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

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

E-mail: