Annotation of parser3/src/types/pa_vcookie.C, revision 1.89
1.6 paf 1: /** @file
2: Parser: cookie class.
3:
1.86 moko 4: Copyright (c) 2001-2012 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.89 ! misha 16: volatile const char * IDENT_PA_VCOOKIE_C="$Id: pa_vcookie.C,v 1.88 2013/10/04 21:21:56 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.89 ! misha 41: #ifndef OPTIMIZE_BYTECODE_GET_ELEMENT__SPECIAL
1.28 parser 42: // $CLASS
1.46 paf 43: if(aname==CLASS_NAME)
1.28 parser 44: return this;
45:
1.76 misha 46: // $CLASS_NAME
47: if(aname==CLASS_NAMETEXT)
48: return new VString(cookie_class_name);
1.89 ! misha 49: #endif
1.76 misha 50:
1.74 misha 51: // $fields
1.72 misha 52: if(aname==COOKIE_FIELDS_ELEMENT_NAME){
1.74 misha 53: if(should_refill())
54: refill();
55:
56: HashStringValue *result=new HashStringValue(before);
1.72 misha 57: after.for_each<HashStringValue*>(copy_all_overwrite_to, result);
58: deleted.for_each<HashStringValue*>(remove_key_from, result);
59: return new VHash(*result);
60: }
61:
1.1 paf 62: // $cookie
1.46 paf 63: if(deleted.get(aname)) // deleted?
1.1 paf 64: return 0;
65:
1.56 paf 66: if(Value* after_meaning=after.get(aname)) // assigned 'after'?
67: if(HashStringValue *hash=after_meaning->get_hash())
68: return hash->get(value_name);
1.2 paf 69: else
70: return after_meaning;
1.1 paf 71:
1.74 misha 72: if(should_refill())
73: refill();
74:
1.1 paf 75: // neither deleted nor assigned
76: // return any value it had 'before'
1.56 paf 77: return before.get(aname);
1.1 paf 78: }
79:
1.84 misha 80: time_t expires_sec(double days_till_expire) {
81: time_t result=time(NULL)+(time_t)(60*60*24*days_till_expire);
82: struct tm* tms=gmtime(&result);
83: if(!tms)
84: throw Exception(DATE_RANGE_EXCEPTION_TYPE,
85: 0,
86: "bad expires time (seconds from epoch=%u)", result);
87: return result;
88: }
89:
1.88 moko 90: const VJunction* VCookie::put_element(const String& aname, Value* avalue) {
1.1 paf 91: // $cookie
1.56 paf 92: Value* lvalue;
1.84 misha 93: if(HashStringValue *hash=avalue->get_hash()) {
1.85 misha 94: if(Value* expires=hash->get(expires_name)){
95: const String* string;
96: if(!(expires->is_string() && (string=expires->get_string()) && (*string==SESSION_NAME)))
97: if(double days_till_expire=expires->as_double())
98: expires_sec(days_till_expire);
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.64 paf 118: return PUT_ELEMENT_REPLACED_ELEMENT;
1.1 paf 119: }
120:
1.56 paf 121: static Value& expires_vdate(double days_till_expire) {
1.84 misha 122: return *new VDate(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.80 misha 171: if(Value* vdate=expires->as(VDATE_TYPE))
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;
266: /*
267: FILE *f=fopen("c:\\temp\\a", "wt");
268: fprintf(f, "cookie=%s", request_info.cookie);
269: fclose(f);
270: */
271: char *cookies=strdup(frequest_info.cookie);
272: char *current=cookies;
273: //_asm int 3;
274: do {
275: if(char *attribute=search_stop(current, '='))
276: if(char *meaning=search_stop(current, ';')) {
277: const String& sattribute=
1.83 misha 278: *new String(unescape_chars(attribute, strlen(attribute), &fcharsets.source(), true), String::L_TAINTED);
1.74 misha 279: const String& smeaning=
1.83 misha 280: *new String(unescape_chars(meaning, strlen(meaning), &fcharsets.source(), true), String::L_TAINTED);
1.74 misha 281: before.put(sattribute, new VString(smeaning));
282:
283: //if(sattribute == "test_js") throw Exception(0, 0, "'%s' '%s'", meaning, smeaning.cstr());
284: }
285: } while(current);
286:
287: filled_source=&fcharsets.source();
288: filled_client=&fcharsets.client();
1.1 paf 289: }
1.74 misha 290:
E-mail: