|
|
| version 1.6, 2001/02/21 16:11:49 | version 1.135, 2002/06/11 12:20:41 |
|---|---|
| Line 1 | Line 1 |
| /* | /** @file |
| $Id$ | Parser: request class decl. |
| Copyright (c) 2001, 2002 ArtLebedev Group (http://www.artlebedev.com) | |
| Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru) | |
| $Id$ | |
| */ | */ |
| #ifndef PA_REQUEST_H | #ifndef PA_REQUEST_H |
| #define PA_REQUEST_H | #define PA_REQUEST_H |
| #include "pa_pool.h" | #include "pa_pool.h" |
| #include "pa_exception.h" | |
| #include "pa_hash.h" | #include "pa_hash.h" |
| #include "pa_context.h" | #include "pa_wcontext.h" |
| #include "pa_value.h" | #include "pa_value.h" |
| #include "pa_stack.h" | |
| #include "pa_vclass.h" | |
| #include "pa_vobject.h" | |
| #include "pa_venv.h" | |
| #include "pa_vstatus.h" | |
| #include "pa_vform.h" | |
| #include "pa_vmath.h" | |
| #include "pa_vrequest.h" | |
| #include "pa_vresponse.h" | |
| #include "pa_vcookie.h" | |
| #include "pa_sql_driver_manager.h" | |
| #ifdef RESOURCES_DEBUG | |
| #include <sys/resource.h> | |
| #endif | |
| // consts | |
| #define MAIN_METHOD_NAME "main" | |
| const uint ANTI_ENDLESS_EXECUTE_RECOURSION=500; | |
| class Local_request_exception; | // defines |
| class Request { | #ifndef NO_STRING_ORIGIN |
| friend Local_request_exception; | # define COMPILE_PARAMS \ |
| const char *source, \ | |
| VStateless_class *aclass, const String *name, \ | |
| VStateless_class *base_class, \ | |
| const char *file | |
| # define COMPILE(source, aclass, name, base_class, file) \ | |
| real_compile(source, aclass, name, base_class, file) | |
| #else | |
| # define COMPILE_PARAMS \ | |
| const char *source, \ | |
| VStateless_class *aclass, const String *name, \ | |
| VStateless_class *base_class | |
| # define COMPILE(source, aclass, name, base_class, file) \ | |
| real_compile(source, aclass, name, base_class) | |
| #endif | |
| class Temp_lang; | |
| class Methoded; | |
| class VMethodFrame; | |
| /// Main workhorse. | |
| class Request : public Pooled { | |
| friend class Temp_lang; | |
| friend class Temp_connection; | |
| public: | public: |
| #ifdef RESOURCES_DEBUG | |
| /// measures | |
| double sql_connect_time; | |
| double sql_request_time; | |
| #endif | |
| /// some information from web server | |
| class Info { | |
| public: | |
| const char *document_root; | |
| const char *path_translated; | |
| const char *method; | |
| const char *query_string; | |
| const char *uri; | |
| const char *content_type; | |
| size_t content_length; | |
| const char *cookie; | |
| }; | |
| Request(Pool& apool, | Request(Pool& apool, |
| Value *aroot, Value *aself, Value *arcontext, WContext *awcontext) : | Info& ainfo, |
| fpool(apool), | uchar adefault_lang, ///< all tainted data default untainting lang |
| root(aroot), self(aself), rcontext(arcontext), wcontext(awcontext), | bool status_allowed ///< status class allowed |
| fclasses(apool) | ); |
| { | ~Request(); |
| /// global classes | |
| Hash& classes() { return fclasses; } | |
| /** | |
| core request processing | |
| BEWARE: may throw exception to you: catch it! | |
| */ | |
| void core( | |
| const char *root_config_filespec, ///< system config filespec | |
| bool root_config_fail_on_read_problem, ///< fail if system config file not found | |
| const char *site_config_filespec, ///< site config filespec | |
| bool site_config_fail_on_read_problem, ///< fail if site config file not found | |
| bool header_only); | |
| /// executes ops | |
| void execute(const Array& ops); // execute.C | |
| /// execute ops with anti-recoursion check | |
| void recoursion_checked_execute(const String *name, const Array& ops) { | |
| // anti_endless_execute_recoursion | |
| if(++anti_endless_execute_recoursion==ANTI_ENDLESS_EXECUTE_RECOURSION) { | |
| anti_endless_execute_recoursion=0; // give @exception a chance | |
| throw Exception("parser.runtime", | |
| name, | |
| "call canceled - endless recursion detected"); | |
| } | |
| execute(ops); // execute it | |
| anti_endless_execute_recoursion--; | |
| } | } |
| ~Request() {} | |
| // IMPORTANT: don't use pool without Local_request_exception | /// compiles the file, maybe forcing it's class @a name and @a base_class. |
| Pool& pool() { return fpool; } | VStateless_class *use_file( |
| const String& file_name, | |
| bool ignore_class_path=false, bool fail_on_read_problem=true, | |
| const String *name=0, | |
| VStateless_class *base_class=0); // core.C | |
| /// compiles a @a source buffer | |
| VStateless_class *use_buf( | |
| const char *source, const char *file, | |
| VStateless_class *aclass=0, const String *name=0, | |
| VStateless_class *base_class=0); // core.C | |
| /// processes any code-junction there may be inside of @a value | |
| StringOrValue process(Value& input_value, bool intercept_string=true); // execute.C | |
| //@{ convinient helpers | |
| const String& process_to_string(Value& input_value) { | |
| return process(input_value, true/*intercept_string*/).as_string(); | |
| } | |
| Value& process_to_value(Value& input_value, bool intercept_string=true) { | |
| return process(input_value, intercept_string).as_value(); | |
| } | |
| //@} | |
| Exception& exception() { return *fexception; } | |
| Hash& classes() { return fclasses; } | #define DEFINE_DUAL(modification) \ |
| void write_##modification##_lang(StringOrValue dual) { \ | |
| if(const String *string=dual.get_string()) \ | |
| write_##modification##_lang(*string); \ | |
| else \ | |
| write_##modification##_lang(*dual.get_value()); \ | |
| } | |
| #define DEFINE_DUAL_CHECKED(modification) \ | |
| void write_##modification##_lang(StringOrValue dual, const String *origin) { \ | |
| if(const String *string=dual.get_string()) \ | |
| write_##modification##_lang(*string); \ | |
| else \ | |
| write_##modification##_lang(*dual.get_value(), origin); \ | |
| } | |
| // core request processing | /// appending, sure of clean string inside |
| void core(); | void write_no_lang(const String& astring) { |
| wcontext->write(astring, | |
| String::UL_CLEAN | flang&String::UL_OPTIMIZE_BIT); | |
| } | |
| /// appending sure value, that would be converted to clean string | |
| void write_no_lang(Value& avalue) { | |
| if(wcontext->get_in_expression()) | |
| wcontext->write(avalue); | |
| else | |
| wcontext->write(avalue, | |
| String::UL_CLEAN | flang&String::UL_OPTIMIZE_BIT); | |
| } | |
| //DEFINE_DUAL(no) | |
| protected: // core | /// appending string, passing language built into string being written |
| void write_pass_lang(const String& astring) { | |
| wcontext->write(astring, String::UL_PASS_APPENDED); | |
| } | |
| /// appending possible string, passing language built into string being written | |
| void write_pass_lang(Value& avalue) { | |
| wcontext->write(avalue, String::UL_PASS_APPENDED); | |
| } | |
| DEFINE_DUAL(pass) | |
| // classes | /// appending possible string, assigning untaint language |
| Hash fclasses; | void write_assign_lang(Value& avalue) { |
| wcontext->write(avalue, flang); | |
| } | |
| /// appending possible string, assigning untaint language | |
| void write_assign_lang(Value& avalue, const String *origin) { | |
| wcontext->write(avalue, flang, origin); | |
| } | |
| /// appending string, assigning untaint language | |
| void write_assign_lang(const String& astring) { | |
| wcontext->write(astring, flang); | |
| } | |
| DEFINE_DUAL(assign) | |
| DEFINE_DUAL_CHECKED(assign) | |
| /// returns relative to @a path path to @a file | |
| const String& relative(const char *apath, const String& relative_name); | |
| /// returns an absolute @a path to relative @a name | |
| const String& absolute(const String& relative_name); | |
| /// returns the mime type of 'user_file_name_cstr' | |
| const String& mime_type_of(const char *user_file_name_cstr); | |
| /// returns current SQL connection if any | |
| SQL_Connection *connection(const String *source) { | |
| if(!fconnection && source) | |
| throw Exception("parser.runtime", | |
| source, | |
| "outside of 'connect' operator"); | |
| // contexts | return fconnection; |
| Value *root, *self, *rcontext; | } |
| bool origins_mode() { | |
| return main_class->get_element(*origins_mode_name)!=0; // $ORIGINS mode | |
| } | |
| public: | |
| /// info from web server | |
| Info& info; | |
| /// user's post data | |
| char *post_data; size_t post_size; | |
| /// name of 'main' method | |
| const String main_method_name; | |
| /// operators are methods of this class | |
| Methoded& OP; | |
| /// $env:fields | |
| VEnv env; | |
| /// $status:fields | |
| VStatus status; | |
| /// $form:elements | |
| VForm form; | |
| /// $math:constants | |
| VMath math; | |
| /// $request:elements | |
| VRequest request; | |
| /// $response:elements | |
| VResponse response; | |
| /// $cookie:elements | |
| VCookie cookie; | |
| //@{ request processing status | |
| /// execution stack | |
| Stack stack; | |
| /// contexts | |
| Value *self, *root, *rcontext; | |
| /// contexts | |
| WContext *wcontext; | WContext *wcontext; |
| /// exception stack trace | |
| Stack exception_trace; | |
| //@} | |
| /// 'MAIN' class conglomerat | |
| VStateless_class *main_class; | |
| /// classes configured data | |
| Hash classes_conf; | |
| private: // core data | |
| /// classes | |
| Hash fclasses; | |
| /// already used files to avoid cyclic uses | |
| Hash used_files; | |
| /** endless execute(execute(... preventing counter | |
| @see ANTI_ENDLESS_EXECUTE_RECOURSION | |
| */ | |
| uint anti_endless_execute_recoursion; | |
| private: // compile.C | |
| VStateless_class& real_compile(COMPILE_PARAMS); | |
| private: // execute.C | |
| const String *execute_method(Value& aself, const Method& method, | |
| bool return_cstr); | |
| const String& execute_method(VMethodFrame& amethodFrame, const Method& method); | |
| const String *execute_virtual_method(Value& aself, const String& method_name); | |
| const String *execute_nonvirtual_method(VStateless_class& aclass, | |
| const String& method_name, | |
| bool return_cstr); | |
| Value *get_element(const String *& remember_name, bool can_call_operator); | |
| private: // defaults | |
| const uchar fdefault_lang; | |
| Value *default_content_type; | |
| private: // mime types | |
| /// $MAIN:MIME-TYPES | |
| Table *mime_types; | |
| private: // lang manipulation | |
| uchar set_lang(uchar alang) { | |
| uchar result=flang; | |
| flang=alang; | |
| return result; | |
| } | |
| void restore_lang(uchar alang) { | |
| flang=alang; | |
| } | |
| private: // lang&raw | |
| Array& load_and_compile_RUN(); | uchar flang; |
| VClass *construct_class(String& name, Array& compiled_methods); | |
| char *execute_MAIN(Value *class_RUN); | |
| private: // connection manipulation | |
| protected: | |
| SQL_Connection *set_connection(SQL_Connection *aconnection) { | |
| // all request' objects are allocated in this pool | SQL_Connection *result=fconnection; |
| Pool& fpool; | fconnection=aconnection; |
| return result; | |
| // exception replacement mechanism is protected from direct usage | |
| // Local_request_exception object enforces paired set/restore | |
| Exception *set_exception(Exception *e){ | |
| Exception *r=fexception; | |
| fexception=e; | |
| return r; | |
| } | } |
| void restore_exception(Exception *e) { | void restore_connection(SQL_Connection *aconnection) { |
| fexception=e; | fconnection=aconnection; |
| } | } |
| private: | private: |
| // current request's exception object | /// connection |
| Exception *fexception; | SQL_Connection *fconnection; |
| void output_result(const VFile& body_file, bool header_only); | |
| }; | }; |
| class Local_request_exception { | /// Auto-object used for temporary changing Request::flang. |
| Request request; | class Temp_lang { |
| Exception *saved_exception; | Request& frequest; |
| uchar saved_lang; | |
| public: | public: |
| Local_request_exception(Request& arequest, Exception& exception) : | Temp_lang(Request& arequest, uchar alang) : |
| request(arequest), | frequest(arequest), |
| saved_exception(arequest.set_exception(&exception)) {} | saved_lang(arequest.set_lang(alang)) { |
| ~Local_request_exception() { request.restore_exception(saved_exception); } | } |
| ~Temp_lang() { | |
| frequest.restore_lang(saved_lang); | |
| } | |
| }; | }; |
| /// Auto-object used for temporary changing Request::fconnection. | |
| class Temp_connection { | |
| Request& frequest; | |
| SQL_Connection *saved_connection; | |
| public: | |
| Temp_connection(Request& arequest, SQL_Connection *aconnection) : | |
| frequest(arequest), | |
| saved_connection(arequest.set_connection(aconnection)) { | |
| } | |
| ~Temp_connection() { | |
| frequest.restore_connection(saved_connection); | |
| } | |
| }; | |
| /** | |
| @b method parameters passed in this array. | |
| contains handy typecast ad junction/not junction ensurers | |
| */ | |
| class MethodParams : public Array { | |
| public: | |
| MethodParams(Pool& pool, const String& amethod_name) : Array(pool), | |
| fmethod_name(amethod_name) { | |
| } | |
| /// handy typecast. I long for templates | |
| Value& get(int index) { | |
| return *static_cast<Value *>(Array::get(index)); | |
| } | |
| /// handy is-value-a-junction ensurer | |
| Value& as_junction(int index, const char *msg) { | |
| return get_as(index, true, msg); | |
| } | |
| /// handy value-is-not-a-junction ensurer | |
| Value& as_no_junction(int index, const char *msg) { | |
| return get_as(index, false, msg); | |
| } | |
| /// handy expression auto-processing to double | |
| double as_double(int index, const char *msg, Request& r) { | |
| return get_processed(index, msg, r).as_double(); | |
| } | |
| /// handy expression auto-processing to int | |
| int as_int(int index, const char *msg, Request& r) { | |
| return get_processed(index, msg, r).as_int(); | |
| } | |
| /// handy expression auto-processing to bool | |
| bool as_bool(int index, const char *msg, Request& r) { | |
| return get_processed(index, msg, r).as_bool(); | |
| } | |
| /// handy string ensurer | |
| const String& as_string(int index, const char *msg) { | |
| return as_no_junction(index, msg).as_string(); | |
| } | |
| private: | |
| /// handy value-is/not-a-junction ensurer | |
| Value& get_as(int index, bool as_junction, const char *msg) { | |
| Value& result=get(index); | |
| if((result.get_junction()!=0) ^ as_junction) | |
| throw Exception("parser.runtime", | |
| &fmethod_name, | |
| "%s (parameter #%d)", msg, 1+index); | |
| return result; | |
| } | |
| Value& get_processed(int index, const char *msg, Request& r) { | |
| return r.process_to_value(as_junction(index, msg), 0/*no name*/); | |
| } | |
| private: | |
| const String& fmethod_name; | |
| }; | |
| #endif | #endif |