Annotation of parser3/src/include/pa_request.h, revision 1.116
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.116 ! paf 7: $Id: pa_request.h,v 1.115 2001/12/15 21:28:19 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.1 paf 57: public:
1.112 paf 58:
59: #ifdef RESOURCES_DEBUG
60: /// measures
61: double sql_connect_time;
62: double sql_request_time;
63: #endif
1.61 paf 64:
65: /// some information from web server
1.65 paf 66: class Info {
67: public:
1.53 paf 68: const char *document_root;
69: const char *path_translated;
1.56 paf 70: const char *method;
1.53 paf 71: const char *query_string;
1.56 paf 72: const char *uri;
1.53 paf 73: const char *content_type;
74: size_t content_length;
1.60 paf 75: const char *cookie;
1.71 paf 76: const char *user_agent;
1.53 paf 77: };
78:
1.50 paf 79: Request(Pool& apool,
1.53 paf 80: Info& ainfo,
1.111 paf 81: uchar adefault_lang, ///< all tainted data default untainting lang
1.110 paf 82: bool status_allowed ///< status class allowed
1.50 paf 83: );
1.3 paf 84: ~Request() {}
1.1 paf 85:
1.61 paf 86: /// global classes
1.6 paf 87: Hash& classes() { return fclasses; }
88:
1.65 paf 89: /**
90: core request processing
91:
92: BEWARE: may throw exception to you: catch it!
93: */
94: void core(
1.95 parser 95: const char *root_config_filespec, ///< system config filespec
96: bool root_config_fail_on_read_problem, ///< fail if system config file not found
97: const char *site_config_filespec, ///< site config filespec
98: bool site_config_fail_on_read_problem, ///< fail if site config file not found
1.65 paf 99: bool header_only);
1.17 paf 100:
1.61 paf 101: /// executes ops
1.89 parser 102: void execute(const Array& ops); // execute.C
1.40 paf 103:
1.64 paf 104: /// compiles the file, maybe forcing it's class @a name and @a base_class.
1.46 paf 105: VStateless_class *use_file(
1.94 parser 106: const String& file_name,
107: bool ignore_class_path=false, bool fail_on_read_problem=true,
1.45 paf 108: const String *name=0,
1.46 paf 109: VStateless_class *base_class=0); // core.C
1.64 paf 110: /// compiles a @a source buffer
1.46 paf 111: VStateless_class *use_buf(
1.40 paf 112: const char *source, const char *file,
1.46 paf 113: VStateless_class *aclass=0, const String *name=0,
114: VStateless_class *base_class=0); // core.C
1.64 paf 115: /// processes any code-junction there may be inside of @a value
1.40 paf 116: Value& process(
1.33 paf 117: Value& value,
1.37 paf 118: const String *name=0,
1.38 paf 119: bool intercept_string=true); // execute.C
1.28 paf 120:
1.61 paf 121: /// appending, sure of clean string inside
1.65 paf 122: void write_no_lang(const String& astring) {
1.111 paf 123: wcontext->write(astring,
124: String::UL_CLEAN | flang&String::UL_OPTIMIZE_BIT);
1.49 paf 125: }
1.61 paf 126: /// appending string, passing language built into string being written
1.65 paf 127: void write_pass_lang(const String& astring) {
128: wcontext->write(astring, String::UL_PASS_APPENDED);
1.59 paf 129: }
1.61 paf 130: /// appending possible string, assigning untaint language
1.40 paf 131: void write_assign_lang(Value& avalue) {
1.39 paf 132: wcontext->write(avalue, flang);
1.106 parser 133: }
134: /// appending string, assigning untaint language
135: void write_assign_lang(const String& astring) {
136: wcontext->write(astring, flang);
1.22 paf 137: }
1.61 paf 138: /// appending possible string, passing language built into string being written
1.40 paf 139: void write_pass_lang(Value& avalue) {
1.65 paf 140: wcontext->write(avalue, String::UL_PASS_APPENDED);
1.49 paf 141: }
1.61 paf 142: /// appending sure value, that would be converted to clean string
1.49 paf 143: void write_no_lang(Value& avalue) {
1.111 paf 144: wcontext->write(avalue,
145: String::UL_CLEAN | flang&String::UL_OPTIMIZE_BIT);
1.55 paf 146: }
1.61 paf 147: /// appending sure value, not VString
1.55 paf 148: void write_expr_result(Value& avalue) {
149: wcontext->write(avalue);
1.40 paf 150: }
1.22 paf 151:
1.64 paf 152: /// returns relative to @a path path to @a file
1.69 paf 153: const String& relative(const char *apath, const String& relative_name);
1.61 paf 154:
1.64 paf 155: /// returns an absolute @a path to relative @a name
1.69 paf 156: const String& absolute(const String& relative_name);
1.42 paf 157:
1.80 paf 158: /// returns the mime type of 'user_file_name_cstr'
159: const String& mime_type_of(const char *user_file_name_cstr);
160:
1.17 paf 161: public:
1.22 paf 162:
1.61 paf 163: /// info from web server
1.53 paf 164: Info& info;
1.81 paf 165: /// user's post data
166: char *post_data; size_t post_size;
1.53 paf 167:
1.78 paf 168: /// operators are methods of this class
1.84 paf 169: Methoded& OP;
1.86 paf 170: /// $env:fields
1.57 paf 171: VEnv env;
1.108 paf 172: /// $status:fields
173: VStatus status;
1.86 paf 174: /// $form:elements
1.57 paf 175: VForm form;
1.90 parser 176: /// $math:constants
177: VMath math;
1.86 paf 178: /// $request:elements
1.57 paf 179: VRequest request;
1.86 paf 180: /// $response:elements
1.57 paf 181: VResponse response;
1.86 paf 182: /// $cookie:elements
1.60 paf 183: VCookie cookie;
1.70 paf 184:
1.61 paf 185: /// contexts
1.22 paf 186: Value *self, *root, *rcontext;
1.61 paf 187: /// contexts
1.22 paf 188: WContext *wcontext;
1.85 paf 189:
1.86 paf 190: /// 'MAIN' class conglomerat
1.85 paf 191: VStateless_class *main_class;
1.76 paf 192:
193: /// connection
1.77 paf 194: SQL_Connection *connection;
1.87 paf 195:
196: /// classes configured data
197: Hash classes_conf;
198:
1.7 paf 199: private: // core data
1.6 paf 200:
1.89 parser 201: /// classes
1.6 paf 202: Hash fclasses;
1.67 paf 203:
1.89 parser 204: /// already used files to avoid cyclic uses
1.67 paf 205: Hash used_files;
1.6 paf 206:
1.89 parser 207: /// execution stack
1.7 paf 208: Stack stack;
1.89 parser 209:
210: /** endless execute(execute(... preventing counter
211: @see ANTI_ENDLESS_EXECUTE_RECOURSION
212: */
213: uint anti_endless_execute_recoursion;
1.105 parser 214:
215: /// stack trace
216: Stack trace;
1.99 parser 217:
1.7 paf 218: private: // compile.C
219:
1.46 paf 220: VStateless_class& real_compile(COMPILE_PARAMS);
1.7 paf 221:
222: private: // execute.C
223:
1.116 ! paf 224: const String *execute_method(Value& aself, const Method& method,
! 225: bool return_cstr);
! 226: const String& execute_method(VMethodFrame& amethodFrame, const Method& method);
! 227: const String *execute_virtual_method(Value& aself, const String& method_name);
1.93 parser 228: const String *execute_nonvirtual_method(VStateless_class& aclass,
1.116 ! paf 229: const String& method_name,
! 230: bool return_cstr);
1.9 paf 231:
232: Value *get_element();
1.22 paf 233:
234: private: // lang&raw
235:
1.111 paf 236: uchar flang;
1.58 paf 237:
238: private: // defaults
239:
1.111 paf 240: const uchar fdefault_lang;
1.68 paf 241: Value *default_content_type;
1.80 paf 242:
243: private: // mime types
244:
245: /// $MAIN:MIME-TYPES
246: Table *mime_types;
1.22 paf 247:
1.39 paf 248: private: // lang manipulation
1.22 paf 249:
1.111 paf 250: uchar set_lang(uchar alang) {
251: uchar result=flang;
1.39 paf 252: flang=alang;
253: return result;
254: }
1.111 paf 255: void restore_lang(uchar alang) {
1.39 paf 256: flang=alang;
257: }
258:
1.59 paf 259: private:
260:
1.75 paf 261: void output_result(const VFile& body_file, bool header_only);
1.39 paf 262: };
263:
1.61 paf 264: /// Auto-object used for temporary changing Request::flang.
1.39 paf 265: class Temp_lang {
266: Request& frequest;
1.111 paf 267: uchar saved_lang;
1.39 paf 268: public:
1.111 paf 269: Temp_lang(Request& arequest, uchar alang) :
1.39 paf 270: frequest(arequest),
271: saved_lang(arequest.set_lang(alang)) {
272: }
273: ~Temp_lang() {
274: frequest.restore_lang(saved_lang);
275: }
1.91 parser 276: };
277:
278: /**
279: @b method parameters passed in this array.
280: contains handy typecast ad junction/not junction ensurers
281:
282: */
283: class MethodParams : public Array {
284: public:
285: MethodParams(Pool& pool, const String& amethod_name) : Array(pool),
286: fmethod_name(amethod_name) {
287: }
288:
289: /// handy typecast. I long for templates
290: Value& get(int index) {
291: return *static_cast<Value *>(Array::get(index));
292: }
293: /// handy is-value-a-junction ensurer
294: Value& as_junction(int index, const char *msg) {
295: return get_as(index, true, msg);
296: }
297: /// handy value-is-not-a-junction ensurer
298: Value& as_no_junction(int index, const char *msg) {
299: return get_as(index, false, msg);
300: }
301: /// handy expression auto-processing to double
1.102 parser 302: double as_double(int index, const char *msg, Request& r) {
303: return get_processed(index, msg, r).as_double();
1.91 parser 304: }
305: /// handy expression auto-processing to int
1.102 parser 306: int as_int(int index, const char *msg, Request& r) {
307: return get_processed(index, msg, r).as_int();
1.103 parser 308: }
309: /// handy expression auto-processing to bool
310: bool as_bool(int index, const char *msg, Request& r) {
311: return get_processed(index, msg, r).as_bool();
1.91 parser 312: }
313: /// handy string ensurer
314: const String& as_string(int index, const char *msg) {
315: return as_no_junction(index, msg).as_string();
316: }
317:
318: private:
319:
320: /// handy value-is/not-a-junction ensurer
321: Value& get_as(int index, bool as_junction, const char *msg) {
322: Value& result=get(index);
323: if((result.get_junction()!=0) ^ as_junction)
1.104 parser 324: throw Exception(0, 0,
1.91 parser 325: &fmethod_name,
326: "%s (parameter #%d)", msg, 1+index);
1.104 parser 327:
1.91 parser 328: return result;
329: }
330:
1.102 parser 331: Value& get_processed(int index, const char *msg, Request& r) {
332: return r.process(as_junction(index, msg),
1.91 parser 333: 0/*no name*/,
334: false/*don't intercept string*/);
335: }
336:
337: private:
338:
339: const String& fmethod_name;
340:
1.4 paf 341: };
1.1 paf 342:
343: #endif
E-mail: