Annotation of parser3/src/types/pa_vcookie.C, revision 1.106

1.6       paf         1: /** @file
                      2:        Parser: cookie class.
                      3: 
1.105     moko        4:        Copyright (c) 2001-2024 Art. Lebedev Studio (http://www.artlebedev.com)
1.102     moko        5:        Authors: Konstantin Morshnev <moko@design.ru>, Alexandr Petrosian <paf@design.ru>
1.44      paf         6: */
1.6       paf         7: 
1.11      paf         8: #include "pa_sapi.h"
1.3       paf         9: #include "pa_common.h"
1.1       paf        10: #include "pa_vcookie.h"
                     11: #include "pa_vstring.h"
1.49      paf        12: #include "pa_vdate.h"
1.56      paf        13: #include "pa_vhash.h"
1.74      misha      14: #include "pa_request.h"
1.56      paf        15: 
1.106   ! moko       16: volatile const char * IDENT_PA_VCOOKIE_C="$Id: pa_vcookie.C,v 1.105 2024/11/04 03:53:25 moko Exp $" IDENT_PA_VCOOKIE_H;
1.86      moko       17: 
1.56      paf        18: // defines
                     19: 
                     20: #define PATH_NAME "path"
                     21: #define PATH_VALUE_DEFAULT "/"
1.1       paf        22: 
                     23: #define SESSION_NAME "session"
                     24: #define DEFAULT_EXPIRES_DAYS 90
1.9       paf        25: 
1.72      misha      26: #define COOKIE_FIELDS_ELEMENT_NAME "fields"
                     27: 
1.56      paf        28: // statics
                     29: 
                     30: static const String path_name(PATH_NAME);
                     31: static const String path_value_default(PATH_VALUE_DEFAULT);
                     32: 
1.1       paf        33: // VCookie
                     34: 
1.74      misha      35: VCookie::VCookie(Request_charsets& acharsets, Request_info& arequest_info):
1.106   ! moko       36:        fcharsets(acharsets), frequest_info(arequest_info), filled_source(0), filled_client(0) {
1.74      misha      37: }
                     38: 
1.80      misha      39: Value* VCookie::get_element(const String& aname) {
1.95      moko       40: #ifndef OPTIMIZE_BYTECODE_GET_ELEMENT__SPECIAL
                     41:        // CLASS, CLASS_NAME
1.94      moko       42:        if(Value* result=VStateless_class::get_element(aname))
                     43:                return result;
1.95      moko       44: #endif
1.76      misha      45: 
1.74      misha      46:        // $fields
1.72      misha      47:        if(aname==COOKIE_FIELDS_ELEMENT_NAME){
1.74      misha      48:                if(should_refill())
                     49:                        refill();
                     50: 
                     51:                HashStringValue *result=new HashStringValue(before);
1.96      moko       52:                for(HashStringValue::Iterator i(after); i; i.next())
                     53:                        result->put(i.key(), i.value());
                     54:                for(HashStringValue::Iterator i(deleted); i; i.next())
                     55:                        result->remove(i.key());
1.72      misha      56:                return new VHash(*result);
                     57:        }
                     58: 
1.1       paf        59:        // $cookie
1.46      paf        60:        if(deleted.get(aname)) // deleted?
1.1       paf        61:                return 0;
                     62:        
1.90      moko       63:        if(Value* after_meaning=after.get(aname)) { // assigned 'after'?
1.56      paf        64:                if(HashStringValue *hash=after_meaning->get_hash())
                     65:                        return hash->get(value_name);
1.2       paf        66:                else
                     67:                        return after_meaning;
1.90      moko       68:        }
1.1       paf        69:        
1.74      misha      70:        if(should_refill())
                     71:                refill();
                     72: 
1.1       paf        73:        // neither deleted nor assigned 
                     74:        // return any value it had 'before'
1.56      paf        75:        return before.get(aname);
1.1       paf        76: }
                     77: 
1.104     moko       78: static Value& expires_vdate(double days_till_expire) {
                     79:        return *new VDate(time(NULL)+60*60*24*days_till_expire);
1.84      misha      80: }
                     81: 
1.88      moko       82: const VJunction* VCookie::put_element(const String& aname, Value* avalue) {
1.1       paf        83:        // $cookie
1.56      paf        84:        Value* lvalue;
1.84      misha      85:        if(HashStringValue *hash=avalue->get_hash()) {
1.85      misha      86:                if(Value* expires=hash->get(expires_name)){
                     87:                        const String* string;
                     88:                        if(!(expires->is_string() && (string=expires->get_string()) && (*string==SESSION_NAME)))
1.103     moko       89:                                if(!dynamic_cast<VDate*>(expires))
1.92      moko       90:                                        if(double days_till_expire=expires->as_double())
1.104     moko       91:                                                expires_vdate(days_till_expire); // checking if date is valid here to avoid failure when sending headers
1.85      misha      92:                }
1.56      paf        93:                lvalue=hash->get(value_name);
1.84      misha      94:        } else
1.50      paf        95:                lvalue=avalue;
1.51      paf        96: 
                     97:        if(lvalue && lvalue->is_string()) {
                     98:                // taint string being assigned
1.56      paf        99:                String& tainted=*new String;
                    100:                tainted.append(*lvalue->get_string(), String::L_TAINTED, true /*forced*/);
                    101:                lvalue=new VString(tainted);
1.51      paf       102:        }
1.1       paf       103: 
1.71      misha     104:        if( !lvalue || lvalue->as_string().is_empty() ) {
                    105:                deleted.put(aname, avalue);
                    106:                after.put(aname, 0);
                    107:        } else {
                    108:                after.put(aname, avalue);
                    109:                deleted.put(aname, 0);
                    110:        }
1.99      moko      111:        return 0;
1.1       paf       112: }
                    113: 
1.25      parser    114: /*
1.49      paf       115:        @todo 
1.87      misha     116:        http://curl.haxx.se/rfc/cookie_spec.html
                    117:        http://www.w3.org/Protocols/rfc2109/rfc2109
1.25      parser    118:        When sending cookies to a server, 
                    119:        all cookies with a more specific path mapping should be sent before cookies 
                    120:        with less specific path mappings. 
                    121:        For example, a cookie "name1=foo" with a path mapping of "/" should be sent after 
                    122:        a cookie "name1=foo2" with a path mapping of "/bar" if they are both to be sent. 
                    123: 
1.74      misha     124:        There are limitations on the number of cookies that a client can store at any one time. 
                    125:        This is a specification of the minimum number of cookies that a client should be prepared 
                    126:        to receive and store. 
                    127:                300 total cookies 
                    128:                4 kilobytes per cookie, where the name and the OPAQUE_STRING combine 
                    129:                        to form the 4 kilobyte limit. 
                    130:                20 cookies per server or domain. (note that completely specified hosts 
                    131:                        and domains are treated as separate entities and have a 20 cookie limitation 
                    132:                        for each, not combined) 
1.25      parser    133: */
1.74      misha     134: 
                    135: const String* output_set_cookie_value(
                    136:                                        HashStringValue::key_type aname,
                    137:                                        HashStringValue::value_type ameaning,
                    138:                                        bool adelete){
                    139:        String* result=new String();
1.1       paf       140:        // attribute=
1.79      misha     141:        *result << String(aname, String::L_HTTP_COOKIE) << "=";
1.74      misha     142: 
1.56      paf       143:        Value* lmeaning;
1.1       paf       144:        // figure out 'meaning'
1.61      paf       145:        // Set-Cookie: (attribute)=(value); path=/
                    146:        HashStringValue *hash;
                    147:        double default_expires_days=adelete?-DEFAULT_EXPIRES_DAYS:+DEFAULT_EXPIRES_DAYS;
                    148:        if((hash=ameaning->get_hash())) { // ...[hash value]
                    149:                // clone to safely change it
1.74      misha     150:                lmeaning=new VHash(*hash);
                    151:                hash=lmeaning->get_hash();
1.104     moko      152:  
1.61      paf       153:                // $expires
                    154:                if(Value* expires=hash->get(expires_name)) {
                    155:                        const String* string;
                    156:                        if(expires->is_string() && (string=expires->get_string()) && (*string==SESSION_NAME))  {
                    157:                                // $expires[session]
                    158:                                hash->remove(expires_name);
                    159:                        } else {
1.103     moko      160:                                if(Value* vdate=dynamic_cast<VDate*>(expires))
1.61      paf       161:                                        hash->put(expires_name, vdate); // $expires[DATE]
                    162:                                else if(double days_till_expire=expires->as_double())
                    163:                                        hash->put(expires_name, &expires_vdate(days_till_expire)); // $expires(days)
                    164:                                else
                    165:                                        hash->remove(expires_name); // $expires(0)
                    166:                        }
                    167:                } else // $expires not assigned, defaulting
                    168:                        hash->put(expires_name, &expires_vdate(default_expires_days));
                    169:        } else { // ...[string value]
                    170:                Value* wrap_meaning=new VHash;
                    171:                hash=wrap_meaning->get_hash();
                    172:                // wrapping lmeaning into hash
                    173:                hash->put(value_name, ameaning);
                    174:                // string = $expires not assigned, defaulting
                    175:                hash->put(expires_name, &expires_vdate(default_expires_days));
                    176:                // replacing lmeaning with hash-wrapped one
                    177:                lmeaning=wrap_meaning;
                    178:        }
                    179: 
                    180:        if(adelete) {// removing value
1.25      parser    181:                /*
1.87      misha     182:                        http://curl.haxx.se/rfc/cookie_spec.html
                    183:                        http://www.w3.org/Protocols/rfc2109/rfc2109
1.25      parser    184:                        to delete a cookie, it can do so by returning a cookie with the same name, 
                    185:                        and an expires time which is in the past
                    186:                */
                    187: 
1.1       paf       188:                // Set-Cookie: (attribute)=; path=/
1.61      paf       189:                lmeaning->get_hash()->remove(value_name);
1.1       paf       190:        }
1.74      misha     191: 
1.1       paf       192:        // defaulting path
1.56      paf       193:        if(!lmeaning->get_hash()->get(path_name))
1.74      misha     194:                lmeaning->get_hash()->put(path_name, new VString(path_value_default));
1.1       paf       195: 
1.56      paf       196:        // append lmeaning
1.74      misha     197:        *result << attributed_meaning_to_string(*lmeaning, String::L_HTTP_COOKIE, true, true /* allow bool attr */);
1.1       paf       198: 
1.74      misha     199:        return result;
1.1       paf       200: }
1.74      misha     201: 
                    202: 
                    203: struct Cookie_pass_info {
                    204:        SAPI_Info* sapi_info;
                    205:        Request_charsets* charsets;
                    206: };
                    207: 
                    208: void output_set_cookie_header(
                    209:                        HashStringValue::key_type aattribute, 
                    210:                        HashStringValue::value_type ameaning,
                    211:                        bool adelete,
                    212:                        Cookie_pass_info& cookie_info
                    213:        ){
1.82      misha     214:                SAPI::add_header_attribute(*cookie_info.sapi_info, "set-cookie",
1.79      misha     215:                        output_set_cookie_value(aattribute, ameaning, adelete)->untaint_cstr(String::L_AS_IS, 0, cookie_info.charsets));
1.56      paf       216: }
1.74      misha     217: 
                    218: void output_after(
                    219:                        HashStringValue::key_type aattribute, 
                    220:                        HashStringValue::value_type ameaning,
                    221:                        Cookie_pass_info& cookie_info
                    222:        ){
                    223:                output_set_cookie_header(aattribute, ameaning, false, cookie_info);
                    224: }
                    225: 
                    226: void output_deleted(
                    227:                        HashStringValue::key_type aattribute, 
                    228:                        HashStringValue::value_type ameaning, 
                    229:                        Cookie_pass_info& cookie_info
                    230:        ){
                    231:                if(ameaning)
                    232:                        output_set_cookie_header(aattribute, ameaning, true, cookie_info);
                    233: }
                    234: 
1.56      paf       235: void VCookie::output_result(SAPI_Info& sapi_info) {
1.74      misha     236:        Cookie_pass_info cookie_info={&sapi_info, &fcharsets};
                    237: 
                    238:        after.for_each<Cookie_pass_info&>(output_after, cookie_info);
                    239:        deleted.for_each<Cookie_pass_info&>(output_deleted, cookie_info);
                    240: }
                    241: 
                    242: bool VCookie::should_refill(){
                    243:        return !(
                    244:                &fcharsets.source()==filled_source
                    245:                && &fcharsets.client()==filled_client
                    246:        );
                    247: }
                    248: 
                    249: //#include <stdio.h>
                    250: void VCookie::refill(){
                    251:        //request_info.cookie="test-session=value%3D5; test-default1=value%3D1; test-default2=value%3D2; test-tomorrow=value%3D3";
                    252:        //request_info.cookie="enabled=yes; auth.uid=196325308053599810; enabled=yes; msnames; msuri"; // mdm 
                    253:        if(!frequest_info.cookie)
                    254:                return;
1.97      moko      255: 
1.74      misha     256:        char *cookies=strdup(frequest_info.cookie);
                    257:        char *current=cookies;
                    258:        //_asm int 3;
                    259:        do {
                    260:                if(char *attribute=search_stop(current, '='))
                    261:                        if(char *meaning=search_stop(current, ';')) {
                    262:                                const String& sattribute=
1.83      misha     263:                                        *new String(unescape_chars(attribute, strlen(attribute), &fcharsets.source(), true), String::L_TAINTED);
1.74      misha     264:                                const String& smeaning=
1.83      misha     265:                                        *new String(unescape_chars(meaning, strlen(meaning), &fcharsets.source(), true), String::L_TAINTED);
1.74      misha     266:                                before.put(sattribute, new VString(smeaning));
                    267: 
                    268:                                //if(sattribute == "test_js") throw Exception(0, 0, "'%s' '%s'", meaning, smeaning.cstr());
                    269:                        }
                    270:        } while(current);
                    271: 
                    272:        filled_source=&fcharsets.source();
                    273:        filled_client=&fcharsets.client();
1.1       paf       274: }
1.74      misha     275: 

E-mail: