Annotation of parser3/src/targets/apache/mod_parser3_core.C, revision 1.43

1.1       moko        1: /** @file
1.8       moko        2: Parser: apache 1.3/2.X module, part, compiled by parser3project.
1.1       moko        3: 
1.37      moko        4:        Copyright (c) 2001-2024 Art. Lebedev Studio (http://www.artlebedev.com)
1.36      moko        5:        Authors: Konstantin Morshnev <moko@design.ru>, Alexandr Petrosian <paf@design.ru>
1.1       moko        6: */
                      7: 
1.43    ! moko        8: volatile const char * IDENT_MOD_PARSER3_CORE_C="$Id: mod_parser3_core.C,v 1.42 2024/12/06 00:40:12 moko Exp $";
1.1       moko        9: 
                     10: #include "pa_config_includes.h"
                     11: 
                     12: #include "pa_globals.h"
                     13: 
                     14: #include "pa_httpd.h"
                     15: 
                     16: #include "pa_common.h"
                     17: #include "pa_sapi.h"
                     18: #include "classes.h"
                     19: #include "pa_request.h"
                     20: 
1.17      moko       21: #if defined(_MSC_VER) && !defined(_DEBUG)
1.9       moko       22: #      include <windows.h>
1.1       moko       23: #      define PA_SUPPRESS_SYSTEM_EXCEPTION
                     24: #endif
                     25: 
                     26: // generals
                     27: 
1.7       moko       28: static bool globals_inited=false;
1.42      moko       29: const char* parser3_mode="apache"; // $status:mode
1.43    ! moko       30: const char *parser3_log_filespec(){ return ""; } // $status:log-filename
1.7       moko       31: 
1.1       moko       32: void pa_setup_module_cells() {
                     33:        if(globals_inited)
                     34:                return;
                     35:        globals_inited=true;
                     36:        
                     37:        /// no trying to __try here [yet]
                     38:        try {
1.18      moko       39:                // init libraries
1.1       moko       40:                pa_globals_init();
                     41:        } catch(const Exception& e) { // global problem 
1.21      moko       42:                SAPI::die("setup_module_cells failed: %s", e.comment());
1.1       moko       43:        }
                     44: }
                     45: 
                     46: void pa_destroy_module_cells() {
1.7       moko       47:        if(!globals_inited)
                     48:                return;
                     49: 
1.1       moko       50:        pa_globals_done();
                     51: }
                     52: 
                     53: 
                     54: //@{
                     55: /// SAPI func decl
                     56: 
                     57: class SAPI_Info {
                     58: public:
                     59:        pa_request_rec* r;
                     60: };
                     61: 
                     62: void SAPI::log(SAPI_Info& SAPI_info, const char* fmt, ...) {
                     63:        va_list args;
                     64:        va_start(args,fmt);
                     65:        char buf[MAX_LOG_STRING];
                     66:        size_t size=vsnprintf(buf, MAX_LOG_STRING, fmt, args);
                     67:        size=remove_crlf(buf, buf+size);
                     68:        pa_ap_log_rerror(0, 0, PA_APLOG_ERR | PA_APLOG_NOERRNO, SAPI_info.r, "%s", buf);
                     69:        va_end(args);
                     70: }
                     71: 
1.21      moko       72: void SAPI::die(const char* fmt, ...) {
                     73:        va_list args;
                     74:        va_start(args, fmt);
1.1       moko       75:        char buf[MAX_LOG_STRING];
                     76:        size_t size=vsnprintf(buf, MAX_LOG_STRING, fmt, args);
                     77:        size=remove_crlf(buf, buf+size);
                     78:        pa_ap_log_error(PA_APLOG_MARK, PA_APLOG_EMERG, 0, "%s", buf);
1.21      moko       79:        exit(1);
                     80: //     va_end(args);
1.1       moko       81: }
                     82: 
1.41      moko       83: void SAPI::send_error(SAPI_Info& SAPI_info, const char *exception_cstr, const char *status){
1.38      moko       84:        // capitalized headers passed for preventing malloc during capitalization
1.41      moko       85:        add_header_attribute(SAPI_info, HTTP_STATUS_CAPITALIZED, status);
                     86:        add_header_attribute(SAPI_info, HTTP_CONTENT_TYPE_CAPITALIZED, "text/plain");
                     87:        send_headers(SAPI_info);
                     88:        send_body(SAPI_info, exception_cstr, strlen(exception_cstr));
1.38      moko       89: }
                     90: 
1.11      moko       91: char* SAPI::Env::get(SAPI_Info& SAPI_info, const char* name) {
1.1       moko       92:        const char* dont_return_me=pa_ap_table_get(SAPI_info.r->subprocess_env, name);
                     93:        return dont_return_me?pa_strdup(dont_return_me):0;
                     94: }
                     95: 
1.28      moko       96: bool SAPI::Env::set(SAPI_Info&, const char*, const char*) {
                     97:        return false;
                     98: }
                     99: 
1.1       moko      100: #ifndef DOXYGEN
                    101: struct SAPI_environment_append_info {
                    102:        const char** cur;
                    103: };
                    104: #endif
1.22      moko      105: 
1.1       moko      106: static int SAPI_environment_append(void *d, const char* k, const char* val) {
1.26      moko      107:        if(k && val) {
                    108:                SAPI_environment_append_info& info=*static_cast<SAPI_environment_append_info *>(d);
1.30      moko      109:                *info.cur++=pa_strcat(k, "=", val);
1.1       moko      110:        }
                    111:        return 1/*true*/;
                    112: }
1.22      moko      113: 
1.11      moko      114: const char* const* SAPI::Env::get(SAPI_Info& SAPI_info) {
1.1       moko      115:        const pa_table *t=SAPI_info.r->subprocess_env;
1.35      moko      116:        const char** result=new(PointerGC) const char*[pa_ap_table_size(t)+1/*0*/];
1.1       moko      117:        SAPI_environment_append_info info={result};
                    118:        pa_ap_table_do(SAPI_environment_append, &info, t, 0); *info.cur=0; // mark EOE
                    119:        return result;
                    120: }
                    121: 
                    122: size_t SAPI::read_post(SAPI_Info& SAPI_info, char *buf, size_t max_bytes) {
1.21      moko      123: //     pa_ap_log_error(PA_APLOG_MARK, PA_APLOG_DEBUG, SAPI_info.r->server, "mod_parser3: SAPI::read_post(max=%u)", max_bytes);
                    124: 
1.1       moko      125:        int retval;
                    126:        if((retval = pa_ap_setup_client_block(SAPI_info.r, PA_REQUEST_CHUNKED_ERROR)))
                    127:                return 0;
                    128:        if(!pa_ap_should_client_block(SAPI_info.r))
                    129:                return 0;
                    130:        
                    131:        uint total_read_bytes=0;
                    132:        void (*handler)(int)=pa_signal(PA_SIGPIPE, PA_SIG_IGN);
                    133:        while (total_read_bytes<max_bytes) {
                    134:                pa_ap_hard_timeout("Read POST information", SAPI_info.r); /* start timeout timer */
                    135:                uint read_bytes=
                    136:                        pa_ap_get_client_block(SAPI_info.r, buf+total_read_bytes, max_bytes-total_read_bytes);
                    137:                pa_ap_reset_timeout(SAPI_info.r);
                    138:                if (read_bytes<=0)
                    139:                        break;
                    140:                total_read_bytes+=read_bytes;
                    141:        }
                    142:        pa_signal(PA_SIGPIPE, handler);
                    143:        return total_read_bytes;
                    144: }
                    145: 
                    146: /// @test location provide with protocol. think about internal redirects
1.22      moko      147: void SAPI::add_header_attribute(SAPI_Info& SAPI_info, const char* dont_store_key, const char* dont_store_value) {
1.1       moko      148:        if(strcasecmp(dont_store_key, "location")==0) 
                    149:                *SAPI_info.r->status=302;
                    150:        
                    151:        if(strcasecmp(dont_store_key, HTTP_CONTENT_TYPE)==0) {
                    152:        /* r->content_type, *not* r->headers_out("Content-type").  If you don't
                    153:        * set it, it will be filled in with the server's default type (typically
                    154:        * "text/plain").  You *must* also ensure that r->content_type is lower
                    155:        * case.
                    156:                */
                    157:                *SAPI_info.r->content_type = pa_ap_pstrdup(SAPI_info.r->pool, dont_store_value);
                    158:        } else if(strcasecmp(dont_store_key, HTTP_STATUS)==0) 
1.25      moko      159:                *SAPI_info.r->status=atoi(dont_store_value);
1.1       moko      160:        else
                    161:                pa_ap_table_addn(SAPI_info.r->headers_out, 
                    162:                pa_ap_pstrdup(SAPI_info.r->pool, capitalize(dont_store_key)), 
                    163:                pa_ap_pstrdup(SAPI_info.r->pool, dont_store_value));
                    164: }
                    165: 
1.39      moko      166: void SAPI::send_headers(SAPI_Info& SAPI_info) {
1.1       moko      167:        pa_ap_hard_timeout("Send header", SAPI_info.r);
                    168:        pa_ap_send_http_header(SAPI_info.r);
                    169:        pa_ap_kill_timeout(SAPI_info.r);
                    170: }
                    171: 
1.41      moko      172: void SAPI::clear_headers(SAPI_Info&) {
1.39      moko      173: }
                    174: 
1.1       moko      175: size_t SAPI::send_body(SAPI_Info& SAPI_info, const void *buf, size_t size) {
                    176:        pa_ap_hard_timeout("Send body", SAPI_info.r);
                    177:        size = (size_t)pa_ap_rwrite(buf, size, SAPI_info.r);
                    178:        pa_ap_kill_timeout(SAPI_info.r);
                    179:        return size;
                    180: }
                    181: 
                    182: //@}
                    183: 
                    184: /**
                    185: main workhorse
                    186:        @todo intelligent cache-control
                    187: */
                    188: static void real_parser_handler(SAPI_Info& SAPI_info, Parser_module_config *dcfg) {
                    189:        // collect garbage from prev request
1.34      moko      190:        pa_gc_collect();
1.1       moko      191: 
                    192:        // populate env
                    193:        pa_ap_add_common_vars(SAPI_info.r);
                    194:        pa_ap_add_cgi_vars(SAPI_info.r);
                    195:        
                    196:        // Request info
                    197:        Request_info request_info;  memset(&request_info, 0, sizeof(request_info));
                    198:        
1.11      moko      199:        request_info.document_root=SAPI::Env::get(SAPI_info, "DOCUMENT_ROOT");
1.1       moko      200:        request_info.path_translated=SAPI_info.r->filename;
                    201:        request_info.method=SAPI_info.r->method;
                    202:        request_info.query_string=SAPI_info.r->args;
1.15      moko      203:        request_info.uri=request_info.strip_absolute_uri(SAPI::Env::get(SAPI_info, "REQUEST_URI"));
1.11      moko      204:        request_info.content_type=SAPI::Env::get(SAPI_info, "CONTENT_TYPE");
1.27      moko      205:        request_info.content_length=pa_atoul(SAPI::Env::get(SAPI_info, "CONTENT_LENGTH"));
1.11      moko      206:        request_info.cookie=SAPI::Env::get(SAPI_info, "HTTP_COOKIE");
1.1       moko      207:        request_info.mail_received=false;
                    208:        
                    209:        // prepare to process request
1.29      moko      210:        Request request(SAPI_info, request_info, String::Language(String::L_HTML|String::L_OPTIMIZE_BIT));
1.1       moko      211:        
                    212:        // process the request
1.31      moko      213:        const char *config=dcfg->parser_config_filespec;
                    214: #ifdef SYSTEM_CONFIG_FILE
                    215:        if(!config && entry_exists(SYSTEM_CONFIG_FILE)){
                    216:                config=SYSTEM_CONFIG_FILE;
                    217:        }
                    218: #endif
                    219:        request.core(config, SAPI_info.r->header_only!=0);
1.1       moko      220: }
                    221: 
                    222: #ifdef PA_SUPPRESS_SYSTEM_EXCEPTION
1.20      moko      223: static const Exception call_real_parser_handler__do_PEH_return_it(SAPI_Info& SAPI_info, Parser_module_config *dcfg) {
1.1       moko      224:        try {
                    225:                real_parser_handler(SAPI_info, dcfg);
                    226:        } catch(const Exception& e) {
                    227:                return e;
                    228:        }
                    229: 
                    230:        return Exception();
                    231: }
1.20      moko      232: 
                    233: static void call_real_parser_handler__supress_system_exception(SAPI_Info& SAPI_info, Parser_module_config *dcfg) {
1.1       moko      234:        Exception parser_exception;
                    235:        LPEXCEPTION_POINTERS system_exception=0;
                    236: 
                    237:        __try {
1.20      moko      238:                parser_exception=call_real_parser_handler__do_PEH_return_it(SAPI_info, dcfg);
                    239:        } __except ( (system_exception=GetExceptionInformation()), EXCEPTION_EXECUTE_HANDLER) {
1.1       moko      240:                if(system_exception)
                    241:                        if(_EXCEPTION_RECORD *er=system_exception->ExceptionRecord)
1.20      moko      242:                                throw Exception("system", 0, "0x%08X at 0x%08X", er->ExceptionCode,  er->ExceptionAddress);
1.1       moko      243:                        else
1.20      moko      244:                                throw Exception("system", 0, "<no exception record>");
1.1       moko      245:                else
1.20      moko      246:                        throw Exception("system", 0, "<no exception information>");
1.1       moko      247:        }
                    248: 
                    249:        if(parser_exception)
                    250:                throw Exception(parser_exception);
                    251: }
                    252: #endif
                    253: 
                    254: /// @test r->finfo.st_mode check seems to work only on win32
                    255: int pa_parser_handler(pa_request_rec *r, Parser_module_config *dcfg) {
                    256:        // SAPI info
                    257:        SAPI_Info SAPI_info; SAPI_info.r=r;
                    258:        
1.24      moko      259:        if(r->file_not_found)
1.1       moko      260:                return PA_HTTP_NOT_FOUND;
                    261:        
                    262:        try { // global try
                    263: #ifdef PA_SUPPRESS_SYSTEM_EXCEPTION
                    264:                call_real_parser_handler__supress_system_exception(
                    265: #else
                    266:                real_parser_handler(
                    267: #endif
                    268:                        SAPI_info, dcfg);
                    269: 
                    270:                // successful finish
1.40      moko      271:        } catch(const Exception& e) { // just in case
1.1       moko      272:                // log it
1.24      moko      273:                SAPI::log(SAPI_info, "%s", e.comment());
1.26      moko      274:                SAPI::send_error(SAPI_info, e.comment());
1.1       moko      275:        }
                    276:        
                    277:        /*
                    278:        * We did what we wanted to do, so tell the rest of the server we
                    279:        * succeeded.
                    280:        */
                    281:        return PA_OK;
                    282: }

E-mail: