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

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.56    ! parser      7:        $Id: file.C,v 1.55 2001/09/26 10:32:25 parser 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.48      parser    123:        char *user_file_name=params->size()>2?params->get(2).as_string().cstr()
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.36      paf       163: /// @todo fix `` in perl - they produced flipping consoles and no output to perl
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);
                    173:        #define PASS(key) \
                    174:                String key(pool); \
                    175:                if(const char *value=SAPI::get_env(pool, #key)) { \
                    176:                        key.APPEND_CONST(value); \
                    177:                        env.put(String(pool, #key), &key); \
                    178:                }
                    179:        #define INFO(key, value) \
                    180:                String value(pool); \
                    181:                if(r.info.value) { \
                    182:                        value.APPEND_CONST(r.info.value); \
                    183:                        env.put(String(pool, key), &value); \
                    184:                }
                    185: 
                    186:        // const
                    187:        String gateway_interface(pool, "CGI/1.1");
                    188:        env.put(String(pool, "GATEWAY_INTERFACE"), &gateway_interface);
                    189:        // from Request.info
                    190:        INFO("DOCUMENT_ROOT", document_root);
                    191:        INFO("PATH_TRANSLATED", path_translated);
                    192:        INFO("SERVER_PROTOCOL", method);
                    193:        INFO("QUERY_STRING", query_string);
                    194:        INFO("REQUEST_URI", uri);
                    195:        INFO("CONTENT_TYPE", content_type);
                    196:        char content_length_cstr[MAX_NUMBER];  
                    197:        snprintf(content_length_cstr, MAX_NUMBER, "%u", r.info.content_length);
                    198:        String content_length(pool, content_length_cstr);
                    199:        env.put(String(pool, "CONTENT_LENGTH"), &content_length);
                    200:        INFO("HTTP_COOKIE", cookie);
                    201:        INFO("HTTP_USER_AGENT", user_agent);
                    202:        // passing some SAPI:get_env-s
                    203:        PASS(SERVER_NAME);
                    204:        PASS(SERVER_PORT);
                    205:        PASS(HTTP_REFERER);
                    206:        PASS(REMOTE_ADDR);
                    207:        PASS(REMOTE_HOST);
                    208:        PASS(REMOTE_USER);
                    209:        // SCRIPT_NAME
                    210:        env.put(String(pool, "SCRIPT_NAME"), &script_name);
1.27      paf       211: #ifdef WIN32
                    212:        // WIN32 shell
                    213:        PASS(COMSPEC);
                    214: #endif
1.23      paf       215: 
1.21      paf       216:        if(params->size()>1) {
1.39      parser    217:                Value& venv=params->as_no_junction(1, "env must not be code");
1.23      paf       218:                if(Hash *user_env=venv.get_hash())
                    219:                        user_env->for_each(append_env_pair, &env);
1.21      paf       220:        }
                    221: 
                    222:        Array *argv=0;
                    223:        if(params->size()>2) {
                    224:                argv=new(pool) Array(pool, params->size()-2);
                    225:                for(int i=2; i<params->size(); i++)
1.26      paf       226:                        *argv+=&params->get(i).as_string();
1.21      paf       227:        }
                    228: 
                    229:        const String in(pool, r.post_data, r.post_size);
                    230:        String out(pool);
1.31      paf       231:        //out.APPEND_CONST("content-type:text/plain\nheader:test-header\n\ntest-body");
                    232:        //out<<in;
1.27      paf       233:        String& err=*new(pool) String(pool);
1.42      parser    234:        int status=pa_exec(script_name, &env, argv, in, out, err);
1.21      paf       235: 
                    236:        VFile& self=*static_cast<VFile *>(r.self);
                    237: 
1.41      parser    238:        const String *body=&out; // ^file:exec
                    239:        if(cgi) { // ^file:cgi
                    240:                // construct with 'out' body and header
                    241:                int delim_size;
                    242:                const char *eol_marker="\r\n"; size_t eol_marker_size=2;
                    243:                int pos=out.pos("\r\n\r\n", delim_size=4);
                    244:                if(pos<0) {
                    245:                        eol_marker="\n"; eol_marker_size=1;
                    246:                        pos=out.pos("\n\n", delim_size=2);
                    247:                }
                    248:                if(pos<0) {
                    249:                        delim_size=0; // calm down, compiler
                    250:                        PTHROW(0, 0,
                    251:                                &method_name,
1.46      parser    252:                                "output does not contain CGI header; exit code=%d; outsize=%u; out: \"%s\"; errsize=%u; err: \"%s\"", 
                    253:                                        status, 
                    254:                                        (uint)out.size(), out.cstr(),
                    255:                                        (uint)err.size(), err.cstr());
1.41      parser    256:                }
1.21      paf       257: 
1.41      parser    258:                const String& header=out.mid(0, pos);
                    259:                body=&out.mid(pos+delim_size, out.size());
1.30      paf       260: 
1.41      parser    261:                // header to $fields
                    262:                {
                    263:                        Array rows(pool);
                    264:                        header.split(rows, 0, eol_marker, eol_marker_size, String::UL_CLEAN);
                    265:                        rows.for_each(pass_cgi_header_attribute, &self.fields());
                    266:                }
1.29      paf       267:        }
1.41      parser    268:        // body
                    269:        self.set(false/*not tainted*/, body->cstr(String::UL_AS_IS), body->size());
1.21      paf       270: 
1.42      parser    271:        // $status
1.21      paf       272:        self.fields().put(
1.42      parser    273:                *new(pool) String(pool, "status"),
                    274:                new(pool) VInt(pool, status));
1.21      paf       275:        
                    276:        // $stderr
                    277:        if(err.size()) {
                    278:                self.fields().put(
                    279:                        *new(pool) String(pool, "stderr"),
                    280:                        new(pool) VString(err));
                    281: 
1.44      parser    282:                SAPI::log(pool, "file:%s: %s", cgi?"cgi":"exec", err.cstr());
1.21      paf       283:        }
                    284: }
1.41      parser    285: static void _exec(Request& r, const String& method_name, MethodParams *params) {
                    286:        _exec_cgi(r, method_name, params, false);
                    287: }
                    288: static void _cgi(Request& r, const String& method_name, MethodParams *params) {
                    289:        _exec_cgi(r, method_name, params, true);
                    290: }
                    291: 
1.47      parser    292: static void _list(Request& r, const String& method_name, MethodParams *params) {
                    293:        Pool& pool=r.pool();
                    294: 
                    295:        Value& relative_path=params->as_no_junction(0, "path must not be code");
                    296: 
                    297:        const String *regexp;
                    298:        pcre *regexp_code;
                    299:        int ovecsize;
                    300:        int *ovector;
                    301:        if(params->size()>1) {
                    302:                regexp=&params->as_no_junction(1, "regexp must not be code").as_string();
                    303: 
                    304:                const char *pattern=regexp->cstr(String::UL_AS_IS);
                    305:                const char *errptr;
                    306:                int erroffset;
                    307:                regexp_code=pcre_compile(pattern, PCRE_EXTRA | PCRE_DOTALL, 
                    308:                        &errptr, &erroffset, 
1.56    ! parser    309:                        r.pcre_tables());
1.47      parser    310: 
                    311:                if(!regexp_code)
                    312:                        PTHROW(0, 0, 
                    313:                                &regexp->mid(erroffset, regexp->size()), 
                    314:                                "regular expression syntax error - %s", errptr);
                    315: 
1.50      parser    316:                ovector=(int *)pool.malloc(sizeof(int)*(ovecsize=(1/*match*/)*3));
1.47      parser    317:        } else 
                    318:                regexp_code=0;
                    319: 
                    320: 
                    321:        const char* absolute_path_cstr=r.absolute(relative_path.as_string())
1.53      parser    322:                .cstr(String::UL_FILE_SPEC);
1.47      parser    323: 
                    324:        Array& columns=*new(pool) Array(pool);
                    325:        columns+=new(pool) String(pool, "name");        
                    326:        Table& table=*new(pool) Table(pool, &method_name, &columns);
                    327: 
                    328:        LOAD_DIR(absolute_path_cstr, 
                    329:                size_t file_name_size=strlen(ffblk.ff_name);
                    330:                bool suits=true;
                    331:                if(regexp_code) {
                    332:                        int exec_result=pcre_exec(regexp_code, 0, 
                    333:                                ffblk.ff_name, file_name_size, 0, 
                    334:                                0, ovector, ovecsize);
                    335:                        
                    336:                        if(exec_result==PCRE_ERROR_NOMATCH)
                    337:                                suits=false;
                    338:                        else if(exec_result<0) {
                    339:                                (*pcre_free)(regexp_code);
                    340:                                PTHROW(0, 0, 
                    341:                                        regexp, 
                    342:                                        "regular expression execute (%d)", 
                    343:                                                exec_result);
                    344:                        }
                    345:                }
                    346: 
                    347:                if(suits) {
1.50      parser    348:                        char *file_name_cstr=(char *)pool.malloc(file_name_size);
1.47      parser    349:                        memcpy(file_name_cstr, ffblk.ff_name, file_name_size);
                    350:                        String &file_name=*new(pool) String(pool);
1.53      parser    351:                        file_name.APPEND(file_name_cstr, file_name_size, String::UL_FILE_SPEC, 
1.47      parser    352:                                method_name.origin().file, method_name.origin().line);
                    353:                
                    354:                        Array& row=*new(pool) Array(pool);
                    355:                        row+=&file_name;
                    356:                        table+=&row;
                    357:                }
                    358:        );
                    359: 
                    360:        if(regexp_code)
                    361:                (*pcre_free)(regexp_code);
                    362: 
                    363:        VTable& result=*new(pool) VTable(pool, &table);
                    364:        result.set_name(method_name);
                    365:        r.write_no_lang(result);
                    366: }
1.21      paf       367: 
1.32      paf       368: // constructor
                    369: 
                    370: MFile::MFile(Pool& apool) : Methoded(apool) {
                    371:        set_name(*NEW String(pool(), FILE_CLASS_NAME));
                    372: 
1.1       paf       373: 
1.48      parser    374:        // ^save[mode;file-name]
                    375:        add_native_method("save", Method::CT_DYNAMIC, _save, 2, 2);
1.7       paf       376: 
                    377:        // ^delete[file-name]
1.32      paf       378:        add_native_method("delete", Method::CT_STATIC, _delete, 1, 1);
1.45      parser    379: 
                    380:        // ^move[from-file-name;to-file-name]
                    381:        add_native_method("move", Method::CT_STATIC, _move, 2, 2);
1.8       paf       382: 
                    383:        // ^find[file-name]
                    384:        // ^find[file-name]{when-not-found}
1.32      paf       385:        add_native_method("find", Method::CT_STATIC, _find, 1, 2);
1.9       paf       386: 
1.48      parser    387:        // ^load[mode;disk-name]
                    388:        // ^load[mode;disk-name;user-name]
                    389:        add_native_method("load", Method::CT_DYNAMIC, _load, 2, 3);
1.25      paf       390: 
                    391:        // ^stat[disk-name]
1.32      paf       392:        add_native_method("stat", Method::CT_DYNAMIC, _stat, 1, 1);
1.21      paf       393: 
1.36      paf       394:        // ^cgi[file-name]
                    395:        // ^cgi[file-name;env hash]
                    396:        // ^cgi[file-name;env hash;1cmd;2line;3ar;4g;5s]
1.41      parser    397:        add_native_method("cgi", Method::CT_DYNAMIC, _cgi, 1, 2+10);
                    398: 
                    399:        // ^exec[file-name]
                    400:        // ^exec[file-name;env hash]
                    401:        // ^exec[file-name;env hash;1cmd;2line;3ar;4g;5s]
                    402:        add_native_method("exec", Method::CT_DYNAMIC, _exec, 1, 2+10);
1.47      parser    403: 
                    404:        // ^file:list[path]
                    405:        // ^file:list[path][regexp]
                    406:        add_native_method("list", Method::CT_STATIC, _list, 1, 2);
                    407: 
1.32      paf       408: }
                    409: 
                    410: // global variable
                    411: 
                    412: Methoded *file_class;
                    413: 
                    414: // creator
                    415: 
                    416: Methoded *MFile_create(Pool& pool) {
                    417:        return file_class=new(pool) MFile(pool);
1.1       paf       418: }

E-mail: