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

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.62      paf         5: 
1.36      paf         6:        Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)
1.32      paf         7: 
1.89    ! parser      8:        $Id: pa_request.h,v 1.88 2001/05/17 10:22:24 parser Exp $
1.1       paf         9: */
                     10: 
                     11: #ifndef PA_REQUEST_H
                     12: #define PA_REQUEST_H
                     13: 
1.88      parser     14: #include "pa_config_includes.h"
1.1       paf        15: #include "pa_pool.h"
1.5       paf        16: #include "pa_hash.h"
1.7       paf        17: #include "pa_wcontext.h"
1.6       paf        18: #include "pa_value.h"
1.7       paf        19: #include "pa_stack.h"
1.12      paf        20: #include "pa_vclass.h"
1.45      paf        21: #include "pa_vobject.h"
1.47      paf        22: #include "pa_venv.h"
1.48      paf        23: #include "pa_vform.h"
1.56      paf        24: #include "pa_vrequest.h"
1.57      paf        25: #include "pa_vresponse.h"
1.60      paf        26: #include "pa_vcookie.h"
1.77      paf        27: #include "pa_sql_driver_manager.h"
1.44      paf        28: 
1.7       paf        29: #ifndef NO_STRING_ORIGIN
1.40      paf        30: #      define COMPILE_PARAMS  \
                     31:                const char *source, \
1.46      paf        32:                VStateless_class *aclass, const String *name, \
                     33:                VStateless_class *base_class, \
1.40      paf        34:                const char *file
                     35: #      define COMPILE(source, aclass, name, base_class, file)  \
                     36:                real_compile(source, aclass, name, base_class, file)
1.7       paf        37: #else
1.40      paf        38: #      define COMPILE_PARAMS  \
                     39:                const char *source, \
1.46      paf        40:                VStateless_class *aclass, const String *name, \
                     41:                VStateless_class *base_class
1.40      paf        42: #      define COMPILE(source, aclass, name, base_class, file)  \
                     43:                real_compile(source, aclass, name, base_class)
1.7       paf        44: #endif
1.4       paf        45: 
1.39      paf        46: class Temp_lang;
1.84      paf        47: class Methoded;
1.1       paf        48: 
1.61      paf        49: /// Main workhorse.
1.7       paf        50: class Request : public Pooled {
1.39      paf        51:        friend Temp_lang;
1.1       paf        52: public:
1.61      paf        53: 
                     54:        /// some information from web server
1.65      paf        55:        class Info {
                     56:        public:
1.53      paf        57:                const char *document_root;
                     58:                const char *path_translated;
1.56      paf        59:                const char *method;
1.53      paf        60:                const char *query_string;
1.56      paf        61:                const char *uri;
1.53      paf        62:                const char *content_type;
                     63:                size_t content_length;
1.60      paf        64:                const char *cookie;
1.71      paf        65:                const char *user_agent;
1.53      paf        66:        };
                     67:        
1.50      paf        68:        Request(Pool& apool,
1.53      paf        69:                Info& ainfo,
1.63      paf        70:                String::Untaint_lang adefault_lang ///< all tainted data default untainting lang
1.50      paf        71:        );
1.3       paf        72:        ~Request() {}
1.1       paf        73: 
1.61      paf        74:        /// global classes
1.6       paf        75:        Hash& classes() { return fclasses; }
                     76: 
1.65      paf        77:        /**
                     78:                core request processing
                     79: 
                     80:                BEWARE: may throw exception to you: catch it!
                     81:        */
                     82:        void core(
1.66      paf        83:                const char *root_auto_path, ///< path to system auto.p file
                     84:                bool root_auto_fail, ///< fail if system auto.p file not found
                     85:                const char *site_auto_path, ///< path to site auto.p file
                     86:                bool site_auto_fail, ///< fail if site auto.p file not found
1.65      paf        87:                bool header_only);
1.17      paf        88: 
1.61      paf        89:        /// executes ops
1.89    ! parser     90:        void execute(const Array& ops); // execute.C
1.40      paf        91: 
1.64      paf        92:        /// compiles the file, maybe forcing it's class @a name and @a base_class.
1.46      paf        93:        VStateless_class *use_file(
1.69      paf        94:                const String& file_spec, bool fail_on_read_problem=true,
1.45      paf        95:                const String *name=0, 
1.46      paf        96:                VStateless_class *base_class=0); // core.C
1.64      paf        97:        /// compiles a @a source buffer
1.46      paf        98:        VStateless_class *use_buf(
1.40      paf        99:                const char *source, const char *file,
1.46      paf       100:                VStateless_class *aclass=0, const String *name=0, 
                    101:                VStateless_class *base_class=0); // core.C
1.64      paf       102:        /// processes any code-junction there may be inside of @a value
1.40      paf       103:        Value& process(
1.33      paf       104:                Value& value, 
1.37      paf       105:                const String *name=0,
1.38      paf       106:                bool intercept_string=true); // execute.C
1.28      paf       107: 
1.61      paf       108:        /// appending, sure of clean string inside
1.65      paf       109:        void write_no_lang(const String& astring) {
1.74      paf       110:                wcontext->write(astring, String::UL_CLEAN);
1.49      paf       111:        }
1.61      paf       112:        /// appending string, passing language built into string being written
1.65      paf       113:        void write_pass_lang(const String& astring) {
                    114:                wcontext->write(astring, String::UL_PASS_APPENDED); 
1.59      paf       115:        }
1.61      paf       116:        /// appending possible string, assigning untaint language
1.40      paf       117:        void write_assign_lang(Value& avalue) {
1.39      paf       118:                wcontext->write(avalue, flang); 
1.22      paf       119:        }
1.61      paf       120:        /// appending possible string, passing language built into string being written
1.40      paf       121:        void write_pass_lang(Value& avalue) {
1.65      paf       122:                wcontext->write(avalue, String::UL_PASS_APPENDED); 
1.49      paf       123:        }
1.61      paf       124:        /// appending sure value, that would be converted to clean string
1.49      paf       125:        void write_no_lang(Value& avalue) {
1.74      paf       126:                wcontext->write(avalue, String::UL_CLEAN);
1.55      paf       127:        }
1.61      paf       128:        /// appending sure value, not VString
1.55      paf       129:        void write_expr_result(Value& avalue) {
                    130:                wcontext->write(avalue); 
1.40      paf       131:        }
1.22      paf       132: 
1.64      paf       133:        /// returns relative to @a path  path to @a file 
1.69      paf       134:        const String& relative(const char *apath, const String& relative_name);
1.61      paf       135: 
1.64      paf       136:        /// returns an absolute @a path to relative @a name
1.69      paf       137:        const String& absolute(const String& relative_name);
1.42      paf       138: 
1.80      paf       139:        /// returns the mime type of 'user_file_name_cstr'
                    140:        const String& mime_type_of(const char *user_file_name_cstr);
                    141: 
1.17      paf       142: public:
1.22      paf       143:        
1.61      paf       144:        /// info from web server
1.53      paf       145:        Info& info;
1.81      paf       146:        /// user's post data
                    147:        char *post_data;  size_t post_size;
1.53      paf       148: 
1.78      paf       149:        /// operators are methods of this class
1.84      paf       150:        Methoded& OP;
1.86      paf       151:        /// $env:fields
1.57      paf       152:        VEnv env;
1.86      paf       153:        /// $form:elements
1.57      paf       154:        VForm form;
1.86      paf       155:        /// $request:elements
1.57      paf       156:        VRequest request;
1.86      paf       157:        /// $response:elements
1.57      paf       158:        VResponse response;
1.86      paf       159:        /// $cookie:elements
1.60      paf       160:        VCookie cookie;
1.70      paf       161: 
1.61      paf       162:        /// contexts
1.22      paf       163:        Value *self, *root, *rcontext;
1.61      paf       164:        /// contexts
1.22      paf       165:        WContext *wcontext;
1.85      paf       166: 
1.86      paf       167:        /// 'MAIN' class conglomerat
1.85      paf       168:        VStateless_class *main_class;
1.76      paf       169: 
                    170:        /// connection
1.77      paf       171:        SQL_Connection *connection;
1.83      paf       172:        /// PCRE character tables
                    173:        unsigned char *pcre_tables;
1.87      paf       174: 
                    175:        /// classes configured data
                    176:        Hash classes_conf;
                    177: 
1.6       paf       178: 
1.7       paf       179: private: // core data
1.6       paf       180: 
1.89    ! parser    181:        /// classes
1.6       paf       182:        Hash fclasses;
1.67      paf       183: 
1.89    ! parser    184:        /// already used files to avoid cyclic uses
1.67      paf       185:        Hash used_files;
1.6       paf       186: 
1.89    ! parser    187:        /// execution stack
1.7       paf       188:        Stack stack;
1.89    ! parser    189: 
        !           190:        /**     endless execute(execute(... preventing counter 
        !           191:                @see ANTI_ENDLESS_EXECUTE_RECOURSION
        !           192:        */
        !           193:        uint anti_endless_execute_recoursion;
1.7       paf       194: 
                    195: private: // compile.C
                    196: 
1.46      paf       197:        VStateless_class& real_compile(COMPILE_PARAMS);
1.7       paf       198: 
                    199: private: // execute.C
                    200: 
1.57      paf       201:        const String *execute_method(Value& aself, const Method& method, 
                    202:                bool return_cstr=true);
                    203:        const String *execute_method(Value& aself, const String& method_name, 
                    204:                bool return_cstr=true);
1.9       paf       205: 
                    206:        Value *get_element();
1.22      paf       207: 
                    208: private: // lang&raw 
                    209:        
1.39      paf       210:        String::Untaint_lang flang;
1.58      paf       211: 
                    212: private: // defaults
                    213: 
                    214:        const String::Untaint_lang fdefault_lang;
1.68      paf       215:        Value *default_content_type;
1.80      paf       216: 
                    217: private: // mime types
                    218: 
                    219:        /// $MAIN:MIME-TYPES
                    220:        Table *mime_types;
1.22      paf       221: 
1.39      paf       222: private: // lang manipulation
1.22      paf       223: 
1.39      paf       224:        String::Untaint_lang set_lang(String::Untaint_lang alang) {
                    225:                String::Untaint_lang result=flang;
                    226:                flang=alang;
                    227:                return result;
                    228:        }
                    229:        void restore_lang(String::Untaint_lang alang) {
                    230:                flang=alang;
                    231:        }
                    232: 
1.59      paf       233: private:
                    234: 
1.75      paf       235:        void output_result(const VFile& body_file, bool header_only);
1.39      paf       236: };
                    237: 
1.61      paf       238: ///    Auto-object used for temporary changing Request::flang.
1.39      paf       239: class Temp_lang {
                    240:        Request& frequest;
                    241:        String::Untaint_lang saved_lang;
                    242: public:
                    243:        Temp_lang(Request& arequest, String::Untaint_lang alang) : 
                    244:                frequest(arequest),
                    245:                saved_lang(arequest.set_lang(alang)) {
                    246:        }
                    247:        ~Temp_lang() { 
                    248:                frequest.restore_lang(saved_lang); 
                    249:        }
1.4       paf       250: };
1.1       paf       251: 
                    252: #endif

E-mail: