--- parser3/src/include/pa_request.h 2002/09/21 12:36:10 1.151 +++ parser3/src/include/pa_request.h 2016/11/29 14:32:32 1.243 @@ -1,334 +1,392 @@ /** @file Parser: request class decl. - Copyright (c) 2001, 2002 ArtLebedev Group (http://www.artlebedev.com) + Copyright (c) 2001-2015 Art. Lebedev Studio (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: 2002/09/21 12:36:10 $"; +#define IDENT_PA_REQUEST_H "$Id: pa_request.h,v 1.243 2016/11/29 14:32:32 moko Exp $" #include "pa_pool.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_sql_driver_manager.h" - -#ifdef RESOURCES_DEBUG -#include -#endif +#include "pa_request_info.h" +#include "pa_request_charsets.h" +#include "pa_sapi.h" // consts -#define MAIN_METHOD_NAME "main" -const uint ANTI_ENDLESS_EXECUTE_RECOURSION=500; +const size_t pseudo_file_no__process=1; -// 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) -#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 +// forwards class Temp_lang; class Methoded; class VMethodFrame; +class VMail; +class VForm; +class VResponse; +class VCookie; +class VStateless_class; +class VConsole; + +extern int pa_execute_recoursion_limit; +extern int pa_loop_limit; /// Main workhorse. -class Request : public Pooled { +class Request: public PA_Object { friend class Temp_lang; friend class Temp_connection; + friend class Temp_request_self; + friend class Temp_value_element; friend class Request_context_saver; + friend class Exception_trace; + +public: + class Trace { + const String* fname; + Operation::Origin forigin; + public: + Trace(): fname(0) {} + void clear() { 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 + }; + +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; + } + }; + + ///@{ core data + + /// classes + HashString fclasses; + + /// already used files to avoid cyclic uses + 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 + int anti_endless_execute_recoursion; + + ///@} + + /// execution stack + Stack stack; + + /// exception stack trace + Exception_trace exception_trace; public: + bool allow_class_replace; + + //@{ request processing status + /// contexts + VMethodFrame* method_frame; + Value* rcontext; + WContext* wcontext; + /// current language + String::Language flang; + /// current connection + SQL_Connection* fconnection; + //@} + /// interrupted flag, raised on signals [SIGPIPE] + bool finterrupted; + Skip fskip; + int fin_cycle; + +public: + uint register_file(String::Body file_spec); + + struct Exception_details { + const Operation::Origin origin; + const String* problem_source; + VHash& vhash; + Exception_details(const Operation::Origin aorigin, const String* aproblem_source, VHash& avhash): origin(aorigin), 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 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; - bool mail_received; - }; - - Request(Pool& apool, - Info& ainfo, - uchar adefault_lang, ///< all tainted data default untainting lang - bool status_allowed ///< status class allowed + Request(SAPI_Info& asapi_info, Request_info& arequest_info, + String::Language adefault_lang ///< all tainted data default untainting lang ); ~Request(); /// global classes - Hash& classes() { return fclasses; } + HashString& classes() { return fclasses; } + VStateless_class* get_class(const String& name); + void put_class(VStateless_class *aclass){ classes().put(aclass->type(), aclass); } /** core request processing - BEWARE: may throw exception to you: catch it! */ - void core( - const char *config_filespec, ///< system config filespec - bool config_fail_on_read_problem, ///< fail if system config file not found - bool header_only); + void core(const char* config_filespec, bool config_fail_on_read_problem, bool header_only); /// executes ops - void execute(const Array& ops); // execute.C + void execute(ArrayOperation& ops); // execute.C + + template void call(Frame& frame){ + VMethodFrame *saved_method_frame=method_frame; + Value* saved_rcontext=rcontext; + WContext *saved_wcontext=wcontext; + + rcontext=wcontext=method_frame=&frame; + + frame.call(*this); + + wcontext=saved_wcontext; + rcontext=saved_rcontext; + method_frame=saved_method_frame; + } + + template void call_write(Frame& frame){ + VMethodFrame *saved_method_frame=method_frame; + Value* saved_rcontext=rcontext; + + rcontext=method_frame=&frame; + + frame.call(*this); + + rcontext=saved_rcontext; + method_frame=saved_method_frame; + } + + Value& construct(VStateless_class &class_value, const Method &method); + /// 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) { + void recoursion_checked_execute(ArrayOperation& ops) { + if(++anti_endless_execute_recoursion==pa_execute_recoursion_limit) { anti_endless_execute_recoursion=0; // give @exception a chance - throw Exception("parser.runtime", - name, - "call canceled - endless recursion detected"); + throw Exception(PARSER_RUNTIME, 0, "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_class *use_file( - const String& file_name, - bool ignore_class_path=false, - bool fail_on_read_problem=true, bool fail_on_file_absence=true, - const String *name=0, - VStateless_class *base_class=0); // core.C + void use_file(VStateless_class& aclass, const String& file_name, const String* use_filespec); + + /// for @USE only, calls ^use (which may be user-defined) + void use_file(const String& file_name, const String* use_filespec, Operation::Origin origin); + /// compiles a @a source buffer - VStateless_class *use_buf( - const char *source, const String& filespec, const char *filespec_cstr, - VStateless_class *aclass=0, const String *name=0, - VStateless_class *base_class=0); // core.C + void use_buf(VStateless_class& aclass, const char* source, 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(Value& input_value, bool intercept_string=true); // execute.C + Value& process_getter(Junction& junction); // execute.C + Value& process(Value& input_value); // execute.C + void process_write(Value& input_value); // 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(); + return process(input_value).as_string(); } //@} - + const String* get_method_filespec(const Method* method); // execute.C + const String* get_used_filespec(uint file_no); + + /// appending string with it's languages + inline void write(const String& astring) { + wcontext->write(astring); + } -#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); \ - } - - /// 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 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) - - /// 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) - - /// appending possible string, assigning untaint language - 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); + /// in [] and {} appending string if get_string is not null, else appending value + /// in () appending string if is_string, else appending value + inline void write(Value& avalue) { + wcontext->write_as_string(avalue); + } + + /// allways appending value + inline void write_value(Value& avalue) { + wcontext->write(avalue); } - 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); + 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' + const String& mime_type_of(const String* file_name); + /// returns the mime type of 'user_file_name_cstr' - const String& 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(const String *source) { - if(!fconnection && source) - throw Exception("parser.runtime", - source, - "outside of 'connect' operator"); - - return fconnection; + 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() { - return main_class->get_element(*origins_mode_name, main_class, false)!=0; // $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 set_in_cycle(int adelta) { fin_cycle+=adelta; } + bool get_in_cycle() { return fin_cycle>0; } public: /// info from web server - Info& info; - /// user's post data - const char *post_data; size_t post_size; + Request_info& request_info; - /// 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; + /// info about ServerAPI + SAPI_Info& sapi_info; + + /// source, client, mail charsets + Request_charsets charsets; + + /// 'MAIN' class conglomerat & operators are methods of this class + VStateless_class& main_class; /// $form:elements - VForm form; + VForm& form; /// $mail - VMail mail; - /// $math:constants - VMath math; - /// $request:elements - VRequest request; + VMail& mail; /// $response:elements - VResponse response; + VResponse& response; /// $cookie:elements - VCookie cookie; - - /// 'MAIN' class conglomerat - VStateless_class *main_class; + VCookie& cookie; + /// $console + VConsole& console; /// classes configured data - Hash classes_conf; - -private: - - //@{ request processing status - /// exception stack trace - Stack exception_trace; - /// execution stack - Stack stack; - /// contexts - Value *self; - VMethodFrame *method_frame; - Value *rcontext; - WContext *wcontext; - /// current language - uchar flang; - /// current connection - SQL_Connection *fconnection; - //@} + HashString classes_conf; public: // status read methods - Value *get_self() { return self; } VMethodFrame *get_method_frame() { return method_frame; } + Value& get_self(); -private: // core data +#define GET_SELF(request, type) (static_cast(request.get_self())) - /// classes - Hash fclasses; + /// public for ^reflection:copy[] + void put_element(Value& ncontext, const String& name, Value* value); - /// already used files to avoid cyclic uses - Hash used_files; + /// for @main[] + const String* execute_virtual_method(Value& aself, const String& method_name); - /** endless execute(execute(... preventing counter - @see ANTI_ENDLESS_EXECUTE_RECOURSION - */ - uint anti_endless_execute_recoursion; + //{ 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, const String *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] - const String& execute_method(VMethodFrame& amethodFrame, const Method& method); - //{ for @conf[filespec] and @auto[filespec] - void execute_method(Value& aself, - const Method& method, VString *optional_param, - const String **return_string); - void execute_nonvirtual_method(VStateless_class& aclass, - const String& method_name, VString *optional_param, - const String **return_string, - const Method **return_method=0); - //} - /// for @main[] - const String *execute_virtual_method(Value& aself, const String& method_name); - - Value *get_element(const String *& remember_name, - bool can_call_operator, bool should_explode_junction=false/*there's only one place when true*/); + Value& get_element(Value& ncontext, const String& name); +#ifdef FEATURE_GET_ELEMENT4CALL + Value& get_element4call(Value& ncontext, const String& name); +#endif private: // defaults - const uchar fdefault_lang; - Value *default_content_type; + const String::Language fdefault_lang; private: // mime types @@ -337,159 +395,140 @@ 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(const VFile& body_file, bool header_only); + void output_result(VFile* 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; + size_t exception_trace_top; + size_t exception_trace_bottom; /// execution stack - int stack; + size_t stack; + uint anti_endless_execute_recoursion; /// contexts - Value *self; - 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()), + Request_context_saver(Request& ar) : + fr(ar), + exception_trace_top(ar.exception_trace.top_index()), + exception_trace_bottom(ar.exception_trace.bottom_index()), stack(ar.stack.top_index()), - self(ar.self), + 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) {} - ~Request_context_saver() { - fr.exception_trace.top_index(exception_trace); - fr.stack.top_index(stack); - fr.self=self; fr.method_frame=method_frame, fr.rcontext=rcontext; fr.wcontext=wcontext; + fconnection(ar.fconnection) {} + void restore() { + 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; } }; -/// Auto-object used for temporary changing Request::flang. -class Temp_lang { - Request& frequest; - uchar saved_lang; -public: - Temp_lang(Request& arequest, uchar alang) : - frequest(arequest), - saved_lang(arequest.set_lang(alang)) { - } - ~Temp_lang() { - frequest.restore_lang(saved_lang); - } -}; - /// 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)) { } - ~Temp_connection() { + ~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 { +/// Auto-object used for break out of cycle check +class InCycle { + Request& frequest; 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); + InCycle(Request& arequest) : frequest(arequest) { + frequest.set_in_cycle(1); } - /// handy value-is-not-a-junction ensurer - Value& as_no_junction(int index, const char *msg) { - return get_as(index, false, msg); + ~InCycle() { + frequest.set_in_cycle(-1); } - /// 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(); +}; + +/// Auto-object used for temporary changing Request::allow_class_replace. +class Temp_class_replace { + Request& frequest; +public: + Temp_class_replace(Request& arequest, bool avalue) : frequest(arequest){ + frequest.allow_class_replace=avalue; } - /// handy string ensurer - const String& as_string(int index, const char *msg) { - return as_no_junction(index, msg).as_string(); + ~Temp_class_replace() { + frequest.allow_class_replace=false; } +}; -private: +/// Auto-object used for temporarily substituting/removing elements +class Temp_value_element { + Request& frequest; + Value& fwhere; + const String& fname; + Value* saved; +public: + Temp_value_element(Request& arequest, Value& awhere, const String& aname, Value* awhat); + ~Temp_value_element(); +}; - /// 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); +// defines for externs - return result; - } +#define EXCEPTION_HANDLED_PART_NAME "handled" - Value& get_processed(int index, const char *msg, Request& r) { - return r.process_to_value(as_junction(index, msg), 0/*no name*/); - } -private: +// externs - const String& fmethod_name; +extern const String main_method_name; +extern const String auto_method_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 + +#define MAIN_CLASS_NAME "MAIN" +#define AUTO_FILE_NAME "auto.p" #endif