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