Annotation of parser3/src/include/pa_request.h, revision 1.280
1.61 paf 1: /** @file
1.62 paf 2: Parser: request class decl.
3:
1.272 moko 4: Copyright (c) 2001-2026 Art. Lebedev Studio (https://www.artlebedev.com)
1.262 moko 5: Authors: Konstantin Morshnev <moko@design.ru>, Alexandr Petrosian <paf@design.ru>
1.1 paf 6: */
7:
8: #ifndef PA_REQUEST_H
9: #define PA_REQUEST_H
1.141 paf 10:
1.280 ! moko 11: #define IDENT_PA_REQUEST_H "$Id: pa_request.h,v 1.279 2026/09/29 02:56:52 moko Exp $"
1.1 paf 12:
1.168 paf 13: #include "pa_pool.h"
1.5 paf 14: #include "pa_hash.h"
1.278 moko 15: #include "pa_file.h"
1.7 paf 16: #include "pa_wcontext.h"
1.6 paf 17: #include "pa_value.h"
1.273 moko 18: #include "pa_vhash.h"
1.7 paf 19: #include "pa_stack.h"
1.162 paf 20: #include "pa_request_info.h"
21: #include "pa_request_charsets.h"
22: #include "pa_sapi.h"
1.44 paf 23:
1.257 moko 24: // externs
25:
26: extern const String main_method_name;
27: extern const String auto_method_name;
28:
29: // defines for statics
30:
31: #define MAIN_CLASS_NAME "MAIN"
32: #define AUTO_FILE_NAME "auto.p"
33:
1.128 paf 34: // consts
35:
1.162 paf 36: const size_t pseudo_file_no__process=1;
1.128 paf 37:
1.162 paf 38: // forwards
1.4 paf 39:
1.39 paf 40: class Temp_lang;
1.84 paf 41: class Methoded;
1.116 paf 42: class VMethodFrame;
1.162 paf 43: class VMail;
44: class VForm;
45: class VResponse;
46: class VCookie;
47: class VStateless_class;
1.215 moko 48: class VConsole;
1.273 moko 49: class VException;
1.1 paf 50:
1.244 moko 51: extern int pa_loop_limit;
1.266 moko 52: extern int pa_array_limit;
1.267 moko 53: extern int pa_execute_recursion_limit;
1.257 moko 54: extern int pa_httpd_timeout;
1.244 moko 55: extern size_t pa_file_size_limit;
1.229 moko 56:
1.61 paf 57: /// Main workhorse.
1.162 paf 58: class Request: public PA_Object {
1.107 paf 59: friend class Temp_lang;
1.117 paf 60: friend class Temp_connection;
1.214 moko 61: friend class Temp_request_self;
62: friend class Temp_value_element;
1.267 moko 63: friend class Temp_recursion;
1.148 paf 64: friend class Request_context_saver;
1.162 paf 65: friend class Exception_trace;
1.273 moko 66: friend class VException;
1.162 paf 67:
1.1 paf 68: public:
1.162 paf 69: class Trace {
70: const String* fname;
71: Operation::Origin forigin;
72: public:
73: Trace(): fname(0) {}
74: void clear() { fname=0; }
75:
76: Trace(const String* aname, const Operation::Origin aorigin):
77: fname(aname), forigin(aorigin) {}
78:
79: const String* name() const { return fname; }
80: const Operation::Origin origin() const { return forigin; }
81: };
82:
1.181 paf 83: enum Skip {
84: SKIP_NOTHING,
1.245 moko 85: SKIP_CONTINUE,
1.181 paf 86: SKIP_BREAK,
1.245 moko 87: SKIP_RETURN,
88: SKIP_INTERRUPTED
1.181 paf 89: };
90:
1.168 paf 91: private:
92: Pool fpool;
93: public:
94: Pool& pool() { return fpool; }
1.162 paf 95:
96: private:
97: union StackItem {
98: Value* fvalue;
99: ArrayOperation* fops;
100: VMethodFrame* fmethod_frame;
101: public:
102: Value& value() const { return *fvalue; }
103: const String& string() const {
1.167 paf 104: return fvalue->as_string();
1.162 paf 105: }
106: ArrayOperation& ops() const { return *fops; }
107: VMethodFrame& method_frame() const { return *fmethod_frame; }
108:
1.228 moko 109: StackItem(Value& avalue): fvalue(&avalue) {}
1.162 paf 110: StackItem(ArrayOperation& aops): fops(&aops) {}
111: StackItem(VMethodFrame& amethod_frame): fmethod_frame(&amethod_frame) {}
112: };
113:
114: class Exception_trace: public Stack<Trace> {
115: size_t fbottom;
116: public:
117: Exception_trace(): fbottom(0) {}
118:
119: size_t bottom_index() { return fbottom; }
1.165 paf 120: void set_bottom_index(size_t abottom) { fbottom=abottom; }
1.162 paf 121: element_type bottom_value() { return get(bottom_index()); }
1.274 moko 122: void set_range(size_t bottom, size_t top) { fbottom=bottom; fsize=top; }
1.162 paf 123:
124: void clear() {
1.264 moko 125: fsize=fbottom=0;
1.162 paf 126: }
127:
128: bool is_empty() {
1.264 moko 129: return fsize==fbottom;
1.162 paf 130: }
1.259 moko 131:
1.275 moko 132: Table &table(Request &r, const String* problem_source) {
133: return table(r, problem_source, bottom_index(), top_index());
134: }
135: Table &table(Request &r, const String* problem_source, size_t bottom, size_t top);
1.162 paf 136: };
137:
138: ///@{ core data
139:
140: /// classes
1.270 moko 141: OrderedHashString<VStateless_class*> fclasses;
1.162 paf 142:
143: /// already used files to avoid cyclic uses
1.193 misha 144: HashString<bool> used_files;
1.200 misha 145: HashString<bool> searched_along_class_path;
1.162 paf 146: /// list of all used files, Operation::file_no = index to it
1.163 paf 147: Array<String::Body> file_list;
1.162 paf 148:
1.229 moko 149: /// endless execute(execute(... preventing counter
1.267 moko 150: int anti_endless_execute_recursion;
1.276 moko 151: int execute_recursion_limit;
152: void recursion_limit_reached();
1.162 paf 153:
154: ///@}
155:
156: /// execution stack
157: Stack<StackItem> stack;
158:
1.274 moko 159: public:
1.162 paf 160: /// exception stack trace
161: Exception_trace exception_trace;
162:
1.213 moko 163: bool allow_class_replace;
164:
1.162 paf 165: //@{ request processing status
166: /// contexts
167: VMethodFrame* method_frame;
168: Value* rcontext;
169: WContext* wcontext;
170: /// current language
1.228 moko 171: String::Language flang;
1.162 paf 172: /// current connection
173: SQL_Connection* fconnection;
174: //@}
1.245 moko 175:
176: private:
177:
178: int fin_cycle;
1.181 paf 179: Skip fskip;
1.245 moko 180: VMethodFrame* freturn_method_frame;
1.162 paf 181:
182: public:
1.175 paf 183: uint register_file(String::Body file_spec);
1.162 paf 184:
1.273 moko 185: const char* get_exception_cstr(const Exception& e, VException& details);
1.162 paf 186:
187: /// @see Stack::wipe_unused
188: void wipe_unused_execution_stack() {
189: stack.wipe_unused();
190: }
1.112 paf 191:
192: #ifdef RESOURCES_DEBUG
193: /// measures
194: double sql_connect_time;
195: double sql_request_time;
196: #endif
1.61 paf 197:
1.162 paf 198: Request(SAPI_Info& asapi_info, Request_info& arequest_info,
1.208 moko 199: String::Language adefault_lang ///< all tainted data default untainting lang
1.50 paf 200: );
1.118 paf 201: ~Request();
1.1 paf 202:
1.61 paf 203: /// global classes
1.270 moko 204: OrderedHashString<VStateless_class*>& classes() { return fclasses; }
1.224 moko 205: VStateless_class* get_class(const String& name);
1.260 moko 206: VStateless_class& get_class_ref(const String& name);
1.224 moko 207: void put_class(VStateless_class *aclass){ classes().put(aclass->type(), aclass); }
1.265 moko 208: bool add_class(const char* atype, VStateless_class *aclass);
1.6 paf 209:
1.65 paf 210: /**
211: core request processing
212: BEWARE: may throw exception to you: catch it!
213: */
1.261 moko 214: void core(const char* config_filespec, bool header_only, const String& amain_method_name = main_method_name, const String* amain_class_name = NULL);
1.17 paf 215:
1.61 paf 216: /// executes ops
1.162 paf 217: void execute(ArrayOperation& ops); // execute.C
1.239 moko 218:
219: template<typename Frame> void call(Frame& frame){
220: VMethodFrame *saved_method_frame=method_frame;
221: Value* saved_rcontext=rcontext;
222: WContext *saved_wcontext=wcontext;
223:
224: rcontext=wcontext=method_frame=&frame;
225:
226: frame.call(*this);
227:
228: wcontext=saved_wcontext;
229: rcontext=saved_rcontext;
230: method_frame=saved_method_frame;
231: }
232:
233: template<typename Frame> void call_write(Frame& frame){
234: VMethodFrame *saved_method_frame=method_frame;
235: Value* saved_rcontext=rcontext;
236:
237: rcontext=method_frame=&frame;
238:
239: frame.call(*this);
240:
241: rcontext=saved_rcontext;
242: method_frame=saved_method_frame;
243: }
244:
1.225 moko 245: Value& construct(VStateless_class &class_value, const Method &method);
1.202 moko 246:
1.267 moko 247: /// execute ops with anti-recursion check
248: void recursion_checked_execute(ArrayOperation& ops) {
1.276 moko 249: if(++anti_endless_execute_recursion>=execute_recursion_limit)
250: recursion_limit_reached();
1.147 paf 251: execute(ops); // execute it
1.267 moko 252: anti_endless_execute_recursion--;
1.128 paf 253: }
1.40 paf 254:
1.277 moko 255: /// take the recovery reserve back if recursion limit is far enough
256: void recursion_limit_try_restore() {
257: if(execute_recursion_limit>pa_execute_recursion_limit && anti_endless_execute_recursion<pa_execute_recursion_limit/2)
258: execute_recursion_limit=pa_execute_recursion_limit;
259: }
260:
1.199 misha 261: ///
1.255 moko 262: void use_file_directly(const String& file_spec, bool fail_on_file_absence=true, bool with_auto_p=false);
1.228 moko 263:
1.255 moko 264: /// compiles the file in main class context by default
265: void use_file(const String& file_name, const String* use_filespec, bool with_auto_p=false);
1.241 moko 266:
267: /// for @USE only, calls ^use (which may be user-defined)
268: void use_file(const String& file_name, const String* use_filespec, Operation::Origin origin);
1.199 misha 269:
1.64 paf 270: /// compiles a @a source buffer
1.228 moko 271: void use_buf(VStateless_class& aclass, const char* source, const String* main_alias, uint file_no, int line_no_offset=0);
1.28 paf 272:
1.129 paf 273: /// processes any code-junction there may be inside of @a value
1.227 moko 274: Value& process_getter(Junction& junction); // execute.C
1.231 moko 275: Value& process(Value& input_value); // execute.C
1.192 misha 276: void process_write(Value& input_value); // execute.C
1.228 moko 277:
1.129 paf 278: //@{ convinient helpers
279: const String& process_to_string(Value& input_value) {
1.231 moko 280: return process(input_value).as_string();
1.129 paf 281: }
1.126 paf 282: //@}
1.247 moko 283: const Operation::Origin get_method_origin(const Method* method); // execute.C
1.242 moko 284: const String* get_method_filespec(const Method* method); // execute.C
285: const String* get_used_filespec(uint file_no);
1.126 paf 286:
1.238 moko 287: /// appending string with it's languages
1.239 moko 288: inline void write(const String& astring) {
1.236 moko 289: wcontext->write(astring);
1.49 paf 290: }
1.238 moko 291:
292: /// in [] and {} appending string if get_string is not null, else appending value
1.240 moko 293: /// in () appending string if is_string, else appending value
1.239 moko 294: inline void write(Value& avalue) {
1.236 moko 295: wcontext->write_as_string(avalue);
1.131 paf 296: }
297:
1.238 moko 298: /// allways appending value
1.239 moko 299: inline void write_value(Value& avalue) {
1.226 moko 300: wcontext->write(avalue);
301: }
302:
1.64 paf 303: /// returns relative to @a path path to @a file
1.162 paf 304: const String& relative(const char* apath, const String& relative_name);
1.61 paf 305:
1.280 ! moko 306: /// '/'-normalized disk path of a file name; a uri of another scheme is returned as is if allowed, otherwise throws
1.279 moko 307: const String& full_disk_path(const String& relative_name, uint allowed=0);
1.280 ! moko 308: /// '/'-normalized full_disk_path of a real file on disk, which does not throw: 0 for a uri or a remote or invalid file:// one
1.279 moko 309: const String* real_disk_path(const String& name);
1.42 paf 310:
1.209 misha 311: /// returns the mime type of 'user_file_name'
312: const String& mime_type_of(const String* file_name);
313:
1.80 paf 314: /// returns the mime type of 'user_file_name_cstr'
1.162 paf 315: const String& mime_type_of(const char* user_file_name_cstr);
1.80 paf 316:
1.117 paf 317: /// returns current SQL connection if any
1.228 moko 318: SQL_Connection* connection(bool fail_on_error=true) {
1.162 paf 319: if(fail_on_error && !fconnection)
1.228 moko 320: throw Exception(PARSER_RUNTIME, 0, "outside of 'connect' operator");
321: return fconnection;
1.133 paf 322: }
323:
1.245 moko 324: Skip get_skip() { return fskip; }
1.181 paf 325: void set_skip(Skip askip) { fskip=askip; }
1.246 moko 326: void set_skip_return(VMethodFrame& amethod_frame) { fskip=SKIP_RETURN; freturn_method_frame=&amethod_frame; }
1.245 moko 327: inline bool check_skip_break() { bool result=fskip >= SKIP_BREAK; if(fskip <= SKIP_BREAK) fskip=SKIP_NOTHING; return result; }
328: inline void check_skip_return() { if(fskip==SKIP_RETURN && method_frame==freturn_method_frame) fskip=SKIP_NOTHING; }
1.181 paf 329:
1.196 misha 330: void set_in_cycle(int adelta) { fin_cycle+=adelta; }
331: bool get_in_cycle() { return fin_cycle>0; }
332:
1.17 paf 333: public:
1.22 paf 334:
1.61 paf 335: /// info from web server
1.162 paf 336: Request_info& request_info;
337:
338: /// info about ServerAPI
339: SAPI_Info& sapi_info;
340:
341: /// source, client, mail charsets
342: Request_charsets charsets;
1.53 paf 343:
1.154 paf 344: /// 'MAIN' class conglomerat & operators are methods of this class
1.162 paf 345: VStateless_class& main_class;
1.86 paf 346: /// $form:elements
1.162 paf 347: VForm& form;
1.140 paf 348: /// $mail
1.162 paf 349: VMail& mail;
1.86 paf 350: /// $response:elements
1.162 paf 351: VResponse& response;
1.86 paf 352: /// $cookie:elements
1.162 paf 353: VCookie& cookie;
1.183 misha 354: /// $console
355: VConsole& console;
1.70 paf 356:
1.148 paf 357: /// classes configured data
1.193 misha 358: HashString<void*> classes_conf;
1.85 paf 359:
1.148 paf 360: public: // status read methods
1.76 paf 361:
1.148 paf 362: VMethodFrame *get_method_frame() { return method_frame; }
1.162 paf 363: Value& get_self();
1.227 moko 364:
1.162 paf 365: #define GET_SELF(request, type) (static_cast<type &>(request.get_self()))
1.6 paf 366:
1.205 moko 367: /// public for ^reflection:copy[]
368: void put_element(Value& ncontext, const String& name, Value* value);
369:
1.251 moko 370: /// for @main[] and parser://method/call
371: const String* execute_method(VStateless_class& aclass, const String& method_name, Value* optional_param = 0);
1.173 paf 372:
1.251 moko 373: //{ for @conf[filespec] and @auto[filespec]
374: bool execute_method_if_exists(VStateless_class& aclass, const String& method_name, Value* optional_param);
1.263 moko 375: bool execute_auto_method_if_exists(VStateless_class& aclass, const String& method_name, Value* optional_param);
1.228 moko 376:
1.173 paf 377: //}
378:
1.162 paf 379: #ifdef XML
380: public: // charset helpers
1.67 paf 381:
1.162 paf 382: /// @see Charset::transcode
1.180 paf 383: xmlChar* transcode(const String& s);
1.162 paf 384: /// @see Charset::transcode
1.180 paf 385: xmlChar* transcode(const String::Body s);
1.162 paf 386: /// @see Charset::transcode
1.180 paf 387: const String& transcode(const xmlChar* s);
1.89 parser 388:
1.162 paf 389: #endif
1.136 paf 390:
391: private:
392:
393: /// already executed some @conf method
394: bool configure_admin_done;
395:
1.162 paf 396: void configure_admin(VStateless_class& conf_class);
1.177 paf 397:
398: void configure();
1.99 parser 399:
1.7 paf 400: private: // compile.C
401:
1.228 moko 402: ArrayClass& compile(VStateless_class* aclass, const char* source, const String* main_alias, uint file_no, int line_no_offset);
1.7 paf 403:
404: private: // execute.C
1.9 paf 405:
1.191 misha 406: Value& get_element(Value& ncontext, const String& name);
1.219 moko 407: #ifdef FEATURE_GET_ELEMENT4CALL
408: Value& get_element4call(Value& ncontext, const String& name);
409: #endif
1.22 paf 410:
1.58 paf 411: private: // defaults
412:
1.162 paf 413: const String::Language fdefault_lang;
1.80 paf 414:
415: private: // mime types
416:
417: /// $MAIN:MIME-TYPES
418: Table *mime_types;
1.22 paf 419:
1.117 paf 420: private: // connection manipulation
421:
1.162 paf 422: SQL_Connection* set_connection(SQL_Connection* aconnection) {
423: SQL_Connection* result=fconnection;
1.117 paf 424: fconnection=aconnection;
425: return result;
426: }
1.162 paf 427: void restore_connection(SQL_Connection* aconnection) {
1.117 paf 428: fconnection=aconnection;
429: }
430:
431: private:
432:
1.162 paf 433: void output_result(VFile* body_file, bool header_only, bool as_attachment);
1.148 paf 434: };
435:
1.273 moko 436: /// Hash-compatible exception; hash is built on demand.
437: class VException: public VHashReference {
438: Exception fexception;
439: String::Body ffile;
440: Value* fhandled;
1.275 moko 441: size_t ftrace_bottom, ftrace_top;
1.273 moko 442: public:
443: Operation::Origin origin;
444: const String* problem_source;
445:
446: VException(Request& r, const Exception& e);
447:
448: override HashStringValue& hash();
449: override Value* get_element(const String& name);
450: override const VJunction* put_element(const String& name, Value* value);
451:
452: Value* handled();
1.275 moko 453: Table& stack(Request& r);
454: void expire_trace() { ftrace_top=size_t(-1); }
1.273 moko 455: };
456:
1.148 paf 457: /// Auto-object used to save request context across ^try body
458: class Request_context_saver {
459: Request& fr;
460:
461: /// execution stack
1.162 paf 462: size_t stack;
1.277 moko 463: int anti_endless_execute_recursion;
1.148 paf 464: /// contexts
1.162 paf 465: VMethodFrame* method_frame;
466: Value* rcontext;
467: WContext* wcontext;
1.148 paf 468: /// current language
1.162 paf 469: String::Language flang;
1.148 paf 470: /// current connection
1.162 paf 471: SQL_Connection* fconnection;
1.126 paf 472:
1.148 paf 473: public:
1.228 moko 474: Request_context_saver(Request& ar) :
1.171 paf 475: fr(ar),
1.165 paf 476: stack(ar.stack.top_index()),
1.267 moko 477: anti_endless_execute_recursion(ar.anti_endless_execute_recursion),
1.148 paf 478: method_frame(ar.method_frame),
479: rcontext(ar.rcontext),
480: wcontext(ar.wcontext),
481: flang(ar.flang),
1.171 paf 482: fconnection(ar.fconnection) {}
1.153 paf 483: void restore() {
1.165 paf 484: fr.stack.set_top_index(stack);
1.267 moko 485: fr.anti_endless_execute_recursion=anti_endless_execute_recursion;
1.157 paf 486: fr.method_frame=method_frame, fr.rcontext=rcontext; fr.wcontext=wcontext;
1.148 paf 487: fr.flang=flang;
488: fr.fconnection=fconnection;
489: }
1.39 paf 490: };
491:
1.117 paf 492: /// Auto-object used for temporary changing Request::fconnection.
493: class Temp_connection {
494: Request& frequest;
1.162 paf 495: SQL_Connection* saved_connection;
1.117 paf 496: public:
1.228 moko 497: Temp_connection(Request& arequest, SQL_Connection* aconnection) :
1.117 paf 498: frequest(arequest),
499: saved_connection(arequest.set_connection(aconnection)) {
500: }
1.228 moko 501: ~Temp_connection() {
1.117 paf 502: frequest.restore_connection(saved_connection);
1.39 paf 503: }
1.91 parser 504: };
505:
1.196 misha 506: /// Auto-object used for break out of cycle check
507: class InCycle {
508: Request& frequest;
509: public:
510: InCycle(Request& arequest) : frequest(arequest) {
511: frequest.set_in_cycle(1);
512: }
1.228 moko 513: ~InCycle() {
1.196 misha 514: frequest.set_in_cycle(-1);
515: }
516: };
1.91 parser 517:
1.245 moko 518: /// Auto-object used for break out of cycle check
519: class TempSkip4Delimiter {
520: Request& frequest;
521: Request::Skip fskip;
522: public:
523: TempSkip4Delimiter(Request& arequest) : frequest(arequest), fskip(arequest.get_skip()) {
524: frequest.set_skip(Request::SKIP_NOTHING);
525: }
526: // returns true if break required, should be called
527: bool check_break() {
528: if(frequest.get_skip())
529: fskip=frequest.get_skip();
530: frequest.set_skip(fskip <= Request::SKIP_BREAK ? Request::SKIP_NOTHING : fskip);
531: return fskip >= Request::SKIP_BREAK;
532: }
533: };
534:
1.213 moko 535: /// Auto-object used for temporary changing Request::allow_class_replace.
536: class Temp_class_replace {
537: Request& frequest;
538: public:
539: Temp_class_replace(Request& arequest, bool avalue) : frequest(arequest){
540: frequest.allow_class_replace=avalue;
541: }
542: ~Temp_class_replace() {
543: frequest.allow_class_replace=false;
544: }
545: };
546:
1.214 moko 547: /// Auto-object used for temporarily substituting/removing elements
548: class Temp_value_element {
549: Request& frequest;
550: Value& fwhere;
551: const String& fname;
1.216 moko 552: Value* saved;
1.214 moko 553: public:
1.216 moko 554: Temp_value_element(Request& arequest, Value& awhere, const String& aname, Value* awhat);
555: ~Temp_value_element();
1.214 moko 556: };
557:
1.267 moko 558: /// Auto-object that temporarily increases recursion
559: class Temp_recursion {
560: Request& frequest;
561: public:
562: Temp_recursion(Request& arequest) : frequest(arequest){
563: frequest.anti_endless_execute_recursion++;
564: }
565: ~Temp_recursion(){
566: frequest.anti_endless_execute_recursion--;
567: }
568: };
569:
1.1 paf 570: #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