Annotation of parser3/src/include/pa_request.h, revision 1.117
1.61 paf 1: /** @file
1.62 paf 2: Parser: request class decl.
3:
1.32 paf 4: Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)
1.109 paf 5: Author: Alexander Petrosyan <paf@design.ru> (http://paf.design.ru)
1.32 paf 6:
1.117 ! paf 7: $Id: pa_request.h,v 1.116 2001/12/21 12:47:56 paf Exp $
1.1 paf 8: */
9:
10: #ifndef PA_REQUEST_H
11: #define PA_REQUEST_H
12:
13: #include "pa_pool.h"
1.5 paf 14: #include "pa_hash.h"
1.7 paf 15: #include "pa_wcontext.h"
1.6 paf 16: #include "pa_value.h"
1.7 paf 17: #include "pa_stack.h"
1.12 paf 18: #include "pa_vclass.h"
1.45 paf 19: #include "pa_vobject.h"
1.47 paf 20: #include "pa_venv.h"
1.108 paf 21: #include "pa_vstatus.h"
1.48 paf 22: #include "pa_vform.h"
1.90 parser 23: #include "pa_vmath.h"
1.56 paf 24: #include "pa_vrequest.h"
1.57 paf 25: #include "pa_vresponse.h"
1.60 paf 26: #include "pa_vcookie.h"
1.77 paf 27: #include "pa_sql_driver_manager.h"
1.44 paf 28:
1.112 paf 29: #ifdef RESOURCES_DEBUG
30: #include <sys/resource.h>
31: #endif
32:
1.7 paf 33: #ifndef NO_STRING_ORIGIN
1.40 paf 34: # define COMPILE_PARAMS \
35: const char *source, \
1.46 paf 36: VStateless_class *aclass, const String *name, \
37: VStateless_class *base_class, \
1.40 paf 38: const char *file
39: # define COMPILE(source, aclass, name, base_class, file) \
40: real_compile(source, aclass, name, base_class, file)
1.7 paf 41: #else
1.40 paf 42: # define COMPILE_PARAMS \
43: const char *source, \
1.46 paf 44: VStateless_class *aclass, const String *name, \
45: VStateless_class *base_class
1.40 paf 46: # define COMPILE(source, aclass, name, base_class, file) \
47: real_compile(source, aclass, name, base_class)
1.7 paf 48: #endif
1.4 paf 49:
1.39 paf 50: class Temp_lang;
1.84 paf 51: class Methoded;
1.116 paf 52: class VMethodFrame;
1.1 paf 53:
1.61 paf 54: /// Main workhorse.
1.7 paf 55: class Request : public Pooled {
1.107 paf 56: friend class Temp_lang;
1.117 ! paf 57: friend class Temp_connection;
1.1 paf 58: public:
1.112 paf 59:
60: #ifdef RESOURCES_DEBUG
61: /// measures
62: double sql_connect_time;
63: double sql_request_time;
64: #endif
1.61 paf 65:
66: /// some information from web server
1.65 paf 67: class Info {
68: public:
1.53 paf 69: const char *document_root;
70: const char *path_translated;
1.56 paf 71: const char *method;
1.53 paf 72: const char *query_string;
1.56 paf 73: const char *uri;
1.53 paf 74: const char *content_type;
75: size_t content_length;
1.60 paf 76: const char *cookie;
1.71 paf 77: const char *user_agent;
1.53 paf 78: };
79:
1.50 paf 80: Request(Pool& apool,
1.53 paf 81: Info& ainfo,
1.111 paf 82: uchar adefault_lang, ///< all tainted data default untainting lang
1.110 paf 83: bool status_allowed ///< status class allowed
1.50 paf 84: );
1.3 paf 85: ~Request() {}
1.1 paf 86:
1.61 paf 87: /// global classes
1.6 paf 88: Hash& classes() { return fclasses; }
89:
1.65 paf 90: /**
91: core request processing
92:
93: BEWARE: may throw exception to you: catch it!
94: */
95: void core(
1.95 parser 96: const char *root_config_filespec, ///< system config filespec
97: bool root_config_fail_on_read_problem, ///< fail if system config file not found
98: const char *site_config_filespec, ///< site config filespec
99: bool site_config_fail_on_read_problem, ///< fail if site config file not found
1.65 paf 100: bool header_only);
1.17 paf 101:
1.61 paf 102: /// executes ops
1.89 parser 103: void execute(const Array& ops); // execute.C
1.40 paf 104:
1.64 paf 105: /// compiles the file, maybe forcing it's class @a name and @a base_class.
1.46 paf 106: VStateless_class *use_file(
1.94 parser 107: const String& file_name,
108: bool ignore_class_path=false, bool fail_on_read_problem=true,
1.45 paf 109: const String *name=0,
1.46 paf 110: VStateless_class *base_class=0); // core.C
1.64 paf 111: /// compiles a @a source buffer
1.46 paf 112: VStateless_class *use_buf(
1.40 paf 113: const char *source, const char *file,
1.46 paf 114: VStateless_class *aclass=0, const String *name=0,
115: VStateless_class *base_class=0); // core.C
1.64 paf 116: /// processes any code-junction there may be inside of @a value
1.40 paf 117: Value& process(
1.33 paf 118: Value& value,
1.37 paf 119: const String *name=0,
1.38 paf 120: bool intercept_string=true); // execute.C
1.28 paf 121:
1.61 paf 122: /// appending, sure of clean string inside
1.65 paf 123: void write_no_lang(const String& astring) {
1.111 paf 124: wcontext->write(astring,
125: String::UL_CLEAN | flang&String::UL_OPTIMIZE_BIT);
1.49 paf 126: }
1.61 paf 127: /// appending string, passing language built into string being written
1.65 paf 128: void write_pass_lang(const String& astring) {
129: wcontext->write(astring, String::UL_PASS_APPENDED);
1.59 paf 130: }
1.61 paf 131: /// appending possible string, assigning untaint language
1.40 paf 132: void write_assign_lang(Value& avalue) {
1.39 paf 133: wcontext->write(avalue, flang);
1.106 parser 134: }
135: /// appending string, assigning untaint language
136: void write_assign_lang(const String& astring) {
137: wcontext->write(astring, flang);
1.22 paf 138: }
1.61 paf 139: /// appending possible string, passing language built into string being written
1.40 paf 140: void write_pass_lang(Value& avalue) {
1.65 paf 141: wcontext->write(avalue, String::UL_PASS_APPENDED);
1.49 paf 142: }
1.61 paf 143: /// appending sure value, that would be converted to clean string
1.49 paf 144: void write_no_lang(Value& avalue) {
1.111 paf 145: wcontext->write(avalue,
146: String::UL_CLEAN | flang&String::UL_OPTIMIZE_BIT);
1.55 paf 147: }
1.61 paf 148: /// appending sure value, not VString
1.55 paf 149: void write_expr_result(Value& avalue) {
150: wcontext->write(avalue);
1.40 paf 151: }
1.22 paf 152:
1.64 paf 153: /// returns relative to @a path path to @a file
1.69 paf 154: const String& relative(const char *apath, const String& relative_name);
1.61 paf 155:
1.64 paf 156: /// returns an absolute @a path to relative @a name
1.69 paf 157: const String& absolute(const String& relative_name);
1.42 paf 158:
1.80 paf 159: /// returns the mime type of 'user_file_name_cstr'
160: const String& mime_type_of(const char *user_file_name_cstr);
161:
1.117 ! paf 162: /// returns current SQL connection if any
! 163: SQL_Connection *connection(const String *source) {
! 164: if(!fconnection && source)
! 165: throw Exception(0, 0,
! 166: source,
! 167: "outside of 'connect' operator");
! 168:
! 169: return fconnection;
! 170: }
! 171:
1.17 paf 172: public:
1.22 paf 173:
1.61 paf 174: /// info from web server
1.53 paf 175: Info& info;
1.81 paf 176: /// user's post data
177: char *post_data; size_t post_size;
1.53 paf 178:
1.78 paf 179: /// operators are methods of this class
1.84 paf 180: Methoded& OP;
1.86 paf 181: /// $env:fields
1.57 paf 182: VEnv env;
1.108 paf 183: /// $status:fields
184: VStatus status;
1.86 paf 185: /// $form:elements
1.57 paf 186: VForm form;
1.90 parser 187: /// $math:constants
188: VMath math;
1.86 paf 189: /// $request:elements
1.57 paf 190: VRequest request;
1.86 paf 191: /// $response:elements
1.57 paf 192: VResponse response;
1.86 paf 193: /// $cookie:elements
1.60 paf 194: VCookie cookie;
1.70 paf 195:
1.61 paf 196: /// contexts
1.22 paf 197: Value *self, *root, *rcontext;
1.61 paf 198: /// contexts
1.22 paf 199: WContext *wcontext;
1.85 paf 200:
1.86 paf 201: /// 'MAIN' class conglomerat
1.85 paf 202: VStateless_class *main_class;
1.76 paf 203:
1.87 paf 204: /// classes configured data
205: Hash classes_conf;
206:
1.7 paf 207: private: // core data
1.6 paf 208:
1.89 parser 209: /// classes
1.6 paf 210: Hash fclasses;
1.67 paf 211:
1.89 parser 212: /// already used files to avoid cyclic uses
1.67 paf 213: Hash used_files;
1.6 paf 214:
1.89 parser 215: /// execution stack
1.7 paf 216: Stack stack;
1.89 parser 217:
218: /** endless execute(execute(... preventing counter
219: @see ANTI_ENDLESS_EXECUTE_RECOURSION
220: */
221: uint anti_endless_execute_recoursion;
1.105 parser 222:
223: /// stack trace
224: Stack trace;
1.99 parser 225:
1.7 paf 226: private: // compile.C
227:
1.46 paf 228: VStateless_class& real_compile(COMPILE_PARAMS);
1.7 paf 229:
230: private: // execute.C
231:
1.116 paf 232: const String *execute_method(Value& aself, const Method& method,
233: bool return_cstr);
234: const String& execute_method(VMethodFrame& amethodFrame, const Method& method);
235: const String *execute_virtual_method(Value& aself, const String& method_name);
1.93 parser 236: const String *execute_nonvirtual_method(VStateless_class& aclass,
1.116 paf 237: const String& method_name,
238: bool return_cstr);
1.9 paf 239:
240: Value *get_element();
1.22 paf 241:
1.58 paf 242: private: // defaults
243:
1.111 paf 244: const uchar fdefault_lang;
1.68 paf 245: Value *default_content_type;
1.80 paf 246:
247: private: // mime types
248:
249: /// $MAIN:MIME-TYPES
250: Table *mime_types;
1.22 paf 251:
1.39 paf 252: private: // lang manipulation
1.22 paf 253:
1.111 paf 254: uchar set_lang(uchar alang) {
255: uchar result=flang;
1.39 paf 256: flang=alang;
257: return result;
258: }
1.111 paf 259: void restore_lang(uchar alang) {
1.39 paf 260: flang=alang;
261: }
262:
1.117 ! paf 263: private: // lang&raw
! 264:
! 265: uchar flang;
! 266:
! 267:
! 268: private: // connection manipulation
! 269:
! 270: SQL_Connection *set_connection(SQL_Connection *aconnection) {
! 271: SQL_Connection *result=fconnection;
! 272: fconnection=aconnection;
! 273: return result;
! 274: }
! 275: void restore_connection(SQL_Connection *aconnection) {
! 276: fconnection=aconnection;
! 277: }
! 278:
! 279: private:
! 280:
! 281: /// connection
! 282: SQL_Connection *fconnection;
! 283:
! 284:
1.59 paf 285: private:
286:
1.75 paf 287: void output_result(const VFile& body_file, bool header_only);
1.39 paf 288: };
289:
1.61 paf 290: /// Auto-object used for temporary changing Request::flang.
1.39 paf 291: class Temp_lang {
292: Request& frequest;
1.111 paf 293: uchar saved_lang;
1.39 paf 294: public:
1.111 paf 295: Temp_lang(Request& arequest, uchar alang) :
1.39 paf 296: frequest(arequest),
297: saved_lang(arequest.set_lang(alang)) {
298: }
299: ~Temp_lang() {
300: frequest.restore_lang(saved_lang);
1.117 ! paf 301: }
! 302: };
! 303:
! 304: /// Auto-object used for temporary changing Request::fconnection.
! 305: class Temp_connection {
! 306: Request& frequest;
! 307: SQL_Connection *saved_connection;
! 308: public:
! 309: Temp_connection(Request& arequest, SQL_Connection *aconnection) :
! 310: frequest(arequest),
! 311: saved_connection(arequest.set_connection(aconnection)) {
! 312: }
! 313: ~Temp_connection() {
! 314: frequest.restore_connection(saved_connection);
1.39 paf 315: }
1.91 parser 316: };
317:
318: /**
319: @b method parameters passed in this array.
320: contains handy typecast ad junction/not junction ensurers
321:
322: */
323: class MethodParams : public Array {
324: public:
325: MethodParams(Pool& pool, const String& amethod_name) : Array(pool),
326: fmethod_name(amethod_name) {
327: }
328:
329: /// handy typecast. I long for templates
330: Value& get(int index) {
331: return *static_cast<Value *>(Array::get(index));
332: }
333: /// handy is-value-a-junction ensurer
334: Value& as_junction(int index, const char *msg) {
335: return get_as(index, true, msg);
336: }
337: /// handy value-is-not-a-junction ensurer
338: Value& as_no_junction(int index, const char *msg) {
339: return get_as(index, false, msg);
340: }
341: /// handy expression auto-processing to double
1.102 parser 342: double as_double(int index, const char *msg, Request& r) {
343: return get_processed(index, msg, r).as_double();
1.91 parser 344: }
345: /// handy expression auto-processing to int
1.102 parser 346: int as_int(int index, const char *msg, Request& r) {
347: return get_processed(index, msg, r).as_int();
1.103 parser 348: }
349: /// handy expression auto-processing to bool
350: bool as_bool(int index, const char *msg, Request& r) {
351: return get_processed(index, msg, r).as_bool();
1.91 parser 352: }
353: /// handy string ensurer
354: const String& as_string(int index, const char *msg) {
355: return as_no_junction(index, msg).as_string();
356: }
357:
358: private:
359:
360: /// handy value-is/not-a-junction ensurer
361: Value& get_as(int index, bool as_junction, const char *msg) {
362: Value& result=get(index);
363: if((result.get_junction()!=0) ^ as_junction)
1.104 parser 364: throw Exception(0, 0,
1.91 parser 365: &fmethod_name,
366: "%s (parameter #%d)", msg, 1+index);
1.104 parser 367:
1.91 parser 368: return result;
369: }
370:
1.102 parser 371: Value& get_processed(int index, const char *msg, Request& r) {
372: return r.process(as_junction(index, msg),
1.91 parser 373: 0/*no name*/,
374: false/*don't intercept string*/);
375: }
376:
377: private:
378:
379: const String& fmethod_name;
380:
1.4 paf 381: };
1.1 paf 382:
383: #endif
E-mail:
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to pa_request.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [parser3project] / parser3 / src / include