Annotation of parser3/src/classes/file.C, revision 1.75

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