[BACK]Return to pa_request.h CVS log [TXT] [DIR] Up to [parser3project] / parser3 / src / include

Diff for /parser3/src/include/pa_request.h between versions 1.62 and 1.288

version 1.62, 2001/03/19 17:42:12 version 1.288, 2026/10/16 13:55:16
Line 1 Line 1
 /** @file  /** @file
         Parser: request class decl.          Parser: request class decl.
   
         Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)          Copyright (c) 2001-2026 Art. Lebedev Studio (https://www.artlebedev.com)
           Authors: Konstantin Morshnev <moko@design.ru>, Alexandr Petrosian <paf@design.ru>
         Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)  
   
         $Id$  
 */  */
   
 #ifndef PA_REQUEST_H  #ifndef PA_REQUEST_H
 #define PA_REQUEST_H  #define PA_REQUEST_H
   
   #define IDENT_PA_REQUEST_H "$Id$"
   
 #include "pa_pool.h"  #include "pa_pool.h"
 #include "pa_hash.h"  #include "pa_hash.h"
   #include "pa_file.h"
 #include "pa_wcontext.h"  #include "pa_wcontext.h"
 #include "pa_value.h"  #include "pa_value.h"
 #include "pa_stack.h"  #include "pa_vhash.h"
 #include "pa_vclass.h"  
 #include "pa_vobject.h"  
 #include "pa_venv.h"  
 #include "pa_vform.h"  
 #include "pa_vrequest.h"  
 #include "pa_vresponse.h"  #include "pa_vresponse.h"
 #include "pa_vcookie.h"  #include "pa_stack.h"
   #include "pa_request_info.h"
   #include "pa_request_charsets.h"
   #include "pa_sapi.h"
   
 #ifndef NO_STRING_ORIGIN  // externs
 #       define COMPILE_PARAMS  \  
                 const char *source, \  extern const String main_method_name;
                 VStateless_class *aclass, const String *name, \  extern const String auto_method_name;
                 VStateless_class *base_class, \  
                 const char *file  // defines for statics
 #       define COMPILE(source, aclass, name, base_class, file)  \  
                 real_compile(source, aclass, name, base_class, file)  #define MAIN_CLASS_NAME "MAIN"
 #else  #define AUTO_FILE_NAME "auto.p"
 #       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  
   
 class Temp_lang;  // consts
   
   const size_t pseudo_file_no__process=1;
   
   // forwards
   
   class Methoded;
   class VMethodFrame;
   class VMail;
   class VForm;
   class VCookie;
   class VStateless_class;
   class VConsole;
   class WebSocket;
   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.  /// Main workhorse.
 class Request : public Pooled {  class Request: public PA_Object {
         friend Temp_lang;          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:  public:
           class Trace {
                   const String* fname;
                   Operation::Origin forigin;
           public:
                   Trace(): fname(0) {}
                   void clear() { fname=0; }
   
         /// some information from web server                  Trace(const String* aname, const Operation::Origin aorigin):
         struct Info {                          fname(aname), forigin(aorigin) {}
                 const char *document_root;  
                 const char *path_translated;                  const String* name() const { return fname; }
                 const char *method;                  const Operation::Origin origin() const { return forigin; }
                 const char *query_string;  
                 const char *uri;  
                 const char *content_type;  
                 size_t content_length;  
                 const char *cookie;  
         };          };
           
         Request(Pool& apool,          enum Skip {
                 Info& ainfo,                  SKIP_NOTHING,
                 String::Untaint_lang adefault_lang ///< all tainted data default untainted                  SKIP_CONTINUE,
                   SKIP_BREAK,
                   SKIP_RETURN,
                   SKIP_INTERRUPTED
           };
   
   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; }
   
                   StackItem(Value& avalue): fvalue(&avalue) {}
                   StackItem(ArrayOperation& aops): fops(&aops) {}
                   StackItem(VMethodFrame& amethod_frame): fmethod_frame(&amethod_frame) {}
           };
   
           class Exception_trace: public Stack<Trace> {
                   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<VStateless_class*> fclasses;
   
           /// already used files to avoid cyclic uses
           HashString<bool> used_files;
           HashString<bool> searched_along_class_path;
           /// list of all used files, Operation::file_no = index to it
           Array<String::Body> file_list;
   
           /// endless execute(execute(... preventing counter
           int anti_endless_execute_recursion;
           int execute_recursion_limit;
           void recursion_limit_reached();
   
           ///@}
   
           /// execution stack
           Stack<StackItem> 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          /// global classes
         Hash& classes() { return fclasses; }          OrderedHashString<VStateless_class*>& 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* config_filespec, const String& amain_method_name = main_method_name, const String* amain_class_name = NULL);
   
         /// core request processing          /// ^response:stream[part]: the headers go with the first part
         void core(Exception& system_exception,          void stream(Value& part);
                 const char *sys_auto_path1,  
                 const char *sys_auto_path2);          /// sends headers and sets response.started
           void start(VResponse::Started mode);
   
         /// executes ops          /// executes ops
         void execute(const Array& ops);          void execute(ArrayOperation& ops); // execute.C
   
           template<typename Frame> void call(Frame& frame){
                   VMethodFrame *saved_method_frame=method_frame;
                   Value* saved_rcontext=rcontext;
                   WContext *saved_wcontext=wcontext;
   
         /// compiles the file, maybe forcing it's class \a name and \a base_class.                  rcontext=wcontext=method_frame=&frame;
         VStateless_class *use_file(  
                 const char *file, bool fail_on_read_problem=true,                  frame.call(*this);
                 const String *name=0,   
                 VStateless_class *base_class=0); // core.C                  wcontext=saved_wcontext;
         /// compiles a \a source buffer                  rcontext=saved_rcontext;
         VStateless_class *use_buf(                  method_frame=saved_method_frame;
                 const char *source, const char *file,          }
                 VStateless_class *aclass=0, const String *name=0,   
                 VStateless_class *base_class=0); // core.C          template<typename Frame> void call_write(Frame& frame){
         /// processes any code-junction there may be inside of \a value                  VMethodFrame *saved_method_frame=method_frame;
         Value& process(                  Value* saved_rcontext=rcontext;
                 Value& value,   
                 const String *name=0,                  rcontext=method_frame=&frame;
                 bool intercept_string=true); // execute.C  
                   frame.call(*this);
         /// write(const) = clean  
         void write(const String& astring) {                  rcontext=saved_rcontext;
                 wcontext->write(astring, String::Untaint_lang::NO);                  method_frame=saved_method_frame;
         }          }
         /// appending, sure of clean string inside  
         void write_no_lang(String& astring) {          Value& construct(VStateless_class &class_value, const Method &method);
                 wcontext->write(astring, String::Untaint_lang::NO);  
         }          /// execute ops with anti-recursion check
         /// appending string, passing language built into string being written          void recursion_checked_execute(ArrayOperation& ops) {
         void write_pass_lang(String& astring) {                  if(++anti_endless_execute_recursion>=execute_recursion_limit)
                 wcontext->write(astring, String::Untaint_lang::PASS_APPENDED);                           recursion_limit_reached();
         }                  execute(ops); // execute it
         /// appending possible string, assigning untaint language                  anti_endless_execute_recursion--;
         void write_assign_lang(Value& avalue) {          }
                 wcontext->write(avalue, flang);   
         }          /// take the recovery reserve back if recursion limit is far enough
         /// appending possible string, passing language built into string being written          void recursion_limit_try_restore() {
         void write_pass_lang(Value& avalue) {                  if(execute_recursion_limit>pa_execute_recursion_limit && anti_endless_execute_recursion<pa_execute_recursion_limit/2)
                 wcontext->write(avalue, String::Untaint_lang::PASS_APPENDED);                           execute_recursion_limit=pa_execute_recursion_limit;
         }  
         /// appending sure value, that would be converted to clean string  
         void write_no_lang(Value& avalue) {  
                 wcontext->write(avalue, String::Untaint_lang::NO);  
         }  
         /// appending sure value, not VString  
         void write_expr_result(Value& avalue) {  
                 wcontext->write(avalue);   
         }          }
   
         /// handy is-value-a-junction ensurer          ///
         void fail_if_junction_(bool is, Value& value, const String& method_name, char *msg);          void use_file_directly(const String& file_spec, bool fail_on_file_absence=true, bool with_auto_p=false);
   
         /// returns relative to \a path  path to \a file           /// compiles the file in main class context by default
         char *relative(const char *path, const char *file);          void use_file(const String& file_name, const String* use_filespec, bool with_auto_p=false);
   
         /// returns an absolute \a path to relative \a name          /// for @USE only, calls ^use (which may be user-defined)
         char *absolute(const char *name);          void use_file(const String& file_name, const String* use_filespec, Operation::Origin origin);
   
           /// compiles a @a source buffer, recording it into @a code if given, or replays the cached @a code
           void use_buf(VStateless_class& aclass, const char* source, const String* main_alias, uint file_no, int line_no_offset=0, Code_cache* code=0);
   
           /// processes any code-junction there may be inside of @a value
           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);
   
           /// '/'-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 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);
   
           /// 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:  public:
                   
         /// info from web server          /// info from web server
         Info& info;          Request_info& request_info;
   
         /// default base          /// info about ServerAPI
         VClass ROOT;          SAPI_Info& sapi_info;
         /// $env:fields here  
         VEnv env;  
         /// $form:elements here  
         VForm form;  
         /// $request:elements here  
         VRequest request;  
         /// $response:  
         VResponse response;  
         /// $cookie:  
         VCookie cookie;  
   
         /// contexts          /// source, client, mail charsets
         Value *self, *root, *rcontext;          Request_charsets charsets;
         /// contexts  
         WContext *wcontext;  
   
 private: // core data          /// 'MAIN' class conglomerat & operators are methods of this class
           VStateless_class& main_class;
           /// $form:elements
           VForm& form;
           /// $mail
           VMail& mail;
           /// $response:elements
           VResponse& response;
           /// $cookie:elements
           VCookie& cookie;
           /// $console
           VConsole& console;
           /// inited in httpd mode
           WebSocket* websocket;
   
           /// classes configured data
           HashString<void*> classes_conf;
   
   public: // status read methods
   
           VMethodFrame *get_method_frame() { return method_frame; }
           Value& get_self();
   
   #define GET_SELF(request, type) (static_cast<type &>(request.get_self()))
   
           /// public for ^reflection:copy[]
           void put_element(Value& ncontext, const String& name, Value* value);
   
           /// for @main[] and parser://method/call
           const String* execute_method(VStateless_class& aclass, const String& method_name, Value* optional_param = 0);
   
           //{ 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);
   
           //}
   
   #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);
   
         // classes  #endif
         Hash fclasses;  
   
         // execution stack  private:
         Stack stack;  
   
 private: // compile.C          /// already executed some @conf method
           bool configure_admin_done;
   
         VStateless_class& real_compile(COMPILE_PARAMS);          void configure_admin(VStateless_class& conf_class);
   
 private: // execute.C          void configure();
   
         const String *execute_method(Value& aself, const Method& method,   private: // compile.C
                 bool return_cstr=true);  
         const String *execute_method(Value& aself, const String& method_name,   
                 bool return_cstr=true);  
   
         Value *get_element();          ArrayClass& compile(VStateless_class* aclass, const char* source, const String* main_alias, uint file_no, int line_no_offset, Code_cache* code);
   
 private: // lang&raw   private: // execute.C
           
         String::Untaint_lang flang;          Value& get_element(Value& ncontext, const String& name);
   #ifdef FEATURE_GET_ELEMENT4CALL
           Value& get_element4call(Value& ncontext, const String& name);
   #endif
   
 private: // defaults  private: // mime types
   
         const String::Untaint_lang fdefault_lang;          /// $MAIN:MIME-TYPES
         Value *fdefault_content_type;          Table *mime_types;
   
 private: // lang manipulation  private: // connection manipulation
   
         String::Untaint_lang set_lang(String::Untaint_lang alang) {          SQL_Connection* set_connection(SQL_Connection* aconnection) {
                 String::Untaint_lang result=flang;                  SQL_Connection* result=fconnection;
                 flang=alang;                  fconnection=aconnection;
                 return result;                  return result;
         }          }
         void restore_lang(String::Untaint_lang alang) {          void restore_connection(SQL_Connection* aconnection) {
                 flang=alang;                  fconnection=aconnection;
         }          }
   
 private:  private:
   
         void output_result(const String& body_string);          void output_result(VFile* body_file, bool header_only, bool as_attachment);
   };
   
   /// 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:
           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); }
   };
   
   /// 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;
   
   public:
           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;
           }
 };  };
   
 ///     Auto-object used for temporary changing Request::flang.  ///     Auto-object used for temporary changing Request::fconnection.
 class Temp_lang {  class Temp_connection {
         Request& frequest;          Request& frequest;
         String::Untaint_lang saved_lang;          SQL_Connection* saved_connection;
 public:  public:
         Temp_lang(Request& arequest, String::Untaint_lang alang) :           Temp_connection(Request& arequest, SQL_Connection* aconnection) :
                 frequest(arequest),                  frequest(arequest),
                 saved_lang(arequest.set_lang(alang)) {                  saved_connection(arequest.set_connection(aconnection)) {
           }
           ~Temp_connection() {
                   frequest.restore_connection(saved_connection); 
           }
   };
   
   ///     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);
           }
   };
   
   ///     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);
           }
           // 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;
           }
   };
   
   ///     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;
           }
           ~Temp_class_replace() {
                   frequest.allow_class_replace=false;
           }
   };
   
   ///     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_lang() {           ~Temp_recursion(){
                 frequest.restore_lang(saved_lang);                   frequest.anti_endless_execute_recursion--;
         }          }
 };  };
   
Removed from v.1.62  
changed lines
  Added in v.1.288

E-mail: