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

1.29      paf         1: /** @file
                      2:        Parser: IIS extension.
                      3: 
                      4:        Copyright (c) 2000,2001 ArtLebedev Group (http://www.artlebedev.com)
                      5: 
                      6:        Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)
                      7: */
1.42    ! parser      8: static const char *RCSId="$Id: parser3isapi.C,v 1.38.4.1 2001/09/13 07:41:45 parser 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
                     13: 
                     14: #include <windows.h>
                     15: #include <process.h>
                     16: 
                     17: #include <httpext.h>
                     18: 
1.9       paf        19: #include "pa_sapi.h"
1.1       paf        20: #include "pa_globals.h"
                     21: #include "pa_request.h"
                     22: #include "pa_version.h"
1.13      paf        23: #include "pool_storage.h"
1.24      paf        24: #include "pa_socks.h"
1.1       paf        25: 
                     26: #define MAX_STATUS_LENGTH sizeof("xxxx LONGEST STATUS DESCRIPTION")
                     27: 
1.18      paf        28: // SAPI
                     29: 
1.38      parser     30: #ifndef DOXYGEN
                     31: /*
1.18      paf        32:        ISAPI SAPI functions receive this context information. 
1.38      parser     33:        see Pool::set_context
1.18      paf        34: */
1.15      paf        35: struct SAPI_func_context {
1.3       paf        36:        LPEXTENSION_CONTROL_BLOCK lpECB;
                     37:        String *header;
                     38:        DWORD http_response_code;
                     39: };
1.38      parser     40: #endif
1.3       paf        41: 
1.26      paf        42: // goes to 'cs-uri-query' log file field. webmaster: switch it ON[default OFF].
                     43: void SAPI::log(Pool& pool, const char *fmt, ...) {
                     44:        SAPI_func_context& ctx=*static_cast<SAPI_func_context *>(pool.context());
                     45:        
                     46:        va_list args;
                     47:        va_start(args,fmt);
                     48:        char buf[MAX_STRING];
                     49:        const char *prefix="PARSER_ERROR:";
                     50:        strcpy(buf, prefix);
                     51:        DWORD size=vsnprintf(buf+strlen(prefix), MAX_STRING-strlen(prefix), fmt, args);
                     52:        
                     53:        ctx.lpECB->ServerSupportFunction(ctx.lpECB->ConnID, 
                     54:                HSE_APPEND_LOG_PARAMETER, buf, &size, 0);
                     55: }
                     56: 
1.9       paf        57: const char *SAPI::get_env(Pool& pool, const char *name) {
1.15      paf        58:        SAPI_func_context& ctx=*static_cast<SAPI_func_context *>(pool.context());
1.1       paf        59: 
                     60:        char *variable_buf=(char *)pool.malloc(MAX_STRING);
                     61:        DWORD variable_len = MAX_STRING-1;
                     62: 
1.3       paf        63:        if(ctx.lpECB->GetServerVariable(ctx.lpECB->ConnID, const_cast<char *>(name), 
1.1       paf        64:                variable_buf, &variable_len)) {
                     65:                variable_buf[variable_len]=0;
                     66:                return variable_buf;
1.7       paf        67:        } else if (GetLastError()==ERROR_INSUFFICIENT_BUFFER) {
                     68:                variable_buf=(char *)pool.malloc(variable_len+1);
                     69:                
                     70:                if(ctx.lpECB->GetServerVariable(ctx.lpECB->ConnID, const_cast<char *>(name), 
                     71:                        variable_buf, &variable_len)) {
                     72:                        variable_buf[variable_len]=0;
                     73:                        return variable_buf;
                     74:                }
1.1       paf        75:        }
1.7       paf        76:                
1.1       paf        77:        return 0;
                     78: }
                     79: 
1.26      paf        80: size_t SAPI::read_post(Pool& pool, char *buf, size_t max_bytes) {
1.15      paf        81:        SAPI_func_context& ctx=*static_cast<SAPI_func_context *>(pool.context());
1.1       paf        82: 
                     83:        DWORD read_from_buf=0;
                     84:        DWORD read_from_input=0;
                     85:        DWORD total_read=0;
                     86: 
1.3       paf        87:        read_from_buf=min(ctx.lpECB->cbAvailable, max_bytes);
                     88:        memcpy(buf, ctx.lpECB->lpbData, read_from_buf);
1.1       paf        89:        total_read+=read_from_buf;
                     90: 
                     91:        if(read_from_buf<max_bytes &&
1.3       paf        92:                read_from_buf<ctx.lpECB->cbTotalBytes) {
1.1       paf        93:                DWORD cbRead=0, cbSize;
                     94: 
1.3       paf        95:                read_from_input=min(max_bytes-read_from_buf, 
                     96:                        ctx.lpECB->cbTotalBytes-read_from_buf);
1.1       paf        97:                while(cbRead < read_from_input) {
                     98:                        cbSize=read_from_input - cbRead;
1.3       paf        99:                        if(!ctx.lpECB->ReadClient(ctx.lpECB->ConnID, 
                    100:                                buf+read_from_buf+cbRead, &cbSize) || 
1.1       paf       101:                                cbSize==0) 
                    102:                                break;
                    103:                        cbRead+=cbSize;
                    104:                }
                    105:                total_read+=cbRead;
                    106:        }
                    107:        return total_read;
                    108: }
                    109: 
1.9       paf       110: void SAPI::add_header_attribute(Pool& pool, const char *key, const char *value) {
1.15      paf       111:        SAPI_func_context& ctx=*static_cast<SAPI_func_context *>(pool.context());
1.3       paf       112: 
                    113:        if(strcasecmp(key, "location")==0) 
                    114:                ctx.http_response_code=302;
                    115: 
                    116:        if(strcasecmp(key, "status")==0) 
                    117:                ctx.http_response_code=atoi(value);
                    118:        else {
                    119:                ctx.header->APPEND_CONST(key);
                    120:                ctx.header->APPEND_CONST(": ");
                    121:                ctx.header->APPEND_CONST(value);
1.30      paf       122:                ctx.header->APPEND_CONST("\r\n");
1.3       paf       123:        }
1.1       paf       124: }
                    125: 
1.23      paf       126: /// @todo intelligent cache-control
1.9       paf       127: void SAPI::send_header(Pool& pool) {
1.15      paf       128:        SAPI_func_context& ctx=*static_cast<SAPI_func_context *>(pool.context());
1.1       paf       129: 
1.6       paf       130:        ctx.header->APPEND_CONST(
1.30      paf       131:                "expires: Fri, 23 Mar 2001 09:32:23 GMT\r\n"
                    132:                "\r\n");
1.1       paf       133:        HSE_SEND_HEADER_EX_INFO header_info;
                    134: 
                    135:        char status_buf[MAX_STATUS_LENGTH];
1.3       paf       136:        switch(ctx.http_response_code) {
1.1       paf       137:                case 200:
                    138:                        header_info.pszStatus="200 OK";
                    139:                        break;
                    140:                case 302:
                    141:                        header_info.pszStatus="302 Moved Temporarily";
                    142:                        break;
1.8       paf       143:                case 401:// useless untill parser auth mech
1.1       paf       144:                        header_info.pszStatus="401 Authorization Required";
1.8       paf       145:                        break;
1.1       paf       146:                default:
1.3       paf       147:                        snprintf(status_buf, MAX_STATUS_LENGTH, 
                    148:                                "%d Undescribed", ctx.http_response_code);
1.1       paf       149:                        header_info.pszStatus=status_buf;
                    150:                        break;
                    151:        }
                    152:        header_info.cchStatus=strlen(header_info.pszStatus);
1.3       paf       153:        header_info.pszHeader=ctx.header->cstr();
                    154:        header_info.cchHeader=ctx.header->size();
1.5       paf       155:        header_info.fKeepConn=true;
1.1       paf       156: 
1.3       paf       157:        ctx.lpECB->dwHttpStatusCode=ctx.http_response_code;
1.1       paf       158: 
1.3       paf       159:        ctx.lpECB->ServerSupportFunction(ctx.lpECB->ConnID, 
                    160:                HSE_REQ_SEND_RESPONSE_HEADER_EX, &header_info, NULL, NULL);
1.1       paf       161: }
                    162: 
1.23      paf       163: void SAPI::send_body(Pool& pool, const void *buf, size_t size) {
1.15      paf       164:        SAPI_func_context& ctx=*static_cast<SAPI_func_context *>(pool.context());
1.1       paf       165: 
                    166:        DWORD num_bytes=size;
1.3       paf       167:        ctx.lpECB->WriteClient(ctx.lpECB->ConnID, 
1.23      paf       168:                const_cast<void *>(buf), &num_bytes, HSE_IO_SYNC);
1.1       paf       169: }
1.16      paf       170: 
1.1       paf       171: // 
                    172: 
1.15      paf       173: static bool parser_init() {
1.1       paf       174:        static bool globals_inited=false;
                    175:        if(globals_inited)
1.15      paf       176:                return true;
1.1       paf       177:        globals_inited=true;
                    178: 
1.13      paf       179:        static Pool pool(0); // global pool
1.1       paf       180:        PTRY {
1.27      paf       181:                // init socks
                    182:                init_socks(pool);
                    183: 
1.32      paf       184:                // init global classes
                    185:                init_methoded_array(pool);
1.1       paf       186:                // init global variables
1.9       paf       187:                pa_globals_init(pool);
1.1       paf       188:                
1.15      paf       189:                // successful finish
                    190:                return true;
1.1       paf       191:        } PCATCH(e) { // global problem 
1.15      paf       192:                //const char *body=e.comment();
                    193:                
                    194:                // unsuccessful finish
                    195:                return false;
1.1       paf       196:        }
                    197:        PEND_CATCH
                    198: }
                    199: 
                    200: /// ISAPI //
                    201: BOOL WINAPI GetExtensionVersion(HSE_VERSION_INFO *pVer) {
                    202:        pVer->dwExtensionVersion = HSE_VERSION;
1.36      parser    203:        strncpy(pVer->lpszExtensionDesc, "Parser "PARSER_VERSION, HSE_MAX_EXT_DLL_NAME_LEN-1);
                    204:        pVer->lpszExtensionDesc[HSE_MAX_EXT_DLL_NAME_LEN-1]=0;
1.15      paf       205:        return parser_init();
1.1       paf       206: }
                    207: 
1.6       paf       208: /** 
                    209:        ISAPI // main workhorse
                    210: 
1.23      paf       211:        @todo 
1.10      paf       212:                IIS: remove trailing default-document[index.html] from $request.uri.
                    213:                to do that we need to consult metabase,
1.12      paf       214:                wich is tested&works but seems slow runtime 
                    215:                and not could-be-quickly-implemented if prepared.
1.37      parser    216:        @test
                    217:                PARSER_VERSION from outside
1.6       paf       218: */
1.1       paf       219: DWORD WINAPI HttpExtensionProc(LPEXTENSION_CONTROL_BLOCK lpECB) {
1.13      paf       220:        Pool_storage pool_storage;
1.15      paf       221:        Pool pool(&pool_storage); // no allocations until assigned context [for reporting]
                    222:        SAPI_func_context ctx={
                    223:                lpECB,
1.18      paf       224:                0, // filling later: so that if there would be error pool would have ctx
1.39      parser    225:                200 // default http_response_code
1.15      paf       226:        };
1.41      parser    227:        _asm nop; // int 3;
1.15      paf       228:        pool.set_context(&ctx);// no allocations before this line!
1.2       paf       229:        
1.1       paf       230:        bool header_only=strcasecmp(lpECB->lpszMethod, "HEAD")==0;
                    231:        PTRY { // global try
1.12      paf       232:                ctx.header=new(pool) String(pool);
1.3       paf       233:                
1.2       paf       234:                // Request info
                    235:                Request::Info request_info;
1.14      paf       236: 
                    237:                size_t path_translated_buf_size=strlen(lpECB->lpszPathTranslated)+1;
                    238:                char *filespec_to_process=(char *)malloc(path_translated_buf_size);
                    239:                memcpy(filespec_to_process, lpECB->lpszPathTranslated, path_translated_buf_size);
                    240: #ifdef WIN32
                    241:                back_slashes_to_slashes(filespec_to_process);
                    242: #endif
                    243: 
1.11      paf       244:                if(const char *path_info=SAPI::get_env(pool, "PATH_INFO")) {
                    245:                        // IIS
                    246:                        size_t len=strlen(filespec_to_process)-strlen(path_info);
                    247:                        char *buf=(char *)pool.malloc(len+1);
1.36      parser    248:                        strncpy(buf, filespec_to_process, len); buf[len]=0;
1.11      paf       249:                        request_info.document_root=buf;
                    250:                } else
1.6       paf       251:                        PTHROW(0, 0,
                    252:                                0,
1.11      paf       253:                                "ISAPI: no PATH_INFO defined (in reinventing DOCUMENT_ROOT)");
1.6       paf       254: 
1.11      paf       255:                request_info.path_translated=filespec_to_process;
1.2       paf       256:                request_info.method=lpECB->lpszMethod;
                    257:                request_info.query_string=lpECB->lpszQueryString;
                    258:                if(lpECB->lpszQueryString && *lpECB->lpszQueryString) {
1.7       paf       259:                        char *reconstructed_uri=(char *)malloc(
                    260:                                strlen(lpECB->lpszPathInfo)+1/*'?'*/+
                    261:                                strlen(lpECB->lpszQueryString)+1/*0*/);
                    262:                        strcpy(reconstructed_uri, lpECB->lpszPathInfo);
1.2       paf       263:                        strcat(reconstructed_uri, "?");
1.7       paf       264:                        strcat(reconstructed_uri, lpECB->lpszQueryString);
1.2       paf       265:                        request_info.uri=reconstructed_uri;
                    266:                } else
                    267:                        request_info.uri=lpECB->lpszPathInfo;
                    268:                
                    269:                request_info.content_type=lpECB->lpszContentType;
                    270:                request_info.content_length=lpECB->cbTotalBytes;
1.9       paf       271:                request_info.cookie=SAPI::get_env(pool, "HTTP_COOKIE");
1.20      paf       272:                request_info.user_agent=SAPI::get_env(pool, "HTTP_USER_AGENT");
                    273: 
1.2       paf       274:                
                    275:                // prepare to process request
                    276:                Request request(pool,
                    277:                        request_info,
1.33      paf       278:                        String::UL_USER_HTML
1.2       paf       279:                        );
1.15      paf       280: 
1.2       paf       281:                // some root-controlled location
1.7       paf       282:                //   c:\windows
1.42    ! parser    283:                char root_config_path[MAX_STRING];
        !           284:                GetWindowsDirectory(root_config_path, MAX_STRING);
1.7       paf       285:                // must be dynamic: rethrowing from request.core 
                    286:                //   may return 'source' which can be inside of 'root auto.p@exeception'
1.42    ! parser    287:                char *root_config_filespec=(char *)pool.malloc(MAX_STRING);
        !           288:                snprintf(root_config_filespec, MAX_STRING, 
        !           289:                        "%s/%s", 
        !           290:                        root_config_path, CONFIG_FILE_NAME);
1.4       paf       291: 
1.2       paf       292:                // process the request
                    293:                request.core(
1.42    ! parser    294:                        root_config_filespec, false/*may be abcent*/, // /path/to/admin/auto.p
1.2       paf       295:                        0/*parser_site_auto_path*/, false, // /path/to/site/auto.p
                    296:                        header_only);
                    297:                // successful finish
1.12      paf       298:        } PCATCH(e) { // global problem
                    299:                // don't allocate anything on pool here:
                    300:                //   possible pool' exception not catch-ed now
1.31      paf       301:                        //   and there could be out-of-memory exception
1.1       paf       302:                const char *body=e.comment();
1.16      paf       303:                // log it
                    304:                SAPI::log(pool, "exception in request exception handler: %s", body);
                    305: 
                    306:                //
1.1       paf       307:                int content_length=strlen(body);
                    308: 
1.12      paf       309:                // prepare header // not using SAPI func wich allocates on pool
                    310:                char header_buf[MAX_STRING];
                    311:                int header_len=snprintf(header_buf, MAX_STRING,
1.30      paf       312:                        "content-type: text/plain\r\n"
                    313:                        "content-length: %lu\r\n"
                    314:                        "expires: Fri, 23 Mar 2001 09:32:23 GMT\r\n"
                    315:                        "\r\n",
1.12      paf       316:                        content_length);
                    317: 
                    318:                HSE_SEND_HEADER_EX_INFO header_info;
                    319:                header_info.pszStatus="200 OK";
                    320:                header_info.cchStatus=strlen(header_info.pszStatus);
                    321:                header_info.pszHeader=header_buf;
                    322:                header_info.cchHeader=header_len;
                    323:                header_info.fKeepConn=true;
                    324:                
1.1       paf       325:                // send header
1.12      paf       326:                lpECB->dwHttpStatusCode=200;
                    327:                lpECB->ServerSupportFunction(lpECB->ConnID, 
                    328:                        HSE_REQ_SEND_RESPONSE_HEADER_EX, &header_info, NULL, NULL);
1.1       paf       329: 
                    330:                // send body
                    331:                if(!header_only)
1.9       paf       332:                        SAPI::send_body(pool, body, content_length);
1.1       paf       333: 
                    334:                // unsuccessful finish
                    335:        }
                    336:        PEND_CATCH
                    337:        
1.6       paf       338:        return HSE_STATUS_SUCCESS_AND_KEEP_CONN;
1.1       paf       339: }

E-mail: