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

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

E-mail: