Annotation of parser3/src/classes/op.C, revision 1.154

1.1       paf         1: /** @file
1.9       paf         2:        Parser: parser @b operators.
1.1       paf         3: 
1.145     paf         4:        Copyright (c) 2001-2004 ArtLebedev Group (http://www.artlebedev.com)
1.71      paf         5:        Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
1.98      paf         6: */
1.1       paf         7: 
1.154   ! paf         8: static const char * const IDENT_OP_C="$Date: 2005/07/28 10:02:26 $";
1.1       paf         9: 
1.13      paf        10: #include "classes.h"
1.129     paf        11: #include "pa_vmethod_frame.h"
                     12: 
1.1       paf        13: #include "pa_common.h"
1.134     paf        14: #include "pa_os.h"
1.1       paf        15: #include "pa_request.h"
                     16: #include "pa_vint.h"
                     17: #include "pa_sql_connection.h"
1.79      paf        18: #include "pa_vdate.h"
1.105     paf        19: #include "pa_vmethod_frame.h"
1.129     paf        20: #include "pa_vclass.h"
1.144     paf        21: #include "pa_charset.h"
1.1       paf        22: 
1.18      parser     23: // limits
                     24: 
                     25: #define MAX_LOOPS 10000
                     26: 
1.10      paf        27: // defines
                     28: 
1.82      paf        29: #define CASE_DEFAULT_VALUE "DEFAULT"
1.146     paf        30: #define PROCESS_MAIN_OPTION_NAME "main"
                     31: #define PROCESS_FILE_OPTION_NAME "file"
                     32: #define PROCESS_LINENO_OPTION_NAME "lineno"
1.11      paf        33: 
1.10      paf        34: // class
                     35: 
1.113     paf        36: class VClassMAIN: public VClass {
1.10      paf        37: public:
1.129     paf        38:        VClassMAIN();
1.10      paf        39: };
                     40: 
1.129     paf        41: // defines for statics
                     42: 
                     43: #define SWITCH_DATA_NAME "SWITCH-DATA"
                     44: #define CACHE_DATA_NAME "CACHE-DATA"
                     45: #define EXCEPTION_VAR_NAME "exception"
                     46: 
                     47: // statics
                     48: 
                     49: //^switch ^case
                     50: static const String switch_data_name(SWITCH_DATA_NAME);
                     51: //^cache
                     52: static const String cache_data_name(CACHE_DATA_NAME);
                     53: 
                     54: static const String exception_var_name(EXCEPTION_VAR_NAME);
                     55: 
1.136     paf        56: // local defines
                     57: 
                     58: #define CACHE_EXCEPTION_HANDLED_CACHE_NAME "cache"
                     59: 
1.129     paf        60: // helpers
                     61: 
1.130     paf        62: class Untaint_lang_name2enum: public Hash<const String::Body, String::Language> {
1.129     paf        63: public:
                     64:        Untaint_lang_name2enum() {
                     65:                #define ULN(name, LANG) \
1.130     paf        66:                        put(String::Body(name), (value_type)(String::L_##LANG));
1.129     paf        67:                ULN("as-is", AS_IS);
                     68:                ULN("optimized-as-is", AS_IS|String::L_OPTIMIZE_BIT);
                     69:                ULN("file-spec", FILE_SPEC);
                     70:                ULN("http-header", HTTP_HEADER);
                     71:                ULN("mail-header", MAIL_HEADER);
                     72:                ULN("uri", URI);
                     73:                ULN("sql", SQL);
                     74:                ULN("js", JS);
                     75:                ULN("xml", XML);
                     76:                ULN("optimized-xml", XML|String::L_OPTIMIZE_BIT);
                     77:                ULN("html", HTML);
                     78:                ULN("optimized-html", HTML|String::L_OPTIMIZE_BIT);
                     79:                #undef ULN
                     80:        }
                     81: } untaint_lang_name2enum;
                     82: 
1.10      paf        83: // methods
                     84: 
1.129     paf        85: static void _if(Request& r, MethodParams& params) {
                     86:        Value& condition_code=params.as_junction(0, "condition must be expression");
1.1       paf        87: 
1.81      paf        88:        bool condition=r.process_to_value(condition_code, 
1.1       paf        89:                false/*don't intercept string*/).as_bool();
1.6       paf        90:        if(condition)
1.129     paf        91:                r.write_pass_lang(r.process(params.as_junction(1, "'then' parameter must be code")));
                     92:        else if(params.count()>2)
                     93:                r.write_pass_lang(r.process(params.as_junction(2, "'else' parameter must be code")));
1.1       paf        94: }
                     95: 
1.129     paf        96: static void _untaint(Request& r, MethodParams& params) {
1.1       paf        97: 
1.129     paf        98:        String::Language lang;
                     99:        if(params.count()==1)
                    100:                lang=String::L_AS_IS; // mark as simply 'tainted'. useful in html from sql 
1.59      paf       101:        else {
1.129     paf       102:                const String& lang_name=params.as_string(0, "lang must be string");
                    103:                lang=untaint_lang_name2enum.get(lang_name);
1.59      paf       104:                if(!lang)
1.78      paf       105:                        throw Exception(0,
1.59      paf       106:                                &lang_name,
                    107:                                "invalid taint language");
                    108:        }
1.1       paf       109: 
                    110:        {
1.129     paf       111:                Value& vbody=params.as_junction(params.count()-1, "body must be code");
1.1       paf       112:                
                    113:                Temp_lang temp_lang(r, lang); // set temporarily specified ^untaint[language;
1.86      paf       114:                r.write_pass_lang(r.process(vbody)); // process marking tainted with that lang
1.1       paf       115:        }
                    116: }
                    117: 
1.129     paf       118: static void _taint(Request& r, MethodParams& params) {
                    119:        String::Language lang;
                    120:        if(params.count()==1)
                    121:                lang=String::L_TAINTED; // mark as simply 'tainted'. useful in table:set
1.1       paf       122:        else {
1.129     paf       123:                const String& lang_name=params.as_string(0, "lang must be string");
                    124:                lang=untaint_lang_name2enum.get(lang_name);
1.1       paf       125:                if(!lang)
1.78      paf       126:                        throw Exception(0,
1.3       paf       127:                                &lang_name,
                    128:                                "invalid taint language");
1.1       paf       129:        }
                    130: 
                    131:        {
1.129     paf       132:                Value& vbody=params.as_no_junction(params.count()-1, "body must not be code");
1.1       paf       133:                
1.129     paf       134:                String result;
1.1       paf       135:                result.append(
                    136:                        vbody.as_string(),  // process marking tainted with that lang
                    137:                        lang, true);  // force result language to specified
                    138:                r.write_pass_lang(result);
                    139:        }
                    140: }
                    141: 
1.129     paf       142: static void _process(Request& r, MethodParams& params) {
                    143:        Method* main_method;
                    144: 
                    145:        size_t index=0;
                    146:        Value* target_self;
                    147:        Value& maybe_target_self=params[index];
                    148:        if(maybe_target_self.get_string() || maybe_target_self.get_junction())
                    149:                target_self=&r.get_method_frame()->caller()->self();
                    150:        else {
                    151:                target_self=&maybe_target_self;  index++;
                    152:        }
                    153: 
1.1       paf       154:        {
1.129     paf       155:                VStateless_class *target_class=target_self->get_last_derived_class();
1.116     paf       156:                if(!target_class)
                    157:                        throw Exception("parser.runtime",
1.129     paf       158:                                0,
1.116     paf       159:                                "no target class");
1.114     paf       160: 
1.73      paf       161:                // temporary remove language change
1.129     paf       162:                Temp_lang temp_lang(r, String::L_PASS_APPENDED);
1.1       paf       163:                // temporary zero @main so to maybe-replace it in processed code
1.129     paf       164:                Temp_method temp_method_main(*target_class, main_method_name, 0);
1.1       paf       165:                // temporary zero @auto so it wouldn't be auto-called in Request::use_buf
1.129     paf       166:                Temp_method temp_method_auto(*target_class, auto_method_name, 0);
                    167: 
1.146     paf       168:                size_t options_index=index+1;
                    169:                HashStringValue* options=0;
                    170:                if(options_index<params.count()) {
                    171:                        Value& voptions=params.as_no_junction(options_index, "options must not be code");
                    172:                        options=voptions.get_hash();
                    173:                        if(!options)
                    174:                                throw Exception("parser.runtime",
                    175:                                        0,
                    176:                                        "options must be hash");
                    177:                }
                    178: 
1.129     paf       179:                const String* main_alias=0;
1.146     paf       180:                const String* file_alias=0;
                    181:                int line_no_alias_offset=0;
                    182:                if(options) {
                    183:                        int valid_options=0;
                    184:                        if(Value* vmain_alias=options->get(PROCESS_MAIN_OPTION_NAME)) {
                    185:                                valid_options++;
                    186:                                main_alias=&vmain_alias->as_string();
                    187:                        }
                    188:                        if(Value* vfile_alias=options->get(PROCESS_FILE_OPTION_NAME)) {
                    189:                                valid_options++;
                    190:                                file_alias=&vfile_alias->as_string();
                    191:                        }
                    192:                        if(Value* vline_no_alias_offset=options->get(PROCESS_LINENO_OPTION_NAME)) {
                    193:                                valid_options++;
                    194:                                line_no_alias_offset=vline_no_alias_offset->as_int();
                    195:                        }
                    196:        
                    197:                        if(valid_options!=options->count())
                    198:                                throw Exception("parser.runtime",
                    199:                                        0,
                    200:                                        "called with invalid option");
                    201:                }
1.129     paf       202: 
1.146     paf       203:                uint processe_file_no=file_alias?
                    204:                        r.register_file(r.absolute(*file_alias))
                    205:                        : pseudo_file_no__process;
                    206:                // process...{string}
                    207:                Value& vjunction=params.as_junction(index, "body must be code");
                    208:                // evaluate source to process
                    209:                const String& source=r.process_to_string(vjunction);
                    210:                r.use_buf(*target_class,
                    211:                        source.cstr(String::L_UNSPECIFIED, r.connection(false)),
                    212:                        main_alias,
                    213:                        processe_file_no,
                    214:                        line_no_alias_offset);
1.1       paf       215: 
1.73      paf       216:                // main_method
1.129     paf       217:                main_method=target_class->get_method(main_method_name);
1.73      paf       218:        }
                    219:        // after restoring current-request-lang
                    220:        // maybe-execute @main[]
                    221:        if(main_method) {
1.119     paf       222:                // temporarily set method_frame's self to target_self
1.129     paf       223:                Temp_method_frame_self tmfs(*r.get_method_frame(), *target_self);
1.73      paf       224:                // execute!     
                    225:                r.execute(*main_method->parser_code);
1.1       paf       226:        }
                    227: }
                    228:        
1.138     paf       229: static void _rem(Request&, MethodParams& params) {
1.129     paf       230:        params.as_junction(0, "body must be code");
1.1       paf       231: }
                    232: 
1.129     paf       233: static void _while(Request& r, MethodParams& params) {
                    234:        Value& vcondition=params.as_junction(0, "condition must be expression");
                    235:        Value& body=params.as_junction(1, "body must be code");
1.1       paf       236: 
                    237:        // while...
                    238:        int endless_loop_count=0;
                    239:        while(true) {
1.18      parser    240:                if(++endless_loop_count>=MAX_LOOPS) // endless loop?
1.78      paf       241:                        throw Exception("parser.runtime",
1.129     paf       242:                                0,
1.1       paf       243:                                "endless loop detected");
                    244: 
1.86      paf       245:                bool condition=r.process_to_value(vcondition, 
1.1       paf       246:                                false/*don't intercept string*/).as_bool();
                    247:                if(!condition) // ...condition is true
                    248:                        break;
                    249: 
                    250:                // write processed body
1.86      paf       251:                r.write_pass_lang(r.process(body));
1.1       paf       252:        }
                    253: }
                    254: 
1.129     paf       255: static void _use(Request& r, MethodParams& params) {
                    256:        Value& vfile=params.as_no_junction(0, "file name must not be code");
1.113     paf       257:        r.use_file(r.main_class, vfile.as_string());
1.1       paf       258: }
                    259: 
1.129     paf       260: static void _for(Request& r, MethodParams& params) {
                    261:        const String& var_name=params.as_string(0, "var name must be string");
                    262:        int from=params.as_int(1, "from must be int", r);
                    263:        int to=params.as_int(2, "to must be int", r);
                    264:        Value&  body_code=params.as_junction(3, "body must be code");
                    265:        Value* delim_maybe_code=params.count()>4?&params[4]:0;
1.1       paf       266: 
1.57      paf       267:        if(to-from>=MAX_LOOPS) // too long loop?
1.78      paf       268:                throw Exception("parser.runtime",
1.129     paf       269:                        0,
1.57      paf       270:                        "endless loop detected");
                    271: 
1.1       paf       272:        bool need_delim=false;
1.129     paf       273:        VInt* vint=new VInt(0);
1.154   ! paf       274: 
        !           275:        VMethodFrame& caller=*r.get_method_frame()->caller();
        !           276:        caller.put_element(caller, var_name, vint, false);
1.1       paf       277:        for(int i=from; i<=to; i++) {
                    278:                vint->set_int(i);
                    279: 
1.108     paf       280:                StringOrValue sv_processed=r.process(body_code);
1.129     paf       281:                const String* s_processed=sv_processed.get_string();
                    282:                if(delim_maybe_code && s_processed && s_processed->length()) { // delimiter set and we have body
1.108     paf       283:                        if(need_delim) // need delim & iteration produced string?
1.86      paf       284:                                r.write_pass_lang(r.process(*delim_maybe_code));
1.1       paf       285:                        need_delim=true;
                    286:                }
1.108     paf       287:                r.write_pass_lang(sv_processed);
1.1       paf       288:        }
                    289: }
                    290: 
1.129     paf       291: static void _eval(Request& r, MethodParams& params) {
                    292:        Value& expr=params.as_junction(0, "need expression");
1.1       paf       293:        // evaluate expresion
1.129     paf       294:        Value& value_result=r.process_to_value(expr, 
1.1       paf       295:                true/*don't intercept string*/).as_expr_result();
1.129     paf       296:        if(params.count()>1) {
                    297:                Value& fmt=params.as_no_junction(1, "fmt must not be code");
                    298:                r.write_no_lang(String(format(value_result.as_double(), fmt.as_string().cstrm())));
1.91      paf       299:        } else
1.129     paf       300:                r.write_no_lang(value_result);
1.1       paf       301: }
                    302: 
1.129     paf       303: static void _connect(Request& r, MethodParams& params) {
1.63      paf       304: #ifdef RESOURCES_DEBUG
                    305: struct timeval mt[2];
                    306: #endif
1.129     paf       307:        Value& url=params.as_no_junction(0, "url must not be code");
                    308:        Value& body_code=params.as_junction(1, "body must be code");
1.1       paf       309: 
1.129     paf       310:        Table* protocol2driver_and_client=0;
                    311:        if(Value* sql=r.main_class.get_element(String(MAIN_SQL_NAME), r.main_class, false)) {
                    312:                if(Value* element=sql->get_element(String(MAIN_SQL_DRIVERS_NAME), *sql, false)) {
1.113     paf       313:                        protocol2driver_and_client=element->get_table();
                    314:                }
                    315:        }
1.11      paf       316: 
1.63      paf       317: #ifdef RESOURCES_DEBUG
                    318: //measure:before
                    319: gettimeofday(&mt[0],NULL);
                    320: #endif
1.1       paf       321:        // connect
1.142     paf       322:        SQL_Connection* connection=SQL_driver_manager->get_connection(url.as_string(), 
1.144     paf       323:                protocol2driver_and_client,
                    324:                r.charsets.source().NAME().cstr());
1.1       paf       325: 
1.63      paf       326: #ifdef RESOURCES_DEBUG
                    327: //measure:after connect
                    328: gettimeofday(&mt[1],NULL);
                    329: 
                    330: double t[2];
                    331: for(int i=0;i<2;i++)
                    332:     t[i]=mt[i].tv_sec+mt[i].tv_usec/1000000.0;
                    333: 
                    334: r.sql_connect_time+=t[1]-t[0];
                    335: #endif
1.129     paf       336:        Temp_connection temp_connection(r, connection);
1.1       paf       337:        // execute body
1.53      parser    338:        try {
1.86      paf       339:                r.write_assign_lang(r.process(body_code));
1.129     paf       340:                connection->commit();
                    341:                connection->close();
1.75      paf       342:        } catch(...) { // process problem
1.129     paf       343:                connection->rollback();
                    344:                connection->close();
                    345:                rethrow;
1.1       paf       346:        }
                    347: }
                    348: 
1.41      parser    349: #ifndef DOXYGEN
1.129     paf       350: class Switch_data: public PA_Object {
                    351: public:
                    352:        Request& r;
                    353:        Value& searching;
                    354:        Value* found;
                    355:        Value* _default;
                    356: public:
                    357:        Switch_data(Request& ar, Value& asearching): 
                    358:          r(ar), searching(asearching) {}
1.28      parser    359: };
1.41      parser    360: #endif
1.129     paf       361: static void _switch(Request& r, MethodParams& params) {
                    362:        Switch_data* data=new Switch_data(r, r.process_to_value(params[0]));
1.135     paf       363:        Temp_hash_value<const String::Body, void*> 
1.129     paf       364:                switch_data_setter(r.classes_conf, switch_data_name, data);
1.28      parser    365: 
1.129     paf       366:        Value& cases_code=params.as_junction(1, "switch cases must be code");
1.82      paf       367:        // execution of found ^case[...]{code} must be in context of ^switch[...]{code}
                    368:        // because of stacked WWrapper used there as wcontext
1.84      paf       369:        r.process(cases_code, true/*intercept_string*/);
1.147     paf       370:        if(Value* selected_code=data->found? data->found: data->_default)
1.107     paf       371:                r.write_pass_lang(r.process(*selected_code));
1.28      parser    372: }
                    373: 
1.129     paf       374: static void _case(Request& r, MethodParams& params) {
                    375:        Switch_data* data=static_cast<Switch_data*>(r.classes_conf.get(switch_data_name));
1.38      parser    376:        if(!data)
1.78      paf       377:                throw Exception("parser.runtime",
1.129     paf       378:                        0,
1.38      parser    379:                        "without switch");
1.28      parser    380: 
1.129     paf       381:        int count=params.count();
                    382:        Value& code=params.as_junction(--count, "case result must be code");
1.83      paf       383:        
1.28      parser    384:        for(int i=0; i<count; i++) {
1.129     paf       385:                Value& value=r.process_to_value(params[i]);
1.28      parser    386: 
1.82      paf       387:                if(value.as_string() == CASE_DEFAULT_VALUE) {
1.129     paf       388:                        data->_default=&code;
1.28      parser    389:                        break;
                    390:                }
                    391: 
                    392:                bool matches;
1.129     paf       393:                if(data->searching.is_string())
                    394:                        matches=data->searching.as_string() == value.as_string();
1.28      parser    395:                else
1.129     paf       396:                        matches=data->searching.as_double() == value.as_double();
1.28      parser    397: 
                    398:                if(matches) {
1.82      paf       399:                        if(data->found)
                    400:                                throw Exception("parser.runtime",
1.129     paf       401:                                        0,
1.82      paf       402:                                        "duplicate found");
                    403: 
1.129     paf       404:                        data->found=&code;
1.28      parser    405:                        break;
                    406:                }
                    407:        }
                    408: }
1.136     paf       409: #ifndef DOXYGEN
                    410: struct Try_catch_result {
                    411:        StringOrValue processed_code;
                    412:        const String* exception_should_be_handled;
                    413: 
                    414:        Try_catch_result(): exception_should_be_handled(0) {}
                    415: };
                    416: #endif
                    417: 
                    418: /// used by ^try and ^cache, @returns $exception.handled[string] if any
                    419: template<class I>
                    420: static Try_catch_result try_catch(Request& r, 
                    421:                  StringOrValue body_code(Request&, I), I info, 
                    422:                  Value* catch_code) 
                    423: {
                    424:        Try_catch_result result;
                    425:        if(!catch_code) {
                    426:                result.processed_code=body_code(r, info);
                    427:                return result;
                    428:        }
                    429: 
                    430:        // taking snapshot of try-context
                    431:        Request_context_saver try_context(r);
                    432:        try {
                    433:                result.processed_code=body_code(r, info);
                    434:        } catch(const Exception& e) {
                    435:                Request_context_saver throw_context(r); // taking snapshot of throw-context [stack trace contains error]
                    436:                Request::Exception_details details=r.get_details(e);
                    437:                try_context.restore(); // restoring try-context to perform catch-code
                    438: 
                    439:                Junction* junction=catch_code->get_junction();
                    440:                Value* method_frame=junction->method_frame;
                    441:                Value* saved_exception_var_value=method_frame->get_element(exception_var_name, *method_frame, false);
1.154   ! paf       442:                VMethodFrame& frame=*junction->method_frame;
        !           443:                frame.put_element(frame, exception_var_name, &details.vhash, false);
1.136     paf       444:                result.processed_code=r.process(*catch_code);
                    445:                
                    446:                // retriving $exception.handled, restoring $exception var
                    447:                Value* vhandled=details.vhash.hash().get(exception_handled_part_name);
1.154   ! paf       448:                frame.put_element(frame, exception_var_name, saved_exception_var_value, false);
1.136     paf       449: 
                    450:                bool bhandled=false;
                    451:                if(vhandled) {
                    452:                        if(vhandled->is_string()) { // not simple $exception.handled(1/0)?
                    453:                                result.exception_should_be_handled=vhandled->get_string(); // considering 'recovered' and let the caller recover
                    454:                                return result;
                    455:                        }
                    456: 
                    457:                        bhandled=vhandled->as_bool();           
                    458:                }
                    459: 
                    460:                if(!bhandled) {
                    461:                        throw_context.restore(); // restoring throw-context [exception were not handled]
                    462:                        rethrow;
                    463:                }
                    464:        }
                    465:        return result;
                    466: }
1.28      parser    467: 
1.63      paf       468: // cache--
                    469: 
                    470: // consts
                    471: 
1.152     paf       472: const int DATA_STRING_SERIALIZED_VERSION=0x0006;
1.63      paf       473: 
                    474: // helper types
                    475: 
                    476: #ifndef DOXYGEN
                    477: struct Data_string_serialized_prolog {
                    478:        int version;
1.79      paf       479:        time_t expires;
1.63      paf       480: };
                    481: #endif
                    482: 
1.68      paf       483: void cache_delete(const String& file_spec) {
                    484:        file_delete(file_spec, false/*fail_on_read_problem*/);
1.63      paf       485: }
1.69      paf       486: 
                    487: #ifndef DOXYGEN
1.135     paf       488: struct Cache_scope {
1.129     paf       489: public:
1.79      paf       490:        time_t expires;
1.135     paf       491:        const String* body_from_disk;
1.79      paf       492: };
1.69      paf       493: struct Locked_process_and_cache_put_action_info {
                    494:        Request *r;
1.136     paf       495:        Cache_scope *scope;
                    496:        Value* body_code; Value* catch_code; 
                    497:        const String* processed_code;
1.69      paf       498: };
                    499: #endif
1.136     paf       500: 
                    501: 
                    502: 
                    503: static StringOrValue process_cache_body_code(Request& r, Value* body_code) {
1.153     paf       504:        return StringOrValue(r.process_to_string(*body_code));
1.136     paf       505: }
                    506: 
1.129     paf       507: /* @todo maybe network order worth spending some effort?
                    508:        don't bothering myself with network byte order,
                    509:        am not planning to be able to move resulting file across platforms
                    510: */
1.69      paf       511: static void locked_process_and_cache_put_action(int f, void *context) {
                    512:        Locked_process_and_cache_put_action_info& info=
                    513:                *static_cast<Locked_process_and_cache_put_action_info *>(context);
1.129     paf       514: 
1.69      paf       515:        // body->process 
1.136     paf       516:        Try_catch_result result=try_catch(*info.r, 
                    517:                process_cache_body_code, info.body_code,
                    518:                info.catch_code);
                    519: 
                    520:        if(result.exception_should_be_handled) {
                    521:                if(*result.exception_should_be_handled==CACHE_EXCEPTION_HANDLED_CACHE_NAME) {
                    522:                        if(const String* body_from_disk=info.scope->body_from_disk) // we have something old?
                    523:                                info.processed_code=body_from_disk;
                    524:                        else
                    525:                                throw Exception(0,
                    526:                                        new String("$"EXCEPTION_VAR_NAME"."EXCEPTION_HANDLED_PART_NAME"["CACHE_EXCEPTION_HANDLED_CACHE_NAME"]"),
                    527:                                        "fallback failed - there is no old cached body");
                    528:                } else
                    529:                        throw Exception("parser.runtime",
                    530:                                result.exception_should_be_handled,
                    531:                                "$"EXCEPTION_VAR_NAME"."EXCEPTION_HANDLED_PART_NAME" value must be "
                    532:                                "either boolean or string '"CACHE_EXCEPTION_HANDLED_CACHE_NAME"'");
                    533:        } else
                    534:                info.processed_code=&result.processed_code.as_string();
1.69      paf       535: 
1.79      paf       536:        // expiration time not spoiled by ^cache(0) or something?
1.136     paf       537:        if(info.scope->expires > time(0)) {
1.79      paf       538:                // string -serialize> buffer
1.136     paf       539:                String::Cm serialized=info.processed_code->serialize(
1.129     paf       540:                        sizeof(Data_string_serialized_prolog));
1.79      paf       541:                Data_string_serialized_prolog& prolog=
1.129     paf       542:                        *reinterpret_cast<Data_string_serialized_prolog *>(serialized.str);
1.79      paf       543:                prolog.version=DATA_STRING_SERIALIZED_VERSION;
1.136     paf       544:                prolog.expires=info.scope->expires;
1.79      paf       545:                
                    546:                // buffer -write> file
1.129     paf       547:                write(f, serialized.str, serialized.length);
1.79      paf       548:        } else // expired!
1.136     paf       549:                info.scope->expires=0; // flag it so that could be easily checked by caller
1.69      paf       550: }
1.129     paf       551: const String* locked_process_and_cache_put(Request& r, 
1.128     paf       552:                                           Value& body_code,
1.136     paf       553:                                           Value* catch_code,
                    554:                                           Cache_scope& scope,
                    555:                                           const String& file_spec) 
                    556: {
1.140     paf       557:        Locked_process_and_cache_put_action_info info={&r, &scope, &body_code, catch_code, 0};
1.69      paf       558: 
1.129     paf       559:        const String* result=file_write_action_under_lock(
1.69      paf       560:                file_spec, 
                    561:                "cache_put", locked_process_and_cache_put_action, &info,
                    562:                false/*as_text*/,
                    563:                false/*do_append*/,
1.96      paf       564:                false/*block*/,
1.136     paf       565:                false/*fail on lock problem*/) ? info.processed_code: 0;
1.100     paf       566:        time_t now=time(0);
1.136     paf       567:        if(scope.expires<=now)
1.79      paf       568:                cache_delete(file_spec);
                    569:        return result;
1.63      paf       570: }
1.137     paf       571: #ifndef DOXYGEN
1.135     paf       572: struct Cache_get_result {
                    573:        const String* body;
                    574:        bool expired;
1.137     paf       575: };
                    576: #endif
                    577: static Cache_get_result cache_get(Request_charsets& charsets, const String& file_spec, time_t now) {
1.140     paf       578:        Cache_get_result result={0, false};
1.135     paf       579: 
1.129     paf       580:        File_read_result file=file_read(charsets, file_spec, 
1.63      paf       581:                           false/*as_text*/, 
1.129     paf       582:                           0, //no params
                    583:                           false/*fail_on_read_problem*/);
                    584:        if(file.success && file.length/* ignore reads which are empty due to 
1.72      paf       585:                        non-unary open+lockEX conflict with lockSH */) {
1.129     paf       586:                        
1.72      paf       587:                Data_string_serialized_prolog& prolog=
1.129     paf       588:                        *reinterpret_cast<Data_string_serialized_prolog *>(file.str);
1.63      paf       589: 
1.135     paf       590:                String* body=new String;
1.72      paf       591:                if(
1.129     paf       592:                        file.length>=sizeof(Data_string_serialized_prolog)
1.135     paf       593:                        && prolog.version==DATA_STRING_SERIALIZED_VERSION) {
                    594:                        if(body->deserialize(sizeof(Data_string_serialized_prolog),  file.str, file.length)) {
                    595:                                result.body=body;
                    596:                                result.expired=prolog.expires <= now;
                    597:                        }
                    598:                }
1.72      paf       599:        }
1.63      paf       600: 
1.135     paf       601:        return result;
1.63      paf       602: }
1.129     paf       603: static time_t as_expires(Request& r, MethodParams& params, 
1.79      paf       604:                                                int index, time_t now) {
                    605:        time_t result;
1.129     paf       606:        if(Value* vdate=params[index].as(VDATE_TYPE, false))
                    607:                result=static_cast<VDate*>(vdate)->get_time();
1.79      paf       608:        else
1.129     paf       609:                result=now+(time_t)params.as_double(index, "lifespan must be date or number", r);
1.79      paf       610:        
                    611:        return result;
                    612: }
1.129     paf       613: static const String& as_file_spec(Request& r, MethodParams& params, int index) {
                    614:        return r.absolute(params.as_string(index, "filespec must be string"));
1.79      paf       615: }
1.129     paf       616: static void _cache(Request& r, MethodParams& params) {
1.79      paf       617:        time_t now=time(0);
                    618: 
                    619:        // ^cache[filename] ^cache(seconds) ^cache[expires date]
1.129     paf       620:        if(params.count()==1) {
                    621:                if(params[0].is_string()) { // filename?
1.79      paf       622:                        cache_delete(as_file_spec(r, params, 0));
                    623:                        return;
                    624:                }
                    625: 
                    626:                // secods|expires date
1.135     paf       627:                Cache_scope* scope=static_cast<Cache_scope*>(r.classes_conf.get(cache_data_name));
                    628:                if(!scope)
1.79      paf       629:                        throw Exception("parser.runtime",
1.129     paf       630:                                0,
1.79      paf       631:                                "expire-time reducing instruction without cache");
                    632:                
1.129     paf       633:                time_t expires=as_expires(r, params, 0, now);
1.135     paf       634:                if(expires < scope->expires)
                    635:                        scope->expires=expires;
1.79      paf       636: 
                    637:                return;
1.149     paf       638:        } else if(params.count()<3)
                    639:                throw Exception("parser.runtime",
                    640:                        0,
                    641:                        "invalid number of parameters"); 
1.63      paf       642:        
                    643:        // file_spec, expires, body code
1.129     paf       644:        const String& file_spec=r.absolute(params.as_string(0, "filespec must be string"));
1.65      paf       645: 
1.141     paf       646:        Cache_scope scope={as_expires(r, params, 1, now), 0};
1.135     paf       647: 
                    648:        Temp_hash_value<const String::Body, void*> 
                    649:                cache_scope_setter(r.classes_conf, cache_data_name, &scope);
1.136     paf       650:        Value& body_code=params.as_junction(2, "body_code must be code");
                    651:        Value* catch_code=0;
                    652:        if(params.count()>3)
                    653:                catch_code=&params.as_junction(3, "catch_code must be code");
1.63      paf       654: 
1.135     paf       655:        if(scope.expires>now) { // valid 'expires' specified? try cached copy...
1.69      paf       656:                // hence we don't hope to have unary create/lockEX
                    657:                // we need some plan to live in a life like that, so... 
                    658:                // worst races plan:
                    659:                // A        B
                    660:                // open
                    661:                //          |open
                    662:                // lockSH
                    663:                //          |nonblocking-lockEX fails
                    664:                // unlockSH
                    665:                // close, cache_get returns 0
                    666:                // open
                    667:                // nonblocking-lockEX succeeds; process, write, close
                    668:                //          |retry1: open
                    669:                // ...
                    670:                //          |lockSH succeeds; ...
                    671: 
                    672:                for(int retry=0; retry<2; retry++) {
1.135     paf       673:                        Cache_get_result cached=cache_get(r.charsets, file_spec, now);
1.136     paf       674:                        if(cached.body) { // have cached copy
1.135     paf       675:                                if(cached.expired) 
                    676:                                        scope.body_from_disk=cached.body; // storing for user to retrive it with ^cache[]
1.136     paf       677:                                else // and it's not expired yet
                    678:                                {
1.135     paf       679:                                // write it out 
                    680:                                r.write_assign_lang(*cached.body);
                    681:                                // happy with it
                    682:                                return;
                    683:                        }
1.79      paf       684:                        }
1.69      paf       685: 
1.135     paf       686:                // non-blocked lock; process; cache it
                    687:                if(const String* processed_body=
1.136     paf       688:                        locked_process_and_cache_put(r, body_code, catch_code, scope, file_spec)) {
1.135     paf       689:                        // write it out 
                    690:                        r.write_assign_lang(*processed_body);
                    691:                        // happy with it
                    692:                        return;
                    693:                } else { // somebody writing result right now
                    694:                        pa_sleep(0, 500000); // waiting half a second
                    695:                        retry=0; // prolonging our wait, than could cache_get it, without processing body_code
                    696:                }
1.69      paf       697:                }
1.78      paf       698:                throw Exception(0,
1.69      paf       699:                        &file_spec,
                    700:                        "locking problem");
                    701:        } else { 
1.79      paf       702:                // instructed not to cache; forget cached copy
1.68      paf       703:                cache_delete(file_spec);
1.69      paf       704:                // process
1.81      paf       705:                const String& processed_body=r.process_to_string(body_code);
1.69      paf       706:                // write it out 
                    707:                r.write_assign_lang(processed_body);
                    708:                // happy with it
                    709:                return;
                    710:        }
                    711:        // never reached
1.63      paf       712: }
                    713: 
1.136     paf       714: static StringOrValue process_try_body_code(Request& r, Value* body_code) {
                    715:        return r.process(*body_code);
                    716: }
1.129     paf       717: static void _try_operator(Request& r, MethodParams& params) {
                    718:        Value& body_code=params.as_junction(0, "body_code must be code");
                    719:        Value& catch_code=params.as_junction(1, "catch_code must be code");
1.74      paf       720: 
1.136     paf       721:        Try_catch_result result=try_catch(r, 
                    722:                process_try_body_code, &body_code,
                    723:                &catch_code);
                    724:        
                    725:        if(result.exception_should_be_handled)
                    726:                throw Exception("parser.runtime",
                    727:                        result.exception_should_be_handled,
                    728:                        "catch block must set $exception.handled to some boolean value, not string");
1.123     paf       729: 
1.136     paf       730:        // write out processed body_code or catch_code
                    731:        r.write_pass_lang(result.processed_code);
1.74      paf       732: }
                    733: 
1.138     paf       734: static void _throw_operator(Request&, MethodParams& params) {
1.129     paf       735:        if(params.count()==1) {
                    736:                if(HashStringValue *hash=params[0].get_hash()) {
                    737:                        const char* type=0;
                    738:                        if(Value* value=hash->get(exception_type_part_name))
1.78      paf       739:                                type=value->as_string().cstr();
1.129     paf       740:                        const String* source=0;
                    741:                        if(Value* value=hash->get(exception_source_part_name))
1.74      paf       742:                                source=&value->as_string();
1.138     paf       743:                        const char* comment=0;
1.129     paf       744:                        if(Value* value=hash->get(exception_comment_part_name))
1.74      paf       745:                                comment=value->as_string().cstr();
                    746: 
1.78      paf       747:                        throw Exception(type,
1.129     paf       748:                                source?source:0,
                    749:                                "%s", comment?comment:"");
1.74      paf       750:                } else
1.78      paf       751:                        throw Exception("parser.runtime",
1.129     paf       752:                                0,
1.74      paf       753:                                "one-param version has hash param");
                    754:        } else {
1.129     paf       755:                const char* type=params.as_string(0, "type must be string").cstr();
                    756:                const String& source=params.as_string(1, "source must be string");
                    757:                const char* comment=params.count()>2? params.as_string(2, "comment must be string").cstr()
                    758:                        :0;
1.97      paf       759:                throw Exception(type, &source, "%s", comment?comment:"");
1.74      paf       760:        }
1.132     paf       761:  }
1.129     paf       762: 
1.150     paf       763: static void _sleep_operator(Request& r, MethodParams& params) {
                    764:        double seconds=params.as_double(0, "seconds must be double", r);
1.151     paf       765:        pa_sleep((int)trunc(seconds), (int)trunc(seconds*1000));
1.150     paf       766:  }
                    767: 
1.129     paf       768: #if defined(WIN32) && defined(_DEBUG)
                    769: #      define PA_BPT
1.138     paf       770: static void _bpt(Request&, MethodParams&) {
1.129     paf       771:        _asm int 3;
                    772: }
                    773: #endif
                    774: 
1.10      paf       775: // constructor
                    776: 
1.129     paf       777: VClassMAIN::VClassMAIN(): VClass() {
                    778:        set_name(*new String(MAIN_CLASS_NAME));
                    779: 
                    780: #ifdef PA_BPT
                    781:        // ^bpt[]
                    782:        add_native_method("bpt", Method::CT_ANY, _bpt, 0, 0);
                    783: #endif
1.121     paf       784: 
1.1       paf       785:        // ^if(condition){code-when-true}
                    786:        // ^if(condition){code-when-true}{code-when-false}
1.10      paf       787:        add_native_method("if", Method::CT_ANY, _if, 2, 3);
1.1       paf       788: 
                    789:        // ^untaint[as-is|uri|sql|js|html|html-typo]{code}
1.59      paf       790:        add_native_method("untaint", Method::CT_ANY, _untaint, 1, 2);
1.1       paf       791: 
                    792:        // ^taint[as-is|uri|sql|js|html|html-typo]{code}
1.10      paf       793:        add_native_method("taint", Method::CT_ANY, _taint, 1, 2);
1.1       paf       794: 
                    795:        // ^process[code]
1.146     paf       796:        add_native_method("process", Method::CT_ANY, _process, 1, 3);
1.1       paf       797: 
                    798:        // ^rem{code}
1.51      parser    799:        add_native_method("rem", Method::CT_ANY, _rem, 1, 10000);
1.1       paf       800: 
                    801:        // ^while(condition){code}
1.10      paf       802:        add_native_method("while", Method::CT_ANY, _while, 2, 2);
1.1       paf       803: 
                    804:        // ^use[file]
1.10      paf       805:        add_native_method("use", Method::CT_ANY, _use, 1, 1);
1.1       paf       806: 
1.54      paf       807:        // ^for[i](from-number;to-number-inclusive){code}[delim]
1.10      paf       808:        add_native_method("for", Method::CT_ANY, _for, 3+1, 3+1+1);
1.1       paf       809: 
                    810:        // ^eval(expr)
                    811:        // ^eval(expr)[format]
1.10      paf       812:        add_native_method("eval", Method::CT_ANY, _eval, 1, 2);
1.52      parser    813: 
1.1       paf       814:        // ^connect[protocol://user:pass@host[:port]/database]{code with ^sql-s}
1.10      paf       815:        add_native_method("connect", Method::CT_ANY, _connect, 2, 2);
                    816: 
1.63      paf       817: 
1.136     paf       818:        // ^cache[file_spec](time){code}[{catch code}] time=0 no cache
1.65      paf       819:        // ^cache[file_spec] delete cache
1.136     paf       820:        add_native_method("cache", Method::CT_ANY, _cache, 1, 4);
1.63      paf       821:        
1.28      parser    822:        // switch
                    823: 
                    824:        // ^switch[value]{cases}
                    825:        add_native_method("switch", Method::CT_ANY, _switch, 2, 2);
                    826: 
                    827:        // ^case[value]{code}
1.51      parser    828:        add_native_method("case", Method::CT_ANY, _case, 2, 10000);
1.74      paf       829: 
                    830:        // try-catch
                    831: 
                    832:        // ^try{code}{catch code}
                    833:        add_native_method("try", Method::CT_ANY, _try_operator, 2, 2);
                    834:        // ^throw[$exception hash]
                    835:        // ^throw[type;source;comment]
                    836:        add_native_method("throw", Method::CT_ANY, _throw_operator, 1, 3);
                    837: 
1.150     paf       838:        add_native_method("sleep", Method::CT_ANY, _sleep_operator, 1, 1);
1.10      paf       839: }
1.11      paf       840: 
                    841: // constructor & configurator
1.1       paf       842: 
1.129     paf       843: VStateless_class& VClassMAIN_create() {
                    844:        return *new VClassMAIN;
1.1       paf       845: }

E-mail: