--- parser3/src/include/pa_request.h 2003/02/20 16:09:01 1.160.2.25 +++ parser3/src/include/pa_request.h 2010/05/25 03:58:17 1.201 @@ -1,34 +1,24 @@ /** @file Parser: request class decl. - Copyright (c) 2001-2003 ArtLebedev Group (http://www.artlebedev.com) + Copyright (c) 2001-2009 ArtLebedev Group (http://www.artlebedev.com) Author: Alexandr Petrosian (http://paf.design.ru) */ #ifndef PA_REQUEST_H #define PA_REQUEST_H -static const char* IDENT_REQUEST_H="$Date: 2003/02/20 16:09:01 $"; +static const char * const IDENT_REQUEST_H="$Date: 2010/05/25 03:58:17 $"; #include "pa_pool.h" -#include "pa_request_info.h" #include "pa_hash.h" #include "pa_wcontext.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_vmail.h" -#include "pa_vmath.h" -#include "pa_vrequest.h" -#include "pa_vresponse.h" -#include "pa_vcookie.h" #include "pa_request_info.h" #include "pa_request_charsets.h" #include "pa_sapi.h" +#include "pa_vconsole.h" #ifdef RESOURCES_DEBUG #include @@ -36,28 +26,19 @@ static const char* IDENT_REQUEST_H="$Dat // consts -const uint ANTI_ENDLESS_EXECUTE_RECOURSION=500; - -// defines - -#ifndef NO_STRING_ORIGIN -# define COMPILE_PARAMS \ - VStateless_class* aclass, const char* source \ - , const char* file -# define COMPILE(aclass, source, file) \ - real_compile(aclass, source, file) -#else -# define COMPILE_PARAMS \ - VStateless_class* aclass, const char* source -# define COMPILE(aclass, source, file) \ - real_compile(aclass, source) -#endif +const uint ANTI_ENDLESS_EXECUTE_RECOURSION=1000; +const size_t pseudo_file_no__process=1; // forwards class Temp_lang; class Methoded; class VMethodFrame; +class VMail; +class VForm; +class VResponse; +class VCookie; +class VStateless_class; /// Main workhorse. class Request: public PA_Object { @@ -65,17 +46,85 @@ class Request: public PA_Object { friend class Temp_connection; friend class Request_context_saver; friend class Temp_request_self; + friend class Exception_trace; + +public: + class Trace { + const String* fname; + Operation::Origin forigin; + public: + Trace(): fname(0) {} + void clear() { fname=0; } + operator bool() const { return fname!=0; } + + Trace(const String* aname, const Operation::Origin aorigin): + fname(aname), forigin(aorigin) {} + + const String* name() const { return fname; } + const Operation::Origin origin() const { return forigin; } + }; + + enum Skip { + SKIP_NOTHING, + SKIP_BREAK, + SKIP_CONTINUE + }; - /// all files and classes and other hard-to-place allocations go to this pool - Pool& fpool; +private: + Pool fpool; +public: + Pool& pool() { return fpool; } + +private: + union StackItem { + Value* fvalue; + ArrayOperation* fops; + VMethodFrame* fmethod_frame; + public: + Value& value() const { return *fvalue; } + const String& string() const { + return fvalue->as_string(); + } + ArrayOperation& ops() const { return *fops; } + VMethodFrame& method_frame() const { return *fmethod_frame; } + + /// needed to fill unused Array entries + StackItem() {} + StackItem(Value& avalue): fvalue(&avalue) {} + StackItem(ArrayOperation& aops): fops(&aops) {} + StackItem(VMethodFrame& amethod_frame): fmethod_frame(&amethod_frame) {} + }; + + class Exception_trace: public Stack { + size_t fbottom; + public: + Exception_trace(): fbottom(0) {} + + size_t bottom_index() { return fbottom; } + void set_bottom_index(size_t abottom) { fbottom=abottom; } + element_type bottom_value() { return get(bottom_index()); } + + void clear() { + fused=fbottom=0; + } + + bool is_empty() { + return fused==fbottom; + } + + const element_type extract_origin(const String*& problem_source); + }; ///@{ core data /// classes - HashStringValue fclasses; + HashString fclasses; /// already used files to avoid cyclic uses - Hash used_files; + HashString used_files; + HashString searched_along_class_path; + /// list of all used files, Operation::file_no = index to it + Array file_list; /** endless execute(execute(... preventing counter @see ANTI_ENDLESS_EXECUTE_RECOURSION @@ -84,43 +133,48 @@ class Request: public PA_Object { ///@} -public: - - class StackItem { - public: - StringPtr string() { return value->get_string(0); } - ValuePtr value; - ArrayOperationPtr ops; - void *ptr; + /// execution stack + Stack stack; - /// needed to fill unused Array entries - StackItem() {} - StackItem(ValuePtr avalue): value(avalue) {} - StackItem(ArrayOperationPtr aops): ops(aops) {} - StackItem(void *aptr): ptr(aptr) {} - }; + /// exception stack trace + Exception_trace exception_trace; +public: //@{ request processing status - /// exception stack trace - Stack exception_trace; - /// execution stack - Stack stack; /// contexts - VMethodFrame *method_frame; - Value *rcontext; - WContext *wcontext; + VMethodFrame* method_frame; + Value* rcontext; + WContext* wcontext; /// current language - uchar flang; + String::Language flang; /// current connection - SQL_Connection *fconnection; + SQL_Connection* fconnection; //@} /// interrupted flag, raised on signals [SIGPIPE] bool finterrupted; + Skip fskip; + int fin_cycle; public: + uint register_file(String::Body file_spec); - /// all files and classes and other hard-to-place allocations go to this pool - Pool& pool() { return fpool; } + struct Exception_details { + const Trace trace; + const String* problem_source; + VHash& vhash; + + Exception_details( + const Trace atrace, + const String* aproblem_source, + VHash& avhash): trace(atrace), problem_source(aproblem_source), vhash(avhash) {} + }; + Exception_details get_details(const Exception& e); + const char* get_exception_cstr(const Exception& e, Exception_details& details); + + /// @see Stack::wipe_unused + void wipe_unused_execution_stack() { + stack.wipe_unused(); + } #ifdef RESOURCES_DEBUG /// measures @@ -128,14 +182,15 @@ public: double sql_request_time; #endif - Request(Pool& apool, SAPI_Info& asapi_info, Request_info& arequest_info, - uchar adefault_lang, ///< all tainted data default untainting lang + Request(SAPI_Info& asapi_info, Request_info& arequest_info, + String::Language adefault_lang, ///< all tainted data default untainting lang bool status_allowed ///< status class allowed ); ~Request(); /// global classes - HashStringValue& classes() { return fclasses; } + HashString& classes() { return fclasses; } + Value* get_class(const String& name); /** core request processing @@ -149,118 +204,123 @@ public: /// executes ops void execute(ArrayOperation& ops); // execute.C + void op_call(VMethodFrame &frame); + void op_call_write(VMethodFrame &frame); + void op_call(VMethodFrame &frame, bool constructing); /// execute ops with anti-recoursion check - void recoursion_checked_execute(StringPtr name, ArrayOperation& ops) { + void recoursion_checked_execute(/*const String& 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, + throw Exception(PARSER_RUNTIME, + 0, //&name, "call canceled - endless recursion detected"); } execute(ops); // execute it anti_endless_execute_recoursion--; } + /// + void use_file_directly(VStateless_class& aclass, + const String& file_spec, + bool fail_on_read_problem=true, + bool fail_on_file_absence=true); + /// compiles the file, maybe forcing it's class @a name and @a base_class. - 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 + void use_file(VStateless_class& aclass, + const String& file_name, + const String* use_filespec); + /// compiles a @a source buffer - VStateless_classPtr use_buf(VStateless_class& aclass, + void use_buf(VStateless_class& aclass, const char* source, - StringPtr filespec, const char* filespec_cstr); // pa_request.C + const String* main_alias, + uint file_no, + int line_no_offset=0); /// processes any code-junction there may be inside of @a value - StringOrValue process(ValuePtr input_value, bool intercept_string=true); // execute.C + StringOrValue process(Value& input_value, bool intercept_string=true); // execute.C + void process_write(Value& input_value); // execute.C //@{ convinient helpers - StringPtr process_to_string(ValuePtr input_value) { - return process(input_value, true/*intercept_string*/).as_string(&pool()); + const String& process_to_string(Value& input_value) { + return process(input_value, true/*intercept_string*/).as_string(); } - ValuePtr process_to_value(ValuePtr input_value, bool intercept_string=true) { + Value& process_to_value(Value& input_value, bool intercept_string=true) { return process(input_value, intercept_string).as_value(); } //@} - + const String* get_method_filename(const Method* method); // execute.C + const String* get_used_filename(uint file_no); #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()) \ + if(const String* string=dual.get_string()) \ write_##modification##_lang(*string); \ else \ - write_##modification##_lang(dual.get_value(), origin); \ + write_##modification##_lang(*dual.get_value()); \ } /// appending, sure of clean string inside void write_no_lang(const String& astring) { wcontext->write(astring, - String::UL_CLEAN | flang&String::UL_OPTIMIZE_BIT); + (String::Language)(String::L_CLEAN | flang&String::L_OPTIMIZE_BIT)); } /// appending sure value, that would be converted to clean string - void write_no_lang(ValuePtr avalue) { + void write_no_lang(Value& avalue) { if(wcontext->get_in_expression()) - wcontext->write(pool(), avalue); + wcontext->write(avalue); else - wcontext->write(pool(), avalue, - String::UL_CLEAN | flang&String::UL_OPTIMIZE_BIT); + wcontext->write(avalue, + (String::Language)(String::L_CLEAN | flang&String::L_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); + wcontext->write(astring, String::L_PASS_APPENDED); } /// appending possible string, passing language built into string being written - void write_pass_lang(ValuePtr avalue) { - wcontext->write(pool(), avalue, String::UL_PASS_APPENDED); + void write_pass_lang(Value& avalue) { + wcontext->write(avalue, String::L_PASS_APPENDED); } 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); + void write_assign_lang(Value& avalue) { + wcontext->write(avalue, flang); } /// 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 - StringPtr relative(const char* apath, StringPtr relative_name); + const String& relative(const char* apath, const String& relative_name); /// returns an absolute @a path to relative @a name - StringPtr absolute(StringPtr relative_name); + const String& absolute(const String& relative_name); /// returns the mime type of 'user_file_name_cstr' - StringPtr mime_type_of(const char* user_file_name_cstr); + const String& 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, + SQL_Connection* connection(bool fail_on_error=true) { + if(fail_on_error && !fconnection) + throw Exception(PARSER_RUNTIME, + 0, "outside of 'connect' operator"); return fconnection; } - bool origins_mode(); + void set_interrupted(bool ainterrupted) { finterrupted=ainterrupted; } + bool get_interrupted() { return finterrupted; } + + void set_skip(Skip askip) { fskip=askip; } + Skip get_skip() { return fskip; } - void interrupt() { finterrupted=true; } - bool interrupted() { return finterrupted; } + void set_in_cycle(int adelta) { fin_cycle+=adelta; } + bool get_in_cycle() { return fin_cycle>0; } public: @@ -274,32 +334,26 @@ public: Request_charsets charsets; /// 'MAIN' class conglomerat & operators are methods of this class - VStateless_classPtr main_class; - /// $env:fields - //VEnv env; - /// $status:fields - //VStatus status; + VStateless_class& main_class; /// $form:elements - VFormPtr form; + VForm& form; /// $mail - VMailPtr mail; - /// $math:constants - //VMath math; - /// $request:elements - //VRequest request; + VMail& mail; /// $response:elements - VResponsePtr response; + VResponse& response; /// $cookie:elements - VCookiePtr cookie; + VCookie& cookie; + /// $console + VConsole& console; /// classes configured data - HashStringObject classes_conf; + HashString classes_conf; public: // status read methods VMethodFrame *get_method_frame() { return method_frame; } - ValuePtr get_self(); -#define GET_SELF(request, type) (*static_cast(request.get_self().get())) + Value& get_self(); +#define GET_SELF(request, type) (static_cast(request.get_self())) /* for strange reason call to this: r.get_self() refuses to compile @@ -309,43 +363,62 @@ public: // status read methods } */ + /// for @main[] + const String* execute_virtual_method(Value& aself, const String& method_name); + /// for @postprocess[body] + StringOrValue execute_method(VMethodFrame& amethodFrame, const Method& method); + //{ for @conf[filespec] and @auto[filespec] and parser://method/call + const String* execute_method(Value& aself, + const Method& method, Value* optional_param, + bool do_return_string); + struct Execute_nonvirtual_method_result { + const String* string; + Method* method; + Execute_nonvirtual_method_result(): string(0), method(0) {} + }; + Execute_nonvirtual_method_result execute_nonvirtual_method(VStateless_class& aclass, + const String& method_name, + VString* optional_param, + bool do_return_string); + //} + +#ifdef XML +public: // charset helpers + + /// @see Charset::transcode + xmlChar* transcode(const String& s); + /// @see Charset::transcode + xmlChar* transcode(const String::Body s); + /// @see Charset::transcode + const String& transcode(const xmlChar* s); + +#endif private: /// already executed some @conf method bool configure_admin_done; - void configure_admin(VStateless_class& conf_class, StringPtr source); + void configure_admin(VStateless_class& conf_class); + + void configure(); private: // compile.C - VStateless_class& real_compile(COMPILE_PARAMS); + ArrayClass& compile(VStateless_class* aclass, + const char* source, const String* main_alias, + uint file_no, + int line_no_offset); private: // execute.C - /// 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); - struct Execute_nonvirtual_method_result { - StringPtr string; - MethodPtr method; - }; - Execute_nonvirtual_method_result execute_nonvirtual_method(VStateless_class& aclass, - StringPtr method_name, VStringPtr optional_param, - bool do_return_string); - //} - /// for @main[] - StringPtr execute_virtual_method(ValuePtr aself, StringPtr method_name); - - ValuePtr get_element(StringPtr& remember_name, bool can_call_operator); + void put_element(Value& ncontext, const String& name, Value* value); + Value& get_element(Value& ncontext, const String& name); private: // defaults - const uchar fdefault_lang; + const String::Language fdefault_lang; private: // mime types @@ -354,29 +427,29 @@ private: // mime types private: // lang manipulation - uchar set_lang(uchar alang) { - uchar result=flang; + String::Language set_lang(String::Language alang) { + String::Language result=flang; flang=alang; return result; } - void restore_lang(uchar alang) { + void restore_lang(String::Language alang) { flang=alang; } private: // connection manipulation - SQL_Connection *set_connection(SQL_Connection *aconnection) { - SQL_Connection *result=fconnection; + SQL_Connection* set_connection(SQL_Connection* aconnection) { + SQL_Connection* result=fconnection; fconnection=aconnection; return result; } - void restore_connection(SQL_Connection *aconnection) { + void restore_connection(SQL_Connection* aconnection) { fconnection=aconnection; } private: - void output_result(VFilePtr body_file, bool header_only, bool as_attachment); + void output_result(VFile* body_file, bool header_only, bool as_attachment); }; /// Auto-object used to save request context across ^try body @@ -384,31 +457,37 @@ class Request_context_saver { Request& fr; /// exception stack trace - int exception_trace; + size_t exception_trace_top; + size_t exception_trace_bottom; /// execution stack - int stack; + size_t stack; + uint anti_endless_execute_recoursion; /// contexts - VMethodFrame *method_frame; - Value *rcontext; - WContext *wcontext; + VMethodFrame* method_frame; + Value* rcontext; + WContext* wcontext; /// current language - uchar flang; + String::Language flang; /// current connection - SQL_Connection *fconnection; + SQL_Connection* fconnection; public: Request_context_saver(Request& ar) : - exception_trace(ar.exception_trace.top_index()), + fr(ar), + exception_trace_top(ar.exception_trace.top_index()), + exception_trace_bottom(ar.exception_trace.bottom_index()), stack(ar.stack.top_index()), + anti_endless_execute_recoursion(ar.anti_endless_execute_recoursion), method_frame(ar.method_frame), rcontext(ar.rcontext), wcontext(ar.wcontext), flang(ar.flang), - fconnection(ar.fconnection), - fr(ar) {} + fconnection(ar.fconnection) {} void restore() { - fr.exception_trace.top_index(exception_trace); - fr.stack.top_index(stack); + fr.exception_trace.set_top_index(exception_trace_top); + fr.exception_trace.set_bottom_index(exception_trace_bottom); + fr.stack.set_top_index(stack); + fr.anti_endless_execute_recoursion=anti_endless_execute_recoursion; fr.method_frame=method_frame, fr.rcontext=rcontext; fr.wcontext=wcontext; fr.flang=flang; fr.fconnection=fconnection; @@ -418,9 +497,9 @@ public: /// Auto-object used for temporary changing Request::flang. class Temp_lang { Request& frequest; - String_UL saved_lang; + String::Language saved_lang; public: - Temp_lang(Request& arequest, String_UL alang) : + Temp_lang(Request& arequest, String::Language alang) : frequest(arequest), saved_lang(arequest.set_lang(alang)) { } @@ -432,9 +511,9 @@ public: /// Auto-object used for temporary changing Request::fconnection. class Temp_connection { Request& frequest; - SQL_Connection *saved_connection; + SQL_Connection* saved_connection; public: - Temp_connection(Request& arequest, SQL_Connection *aconnection) : + Temp_connection(Request& arequest, SQL_Connection* aconnection) : frequest(arequest), saved_connection(arequest.set_connection(aconnection)) { } @@ -443,21 +522,33 @@ public: } }; +/// Auto-object used for break out of cycle check +class InCycle { + Request& frequest; +public: + InCycle(Request& arequest) : frequest(arequest) { + frequest.set_in_cycle(1); + } + ~InCycle() { + frequest.set_in_cycle(-1); + } +}; // defines for externs -#define CONTENT_DISPOSITION_NAME "content-disposition" -#define CONTENT_DISPOSITION_VALUE "attachment" -#define CONTENT_DISPOSITION_FILENAME_NAME "filename" +#define EXCEPTION_HANDLED_PART_NAME "handled" + // externs -extern StringPtr main_method_name; -extern StringPtr auto_method_name; -extern StringPtr body_name; -extern StringPtr content_disposition_name; -extern StringPtr content_disposition_value; -extern StringPtr content_disposition_filename_name; +extern const String main_method_name; +extern const String auto_method_name; +extern const String body_name; + +extern const String exception_type_part_name; +extern const String exception_source_part_name; +extern const String exception_comment_part_name; +extern const String exception_handled_part_name; // defines for statics