--- parser3/src/include/pa_request.h 2001/09/24 14:34:25 1.97 +++ parser3/src/include/pa_request.h 2026/10/13 20:02:00 1.286 @@ -1,318 +1,568 @@ /** @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.97 2001/09/24 14:34:25 parser Exp $ + Copyright (c) 2001-2026 Art. Lebedev Studio (https://www.artlebedev.com) + Authors: Konstantin Morshnev , Alexandr Petrosian */ #ifndef PA_REQUEST_H #define PA_REQUEST_H -#include "pa_config_includes.h" +#define IDENT_PA_REQUEST_H "$Id: pa_request.h,v 1.286 2026/10/13 20:02:00 moko Exp $" + #include "pa_pool.h" #include "pa_hash.h" +#include "pa_file.h" #include "pa_wcontext.h" #include "pa_value.h" +#include "pa_vhash.h" #include "pa_stack.h" -#include "pa_vclass.h" -#include "pa_vobject.h" -#include "pa_venv.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" - -#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 +#include "pa_request_info.h" +#include "pa_request_charsets.h" +#include "pa_sapi.h" + +// externs + +extern const String main_method_name; +extern const String auto_method_name; + +// defines for statics + +#define MAIN_CLASS_NAME "MAIN" +#define AUTO_FILE_NAME "auto.p" + +// consts + +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; +class VConsole; +class VException; + +extern int pa_loop_limit; +extern int pa_array_limit; +extern int pa_execute_recursion_limit; +extern int pa_httpd_timeout; +extern size_t pa_file_size_limit; + +class Code_cache; /// Main workhorse. -class Request : public Pooled { - friend Temp_lang; +class Request: public PA_Object { + friend class Temp_connection; + friend class Temp_request_self; + friend class Temp_value_element; + friend class Temp_recursion; + friend class Request_context_saver; + friend class Exception_trace; + friend class VException; + friend class Code_cache_manager; + +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_CONTINUE, + SKIP_BREAK, + SKIP_RETURN, + SKIP_INTERRUPTED + }; + +private: + Pool fpool; public: + Pool& pool() { return fpool; } - /// some information from web server - class Info { +private: + union StackItem { + Value* fvalue; + ArrayOperation* fops; + VMethodFrame* fmethod_frame; 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; + 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; } + + StackItem(Value& avalue): fvalue(&avalue) {} + StackItem(ArrayOperation& aops): fops(&aops) {} + StackItem(VMethodFrame& amethod_frame): fmethod_frame(&amethod_frame) {} }; - - Request(Pool& apool, - Info& ainfo, - String::Untaint_lang adefault_lang ///< all tainted data default untainting lang + + 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 set_range(size_t bottom, size_t top) { fbottom=bottom; fsize=top; } + + void clear() { + fsize=fbottom=0; + } + + bool is_empty() { + return fsize==fbottom; + } + + Table &table(Request &r, const String* problem_source) { + return table(r, problem_source, bottom_index(), top_index()); + } + Table &table(Request &r, const String* problem_source, size_t bottom, size_t top); + }; + + ///@{ core data + + /// classes + OrderedHashString 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_recursion; + int execute_recursion_limit; + void recursion_limit_reached(); + + ///@} + + /// execution stack + Stack stack; + +public: + /// exception stack trace + Exception_trace exception_trace; + + bool allow_class_replace; + + //@{ request processing status + /// contexts + VMethodFrame* method_frame; + Value* rcontext; + WContext* wcontext; + /// current connection + SQL_Connection* fconnection; + //@} + +private: + + int fin_cycle; + Skip fskip; + VMethodFrame* freturn_method_frame; + +public: + uint register_file(String::Body file_spec); + + const char* get_exception_cstr(const Exception& e, VException& 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 + + Request(SAPI_Info& asapi_info, Request_info& arequest_info, + String::Language adefault_lang ///< all tainted data default untainting lang ); - ~Request() {} + ~Request(); /// global classes - Hash& classes() { return fclasses; } + OrderedHashString& classes() { return fclasses; } + VStateless_class* get_class(const String& name); + VStateless_class& get_class_ref(const String& name); + void put_class(VStateless_class *aclass){ classes().put(aclass->type(), aclass); } + bool add_class(const char* atype, VStateless_class *aclass); /** 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); + void core(const char* config_filespec, const String& amain_method_name = main_method_name, const String* amain_class_name = NULL); + + /// ^response:send[part]: the headers go with the first part, the result of @main or exception is not sent then + void send(Value& part); /// 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-recursion check + void recursion_checked_execute(ArrayOperation& ops) { + if(++anti_endless_execute_recursion>=execute_recursion_limit) + recursion_limit_reached(); + execute(ops); // execute it + anti_endless_execute_recursion--; + } + + /// take the recovery reserve back if recursion limit is far enough + void recursion_limit_try_restore() { + if(execute_recursion_limit>pa_execute_recursion_limit && anti_endless_execute_recursionwrite(astring, String::UL_CLEAN); - } - /// 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); - } - /// appending sure value, that would be converted to clean string - void write_no_lang(Value& avalue) { - wcontext->write(avalue, String::UL_CLEAN); - } - /// appending sure value, not VString - void write_expr_result(Value& avalue) { - wcontext->write(avalue); + 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).as_string(); + } + //@} + const Operation::Origin get_method_origin(const Method* method); // execute.C + 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); + } + + /// 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); } /// 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); + + /// '/'-normalized disk path of a file name; a uri of another scheme is returned as is if allowed, otherwise throws + const String& full_disk_path(const String& relative_name, uint allowed=0); + /// '/'-normalized full_disk_path of a real file on disk, which does not throw: 0 for a uri or a remote, invalid or tainted file:// one + const String* real_disk_path(const String& 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(bool fail_on_error=true) { + if(fail_on_error && !fconnection) + throw Exception(PARSER_RUNTIME, 0, "outside of 'connect' operator"); + return fconnection; + } + + Skip get_skip() { return fskip; } + void set_skip(Skip askip) { fskip=askip; } + void set_skip_return(VMethodFrame& amethod_frame) { fskip=SKIP_RETURN; freturn_method_frame=&amethod_frame; } + inline bool check_skip_break() { bool result=fskip >= SKIP_BREAK; if(fskip <= SKIP_BREAK) fskip=SKIP_NOTHING; return result; } + inline void check_skip_return() { if(fskip==SKIP_RETURN && method_frame==freturn_method_frame) fskip=SKIP_NOTHING; } + + 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 - char *post_data; size_t post_size; - - /// operators are methods of this class - Methoded& OP; - /// $env:fields - VEnv env; + Request_info& request_info; + + /// 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; - /// $math:constants - VMath math; - /// $request:elements - VRequest request; + VForm& form; + /// $mail + VMail& mail; /// $response:elements - VResponse response; + VResponse& response; /// $cookie:elements - VCookie cookie; + VCookie& cookie; + /// $console + VConsole& console; - /// contexts - Value *self, *root, *rcontext; - /// contexts - WContext *wcontext; + /// classes configured data + HashString 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; } + Value& get_self(); - /// classes configured data - Hash classes_conf; +#define GET_SELF(request, type) (static_cast(request.get_self())) + /// public for ^reflection:copy[] + void put_element(Value& ncontext, const String& name, Value* value); -private: // core data + /// for @main[] and parser://method/call + const String* execute_method(VStateless_class& aclass, const String& method_name, Value* optional_param = 0); - /// classes - Hash fclasses; + //{ for @conf[filespec] and @auto[filespec] + bool execute_method_if_exists(VStateless_class& aclass, const String& method_name, Value* optional_param); + bool execute_auto_method_if_exists(VStateless_class& aclass, const String& method_name, Value* optional_param); - /// already used files to avoid cyclic uses - Hash used_files; + //} - /// execution stack - Stack stack; +#ifdef XML +public: // charset helpers - /** endless execute(execute(... preventing counter - @see ANTI_ENDLESS_EXECUTE_RECOURSION - */ - uint anti_endless_execute_recoursion; + /// @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); -private: // compile.C +#endif - VStateless_class& real_compile(COMPILE_PARAMS); +private: -private: // execute.C + /// already executed some @conf method + bool configure_admin_done; - 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); + void configure_admin(VStateless_class& conf_class); - Value *get_element(); + void configure(); -private: // lang&raw - - String::Untaint_lang flang; +private: // compile.C -private: // defaults + ArrayClass& compile(VStateless_class* aclass, const char* source, const String* main_alias, uint file_no, int line_no_offset, Code_cache* code); - const String::Untaint_lang fdefault_lang; - Value *default_content_type; +private: // execute.C + + Value& get_element(Value& ncontext, const String& name); +#ifdef FEATURE_GET_ELEMENT4CALL + Value& get_element4call(Value& ncontext, const String& name); +#endif private: // mime types /// $MAIN:MIME-TYPES Table *mime_types; -private: // lang manipulation +private: // true if ^response:send[] was used + + bool fheaders_sent; + +private: // connection manipulation - String::Untaint_lang set_lang(String::Untaint_lang alang) { - String::Untaint_lang result=flang; - flang=alang; + SQL_Connection* set_connection(SQL_Connection* aconnection) { + SQL_Connection* result=fconnection; + fconnection=aconnection; return result; } - void restore_lang(String::Untaint_lang alang) { - flang=alang; + 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 for temporary changing Request::flang. -class Temp_lang { - Request& frequest; - String::Untaint_lang saved_lang; +/// Hash-compatible exception; hash is built on demand. +class VException: public VHashReference { + Exception fexception; + String::Body ffile; + Value* fhandled; + size_t ftrace_bottom, ftrace_top; public: - Temp_lang(Request& arequest, String::Untaint_lang alang) : - frequest(arequest), - saved_lang(arequest.set_lang(alang)) { - } - ~Temp_lang() { - frequest.restore_lang(saved_lang); - } + Operation::Origin origin; + const String* problem_source; + + VException(Request& r, const Exception& e); + + override HashStringValue& hash(); + override Value* get_element(const String& name); + override const VJunction* put_element(const String& name, Value* value); + + Value* handled(); + Table& stack(Request& r); + void expire_trace() { ftrace_top=size_t(-1); } }; -/** - @b method parameters passed in this array. - contains handy typecast ad junction/not junction ensurers +/// Auto-object used to save request context across ^try body +class Request_context_saver { + Request& fr; + + /// execution stack + size_t stack; + int anti_endless_execute_recursion; + /// contexts + VMethodFrame* method_frame; + Value* rcontext; + WContext* wcontext; + /// current connection + SQL_Connection* fconnection; -*/ -class MethodParams : public Array { public: - MethodParams(Pool& pool, const String& amethod_name) : Array(pool), - fmethod_name(amethod_name) { + Request_context_saver(Request& ar) : + fr(ar), + stack(ar.stack.top_index()), + anti_endless_execute_recursion(ar.anti_endless_execute_recursion), + method_frame(ar.method_frame), + rcontext(ar.rcontext), + wcontext(ar.wcontext), + fconnection(ar.fconnection) {} + void restore() { + fr.stack.set_top_index(stack); + fr.anti_endless_execute_recursion=anti_endless_execute_recursion; + fr.method_frame=method_frame, fr.rcontext=rcontext; fr.wcontext=wcontext; + fr.fconnection=fconnection; } +}; - /// handy typecast. I long for templates - Value& get(int index) { - return *static_cast(Array::get(index)); +/// 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)) { } - /// handy is-value-a-junction ensurer - Value& as_junction(int index, const char *msg) { - return get_as(index, true, msg); + ~Temp_connection() { + frequest.restore_connection(saved_connection); } - /// handy value-is-not-a-junction ensurer - Value& as_no_junction(int index, const char *msg) { - return get_as(index, false, msg); +}; + +/// Auto-object used for break out of cycle check +class InCycle { + Request& frequest; +public: + InCycle(Request& arequest) : frequest(arequest) { + frequest.set_in_cycle(1); } - /// handy expression auto-processing to double - double as_double(int index, Request& r) { - return get_processed(index, r).as_double(); + ~InCycle() { + frequest.set_in_cycle(-1); } - /// handy expression auto-processing to int - int as_int(int index, Request& r) { - return get_processed(index, r).as_int(); +}; + +/// Auto-object used for break out of cycle check +class TempSkip4Delimiter { + Request& frequest; + Request::Skip fskip; +public: + TempSkip4Delimiter(Request& arequest) : frequest(arequest), fskip(arequest.get_skip()) { + frequest.set_skip(Request::SKIP_NOTHING); } - /// handy string ensurer - const String& as_string(int index, const char *msg) { - return as_no_junction(index, msg).as_string(); + // returns true if break required, should be called + bool check_break() { + if(frequest.get_skip()) + fskip=frequest.get_skip(); + frequest.set_skip(fskip <= Request::SKIP_BREAK ? Request::SKIP_NOTHING : fskip); + return fskip >= Request::SKIP_BREAK; } +}; -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; +/// 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; } - - Value& get_processed(int index, Request& r) { - return r.process(get(index), - 0/*no name*/, - false/*don't intercept string*/); + ~Temp_class_replace() { + frequest.allow_class_replace=false; } +}; -private: - - const String& fmethod_name; +/// 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(); +}; +/// Auto-object that temporarily increases recursion +class Temp_recursion { + Request& frequest; +public: + Temp_recursion(Request& arequest) : frequest(arequest){ + frequest.anti_endless_execute_recursion++; + } + ~Temp_recursion(){ + frequest.anti_endless_execute_recursion--; + } }; #endif