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

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

E-mail: