2.0.0beta2
[m6w6/ext-http] / php_http_cookie.h
1 /*
2 +--------------------------------------------------------------------+
3 | PECL :: http |
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted provided that the conditions mentioned |
7 | in the accompanying LICENSE file are met. |
8 +--------------------------------------------------------------------+
9 | Copyright (c) 2004-2011, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
11 */
12
13 #ifndef PHP_HTTP_COOKIE_H
14 #define PHP_HTTP_COOKIE_H
15
16 #define PHP_HTTP_COOKIE_SECURE 0x10L
17 #define PHP_HTTP_COOKIE_HTTPONLY 0x20L
18
19 #define PHP_HTTP_COOKIE_PARSE_RAW 0x01L
20
21 /*
22 generally a netscape cookie compliant struct, recognizing httpOnly attribute, too;
23 cookie params like those from rfc2109 and rfc2965 are just put into extras, if
24 one specifies them in allowed extras, else they're treated like cookies themself
25 */
26 typedef struct php_http_cookie_list {
27 HashTable cookies;
28 HashTable extras;
29 long flags;
30 char *path;
31 char *domain;
32 time_t expires;
33
34 #ifdef ZTS
35 void ***ts;
36 #endif
37 } php_http_cookie_list_t;
38
39 PHP_HTTP_API php_http_cookie_list_t *php_http_cookie_list_init(php_http_cookie_list_t *list TSRMLS_DC);
40 PHP_HTTP_API php_http_cookie_list_t *php_http_cookie_list_parse(php_http_cookie_list_t *list, const char *str, size_t len, long flags, char **allowed_extras TSRMLS_DC);
41 PHP_HTTP_API php_http_cookie_list_t *php_http_cookie_list_copy(php_http_cookie_list_t *from, php_http_cookie_list_t *to);
42 PHP_HTTP_API void php_http_cookie_list_dtor(php_http_cookie_list_t *list);
43 PHP_HTTP_API void php_http_cookie_list_free(php_http_cookie_list_t **list);
44
45 #define php_http_cookie_list_has_cookie(list, name, name_len) zend_symtable_exists(&(list)->cookies, (name), (name_len)+1)
46 PHP_HTTP_API void php_http_cookie_list_add_cookie(php_http_cookie_list_t *list, const char *name, size_t name_len, const char *value, size_t value_len);
47 PHP_HTTP_API const char *php_http_cookie_list_get_cookie(php_http_cookie_list_t *list, const char *name, size_t name_len);
48
49 #define php_http_cookie_list_has_extra(list, name, name_len) zend_symtable_exists(&(list)->extras, (name), (name_len)+1)
50 PHP_HTTP_API void php_http_cookie_list_add_extra(php_http_cookie_list_t *list, const char *name, size_t name_len, const char *value, size_t value_len);
51 PHP_HTTP_API const char *php_http_cookie_list_get_extra(php_http_cookie_list_t *list, const char *name, size_t name_len);
52
53 PHP_HTTP_API void php_http_cookie_list_to_string(php_http_cookie_list_t *list, char **str, size_t *len);
54 PHP_HTTP_API php_http_cookie_list_t *php_http_cookie_list_from_struct(php_http_cookie_list_t *list, zval *strct TSRMLS_DC);
55 PHP_HTTP_API void php_http_cookie_list_to_struct(php_http_cookie_list_t *list, zval *strct);
56
57
58 zend_class_entry *php_http_cookie_get_class_entry(void);
59
60 typedef struct php_http_cookie_object {
61 zend_object o;
62 php_http_cookie_list_t *list;
63 } php_http_cookie_object_t;
64
65 zend_object_value php_http_cookie_object_new(zend_class_entry *ce TSRMLS_DC);
66 zend_object_value php_http_cookie_object_new_ex(zend_class_entry *ce, php_http_cookie_list_t *list, php_http_cookie_object_t **obj TSRMLS_DC);
67 zend_object_value php_http_cookie_object_clone(zval *this_ptr TSRMLS_DC);
68 void php_http_cookie_object_free(void *object TSRMLS_DC);
69
70 PHP_METHOD(HttpCookie, __construct);
71 PHP_METHOD(HttpCookie, getCookies);
72 PHP_METHOD(HttpCookie, setCookies);
73 PHP_METHOD(HttpCookie, addCookies);
74 PHP_METHOD(HttpCookie, getExtras);
75 PHP_METHOD(HttpCookie, setExtras);
76 PHP_METHOD(HttpCookie, addExtras);
77 PHP_METHOD(HttpCookie, getCookie);
78 PHP_METHOD(HttpCookie, setCookie);
79 PHP_METHOD(HttpCookie, addCookie);
80 PHP_METHOD(HttpCookie, getExtra);
81 PHP_METHOD(HttpCookie, setExtra);
82 PHP_METHOD(HttpCookie, addExtra);
83 PHP_METHOD(HttpCookie, getDomain);
84 PHP_METHOD(HttpCookie, setDomain);
85 PHP_METHOD(HttpCookie, getPath);
86 PHP_METHOD(HttpCookie, setPath);
87 PHP_METHOD(HttpCookie, getExpires);
88 PHP_METHOD(HttpCookie, setExpires);
89 PHP_METHOD(HttpCookie, getFlags);
90 PHP_METHOD(HttpCookie, setFlags);
91 PHP_METHOD(HttpCookie, toString);
92 PHP_METHOD(HttpCookie, toArray);
93
94 extern PHP_MINIT_FUNCTION(http_cookie);
95
96
97 #endif
98
99 /*
100 * Local variables:
101 * tab-width: 4
102 * c-basic-offset: 4
103 * End:
104 * vim600: noet sw=4 ts=4 fdm=marker
105 * vim<600: noet sw=4 ts=4
106 */