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

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

E-mail: