[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.96 and 1.201

version 1.96, 2001/09/21 15:35:45 version 1.201, 2010/05/25 03:58:17
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-2009 ArtLebedev Group (http://www.artlebedev.com)
           Author: Alexandr Petrosian <paf@design.ru> (http://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
   
 #include "pa_config_includes.h"  static const char * const IDENT_REQUEST_H="$Date$";
   
 #include "pa_pool.h"  #include "pa_pool.h"
 #include "pa_hash.h"  #include "pa_hash.h"
 #include "pa_wcontext.h"  #include "pa_wcontext.h"
 #include "pa_value.h"  #include "pa_value.h"
 #include "pa_stack.h"  #include "pa_stack.h"
 #include "pa_vclass.h"  #include "pa_request_info.h"
 #include "pa_vobject.h"  #include "pa_request_charsets.h"
 #include "pa_venv.h"  #include "pa_sapi.h"
 #include "pa_vform.h"  #include "pa_vconsole.h"
 #include "pa_vmath.h"  
 #include "pa_vrequest.h"  #ifdef RESOURCES_DEBUG
 #include "pa_vresponse.h"  #include <sys/resource.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  #endif
   
   // consts
   
   const uint ANTI_ENDLESS_EXECUTE_RECOURSION=1000;
   const size_t pseudo_file_no__process=1;
   
   // forwards
   
 class Temp_lang;  class Temp_lang;
 class Methoded;  class Methoded;
   class VMethodFrame;
   class VMail;
   class VForm;
   class VResponse;
   class VCookie;
   class VStateless_class;
   
 /// Main workhorse.  /// Main workhorse.
 class Request : public Pooled {  class Request: public PA_Object {
         friend Temp_lang;          friend class Temp_lang;
           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
           };
   
   private:
           Pool fpool;
 public:  public:
           Pool& pool() { return fpool; }
   
         /// some information from web server  private:
         class Info {          union StackItem {
                   Value* fvalue;
                   ArrayOperation* fops;
                   VMethodFrame* fmethod_frame;
         public:          public:
                 const char *document_root;                  Value& value() const { return *fvalue; }
                 const char *path_translated;                  const String& string() const { 
                 const char *method;                          return fvalue->as_string();
                 const char *query_string;                  }
                 const char *uri;                  ArrayOperation& ops() const { return *fops; }
                 const char *content_type;                  VMethodFrame& method_frame() const { return *fmethod_frame; }
                 size_t content_length;  
                 const char *cookie;                  /// needed to fill unused Array entries
                 const char *user_agent;                  StackItem() {}
                   StackItem(Value& avalue): fvalue(&avalue) {}            
                   StackItem(ArrayOperation& aops): fops(&aops) {}
                   StackItem(VMethodFrame& amethod_frame): fmethod_frame(&amethod_frame) {}
         };          };
           
         Request(Pool& apool,          class Exception_trace: public Stack<Trace> {
                 Info& ainfo,                  size_t fbottom;
                 String::Untaint_lang adefault_lang ///< all tainted data default untainting lang          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
           HashString<Value*> 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 
                   @see ANTI_ENDLESS_EXECUTE_RECOURSION
           */
           uint anti_endless_execute_recoursion;
   
           ///@}
   
           /// execution stack
           Stack<StackItem> stack;
   
           /// exception stack trace
           Exception_trace exception_trace;
   public:
   
           //@{ 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 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
           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
                   bool status_allowed ///<  status class allowed
         );          );
         ~Request() {}          ~Request();
   
         /// global classes          /// global classes
         Hash& classes() { return fclasses; }          HashString<Value*>& classes() { return fclasses; }
           Value* get_class(const String& name);
   
         /**          /**
                 core request processing                  core request processing
Line 81  public: Line 198  public:
                 BEWARE: may throw exception to you: catch it!                  BEWARE: may throw exception to you: catch it!
         */          */
         void core(          void core(
                 const char *root_config_filespec, ///< system config filespec                  const char* config_filespec, ///< system config filespec
                 bool root_config_fail_on_read_problem, ///< fail if system config file not found                  bool 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);                  bool header_only);
   
         /// executes ops          /// executes ops
         void execute(const Array& ops); // execute.C          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(/*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,
                                   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.          /// compiles the file, maybe forcing it's class @a name and @a base_class.
         VStateless_class *use_file(          void use_file(VStateless_class& aclass,
                 const String& file_name,                   const String& file_name,
                 bool ignore_class_path=false, bool fail_on_read_problem=true,                  const String* use_filespec);
                 const String *name=0,   
                 VStateless_class *base_class=0); // core.C  
         /// compiles a @a source buffer          /// compiles a @a source buffer
         VStateless_class *use_buf(          void use_buf(VStateless_class& aclass,
                 const char *source, const char *file,                  const char* source, 
                 VStateless_class *aclass=0, const String *name=0,                   const String* main_alias,
                 VStateless_class *base_class=0); // core.C                  uint file_no,
                   int line_no_offset=0);
   
         /// processes any code-junction there may be inside of @a value          /// processes any code-junction there may be inside of @a value
         Value& process(          StringOrValue process(Value& input_value, bool intercept_string=true); // execute.C
                 Value& value,           void process_write(Value& input_value); // execute.C
                 const String *name=0,          //@{ convinient helpers
                 bool intercept_string=true); // execute.C          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();
           }
           //@}
           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(const String* string=dual.get_string()) \
                           write_##modification##_lang(*string); \
                   else \
                           write_##modification##_lang(*dual.get_value()); \
           }
   
         /// appending, sure of clean string inside          /// appending, sure of clean string inside
         void write_no_lang(const String& astring) {          void write_no_lang(const String& astring) {
                 wcontext->write(astring, String::UL_CLEAN);                  wcontext->write(astring, 
                           (String::Language)(String::L_CLEAN | flang&String::L_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::Language)(String::L_CLEAN | flang&String::L_OPTIMIZE_BIT));
           }
   
         /// appending string, passing language built into string being written          /// appending string, passing language built into string being written
         void write_pass_lang(const String& astring) {          void write_pass_lang(const String& astring) {
                 wcontext->write(astring, String::UL_PASS_APPENDED);                   wcontext->write(astring, String::L_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          /// appending possible string, passing language built into string being written
         void write_pass_lang(Value& avalue) {          void write_pass_lang(Value& avalue) {
                 wcontext->write(avalue, String::UL_PASS_APPENDED);                   wcontext->write(avalue, String::L_PASS_APPENDED); 
         }          }
         /// appending sure value, that would be converted to clean string          DEFINE_DUAL(pass)
         void write_no_lang(Value& avalue) {  
                 wcontext->write(avalue, String::UL_CLEAN);          /// appending possible string, assigning untaint language
           void write_assign_lang(Value& avalue) {
                   wcontext->write(avalue, flang); 
         }          }
         /// appending sure value, not VString          /// appending string, assigning untaint language
         void write_expr_result(Value& avalue) {          void write_assign_lang(const String& astring) {
                 wcontext->write(avalue);                   wcontext->write(astring, flang); 
         }          }
           DEFINE_DUAL(assign)
   
         /// returns relative to @a path  path to @a file           /// 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          /// returns an absolute @a path to relative @a name
         const String& absolute(const String& relative_name);          const String& absolute(const String& relative_name);
   
         /// returns the mime type of 'user_file_name_cstr'          /// 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; 
           }
   
           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:  public:
                   
         /// info from web server          /// info from web server
         Info& info;          Request_info& request_info;
         /// user's post data  
         char *post_data;  size_t post_size;          /// info about ServerAPI
           SAPI_Info& sapi_info;
         /// operators are methods of this class  
         Methoded& OP;          /// source, client, mail charsets
         /// $env:fields          Request_charsets charsets;
         VEnv env;  
           /// 'MAIN' class conglomerat & operators are methods of this class
           VStateless_class& main_class;
         /// $form:elements          /// $form:elements
         VForm form;          VForm& form;
         /// $math:constants          /// $mail
         VMath math;          VMail& mail;
         /// $request:elements  
         VRequest request;  
         /// $response:elements          /// $response:elements
         VResponse response;          VResponse& response;
         /// $cookie:elements          /// $cookie:elements
         VCookie cookie;          VCookie& cookie;
           /// $console
           VConsole& console;
   
         /// contexts          /// classes configured data
         Value *self, *root, *rcontext;          HashString<void*> classes_conf;
         /// contexts  
         WContext *wcontext;  
   
         /// 'MAIN' class conglomerat  public: // status read methods
         VStateless_class *main_class;  
   
         /// connection          VMethodFrame *get_method_frame() { return method_frame; }
         SQL_Connection *connection;          Value& get_self();
         /// PCRE character tables  #define GET_SELF(request, type) (static_cast<type &>(request.get_self()))
         unsigned char *pcre_tables;          /* for strange reason call to this: 
                   r.get_self<VHash>() 
                   refuses to compile
   
         /// classes configured data          template<typename T> T& get_self() {
         Hash classes_conf;                  return *static_cast<T*>(get_self().get());
           }
           */
   
           /// for @main[]
           const String* execute_virtual_method(Value& aself, const String& method_name);
   
 private: // core data          /// 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);
   
         /// classes  #endif
         Hash fclasses;  
   
         /// already used files to avoid cyclic uses  private:
         Hash used_files;  
   
         /// execution stack          /// already executed some @conf method
         Stack stack;          bool configure_admin_done;
   
         /**     endless execute(execute(... preventing counter           void configure_admin(VStateless_class& conf_class);
                 @see ANTI_ENDLESS_EXECUTE_RECOURSION  
         */          void configure();
         uint anti_endless_execute_recoursion;  
   
 private: // compile.C  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  private: // execute.C
   
         const String *execute_method(Value& aself,           void put_element(Value& ncontext, const String& name, Value* value);
                 const Method& method, bool return_cstr=true);          Value& get_element(Value& ncontext, const String& name);
         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);  
   
         Value *get_element();  
   
 private: // lang&raw   
           
         String::Untaint_lang flang;  
   
 private: // defaults  private: // defaults
   
         const String::Untaint_lang fdefault_lang;          const String::Language fdefault_lang;
         Value *default_content_type;  
   
 private: // mime types  private: // mime types
   
Line 227  private: // mime types Line 427  private: // mime types
   
 private: // lang manipulation  private: // lang manipulation
   
         String::Untaint_lang set_lang(String::Untaint_lang alang) {          String::Language set_lang(String::Language alang) {
                 String::Untaint_lang result=flang;                  String::Language result=flang;
                 flang=alang;                  flang=alang;
                 return result;                  return result;
         }          }
         void restore_lang(String::Untaint_lang alang) {          void restore_lang(String::Language alang) {
                 flang=alang;                  flang=alang;
         }          }
   
   private: // connection manipulation
   
           SQL_Connection* set_connection(SQL_Connection* aconnection) {
                   SQL_Connection* result=fconnection;
                   fconnection=aconnection;
                   return result;
           }
           void restore_connection(SQL_Connection* aconnection) {
                   fconnection=aconnection;
           }
   
 private:  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
           size_t exception_trace_top;
           size_t exception_trace_bottom;
           /// execution stack
           size_t stack;
           uint anti_endless_execute_recoursion;
           /// contexts
           VMethodFrame* method_frame;
           Value* rcontext;
           WContext* wcontext;
           /// current language
           String::Language flang; 
           /// current connection
           SQL_Connection* fconnection;
   
   public:
           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()),
                   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) {}
           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.  ///     Auto-object used for temporary changing Request::flang.
 class Temp_lang {  class Temp_lang {
         Request& frequest;          Request& frequest;
         String::Untaint_lang saved_lang;          String::Language saved_lang;
 public:  public:
         Temp_lang(Request& arequest, String::Untaint_lang alang) :           Temp_lang(Request& arequest, String::Language alang) : 
                 frequest(arequest),                  frequest(arequest),
                 saved_lang(arequest.set_lang(alang)) {                  saved_lang(arequest.set_lang(alang)) {
         }          }
Line 255  public: Line 508  public:
         }          }
 };  };
   
 /**  ///     Auto-object used for temporary changing Request::fconnection.
         @b method parameters passed in this array.  class Temp_connection {
         contains handy typecast ad junction/not junction ensurers          Request& frequest;
           SQL_Connection* saved_connection;
 */  
 class MethodParams : public Array {  
 public:  public:
         MethodParams(Pool& pool, const String& amethod_name) : Array(pool),          Temp_connection(Request& arequest, SQL_Connection* aconnection) : 
                 fmethod_name(amethod_name) {                  frequest(arequest),
         }                  saved_connection(arequest.set_connection(aconnection)) {
   
         /// handy typecast. I long for templates  
         Value& get(int index) {   
                 return *static_cast<Value *>(Array::get(index));   
         }  
         /// handy is-value-a-junction ensurer  
         Value& as_junction(int index, const char *msg) {   
                 return get_as(index, true, msg);   
         }  
         /// handy value-is-not-a-junction ensurer  
         Value& as_no_junction(int index, const char *msg) {   
                 return get_as(index, false, msg);   
         }          }
         /// handy expression auto-processing to double          ~Temp_connection() { 
         double as_double(int index, Request& r) {                   frequest.restore_connection(saved_connection); 
                 return get_processed(index, r).as_double();   
         }          }
         /// handy expression auto-processing to int  };
         int as_int(int index, Request& r) {   
                 return get_processed(index, r).as_int();   ///     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 string ensurer          ~InCycle() { 
         const String& as_string(int index, const char *msg) {                   frequest.set_in_cycle(-1);
                 return as_no_junction(index, msg).as_string();   
         }          }
   };
   
 private:  // defines for externs
   
         /// handy value-is/not-a-junction ensurer  #define EXCEPTION_HANDLED_PART_NAME "handled"
         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;  
         }  
   
         Value& get_processed(int index, Request& r) {  
                 return r.process(get(index),  
                         0/*no name*/,  
                         false/*don't intercept string*/);  
         }  
   
 private:  // externs
   
         const String& fmethod_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
   
   #define MAIN_CLASS_NAME "MAIN"
   #define AUTO_FILE_NAME "auto.p"
   
 #endif  #endif
Removed from v.1.96  
changed lines
  Added in v.1.201

E-mail: