Annotation of parser3/src/include/pa_request.h, revision 1.64.2.4
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.62 paf 5:
1.36 paf 6: Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)
1.32 paf 7:
1.64.2.4! paf 8: $Id: pa_request.h,v 1.64.2.3 2001/03/20 18:24:43 paf Exp $
1.1 paf 9: */
10:
11: #ifndef PA_REQUEST_H
12: #define PA_REQUEST_H
13:
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.48 paf 22: #include "pa_vform.h"
1.56 paf 23: #include "pa_vrequest.h"
1.57 paf 24: #include "pa_vresponse.h"
1.60 paf 25: #include "pa_vcookie.h"
1.44 paf 26:
1.7 paf 27: #ifndef NO_STRING_ORIGIN
1.40 paf 28: # define COMPILE_PARAMS \
29: const char *source, \
1.46 paf 30: VStateless_class *aclass, const String *name, \
31: VStateless_class *base_class, \
1.40 paf 32: const char *file
33: # define COMPILE(source, aclass, name, base_class, file) \
34: real_compile(source, aclass, name, base_class, file)
1.7 paf 35: #else
1.40 paf 36: # define COMPILE_PARAMS \
37: const char *source, \
1.46 paf 38: VStateless_class *aclass, const String *name, \
39: VStateless_class *base_class
1.40 paf 40: # define COMPILE(source, aclass, name, base_class, file) \
41: real_compile(source, aclass, name, base_class)
1.7 paf 42: #endif
1.4 paf 43:
1.39 paf 44: class Temp_lang;
1.1 paf 45:
1.61 paf 46: /// Main workhorse.
1.7 paf 47: class Request : public Pooled {
1.39 paf 48: friend Temp_lang;
1.1 paf 49: public:
1.61 paf 50:
51: /// some information from web server
1.64.2.3 paf 52: class Info {
53: public:
1.53 paf 54: const char *document_root;
55: const char *path_translated;
1.56 paf 56: const char *method;
1.53 paf 57: const char *query_string;
1.56 paf 58: const char *uri;
1.53 paf 59: const char *content_type;
60: size_t content_length;
1.60 paf 61: const char *cookie;
1.53 paf 62: };
63:
1.50 paf 64: Request(Pool& apool,
1.53 paf 65: Info& ainfo,
1.63 paf 66: String::Untaint_lang adefault_lang ///< all tainted data default untainting lang
1.50 paf 67: );
1.3 paf 68: ~Request() {}
1.1 paf 69:
1.61 paf 70: /// global classes
1.6 paf 71: Hash& classes() { return fclasses; }
72:
1.64.2.4! paf 73: /**
! 74: core request processing
! 75:
! 76: BEWARE: may throw exception to you: catch it!
! 77: */
! 78: void core(
1.51 paf 79: const char *sys_auto_path1,
1.64.2.4! paf 80: const char *sys_auto_path2,
! 81: bool header_only);
1.17 paf 82:
1.61 paf 83: /// executes ops
1.40 paf 84: void execute(const Array& ops);
85:
1.64 paf 86: /// compiles the file, maybe forcing it's class @a name and @a base_class.
1.46 paf 87: VStateless_class *use_file(
1.40 paf 88: const char *file, bool fail_on_read_problem=true,
1.45 paf 89: const String *name=0,
1.46 paf 90: VStateless_class *base_class=0); // core.C
1.64 paf 91: /// compiles a @a source buffer
1.46 paf 92: VStateless_class *use_buf(
1.40 paf 93: const char *source, const char *file,
1.46 paf 94: VStateless_class *aclass=0, const String *name=0,
95: VStateless_class *base_class=0); // core.C
1.64 paf 96: /// processes any code-junction there may be inside of @a value
1.40 paf 97: Value& process(
1.33 paf 98: Value& value,
1.37 paf 99: const String *name=0,
1.38 paf 100: bool intercept_string=true); // execute.C
1.28 paf 101:
1.61 paf 102: /// appending, sure of clean string inside
1.64.2.2 paf 103: void write_no_lang(const String& astring) {
1.64.2.1 paf 104: wcontext->write(astring, String::UL_NO);
1.49 paf 105: }
1.61 paf 106: /// appending string, passing language built into string being written
1.64.2.2 paf 107: void write_pass_lang(const String& astring) {
1.64.2.1 paf 108: wcontext->write(astring, String::UL_PASS_APPENDED);
1.59 paf 109: }
1.61 paf 110: /// appending possible string, assigning untaint language
1.40 paf 111: void write_assign_lang(Value& avalue) {
1.39 paf 112: wcontext->write(avalue, flang);
1.22 paf 113: }
1.61 paf 114: /// appending possible string, passing language built into string being written
1.40 paf 115: void write_pass_lang(Value& avalue) {
1.64.2.1 paf 116: wcontext->write(avalue, String::UL_PASS_APPENDED);
1.49 paf 117: }
1.61 paf 118: /// appending sure value, that would be converted to clean string
1.49 paf 119: void write_no_lang(Value& avalue) {
1.64.2.1 paf 120: wcontext->write(avalue, String::UL_NO);
1.55 paf 121: }
1.61 paf 122: /// appending sure value, not VString
1.55 paf 123: void write_expr_result(Value& avalue) {
124: wcontext->write(avalue);
1.40 paf 125: }
1.43 paf 126:
1.61 paf 127: /// handy is-value-a-junction ensurer
1.64.2.2 paf 128: void fail_if_junction_(bool is, Value& value,
129: const String& method_name, const char *msg);
1.22 paf 130:
1.64 paf 131: /// returns relative to @a path path to @a file
1.42 paf 132: char *relative(const char *path, const char *file);
1.61 paf 133:
1.64 paf 134: /// returns an absolute @a path to relative @a name
1.42 paf 135: char *absolute(const char *name);
136:
1.17 paf 137: public:
1.22 paf 138:
1.61 paf 139: /// info from web server
1.53 paf 140: Info& info;
141:
1.61 paf 142: /// default base
1.57 paf 143: VClass ROOT;
1.61 paf 144: /// $env:fields here
1.57 paf 145: VEnv env;
1.61 paf 146: /// $form:elements here
1.57 paf 147: VForm form;
1.61 paf 148: /// $request:elements here
1.57 paf 149: VRequest request;
1.61 paf 150: /// $response:
1.57 paf 151: VResponse response;
1.61 paf 152: /// $cookie:
1.60 paf 153: VCookie cookie;
1.17 paf 154:
1.61 paf 155: /// contexts
1.22 paf 156: Value *self, *root, *rcontext;
1.61 paf 157: /// contexts
1.22 paf 158: WContext *wcontext;
1.6 paf 159:
1.7 paf 160: private: // core data
1.6 paf 161:
162: // classes
163: Hash fclasses;
164:
1.7 paf 165: // execution stack
166: Stack stack;
167:
168: private: // compile.C
169:
1.46 paf 170: VStateless_class& real_compile(COMPILE_PARAMS);
1.7 paf 171:
172: private: // execute.C
173:
1.57 paf 174: const String *execute_method(Value& aself, const Method& method,
175: bool return_cstr=true);
176: const String *execute_method(Value& aself, const String& method_name,
177: bool return_cstr=true);
1.9 paf 178:
179: Value *get_element();
1.22 paf 180:
181: private: // lang&raw
182:
1.39 paf 183: String::Untaint_lang flang;
1.58 paf 184:
185: private: // defaults
186:
187: const String::Untaint_lang fdefault_lang;
188: Value *fdefault_content_type;
1.22 paf 189:
1.39 paf 190: private: // lang manipulation
1.22 paf 191:
1.39 paf 192: String::Untaint_lang set_lang(String::Untaint_lang alang) {
193: String::Untaint_lang result=flang;
194: flang=alang;
195: return result;
196: }
197: void restore_lang(String::Untaint_lang alang) {
198: flang=alang;
199: }
200:
1.59 paf 201: private:
202:
1.64.2.4! paf 203: void output_result(const String& body_string, bool header_only);
1.39 paf 204: };
205:
1.61 paf 206: /// Auto-object used for temporary changing Request::flang.
1.39 paf 207: class Temp_lang {
208: Request& frequest;
209: String::Untaint_lang saved_lang;
210: public:
211: Temp_lang(Request& arequest, String::Untaint_lang alang) :
212: frequest(arequest),
213: saved_lang(arequest.set_lang(alang)) {
214: }
215: ~Temp_lang() {
216: frequest.restore_lang(saved_lang);
217: }
1.4 paf 218: };
1.1 paf 219:
220: #endif
E-mail: