/*
Start the CGI command program. This commences the CGI gateway program. This will be called after content for
form and upload requests (or if "RunHandler" before specified), otherwise it runs before receiving content data.
*/
static void startCgi(HttpQueue *q)
{
HttpRx *rx;
HttpTx *tx;
HttpRoute *route;
HttpConn *conn;
MprCmd *cmd;
Cgi *cgi;
cchar *baseName, **argv, *fileName, **envv;
ssize varCount;
int argc, count;
argv = 0;
argc = 0;
cgi = q->queueData;
conn = q->conn;
rx = conn->rx;
route = rx->route;
tx = conn->tx;
/*
The command uses the conn dispatcher. This serializes all I/O for both the connection and the CGI gateway.
*/
if ((cmd = mprCreateCmd(conn->dispatcher)) == 0) {
return;
}
cgi->cmd = cmd;
if (conn->http->forkCallback) {
cmd->forkCallback = conn->http->forkCallback;
cmd->forkData = conn->http->forkData;
}
argc = 1; /* argv[0] == programName */
buildArgs(conn, cmd, &argc, &argv);
fileName = argv[0];
baseName = mprGetPathBase(fileName);
/*
nph prefix means non-parsed-header. Don't parse the CGI output for a CGI header
*/
if (strncmp(baseName, "nph-", 4) == 0 ||
(strlen(baseName) > 4 && strcmp(&baseName[strlen(baseName) - 4], "-nph") == 0)) {
/* Pretend we've seen the header for Non-parsed Header CGI programs */
cgi->seenHeader = 1;
tx->flags |= HTTP_TX_USE_OWN_HEADERS;
}
/*
Build environment variables
*/
varCount = mprGetHashLength(rx->headers) + mprGetHashLength(rx->svars) + mprGetJsonLength(rx->params);
if ((envv = mprAlloc((varCount + 1) * sizeof(char*))) != 0) {
count = copyParams(conn, envv, 0, rx->params, route->envPrefix);
count = copyVars(conn, envv, count, rx->svars, "");
count = copyVars(conn, envv, count, rx->headers, "HTTP_");
assert(count <= varCount);
}
#if !VXWORKS
/*
This will be ignored on VxWorks because there is only one global current directory for all tasks
*/
mprSetCmdDir(cmd, mprGetPathDir(fileName));
#endif
mprSetCmdCallback(cmd, cgiCallback, cgi);
if (mprStartCmd(cmd, argc, argv, envv, MPR_CMD_IN | MPR_CMD_OUT | MPR_CMD_ERR) < 0) {
httpError(conn, HTTP_CODE_NOT_FOUND, "Cannot run CGI process: %s, URI %s", fileName, rx->uri);
return;
}
#if ME_WIN_LIKE
mprCreateEvent(conn->dispatcher, "cgi-win", 10, waitForCgi, cgi, MPR_EVENT_CONTINUOUS);
#endif
}
/*
Build the command arguments. NOTE: argv is untrusted input.
*/
static void buildArgs(MaConn *conn, MprCmd *cmd, int *argcp, char ***argvp)
{
MaRequest *req;
MaResponse *resp;
char *fileName, **argv, status[8], *indexQuery, *cp, *tok;
cchar *actionProgram;
int argc, argind, len;
req = conn->request;
resp = conn->response;
fileName = resp->filename;
mprAssert(fileName);
actionProgram = 0;
argind = 0;
argc = *argcp;
if (resp->extension) {
actionProgram = maGetMimeActionProgram(req->host, resp->extension);
if (actionProgram != 0) {
argc++;
}
}
/*
This is an Apache compatible hack for PHP 5.3
*/
mprItoa(status, sizeof(status), MPR_HTTP_CODE_MOVED_TEMPORARILY, 10);
mprAddHash(req->headers, "REDIRECT_STATUS", mprStrdup(req, status));
/*
Count the args for ISINDEX queries. Only valid if there is not a "=" in the query.
If this is so, then we must not have these args in the query env also?
*/
indexQuery = req->parsedUri->query;
if (indexQuery && !strchr(indexQuery, '=')) {
argc++;
for (cp = indexQuery; *cp; cp++) {
if (*cp == '+') {
argc++;
}
}
} else {
indexQuery = 0;
}
#if BLD_WIN_LIKE || VXWORKS
{
char *bangScript, *cmdBuf, *program, *cmdScript;
/*
On windows we attempt to find an executable matching the fileName.
We look for *.exe, *.bat and also do unix style processing "#!/program"
*/
findExecutable(conn, &program, &cmdScript, &bangScript, fileName);
mprAssert(program);
if (cmdScript) {
/*
Cmd/Batch script (.bat | .cmd)
Convert the command to the form where there are 4 elements in argv
that cmd.exe can interpret.
argv[0] = cmd.exe
argv[1] = /Q
argv[2] = /C
argv[3] = ""script" args ..."
*/
argc = 4;
len = (argc + 1) * sizeof(char*);
argv = (char**) mprAlloc(cmd, len);
memset(argv, 0, len);
argv[argind++] = program; /* Duped in findExecutable */
argv[argind++] = mprStrdup(cmd, "/Q");
argv[argind++] = mprStrdup(cmd, "/C");
len = (int) strlen(cmdScript) + 2 + 1;
cmdBuf = (char*) mprAlloc(cmd, len);
mprSprintf(cmdBuf, len, "\"%s\"", cmdScript);
argv[argind++] = cmdBuf;
mprSetCmdDir(cmd, cmdScript);
mprFree(cmdScript);
/* program will get freed when argv[] gets freed */
} else if (bangScript) {
/*
Script used "#!/program". NOTE: this may be overridden by a mime
Action directive.
*/
argc++; /* Adding bangScript arg */
len = (argc + 1) * sizeof(char*);
argv = (char**) mprAlloc(cmd, len);
memset(argv, 0, len);
argv[argind++] = program; /* Will get freed when argv[] is freed */
argv[argind++] = bangScript; /* Will get freed when argv[] is freed */
mprSetCmdDir(cmd, bangScript);
} else {
/*
Either unknown extension or .exe (.out) program.
*/
len = (argc + 1) * sizeof(char*);
argv = (char**) mprAlloc(cmd, len);
memset(argv, 0, len);
if (actionProgram) {
argv[argind++] = mprStrdup(cmd, actionProgram);
}
argv[argind++] = program;
}
}
#else
len = (argc + 1) * (int) sizeof(char*);
argv = (char**) mprAlloc(cmd, len);
memset(argv, 0, len);
if (actionProgram) {
argv[argind++] = mprStrdup(cmd, actionProgram);
}
argv[argind++] = mprStrdup(cmd, fileName);
#endif
/*
ISINDEX queries. Only valid if there is not a "=" in the query. If this is so, then we must not
have these args in the query env also?
*/
if (indexQuery) {
indexQuery = mprStrdup(cmd, indexQuery);
cp = mprStrTok(indexQuery, "+", &tok);
while (cp) {
argv[argind++] = mprEscapeCmd(resp, mprUrlDecode(resp, cp), 0);
cp = mprStrTok(NULL, "+", &tok);
}
}
mprAssert(argind <= argc);
argv[argind] = 0;
*argcp = argc;
*argvp = argv;
}
/*
Build the command arguments. NOTE: argv is untrusted input.
*/
static void buildArgs(HttpConn *conn, MprCmd *cmd, int *argcp, cchar ***argvp)
{
HttpRx *rx;
HttpTx *tx;
char **argv;
char *indexQuery, *cp, *tok;
cchar *actionProgram, *fileName;
size_t len;
int argc, argind, i;
rx = conn->rx;
tx = conn->tx;
fileName = tx->filename;
assert(fileName);
actionProgram = 0;
argind = 0;
argc = *argcp;
if (tx->ext) {
actionProgram = mprGetMimeProgram(rx->route->mimeTypes, tx->ext);
if (actionProgram != 0) {
argc++;
}
/*
This is an Apache compatible hack for PHP 5.3
*/
mprAddKey(rx->headers, "REDIRECT_STATUS", itos(HTTP_CODE_MOVED_TEMPORARILY));
}
/*
Count the args for ISINDEX queries. Only valid if there is not a "=" in the query.
If this is so, then we must not have these args in the query env also?
*/
indexQuery = rx->parsedUri->query;
if (indexQuery && !strchr(indexQuery, '=')) {
argc++;
for (cp = indexQuery; *cp; cp++) {
if (*cp == '+') {
argc++;
}
}
} else {
indexQuery = 0;
}
#if ME_WIN_LIKE || VXWORKS
{
char *bangScript, *cmdBuf, *program, *cmdScript;
/*
On windows we attempt to find an executable matching the fileName.
We look for *.exe, *.bat and also do unix style processing "#!/program"
*/
findExecutable(conn, &program, &cmdScript, &bangScript, fileName);
assert(program);
if (cmdScript) {
/*
Cmd/Batch script (.bat | .cmd)
Convert the command to the form where there are 4 elements in argv
that cmd.exe can interpret.
argv[0] = cmd.exe
argv[1] = /Q
argv[2] = /C
argv[3] = ""script" args ..."
*/
argc = 4;
len = (argc + 1) * sizeof(char*);
argv = (char**) mprAlloc(len);
memset(argv, 0, len);
argv[argind++] = program; /* Duped in findExecutable */
argv[argind++] = "/Q";
argv[argind++] = "/C";
len = strlen(cmdScript) + 2 + 1;
cmdBuf = mprAlloc(len);
fmt(cmdBuf, len, "\"%s\"", cmdScript);
argv[argind++] = cmdBuf;
mprSetCmdDir(cmd, cmdScript);
/* program will get freed when argv[] gets freed */
} else if (bangScript) {
/*
Script used "#!/program". NOTE: this may be overridden by a mime Action directive.
*/
argc++; /* Adding bangScript arg */
len = (argc + 1) * sizeof(char*);
argv = (char**) mprAlloc(len);
memset(argv, 0, len);
argv[argind++] = program; /* Will get freed when argv[] is freed */
argv[argind++] = bangScript; /* Will get freed when argv[] is freed */
mprSetCmdDir(cmd, bangScript);
} else {
/*
Either unknown extension or .exe (.out) program.
*/
len = (argc + 1) * sizeof(char*);
argv = (char**) mprAlloc(len);
memset(argv, 0, len);
if (actionProgram) {
argv[argind++] = sclone(actionProgram);
}
argv[argind++] = program;
}
}
#else
len = (argc + 1) * sizeof(char*);
argv = mprAlloc(len);
memset(argv, 0, len);
if (actionProgram) {
argv[argind++] = sclone(actionProgram);
}
// OPT - why clone all these string?
argv[argind++] = sclone(fileName);
#endif
/*
ISINDEX queries. Only valid if there is not a "=" in the query. If this is so, then we must not
have these args in the query env also?
FUTURE - should query vars be set in the env?
*/
if (indexQuery) {
indexQuery = sclone(indexQuery);
cp = stok(indexQuery, "+", &tok);
while (cp) {
argv[argind++] = mprEscapeCmd(mprUriDecode(cp), 0);
cp = stok(NULL, "+", &tok);
}
}
assert(argind <= argc);
argv[argind] = 0;
*argcp = argc;
*argvp = (cchar**) argv;
mprDebug("http cgi", 5, "CGI: command:");
for (i = 0; i < argind; i++) {
mprDebug("http cgi", 5, " argv[%d] = %s", i, argv[i]);
}
}
static void startCgi(MaQueue *q)
{
MaRequest *req;
MaConn *conn;
MprCmd *cmd;
MprHash *hp;
cchar *baseName;
char **argv, **envv, *fileName;
int index, argc, varCount;
argv = 0;
argc = 0;
conn = q->conn;
req = conn->request;
if ((req->form || req->flags & MA_REQ_UPLOADING) && conn->state <= MPR_HTTP_STATE_CONTENT) {
/*
Delay starting the CGI process if uploading files or a form request. This enables env vars to be defined
with file upload and form data before starting the CGI gateway.
*/
return;
}
cmd = q->queueData = mprCreateCmd(req);
if (conn->http->forkCallback) {
cmd->forkCallback = conn->http->forkCallback;
cmd->forkData = conn->http->forkData;
}
/*
Build the commmand line arguments
*/
argc = 1; /* argv[0] == programName */
buildArgs(conn, cmd, &argc, &argv);
fileName = argv[0];
baseName = mprGetPathBase(q, fileName);
if (strncmp(baseName, "nph-", 4) == 0 ||
(strlen(baseName) > 4 && strcmp(&baseName[strlen(baseName) - 4], "-nph") == 0)) {
/*
Pretend we've seen the header for Non-parsed Header CGI programs
*/
cmd->userFlags |= MA_CGI_SEEN_HEADER;
}
/*
Build environment variables
*/
varCount = mprGetHashCount(req->headers) + mprGetHashCount(req->formVars);
envv = (char**) mprAlloc(cmd, (varCount + 1) * (int) sizeof(char*));
index = 0;
hp = mprGetFirstHash(req->headers);
while (hp) {
if (hp->data) {
envv[index] = mprStrcat(cmd, -1, hp->key, "=", (char*) hp->data, NULL);
index++;
}
hp = mprGetNextHash(req->headers, hp);
}
hp = mprGetFirstHash(req->formVars);
while (hp) {
if (hp->data) {
envv[index] = mprStrcat(cmd, -1, hp->key, "=", (char*) hp->data, NULL);
index++;
}
hp = mprGetNextHash(req->formVars, hp);
}
envv[index] = 0;
mprAssert(index <= varCount);
cmd->stdoutBuf = mprCreateBuf(cmd, MA_BUFSIZE, -1);
cmd->stderrBuf = mprCreateBuf(cmd, MA_BUFSIZE, -1);
cmd->lastActivity = mprGetTime(cmd);
mprSetCmdDir(cmd, mprGetPathDir(q, fileName));
mprSetCmdCallback(cmd, cgiCallback, conn);
maSetHeader(conn, 0, "Last-Modified", req->host->currentDate);
maDontCacheResponse(conn);
maPutForService(q, maCreateHeaderPacket(q), 0);
if (mprStartCmd(cmd, argc, argv, envv, MPR_CMD_IN | MPR_CMD_OUT | MPR_CMD_ERR) < 0) {
maFailRequest(conn, MPR_HTTP_CODE_SERVICE_UNAVAILABLE, "Can't run CGI process: %s, URI %s", fileName, req->url);
return;
}
/*
This will dedicate this thread to the connection. It will also put the socket into blocking mode.
*/
maDedicateThreadToConn(conn);
}