Annotation of parser3/src/targets/cgi/parser3.C, revision 1.181

1.27      paf         1: /** @file
                      2:        Parser: scripting and CGI main.
                      3: 
1.155     paf         4:        Copyright(c) 2001, 2002 ArtLebedev Group (http://www.artlebedev.com)
1.154     paf         5:        Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
1.27      paf         6: 
1.181   ! paf         7:        $Id: parser3.C,v 1.180 2002/06/11 12:20:42 paf Exp $
1.1       paf         8: */
                      9: 
1.40      paf        10: #include "pa_config_includes.h"
1.3       paf        11: 
1.139     paf        12: #if _MSC_VER
1.131     paf        13: #      include <new.h>
1.148     paf        14: #      include <crtdbg.h>
1.151     paf        15: #else
                     16: #      include "pa_config_paths.h"
1.3       paf        17: #endif
1.27      paf        18: 
1.37      paf        19: #include "pa_sapi.h"
1.76      paf        20: #include "classes.h"
1.24      paf        21: #include "pa_common.h"
1.2       paf        22: #include "pa_request.h"
1.57      paf        23: #include "pa_socks.h"
1.68      paf        24: #include "pa_version.h"
1.125     parser     25: #include "pool_storage.h"
1.69      paf        26: 
1.149     paf        27: #ifdef WIN32
                     28: #      include <windows.h>
1.120     parser     29: #endif
                     30: 
1.158     paf        31: //#define DEBUG_POOL_MALLOC
1.162     paf        32: //#define DEBUG_STRING_APPENDS_VS_EXPANDS
1.160     paf        33: 
                     34: #ifdef DEBUG_STRING_APPENDS_VS_EXPANDS
                     35: extern ulong 
                     36:        string_piece_appends, 
                     37:        wcontext_result_size,
                     38:        total_alloc_size,
                     39:        string_string_shortcut_economy;
                     40: #endif
1.84      parser     41: 
1.109     parser     42: // consts
1.113     parser     43: 
1.174     paf        44: #ifndef _PROFILE
1.113     parser     45: extern const char *main_RCSIds[];
1.116     parser     46: #ifdef USE_SMTP
1.113     parser     47: extern const char *smtp_RCSIds[];
1.114     parser     48: #endif
1.113     parser     49: extern const char *gd_RCSIds[];
                     50: extern const char *classes_RCSIds[];
                     51: extern const char *types_RCSIds[];
1.115     parser     52: extern const char *parser3_RCSIds[];
1.113     parser     53: const char **RCSIds[]={
                     54:        main_RCSIds,
1.116     parser     55: #ifdef USE_SMTP
1.113     parser     56:        smtp_RCSIds,
1.114     parser     57: #endif
1.113     parser     58:        gd_RCSIds,
                     59:        classes_RCSIds,
                     60:        types_RCSIds,
1.115     parser     61:        parser3_RCSIds,
1.113     parser     62:        0
                     63: };
1.174     paf        64: #endif
1.84      parser     65: 
1.175     paf        66: #define REDIRECT_PREFIX "REDIRECT_"
1.181   ! paf        67: #define PARSER_CONFIG_ENV_NAME "CGI_PARSER_CONFIG"
1.159     paf        68: 
1.42      paf        69: /// IIS refuses to read bigger chunks
                     70: const size_t READ_POST_CHUNK_SIZE=0x400*0x400; // 1M 
                     71: 
1.45      paf        72: const char *argv0;
1.178     paf        73: Pool *pool; // global pool [dont describe to doxygen: it confuses it with param names]
1.27      paf        74: bool cgi; ///< we were started as CGI?
1.5       paf        75: 
1.46      paf        76: // SAPI
1.86      parser     77: 
1.124     parser     78: static void log(const char *fmt, va_list args) {
1.61      paf        79:        bool opened;
                     80:        FILE *f=0;
                     81: 
                     82:        if(argv0) {
                     83:                // beside by binary
                     84:                char file_spec[MAX_STRING];
1.98      parser     85:                strncpy(file_spec, argv0, MAX_STRING-1);  file_spec[MAX_STRING-1]=0; // filespec of my binary
1.61      paf        86:                rsplit(file_spec, '/');  rsplit(file_spec, '\\');// strip filename
                     87:                strcat(file_spec, "/parser3.log");
                     88:                f=fopen(file_spec, "at");
                     89:        }
                     90:        opened=f!=0;
                     91:        if(!opened)
                     92:                f=stderr;
                     93: 
                     94:        // prefix
                     95:        time_t t=time(0);
1.171     paf        96:        if(const char *stamp=ctime(&t)) { // never saw that
1.173     paf        97:                if(size_t len=strlen(stamp)) // saw once stamp being =""
1.172     paf        98:                        fprintf(f, "[%.*s] ", len-1, stamp);
1.171     paf        99:        }
1.61      paf       100:        // message
1.117     parser    101: 
                    102:        char buf[MAX_STRING];
                    103:        size_t size=vsnprintf(buf, MAX_STRING, fmt, args);
                    104:        remove_crlf(buf, buf+size);
                    105: 
                    106:        fwrite(buf, size, 1, f);
1.61      paf       107:        // newline
                    108:        fprintf(f, "\n");
                    109: 
                    110:        if(opened)
                    111:                fclose(f);
1.85      parser    112:        else
                    113:                fflush(f);
1.124     parser    114: }
                    115: 
                    116: // appends to parser3.log located beside my binary if openable, to stderr otherwize
                    117: void SAPI::log(Pool& , const char *fmt, ...) {
                    118:     va_list args;
                    119:        va_start(args,fmt);
                    120:        ::log(fmt, args);
                    121:        va_end(args);
                    122: }
                    123: 
                    124: void SAPI::die(const char *fmt, ...) {
1.137     paf       125: #ifdef DEBUG_POOL_MALLOC
                    126:        extern void log_pool_stats(Pool& pool);
1.178     paf       127:        log_pool_stats(*pool);
1.137     paf       128: #endif
                    129: 
1.144     paf       130:     va_list args;
                    131:        va_start(args,fmt);
1.138     paf       132:        // log
                    133: 
                    134:        // logging is more important than user 
                    135:        // she can cancel download, we'd get SIG_PIPE, 
                    136:        // nothing would be logged then
1.124     parser    137:        ::log(fmt, args);
                    138: 
1.138     paf       139:        // inform user
                    140: 
1.134     paf       141:        char body[MAX_STRING];
1.138     paf       142:        int content_length=vsnprintf(body, MAX_STRING, fmt, args);
1.134     paf       143: 
1.144     paf       144:        va_end(args);
                    145: 
1.134     paf       146:        // prepare header
                    147:        // let's be honest, that's bad we couldn't produce valid output
1.178     paf       148:        SAPI::add_header_attribute(*pool, "status", "500");
                    149:        SAPI::add_header_attribute(*pool, "content-type", "text/plain");
1.134     paf       150:        char content_length_cstr[MAX_NUMBER];
1.168     paf       151:        snprintf(content_length_cstr, sizeof(content_length_cstr), "%u", content_length);
1.178     paf       152:        SAPI::add_header_attribute(*pool, "content-length", content_length_cstr);
1.134     paf       153: 
                    154:        // send header
1.178     paf       155:        SAPI::send_header(*pool);
1.134     paf       156: 
                    157:        // body
1.178     paf       158:        SAPI::send_body(*pool, body, content_length);
1.134     paf       159: 
1.124     parser    160:        exit(1);
1.61      paf       161: }
                    162: 
1.122     parser    163: const char *SAPI::get_env(Pool& , const char *name) {
1.109     parser    164:        return getenv(name);
1.28      paf       165: }
                    166: 
1.180     paf       167: const char *const *SAPI::environment(Pool&) {
                    168: #ifdef _MSC_VER
                    169:        extern char **_environ;
                    170:        return _environ;
                    171: #else
                    172:        extern char **environ;
                    173:        return environ;
                    174: #endif
                    175: }
                    176: 
1.122     parser    177: size_t SAPI::read_post(Pool& , char *buf, size_t max_bytes) {
1.59      paf       178:        size_t read_size=0;
1.12      paf       179:        do {
1.36      paf       180:                int chunk_size=read(fileno(stdin), 
1.42      paf       181:                        buf+read_size, min(READ_POST_CHUNK_SIZE, max_bytes-read_size));
1.129     paf       182:                if(chunk_size<=0)
1.12      paf       183:                        break;
                    184:                read_size+=chunk_size;
                    185:        } while(read_size<max_bytes);
                    186: 
                    187:        return read_size;
1.10      paf       188: }
                    189: 
1.122     parser    190: void SAPI::add_header_attribute(Pool& , const char *key, const char *value) {
1.68      paf       191:        if(cgi)
1.20      paf       192:                printf("%s: %s\n", key, value);
1.19      paf       193: }
                    194: 
1.56      paf       195: /// @todo intelligent cache-control
1.122     parser    196: void SAPI::send_header(Pool& ) {
1.33      paf       197:        if(cgi) {
1.147     paf       198: //             puts("expires: Fri, 23 Mar 2001 09:32:23 GMT");
1.33      paf       199: 
                    200:                // header | body  delimiter
1.20      paf       201:                puts("");
1.33      paf       202:        }
1.30      paf       203: }
1.20      paf       204: 
1.122     parser    205: void SAPI::send_body(Pool& , const void *buf, size_t size) {
1.19      paf       206:        stdout_write(buf, size);
1.58      paf       207: }
                    208: 
1.97      parser    209: //
                    210: 
1.166     paf       211: void full_file_spec(const char *file_name, char *buf, size_t buf_size) {
1.167     paf       212:        if(file_name)
                    213:                if(file_name[0]=='/' 
                    214: #ifdef WIN32
                    215:                        || (file_name[0] && file_name[1]==':')
                    216: #endif
                    217:                        ) 
                    218:                        strncpy(buf, file_name, buf_size);
                    219:                else {
                    220:                        char cwd[MAX_STRING];  getcwd(cwd, MAX_STRING);
                    221:                        snprintf(buf, buf_size, "%s/%s", cwd, file_name);
                    222:                }
                    223:        else
                    224:                buf[0]=0;
1.166     paf       225: #ifdef WIN32
                    226:        back_slashes_to_slashes(buf);
                    227: #endif
1.97      parser    228: }
                    229: 
1.40      paf       230: /**
1.122     parser    231: main workhorse
1.19      paf       232: 
1.122     parser    233:   @todo 
1.40      paf       234:                IIS: remove trailing default-document[index.html] from $request.uri.
                    235:                to do that we need to consult metabase,
                    236:                wich is tested but seems slow.
1.144     paf       237:                IIS5 todo find out proper 'illegal call' check 
1.40      paf       238: */
1.122     parser    239: void real_parser_handler(
                    240:                                        const char *filespec_to_process,
                    241:                                        const char *request_method, bool header_only) {
                    242:        // init socks
1.178     paf       243:        init_socks(*pool);
1.122     parser    244:        
                    245:        // init global classes
1.178     paf       246:        init_methoded_array(*pool);
1.122     parser    247:        // init global variables
1.178     paf       248:        pa_globals_init(*pool);
1.122     parser    249:        
                    250:        if(!filespec_to_process)
1.144     paf       251:                SAPI::die("Parser/%s", PARSER_VERSION);
1.122     parser    252:        
                    253:        // Request info
                    254:        Request::Info request_info;
1.166     paf       255:        char document_root_buf[MAX_STRING];
1.122     parser    256:        if(cgi) {
1.178     paf       257:                if(const char *env_document_root=SAPI::get_env(*pool, "DOCUMENT_ROOT"))
1.122     parser    258:                        request_info.document_root=env_document_root;
1.178     paf       259:                else if(const char *path_info=SAPI::get_env(*pool, "PATH_INFO")) {
1.122     parser    260:                        // IIS
1.166     paf       261:                        size_t len=min(sizeof(document_root_buf)-1, strlen(filespec_to_process)-strlen(path_info));
                    262:                        memcpy(document_root_buf, filespec_to_process, len); document_root_buf[len]=0;
                    263:                        request_info.document_root=document_root_buf;
1.122     parser    264:                } else
1.165     paf       265:                        throw Exception("parser.runtime",
                    266:                                0,
                    267:                                "CGI: no PATH_INFO defined(in reinventing DOCUMENT_ROOT)");
1.122     parser    268:        } else {
1.166     paf       269:                full_file_spec("", document_root_buf, sizeof(document_root_buf));
                    270:                request_info.document_root=document_root_buf;
1.122     parser    271:        }
                    272:        request_info.path_translated=filespec_to_process;
                    273:        request_info.method=request_method ? request_method : "GET";
1.178     paf       274:        const char *query_string=SAPI::get_env(*pool, "QUERY_STRING");
1.122     parser    275:        request_info.query_string=query_string;
                    276:        if(cgi) {
1.178     paf       277:                if(const char *env_request_uri=SAPI::get_env(*pool, "REQUEST_URI"))
1.122     parser    278:                        request_info.uri=env_request_uri;
1.178     paf       279:                else if(const char *path_info=SAPI::get_env(*pool, "PATH_INFO"))
1.122     parser    280:                        if(query_string) {
1.178     paf       281:                                char *reconstructed_uri=(char *)pool->malloc(
1.122     parser    282:                                        strlen(path_info)+1/*'?'*/+
                    283:                                        strlen(query_string)+1/*0*/);
                    284:                                strcpy(reconstructed_uri, path_info);
                    285:                                strcat(reconstructed_uri, "?");
                    286:                                strcat(reconstructed_uri, query_string);
                    287:                                request_info.uri=reconstructed_uri;
                    288:                        } else
                    289:                                request_info.uri=path_info;
1.179     paf       290:                else
                    291:                        throw Exception("parser.runtime",
                    292:                                0,
                    293:                                "CGI: no PATH_INFO defined(in reinventing REQUEST_URI)");
1.145     paf       294:                        
                    295: #ifndef WIN32
                    296:                        // they've changed this under IIS5.
1.178     paf       297:                        if(const char *script_name=SAPI::get_env(*pool, "SCRIPT_NAME")) {
1.122     parser    298:                                size_t script_name_len=strlen(script_name);
                    299:                                size_t uri_len=strlen(request_info.uri);
                    300:                                if(strncmp(request_info.uri,script_name, script_name_len)==0 &&
                    301:                                        script_name_len != uri_len) // under IIS they are the same
1.144     paf       302:                                        SAPI::die("CGI: illegal call");
1.122     parser    303:                        }
1.145     paf       304: #endif
1.122     parser    305:        } else
1.177     paf       306:                request_info.uri="";
1.122     parser    307:        
1.178     paf       308:        request_info.content_type=SAPI::get_env(*pool, "CONTENT_TYPE");
                    309:        const char *content_length=SAPI::get_env(*pool, "CONTENT_LENGTH");
1.122     parser    310:        request_info.content_length=(content_length?atoi(content_length):0);
1.178     paf       311:        request_info.cookie=SAPI::get_env(*pool, "HTTP_COOKIE");
1.122     parser    312:        
                    313:        // prepare to process request
1.178     paf       314:        Request request(*pool,
1.122     parser    315:                request_info,
1.143     paf       316: #ifdef _DEBUG
                    317:                String::UL_HTML|String::UL_OPTIMIZE_BIT
                    318: #else
                    319:                cgi ? String::UL_HTML|String::UL_OPTIMIZE_BIT : String::UL_AS_IS
                    320: #endif
                    321:                ,
1.130     paf       322:                true /* status_allowed */);
1.122     parser    323:        
1.181   ! paf       324:        const char *config_filespec_cstr;
        !           325:        char config_filespec_buf[MAX_STRING];
        !           326:        const char *config_by_env=getenv(PARSER_CONFIG_ENV_NAME);
        !           327:        if(!config_by_env)
        !           328:                config_by_env=getenv(REDIRECT_PREFIX PARSER_CONFIG_ENV_NAME);
        !           329:        if(config_by_env)
        !           330:                config_filespec_cstr=config_by_env;
1.164     paf       331:        else {
1.122     parser    332:        // beside by binary
                    333:        // @todo full path, not ./!
1.164     paf       334:                char beside_binary_path[MAX_STRING];
                    335:                strncpy(beside_binary_path, argv0, MAX_STRING-1);  beside_binary_path[MAX_STRING-1]=0; // filespec of my binary
                    336:                if(!(
                    337:                        rsplit(beside_binary_path, '/') || 
                    338:                        rsplit(beside_binary_path, '\\'))) { // strip filename
                    339:                        // no path, just filename
                    340:                        beside_binary_path[0]='.'; beside_binary_path[1]=0;
                    341:                }
1.181   ! paf       342:                snprintf(config_filespec_buf, MAX_STRING, 
1.164     paf       343:                        "%s/%s", 
                    344:                        beside_binary_path, CONFIG_FILE_NAME);
1.181   ! paf       345:                config_filespec_cstr=config_filespec_buf;
1.122     parser    346:        }
                    347:        
                    348:        // process the request
                    349:        request.core(
1.181   ! paf       350:                config_filespec_cstr, false /*fail_on_read_problem*/,
1.122     parser    351:                header_only);
                    352:        
                    353:        //
                    354:        done_socks();
                    355:        
                    356: #ifdef DEBUG_POOL_MALLOC
                    357:        extern void log_pool_stats(Pool& pool);
1.178     paf       358:        log_pool_stats(*pool);
1.122     parser    359: #endif
1.160     paf       360: 
                    361: #ifdef DEBUG_STRING_APPENDS_VS_EXPANDS
1.178     paf       362:        SAPI::log(*pool, 
1.161     paf       363:                "string piece appends=%lu, wcontext_result_size=%lu, string_string_shortcut_economy_closer=%lu, total_alloc_size=%lu", 
1.160     paf       364:                string_piece_appends,
                    365:                wcontext_result_size,
                    366:                string_string_shortcut_economy,
                    367:                total_alloc_size);
                    368: #endif
                    369: 
1.122     parser    370: }
                    371: 
                    372: void call_real_parser_handler__do_SEH(
                    373:                                                                 const char *filespec_to_process,
                    374:                                                                 const char *request_method, bool header_only) {
1.133     paf       375: #if _MSC_VER && !defined(_DEBUG)
1.122     parser    376:        LPEXCEPTION_POINTERS system_exception=0;
                    377:        __try {
                    378: #endif
                    379:                real_parser_handler(
                    380:                        filespec_to_process,
                    381:                        request_method, header_only);
                    382:                
1.133     paf       383: #if _MSC_VER && !defined(_DEBUG)
1.122     parser    384:        } __except (
                    385:                (system_exception=GetExceptionInformation()), 
                    386:                EXCEPTION_EXECUTE_HANDLER) {
                    387:                
                    388:                if(system_exception)
                    389:                        if(_EXCEPTION_RECORD *er=system_exception->ExceptionRecord)
1.165     paf       390:                                throw Exception(0,
                    391:                                        0,
                    392:                                        "Exception 0x%08X at 0x%08X", er->ExceptionCode,  er->ExceptionAddress);
1.122     parser    393:                        else
1.165     paf       394:                                throw Exception(0, 0, "Exception <no exception record>");
1.122     parser    395:                        else
1.165     paf       396:                                throw Exception(0, 0, "Exception <no exception information>");
1.122     parser    397:        }
                    398: #endif
                    399: }
                    400: 
1.139     paf       401: #if _MSC_VER
1.135     paf       402: int failed_new(size_t size) {
                    403:        SAPI::die("out of memory in 'new', failed to allocated %u bytes", size);
                    404:        return 0; // not reached
1.131     paf       405: }
1.135     paf       406: #endif
1.131     paf       407: 
1.135     paf       408: #ifdef HAVE_SET_NEW_HANDLER
1.134     paf       409: void failed_new() {
1.135     paf       410:     SAPI::die("out of memory in 'new'");
1.131     paf       411: }
                    412: #endif
                    413: 
1.5       paf       414: int main(int argc, char *argv[]) {
1.178     paf       415:        Pool_storage global_pool_storage;
                    416:        Pool global_pool(&global_pool_storage);
                    417:        pool=&global_pool;
                    418: 
                    419: #ifdef _DEBUG
                    420: //     _crtBreakAlloc=33112;
                    421: #endif
1.144     paf       422: //     _asm int 3;
1.45      paf       423:        argv0=argv[0];
                    424: 
1.32      paf       425:        umask(2);
                    426: 
1.3       paf       427:        // were we started as CGI?
1.146     paf       428:        cgi=
1.109     parser    429:                getenv("SERVER_SOFTWARE") || 
                    430:                getenv("SERVER_NAME") || 
                    431:                getenv("GATEWAY_INTERFACE") || 
                    432:                getenv("REQUEST_METHOD");
1.5       paf       433:        
1.10      paf       434:        if(!cgi) {
                    435:                if(argc<2) {
1.69      paf       436:                        printf(
1.155     paf       437:                                "Parser/%s Copyright(c) 2001, 2002 ArtLebedev Group (http://www.artlebedev.com)\n"
1.154     paf       438:                                "Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)\n"
1.100     parser    439:                                "\n"
                    440:                                "Usage: %s <file>\n",
1.69      paf       441:                                PARSER_VERSION, 
                    442:                                argv0?argv0:"parser3");
1.67      paf       443:                        return 1;
1.10      paf       444:                }
                    445:        }
                    446: 
1.100     parser    447: #ifdef WIN32
                    448:        setmode(fileno(stdin), _O_BINARY);
                    449:        setmode(fileno(stdout), _O_BINARY);
                    450:        setmode(fileno(stderr), _O_BINARY);
                    451: #endif
                    452: 
1.139     paf       453: #if _MSC_VER
1.138     paf       454:        _set_new_handler(failed_new);
1.148     paf       455: 
                    456: #ifdef _DEBUG
                    457:        // Get current flag
                    458:        int tmpFlag = _CrtSetDbgFlag( _CRTDBG_REPORT_FLAG );
                    459: 
                    460:        // Turn on leak-checking bit
                    461:        tmpFlag |= _CRTDBG_LEAK_CHECK_DF;
                    462: 
                    463:        // Set flag to the new value
                    464:        _CrtSetDbgFlag( tmpFlag );
                    465: //     _CrtSetBreakAlloc(471);
                    466: 
                    467: #endif
                    468: 
1.138     paf       469: #endif
                    470: 
                    471: #ifdef HAVE_SET_NEW_HANDLER
                    472:        std::set_new_handler(failed_new);
                    473: #endif
                    474: 
1.166     paf       475:        char *raw_filespec_to_process=cgi?getenv("PATH_TRANSLATED"):argv[1];
                    476:        char filespec_to_process[MAX_STRING];
                    477:        full_file_spec(raw_filespec_to_process, filespec_to_process, sizeof(filespec_to_process));
1.10      paf       478: 
1.109     parser    479:        const char *request_method=getenv("REQUEST_METHOD");
1.35      paf       480:        bool header_only=request_method && strcasecmp(request_method, "HEAD")==0;
1.131     paf       481: 
1.122     parser    482:        try { // global try
                    483:                call_real_parser_handler__do_SEH(
                    484:                        filespec_to_process,
                    485:                        request_method, header_only);
                    486:        } catch(const Exception& e) { // global problem 
1.44      paf       487:                // don't allocate anything on pool here:
                    488:                //   possible pool' exception not catch-ed now
                    489:                //   and there could be out-of-memory exception
1.43      paf       490: 
1.144     paf       491:                SAPI::die("exception in request exception handler: %s", e.comment());
1.134     paf       492: #ifndef _DEBUG
1.131     paf       493:        } catch(...) { 
1.134     paf       494:                SAPI::die("<unknown exception>");
1.133     paf       495: #endif
1.16      paf       496:        }
1.122     parser    497:        
1.109     parser    498: 
                    499: #ifndef WIN32
                    500:        // 
                    501:        if(!cgi)
1.178     paf       502:                SAPI::send_body(*pool, "\n", 1);
1.109     parser    503: #endif
1.156     paf       504: //_asm int 3;
1.134     paf       505:        return 0;
1.1       paf       506: }

E-mail: