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