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