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

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

E-mail: