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

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

E-mail: