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

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

E-mail: