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