Annotation of parser3/src/include/pa_request.h, revision 1.112

1.61      paf         1: /** @file
1.62      paf         2:        Parser: request class decl.
                      3: 
1.32      paf         4:        Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)
1.109     paf         5:        Author: Alexander Petrosyan <paf@design.ru> (http://paf.design.ru)
1.32      paf         6: 
1.112   ! paf         7:        $Id: pa_request.h,v 1.111.2.1.2.1 2001/12/06 20:23:44 paf Exp $
1.1       paf         8: */
                      9: 
                     10: #ifndef PA_REQUEST_H
                     11: #define PA_REQUEST_H
                     12: 
1.88      parser     13: #include "pa_config_includes.h"
1.1       paf        14: #include "pa_pool.h"
1.5       paf        15: #include "pa_hash.h"
1.7       paf        16: #include "pa_wcontext.h"
1.6       paf        17: #include "pa_value.h"
1.7       paf        18: #include "pa_stack.h"
1.12      paf        19: #include "pa_vclass.h"
1.45      paf        20: #include "pa_vobject.h"
1.47      paf        21: #include "pa_venv.h"
1.108     paf        22: #include "pa_vstatus.h"
1.48      paf        23: #include "pa_vform.h"
1.90      parser     24: #include "pa_vmath.h"
1.56      paf        25: #include "pa_vrequest.h"
1.57      paf        26: #include "pa_vresponse.h"
1.60      paf        27: #include "pa_vcookie.h"
1.77      paf        28: #include "pa_sql_driver_manager.h"
1.44      paf        29: 
1.112   ! paf        30: #ifdef RESOURCES_DEBUG
        !            31: #include <sys/resource.h>
        !            32: #endif
        !            33: 
1.7       paf        34: #ifndef NO_STRING_ORIGIN
1.40      paf        35: #      define COMPILE_PARAMS  \
                     36:                const char *source, \
1.46      paf        37:                VStateless_class *aclass, const String *name, \
                     38:                VStateless_class *base_class, \
1.40      paf        39:                const char *file
                     40: #      define COMPILE(source, aclass, name, base_class, file)  \
                     41:                real_compile(source, aclass, name, base_class, file)
1.7       paf        42: #else
1.40      paf        43: #      define COMPILE_PARAMS  \
                     44:                const char *source, \
1.46      paf        45:                VStateless_class *aclass, const String *name, \
                     46:                VStateless_class *base_class
1.40      paf        47: #      define COMPILE(source, aclass, name, base_class, file)  \
                     48:                real_compile(source, aclass, name, base_class)
1.7       paf        49: #endif
1.4       paf        50: 
1.39      paf        51: class Temp_lang;
1.84      paf        52: class Methoded;
1.1       paf        53: 
1.61      paf        54: /// Main workhorse.
1.7       paf        55: class Request : public Pooled {
1.107     paf        56:        friend class Temp_lang;
1.1       paf        57: public:
1.112   ! paf        58: 
        !            59: #ifdef RESOURCES_DEBUG
        !            60:        /// measures
        !            61:        double sql_connect_time;
        !            62:        double sql_request_time;
        !            63: #endif 
1.61      paf        64: 
                     65:        /// some information from web server
1.65      paf        66:        class Info {
                     67:        public:
1.53      paf        68:                const char *document_root;
                     69:                const char *path_translated;
1.56      paf        70:                const char *method;
1.53      paf        71:                const char *query_string;
1.56      paf        72:                const char *uri;
1.53      paf        73:                const char *content_type;
                     74:                size_t content_length;
1.60      paf        75:                const char *cookie;
1.71      paf        76:                const char *user_agent;
1.53      paf        77:        };
                     78:        
1.50      paf        79:        Request(Pool& apool,
1.53      paf        80:                Info& ainfo,
1.111     paf        81:                uchar adefault_lang, ///< all tainted data default untainting lang
1.110     paf        82:                bool status_allowed ///<  status class allowed
1.50      paf        83:        );
1.3       paf        84:        ~Request() {}
1.1       paf        85: 
1.61      paf        86:        /// global classes
1.6       paf        87:        Hash& classes() { return fclasses; }
                     88: 
1.65      paf        89:        /**
                     90:                core request processing
                     91: 
                     92:                BEWARE: may throw exception to you: catch it!
                     93:        */
                     94:        void core(
1.95      parser     95:                const char *root_config_filespec, ///< system config filespec
                     96:                bool root_config_fail_on_read_problem, ///< fail if system config file not found
                     97:                const char *site_config_filespec, ///< site config filespec
                     98:                bool site_config_fail_on_read_problem, ///< fail if site config file not found
1.65      paf        99:                bool header_only);
1.17      paf       100: 
1.61      paf       101:        /// executes ops
1.89      parser    102:        void execute(const Array& ops); // execute.C
1.40      paf       103: 
1.64      paf       104:        /// compiles the file, maybe forcing it's class @a name and @a base_class.
1.46      paf       105:        VStateless_class *use_file(
1.94      parser    106:                const String& file_name, 
                    107:                bool ignore_class_path=false, bool fail_on_read_problem=true,
1.45      paf       108:                const String *name=0, 
1.46      paf       109:                VStateless_class *base_class=0); // core.C
1.64      paf       110:        /// compiles a @a source buffer
1.46      paf       111:        VStateless_class *use_buf(
1.40      paf       112:                const char *source, const char *file,
1.46      paf       113:                VStateless_class *aclass=0, const String *name=0, 
                    114:                VStateless_class *base_class=0); // core.C
1.64      paf       115:        /// processes any code-junction there may be inside of @a value
1.40      paf       116:        Value& process(
1.33      paf       117:                Value& value, 
1.37      paf       118:                const String *name=0,
1.38      paf       119:                bool intercept_string=true); // execute.C
1.28      paf       120: 
1.61      paf       121:        /// appending, sure of clean string inside
1.65      paf       122:        void write_no_lang(const String& astring) {
1.111     paf       123:                wcontext->write(astring, 
                    124:                        String::UL_CLEAN | flang&String::UL_OPTIMIZE_BIT);
1.49      paf       125:        }
1.61      paf       126:        /// appending string, passing language built into string being written
1.65      paf       127:        void write_pass_lang(const String& astring) {
                    128:                wcontext->write(astring, String::UL_PASS_APPENDED); 
1.59      paf       129:        }
1.61      paf       130:        /// appending possible string, assigning untaint language
1.40      paf       131:        void write_assign_lang(Value& avalue) {
1.39      paf       132:                wcontext->write(avalue, flang); 
1.106     parser    133:        }
                    134:        /// appending string, assigning untaint language
                    135:        void write_assign_lang(const String& astring) {
                    136:                wcontext->write(astring, flang); 
1.22      paf       137:        }
1.61      paf       138:        /// appending possible string, passing language built into string being written
1.40      paf       139:        void write_pass_lang(Value& avalue) {
1.65      paf       140:                wcontext->write(avalue, String::UL_PASS_APPENDED); 
1.49      paf       141:        }
1.61      paf       142:        /// appending sure value, that would be converted to clean string
1.49      paf       143:        void write_no_lang(Value& avalue) {
1.111     paf       144:                wcontext->write(avalue, 
                    145:                        String::UL_CLEAN | flang&String::UL_OPTIMIZE_BIT);
1.55      paf       146:        }
1.61      paf       147:        /// appending sure value, not VString
1.55      paf       148:        void write_expr_result(Value& avalue) {
                    149:                wcontext->write(avalue); 
1.40      paf       150:        }
1.22      paf       151: 
1.64      paf       152:        /// returns relative to @a path  path to @a file 
1.69      paf       153:        const String& relative(const char *apath, const String& relative_name);
1.61      paf       154: 
1.64      paf       155:        /// returns an absolute @a path to relative @a name
1.69      paf       156:        const String& absolute(const String& relative_name);
1.42      paf       157: 
1.80      paf       158:        /// returns the mime type of 'user_file_name_cstr'
                    159:        const String& mime_type_of(const char *user_file_name_cstr);
                    160: 
1.99      parser    161:        /// PCRE character tables
1.101     parser    162:        const unsigned char *pcre_tables();
1.99      parser    163: 
1.17      paf       164: public:
1.22      paf       165:        
1.61      paf       166:        /// info from web server
1.53      paf       167:        Info& info;
1.81      paf       168:        /// user's post data
                    169:        char *post_data;  size_t post_size;
1.53      paf       170: 
1.78      paf       171:        /// operators are methods of this class
1.84      paf       172:        Methoded& OP;
1.86      paf       173:        /// $env:fields
1.57      paf       174:        VEnv env;
1.108     paf       175:        /// $status:fields
                    176:        VStatus status;
1.86      paf       177:        /// $form:elements
1.57      paf       178:        VForm form;
1.90      parser    179:        /// $math:constants
                    180:        VMath math;
1.86      paf       181:        /// $request:elements
1.57      paf       182:        VRequest request;
1.86      paf       183:        /// $response:elements
1.57      paf       184:        VResponse response;
1.86      paf       185:        /// $cookie:elements
1.60      paf       186:        VCookie cookie;
1.70      paf       187: 
1.61      paf       188:        /// contexts
1.22      paf       189:        Value *self, *root, *rcontext;
1.61      paf       190:        /// contexts
1.22      paf       191:        WContext *wcontext;
1.85      paf       192: 
1.86      paf       193:        /// 'MAIN' class conglomerat
1.85      paf       194:        VStateless_class *main_class;
1.76      paf       195: 
                    196:        /// connection
1.77      paf       197:        SQL_Connection *connection;
1.87      paf       198: 
                    199:        /// classes configured data
                    200:        Hash classes_conf;
                    201: 
1.7       paf       202: private: // core data
1.6       paf       203: 
1.89      parser    204:        /// classes
1.6       paf       205:        Hash fclasses;
1.67      paf       206: 
1.89      parser    207:        /// already used files to avoid cyclic uses
1.67      paf       208:        Hash used_files;
1.6       paf       209: 
1.89      parser    210:        /// execution stack
1.7       paf       211:        Stack stack;
1.89      parser    212: 
                    213:        /**     endless execute(execute(... preventing counter 
                    214:                @see ANTI_ENDLESS_EXECUTE_RECOURSION
                    215:        */
                    216:        uint anti_endless_execute_recoursion;
1.7       paf       217: 
1.100     parser    218:        /// charset->pcre_tables
1.99      parser    219:        Hash CTYPE;     
1.105     parser    220: 
                    221:        /// stack trace
                    222:        Stack trace;
1.99      parser    223: 
1.7       paf       224: private: // compile.C
                    225: 
1.46      paf       226:        VStateless_class& real_compile(COMPILE_PARAMS);
1.7       paf       227: 
                    228: private: // execute.C
                    229: 
1.92      parser    230:        const String *execute_method(Value& aself, 
                    231:                const Method& method, bool return_cstr=true);
                    232:        const String *execute_virtual_method(Value& aself, 
                    233:                const String& method_name, bool return_cstr=true);
1.93      parser    234:        const String *execute_nonvirtual_method(VStateless_class& aclass, 
1.92      parser    235:                const String& method_name, bool return_cstr=true);
1.9       paf       236: 
                    237:        Value *get_element();
1.22      paf       238: 
                    239: private: // lang&raw 
                    240:        
1.111     paf       241:        uchar flang;
1.58      paf       242: 
                    243: private: // defaults
                    244: 
1.111     paf       245:        const uchar fdefault_lang;
1.68      paf       246:        Value *default_content_type;
1.80      paf       247: 
                    248: private: // mime types
                    249: 
                    250:        /// $MAIN:MIME-TYPES
                    251:        Table *mime_types;
1.22      paf       252: 
1.39      paf       253: private: // lang manipulation
1.22      paf       254: 
1.111     paf       255:        uchar set_lang(uchar alang) {
                    256:                uchar result=flang;
1.39      paf       257:                flang=alang;
                    258:                return result;
                    259:        }
1.111     paf       260:        void restore_lang(uchar alang) {
1.39      paf       261:                flang=alang;
                    262:        }
                    263: 
1.59      paf       264: private:
                    265: 
1.75      paf       266:        void output_result(const VFile& body_file, bool header_only);
1.39      paf       267: };
                    268: 
1.61      paf       269: ///    Auto-object used for temporary changing Request::flang.
1.39      paf       270: class Temp_lang {
                    271:        Request& frequest;
1.111     paf       272:        uchar saved_lang;
1.39      paf       273: public:
1.111     paf       274:        Temp_lang(Request& arequest, uchar alang) : 
1.39      paf       275:                frequest(arequest),
                    276:                saved_lang(arequest.set_lang(alang)) {
                    277:        }
                    278:        ~Temp_lang() { 
                    279:                frequest.restore_lang(saved_lang); 
                    280:        }
1.91      parser    281: };
                    282: 
                    283: /**
                    284:        @b method parameters passed in this array.
                    285:        contains handy typecast ad junction/not junction ensurers
                    286: 
                    287: */
                    288: class MethodParams : public Array {
                    289: public:
                    290:        MethodParams(Pool& pool, const String& amethod_name) : Array(pool),
                    291:                fmethod_name(amethod_name) {
                    292:        }
                    293: 
                    294:        /// handy typecast. I long for templates
                    295:        Value& get(int index) { 
                    296:                return *static_cast<Value *>(Array::get(index)); 
                    297:        }
                    298:        /// handy is-value-a-junction ensurer
                    299:        Value& as_junction(int index, const char *msg) { 
                    300:                return get_as(index, true, msg); 
                    301:        }
                    302:        /// handy value-is-not-a-junction ensurer
                    303:        Value& as_no_junction(int index, const char *msg) { 
                    304:                return get_as(index, false, msg); 
                    305:        }
                    306:        /// handy expression auto-processing to double
1.102     parser    307:        double as_double(int index, const char *msg, Request& r) { 
                    308:                return get_processed(index, msg, r).as_double(); 
1.91      parser    309:        }
                    310:        /// handy expression auto-processing to int
1.102     parser    311:        int as_int(int index, const char *msg, Request& r) { 
                    312:                return get_processed(index, msg, r).as_int(); 
1.103     parser    313:        }
                    314:        /// handy expression auto-processing to bool
                    315:        bool as_bool(int index, const char *msg, Request& r) { 
                    316:                return get_processed(index, msg, r).as_bool(); 
1.91      parser    317:        }
                    318:        /// handy string ensurer
                    319:        const String& as_string(int index, const char *msg) { 
                    320:                return as_no_junction(index, msg).as_string(); 
                    321:        }
                    322: 
                    323: private:
                    324: 
                    325:        /// handy value-is/not-a-junction ensurer
                    326:        Value& get_as(int index, bool as_junction, const char *msg) { 
                    327:                Value& result=get(index);
                    328:                if((result.get_junction()!=0) ^ as_junction)
1.104     parser    329:                        throw Exception(0, 0,
1.91      parser    330:                                &fmethod_name,
                    331:                                "%s (parameter #%d)", msg, 1+index);
1.104     parser    332: 
1.91      parser    333:                return result;
                    334:        }
                    335: 
1.102     parser    336:        Value& get_processed(int index, const char *msg, Request& r) {
                    337:                return r.process(as_junction(index, msg),
1.91      parser    338:                        0/*no name*/,
                    339:                        false/*don't intercept string*/);
                    340:        }
                    341: 
                    342: private:
                    343: 
                    344:        const String& fmethod_name;
                    345: 
1.4       paf       346: };
1.1       paf       347: 
                    348: #endif

E-mail: