Diff for /parser3/src/include/pa_request.h between versions 1.113 and 1.160.2.17

version 1.113, 2001/12/14 12:53:47 version 1.160.2.17, 2003/02/04 15:15:03
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-2003 ArtLebedev Group (http://www.artlebedev.com)
         Author: Alexander Petrosyan <paf@design.ru> (http://paf.design.ru)          Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
   
         $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* IDENT_REQUEST_H="$Date$";
   
 #include "pa_pool.h"  #include "pa_pool.h"
   #include "pa_request_info.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"
Line 21 Line 21
 #include "pa_venv.h"  #include "pa_venv.h"
 #include "pa_vstatus.h"  #include "pa_vstatus.h"
 #include "pa_vform.h"  #include "pa_vform.h"
   #include "pa_vmail.h"
 #include "pa_vmath.h"  #include "pa_vmath.h"
 #include "pa_vrequest.h"  #include "pa_vrequest.h"
 #include "pa_vresponse.h"  #include "pa_vresponse.h"
 #include "pa_vcookie.h"  #include "pa_vcookie.h"
 #include "pa_sql_driver_manager.h"  #include "pa_request_info.h"
 #include "pa_transcoder.h"  #include "pa_request_charsets.h"
   #include "pa_sapi.h"
   
 #ifdef RESOURCES_DEBUG  #ifdef RESOURCES_DEBUG
 #include <sys/resource.h>  #include <sys/resource.h>
 #endif  #endif
   
   // consts
   
   const uint ANTI_ENDLESS_EXECUTE_RECOURSION=500;
   
   // defines
   
 #ifndef NO_STRING_ORIGIN  #ifndef NO_STRING_ORIGIN
 #       define COMPILE_PARAMS  \  #       define COMPILE_PARAMS  \
                 const char *source, \                  VStateless_class* aclass, const char* source \
                 VStateless_class *aclass, const String *name, \                  , const char* file
                 VStateless_class *base_class, \  #       define COMPILE(aclass, source, file)  \
                 const char *file                  real_compile(aclass, source, file)
 #       define COMPILE(source, aclass, name, base_class, file)  \  
                 real_compile(source, aclass, name, base_class, file)  
 #else  #else
 #       define COMPILE_PARAMS  \  #       define COMPILE_PARAMS  \
                 const char *source, \                  VStateless_class* aclass, const char* source
                 VStateless_class *aclass, const String *name, \  #       define COMPILE(aclass, source, file)  \
                 VStateless_class *base_class                  real_compile(aclass, source)
 #       define COMPILE(source, aclass, name, base_class, file)  \  
                 real_compile(source, aclass, name, base_class)  
 #endif  #endif
   
   // forwards
   
 class Temp_lang;  class Temp_lang;
 class Methoded;  class Methoded;
   class VMethodFrame;
   
 /// Main workhorse.  /// Main workhorse.
 class Request : public Pooled {  class Request: public PA_Object {
         friend class Temp_lang;          friend class Temp_lang;
           friend class Temp_connection;
           friend class Request_context_saver;
           friend class Temp_request_self;
   
           /// all files and classes and other hard-to-place allocations go to this pool
           Pool fpool;
   
           ///@{ core data
   
           /// classes
           HashStringValue fclasses;
   
           /// already used files to avoid cyclic uses
           Hash<StringPtr, bool> used_files;
   
           /**     endless execute(execute(... preventing counter 
                   @see ANTI_ENDLESS_EXECUTE_RECOURSION
           */
           uint anti_endless_execute_recoursion;
   
           ///@}
   
   public:
   
           class StackItem {
           public:
                   StringPtr string;
                   ValuePtr value;
                   ArrayOperationPtr ops;
                   void *unknown;
   
                   /// needed to fill unused Array entries
                   StackItem() {}
                   StackItem(StringPtr astring): string(astring) {}
                   StackItem(ValuePtr avalue): value(avalue) {}            
                   StackItem(ArrayOperationPtr aops): ops(aops) {}
                   StackItem(void *aunknown): unknown(aunknown) {}
           };
   
           //@{ request processing status
           /// exception stack trace
           Stack<StringPtr> exception_trace;
           /// execution stack
           Stack<StackItem> stack;
           /// contexts
           VMethodFrame *method_frame;
           Value *rcontext;
           WContext *wcontext;
           /// current language
           uchar flang; 
           /// current connection
           SQL_Connection *fconnection;
           //@}
           /// interrupted flag, raised on signals [SIGPIPE]
           bool finterrupted;
   
 public:  public:
   
           /// all files and classes and other hard-to-place allocations go to this pool
           Pool& pool() { return fpool; }
   
 #ifdef RESOURCES_DEBUG  #ifdef RESOURCES_DEBUG
         /// measures          /// measures
         double sql_connect_time;          double sql_connect_time;
         double sql_request_time;          double sql_request_time;
 #endif    #endif  
   
         /// some information from web server          Request(SAPI_Info& asapi_info, Request_info& arequest_info,
         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;  
                 const char *user_agent;  
         };  
           
         Request(Pool& apool,  
                 Info& ainfo,  
                 uchar adefault_lang, ///< all tainted data default untainting lang                  uchar adefault_lang, ///< all tainted data default untainting lang
                 bool status_allowed ///<  status class allowed                  bool status_allowed ///<  status class allowed
         );          );
         ~Request() {}          ~Request();
   
         /// global classes          /// global classes
         Hash& classes() { return fclasses; }          HashStringValue& classes() { return fclasses; }
   
         /**          /**
                 core request processing                  core request processing
Line 93  public: Line 144  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
           /// execute ops with anti-recoursion check
           void recoursion_checked_execute(StringPtr name, ArrayOperation& ops) {
                   // anti_endless_execute_recoursion
                   if(++anti_endless_execute_recoursion==ANTI_ENDLESS_EXECUTE_RECOURSION) {
                           anti_endless_execute_recoursion=0; // give @exception a chance
                           throw Exception("parser.runtime",
                                   name,
                                   "call canceled - endless recursion detected");
                   }
                   execute(ops); // execute it
                   anti_endless_execute_recoursion--;
           }
   
         /// 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(          VStateless_classPtr use_file(VStateless_class& aclass,
                 const String& file_name,                   StringPtr file_name, 
                 bool ignore_class_path=false, bool fail_on_read_problem=true,                  bool ignore_class_path=false, 
                 const String *name=0,                   bool fail_on_read_problem=true, bool fail_on_file_absence=true); // pa_request.C
                 VStateless_class *base_class=0); // core.C  
         /// compiles a @a source buffer          /// compiles a @a source buffer
         VStateless_class *use_buf(          VStateless_classPtr use_buf(VStateless_class& aclass,
                 const char *source, const char *file,                  const char* source, 
                 VStateless_class *aclass=0, const String *name=0,                   StringPtr filespec, const char* filespec_cstr); // pa_request.C
                 VStateless_class *base_class=0); // core.C  
         /// 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(ValuePtr input_value, bool intercept_string=true); // execute.C
                 Value& value,           //@{ convinient helpers
                 const String *name=0,          StringPtr process_to_string(ValuePtr input_value) {
                 bool intercept_string=true); // execute.C                  return process(input_value, true/*intercept_string*/).as_string(&pool());
           }
           ValuePtr process_to_value(ValuePtr input_value, bool intercept_string=true) {
                   return process(input_value, intercept_string).as_value();
           }
           //@}
   
           
   #define DEFINE_DUAL(modification) \
           void write_##modification##_lang(StringOrValue dual) { \
                   if(StringPtr string=dual.get_string()) \
                           write_##modification##_lang(*string); \
                   else \
                           write_##modification##_lang(dual.get_value()); \
           }
   #define DEFINE_DUAL_CHECKED(modification) \
           void write_##modification##_lang(StringOrValue dual, StringPtr origin) { \
                   if(StringPtr string=dual.get_string()) \
                           write_##modification##_lang(*string); \
                   else \
                           write_##modification##_lang(dual.get_value(), origin); \
           }
   
         /// 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,                   wcontext->write(astring, 
                         String::UL_CLEAN | flang&String::UL_OPTIMIZE_BIT);                          String::UL_CLEAN | flang&String::UL_OPTIMIZE_BIT);
         }          }
           /// appending sure value, that would be converted to clean string
           void write_no_lang(ValuePtr avalue) {
                   if(wcontext->get_in_expression())
                           wcontext->write(pool(), avalue);
                   else
                           wcontext->write(pool(), avalue, 
                                   String::UL_CLEAN | flang&String::UL_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::UL_PASS_APPENDED); 
         }          }
           /// appending possible string, passing language built into string being written
           void write_pass_lang(ValuePtr avalue) {
                   wcontext->write(pool(), avalue, String::UL_PASS_APPENDED); 
           }
           DEFINE_DUAL(pass)
   
         /// appending possible string, assigning untaint language          /// appending possible string, assigning untaint language
         void write_assign_lang(Value& avalue) {          void write_assign_lang(ValuePtr avalue) {
                 wcontext->write(avalue, flang);                   wcontext->write(pool(), avalue, flang); 
           }
           /// appending possible string, assigning untaint language
           void write_assign_lang(ValuePtr avalue, StringPtr origin) {
                   wcontext->write(pool(), avalue, flang, origin); 
         }          }
         /// appending string, assigning untaint language          /// appending string, assigning untaint language
         void write_assign_lang(const String& astring) {          void write_assign_lang(const String& astring) {
                 wcontext->write(astring, flang);                   wcontext->write(astring, flang); 
         }          }
         /// appending possible string, passing language built into string being written          DEFINE_DUAL(assign)
         void write_pass_lang(Value& avalue) {          DEFINE_DUAL_CHECKED(assign)
                 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 | flang&String::UL_OPTIMIZE_BIT);  
         }  
         /// appending sure value, not VString  
         void write_expr_result(Value& avalue) {  
                 wcontext->write(avalue);   
         }  
   
         /// 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);          StringPtr relative(const char* apath, StringPtr 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);          StringPtr absolute(StringPtr 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);          StringPtr mime_type_of(const char* user_file_name_cstr);
   
           /// returns current SQL connection if any
           SQL_Connection *connection(StringPtr source) { 
                   if(!fconnection && source)
                           throw Exception("parser.runtime",
                                   source,
                                   "outside of 'connect' operator");
   
                   return fconnection; 
           }
   
         /// transcoder [pcre_tables + byte->unicode & back]          bool origins_mode();
         const Transcoder* transcoder();  
   
         /// pcre_tables [up/low case & co]          void interrupt() { finterrupted=true; }
         const unsigned char *pcre_tables();          bool interrupted() { return finterrupted; }
   
 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;  
   
         /// operators are methods of this class          /// info about ServerAPI
         Methoded& OP;          SAPI_Info& sapi_info;
   
           /// source, client, mail charsets
           Request_charsets charsets;
   
           /// 'MAIN' class conglomerat & operators are methods of this class
           VStateless_classPtr main_class;
         /// $env:fields          /// $env:fields
         VEnv env;          //VEnv env;
         /// $status:fields          /// $status:fields
         VStatus status;          //VStatus status;
         /// $form:elements          /// $form:elements
         VForm form;          VFormPtr form;
           /// $mail
           VMailPtr mail;
         /// $math:constants          /// $math:constants
         VMath math;          //VMath math;
         /// $request:elements          /// $request:elements
         VRequest request;          //VRequest request;
         /// $response:elements          /// $response:elements
         VResponse response;          VResponsePtr response;
         /// $cookie:elements          /// $cookie:elements
         VCookie cookie;          VCookiePtr cookie;
   
         /// contexts  
         Value *self, *root, *rcontext;  
         /// contexts  
         WContext *wcontext;  
   
         /// 'MAIN' class conglomerat  
         VStateless_class *main_class;  
   
         /// connection  
         SQL_Connection *connection;  
   
         /// classes configured data          /// classes configured data
         Hash classes_conf;          HashStringValue classes_conf;
   
 private: // core data  
   
         /// classes  public: // status read methods
         Hash fclasses;  
   
         /// already used files to avoid cyclic uses          VMethodFrame *get_method_frame() { return method_frame; }
         Hash used_files;          ValuePtr get_self();
   #define GET_SELF(request, type) *static_cast<type *>(request.get_self().get());
   
         /// execution stack  private:
         Stack stack;  
   
         /**     endless execute(execute(... preventing counter   
                 @see ANTI_ENDLESS_EXECUTE_RECOURSION  
         */  
         uint anti_endless_execute_recoursion;  
   
         /// charset->transcoder          /// already executed some @conf method
         Hash CTYPE;               bool configure_admin_done;
   
         /// stack trace          void configure_admin(VStateless_class& conf_class, StringPtr source);
         Stack trace;  
   
 private: // compile.C  private: // compile.C
   
Line 231  private: // compile.C Line 315  private: // compile.C
   
 private: // execute.C  private: // execute.C
   
         const String *execute_method(Value& aself,           /// for @postprocess[body]
                 const Method& method, bool return_cstr=true);          StringPtr execute_method(VMethodFrame& amethodFrame, const Method& method);
         const String *execute_virtual_method(Value& aself,           //{ for @conf[filespec] and @auto[filespec]
                 const String& method_name, bool return_cstr=true);          StringPtr execute_method(ValuePtr aself, 
         const String *execute_nonvirtual_method(VStateless_class& aclass,                   const Method& method, VStringPtr optional_param,
                 const String& method_name, bool return_cstr=true);                  bool do_return_string);
           StringPtr execute_nonvirtual_method(VStateless_class& aclass, 
                   StringPtr method_name, VStringPtr optional_param,
                   bool do_return_string,
                   const Method **return_method=0);
           //}
           /// for @main[]
           StringPtr execute_virtual_method(ValuePtr aself, StringPtr method_name);
   
         Value *get_element();          ValuePtr get_element(StringPtr& remember_name, bool can_call_operator);
   
 private: // lang&raw   
           
         uchar flang;  
   
 private: // defaults  private: // defaults
   
Line 265  private: // lang manipulation Line 352  private: // lang manipulation
                 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(VFilePtr 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;
           /// execution stack
           int stack;
           /// contexts
           VMethodFrame *method_frame;
           Value *rcontext;
           WContext *wcontext;
           /// current language
           uchar flang; 
           /// current connection
           SQL_Connection *fconnection;
   
   public:
           Request_context_saver(Request& ar) : 
                   exception_trace(ar.exception_trace.top_index()),        
                   stack(ar.stack.top_index()),
                   method_frame(ar.method_frame),
                   rcontext(ar.rcontext),
                   wcontext(ar.wcontext),
                   flang(ar.flang),
                   fconnection(ar.fconnection),
                   fr(ar) {}
           void restore() {
                   fr.exception_trace.top_index(exception_trace);
                   fr.stack.top_index(stack);
                   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;
         uchar saved_lang;          String_UL saved_lang;
 public:  public:
         Temp_lang(Request& arequest, uchar alang) :           Temp_lang(Request& arequest, String_UL alang) : 
                 frequest(arequest),                  frequest(arequest),
                 saved_lang(arequest.set_lang(alang)) {                  saved_lang(arequest.set_lang(alang)) {
         }          }
Line 284  public: Line 418  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  
         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();   
         }  
         /// handy string ensurer  
         const String& as_string(int index, const char *msg) {   
                 return as_no_junction(index, msg).as_string();   
         }  
   
 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 Exception(0, 0,  
                                 &fmethod_name,  
                                 "%s (parameter #%d)", msg, 1+index);  
   
                 return result;  
         }          }
           ~Temp_connection() { 
         Value& get_processed(int index, const char *msg, Request& r) {                  frequest.restore_connection(saved_connection); 
                 return r.process(as_junction(index, msg),  
                         0/*no name*/,  
                         false/*don't intercept string*/);  
         }          }
   };
   
 private:  
   
         const String& fmethod_name;  // defines for externs
   
 };  #define CONTENT_DISPOSITION_NAME "content-disposition"
   #define CONTENT_DISPOSITION_VALUE "attachment"
   #define CONTENT_DISPOSITION_FILENAME_NAME "filename"
   
   // externs
   
   extern StringPtr main_method_name;
   extern StringPtr body_name;
   extern StringPtr content_disposition_name;
   extern StringPtr content_disposition_value;
   extern StringPtr content_disposition_filename_name;
   
 #endif  #endif

Removed from v.1.113  
changed lines
  Added in v.1.160.2.17


E-mail: