Annotation of parser3/src/main/pa_request.C, revision 1.334

1.54      paf         1: /** @file
1.55      paf         2:        Parser: request class main part. @see compile.C and execute.C.
                      3: 
1.329     moko        4:        Copyright (c) 2001-2012 Art. Lebedev Studio (http://www.artlebedev.com)
1.194     paf         5:        Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
1.218     paf         6: */
1.55      paf         7: 
1.69      paf         8: #include "pa_sapi.h"
1.53      paf         9: #include "pa_common.h"
1.1       paf        10: #include "pa_request.h"
1.3       paf        11: #include "pa_wwrapper.h"
                     12: #include "pa_vclass.h"
1.31      paf        13: #include "pa_globals.h"
1.30      paf        14: #include "pa_vint.h"
1.297     misha      15: #include "pa_vmethod_frame.h"
1.32      paf        16: #include "pa_types.h"
1.248     paf        17: #include "pa_venv.h"
                     18: #include "pa_vmath.h"
                     19: #include "pa_vstatus.h"
                     20: #include "pa_vrequest.h"
1.78      paf        21: #include "pa_vtable.h"
1.90      paf        22: #include "pa_vfile.h"
1.147     parser     23: #include "pa_dictionary.h"
1.208     paf        24: #include "pa_charset.h"
1.186     paf        25: #include "pa_charsets.h"
1.248     paf        26: #include "pa_cache_managers.h"
                     27: #include "pa_vmail.h"
                     28: #include "pa_vform.h"
                     29: #include "pa_vcookie.h"
                     30: #include "pa_vresponse.h"
                     31: #include "pa_vmemory.h"
1.253     paf        32: #include "pa_vconsole.h"
1.267     paf        33: #include "pa_vdate.h"
1.159     parser     34: 
1.334   ! moko       35: volatile const char * IDENT_PA_REQUEST_C="$Id: pa_request.C,v 1.333 2013/07/23 14:29:02 moko Exp $" IDENT_PA_REQUEST_H IDENT_PA_REQUEST_CHARSETS_H IDENT_PA_REQUEST_INFO_H IDENT_PA_VCONSOLE_H;
1.329     moko       36: 
1.248     paf        37: // consts
                     38: 
1.269     paf        39: #define UNHANDLED_EXCEPTION_METHOD_NAME "unhandled_exception"
1.207     paf        40: 
1.82      paf        41: /// content type of exception response, when no @MAIN:exception handler defined
1.248     paf        42: const char* UNHANDLED_EXCEPTION_CONTENT_TYPE="text/plain";
1.82      paf        43: 
                     44: /// content type of response when no $MAIN:defaults.content-type defined
1.248     paf        45: const char* DEFAULT_CONTENT_TYPE="text/html";
                     46: const char* ORIGINS_CONTENT_TYPE="text/plain";
                     47: 
                     48: // defines for globals
                     49: 
                     50: #define MAIN_METHOD_NAME "main"
                     51: #define AUTO_METHOD_NAME "auto"
1.309     misha      52: #define AUTOUSE_METHOD_NAME "autouse"
1.248     paf        53: #define BODY_NAME "body"
                     54: #define EXCEPTION_TYPE_PART_NAME "type"
                     55: #define EXCEPTION_SOURCE_PART_NAME "source"
                     56: #define EXCEPTION_COMMENT_PART_NAME "comment"
                     57: 
                     58: // globals
                     59: 
                     60: const String main_method_name(MAIN_METHOD_NAME);
                     61: const String auto_method_name(AUTO_METHOD_NAME);
1.309     misha      62: const String autouse_method_name(AUTOUSE_METHOD_NAME);
1.311     misha      63: 
1.248     paf        64: const String body_name(BODY_NAME);
                     65: const String exception_type_part_name(EXCEPTION_TYPE_PART_NAME);
                     66: const String exception_source_part_name(EXCEPTION_SOURCE_PART_NAME);
                     67: const String exception_comment_part_name(EXCEPTION_COMMENT_PART_NAME);
                     68: const String exception_handled_part_name(EXCEPTION_HANDLED_PART_NAME);
                     69: 
                     70: // defines for statics
                     71: 
                     72: #define CHARSETS_NAME "CHARSETS"
                     73: #define MIME_TYPES_NAME "MIME-TYPES"
1.330     moko       74: #define STRICT_VARS_NAME "STRICT-VARS"
1.248     paf        75: #define ORIGINS_MODE_NAME "ORIGINS"
                     76: #define CONF_METHOD_NAME "conf"
                     77: #define POST_PROCESS_METHOD_NAME "postprocess"
                     78: #define DOWNLOAD_NAME "download"
                     79: #define CLASS_PATH_NAME "CLASS_PATH"
1.277     paf        80: #define RESPONSE_BODY_FILE_NAME "file"
1.248     paf        81: 
                     82: // statics
                     83: 
                     84: static const String charsets_name(CHARSETS_NAME);
                     85: static const String main_class_name(MAIN_CLASS_NAME);
                     86: static const String mime_types_name(MIME_TYPES_NAME);
1.330     moko       87: static const String strict_vars_name(STRICT_VARS_NAME);
1.248     paf        88: static const String origins_mode_name(ORIGINS_MODE_NAME);
                     89: static const String conf_method_name(CONF_METHOD_NAME);
                     90: static const String post_process_method_name(POST_PROCESS_METHOD_NAME);
                     91: static const String download_name(DOWNLOAD_NAME);
                     92: static const String class_path_name(CLASS_PATH_NAME);
1.277     paf        93: static const String response_body_file_name(RESPONSE_BODY_FILE_NAME);
1.248     paf        94: 
                     95: // defines
1.82      paf        96: 
1.233     paf        97: // op.C
1.248     paf        98: VStateless_class& VClassMAIN_create();
1.123     paf        99: 
1.157     parser    100: //
1.248     paf       101: Request::Request(SAPI_Info& asapi_info, Request_info& arequest_info, 
1.325     moko      102:                                 String::Language adefault_lang):
1.248     paf       103:        // private
                    104:        anti_endless_execute_recoursion(0),
                    105: 
                    106:        // public
                    107:        method_frame(0),
                    108:        rcontext(0),
                    109:        wcontext(0),
                    110:        flang(adefault_lang),
1.191     paf       111:        fconnection(0),
1.307     misha     112:        finterrupted(false),
                    113:        fskip(SKIP_NOTHING),
                    114:        fin_cycle(0),
1.248     paf       115: 
                    116:        // public
1.257     paf       117:        request_info(arequest_info),
1.248     paf       118:        sapi_info(asapi_info),
                    119:        charsets(UTF8_charset, UTF8_charset, UTF8_charset), // default charsets
                    120: 
                    121:        main_class(VClassMAIN_create()),
1.260     paf       122:        form(*new VForm(charsets, arequest_info)),
1.248     paf       123:        mail(*new VMail),
                    124:        response(*new VResponse(arequest_info, charsets)),
1.298     misha     125:        cookie(*new VCookie(charsets, arequest_info)),
1.285     misha     126:        console(*new VConsole),
1.248     paf       127: 
                    128:        // private
                    129:        configure_admin_done(false),
                    130: 
                    131:        // private defaults
                    132:        fdefault_lang(adefault_lang), 
                    133:        // private mime types
                    134:        mime_types(0)
1.157     parser    135: {
1.261     paf       136:        pa_register_thread_request(*this);
                    137: 
1.248     paf       138:        // file_no=0 => unknown
1.263     paf       139:        file_list+=String::Body("UNKNOWN");
                    140:        file_list+=String::Body("-body of process-"); // pseudo_file_no__process
1.186     paf       141: 
1.178     paf       142:        // maybe expire old caches
1.264     paf       143:        cache_managers->maybe_expire();
1.178     paf       144:        
1.157     parser    145:        /// directly used
1.233     paf       146:        // MAIN class, operators
1.235     paf       147:        classes().put(main_class.name(), &main_class);
1.157     parser    148:        // classes:
                    149:        // table, file, random, mail, image, ...
1.248     paf       150:        methoded_array().register_directly_used(*this);
1.157     parser    151: 
                    152:        /// methodless
                    153:        // env class
1.249     paf       154:        classes().put(String::Body(ENV_CLASS_NAME), new VEnv(asapi_info));
1.175     paf       155:        // status class
1.325     moko      156:        classes().put(String::Body(STATUS_CLASS_NAME), new VStatus());
1.157     parser    157:        // request class
1.294     misha     158:        classes().put(String::Body(REQUEST_CLASS_NAME), new VRequest(arequest_info, charsets, form));   
1.157     parser    159:        // cookie class
1.249     paf       160:        classes().put(String::Body(COOKIE_CLASS_NAME), &cookie);
1.253     paf       161:        // console class
1.285     misha     162:        classes().put(String::Body(CONSOLE_CLASS_NAME), &console);
1.157     parser    163:        /// methoded
                    164:        // response class
1.248     paf       165:        classes().put(response.get_class()->name(), &response);
1.157     parser    166: 
                    167:        /// bases used
                    168:        // form class
1.248     paf       169:        classes().put(form.get_class()->base_class()->name(), &form);
1.213     paf       170:        // mail class
1.248     paf       171:        classes().put(mail.get_class()->base_class()->name(), &mail);
1.157     parser    172:        // math class
1.248     paf       173:        {
                    174:                Value& math=*new VMath;
                    175:                classes().put(math.get_class()->base_class()->name(), &math);
                    176:        }
                    177:        // memory class
                    178:        {
                    179:                Value& memory=*new VMemory;
                    180:                classes().put(memory.get_class()->base_class()->name(), &memory);
                    181:        }
1.117     paf       182: }
1.192     paf       183: 
                    184: Request::~Request() {
                    185: #ifdef XML
                    186:        // if for some strange reason xml generic errors failed to be reported, free them up
1.248     paf       187:        if(const char* xml_generic_errors=xmlGenericErrors()) {
                    188:                SAPI::log(sapi_info, "warning: unreported xmlGenericErrors: %s", xml_generic_errors);
1.192     paf       189:                free((void *)xml_generic_errors);
                    190:        }
                    191: #endif
                    192: }
1.236     paf       193: 
1.248     paf       194: Value& Request::get_self() { return method_frame/*always have!*/->self(); }
1.192     paf       195: 
1.309     misha     196: Value* Request::get_class(const String& name){
                    197:        Value* result=classes().get(name);
1.313     misha     198:        if(!result)
1.309     misha     199:                if(Value* value=main_class.get_element(autouse_method_name))
                    200:                        if(Junction* junction=value->get_junction())
                    201:                                if(const Method *method=junction->method) {
                    202:                                        Value *vname=new VString(name);
1.322     moko      203:                                        VMethodFrame frame(*method, 0 /*no parent*/, main_class);
1.309     misha     204: 
                    205:                                        frame.store_params(&vname, 1);
                    206:                                        // we don't need the result
1.323     moko      207:                                        execute_method(frame);
1.309     misha     208: 
                    209:                                        result=classes().get(name);
                    210:                                }
1.313     misha     211: 
1.309     misha     212:        return result;
                    213: }
                    214: 
1.248     paf       215: static void load_charset(HashStringValue::key_type akey, 
                    216:                         HashStringValue::value_type avalue, 
                    217:                         Request_charsets* charsets) {
1.249     paf       218:        const String::Body NAME=String(akey, String::L_CLEAN).change_case(charsets->source(), String::CC_UPPER);
1.248     paf       219:        ::charsets.load_charset(*charsets, NAME, avalue->as_string());
1.208     paf       220: }
1.248     paf       221: void Request::configure_admin(VStateless_class& conf_class) {
1.208     paf       222:        if(configure_admin_done)
1.286     misha     223:                throw Exception(PARSER_RUNTIME,
1.248     paf       224:                0,
1.208     paf       225:                "parser already configured");
                    226:        configure_admin_done=true;
                    227:        
1.227     paf       228:        // charsets must only be specified in method_frame config
1.208     paf       229:        // so that users would not interfere
                    230: 
                    231:        /* $MAIN:CHARSETS[
                    232:                        $.charsetname1[/full/path/to/charset/file.cfg]
                    233:                        ...
                    234:                ]
                    235:        */
1.308     misha     236:        if(Value* vcharsets=conf_class.get_element(charsets_name)) {
1.240     paf       237:                if(!vcharsets->is_string())
1.248     paf       238:                        if(HashStringValue* charsets=vcharsets->get_hash())
1.281     paf       239:                                charsets->for_each<Request_charsets*>(load_charset, &this->charsets);
1.240     paf       240:                        else
1.286     misha     241:                                throw Exception(PARSER_RUNTIME,
1.240     paf       242:                                        0,
                    243:                                        "$" MAIN_CLASS_NAME ":" CHARSETS_NAME " must be hash");
1.208     paf       244:        }
                    245: 
1.330     moko      246: #ifdef STRICT_VARS
1.332     moko      247:        VVoid::strict_vars=false;
1.330     moko      248:        if(Value* strict_vars=conf_class.get_element(strict_vars_name)) {
                    249:                if(strict_vars->is_bool())
                    250:                        VVoid::strict_vars=strict_vars->as_bool();
                    251:                        else
                    252:                                throw Exception(PARSER_RUNTIME,
                    253:                                        0,
                    254:                                        "$" MAIN_CLASS_NAME ":" STRICT_VARS_NAME " must be bool");
                    255:        }
                    256: #endif
                    257: 
1.227     paf       258:        // configure method_frame options
1.208     paf       259:        //      until someone with less privileges have overriden them
1.248     paf       260:        methoded_array().configure_admin(*this);
1.208     paf       261: }
1.150     parser    262: 
1.269     paf       263: const char* Request::get_exception_cstr(
                    264:                                                                                const Exception& e,
                    265:                                                                                Request::Exception_details& details) {
                    266: #define PA_URI_FORMAT "%s: "
                    267: #define PA_ORIGIN_FILE_POS_FORMAT "%s(%d:%d): "
                    268: #define PA_SOURCE_FORMAT "'%s' "
                    269: #define PA_COMMENT_TYPE_FORMAT "%s [%s]"
                    270:        char* result=new(PointerFreeGC) char[MAX_STRING];
                    271: 
                    272:        if(details.problem_source) { // do we know the guy?
                    273:                if(details.trace) { // do whe know where he came from?
                    274:                        Operation::Origin origin=details.trace.origin();
                    275:                        snprintf(result, MAX_STRING, 
                    276:                                PA_URI_FORMAT 
                    277:                                PA_ORIGIN_FILE_POS_FORMAT 
                    278:                                PA_SOURCE_FORMAT PA_COMMENT_TYPE_FORMAT,
                    279:                                request_info.uri,
                    280:                                file_list[origin.file_no].cstr(), 1+origin.line, 1+origin.col,
                    281:                                details.problem_source->cstr(),
                    282:                                e.comment(), e.type()
                    283:                        );
                    284:                } else
                    285:                        snprintf(result, MAX_STRING, 
                    286:                                PA_URI_FORMAT 
                    287:                                PA_SOURCE_FORMAT PA_COMMENT_TYPE_FORMAT,
                    288:                                request_info.uri,
                    289:                                details.problem_source->cstr(),
                    290:                                e.comment(), e.type()
                    291:                        );
                    292:        } else
                    293:                snprintf(result, MAX_STRING, 
                    294:                        PA_URI_FORMAT 
                    295:                        PA_COMMENT_TYPE_FORMAT,
                    296:                        request_info.uri,
                    297:                        e.comment(), e.type()
                    298:                );
                    299: 
                    300:        return result;
                    301: }
1.272     paf       302: 
                    303: void Request::configure() {
                    304:        // configure admin options if not configured yet
                    305:        if(!configure_admin_done)
                    306:                configure_admin(main_class);
                    307: 
                    308:        // configure not-admin=user options
                    309:        methoded_array().configure_user(*this);
                    310: 
                    311:        // $MAIN:MIME-TYPES
1.308     misha     312:        if(Value* element=main_class.get_element(mime_types_name))
1.272     paf       313:                if(Table *table=element->get_table())
                    314:                        mime_types=table;                       
                    315: }
1.64      paf       316: /**
                    317:        load MAIN class, execute @main.
                    318:        MAIN class consists of all the auto.p files we'd manage to find
                    319:        plus
                    320:        the file user requested us to process
                    321:        all located classes become children of one another,
                    322:        composing class we name 'MAIN'
1.180     paf       323: 
                    324:        @test log stack trace
                    325: 
1.64      paf       326: */
1.248     paf       327: void Request::core(const char* config_filespec, bool config_fail_on_read_problem, bool header_only) {
1.169     parser    328:        try {
1.271     paf       329:                // filling mail received
                    330:                mail.fill_received(*this);
                    331: 
1.211     paf       332:                // loading config
                    333:                if(config_filespec) {
1.248     paf       334:                        const String& filespec=*new String(config_filespec);
1.318     misha     335:                        use_file_directly(main_class,
                    336:                                filespec,
1.248     paf       337:                                config_fail_on_read_problem, 
                    338:                                true /*file must exist if 'fail on read problem' not set*/);
1.29      paf       339:                }
1.8       paf       340: 
1.72      paf       341:                // loading auto.p files from document_root/.. 
                    342:                // to the one beside requested file.
                    343:                // all assigned bases from upper dir
                    344:                {
1.248     paf       345:                        const char* after=request_info.path_translated;
                    346:                        size_t drlen=strlen(request_info.document_root);
                    347:                        if(memcmp(after, request_info.document_root, drlen)==0) {
1.115     paf       348:                                after+=drlen;
                    349:                                if(after[-1]=='/') 
                    350:                                        --after;
                    351:                        }
                    352:                        
1.248     paf       353:                        while(const char* before=strchr(after, '/')) {
                    354:                                String& sfile_spec=*new String;
                    355:                                if(after!=request_info.path_translated) {
                    356:                                        sfile_spec.append_strdup(
                    357:                                                request_info.path_translated, before-request_info.path_translated,
                    358:                                                String::L_CLEAN);
1.152     parser    359:                                        sfile_spec << "/" AUTO_FILE_NAME;
                    360: 
1.318     misha     361:                                        use_file_directly(main_class,
1.248     paf       362:                                                sfile_spec, 
                    363:                                                true /*fail on read problem*/, 
                    364:                                                false /*but ignore absence, sole user*/);
1.115     paf       365:                                }
1.317     misha     366:                                for(after=before+1;*after=='/';after++);
1.72      paf       367:                        }
                    368:                }
1.34      paf       369: 
1.272     paf       370:                try {
                    371:                        // compile requested file
                    372:                        String& spath_translated=*new String;
                    373:                        spath_translated.append_help_length(request_info.path_translated, 0, String::L_TAINTED);
1.318     misha     374:                        use_file_directly(main_class, spath_translated);
1.272     paf       375: 
                    376:                        configure();
                    377:                } catch(...) {
                    378:                        configure(); // configure anyway, useful in @unhandled_exception [say, if they would want to mail by SMTP something]
                    379:                        rethrow;
                    380:                }
1.25      paf       381: 
                    382:                // execute @main[]
1.248     paf       383:                const String* body_string=execute_virtual_method(main_class, main_method_name);
1.41      paf       384:                if(!body_string)
1.286     misha     385:                        throw Exception(PARSER_RUNTIME,
1.248     paf       386:                                0,
1.145     parser    387:                                "'"MAIN_METHOD_NAME"' method not found");
1.79      paf       388: 
1.250     paf       389:                // extract response body
                    390:                Value* body_value=response.fields().get(download_name); // $response:download?
                    391:                bool as_attachment=body_value!=0;
                    392:                if(!body_value)
                    393:                        body_value=response.fields().get(body_name); // $response:body
                    394:                if(!body_value)
                    395:                        body_value=new VString(*body_string); // just result of ^main[]
                    396: 
1.119     paf       397:                // @postprocess
1.308     misha     398:                if(Value* value=main_class.get_element(post_process_method_name))
1.248     paf       399:                        if(Junction* junction=value->get_junction())
1.91      paf       400:                                if(const Method *method=junction->method) {
                    401:                                        // preparing to pass parameters to 
1.119     paf       402:                                        //      @postprocess[data]
1.322     moko      403:                                        VMethodFrame frame(*method, 0 /*no parent*/, main_class);
1.91      paf       404: 
1.300     misha     405:                                        frame.store_params(&body_value, 1);
1.323     moko      406:                                        execute_method(frame);
                    407: 
                    408:                                        body_value=&frame.result().as_value();
1.91      paf       409:                                }
1.90      paf       410: 
1.303     misha     411:                VFile* body_file=body_value->as_vfile(flang, &charsets);
1.41      paf       412: 
1.45      paf       413:                // OK. write out the result
1.248     paf       414:                output_result(body_file, header_only, as_attachment);
1.183     paf       415: 
1.171     parser    416:        } catch(const Exception& e) { // request handling problem
1.268     paf       417:                try {
1.76      paf       418:                // we're returning not result, but error explanation
1.269     paf       419: 
                    420:                Request::Exception_details details=get_details(e);
                    421:                const char* exception_cstr=get_exception_cstr(e, details);
1.258     paf       422: 
                    423:                // reset language to default
                    424:                flang=fdefault_lang;
                    425:                
                    426:                // reset response
                    427:                response.fields().clear();
                    428: 
                    429:                // this is what we'd return in $response:body
                    430:                const String* body_string=0;
                    431: 
                    432:                // maybe we'd be lucky enough as to report an error
                    433:                // in a gracefull way...
1.308     misha     434:                if(Value* value=main_class.get_element(*new String(UNHANDLED_EXCEPTION_METHOD_NAME))) {
1.258     paf       435:                        if(Junction* junction=value->get_junction()) {
                    436:                                if(const Method *method=junction->method) {
1.287     misha     437:                                        // preparing to pass parameters to 
                    438:                                        //      @unhandled_exception[exception;stack]
                    439: 
                    440:                                        // $stack[^table::create{name   file    lineno  colno}]
                    441:                                        Table::columns_type stack_trace_columns(new ArrayString);
                    442:                                        *stack_trace_columns+=new String("name");
                    443:                                        *stack_trace_columns+=new String("file");
                    444:                                        *stack_trace_columns+=new String("lineno");
                    445:                                        *stack_trace_columns+=new String("colno");
                    446:                                        Table& stack_trace=*new Table(stack_trace_columns);
                    447:                                        if(!exception_trace.is_empty()/*signed!*/) 
                    448:                                                for(size_t i=exception_trace.bottom_index(); i<exception_trace.top_index(); i++) {
                    449:                                                        Trace trace=exception_trace.get(i);
                    450:                                                        Table::element_type row(new ArrayString);
                    451: 
                    452:                                                        *row+=trace.name(); // name column
                    453:                                                        Operation::Origin origin=trace.origin();
                    454:                                                        if(origin.file_no) {
                    455:                                                                *row+=new String(file_list[origin.file_no], String::L_TAINTED); // 'file' column
                    456:                                                                *row+=new String(String::Body::Format(1+origin.line), String::L_CLEAN); // 'lineno' column
                    457:                                                                *row+=new String(String::Body::Format(1+origin.col), String::L_CLEAN); // 'colno' column
                    458:                                                        }
                    459:                                                        stack_trace+=row;
                    460:                                                }
                    461: 
1.323     moko      462:                                        // future $response:body=
                    463:                                        //   execute ^unhandled_exception[exception;stack]
                    464:                                        exception_trace.clear(); // forget all about previous life, in case there would be error inside of this method, error handled  would not be mislead by old stack contents (see extract_origin)
                    465: 
                    466:                                        VMethodFrame frame(*method, 0 /*no caller*/, main_class);
1.300     misha     467:                                        Value *params[]={&details.vhash, new VTable(&stack_trace)};
1.323     moko      468: 
1.300     misha     469:                                        frame.store_params(params, 2);
1.323     moko      470:                                        execute_method(frame);
1.287     misha     471: 
1.323     moko      472:                                        body_string=&frame.result().as_string();
1.233     paf       473:                                }
1.30      paf       474:                        }
1.258     paf       475:                }
                    476:                
                    477:                if(!body_string) {  // couldn't report an error beautifully?
                    478:                        // doing that ugly
                    479: 
                    480:                        // future $response:content-type
1.314     misha     481:                        response.fields().put(http_content_type, new VString(*new String(UNHANDLED_EXCEPTION_CONTENT_TYPE)));
1.258     paf       482:                        // future $response:body
1.269     paf       483:                        body_string=new String(exception_cstr);
1.258     paf       484:                }
1.41      paf       485: 
1.258     paf       486:                VString body_vstring(*body_string);
1.303     misha     487:                VFile* body_file=body_vstring.as_vfile(flang, &charsets);
1.90      paf       488: 
1.273     paf       489:                // conditionally log it
                    490:                Value* vhandled=details.vhash.hash().get(exception_handled_part_name);
                    491:                if(!vhandled || !vhandled->as_bool()) {
                    492:                        SAPI::log(sapi_info, "%s", exception_cstr);
                    493:                }
                    494: 
1.258     paf       495:                // ERROR. write it out
                    496:                output_result(body_file, header_only, false);
1.287     misha     497: 
1.273     paf       498:                } catch(const Exception& e) { // exception in unhandled exception
1.269     paf       499:                        Request::Exception_details details=get_details(e);
                    500:                        const char* exception_cstr=get_exception_cstr(e, details);
1.273     paf       501:                        // unconditionally log the beast
                    502:                        SAPI::log(sapi_info, "%s", exception_cstr);
1.269     paf       503: 
                    504:                        throw Exception(0,
                    505:                                0,
                    506:                                "in %s", 
                    507:                                        exception_cstr);
1.268     paf       508:                }
1.1       paf       509:        }
                    510: }
                    511: 
1.266     paf       512: uint Request::register_file(String::Body file_spec) {
1.248     paf       513:        file_list+=file_spec;
                    514:        return file_list.count()-1;
                    515: }
                    516: 
1.318     misha     517: void Request::use_file_directly(VStateless_class& aclass,
                    518:                                const String& file_spec,
                    519:                                bool fail_on_read_problem, 
                    520:                                bool fail_on_file_absence) {
                    521: 
1.73      paf       522:        // cyclic dependence check
1.318     misha     523:        if(used_files.get(file_spec))
1.248     paf       524:                return;
1.318     misha     525:        used_files.put(file_spec, true);
                    526: 
                    527:        if(fail_on_read_problem && !fail_on_file_absence) // ignore file absence if asked for
                    528:                if(!entry_exists(file_spec))
                    529:                        return;
                    530: 
                    531:        if(const char* source=file_read_text(charsets, file_spec, fail_on_read_problem))
                    532:                use_buf(aclass, source, 0, register_file(file_spec));
                    533: }
                    534: 
                    535: 
                    536: void Request::use_file(VStateless_class& aclass,
                    537:                                const String& file_name,
                    538:                                const String* use_filespec/*absolute*/) {
1.73      paf       539: 
1.326     misha     540:        if(file_name.is_empty())
                    541:                throw Exception(PARSER_RUNTIME,
                    542:                        0,
                    543:                        "usage failed - no filename was specified");
                    544: 
1.318     misha     545:        const String* filespec=0;
                    546: 
                    547:        if(file_name.first_char()=='/') //absolute path? [no need to scan MAIN:CLASS_PATH]
                    548:                filespec=&absolute(file_name);
                    549:        else if(use_filespec){ // search in current dir first
1.331     misha     550:                size_t last_slash_pos=use_filespec->strrpbrk("/");
                    551:                if(last_slash_pos!=STRING_NOT_FOUND)
                    552:                        filespec=file_exist(use_filespec->mid(0, last_slash_pos), file_name); // found in current dir?
1.318     misha     553:        }
                    554: 
                    555:        if(!filespec){
                    556:                // prevent multiple scan CLASS_PATH for searching one file
                    557:                if(searched_along_class_path.get(file_name))
                    558:                        return;
                    559:                searched_along_class_path.put(file_name, true);
1.308     misha     560:                if(Value* element=main_class.get_element(class_path_name)) {
1.233     paf       561:                        if(element->is_string()) {
1.318     misha     562:                                filespec=file_exist(absolute(element->as_string()), file_name); // found at class_path?
1.233     paf       563:                        } else if(Table *table=element->get_table()) {
1.318     misha     564:                                for(size_t i=table->count(); i--; ) {
1.248     paf       565:                                        const String& path=*(*table->get(i))[0];
1.318     misha     566:                                        if(filespec=file_exist(absolute(path), file_name))
1.233     paf       567:                                                break; // found along class_path
                    568:                                }
                    569:                        } else
1.286     misha     570:                                throw Exception(PARSER_RUNTIME,
1.233     paf       571:                                        0,
                    572:                                        "$" CLASS_PATH_NAME " must be string or table");
1.318     misha     573:                        if(!filespec)
1.286     misha     574:                                throw Exception(PARSER_RUNTIME,
1.233     paf       575:                                        &file_name,
                    576:                                        "not found along " MAIN_CLASS_NAME ":" CLASS_PATH_NAME);
1.318     misha     577:                } else 
1.286     misha     578:                        throw Exception(PARSER_RUNTIME,
1.153     parser    579:                                &file_name,
1.203     paf       580:                                "usage failed - no $" MAIN_CLASS_NAME  ":" CLASS_PATH_NAME " were specified");
1.148     parser    581:        }
1.230     paf       582: 
1.318     misha     583:        use_file_directly(aclass, *filespec);
1.16      paf       584: }
                    585: 
1.208     paf       586: 
1.248     paf       587: void Request::use_buf(VStateless_class& aclass,
1.318     misha     588:                                const char* source, const String* main_alias, 
                    589:                                uint file_no,
                    590:                                int line_no_offset) {
1.233     paf       591:        // temporary zero @conf so to maybe-replace it in compiled code
1.248     paf       592:        Temp_method temp_method_conf(aclass, conf_method_name, 0);
1.233     paf       593:        // temporary zero @auto so to maybe-replace it in compiled code
1.248     paf       594:        Temp_method temp_method_auto(aclass, auto_method_name, 0);
1.233     paf       595: 
1.295     misha     596:        // compile loaded classes
                    597:        ArrayClass& cclasses=compile(&aclass, source, main_alias, file_no, line_no_offset);
1.212     paf       598: 
1.248     paf       599:        VString* vfilespec=
                    600:                new VString(*new String(file_list[file_no], String::L_TAINTED));
1.295     misha     601: 
                    602:        for(size_t i=0; i<cclasses.count(); i++){
                    603:                VStateless_class& cclass=*cclasses.get(i);
1.296     misha     604: 
                    605:                // locate and execute possible @conf[] static
1.295     misha     606:                Execute_nonvirtual_method_result executed=execute_nonvirtual_method(cclass, 
                    607:                        conf_method_name, vfilespec,
                    608:                        false/*no string result needed*/);
                    609:                if(executed.method)
                    610:                        configure_admin(cclass/*, executed.method->name*/);
                    611: 
                    612:                // locate and execute possible @auto[] static
                    613:                execute_nonvirtual_method(cclass, 
                    614:                        auto_method_name, vfilespec,
                    615:                        false/*no result needed*/);
                    616:        }
1.19      paf       617: }
                    618: 
1.248     paf       619: const String& Request::relative(const char* apath, const String& relative_name) {
                    620:        char *hpath=strdup(apath);
                    621:        String& result=*new String;
                    622:        if(rsplit(hpath, '/')) // if something/splitted
1.217     paf       623:                result << hpath << "/";
1.248     paf       624:        result << relative_name;
                    625:        return result;
1.19      paf       626: }
                    627: 
1.77      paf       628: const String& Request::absolute(const String& relative_name) {
1.217     paf       629:        if(relative_name.first_char()=='/') {
1.248     paf       630:                String& result=*new String(strdup(request_info.document_root));
1.104     paf       631:                result << relative_name;
1.19      paf       632:                return result;
                    633:        } else 
1.248     paf       634:                if(relative_name.pos("://")!=STRING_NOT_FOUND // something like "http://xxx"
1.247     paf       635: #ifdef WIN32
                    636:                        || relative_name.pos(":")==1  // DRIVE:
                    637:                        || relative_name.starts_with("\\\\") // UNC1
                    638:                        || relative_name.starts_with("//") // UNC2
                    639: #endif
                    640:                        )
                    641:                        return relative_name;
                    642:                else
1.248     paf       643:                        return relative(request_info.path_translated, relative_name);
1.1       paf       644: }
1.45      paf       645: 
1.267     paf       646: #ifndef DOXYGEN
                    647: class Add_header_attribute_info
                    648: {
                    649: public:
                    650:        Add_header_attribute_info(Request& ar) : r(ar), add_last_modified(true) {}
                    651:        Request& r;
                    652:        bool add_last_modified;
                    653: };
                    654: #endif
1.248     paf       655: static void add_header_attribute(
1.290     misha     656:                                 HashStringValue::key_type name, 
                    657:                                 HashStringValue::value_type value, 
1.267     paf       658:                                 Add_header_attribute_info* info) {
1.290     misha     659:        if(name==BODY_NAME
                    660:                || name==DOWNLOAD_NAME
                    661:                || name==CHARSET_NAME)
1.101     paf       662:                return;
1.290     misha     663:        
1.316     misha     664:        const char* aname=String(name, String::L_URI).untaint_and_transcode_cstr(String::L_URI, &info->r.charsets);
1.101     paf       665: 
1.267     paf       666:        SAPI::add_header_attribute(info->r.sapi_info,
1.303     misha     667:                        aname, 
1.316     misha     668:                        attributed_meaning_to_string(*value, String::L_URI, false).untaint_and_transcode_cstr(String::L_URI, &info->r.charsets)
1.303     misha     669:                );
1.267     paf       670: 
1.290     misha     671:        if(strcasecmp(aname, "last-modified")==0)
1.303     misha     672:                info->add_last_modified=false;
1.267     paf       673: }
                    674: 
                    675: static void output_sole_piece(Request& r,
                    676:                                                          bool header_only, 
                    677:                                                          VFile& body_file,
                    678:                                                          Value* body_file_content_type) {
                    679:        // transcode text body when "text/*" or simple result
                    680:        String::C output(body_file.value_ptr(), body_file.value_size());
                    681:        if(!body_file_content_type/*vstring.as_vfile*/ || body_file_content_type->as_string().pos("text/")==0)
                    682:                output=Charset::transcode(output, 
                    683:                        r.charsets.source(), 
                    684:                        r.charsets.client());
                    685: 
1.311     misha     686:        // prepare header: Content-Length
                    687:        SAPI::add_header_attribute(r.sapi_info, HTTP_CONTENT_LENGTH, format(output.length, "%u"));
1.267     paf       688: 
                    689:        // send header
                    690:        SAPI::send_header(r.sapi_info);
                    691:        
                    692:        // send body
                    693:        if(!header_only)
                    694:                SAPI::send_body(r.sapi_info, output.str, output.length);
                    695: }
                    696: 
                    697: #ifndef DOXYGEN
                    698: struct Range
                    699: {
                    700:        size_t start;
                    701:        size_t end;
                    702: };
                    703: #endif
1.313     misha     704: static void parse_range(const String* s, Array<Range> &ar) {
1.267     paf       705:        const char *p = s->cstr();
                    706:        if(s->starts_with("bytes="))
                    707:                p += 6;
                    708:        Range r;
                    709:        while(*p){
                    710:                r.start = (size_t)-1;
                    711:                r.end = (size_t)-1;
                    712:                if(*p >= '0' && *p <= '9'){
                    713:                        r.start = atol(p);
                    714:                        while(*p>='0' && *p<='9') ++p;
                    715:                }
                    716:                if(*p++ != '-') break;
                    717:                if(*p >= '0' && *p <= '9'){
                    718:                        r.end = atol(p);
                    719:                        while(*p>='0' && *p<='9') ++p;
                    720:                }
                    721:                if(*p == ',') ++p;
                    722:                ar += r;
                    723:        }
1.101     paf       724: }
1.267     paf       725: 
                    726: static void output_pieces(Request& r,
                    727:                                                  bool header_only, 
                    728:                                                  const String& filename,
                    729:                                                  size_t content_length,
                    730:                                                  Value& date,
                    731:                                                  bool add_last_modified) 
                    732: {
1.315     misha     733:        SAPI::add_header_attribute(r.sapi_info, "accept-ranges", "bytes");
1.270     paf       734: 
1.267     paf       735:        const size_t BUFSIZE = 10*0x400;
                    736:        char buf[BUFSIZE];
                    737:        const char *range = SAPI::get_env(r.sapi_info, "HTTP_RANGE");
                    738:        size_t offset=0;
                    739:        size_t part_length=content_length;
                    740:        if(range){
                    741:                Array<Range> ar;
                    742:                parse_range(new String(range), ar);
                    743:                size_t count = ar.count();
                    744:                if(count == 1){
                    745:                        Range &rg = ar.get_ref(0);
                    746:                        if(rg.start == (size_t)-1 && rg.end == (size_t)-1){
1.311     misha     747:                                SAPI::add_header_attribute(r.sapi_info, HTTP_STATUS, "416 Requested Range Not Satisfiable");
1.267     paf       748:                                return;
                    749:                        }
                    750:                        if(rg.start == (size_t)-1 && rg.end != (size_t)-1){
                    751:                                rg.start = content_length - rg.end;
                    752:                                rg.end = content_length;
                    753:                                offset += rg.start;
                    754:                                part_length = rg.end-rg.start;
                    755:                        }else if(rg.start != (size_t)-1 && rg.end == (size_t)-1){
                    756:                                rg.end = content_length-1;
                    757:                                offset += rg.start;
                    758:                                part_length -= rg.start;
                    759:                        }
                    760:                        if(part_length == 0){
1.311     misha     761:                                SAPI::add_header_attribute(r.sapi_info, HTTP_STATUS, "204 No Content");
1.267     paf       762:                                return;
                    763:                        }
1.311     misha     764:                        SAPI::add_header_attribute(r.sapi_info, HTTP_STATUS, "206 Partial Content");
1.267     paf       765:                        snprintf(buf, BUFSIZE, "bytes %u-%u/%u", rg.start, rg.end, content_length);
1.315     misha     766:                        SAPI::add_header_attribute(r.sapi_info, "content-range", buf);
1.267     paf       767:                }else if(count != 0){
1.311     misha     768:                        SAPI::add_header_attribute(r.sapi_info, HTTP_STATUS, "501 Not Implemented");
1.267     paf       769:                        return;
                    770:                }
                    771:        }
                    772: 
                    773: 
1.311     misha     774:        SAPI::add_header_attribute(r.sapi_info, HTTP_CONTENT_LENGTH, format(part_length, "%u"));
1.267     paf       775: 
1.314     misha     776:        if(add_last_modified)
1.315     misha     777:                SAPI::add_header_attribute(r.sapi_info, "last-modified", attributed_meaning_to_string(date, String::L_AS_IS, true).cstr());
1.314     misha     778: 
1.267     paf       779:        SAPI::send_header(r.sapi_info);
                    780: 
                    781:        const String& filespec=r.absolute(filename);
                    782: 
                    783:        size_t sent = 0;
                    784:        if(!header_only){
                    785:                size_t to_read = 0;
                    786:                size_t size = 0;
                    787:                do{
                    788:                        to_read = part_length<BUFSIZE?part_length:BUFSIZE;
                    789:                        File_read_result read_result=file_read(r.charsets, filespec, 
                    790:                                false /*as text*/,  0/*params*/, true/*fail on problem*/,
                    791:                                buf, offset, to_read);
                    792:                        to_read=read_result.length;
                    793:                        if(to_read == 0)
                    794:                                break;
                    795:                        offset += to_read;
                    796: 
                    797:                        size = SAPI::send_body(r.sapi_info, read_result.str, to_read);
                    798:                        sent += size;
                    799:                        if(size != to_read)
                    800:                                break;
                    801:                        part_length -= to_read;
                    802:                }while(part_length);
                    803:        }
                    804: }
                    805: 
1.248     paf       806: void Request::output_result(VFile* body_file, bool header_only, bool as_attachment) {
1.51      paf       807:        // header: cookies
1.248     paf       808:        cookie.output_result(sapi_info);
1.51      paf       809:        
1.314     misha     810:        // _file_ content-type might be specified
1.267     paf       811:        Value* body_file_content_type=body_file->fields().get(content_type_name);
1.92      paf       812: 
1.314     misha     813:        // Content-Disposition
1.267     paf       814:        Value* vfile_name=body_file->fields().get(name_name);
                    815:        if(!vfile_name) {
                    816:                vfile_name=body_file->fields().get(response_body_file_name);
1.313     misha     817:                if(vfile_name) {
                    818:                        char* name_cstr=vfile_name->as_string().cstrm();
1.274     paf       819:                        if(char *after_slash=rsplit(name_cstr, '\\'))
                    820:                                name_cstr=after_slash;
                    821:                        if(char *after_slash=rsplit(name_cstr, '/'))
                    822:                                name_cstr=after_slash;
1.327     misha     823:                        vfile_name=new VString(*new String(name_cstr));
1.274     paf       824:                }
1.267     paf       825:        }
                    826:        if(vfile_name) {
                    827:                const String& sfile_name=vfile_name->as_string();
                    828:                if(sfile_name!=NONAME_DAT) {
1.283     misha     829:                        VHash& hash=*new VHash();
                    830:                        HashStringValue &h=hash.hash();
1.288     misha     831:                        h.put(value_name, new VString( as_attachment ? content_disposition_attachment : content_disposition_inline ));
1.327     misha     832:                        h.put(content_disposition_filename_name, new VString(String(sfile_name, String::L_HTTP_HEADER)));
1.283     misha     833: 
1.311     misha     834:                        response.fields().put(content_disposition, &hash);
1.267     paf       835: 
                    836:                        if(!body_file_content_type)
                    837:                                body_file_content_type=new VString(mime_type_of(sfile_name.cstr()));
1.111     paf       838:                }
1.267     paf       839:        }
                    840: 
1.312     misha     841:        // set Content-Type
1.314     misha     842:        if(body_file_content_type) {
                    843:                // body file content type
                    844:                response.fields().put(content_type_name, body_file_content_type);
                    845:        } else {
                    846:                // default content type
                    847:                response.fields().put_dont_replace(content_type_name, new VString(*new String(DEFAULT_CONTENT_TYPE)));
                    848:        }
1.312     misha     849: 
1.314     misha     850:        // prepare header: $response:fields without :body, :download and :charset
1.267     paf       851:        Add_header_attribute_info info(*this);
1.281     paf       852:        response.fields().for_each<Add_header_attribute_info*>(add_header_attribute, &info);
1.50      paf       853: 
1.267     paf       854:        if(Value* vresponse_body_file=body_file->fields().get(response_body_file_name)) {
1.314     misha     855:                // $response:[download|body][$.file[filespec]] -- optput specified file
1.267     paf       856:                const String& sresponse_body_file=vresponse_body_file->as_string();
                    857:                size_t content_length=0;
                    858:                time_t atime=0, mtime=0, ctime=0;
                    859:                file_stat(absolute(sresponse_body_file),
                    860:                        content_length,
                    861:                        atime, mtime, ctime);
                    862: 
                    863:                VDate* vdate=0;
                    864:                if(Value* v=body_file->fields().get("mdate")) {
1.308     misha     865:                        if(Value* vdatep=v->as(VDATE_TYPE))
1.267     paf       866:                                vdate=static_cast<VDate*>(vdatep);
                    867:                        else 
1.286     misha     868:                                throw Exception(PARSER_RUNTIME, 0, "mdate must be a date");
1.267     paf       869:                }
                    870:                if(!vdate)
                    871:                        vdate=new VDate(mtime);
1.62      paf       872: 
1.267     paf       873:                output_pieces(*this, header_only, 
                    874:                        sresponse_body_file,
                    875:                        content_length,
                    876:                        *vdate,
                    877:                        info.add_last_modified);
                    878:        } else {
1.314     misha     879:                if(body_file_content_type)
                    880:                        if(HashStringValue *hash=body_file_content_type->get_hash())
                    881:                                body_file_content_type=hash->get(value_name);
                    882: 
1.267     paf       883:                output_sole_piece(*this, header_only, 
                    884:                        *body_file, body_file_content_type);
                    885:        }
1.50      paf       886: }
1.104     paf       887: 
1.328     misha     888: const String& Request::mime_type_of(const String* file_name) {
                    889:        return mime_type_of(file_name?file_name->taint_cstr(String::L_FILE_SPEC):0);
                    890: }
                    891: 
1.248     paf       892: const String& Request::mime_type_of(const char* user_file_name_cstr) {
1.104     paf       893:        if(mime_types)
1.248     paf       894:                if(const char* cext=strrchr(user_file_name_cstr, '.')) {
                    895:                        String sext(++cext);
1.246     paf       896:                        Table::Action_options options;
1.248     paf       897:                        if(mime_types->locate(0, sext.change_case(charsets.source(), String::CC_LOWER), options))
1.313     misha     898:                                if(const String* result=mime_types->item(1))
                    899:                                        return *result;
1.104     paf       900:                                else
1.286     misha     901:                                        throw Exception(PARSER_RUNTIME,
1.248     paf       902:                                                0,
1.212     paf       903:                                                MIME_TYPES_NAME  " table column elements must not be empty");
1.104     paf       904:                }
1.248     paf       905: 
                    906:        return *new String("application/octet-stream");
                    907: }
                    908: 
1.318     misha     909: const String* Request::get_used_filename(uint file_no){
                    910:        if(file_no < file_list.count())
                    911:                return new String(file_list[file_no], String::L_TAINTED);
                    912:        return 0;
                    913: }
                    914: 
1.248     paf       915: #ifdef XML
1.280     paf       916: xmlChar* Request::transcode(const String& s) {
1.248     paf       917:        return charsets.source().transcode(s);
                    918: }
                    919: 
1.280     paf       920: xmlChar* Request::transcode(const String::Body s) {
1.248     paf       921:        return charsets.source().transcode(s);
                    922: }
                    923: 
1.280     paf       924: const String& Request::transcode(const xmlChar* s) {
1.248     paf       925:        return charsets.source().transcode(s);
1.233     paf       926: }
1.248     paf       927: #endif
                    928: 
                    929: 
                    930: const Request::Trace Request::Exception_trace::extract_origin(const String*& problem_source) {
                    931:        Trace result;
                    932:        if(!is_empty()) {
                    933:                result=bottom_value();
                    934:                if(!problem_source) { // we don't know who trigged the bug?
1.279     paf       935:                        problem_source=result.name(); // consider the stack-top-guy (we usually know source of next-from-throw-point exception) did that
1.248     paf       936:                        fbottom++;
                    937:                } else if(result.name()==problem_source) // it is that same guy?
                    938:                        fbottom++; // throw away that trace
1.279     paf       939:                else {
                    940:                        // stack top contains not us, 
                    941:                        //      leaving result intact
                    942:                        //      it would help ^throw
                    943:                }
1.248     paf       944:        }
                    945: 
                    946:        return result;
                    947: }
                    948: 
                    949: Request::Exception_details Request::get_details(const Exception& e) {
                    950:        const String* problem_source=e.problem_source();
                    951:        Trace trace=exception_trace.extract_origin(problem_source);
                    952:        
                    953:        VHash& vhash=*new VHash;  HashStringValue& hash=vhash.hash();
                    954: 
                    955:        // $.type
                    956:        if(const char* type=e.type(true))
                    957:                hash.put(exception_type_part_name, new VString(*new String(type)));
                    958: 
                    959:        // $.source
                    960:        if(problem_source) {
1.306     misha     961:                String& source=*new String(*problem_source, String::L_TAINTED);
1.248     paf       962:                hash.put(exception_source_part_name, new VString(source));
                    963:        }
                    964: 
                    965:        // $.file lineno colno
                    966:        if(trace) {
                    967:                const Operation::Origin origin=trace.origin();
1.263     paf       968:                hash.put(String::Body("file"),
1.248     paf       969:                        new VString(*new String(file_list[origin.file_no], String::L_TAINTED)));
1.263     paf       970:                hash.put(String::Body("lineno"), new VInt(1+origin.line));
                    971:                hash.put(String::Body("colno"), new VInt(1+origin.col));
1.248     paf       972:        }
                    973: 
                    974:        // $.comment
                    975:        if(const char* comment=e.comment(true))
                    976:                hash.put(exception_comment_part_name, 
1.302     misha     977:                        new VString(*new String(comment, String::L_TAINTED)));
1.248     paf       978: 
                    979:        // $.handled(0)
1.299     misha     980:        hash.put(exception_handled_part_name, &VBool::get(false));
1.233     paf       981: 
1.248     paf       982:        return Request::Exception_details(trace, problem_source, vhash);
1.133     parser    983: }

E-mail: