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

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

E-mail: