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