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

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

E-mail: