--- parser3/src/include/pa_request.h 2001/09/21 15:35:45 1.96 +++ parser3/src/include/pa_request.h 2003/02/04 15:59:04 1.160.2.18 @@ -1,18 +1,17 @@ /** @file Parser: request class decl. - Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com) - - Author: Alexander Petrosyan (http://design.ru/paf) - - $Id: pa_request.h,v 1.96 2001/09/21 15:35:45 parser Exp $ + Copyright (c) 2001-2003 ArtLebedev Group (http://www.artlebedev.com) + Author: Alexandr Petrosian (http://paf.design.ru) */ #ifndef PA_REQUEST_H #define PA_REQUEST_H -#include "pa_config_includes.h" +static const char* IDENT_REQUEST_H="$Date: 2003/02/04 15:59:04 $"; + #include "pa_pool.h" +#include "pa_request_info.h" #include "pa_hash.h" #include "pa_wcontext.h" #include "pa_value.h" @@ -20,60 +19,124 @@ #include "pa_vclass.h" #include "pa_vobject.h" #include "pa_venv.h" +#include "pa_vstatus.h" #include "pa_vform.h" +#include "pa_vmail.h" #include "pa_vmath.h" #include "pa_vrequest.h" #include "pa_vresponse.h" #include "pa_vcookie.h" -#include "pa_sql_driver_manager.h" +#include "pa_request_info.h" +#include "pa_request_charsets.h" +#include "pa_sapi.h" + +#ifdef RESOURCES_DEBUG +#include +#endif + +// consts + +const uint ANTI_ENDLESS_EXECUTE_RECOURSION=500; + +// defines #ifndef NO_STRING_ORIGIN # 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) + VStateless_class* aclass, const char* source \ + , const char* file +# define COMPILE(aclass, source, file) \ + real_compile(aclass, source, 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) + VStateless_class* aclass, const char* source +# define COMPILE(aclass, source, file) \ + real_compile(aclass, source) #endif +// forwards + class Temp_lang; class Methoded; +class VMethodFrame; /// Main workhorse. -class Request : public Pooled { - friend Temp_lang; +class Request: public PA_Object { + friend class Temp_lang; + friend class Temp_connection; + friend class Request_context_saver; + friend class Temp_request_self; + + /// all files and classes and other hard-to-place allocations go to this pool + Pool fpool; + + ///@{ core data + + /// classes + HashStringValue 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; + + ///@} + public: - /// some information from web server - class Info { + class StackItem { 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; + StringPtr string; + ValuePtr value; + ArrayOperationPtr ops; + void *unknown; + + /// needed to fill unused Array entries + StackItem() {} + StackItem(StringPtr astring): string(astring) {} + StackItem(ValuePtr avalue): value(avalue) {} + StackItem(ArrayOperationPtr aops): ops(aops) {} + StackItem(void *aunknown): unknown(aunknown) {} }; - - Request(Pool& apool, - Info& ainfo, - String::Untaint_lang adefault_lang ///< all tainted data default untainting lang + + //@{ request processing status + /// exception stack trace + Stack exception_trace; + /// execution stack + Stack stack; + /// contexts + VMethodFrame *method_frame; + Value *rcontext; + WContext *wcontext; + /// current language + uchar flang; + /// current connection + SQL_Connection *fconnection; + //@} + /// interrupted flag, raised on signals [SIGPIPE] + bool finterrupted; + +public: + + /// all files and classes and other hard-to-place allocations go to this pool + Pool& pool() { return fpool; } + +#ifdef RESOURCES_DEBUG + /// measures + double sql_connect_time; + double sql_request_time; +#endif + + Request(SAPI_Info& asapi_info, Request_info& arequest_info, + uchar adefault_lang, ///< all tainted data default untainting lang + bool status_allowed ///< status class allowed ); - ~Request() {} + ~Request(); /// global classes - Hash& classes() { return fclasses; } + HashStringValue& classes() { return fclasses; } /** core request processing @@ -81,120 +144,180 @@ public: 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 + const char* config_filespec, ///< system config filespec + bool config_fail_on_read_problem, ///< fail if system config file not found bool header_only); /// executes ops - void execute(const Array& ops); // execute.C + void execute(ArrayOperation& ops); // execute.C + /// execute ops with anti-recoursion check + void recoursion_checked_execute(StringPtr name, ArrayOperation& 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--; + } /// compiles the file, maybe forcing it's class @a name and @a base_class. - 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 + VStateless_classPtr use_file(VStateless_class& aclass, + StringPtr file_name, + bool ignore_class_path=false, + bool fail_on_read_problem=true, bool fail_on_file_absence=true); // pa_request.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 + VStateless_classPtr use_buf(VStateless_class& aclass, + const char* source, + StringPtr filespec, const char* filespec_cstr); // pa_request.C + /// processes any code-junction there may be inside of @a value - Value& process( - Value& value, - const String *name=0, - bool intercept_string=true); // execute.C + StringOrValue process(ValuePtr input_value, bool intercept_string=true); // execute.C + //@{ convinient helpers + StringPtr process_to_string(ValuePtr input_value) { + return process(input_value, true/*intercept_string*/).as_string(&pool()); + } + ValuePtr process_to_value(ValuePtr input_value, bool intercept_string=true) { + return process(input_value, intercept_string).as_value(); + } + //@} + + +#define DEFINE_DUAL(modification) \ + void write_##modification##_lang(StringOrValue dual) { \ + if(StringPtr 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, StringPtr origin) { \ + if(StringPtr string=dual.get_string()) \ + write_##modification##_lang(*string); \ + else \ + write_##modification##_lang(dual.get_value(), origin); \ + } /// appending, sure of clean string inside void write_no_lang(const String& astring) { - wcontext->write(astring, String::UL_CLEAN); + 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(ValuePtr avalue) { + if(wcontext->get_in_expression()) + wcontext->write(pool(), avalue); + else + wcontext->write(pool(), avalue, + 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) { - wcontext->write(avalue, flang); - } /// appending possible string, passing language built into string being written - void write_pass_lang(Value& avalue) { - wcontext->write(avalue, String::UL_PASS_APPENDED); + void write_pass_lang(ValuePtr avalue) { + wcontext->write(pool(), avalue, String::UL_PASS_APPENDED); } - /// appending sure value, that would be converted to clean string - void write_no_lang(Value& avalue) { - wcontext->write(avalue, String::UL_CLEAN); + DEFINE_DUAL(pass) + + /// appending possible string, assigning untaint language + void write_assign_lang(ValuePtr avalue) { + wcontext->write(pool(), avalue, flang); + } + /// appending possible string, assigning untaint language + void write_assign_lang(ValuePtr avalue, StringPtr origin) { + wcontext->write(pool(), avalue, flang, origin); } - /// appending sure value, not VString - void write_expr_result(Value& avalue) { - wcontext->write(avalue); + /// 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); + StringPtr relative(const char* apath, StringPtr relative_name); /// returns an absolute @a path to relative @a name - const String& absolute(const String& relative_name); + StringPtr absolute(StringPtr relative_name); /// returns the mime type of 'user_file_name_cstr' - const String& mime_type_of(const char *user_file_name_cstr); + StringPtr mime_type_of(const char* user_file_name_cstr); + + /// returns current SQL connection if any + SQL_Connection *connection(StringPtr source) { + if(!fconnection && source) + throw Exception("parser.runtime", + source, + "outside of 'connect' operator"); + + return fconnection; + } + + bool origins_mode(); + + void interrupt() { finterrupted=true; } + bool interrupted() { return finterrupted; } public: /// info from web server - Info& info; - /// user's post data - char *post_data; size_t post_size; + Request_info& request_info; + + /// info about ServerAPI + SAPI_Info& sapi_info; - /// operators are methods of this class - Methoded& OP; + /// source, client, mail charsets + Request_charsets charsets; + + /// 'MAIN' class conglomerat & operators are methods of this class + VStateless_classPtr main_class; /// $env:fields - VEnv env; + //VEnv env; + /// $status:fields + //VStatus status; /// $form:elements - VForm form; + VFormPtr form; + /// $mail + VMailPtr mail; /// $math:constants - VMath math; + //VMath math; /// $request:elements - VRequest request; + //VRequest request; /// $response:elements - VResponse response; + VResponsePtr response; /// $cookie:elements - VCookie cookie; + VCookiePtr cookie; - /// contexts - Value *self, *root, *rcontext; - /// contexts - WContext *wcontext; + /// classes configured data + HashStringValue classes_conf; - /// 'MAIN' class conglomerat - VStateless_class *main_class; +public: // status read methods - /// connection - SQL_Connection *connection; - /// PCRE character tables - unsigned char *pcre_tables; + VMethodFrame *get_method_frame() { return method_frame; } + ValuePtr get_self(); +#define GET_SELF(request, type) (*static_cast(request.get_self().get())) + /* for strange reason call to this: + r.get_self() + refuses to compile - /// classes configured data - Hash classes_conf; + template T& get_self() { + return *static_cast(get_self().get()); + } + */ -private: // core data - /// classes - Hash fclasses; +private: - /// already used files to avoid cyclic uses - Hash used_files; + /// already executed some @conf method + bool configure_admin_done; - /// execution stack - Stack stack; - - /** endless execute(execute(... preventing counter - @see ANTI_ENDLESS_EXECUTE_RECOURSION - */ - uint anti_endless_execute_recoursion; + void configure_admin(VStateless_class& conf_class, StringPtr source); private: // compile.C @@ -202,22 +325,25 @@ private: // compile.C private: // execute.C - const String *execute_method(Value& aself, - const Method& method, bool return_cstr=true); - const String *execute_virtual_method(Value& aself, - const String& method_name, bool return_cstr=true); - const String *execute_nonvirtual_method(VStateless_class& aclass, - const String& method_name, bool return_cstr=true); + /// for @postprocess[body] + StringPtr execute_method(VMethodFrame& amethodFrame, const Method& method); + //{ for @conf[filespec] and @auto[filespec] + StringPtr execute_method(ValuePtr aself, + const Method& method, VStringPtr optional_param, + bool do_return_string); + StringPtr execute_nonvirtual_method(VStateless_class& aclass, + StringPtr method_name, VStringPtr optional_param, + bool do_return_string, + const Method **return_method=0); + //} + /// for @main[] + StringPtr execute_virtual_method(ValuePtr aself, StringPtr method_name); - Value *get_element(); - -private: // lang&raw - - String::Untaint_lang flang; + ValuePtr get_element(StringPtr& remember_name, bool can_call_operator); private: // defaults - const String::Untaint_lang fdefault_lang; + const uchar fdefault_lang; Value *default_content_type; private: // mime types @@ -227,26 +353,73 @@ private: // mime types private: // lang manipulation - String::Untaint_lang set_lang(String::Untaint_lang alang) { - String::Untaint_lang result=flang; + uchar set_lang(uchar alang) { + uchar result=flang; flang=alang; return result; } - void restore_lang(String::Untaint_lang alang) { + void restore_lang(uchar alang) { flang=alang; } +private: // connection manipulation + + SQL_Connection *set_connection(SQL_Connection *aconnection) { + SQL_Connection *result=fconnection; + fconnection=aconnection; + return result; + } + void restore_connection(SQL_Connection *aconnection) { + fconnection=aconnection; + } + private: - void output_result(const VFile& body_file, bool header_only); + void output_result(VFilePtr body_file, bool header_only, bool as_attachment); +}; + +/// Auto-object used to save request context across ^try body +class Request_context_saver { + Request& fr; + + /// exception stack trace + int exception_trace; + /// execution stack + int stack; + /// contexts + VMethodFrame *method_frame; + Value *rcontext; + WContext *wcontext; + /// current language + uchar flang; + /// current connection + SQL_Connection *fconnection; + +public: + Request_context_saver(Request& ar) : + exception_trace(ar.exception_trace.top_index()), + stack(ar.stack.top_index()), + method_frame(ar.method_frame), + rcontext(ar.rcontext), + wcontext(ar.wcontext), + flang(ar.flang), + fconnection(ar.fconnection), + fr(ar) {} + void restore() { + fr.exception_trace.top_index(exception_trace); + fr.stack.top_index(stack); + fr.method_frame=method_frame, fr.rcontext=rcontext; fr.wcontext=wcontext; + fr.flang=flang; + fr.fconnection=fconnection; + } }; /// Auto-object used for temporary changing Request::flang. class Temp_lang { Request& frequest; - String::Untaint_lang saved_lang; + String_UL saved_lang; public: - Temp_lang(Request& arequest, String::Untaint_lang alang) : + Temp_lang(Request& arequest, String_UL alang) : frequest(arequest), saved_lang(arequest.set_lang(alang)) { } @@ -255,64 +428,33 @@ public: } }; -/** - @b method parameters passed in this array. - contains handy typecast ad junction/not junction ensurers - -*/ -class MethodParams : public Array { +/// Auto-object used for temporary changing Request::fconnection. +class Temp_connection { + Request& frequest; + SQL_Connection *saved_connection; 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(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, Request& r) { - return get_processed(index, r).as_double(); - } - /// handy expression auto-processing to int - int as_int(int index, Request& r) { - return get_processed(index, r).as_int(); - } - /// 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(0, 0, - &fmethod_name, - "%s (parameter #%d)", msg, 1+index); - return result; + Temp_connection(Request& arequest, SQL_Connection *aconnection) : + frequest(arequest), + saved_connection(arequest.set_connection(aconnection)) { } - - Value& get_processed(int index, Request& r) { - return r.process(get(index), - 0/*no name*/, - false/*don't intercept string*/); + ~Temp_connection() { + frequest.restore_connection(saved_connection); } +}; -private: - const String& fmethod_name; +// defines for externs -}; +#define CONTENT_DISPOSITION_NAME "content-disposition" +#define CONTENT_DISPOSITION_VALUE "attachment" +#define CONTENT_DISPOSITION_FILENAME_NAME "filename" + +// externs + +extern StringPtr main_method_name; +extern StringPtr body_name; +extern StringPtr content_disposition_name; +extern StringPtr content_disposition_value; +extern StringPtr content_disposition_filename_name; #endif