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