Annotation of parser3/src/targets/isapi/parser3isapi.C, revision 1.136

1.29      paf         1: /** @file
                      2:        Parser: IIS extension.
                      3: 
1.136   ! moko        4:        Copyright (c) 2000-2026 Art. Lebedev Studio (https://www.artlebedev.com)
1.128     moko        5:        Authors: Konstantin Morshnev <moko@design.ru>, Alexandr Petrosian <paf@design.ru>
1.77      paf         6: */
1.29      paf         7: 
1.136   ! moko        8: volatile const char * IDENT_PARSER3ISAPI_C="$Id: parser3isapi.C,v 1.135 2024/12/11 18:35:31 moko Exp $";
1.29      paf         9: 
1.1       paf        10: #ifndef _MSC_VER
1.10      paf        11: #      error compile ISAPI module with MSVC [no urge for now to make it autoconf-ed (PAF)]
1.1       paf        12: #endif
1.43      parser     13: 
                     14: #include "pa_config_includes.h"
1.1       paf        15: 
1.9       paf        16: #include "pa_sapi.h"
1.1       paf        17: #include "pa_globals.h"
                     18: #include "pa_request.h"
                     19: #include "pa_version.h"
                     20: 
1.64      paf        21: #include <windows.h>
                     22: #include <process.h>
                     23: 
                     24: #include <httpext.h>
1.51      parser     25: 
1.92      paf        26: // defines
                     27: 
1.110     moko       28: #if defined(_MSC_VER) && !defined(_DEBUG)
1.92      paf        29: #      define PA_SUPPRESS_SYSTEM_EXCEPTION
                     30: #endif
                     31: 
                     32: 
1.1       paf        33: #define MAX_STATUS_LENGTH sizeof("xxxx LONGEST STATUS DESCRIPTION")
1.44      parser     34: 
                     35: // consts
1.1       paf        36: 
1.83      paf        37: const char* IIS51vars[]={
1.73      paf        38:        "APPL_MD_PATH", "APPL_PHYSICAL_PATH",
                     39:        "AUTH_PASSWORD", "AUTH_TYPE", "AUTH_USER",
                     40:        "CERT_COOKIE", "CERT_FLAGS", "CERT_ISSUER", "CERT_KEYSIZE", "CERT_SECRETKEYSIZE",
                     41:        "CERT_SERIALNUMBER", "CERT_SERVER_ISSUER", "CERT_SERVER_SUBJECT", "CERT_SUBJECT",
                     42:        "CONTENT_LENGTH", "CONTENT_TYPE",
1.107     moko       43:        "GATEWAY_INTERFACE",
1.73      paf        44:        "HTTPS", "HTTPS_KEYSIZE", "HTTPS_SECRETKEYSIZE", "HTTPS_SERVER_ISSUER", "HTTPS_SERVER_SUBJECT",
                     45:        "INSTANCE_ID",  "INSTANCE_META_PATH",
1.107     moko       46:        "LOCAL_ADDR", "LOGON_USER",
1.73      paf        47:        "PATH_INFO",    "PATH_TRANSLATED",
                     48:        "QUERY_STRING",
1.107     moko       49:        "REMOTE_ADDR", "REMOTE_HOST", "REMOTE_PORT", "REMOTE_USER", "REQUEST_METHOD",
1.73      paf        50:        "SCRIPT_NAME",
                     51:        "SERVER_NAME", "SERVER_PORT", "SERVER_PORT_SECURE", "SERVER_PROTOCOL", "SERVER_SOFTWARE",
                     52:        "URL",
                     53: };
                     54: const int IIS51var_count=sizeof(IIS51vars)/sizeof(*IIS51vars);
                     55: 
1.65      paf        56: // globals
                     57: 
                     58: char argv0[MAX_STRING]="";
1.134     moko       59: const char* parser3_mode="isapi"; // $status:mode
1.135     moko       60: const char *parser3_log_filespec(){ return ""; } // $status:log-filename
1.65      paf        61: 
1.18      paf        62: // SAPI
                     63: 
1.38      parser     64: #ifndef DOXYGEN
                     65: /*
1.18      paf        66:        ISAPI SAPI functions receive this context information. 
1.38      parser     67:        see Pool::set_context
1.18      paf        68: */
1.83      paf        69: class SAPI_Info {
                     70: public:
1.3       paf        71:        LPEXTENSION_CONTROL_BLOCK lpECB;
                     72:        String *header;
                     73:        DWORD http_response_code;
                     74: };
1.38      parser     75: #endif
1.3       paf        76: 
1.26      paf        77: // goes to 'cs-uri-query' log file field. webmaster: switch it ON[default OFF].
1.83      paf        78: void SAPI::log(SAPI_Info& SAPI_info, const char* fmt, ...) {
1.26      paf        79:        va_list args;
                     80:        va_start(args,fmt);
1.99      misha      81:        char buf[MAX_LOG_STRING];
1.83      paf        82:        const char* prefix="PARSER_ERROR:";
1.26      paf        83:        strcpy(buf, prefix);
1.47      parser     84:        char *start=buf+strlen(prefix);
1.99      misha      85:        DWORD size=vsnprintf(start, MAX_LOG_STRING-strlen(prefix), fmt, args);
                     86:        size=remove_crlf(start, start+size);
1.47      parser     87: 
1.114     moko       88:        SAPI_info.lpECB->ServerSupportFunction(SAPI_info.lpECB->ConnID, HSE_APPEND_LOG_PARAMETER, buf, &size, 0);
1.55      parser     89: }
                     90: 
                     91: /// @todo event log
1.114     moko       92: void SAPI::die(const char* fmt, ...) {
                     93:        va_list args;
                     94:        va_start(args, fmt);
1.83      paf        95:        if(FILE *log=fopen("c:\\parser3die.log", "at")) {
1.65      paf        96:                vfprintf(log, fmt, args);
                     97:                fclose(log);
                     98:        }
1.114     moko       99:        // abnormal exit
1.81      paf       100:        abort();
1.90      paf       101: //     va_end(args);
1.83      paf       102: }
1.1       paf       103: 
1.133     moko      104: void SAPI::send_error(SAPI_Info& SAPI_info, const char *exception_cstr, const char *status){
1.130     moko      105:        // capitalized headers passed for preventing malloc during capitalization
1.133     moko      106:        add_header_attribute(SAPI_info, HTTP_STATUS_CAPITALIZED, status);
                    107:        add_header_attribute(SAPI_info, HTTP_CONTENT_TYPE_CAPITALIZED, "text/plain");
                    108:        send_headers(SAPI_info);
                    109:        send_body(SAPI_info, exception_cstr, strlen(exception_cstr));
1.130     moko      110: }
                    111: 
1.107     moko      112: char* SAPI::Env::get(SAPI_Info& SAPI_info, const char* name) {
1.83      paf       113:        char *variable_buf=new(PointerFreeGC) char[MAX_STRING];
1.1       paf       114:        DWORD variable_len = MAX_STRING-1;
                    115: 
1.83      paf       116:        if(SAPI_info.lpECB->GetServerVariable(SAPI_info.lpECB->ConnID, const_cast<char *>(name), 
1.1       paf       117:                variable_buf, &variable_len)) {
1.73      paf       118:                if(*variable_buf) { // saw returning len=1 && *buf=0 :(
                    119:                        variable_buf[variable_len]=0;
                    120:                        return variable_buf;
                    121:                }
1.7       paf       122:        } else if (GetLastError()==ERROR_INSUFFICIENT_BUFFER) {
1.83      paf       123:                variable_buf=new(PointerFreeGC) char[variable_len+1];
1.7       paf       124:                
1.83      paf       125:                if(SAPI_info.lpECB->GetServerVariable(SAPI_info.lpECB->ConnID, const_cast<char *>(name), 
1.7       paf       126:                        variable_buf, &variable_len)) {
1.73      paf       127:                        if(*variable_buf) {
                    128:                                variable_buf[variable_len]=0;
                    129:                                return variable_buf;
                    130:                        }
1.7       paf       131:                }
1.1       paf       132:        }
1.7       paf       133:                
1.1       paf       134:        return 0;
                    135: }
                    136: 
1.118     moko      137: bool SAPI::Env::set(SAPI_Info&, const char*, const char*) {
                    138:        return false;
                    139: }
                    140: 
1.83      paf       141: static int grep_char(const char* s, char c) {
1.72      paf       142:        int result=0;
                    143:        if(s) {
                    144:                while(s=strchr(s, c)) {
                    145:                        s++; // skip found c
                    146:                        result++;
                    147:                }
                    148:        }
                    149:        return result;
                    150: }
1.120     moko      151: 
1.107     moko      152: const char* const *SAPI::Env::get(SAPI_Info& info) {
1.72      paf       153:        // we know this buf is writable
1.107     moko      154:        char* all_http_vars=SAPI::Env::get(info, "ALL_HTTP");
1.72      paf       155:        const int http_var_count=grep_char(all_http_vars, '\n')+1/*\n for theoretical(never saw) this \0*/;
1.90      paf       156: 
1.92      paf       157:        const char* *result=new(PointerFreeGC) const char*[IIS51var_count+http_var_count+1/*0*/];
1.83      paf       158:        const char* *cur=result;
1.72      paf       159: 
                    160:        // IIS5.1 vars
                    161:        for(int i=0; i<IIS51var_count; i++) {
1.83      paf       162:                const char* key=IIS51vars[i];
1.107     moko      163:                if(const char* value=SAPI::Env::get(info, key))
1.120     moko      164:                        *cur++=pa_strcat(key, "=", value);
1.72      paf       165:        }
                    166: 
                    167:        // HTTP_* vars
                    168:        if(char *s=all_http_vars) {
                    169:                while(char *key=lsplit(&s, '\n'))
                    170:                        if(char *value=lsplit(key, ':'))
1.123     moko      171:                                *cur++=pa_strcat(key, "=", value);
1.72      paf       172:        }
                    173:        
                    174:        // mark EOE
1.123     moko      175:        *cur=0;
1.72      paf       176: 
                    177:        return result;
                    178: }
                    179: 
1.83      paf       180: size_t SAPI::read_post(SAPI_Info& SAPI_info, char *buf, size_t max_bytes) {
1.1       paf       181:        DWORD read_from_buf=0;
                    182:        DWORD read_from_input=0;
                    183:        DWORD total_read=0;
                    184: 
1.83      paf       185:        read_from_buf=min(SAPI_info.lpECB->cbAvailable, max_bytes);
                    186:        memcpy(buf, SAPI_info.lpECB->lpbData, read_from_buf);
1.1       paf       187:        total_read+=read_from_buf;
                    188: 
                    189:        if(read_from_buf<max_bytes &&
1.83      paf       190:                read_from_buf<SAPI_info.lpECB->cbTotalBytes) {
1.1       paf       191:                DWORD cbRead=0, cbSize;
                    192: 
1.3       paf       193:                read_from_input=min(max_bytes-read_from_buf, 
1.83      paf       194:                        SAPI_info.lpECB->cbTotalBytes-read_from_buf);
1.1       paf       195:                while(cbRead < read_from_input) {
                    196:                        cbSize=read_from_input - cbRead;
1.83      paf       197:                        if(!SAPI_info.lpECB->ReadClient(SAPI_info.lpECB->ConnID, 
1.3       paf       198:                                buf+read_from_buf+cbRead, &cbSize) || 
1.1       paf       199:                                cbSize==0) 
                    200:                                break;
                    201:                        cbRead+=cbSize;
                    202:                }
                    203:                total_read+=cbRead;
                    204:        }
                    205:        return total_read;
                    206: }
                    207: 
1.117     moko      208: void SAPI::add_header_attribute(SAPI_Info& SAPI_info, const char* dont_store_key, const char* dont_store_value) {
                    209:        if(strcasecmp(dont_store_key, "location")==0)
1.83      paf       210:                SAPI_info.http_response_code=302;
                    211: 
1.117     moko      212:        if(strcasecmp(dont_store_key, HTTP_STATUS)==0)
                    213:                SAPI_info.http_response_code=atoi(dont_store_value);
1.83      paf       214:        else
1.102     misha     215:                (*SAPI_info.header) << capitalize(dont_store_key) << ": " << pa_strdup(dont_store_value) << "\r\n";
1.1       paf       216: }
                    217: 
1.23      paf       218: /// @todo intelligent cache-control
1.131     moko      219: void SAPI::send_headers(SAPI_Info& SAPI_info) {
1.64      paf       220:        HSE_SEND_HEADER_EX_INFO header_info;
1.1       paf       221: 
                    222:        char status_buf[MAX_STATUS_LENGTH];
1.83      paf       223:        switch(SAPI_info.http_response_code) {
1.1       paf       224:                case 200:
                    225:                        header_info.pszStatus="200 OK";
                    226:                        break;
                    227:                case 302:
                    228:                        header_info.pszStatus="302 Moved Temporarily";
                    229:                        break;
1.8       paf       230:                case 401:// useless untill parser auth mech
1.1       paf       231:                        header_info.pszStatus="401 Authorization Required";
1.8       paf       232:                        break;
1.1       paf       233:                default:
1.3       paf       234:                        snprintf(status_buf, MAX_STATUS_LENGTH, 
1.83      paf       235:                                "%d Undescribed", SAPI_info.http_response_code);
1.1       paf       236:                        header_info.pszStatus=status_buf;
                    237:                        break;
                    238:        }
                    239:        header_info.cchStatus=strlen(header_info.pszStatus);
1.83      paf       240:        *SAPI_info.header << "\r\n"; // ISAPI v<5 did quite well without it
                    241:        header_info.pszHeader=SAPI_info.header->cstr();
                    242:        header_info.cchHeader=SAPI_info.header->length();
1.5       paf       243:        header_info.fKeepConn=true;
1.1       paf       244: 
1.83      paf       245:        SAPI_info.lpECB->dwHttpStatusCode=SAPI_info.http_response_code;
1.1       paf       246: 
1.83      paf       247:        SAPI_info.lpECB->ServerSupportFunction(SAPI_info.lpECB->ConnID, 
1.3       paf       248:                HSE_REQ_SEND_RESPONSE_HEADER_EX, &header_info, NULL, NULL);
1.1       paf       249: }
                    250: 
1.133     moko      251: void SAPI::clear_headers(SAPI_Info& SAPI_info) {
                    252:        SAPI_info.header=new String;
1.131     moko      253: }
                    254: 
1.91      paf       255: size_t SAPI::send_body(SAPI_Info& SAPI_info, const void *buf, size_t size) {
1.1       paf       256:        DWORD num_bytes=size;
1.91      paf       257:        if(!SAPI_info.lpECB->WriteClient(SAPI_info.lpECB->ConnID, 
                    258:                const_cast<void *>(buf), &num_bytes, HSE_IO_SYNC))
                    259:                return 0;
                    260:        return (size_t)num_bytes;
1.1       paf       261: }
1.16      paf       262: 
1.1       paf       263: 
1.15      paf       264: static bool parser_init() {
1.1       paf       265:        static bool globals_inited=false;
                    266:        if(globals_inited)
1.15      paf       267:                return true;
1.1       paf       268:        globals_inited=true;
                    269: 
1.53      parser    270:        try {
1.111     moko      271:                // init libraries
1.83      paf       272:                pa_globals_init();
1.15      paf       273:                // successful finish
                    274:                return true;
1.96      paf       275:        } catch(.../*const Exception& e*/) { // global problem 
1.15      paf       276:                // unsuccessful finish
                    277:                return false;
1.1       paf       278:        }
                    279: }
                    280: 
1.89      paf       281: static void parser_done() {
1.111     moko      282:        // finalize libraries
1.89      paf       283:        pa_globals_done();
                    284: }
                    285: 
1.1       paf       286: /// ISAPI //
                    287: BOOL WINAPI GetExtensionVersion(HSE_VERSION_INFO *pVer) {
                    288:        pVer->dwExtensionVersion = HSE_VERSION;
1.127     moko      289:        pa_strncpy(pVer->lpszExtensionDesc, "Parser " PARSER_VERSION, HSE_MAX_EXT_DLL_NAME_LEN);
1.15      paf       290:        return parser_init();
1.89      paf       291: }
                    292: // dwFlags & HSE_TERM_MUST_UNLOAD means we can't return false
                    293: BOOL WINAPI TerminateExtension(
                    294:   DWORD /*dwFlags*/
                    295: )
                    296: {
                    297:        parser_done();
                    298: 
                    299:        return TRUE;
1.1       paf       300: }
                    301: 
1.6       paf       302: /** 
                    303:        ISAPI // main workhorse
                    304: 
1.23      paf       305:        @todo 
1.10      paf       306:                IIS: remove trailing default-document[index.html] from $request.uri.
                    307:                to do that we need to consult metabase,
1.12      paf       308:                wich is tested&works but seems slow runtime 
                    309:                and not could-be-quickly-implemented if prepared.
1.37      parser    310:        @test
                    311:                PARSER_VERSION from outside
1.6       paf       312: */
1.83      paf       313: void real_parser_handler(SAPI_Info& SAPI_info, bool header_only) {
1.88      paf       314:        // collect garbage from prev request
1.126     moko      315:        pa_gc_collect();
1.88      paf       316:        
1.83      paf       317:        SAPI_info.header=new String;
                    318:        LPEXTENSION_CONTROL_BLOCK lpECB=SAPI_info.lpECB;
1.53      parser    319:        
                    320:        // Request info
1.83      paf       321:        Request_info request_info;  memset(&request_info, 0, sizeof(request_info));
1.53      parser    322: 
1.125     moko      323:        char *filespec_to_process=pa_strdup(lpECB->lpszPathTranslated);
1.53      parser    324: #ifdef WIN32
                    325:        back_slashes_to_slashes(filespec_to_process);
                    326: #endif
                    327: 
1.107     moko      328:        if(const char* path_info=SAPI::Env::get(SAPI_info, "PATH_INFO")) {
1.53      parser    329:                // IIS
                    330:                size_t len=strlen(filespec_to_process)-strlen(path_info);
1.127     moko      331:                char *buf=new(PointerFreeGC) char[len];
                    332:                pa_strncpy(buf, filespec_to_process, len);
1.53      parser    333:                request_info.document_root=buf;
                    334:        } else
1.120     moko      335:                throw Exception(PARSER_RUNTIME, 0, "ISAPI: no PATH_INFO defined (in reinventing DOCUMENT_ROOT)");
1.53      parser    336: 
                    337:        request_info.path_translated=filespec_to_process;
                    338:        request_info.method=lpECB->lpszMethod;
                    339:        request_info.query_string=lpECB->lpszQueryString;
1.120     moko      340:        request_info.uri=lpECB->lpszQueryString && *lpECB->lpszQueryString ? pa_strcat(lpECB->lpszPathInfo, "?", lpECB->lpszQueryString) : lpECB->lpszPathInfo;
1.53      parser    341:        request_info.content_type=lpECB->lpszContentType;
                    342:        request_info.content_length=lpECB->cbTotalBytes;
1.107     moko      343:        request_info.cookie=SAPI::Env::get(SAPI_info, "HTTP_COOKIE");
1.76      paf       344:        request_info.mail_received=false;
1.53      parser    345:        
                    346:        // prepare to process request
1.119     moko      347:        Request request(SAPI_info, request_info, String::Language(String::L_HTML|String::L_OPTIMIZE_BIT));
1.53      parser    348: 
1.65      paf       349:        // beside by binary
1.75      paf       350:        static char beside_binary_path[MAX_STRING];
1.127     moko      351:        pa_strncpy(beside_binary_path, argv0, MAX_STRING); // filespec of my binary
1.119     moko      352:        if(!(rsplit(beside_binary_path, '/') || rsplit(beside_binary_path, '\\'))) { // strip filename
1.65      paf       353:                // no path, just filename
1.75      paf       354:                beside_binary_path[0]='.'; beside_binary_path[1]=0;
1.119     moko      355:        }
1.74      paf       356:        char config_filespec[MAX_STRING];
1.119     moko      357:        snprintf(config_filespec, MAX_STRING, "%s/%s", beside_binary_path, AUTO_FILE_NAME);
1.65      paf       358: 
1.53      parser    359:        // process the request
1.119     moko      360:        request.core(entry_exists(config_filespec) ? config_filespec : NULL, header_only);
1.53      parser    361: }
                    362: 
1.92      paf       363: #ifdef PA_SUPPRESS_SYSTEM_EXCEPTION
1.113     moko      364: static const Exception call_real_parser_handler__do_PEH_return_it(SAPI_Info& SAPI_info, bool header_only) {
1.92      paf       365:        try {
                    366:                real_parser_handler(SAPI_info, header_only);
                    367:        } catch(const Exception& e) {
                    368:                return e;
                    369:        }
                    370: 
                    371:        return Exception();
                    372: }
1.113     moko      373: 
                    374: static void call_real_parser_handler__supress_system_exception(SAPI_Info& SAPI_info, bool header_only) {
1.92      paf       375:        Exception parser_exception;
1.53      parser    376:        LPEXCEPTION_POINTERS system_exception=0;
1.92      paf       377: 
1.53      parser    378:        __try {
1.113     moko      379:                parser_exception=call_real_parser_handler__do_PEH_return_it(SAPI_info, header_only);
                    380:        } __except ( (system_exception=GetExceptionInformation()), EXCEPTION_EXECUTE_HANDLER) {
1.53      parser    381:                if(system_exception)
                    382:                        if(_EXCEPTION_RECORD *er=system_exception->ExceptionRecord)
1.113     moko      383:                                throw Exception("system", 0, "0x%08X at 0x%08X", er->ExceptionCode,  er->ExceptionAddress);
1.53      parser    384:                        else
1.113     moko      385:                                throw Exception("system", 0, "<no exception record>");
1.92      paf       386:                else
1.113     moko      387:                        throw Exception("system", 0, "<no exception information>");
1.53      parser    388:        }
1.92      paf       389: 
                    390:        if(parser_exception)
                    391:                throw Exception(parser_exception);
                    392: }
1.53      parser    393: #endif
                    394: 
1.83      paf       395: DWORD WINAPI HttpExtensionProc(LPEXTENSION_CONTROL_BLOCK lpECB) {
                    396:        //_asm int 3;
                    397:        SAPI_Info SAPI_info={
1.15      paf       398:                lpECB,
1.83      paf       399:                0, // filling later: so that if there would be error pool would have SAPI_info
1.80      paf       400:                200 // default http_response_code [lpECB->dwHttpStatusCode seems to be always 0, even on 404 redirect to /404.html]
1.15      paf       401:        };
1.71      paf       402: 
1.1       paf       403:        bool header_only=strcasecmp(lpECB->lpszMethod, "HEAD")==0;
1.53      parser    404:        try { // global try
1.92      paf       405: #ifdef PA_SUPPRESS_SYSTEM_EXCEPTION
                    406:                call_real_parser_handler__supress_system_exception(
                    407: #else
                    408:                real_parser_handler(
                    409: #endif
                    410:                        SAPI_info, header_only);
1.2       paf       411:                // successful finish
1.132     moko      412:        } catch(const Exception& e) { // just in case
1.16      paf       413:                // log it
1.116     moko      414:                SAPI::log(SAPI_info, "%s", e.comment());
1.12      paf       415: 
                    416:                HSE_SEND_HEADER_EX_INFO header_info;
1.132     moko      417:                header_info.pszStatus="500 Internal Server Error";
1.12      paf       418:                header_info.cchStatus=strlen(header_info.pszStatus);
1.116     moko      419:                header_info.pszHeader=HTTP_CONTENT_TYPE_CAPITALIZED ": text/plain\r\n\r\n";
                    420:                header_info.cchHeader=strlen(header_info.pszHeader);
1.12      paf       421:                header_info.fKeepConn=true;
                    422:                
1.1       paf       423:                // send header
1.132     moko      424:                lpECB->dwHttpStatusCode=500;
1.116     moko      425:                lpECB->ServerSupportFunction(lpECB->ConnID, HSE_REQ_SEND_RESPONSE_HEADER_EX, &header_info, NULL, NULL);
1.1       paf       426: 
                    427:                // send body
                    428:                if(!header_only)
1.116     moko      429:                        SAPI::send_body(SAPI_info, e.comment(), strlen(e.comment()));
1.1       paf       430: 
                    431:                // unsuccessful finish
                    432:        }
1.71      paf       433:        return HSE_STATUS_SUCCESS_AND_KEEP_CONN;
1.1       paf       434: }
1.65      paf       435: 
                    436: BOOL WINAPI DllMain(
                    437:   HINSTANCE hinstDLL,  // handle to the DLL module
1.85      paf       438:   DWORD /*fdwReason*/,     // reason for calling function
                    439:   LPVOID /*lpvReserved*/   // reserved
1.65      paf       440:   ) {
                    441: 
                    442:        GetModuleFileName(
                    443:          hinstDLL,    // handle to module
                    444:          argv0,  // file name of module
                    445:          sizeof(argv0)         // size of buffer
                    446:        );
                    447: 
                    448:        return TRUE;
                    449: }

E-mail: