[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.7 and 1.151

version 1.7, 2001/02/21 17:36:30 version 1.151, 2002/09/21 12:36:10
Line 1 Line 1
 /*  /** @file
   $Id$          Parser: request class decl.
   
           Copyright (c) 2001, 2002 ArtLebedev Group (http://www.artlebedev.com)
           Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
 */  */
   
 #ifndef PA_REQUEST_H  #ifndef PA_REQUEST_H
 #define PA_REQUEST_H  #define PA_REQUEST_H
   
   static const char* IDENT_REQUEST_H="$Date$";
   
 #include "pa_pool.h"  #include "pa_pool.h"
 #include "pa_exception.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_vobject.h"
   #include "pa_venv.h"
   #include "pa_vstatus.h"
   #include "pa_vform.h"
   #include "pa_vmail.h"
   #include "pa_vmath.h"
   #include "pa_vrequest.h"
   #include "pa_vresponse.h"
   #include "pa_vcookie.h"
   #include "pa_sql_driver_manager.h"
   
   #ifdef RESOURCES_DEBUG
   #include <sys/resource.h>
   #endif
   
   // consts
   
 #define MAIN_METHOD_NAME "main"  #define MAIN_METHOD_NAME "main"
   const uint ANTI_ENDLESS_EXECUTE_RECOURSION=500;
   
   // defines
   
 #ifndef NO_STRING_ORIGIN  #ifndef NO_STRING_ORIGIN
 #       define COMPILE_PARAMS char *source, char *file  #       define COMPILE_PARAMS  \
 #       define COMPILE(source, file) real_compile(source, file)                  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  #else
 #       define COMPILE_PARAMS char *source  #       define COMPILE_PARAMS  \
 #       define COMPILE(source, file) real_compile(source)                  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
   
 class Local_request_exception;  class Temp_lang;
   class Methoded;
   class VMethodFrame;
   
   /// Main workhorse.
 class Request : public Pooled {  class Request : public Pooled {
         friend Local_request_exception;          friend class Temp_lang;
           friend class Temp_connection;
           friend class Request_context_saver;
 public:  public:
   
   #ifdef RESOURCES_DEBUG
           /// measures
           double sql_connect_time;
           double sql_request_time;
   #endif  
   
           /// some information from web server
           class Info {
           public:
                   const char *document_root;
                   const char *path_translated;
                   const char *method;
                   const char *query_string;
                   const char *uri;
                   const char *content_type;
                   size_t content_length;
                   const char *cookie;
                   bool mail_received;
           };
                   
         Request(Pool& apool) : Pooled(apool),          Request(Pool& apool,
                 fpool(apool),                   Info& ainfo,
                 stack(apool),                  uchar adefault_lang, ///< all tainted data default untainting lang
                 fclasses(apool)                  bool status_allowed ///<  status class allowed
                 {          );
           ~Request();
   
           /// global classes
           Hash& classes() { return fclasses; }
   
           /**
                   core request processing
   
                   BEWARE: may throw exception to you: catch it!
           */
           void core(
                   const char *config_filespec, ///< system config filespec
                   bool config_fail_on_read_problem, ///< fail if system config file not found
                   bool header_only);
   
           /// executes ops
           void execute(const Array& ops); // execute.C
           /// execute ops with anti-recoursion check
           void recoursion_checked_execute(const String *name, const Array& ops) {
                   // anti_endless_execute_recoursion
                   if(++anti_endless_execute_recoursion==ANTI_ENDLESS_EXECUTE_RECOURSION) {
                           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--;
         }          }
         ~Request() {}  
   
         // IMPORTANT: don't use without  Local_request_exception           /// compiles the file, maybe forcing it's class @a name and @a base_class.
         Exception& exception() { return *fexception; }          VStateless_class *use_file(
                   const String& file_name, 
                   bool ignore_class_path=false, 
                   bool fail_on_read_problem=true, bool fail_on_file_absence=true,
                   const String *name=0, 
                   VStateless_class *base_class=0); // core.C
           /// compiles a @a source buffer
           VStateless_class *use_buf(
                   const char *source, const String& filespec, const char *filespec_cstr,
                   VStateless_class *aclass=0, const String *name=0, 
                   VStateless_class *base_class=0); // core.C
   
           /// processes any code-junction there may be inside of @a value
           StringOrValue process(Value& input_value, bool intercept_string=true); // execute.C
           //@{ convinient helpers
           const String& process_to_string(Value& input_value) {
                   return process(input_value, true/*intercept_string*/).as_string();
           }
           Value& process_to_value(Value& input_value, bool intercept_string=true) {
                   return process(input_value, intercept_string).as_value();
           }
           //@}
   
         // global classes          
         Hash& classes() { return fclasses; }  #define DEFINE_DUAL(modification) \
           void write_##modification##_lang(StringOrValue dual) { \
                   if(const String *string=dual.get_string()) \
                           write_##modification##_lang(*string); \
                   else \
                           write_##modification##_lang(*dual.get_value()); \
           }
   #define DEFINE_DUAL_CHECKED(modification) \
           void write_##modification##_lang(StringOrValue dual, const String *origin) { \
                   if(const String *string=dual.get_string()) \
                           write_##modification##_lang(*string); \
                   else \
                           write_##modification##_lang(*dual.get_value(), origin); \
           }
   
         // core request processing          /// appending, sure of clean string inside
         void core();          void write_no_lang(const String& astring) {
                   wcontext->write(astring, 
                           String::UL_CLEAN | flang&String::UL_OPTIMIZE_BIT);
           }
           /// appending sure value, that would be converted to clean string
           void write_no_lang(Value& avalue) {
                   if(wcontext->get_in_expression())
                           wcontext->write(avalue);
                   else
                           wcontext->write(avalue, 
                                   String::UL_CLEAN | flang&String::UL_OPTIMIZE_BIT);
           }
           //DEFINE_DUAL(no)
   
 private: // core data          /// appending string, passing language built into string being written
           void write_pass_lang(const String& astring) {
                   wcontext->write(astring, String::UL_PASS_APPENDED); 
           }
           /// appending possible string, passing language built into string being written
           void write_pass_lang(Value& avalue) {
                   wcontext->write(avalue, String::UL_PASS_APPENDED); 
           }
           DEFINE_DUAL(pass)
   
         // classes          /// appending possible string, assigning untaint language
         Hash fclasses;          void write_assign_lang(Value& avalue) {
                   wcontext->write(avalue, flang); 
           }
           /// appending possible string, assigning untaint language
           void write_assign_lang(Value& avalue, const String *origin) {
                   wcontext->write(avalue, flang, origin); 
           }
           /// appending string, assigning untaint language
           void write_assign_lang(const String& astring) {
                   wcontext->write(astring, flang); 
           }
           DEFINE_DUAL(assign)
           DEFINE_DUAL_CHECKED(assign)
   
         // contexts          /// returns relative to @a path  path to @a file 
         Value *root, *self, *rcontext;          const String& relative(const char *apath, const String& relative_name);
         WContext *wcontext;  
           /// returns an absolute @a path to relative @a name
           const String& absolute(const String& relative_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(const String *source) { 
                   if(!fconnection && source)
                           throw Exception("parser.runtime",
                                   source,
                                   "outside of 'connect' operator");
   
                   return fconnection; 
           }
   
           bool origins_mode() {
                   return main_class->get_element(*origins_mode_name, main_class, false)!=0;  // $ORIGINS mode
           }
   
   public:
           
           /// info from web server
           Info& info;
           /// user's post data
           const char *post_data;  size_t post_size;
   
           /// name of 'main' method
           const String main_method_name;
                   
         // execution stack          /// operators are methods of this class
           Methoded& OP;
           /// $env:fields
           VEnv env;
           /// $status:fields
           VStatus status;
           /// $form:elements
           VForm form;
           /// $mail
           VMail mail;
           /// $math:constants
           VMath math;
           /// $request:elements
           VRequest request;
           /// $response:elements
           VResponse response;
           /// $cookie:elements
           VCookie cookie;
   
           /// 'MAIN' class conglomerat
           VStateless_class *main_class;
   
           /// classes configured data
           Hash classes_conf;
   
   private:
   
           //@{ request processing status
           /// exception stack trace
           Stack exception_trace;
           /// execution stack
         Stack stack;          Stack stack;
           /// contexts
           Value *self;
           VMethodFrame *method_frame;
           Value *rcontext;
           WContext *wcontext;
           /// current language
           uchar flang; 
           /// current connection
           SQL_Connection *fconnection;
           //@}
   
   public: // status read methods
   
           Value *get_self() { return self; }
           VMethodFrame *get_method_frame() { return method_frame; }
   
 private: // core.C  private: // core data
   
           /// classes
           Hash fclasses;
   
         Array& load_and_compile_RUN();          /// already used files to avoid cyclic uses
         VClass *construct_class(String& name, Array& compiled_methods);          Hash used_files;
         char *execute_MAIN(VClass *class_RUN);  
           /**     endless execute(execute(... preventing counter 
                   @see ANTI_ENDLESS_EXECUTE_RECOURSION
           */
           uint anti_endless_execute_recoursion;
   
   private:
   
           /// already executed some @conf method
           bool configure_admin_done;
   
           void configure_admin(VStateless_class& conf_class, const String *source);
   
 private: // compile.C  private: // compile.C
   
         Array& real_compile(COMPILE_PARAMS);          VStateless_class& real_compile(COMPILE_PARAMS);
   
 private: // execute.C  private: // execute.C
   
         void execute(Array& ops);          /// for @postprocess[body]
           const String& execute_method(VMethodFrame& amethodFrame, const Method& method);
 protected:          //{ for @conf[filespec] and @auto[filespec]
           void execute_method(Value& aself, 
                   const Method& method, VString *optional_param,
                   const String **return_string);
           void execute_nonvirtual_method(VStateless_class& aclass, 
                   const String& method_name, VString *optional_param,
                   const String **return_string,
                   const Method **return_method=0);
           //}
           /// for @main[]
           const String *execute_virtual_method(Value& aself, const String& method_name);
   
           Value *get_element(const String *& remember_name, 
                   bool can_call_operator, bool should_explode_junction=false/*there's only one place when true*/);
   
   private: // defaults
   
           const uchar fdefault_lang;
           Value *default_content_type;
   
   private: // mime types
   
           /// $MAIN:MIME-TYPES
           Table *mime_types;
   
   private: // lang manipulation
   
           uchar set_lang(uchar alang) {
                   uchar result=flang;
                   flang=alang;
                   return result;
           }
           void restore_lang(uchar alang) {
                   flang=alang;
           }
   
         // all request' objects are allocated in this pool  private: // connection manipulation
         Pool& fpool;  
   
         // exception replacement mechanism is protected from direct usage          SQL_Connection *set_connection(SQL_Connection *aconnection) {
         // Local_request_exception object enforces paired set/restore                  SQL_Connection *result=fconnection;
         Exception *set_exception(Exception *e){                  fconnection=aconnection;
                 Exception *r=fexception;                  return result;
                 fexception=e;  
                 return r;  
         }          }
         void restore_exception(Exception *e) {          void restore_connection(SQL_Connection *aconnection) {
                 fexception=e;                  fconnection=aconnection;
         }          }
   
 private:  private:
   
         // current request's exception object          void output_result(const VFile& body_file, bool header_only);
         Exception *fexception;  };
   
   /// 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
           Value *self;
           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()),
                   self(ar.self),
                   method_frame(ar.method_frame),
                   rcontext(ar.rcontext),
                   wcontext(ar.wcontext),
                   flang(ar.flang),
                   fconnection(ar.fconnection),
                   fr(ar) {}
           ~Request_context_saver() {
                   fr.exception_trace.top_index(exception_trace);
                   fr.stack.top_index(stack);
                   fr.self=self; fr.method_frame=method_frame, fr.rcontext=rcontext; fr.wcontext=wcontext;
                   fr.flang=flang;
                   fr.fconnection=fconnection;
           }
   };
   
   ///     Auto-object used for temporary changing Request::flang.
   class Temp_lang {
           Request& frequest;
           uchar saved_lang;
   public:
           Temp_lang(Request& arequest, uchar alang) : 
                   frequest(arequest),
                   saved_lang(arequest.set_lang(alang)) {
           }
           ~Temp_lang() { 
                   frequest.restore_lang(saved_lang); 
           }
 };  };
   
 class Local_request_exception {  ///     Auto-object used for temporary changing Request::fconnection.
         Request request;  class Temp_connection {
         Exception *saved_exception;          Request& frequest;
 public:          SQL_Connection *saved_connection;
         Local_request_exception(Request& arequest, Exception& exception) :   public:
                 request(arequest),          Temp_connection(Request& arequest, SQL_Connection *aconnection) : 
                 saved_exception(arequest.set_exception(&exception)) {}                  frequest(arequest),
         ~Local_request_exception() { request.restore_exception(saved_exception); }                  saved_connection(arequest.set_connection(aconnection)) {
           }
           ~Temp_connection() { 
                   frequest.restore_connection(saved_connection); 
           }
 };  };
   
 // core func  /**
 void core();          @b method parameters passed in this array.
           contains handy typecast ad junction/not junction ensurers
   
   */
   class MethodParams : public Array {
   public:
           MethodParams(Pool& pool, const String& amethod_name) : Array(pool),
                   fmethod_name(amethod_name) {
           }
   
           /// handy typecast. I long for templates
           Value& get(int index) { 
                   return *static_cast<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("parser.runtime",
                                   &fmethod_name,
                                   "%s (parameter #%d)", msg, 1+index);
   
                   return result;
           }
   
           Value& get_processed(int index, const char *msg, Request& r) {
                   return r.process_to_value(as_junction(index, msg), 0/*no name*/);
           }
   
   private:
   
           const String& fmethod_name;
   
   };
   
 #endif  #endif
Removed from v.1.7  
changed lines
  Added in v.1.151

E-mail: