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

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.17      paf         5: 
1.1       paf         6:        Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)
                      7: 
1.45    ! parser      8:        $Id: file.C,v 1.44 2001/07/20 09:40:46 parser Exp $
1.1       paf         9: */
1.45    ! parser     10: static const char *RCSId="$Id: file.C,v 1.44 2001/07/20 09:40:46 parser Exp $"; 
1.1       paf        11: 
1.35      paf        12: #include "classes.h"
1.1       paf        13: #include "pa_request.h"
                     14: #include "pa_vfile.h"
1.11      paf        15: #include "pa_table.h"
1.21      paf        16: #include "pa_vint.h"
1.24      paf        17: #include "pa_exec.h"
1.40      parser     18: #include "pa_vdate.h"
1.1       paf        19: 
1.33      paf        20: // consts
                     21: 
1.32      paf        22: // defines
                     23: 
                     24: #define FILE_CLASS_NAME "file"
                     25: 
                     26: // class
                     27: 
                     28: class MFile : public Methoded {
                     29: public: // VStateless_class
                     30:        
                     31:        Value *create_new_value(Pool& pool) { return new(pool) VFile(pool); }
                     32: 
1.33      paf        33: public: // Methoded
                     34:        bool used_directly() { return true; }
                     35: 
1.32      paf        36: public:
                     37:        MFile(Pool& pool);
1.33      paf        38: 
1.32      paf        39: };
                     40: 
1.9       paf        41: // consts
                     42: 
                     43: const int FIND_MONKEY_MAX_HOPS=10;
                     44: 
1.1       paf        45: // methods
                     46: 
1.26      paf        47: static void _save(Request& r, const String&, MethodParams *params) {
1.39      parser     48:        Value& vfile_name=params->as_no_junction(0, "file name must not be code");
1.4       paf        49: 
1.7       paf        50:        // save
1.18      paf        51:        static_cast<VFile *>(r.self)->save(r.absolute(vfile_name.as_string()));
1.7       paf        52: }
                     53: 
1.26      paf        54: static void _delete(Request& r, const String&, MethodParams *params) {
1.7       paf        55:        Pool& pool=r.pool();
1.39      parser     56:        Value& vfile_name=params->as_no_junction(0, "file name must not be code");
1.7       paf        57: 
                     58:        // unlink
1.18      paf        59:        file_delete(pool, r.absolute(vfile_name.as_string()));
1.1       paf        60: }
                     61: 
1.45    ! parser     62: static void _move(Request& r, const String&, MethodParams *params) {
        !            63:        Pool& pool=r.pool();
        !            64:        Value& vfrom_file_name=params->as_no_junction(0, "from file name must not be code");
        !            65:        Value& vto_file_name=params->as_no_junction(1, "to file name must not be code");
        !            66: 
        !            67:        // unlink
        !            68:        file_move(pool, 
        !            69:                r.absolute(vfrom_file_name.as_string()),
        !            70:                r.absolute(vto_file_name.as_string()));
        !            71: }
        !            72: 
1.26      paf        73: static void _find(Request& r, const String& method_name, MethodParams *params) {
1.8       paf        74:        Pool& pool=r.pool();
1.39      parser     75:        Value& vfile_name=params->as_no_junction(0, "file name must not be code");
1.8       paf        76: 
1.18      paf        77:        const String &lfile_name=vfile_name.as_string();
1.8       paf        78: 
                     79:        // passed file name simply exists in current dir
                     80:        if(file_readable(r.absolute(lfile_name))) {
                     81:                r.write_no_lang(*new(pool) VString(lfile_name));
                     82:                return;
                     83:        }
                     84: 
                     85:        // scan .. dirs for result
1.9       paf        86:        for(int i=0; i<FIND_MONKEY_MAX_HOPS; i++) {
1.8       paf        87:                String test_name(pool);
                     88:                for(int j=0; j<i; j++)
                     89:                        test_name.APPEND_CONST("../");
1.15      paf        90:                test_name.append(lfile_name, String::UL_CLEAN);
1.8       paf        91:                if(file_readable(r.absolute(test_name))) {
                     92:                        r.write_no_lang(*new(pool) VString(*new(pool) String(test_name)));
                     93:                        return;
                     94:                }
                     95:        }
                     96: 
                     97:        // not found
                     98:        if(params->size()==2) {
1.39      parser     99:                Value& not_found_code=params->as_junction(1, "not-found param must be code");
1.8       paf       100:                r.write_pass_lang(r.process(not_found_code));
                    101:        }
                    102: }
                    103: 
1.26      paf       104: static void _load(Request& r, const String& method_name, MethodParams *params) {
1.9       paf       105:        Pool& pool=r.pool();
1.39      parser    106:        Value& vfile_name=params->as_no_junction(0, "file name must not be code");
1.9       paf       107: 
1.18      paf       108:        const String& lfile_name=vfile_name.as_string();
1.9       paf       109: 
1.12      paf       110:        void *data;  size_t size;
1.9       paf       111:        file_read(pool, r.absolute(lfile_name), data, size, false/*binary*/);
                    112: 
1.18      paf       113:        char *user_file_name=params->size()==1?lfile_name.cstr(String::UL_FILE_NAME)
1.26      paf       114:                :params->get(1).as_string().cstr();
1.10      paf       115:        
1.21      paf       116:        static_cast<VFile *>(r.self)->set(true/*tainted*/, data, size, 
1.20      paf       117:                user_file_name, &r.mime_type_of(user_file_name));
1.9       paf       118: }
                    119: 
1.26      paf       120: static void _stat(Request& r, const String& method_name, MethodParams *params) {
1.25      paf       121:        Pool& pool=r.pool();
1.39      parser    122:        Value& vfile_name=params->as_no_junction(0, "file name must not be code");
1.25      paf       123: 
                    124:        const String& lfile_name=vfile_name.as_string();
                    125: 
1.40      parser    126:        size_t size;
                    127:        time_t atime, mtime, ctime;
                    128:        file_stat(r.absolute(lfile_name),
                    129:                size,
                    130:                atime, mtime, ctime);
1.25      paf       131:        
1.40      parser    132:        VFile& vfile=*static_cast<VFile *>(r.self);
                    133:        vfile.set(true/*tainted*/, 0/*no bytes*/, size);
                    134:        Hash& ff=vfile.fields();
                    135:        ff.put(*new(pool) String(pool, "adate"), new(pool) VDate(pool, atime));
                    136:        ff.put(*new(pool) String(pool, "mdate"), new(pool) VDate(pool, mtime));
                    137:        ff.put(*new(pool) String(pool, "cdate"), new(pool) VDate(pool, ctime));
1.25      paf       138: }
                    139: 
1.22      paf       140: static void append_env_pair(const Hash::Key& key, Hash::Val *value, void *info) {
                    141:        Hash& hash=*static_cast<Hash *>(info);
                    142:        hash.put(key, &static_cast<Value *>(value)->as_string());
                    143: }
1.29      paf       144: 
                    145: static void pass_cgi_header_attribute(Array::Item *value, void *info) {
                    146:        String& string=*static_cast<String *>(value);
                    147:        Hash& hash=*static_cast<Hash *>(info);
                    148:        int colon_pos=string.pos(":", 1);
                    149:        if(colon_pos>0)
1.30      paf       150:                hash.put(string.mid(0, colon_pos), 
                    151:                new(string.pool()) VString(string.mid(colon_pos+1, string.size())));
1.29      paf       152: }
1.36      paf       153: /// @todo fix `` in perl - they produced flipping consoles and no output to perl
1.41      parser    154: static void _exec_cgi(Request& r, const String& method_name, MethodParams *params,
                    155:                                          bool cgi) {
1.21      paf       156:        Pool& pool=r.pool();
                    157: 
1.39      parser    158:        Value& vfile_name=params->as_no_junction(0, "file name must not be code");
1.21      paf       159: 
1.23      paf       160:        const String& script_name=r.absolute(vfile_name.as_string());
                    161: 
                    162:        Hash env(pool);
                    163:        #define PASS(key) \
                    164:                String key(pool); \
                    165:                if(const char *value=SAPI::get_env(pool, #key)) { \
                    166:                        key.APPEND_CONST(value); \
                    167:                        env.put(String(pool, #key), &key); \
                    168:                }
                    169:        #define INFO(key, value) \
                    170:                String value(pool); \
                    171:                if(r.info.value) { \
                    172:                        value.APPEND_CONST(r.info.value); \
                    173:                        env.put(String(pool, key), &value); \
                    174:                }
                    175: 
                    176:        // const
                    177:        String gateway_interface(pool, "CGI/1.1");
                    178:        env.put(String(pool, "GATEWAY_INTERFACE"), &gateway_interface);
                    179:        // from Request.info
                    180:        INFO("DOCUMENT_ROOT", document_root);
                    181:        INFO("PATH_TRANSLATED", path_translated);
                    182:        INFO("SERVER_PROTOCOL", method);
                    183:        INFO("QUERY_STRING", query_string);
                    184:        INFO("REQUEST_URI", uri);
                    185:        INFO("CONTENT_TYPE", content_type);
                    186:        char content_length_cstr[MAX_NUMBER];  
                    187:        snprintf(content_length_cstr, MAX_NUMBER, "%u", r.info.content_length);
                    188:        String content_length(pool, content_length_cstr);
                    189:        env.put(String(pool, "CONTENT_LENGTH"), &content_length);
                    190:        INFO("HTTP_COOKIE", cookie);
                    191:        INFO("HTTP_USER_AGENT", user_agent);
                    192:        // passing some SAPI:get_env-s
                    193:        PASS(SERVER_NAME);
                    194:        PASS(SERVER_PORT);
                    195:        PASS(HTTP_REFERER);
                    196:        PASS(REMOTE_ADDR);
                    197:        PASS(REMOTE_HOST);
                    198:        PASS(REMOTE_USER);
                    199:        // SCRIPT_NAME
                    200:        env.put(String(pool, "SCRIPT_NAME"), &script_name);
1.27      paf       201: #ifdef WIN32
                    202:        // WIN32 shell
                    203:        PASS(COMSPEC);
                    204: #endif
1.23      paf       205: 
1.21      paf       206:        if(params->size()>1) {
1.39      parser    207:                Value& venv=params->as_no_junction(1, "env must not be code");
1.23      paf       208:                if(Hash *user_env=venv.get_hash())
                    209:                        user_env->for_each(append_env_pair, &env);
1.21      paf       210:        }
                    211: 
                    212:        Array *argv=0;
                    213:        if(params->size()>2) {
                    214:                argv=new(pool) Array(pool, params->size()-2);
                    215:                for(int i=2; i<params->size(); i++)
1.26      paf       216:                        *argv+=&params->get(i).as_string();
1.21      paf       217:        }
                    218: 
                    219:        const String in(pool, r.post_data, r.post_size);
                    220:        String out(pool);
1.31      paf       221:        //out.APPEND_CONST("content-type:text/plain\nheader:test-header\n\ntest-body");
                    222:        //out<<in;
1.27      paf       223:        String& err=*new(pool) String(pool);
1.42      parser    224:        int status=pa_exec(script_name, &env, argv, in, out, err);
1.21      paf       225: 
                    226:        VFile& self=*static_cast<VFile *>(r.self);
                    227: 
1.41      parser    228:        const String *body=&out; // ^file:exec
                    229:        if(cgi) { // ^file:cgi
                    230:                // construct with 'out' body and header
                    231:                int delim_size;
                    232:                const char *eol_marker="\r\n"; size_t eol_marker_size=2;
                    233:                int pos=out.pos("\r\n\r\n", delim_size=4);
                    234:                if(pos<0) {
                    235:                        eol_marker="\n"; eol_marker_size=1;
                    236:                        pos=out.pos("\n\n", delim_size=2);
                    237:                }
                    238:                if(pos<0) {
                    239:                        delim_size=0; // calm down, compiler
                    240:                        PTHROW(0, 0,
                    241:                                &method_name,
                    242:                                "output does not contain CGI header; exit code=%d; size=%u; text: \"%s\"", 
1.42      parser    243:                                        status, (uint)out.size(), out.cstr());
1.41      parser    244:                }
1.21      paf       245: 
1.41      parser    246:                const String& header=out.mid(0, pos);
                    247:                body=&out.mid(pos+delim_size, out.size());
1.30      paf       248: 
1.41      parser    249:                // header to $fields
                    250:                {
                    251:                        Array rows(pool);
                    252:                        header.split(rows, 0, eol_marker, eol_marker_size, String::UL_CLEAN);
                    253:                        rows.for_each(pass_cgi_header_attribute, &self.fields());
                    254:                }
1.29      paf       255:        }
1.41      parser    256:        // body
                    257:        self.set(false/*not tainted*/, body->cstr(String::UL_AS_IS), body->size());
1.21      paf       258: 
1.42      parser    259:        // $status
1.21      paf       260:        self.fields().put(
1.42      parser    261:                *new(pool) String(pool, "status"),
                    262:                new(pool) VInt(pool, status));
1.21      paf       263:        
                    264:        // $stderr
                    265:        if(err.size()) {
                    266:                self.fields().put(
                    267:                        *new(pool) String(pool, "stderr"),
                    268:                        new(pool) VString(err));
                    269: 
1.44      parser    270:                SAPI::log(pool, "file:%s: %s", cgi?"cgi":"exec", err.cstr());
1.21      paf       271:        }
                    272: }
1.41      parser    273: static void _exec(Request& r, const String& method_name, MethodParams *params) {
                    274:        _exec_cgi(r, method_name, params, false);
                    275: }
                    276: static void _cgi(Request& r, const String& method_name, MethodParams *params) {
                    277:        _exec_cgi(r, method_name, params, true);
                    278: }
                    279: 
1.21      paf       280: 
1.32      paf       281: // constructor
                    282: 
                    283: MFile::MFile(Pool& apool) : Methoded(apool) {
                    284:        set_name(*NEW String(pool(), FILE_CLASS_NAME));
                    285: 
1.1       paf       286: 
                    287:        // ^save[file-name]
1.32      paf       288:        add_native_method("save", Method::CT_DYNAMIC, _save, 1, 1);
1.7       paf       289: 
                    290:        // ^delete[file-name]
1.32      paf       291:        add_native_method("delete", Method::CT_STATIC, _delete, 1, 1);
1.45    ! parser    292: 
        !           293:        // ^move[from-file-name;to-file-name]
        !           294:        add_native_method("move", Method::CT_STATIC, _move, 2, 2);
1.8       paf       295: 
                    296:        // ^find[file-name]
                    297:        // ^find[file-name]{when-not-found}
1.32      paf       298:        add_native_method("find", Method::CT_STATIC, _find, 1, 2);
1.9       paf       299: 
                    300:        // ^load[disk-name]
                    301:        // ^load[disk-name;user-name]
1.32      paf       302:        add_native_method("load", Method::CT_DYNAMIC, _load, 1, 2);
1.25      paf       303: 
                    304:        // ^stat[disk-name]
1.32      paf       305:        add_native_method("stat", Method::CT_DYNAMIC, _stat, 1, 1);
1.21      paf       306: 
1.36      paf       307:        // ^cgi[file-name]
                    308:        // ^cgi[file-name;env hash]
                    309:        // ^cgi[file-name;env hash;1cmd;2line;3ar;4g;5s]
1.41      parser    310:        add_native_method("cgi", Method::CT_DYNAMIC, _cgi, 1, 2+10);
                    311: 
                    312:        // ^exec[file-name]
                    313:        // ^exec[file-name;env hash]
                    314:        // ^exec[file-name;env hash;1cmd;2line;3ar;4g;5s]
                    315:        add_native_method("exec", Method::CT_DYNAMIC, _exec, 1, 2+10);
1.32      paf       316: }
                    317: 
                    318: // global variable
                    319: 
                    320: Methoded *file_class;
                    321: 
                    322: // creator
                    323: 
                    324: Methoded *MFile_create(Pool& pool) {
                    325:        return file_class=new(pool) MFile(pool);
1.1       paf       326: }

E-mail: