|
|
| version 1.43, 2001/03/12 17:16:49 | version 1.128, 2002/04/15 06:45:56 |
|---|---|
| Line 1 | Line 1 |
| /* | /** @file |
| Parser | Parser: request class decl. |
| Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com) | |
| Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf) | Copyright (c) 2001, 2002 ArtLebedev Group (http://www.artlebedev.com) |
| Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru) | |
| $Id$ | $Id$ |
| */ | */ |
| Line 10 | Line 11 |
| #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_wcontext.h" | #include "pa_wcontext.h" |
| #include "pa_value.h" | #include "pa_value.h" |
| #include "pa_stack.h" | #include "pa_stack.h" |
| #include "pa_vclass.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 | |
| const uint ANTI_ENDLESS_EXECUTE_RECOURSION=500; | |
| #define MAIN_METHOD_NAME "main" | // defines |
| #define AUTO_METHOD_NAME "auto" | |
| #define MAIN_CLASS_NAME "MAIN" | |
| #define ROOT_CLASS_NAME "ROOT" | |
| #define ENV_CLASS_NAME "ENV" | |
| #define TABLE_CLASS_NAME "table" | |
| #ifndef NO_STRING_ORIGIN | #ifndef NO_STRING_ORIGIN |
| # define COMPILE_PARAMS \ | # define COMPILE_PARAMS \ |
| const char *source, \ | const char *source, \ |
| VClass *aclass, const String *name, \ | VStateless_class *aclass, const String *name, \ |
| VClass *base_class, \ | VStateless_class *base_class, \ |
| const char *file | const char *file |
| # define COMPILE(source, aclass, name, base_class, file) \ | # define COMPILE(source, aclass, name, base_class, file) \ |
| real_compile(source, aclass, name, base_class, file) | real_compile(source, aclass, name, base_class, file) |
| #else | #else |
| # define COMPILE_PARAMS \ | # define COMPILE_PARAMS \ |
| const char *source, \ | const char *source, \ |
| VClass *aclass, const String *name, \ | VStateless_class *aclass, const String *name, \ |
| VClass *base_class | VStateless_class *base_class |
| # define COMPILE(source, aclass, name, base_class, file) \ | # define COMPILE(source, aclass, name, base_class, file) \ |
| real_compile(source, aclass, name, base_class) | real_compile(source, aclass, name, base_class) |
| #endif | #endif |
| class Temp_lang; | class Temp_lang; |
| class Methoded; | |
| class VMethodFrame; | |
| /// Main workhorse. | |
| class Request : public Pooled { | class Request : public Pooled { |
| friend Temp_lang; | 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; | |
| const char *user_agent; | |
| }; | |
| Request(Pool& apool); | Request(Pool& apool, |
| ~Request() {} | Info& ainfo, |
| uchar adefault_lang, ///< all tainted data default untainting lang | |
| bool status_allowed ///< status class allowed | |
| ); | |
| ~Request(); | |
| // global classes | /// global classes |
| Hash& classes() { return fclasses; } | Hash& classes() { return fclasses; } |
| Array& classes_array() { return fclasses_array; } | |
| // core request processing | /** |
| void core(); | core request processing |
| void execute(const Array& ops); | 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--; | |
| } | |
| VClass *use_file( | /// compiles the file, maybe forcing it's class @a name and @a base_class. |
| const char *file, bool fail_on_read_problem=true, | VStateless_class *use_file( |
| VClass *aclass=0, const String *name=0, | const String& file_name, |
| VClass *base_class=0); // core.C | bool ignore_class_path=false, bool fail_on_read_problem=true, |
| VClass *use_buf( | 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, | const char *source, const char *file, |
| VClass *aclass=0, const String *name=0, | VStateless_class *aclass=0, const String *name=0, |
| VClass *base_class=0); // core.C | VStateless_class *base_class=0); // core.C |
| Value& process( | |
| Value& value, | |
| const String *name=0, | |
| bool intercept_string=true); // execute.C | |
| void write(const String& astring) { | //@{ convinient inline helpers @see Request::process |
| wcontext->write(astring, String::Untaint_lang::NO); // write(const) = clean | void process_to_nothing(Value& input_value, |
| void (*postexecute)(void *info)=0, void *postexecute_info=0) { | |
| const String *junk_string; | |
| process_internal(input_value, 0/*result_name*/, true/*intercept_string*/, &junk_string, 0, | |
| postexecute, postexecute_info); | |
| } | } |
| const String& process_to_string(Value& input_value, | |
| const String *result_name=0) { | |
| const String *result; | |
| process_internal(input_value, result_name, true/*intercept_string*/, &result, 0); | |
| return *result; | |
| } | |
| Value& process_to_value(Value& input_value, | |
| const String *result_name=0, | |
| bool intercept_string=true) { | |
| Value *result; | |
| process_internal(input_value, result_name, intercept_string, 0, &result); | |
| return *result; | |
| } | |
| //@} | |
| /// appending, sure of clean string inside | |
| void write_no_lang(const String& astring) { | |
| wcontext->write(astring, | |
| String::UL_CLEAN | flang&String::UL_OPTIMIZE_BIT); | |
| } | |
| /// 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, assigning untaint language | |
| void write_assign_lang(Value& avalue) { | void write_assign_lang(Value& avalue) { |
| // appending possible string, assigning untaint language | |
| wcontext->write(avalue, flang); | wcontext->write(avalue, flang); |
| } | } |
| /// appending string, assigning untaint language | |
| void write_assign_lang(const String& astring) { | |
| wcontext->write(astring, flang); | |
| } | |
| /// appending possible string, passing language built into string being written | |
| void write_pass_lang(Value& avalue) { | void write_pass_lang(Value& avalue) { |
| // appending possible string, passing language built into string being written | wcontext->write(avalue, String::UL_PASS_APPENDED); |
| wcontext->write(avalue, String::Untaint_lang::PASS_APPENDED); | } |
| /// 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); | |
| } | } |
| /// appending sure value, not VString | |
| void write_expr_result(Value& avalue) { | |
| wcontext->write(avalue); | |
| } | |
| /// returns relative to @a path path to @a file | |
| const String& relative(const char *apath, const String& relative_name); | |
| void fail_if_junction_(bool is, Value& value, const String& method_name, char *msg); | /// returns an absolute @a path to relative @a name |
| const String& absolute(const String& relative_name); | |
| char *relative(const char *path, const char *file); | /// returns the mime type of 'user_file_name_cstr' |
| char *absolute(const char *name); | 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"); | |
| return fconnection; | |
| } | |
| public: | public: |
| // default base | /// info from web server |
| VClass root_class; | Info& info; |
| // $ENV:fields here | /// user's post data |
| VClass env_class; | char *post_data; size_t post_size; |
| /// 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; | |
| // contexts | //@{ request processing status |
| /// execution stack | |
| Stack stack; | |
| /// contexts | |
| Value *self, *root, *rcontext; | 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 | private: // core data |
| // classes | /// classes |
| Hash fclasses; | Hash fclasses; |
| Array fclasses_array; | |
| // execution stack | /// already used files to avoid cyclic uses |
| Stack stack; | Hash used_files; |
| private: // core.C | /** endless execute(execute(... preventing counter |
| @see ANTI_ENDLESS_EXECUTE_RECOURSION | |
| char *execute_MAIN(); | */ |
| uint anti_endless_execute_recoursion; | |
| private: // compile.C | private: // compile.C |
| VClass& real_compile(COMPILE_PARAMS); | VStateless_class& real_compile(COMPILE_PARAMS); |
| private: // execute.C | private: // execute.C |
| char *execute_static_method(VClass& vclass, String& method_name, bool return_cstr); | 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(); | Value *get_element(bool can_call_operator); |
| private: // lang&raw | private: // defaults |
| String::Untaint_lang flang; | const uchar fdefault_lang; |
| Value *default_content_type; | |
| private: // mime types | |
| /// $MAIN:MIME-TYPES | |
| Table *mime_types; | |
| private: // lang manipulation | private: // lang manipulation |
| String::Untaint_lang set_lang(String::Untaint_lang alang) { | uchar set_lang(uchar alang) { |
| String::Untaint_lang result=flang; | uchar result=flang; |
| flang=alang; | flang=alang; |
| return result; | return result; |
| } | } |
| void restore_lang(String::Untaint_lang alang) { | void restore_lang(uchar alang) { |
| flang=alang; | flang=alang; |
| } | } |
| private: // web | private: // lang&raw |
| uchar flang; | |
| const char *document_root; | private: // connection manipulation |
| const char *page_filespec; | |
| SQL_Connection *set_connection(SQL_Connection *aconnection) { | |
| SQL_Connection *result=fconnection; | |
| fconnection=aconnection; | |
| return result; | |
| } | |
| void restore_connection(SQL_Connection *aconnection) { | |
| fconnection=aconnection; | |
| } | |
| private: | |
| /// connection | |
| SQL_Connection *fconnection; | |
| private: | |
| /// processes any code-junction there may be inside of @a value | |
| void process_internal( | |
| Value& input_value, const String *result_name, | |
| bool intercept_string, | |
| const String **string_result, Value **value_result, | |
| void (*postexecute)(void *info)=0, void *postexecute_info=0); // execute.C | |
| void output_result(const VFile& body_file, bool header_only); | |
| }; | }; |
| /// Auto-object used for temporary changing Request::flang. | |
| class Temp_lang { | class Temp_lang { |
| Request& frequest; | Request& frequest; |
| String::Untaint_lang saved_lang; | uchar saved_lang; |
| public: | public: |
| Temp_lang(Request& arequest, String::Untaint_lang alang) : | Temp_lang(Request& arequest, uchar alang) : |
| frequest(arequest), | frequest(arequest), |
| saved_lang(arequest.set_lang(alang)) { | saved_lang(arequest.set_lang(alang)) { |
| } | } |
| Line 160 public: | Line 346 public: |
| } | } |
| }; | }; |
| /// 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 |