Annotation of parser3/src/main/pa_exec.C, revision 1.61

1.1       paf         1: /** @file
                      2:        Parser: program executing for different OS-es.
                      3: 
1.57      paf         4:        Copyright(c) 2000,2001-2004 ArtLebedev Group(http://www.artlebedev.com)
1.25      paf         5:        Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
1.1       paf         6: 
1.18      paf         7:        @todo setrlimit
1.1       paf         8: */
1.38      paf         9: 
1.61    ! paf        10: static const char * const IDENT_EXEC_C="$Date: 2004/07/06 12:55:16 $";
1.1       paf        11: 
                     12: #include "pa_config_includes.h"
                     13: 
1.19      paf        14: #include "pa_exec.h"
                     15: #include "pa_exception.h"
                     16: #include "pa_common.h"
                     17: 
1.1       paf        18: #ifdef WIN32
                     19: #      include <windows.h>
                     20: #else
                     21: #      include <signal.h>
                     22: #      include <sys/types.h>
                     23: #      include <sys/wait.h>
                     24: #endif
                     25: 
                     26: #ifdef WIN32
                     27: 
                     28: /// this func from http://www.ccas.ru/~posp/popov/spawn.htm
1.36      paf        29: static DWORD CreateHiddenConsoleProcess(LPCTSTR szCmdLine,
1.51      paf        30:                                                                                char *szEnv,
1.1       paf        31:                                         PROCESS_INFORMATION* ppi, 
                     32:                                         LPHANDLE phInWrite,
                     33:                                         LPHANDLE phOutRead,
1.9       parser     34:                                         LPHANDLE phErrRead)
1.1       paf        35: {
1.51      paf        36:        DWORD result=0;
1.36      paf        37:        BOOL fCreated;
1.51      paf        38:        STARTUPINFO si;
                     39:        SECURITY_ATTRIBUTES sa={0};
                     40:        HANDLE hInRead;
                     41:        HANDLE hOutWrite;
                     42:        HANDLE hErrWrite;
                     43:        
                     44:        // Create pipes
                     45:        // initialize security attributes for handle inheritance (for WinNT)
                     46:        sa.nLength=sizeof(sa);
                     47:        sa.bInheritHandle=TRUE;
                     48:        sa.lpSecurityDescriptor=NULL;
                     49:        
                     50:        // create STDIN pipe
                     51:        if(!CreatePipe(&hInRead, phInWrite, &sa, 0))
                     52:                goto error;
                     53:        
                     54:        // create STDOUT pipe
                     55:        if(!CreatePipe(phOutRead, &hOutWrite, &sa, 0))
                     56:                goto error;
                     57:        
                     58:        // create STDERR pipe
                     59:        if(!CreatePipe(phErrRead, &hErrWrite, &sa, 0))
                     60:                goto error;
                     61:        
                     62:        // process startup information
                     63:        memset(&si, 0, sizeof(si));
                     64:        si.cb=sizeof(si); 
                     65:        si.dwFlags=STARTF_USESHOWWINDOW | STARTF_USESTDHANDLES;
                     66:        // child process' console must be hidden for Win95 compatibility
                     67:        si.wShowWindow=SW_HIDE;
                     68:        // assign "other" sides of pipes
                     69:        si.hStdInput=hInRead;
                     70:        si.hStdOutput=hOutWrite;
                     71:        si.hStdError=hErrWrite;
                     72:        
1.31      paf        73:        // calculating script's directory
                     74:        char dir[MAX_STRING];
                     75:        strncpy(dir, szCmdLine, MAX_STRING-1); dir[MAX_STRING-1]=0;
1.33      paf        76:        lsplit(dir,' '); // trim arguments
1.31      paf        77:        rsplit(dir,'/'); rsplit(dir,'\\'); // trim filename
                     78:        chdir(dir);
1.51      paf        79:        
                     80:        // Create a child process (suspended)
                     81:        fCreated=CreateProcess(NULL,
                     82:                (LPTSTR)szCmdLine,
                     83:                NULL,
                     84:                NULL,
                     85:                TRUE,
                     86:                CREATE_NO_WINDOW,
                     87:                szEnv,
                     88:                dir,
                     89:                &si,
                     90:                ppi);
1.36      paf        91:        if(!fCreated)
                     92:                result=GetLastError();
1.51      paf        93:        
                     94:        CloseHandle(hInRead);
                     95:        CloseHandle(hOutWrite);
                     96:        CloseHandle(hErrWrite);
                     97:        
                     98:        if(!fCreated)
                     99:                goto error;
                    100:        
                    101:        return result;
                    102:        
1.1       paf       103: error:
1.36      paf       104:        if(!result/*yet*/)
                    105:                result=GetLastError(); // get it
1.51      paf       106:        
                    107:        CloseHandle(*phInWrite);
                    108:        CloseHandle(*phOutRead);
                    109:        CloseHandle(*phErrRead);
                    110:        
                    111:        return result;
                    112: }
1.36      paf       113: 
1.51      paf       114: static void read_pipe(String& result, HANDLE hOutRead, String::Language lang){
                    115:        while(true) {
                    116:                char *buf=new(PointerFreeGC) char[MAX_STRING];
                    117:                unsigned long size;
                    118:                if(!ReadFile(hOutRead, buf, MAX_STRING-1, &size, NULL) || !size) 
                    119:                        break;
                    120:                buf[size]=0;
                    121:                result.append_know_length(buf, size, lang);
                    122:        }
1.1       paf       123: }
                    124: 
1.51      paf       125: static const char* buildCommand(const char* file_spec_cstr, const ArrayString& argv) {
                    126:        const char* result=file_spec_cstr;
1.4       paf       127:        if(FILE *f=fopen(file_spec_cstr, "r")) {
1.51      paf       128:                try {
1.1       paf       129:                char buf[MAX_STRING];
                    130:                size_t size=fread(buf, 1, MAX_STRING-1, f);
                    131:                if(size>2) {
                    132:                        buf[size]=0;
                    133:                        if(strncmp(buf, "#!", 2)==0) {
1.51      paf       134:                                const char* begin=buf+2;
1.4       paf       135:                                if(*begin==' ') // alx: were an old magic for some linux-es
                    136:                                        begin++;
                    137:                                if(char *end=strchr(begin, '\n')) {
1.51      paf       138:                                        String string(pa_strdup(begin, end-begin));
1.1       paf       139:                                        string << " " << file_spec_cstr;
1.8       parser    140:                                        result=string.cstr();
1.1       paf       141:                                }
                    142:                        }
                    143:                }
1.51      paf       144:                } catch(...) {
                    145:                        fclose(f);
                    146:                        rethrow;
                    147:                }
1.1       paf       148:                fclose(f);
                    149:        }
1.51      paf       150:        { // appending argv
                    151:                String string(result);
                    152:                for(size_t i=0; i<argv.count(); i++) {
                    153:                        string << " ";
                    154:                        string << *argv[i];
1.8       parser    155:                }
                    156: 
1.51      paf       157:                result=string.cstr();
1.8       parser    158:        }
                    159: 
                    160:        return result;
1.1       paf       161: }
                    162: 
1.51      paf       163: #else
1.1       paf       164: 
1.51      paf       165: static pid_t execve_piped(const char* file_spec_cstr, 
1.27      paf       166:                        char * const argv[], char * const env[],
                    167:                        int *pipe_in, int *pipe_out, int *pipe_err) {
1.46      paf       168:        pid_t pid;
1.1       paf       169:        int in_fds[2];
                    170:        int out_fds[2];
                    171:        int err_fds[2];
                    172:        int save_errno;
                    173:        
                    174:        if(pipe_in && pipe(in_fds)<0) {
                    175:                save_errno=errno;
                    176:                errno=save_errno;
                    177:                return 0;
                    178:        }
                    179:        
                    180:        if(pipe_out && pipe(out_fds)<0) {
                    181:                save_errno=errno;
                    182:                if(pipe_in) {
                    183:                        close(in_fds[0]); close(in_fds[1]);
                    184:                }
                    185:                errno=save_errno;
                    186:                return 0;
                    187:        }
                    188:        
                    189:        if(pipe_err && pipe(err_fds)<0) {
                    190:                save_errno=errno;
                    191:                if(pipe_in) {
                    192:                        close(in_fds[0]); close(in_fds[1]);
                    193:                }
                    194:                if(pipe_out) {
                    195:                        close(out_fds[0]); close(out_fds[1]);
                    196:                }
                    197:                errno=save_errno;
                    198:                return 0;
                    199:        }
                    200:        
                    201:        if((pid=fork())<0) {
                    202:                save_errno=errno;
                    203:                if(pipe_in) {
                    204:                        close(in_fds[0]); close(in_fds[1]);
                    205:                }
                    206:                if(pipe_out) {
                    207:                        close(out_fds[0]); close(out_fds[1]);
                    208:                }
                    209:                if(pipe_err) {
                    210:                        close(err_fds[0]); close(err_fds[1]);
                    211:                }
                    212:                errno=save_errno;
1.46      paf       213:                return -1;
1.1       paf       214:        }
                    215:        
                    216:        if(!pid) {
                    217:                /* Child process */
                    218:                
                    219:                if(pipe_out) {
                    220:                        close(out_fds[0]);
                    221:                        dup2(out_fds[1], STDOUT_FILENO);
                    222:                        close(out_fds[1]);
                    223:                }
                    224:                
                    225:                if(pipe_in) {
                    226:                        close(in_fds[1]);
                    227:                        dup2(in_fds[0], STDIN_FILENO);
                    228:                        close(in_fds[0]);
                    229:                }
                    230:                
                    231:                if(pipe_err) {
                    232:                        close(err_fds[0]);
                    233:                        dup2(err_fds[1], STDERR_FILENO);
                    234:                        close(err_fds[1]);
                    235:                }
                    236:                
1.42      paf       237:                /* grabbed this from Apache source: */
                    238:                /*  HP-UX SIGCHLD fix goes here, if someone will remind me what it is... */
1.1       paf       239:                signal(SIGCHLD, SIG_DFL);       /* Was that it? */
                    240:        
1.31      paf       241:                // chdir to script's directory
                    242:                char dir[MAX_STRING];
                    243:                strncpy(dir, file_spec_cstr, MAX_STRING-1); dir[MAX_STRING-1]=0;
                    244:                rsplit(dir,'/'); // trim filename
                    245:                chdir(dir);
                    246: 
                    247:                //  execute
                    248:                execve(file_spec_cstr, argv, env);
1.1       paf       249:                exit(-errno);
                    250:        }
                    251:        
                    252:        /* Parent process */
                    253:        
                    254:        if(pipe_out) {
                    255:                close(out_fds[1]);
                    256:                *pipe_out=out_fds[0];
                    257:        }
                    258:        
                    259:        if(pipe_in) {
                    260:                close(in_fds[0]);
                    261:                *pipe_in=in_fds[1];
                    262:        }
                    263:        
                    264:        if(pipe_err) {
                    265:                close(err_fds[1]);
                    266:                *pipe_err=err_fds[0];
                    267:        }
                    268: 
                    269:        return pid;
                    270: }
                    271: 
                    272: static int get_exit_status(int pid) {
                    273:        int status;
1.58      paf       274:        pid_t cid;
                    275:        while ((cid=waitpid(pid, &status, WUNTRACED)) == -1 && errno == EINTR); 
                    276:        if(!cid)
1.1       paf       277:                return -1;
                    278:        return WIFEXITED(status) ? 
                    279:                WEXITSTATUS(status) : -2;
                    280: }
                    281: 
1.51      paf       282: static void read_pipe(String& result, int file, String::Language lang){
1.1       paf       283:        while(true) {
1.51      paf       284:                char *buf=new(PointerFreeGC) char[MAX_STRING];
                    285:                ssize_t length=read(file, buf, MAX_STRING-1);
                    286:                if(length<=0)
1.49      paf       287:                        break;
1.51      paf       288:                buf[length]=0;
                    289:                result.append_know_length(buf, length, lang);
                    290:        }
1.1       paf       291: }
                    292: 
1.51      paf       293: #endif
1.1       paf       294: 
1.51      paf       295: #ifndef DOXYGEN
                    296: struct Append_env_pair_info {
1.1       paf       297: #ifdef WIN32
1.51      paf       298:        String& string;
                    299:        Append_env_pair_info(String& astring): string(astring) {}
                    300: #else
                    301:        char **env_ref;
                    302: #endif
                    303: };
                    304: #endif
                    305: ///@test maybe here and at argv construction --- cstr(String::L_UNSPECIFIED
                    306: static void append_env_pair(HashStringString::key_type key, HashStringString::value_type value,
                    307:                Append_env_pair_info *info) {
                    308: #ifdef WIN32
                    309:        info->string << key << "=" << value;
                    310:        info->string.append_know_length("\1", 1, String::L_AS_IS); // placeholder for of zero byte
1.1       paf       311: #else
1.52      paf       312:        String::Body body;
1.61    ! paf       313:        body << key << "=" << value.cstr(String::L_UNSPECIFIED);
1.1       paf       314: 
1.61    ! paf       315:        *(info->env_ref++)=body.cstrm();
1.1       paf       316: #endif
                    317: }
1.31      paf       318: 
1.51      paf       319: /// @todonow unix part to smart_ptr
                    320: PA_exec_result pa_exec(
1.53      paf       321:                        bool 
1.55      paf       322: #if defined(NO_PA_EXEC) || defined(PA_SAFE_MODE)
1.53      paf       323:                        forced_allow
                    324: #endif
                    325:                        , 
1.32      paf       326:                        const String& file_spec, 
1.51      paf       327:                        const HashStringString* env, 
                    328:                        const ArrayString& argv, 
                    329:                        String& in) {
                    330:        PA_exec_result result;
1.1       paf       331: 
1.28      paf       332: #ifdef NO_PA_EXECS
1.32      paf       333:        if(!forced_allow)
1.34      paf       334:                throw Exception("parser.runtime",
1.32      paf       335:                        &file_spec,
                    336:                        "parser execs are disabled [recompile parser without --disable-execs configure option]");
                    337: #endif
1.28      paf       338: 
1.1       paf       339: #ifdef WIN32
                    340: 
                    341:        PROCESS_INFORMATION pi; 
                    342:        HANDLE hInWrite, hOutRead, hErrRead;
1.51      paf       343:        const char* cmd=buildCommand(file_spec.cstr(String::L_FILE_SPEC), argv);
1.53      paf       344:        char* env_cstr=0;
1.1       paf       345:        if(env) {
1.51      paf       346:                String string;
                    347:                Append_env_pair_info info(string);
                    348:                env->for_each(append_env_pair, &info);
                    349:                env_cstr=info.string.cstrm(String::L_UNSPECIFIED);
                    350:                for(char* replacer=env_cstr; *replacer; replacer++)
                    351:                        if(*replacer=='\1')
                    352:                                *replacer=0;
1.1       paf       353:        }
1.36      paf       354:        if(DWORD error=CreateHiddenConsoleProcess(cmd, env_cstr, &pi, &hInWrite, &hOutRead, &hErrRead)) {
                    355:                char szErrorDesc[MAX_STRING];
1.51      paf       356:                const char* param="the file you tried to run";
1.36      paf       357:                size_t error_size=FormatMessage(
                    358:                        FORMAT_MESSAGE_FROM_SYSTEM|FORMAT_MESSAGE_ARGUMENT_ARRAY , NULL, error,
                    359:                        MAKELANGID(LANG_NEUTRAL, SUBLANG_NEUTRAL),
1.51      paf       360:                        szErrorDesc, sizeof(szErrorDesc), (va_list *)&param);
1.36      paf       361:                if(error_size>3) // ".\r\n"
                    362:                        szErrorDesc[error_size-3]=0;
                    363:             
                    364:                throw Exception(0,
                    365:                        &file_spec,
1.56      paf       366:                        "exec failed - %s (%u). Consider adding shbang line (#!x:\\interpreter\\command line)", 
                    367:                                error_size?szErrorDesc:"<unknown>", error);
1.36      paf       368:        } else {
1.51      paf       369:                const char* in_cstr=in.cstr();
1.5       paf       370:                DWORD written_size;
1.51      paf       371:                WriteFile(hInWrite, in_cstr, in.length(), &written_size, NULL);
1.5       paf       372:                // EOF for stupid text reads
                    373:                // normally they should read CONTENT_LENGTH bytes,
                    374:                // without this char
                    375:                WriteFile(hInWrite, "\x1A", 1, &written_size, NULL);
1.9       parser    376:                CloseHandle(hInWrite);
1.51      paf       377:                read_pipe(result.out, hOutRead, String::L_AS_IS);
1.9       parser    378:                CloseHandle(hOutRead);
1.51      paf       379:                read_pipe(result.err, hErrRead, String::L_TAINTED);             
1.9       parser    380:                CloseHandle(hErrRead);
1.1       paf       381: /*     
                    382: from http://www.apache.org/websrc/cvsweb.cgi/apache-1.3/src/main/util_script.c?rev=1.151&content-type=text/vnd.viewcvs-markup
                    383: 
                    384:        * We must close the handles to the new process and its main thread
                    385:     * to prevent handle and memory leaks.
                    386: */     
                    387:                CloseHandle(pi.hProcess);
                    388:         CloseHandle(pi.hThread);
                    389:        }
                    390: 
                    391: #else
1.53      paf       392: 
                    393:        // execve needs non const
                    394:        char* file_spec_cstr=file_spec.cstrm(String::L_FILE_SPEC); 
1.1       paf       395: 
                    396:        int pipe_write, pipe_read, pipe_err;
1.31      paf       397: 
1.47      paf       398: #ifdef PA_SAFE_MODE
1.32      paf       399:        if(!forced_allow) {
                    400:                struct stat finfo;
                    401:                if(stat(file_spec_cstr, &finfo)!=0)
1.34      paf       402:                        throw Exception("file.missing", 
1.51      paf       403:                                &file_spec, 
                    404:                                "stat failed: %s (%d), actual filename '%s'", 
                    405:                                        strerror(errno), errno, file_spec_cstr);
1.31      paf       406: 
1.50      paf       407:                check_safe_mode(finfo, file_spec, file_spec_cstr);
1.32      paf       408:        }
1.31      paf       409: #endif
                    410: 
1.51      paf       411:        char* argv_cstrs[1+10+1]={file_spec_cstr, 0};
                    412:        const int argv_size=argv.count();
                    413:        const int argv_max=sizeof(argv_cstrs)/sizeof(argv_cstrs[0])-1-1;
                    414:        if(argv_size>argv_max)
                    415:                throw Exception("parser.runtime",
                    416:                        &file_spec,
                    417:                        "too many arguments (%d > max %d)", argv_size, argv_max);
                    418:        for(int i=0; i<argv_size; i++)
                    419:                argv_cstrs[1+i]=argv[i]->cstrm();
                    420:        argv_cstrs[1+argv_size]=0;
                    421: 
                    422:        char **env_cstrs;
1.1       paf       423:        if(env) {
1.51      paf       424:                env_cstrs=new(PointerFreeGC) char *[env->count()+1/*0*/];
                    425:                Append_env_pair_info info={env_cstrs}; 
                    426:                env->for_each(append_env_pair, &info);
                    427:                *info.env_ref=0;
                    428:        } else
                    429:                env_cstrs=0;
1.31      paf       430: 
1.46      paf       431:        pid_t pid=execve_piped(
1.1       paf       432:                file_spec_cstr,
1.27      paf       433:                argv_cstrs, env_cstrs,
1.22      paf       434:                &pipe_write, &pipe_read, &pipe_err);
1.46      paf       435:        if(pid>0) {
1.21      paf       436:                // in child
1.51      paf       437:                if(in.length()) {// there is some in data
                    438:                        const char* in_cstr=in.cstr();
                    439:                        write(pipe_write, in_cstr, in.length());
                    440:                }
1.1       paf       441:                close(pipe_write);
1.51      paf       442:                read_pipe(result.out, pipe_read, String::L_AS_IS);
1.5       paf       443:                close(pipe_read);
1.51      paf       444:                read_pipe(result.err, pipe_err, String::L_TAINTED);
1.1       paf       445:                close(pipe_err);
                    446: 
1.51      paf       447:                result.status=get_exit_status(pid); // negative may mean "-errno[execl()]"
1.59      paf       448:        } else { 
                    449:                const char* str=strerror(errno);
1.34      paf       450:                throw Exception(0,
1.2       paf       451:                        &file_spec,
1.59      paf       452:                        "%s error: %s (%d)", pid<0?"fork":"pipe", str?str:"<unknown>", errno); 
                    453:        }
1.1       paf       454: #endif
                    455: 
1.51      paf       456:        return result;
1.1       paf       457: }

E-mail: