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

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

E-mail: