Annotation of parser3/src/classes/file.C, revision 1.88
1.17 paf 1: /** @file
2: Parser: @b file parser class.
3:
1.71 paf 4: Copyright (c) 2001, 2002 ArtLebedev Group (http://www.artlebedev.com)
1.72 paf 5: Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
1.17 paf 6:
1.88 ! paf 7: $Id: file.C,v 1.87 2002/06/18 14:22:45 paf Exp $
1.1 paf 8: */
1.47 parser 9:
10: #include "pa_config_includes.h"
11:
12: #include "pcre.h"
1.1 paf 13:
1.35 paf 14: #include "classes.h"
1.1 paf 15: #include "pa_request.h"
16: #include "pa_vfile.h"
1.11 paf 17: #include "pa_table.h"
1.21 paf 18: #include "pa_vint.h"
1.24 paf 19: #include "pa_exec.h"
1.40 parser 20: #include "pa_vdate.h"
1.47 parser 21: #include "pa_dir.h"
22: #include "pa_vtable.h"
1.67 paf 23: #include "pa_charset.h"
1.1 paf 24:
1.32 paf 25: // defines
26:
1.48 parser 27: #define TEXT_MODE_NAME "text"
28:
1.83 paf 29: // consts
30:
31: /// from apache-1.3|src|support|suexec.c
32: static const char *suexec_safe_env_lst[]={
33: "AUTH_TYPE",
34: "CONTENT_LENGTH",
35: "CONTENT_TYPE",
36: "DATE_GMT",
37: "DATE_LOCAL",
38: "DOCUMENT_NAME",
39: "DOCUMENT_PATH_INFO",
40: "DOCUMENT_ROOT",
41: "DOCUMENT_URI",
42: "FILEPATH_INFO",
43: "GATEWAY_INTERFACE",
44: "LAST_MODIFIED",
45: "PATH_INFO",
46: "PATH_TRANSLATED",
47: "QUERY_STRING",
48: "QUERY_STRING_UNESCAPED",
49: "REMOTE_ADDR",
50: "REMOTE_HOST",
51: "REMOTE_IDENT",
52: "REMOTE_PORT",
53: "REMOTE_USER",
54: "REDIRECT_QUERY_STRING",
55: "REDIRECT_STATUS",
56: "REDIRECT_URL",
57: "REQUEST_METHOD",
58: "REQUEST_URI",
59: "SCRIPT_FILENAME",
60: "SCRIPT_NAME",
61: "SCRIPT_URI",
62: "SCRIPT_URL",
63: "SERVER_ADMIN",
64: "SERVER_NAME",
65: "SERVER_ADDR",
66: "SERVER_PORT",
67: "SERVER_PROTOCOL",
68: "SERVER_SOFTWARE",
69: "UNIQUE_ID",
70: "USER_NAME",
71: "TZ",
72: NULL
73: };
74:
1.32 paf 75: // class
76:
77: class MFile : public Methoded {
78: public: // VStateless_class
79:
80: Value *create_new_value(Pool& pool) { return new(pool) VFile(pool); }
81:
1.33 paf 82: public: // Methoded
83: bool used_directly() { return true; }
84:
1.32 paf 85: public:
86: MFile(Pool& pool);
1.33 paf 87:
1.32 paf 88: };
89:
1.9 paf 90: // consts
91:
92: const int FIND_MONKEY_MAX_HOPS=10;
93:
1.1 paf 94: // methods
95:
1.26 paf 96: static void _save(Request& r, const String&, MethodParams *params) {
1.48 parser 97: Value& vmode_name=params-> as_no_junction(0, "mode must not be code");
1.49 parser 98: Value& vfile_name=params->as_no_junction(1, "file name must not be code");
1.4 paf 99:
1.7 paf 100: // save
1.48 parser 101: static_cast<VFile *>(r.self)->save(r.absolute(vfile_name.as_string()),
102: vmode_name.as_string()==TEXT_MODE_NAME);
1.7 paf 103: }
104:
1.26 paf 105: static void _delete(Request& r, const String&, MethodParams *params) {
1.39 parser 106: Value& vfile_name=params->as_no_junction(0, "file name must not be code");
1.7 paf 107:
108: // unlink
1.68 paf 109: file_delete(r.absolute(vfile_name.as_string()));
1.1 paf 110: }
111:
1.45 parser 112: static void _move(Request& r, const String&, MethodParams *params) {
113: Value& vfrom_file_name=params->as_no_junction(0, "from file name must not be code");
114: Value& vto_file_name=params->as_no_junction(1, "to file name must not be code");
115:
1.51 parser 116: // move
1.68 paf 117: file_move(
1.45 parser 118: r.absolute(vfrom_file_name.as_string()),
119: r.absolute(vto_file_name.as_string()));
120: }
121:
1.26 paf 122: static void _find(Request& r, const String& method_name, MethodParams *params) {
1.8 paf 123: Pool& pool=r.pool();
1.39 parser 124: Value& vfile_name=params->as_no_junction(0, "file name must not be code");
1.8 paf 125:
1.18 paf 126: const String &lfile_name=vfile_name.as_string();
1.8 paf 127:
128: // passed file name simply exists in current dir
129: if(file_readable(r.absolute(lfile_name))) {
1.76 paf 130: r.write_no_lang(lfile_name);
1.8 paf 131: return;
132: }
133:
134: // scan .. dirs for result
1.9 paf 135: for(int i=0; i<FIND_MONKEY_MAX_HOPS; i++) {
1.76 paf 136: String local_test_name(pool);
1.8 paf 137: for(int j=0; j<i; j++)
1.76 paf 138: local_test_name.APPEND_CONST("../");
139: local_test_name.append(lfile_name, String::UL_CLEAN);
140: if(file_readable(r.absolute(local_test_name))) {
141: r.write_no_lang(*new(pool) String(local_test_name));
1.8 paf 142: return;
143: }
144: }
145:
146: // not found
147: if(params->size()==2) {
1.39 parser 148: Value& not_found_code=params->as_junction(1, "not-found param must be code");
1.77 paf 149: r.write_pass_lang(r.process(not_found_code));
1.8 paf 150: }
151: }
152:
1.26 paf 153: static void _load(Request& r, const String& method_name, MethodParams *params) {
1.9 paf 154: Pool& pool=r.pool();
1.48 parser 155: Value& vmode_name=params-> as_no_junction(0, "mode must not be code");
156: Value& vfile_name=params->as_no_junction(1, "file name must not be code");
1.9 paf 157:
1.18 paf 158: const String& lfile_name=vfile_name.as_string();
1.9 paf 159:
1.12 paf 160: void *data; size_t size;
1.48 parser 161: file_read(pool, r.absolute(lfile_name), data, size,
162: vmode_name.as_string()==TEXT_MODE_NAME);
1.9 paf 163:
1.61 paf 164: char *user_file_name=params->size()>2?
165: params->as_string(2, "filename must be string").cstr(String::UL_FILE_SPEC)
1.53 parser 166: :lfile_name.cstr(String::UL_FILE_SPEC);
1.10 paf 167:
1.21 paf 168: static_cast<VFile *>(r.self)->set(true/*tainted*/, data, size,
1.52 parser 169: user_file_name, new(pool) VString(r.mime_type_of(user_file_name)));
1.9 paf 170: }
171:
1.26 paf 172: static void _stat(Request& r, const String& method_name, MethodParams *params) {
1.25 paf 173: Pool& pool=r.pool();
1.39 parser 174: Value& vfile_name=params->as_no_junction(0, "file name must not be code");
1.25 paf 175:
176: const String& lfile_name=vfile_name.as_string();
177:
1.40 parser 178: size_t size;
179: time_t atime, mtime, ctime;
180: file_stat(r.absolute(lfile_name),
181: size,
182: atime, mtime, ctime);
1.25 paf 183:
1.40 parser 184: VFile& vfile=*static_cast<VFile *>(r.self);
185: vfile.set(true/*tainted*/, 0/*no bytes*/, size);
186: Hash& ff=vfile.fields();
187: ff.put(*new(pool) String(pool, "adate"), new(pool) VDate(pool, atime));
188: ff.put(*new(pool) String(pool, "mdate"), new(pool) VDate(pool, mtime));
189: ff.put(*new(pool) String(pool, "cdate"), new(pool) VDate(pool, ctime));
1.25 paf 190: }
191:
1.83 paf 192: static bool is_safe_env_key(const char *key) {
1.88 ! paf 193: if(strncasecmp(key, "HTTP_", 5)==0)
1.83 paf 194: return true;
1.87 paf 195: if(strncasecmp(key, "CGI_", 4)==0)
1.83 paf 196: return true;
197: for(int i=0; suexec_safe_env_lst[i]; i++) {
1.87 paf 198: if(strcasecmp(key, suexec_safe_env_lst[i])==0)
1.83 paf 199: return true;
200: }
201: return false;
202: }
1.22 paf 203: static void append_env_pair(const Hash::Key& key, Hash::Val *value, void *info) {
204: Hash& hash=*static_cast<Hash *>(info);
1.85 paf 205: if(!is_safe_env_key(key.cstr()))
206: throw Exception("parser.runtime",
207: &key,
208: "not safe environment variable");
209: hash.put(key, &static_cast<Value *>(value)->as_string());
1.22 paf 210: }
1.29 paf 211: static void pass_cgi_header_attribute(Array::Item *value, void *info) {
212: String& string=*static_cast<String *>(value);
213: Hash& hash=*static_cast<Hash *>(info);
214: int colon_pos=string.pos(":", 1);
215: if(colon_pos>0)
1.30 paf 216: hash.put(string.mid(0, colon_pos),
217: new(string.pool()) VString(string.mid(colon_pos+1, string.size())));
1.29 paf 218: }
1.62 paf 219: /** @todo fix `` in perl - they produced flipping consoles and no output to perl
220: */
1.41 parser 221: static void _exec_cgi(Request& r, const String& method_name, MethodParams *params,
222: bool cgi) {
1.21 paf 223: Pool& pool=r.pool();
224:
1.39 parser 225: Value& vfile_name=params->as_no_junction(0, "file name must not be code");
1.21 paf 226:
1.23 paf 227: const String& script_name=r.absolute(vfile_name.as_string());
228:
229: Hash env(pool);
1.62 paf 230: #define ECSTR(name, value_cstr) \
231: String name##key(pool, #name); \
232: String name##value(pool); \
233: if(value_cstr) { \
234: name##value.APPEND_CONST(value_cstr); \
235: env.put(name##key, &name##value); \
1.23 paf 236: }
1.82 paf 237: // passing SAPI::environment
238: if(const char *const *pairs=SAPI::environment(pool)) {
239: while(const char *pair=*pairs++)
240: if(const char *eq_at=strchr(pair, '=')) {
241: String& key=*new(pool) String(pool, pair, eq_at-pair);
242: String& value=*new(pool) String(pool, eq_at+1);
243: env.put(key, &value);
244: }
245: }
246:
1.23 paf 247: // const
1.63 paf 248: ECSTR(GATEWAY_INTERFACE, "CGI/1.1");
1.23 paf 249: // from Request.info
1.62 paf 250: ECSTR(DOCUMENT_ROOT, r.info.document_root);
251: ECSTR(PATH_TRANSLATED, r.info.path_translated);
1.66 paf 252: ECSTR(REQUEST_METHOD, r.info.method);
1.62 paf 253: ECSTR(QUERY_STRING, r.info.query_string);
254: ECSTR(REQUEST_URI, r.info.uri);
255: ECSTR(CONTENT_TYPE, r.info.content_type);
1.23 paf 256: char content_length_cstr[MAX_NUMBER];
257: snprintf(content_length_cstr, MAX_NUMBER, "%u", r.info.content_length);
258: String content_length(pool, content_length_cstr);
1.62 paf 259: ECSTR(CONTENT_LENGTH, content_length_cstr);
1.82 paf 260: // SCRIPT_*
1.63 paf 261: env.put(*new(pool) String(pool, "SCRIPT_NAME"), &script_name);
1.82 paf 262: //env.put(*new(pool) String(pool, "SCRIPT_FILENAME"), ??&script_name);
1.23 paf 263:
1.21 paf 264: if(params->size()>1) {
1.39 parser 265: Value& venv=params->as_no_junction(1, "env must not be code");
1.60 parser 266: if(Hash *user_env=venv.get_hash(&method_name))
1.23 paf 267: user_env->for_each(append_env_pair, &env);
1.21 paf 268: }
269:
270: Array *argv=0;
271: if(params->size()>2) {
272: argv=new(pool) Array(pool, params->size()-2);
273: for(int i=2; i<params->size(); i++)
1.58 parser 274: *argv+=¶ms->as_string(i, "parameter must be string");
1.21 paf 275: }
276:
1.57 parser 277: String in(pool);
278: in.APPEND(r.post_data, r.post_size, String::UL_CLEAN, "passing post data", 0);
1.21 paf 279: String out(pool);
1.31 paf 280: //out.APPEND_CONST("content-type:text/plain\nheader:test-header\n\ntest-body");
281: //out<<in;
1.27 paf 282: String& err=*new(pool) String(pool);
1.73 paf 283: int status=pa_exec(false/*forced_allow*/, script_name, &env, argv, in, out, err);
1.21 paf 284:
285: VFile& self=*static_cast<VFile *>(r.self);
286:
1.41 parser 287: const String *body=&out; // ^file:exec
288: if(cgi) { // ^file:cgi
289: // construct with 'out' body and header
290: int delim_size;
291: const char *eol_marker="\r\n"; size_t eol_marker_size=2;
292: int pos=out.pos("\r\n\r\n", delim_size=4);
293: if(pos<0) {
294: eol_marker="\n"; eol_marker_size=1;
295: pos=out.pos("\n\n", delim_size=2);
296: }
297: if(pos<0) {
298: delim_size=0; // calm down, compiler
1.74 paf 299: throw Exception(0,
1.41 parser 300: &method_name,
1.79 paf 301: "output does not contain CGI header; exit status=%d; stdoutsize=%u; stdout: \"%s\"; stderrsize=%u; stderr: \"%s\"",
1.46 parser 302: status,
303: (uint)out.size(), out.cstr(),
304: (uint)err.size(), err.cstr());
1.41 parser 305: }
1.21 paf 306:
1.41 parser 307: const String& header=out.mid(0, pos);
308: body=&out.mid(pos+delim_size, out.size());
1.30 paf 309:
1.41 parser 310: // header to $fields
311: {
312: Array rows(pool);
313: header.split(rows, 0, eol_marker, eol_marker_size, String::UL_CLEAN);
314: rows.for_each(pass_cgi_header_attribute, &self.fields());
315: }
1.29 paf 316: }
1.41 parser 317: // body
1.64 paf 318: self.set(false/*not tainted*/, body->cstr(), body->size());
1.21 paf 319:
1.42 parser 320: // $status
1.21 paf 321: self.fields().put(
1.42 parser 322: *new(pool) String(pool, "status"),
323: new(pool) VInt(pool, status));
1.21 paf 324:
325: // $stderr
326: if(err.size()) {
327: self.fields().put(
328: *new(pool) String(pool, "stderr"),
329: new(pool) VString(err));
330:
1.44 parser 331: SAPI::log(pool, "file:%s: %s", cgi?"cgi":"exec", err.cstr());
1.21 paf 332: }
333: }
1.41 parser 334: static void _exec(Request& r, const String& method_name, MethodParams *params) {
335: _exec_cgi(r, method_name, params, false);
336: }
337: static void _cgi(Request& r, const String& method_name, MethodParams *params) {
338: _exec_cgi(r, method_name, params, true);
339: }
340:
1.47 parser 341: static void _list(Request& r, const String& method_name, MethodParams *params) {
342: Pool& pool=r.pool();
343:
344: Value& relative_path=params->as_no_junction(0, "path must not be code");
345:
346: const String *regexp;
347: pcre *regexp_code;
1.81 paf 348: const int ovecsize=(1/*match*/)*3;
349: int ovector[ovecsize];
1.47 parser 350: if(params->size()>1) {
351: regexp=¶ms->as_no_junction(1, "regexp must not be code").as_string();
352:
1.64 paf 353: const char *pattern=regexp->cstr();
1.47 parser 354: const char *errptr;
355: int erroffset;
356: regexp_code=pcre_compile(pattern, PCRE_EXTRA | PCRE_DOTALL,
357: &errptr, &erroffset,
1.67 paf 358: pool.get_client_charset().pcre_tables);
1.47 parser 359:
360: if(!regexp_code)
1.74 paf 361: throw Exception(0,
1.47 parser 362: ®exp->mid(erroffset, regexp->size()),
363: "regular expression syntax error - %s", errptr);
364: } else
365: regexp_code=0;
366:
367:
368: const char* absolute_path_cstr=r.absolute(relative_path.as_string())
1.53 parser 369: .cstr(String::UL_FILE_SPEC);
1.47 parser 370:
371: Array& columns=*new(pool) Array(pool);
372: columns+=new(pool) String(pool, "name");
373: Table& table=*new(pool) Table(pool, &method_name, &columns);
374:
375: LOAD_DIR(absolute_path_cstr,
376: size_t file_name_size=strlen(ffblk.ff_name);
377: bool suits=true;
378: if(regexp_code) {
379: int exec_result=pcre_exec(regexp_code, 0,
380: ffblk.ff_name, file_name_size, 0,
381: 0, ovector, ovecsize);
382:
383: if(exec_result==PCRE_ERROR_NOMATCH)
384: suits=false;
385: else if(exec_result<0) {
386: (*pcre_free)(regexp_code);
1.74 paf 387: throw Exception(0,
1.47 parser 388: regexp,
389: "regular expression execute (%d)",
390: exec_result);
391: }
392: }
393:
394: if(suits) {
1.50 parser 395: char *file_name_cstr=(char *)pool.malloc(file_name_size);
1.47 parser 396: memcpy(file_name_cstr, ffblk.ff_name, file_name_size);
397: String &file_name=*new(pool) String(pool);
1.53 parser 398: file_name.APPEND(file_name_cstr, file_name_size, String::UL_FILE_SPEC,
1.47 parser 399: method_name.origin().file, method_name.origin().line);
400:
401: Array& row=*new(pool) Array(pool);
402: row+=&file_name;
403: table+=&row;
404: }
405: );
406:
407: if(regexp_code)
408: (*pcre_free)(regexp_code);
409:
1.60 parser 410: // write out result
1.47 parser 411: VTable& result=*new(pool) VTable(pool, &table);
412: r.write_no_lang(result);
413: }
1.21 paf 414:
1.69 paf 415: #ifndef DOXYGEN
416: struct Lock_execute_body_info {
417: Request *r;
418: Value *body_code;
419: };
420: #endif
421: static void lock_execute_body(int , void *context) {
422: Lock_execute_body_info& info=*static_cast<Lock_execute_body_info *>(context);
423:
424: // execute body
1.78 paf 425: info.r->write_assign_lang(info.r->process(*info.body_code));
1.69 paf 426: };
427: static void _lock(Request& r, const String& method_name, MethodParams *params) {
428: const String& file_spec=r.absolute(params->as_string(0, "file name must be string"));
429: Value& body_code=params->as_junction(1, "body must be code");
430:
431: Lock_execute_body_info info={&r, &body_code};
1.70 paf 432: file_write_action_under_lock(file_spec, "lock", lock_execute_body, &info);
1.69 paf 433: }
434:
1.32 paf 435: // constructor
436:
1.80 paf 437: MFile::MFile(Pool& apool) : Methoded(apool, "file") {
1.48 parser 438: // ^save[mode;file-name]
439: add_native_method("save", Method::CT_DYNAMIC, _save, 2, 2);
1.7 paf 440:
441: // ^delete[file-name]
1.32 paf 442: add_native_method("delete", Method::CT_STATIC, _delete, 1, 1);
1.45 parser 443:
444: // ^move[from-file-name;to-file-name]
445: add_native_method("move", Method::CT_STATIC, _move, 2, 2);
1.8 paf 446:
447: // ^find[file-name]
448: // ^find[file-name]{when-not-found}
1.32 paf 449: add_native_method("find", Method::CT_STATIC, _find, 1, 2);
1.9 paf 450:
1.48 parser 451: // ^load[mode;disk-name]
452: // ^load[mode;disk-name;user-name]
453: add_native_method("load", Method::CT_DYNAMIC, _load, 2, 3);
1.25 paf 454:
455: // ^stat[disk-name]
1.32 paf 456: add_native_method("stat", Method::CT_DYNAMIC, _stat, 1, 1);
1.21 paf 457:
1.36 paf 458: // ^cgi[file-name]
459: // ^cgi[file-name;env hash]
460: // ^cgi[file-name;env hash;1cmd;2line;3ar;4g;5s]
1.41 parser 461: add_native_method("cgi", Method::CT_DYNAMIC, _cgi, 1, 2+10);
462:
463: // ^exec[file-name]
464: // ^exec[file-name;env hash]
465: // ^exec[file-name;env hash;1cmd;2line;3ar;4g;5s]
466: add_native_method("exec", Method::CT_DYNAMIC, _exec, 1, 2+10);
1.47 parser 467:
468: // ^file:list[path]
469: // ^file:list[path][regexp]
470: add_native_method("list", Method::CT_STATIC, _list, 1, 2);
1.69 paf 471:
472: // ^file:lock[path]{code}
473: add_native_method("lock", Method::CT_STATIC, _lock, 2, 2);
1.47 parser 474:
1.32 paf 475: }
476:
477: // global variable
478:
479: Methoded *file_class;
480:
481: // creator
482:
483: Methoded *MFile_create(Pool& pool) {
484: return file_class=new(pool) MFile(pool);
1.1 paf 485: }
E-mail:
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to file.C CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [parser3project] / parser3 / src / classes