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

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

E-mail: