Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

apreq_cookie.h

Go to the documentation of this file.
00001 /* ====================================================================
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 2003 The Apache Software Foundation.  All rights
00005  * reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  *
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  *
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  *
00026  * 4. The names "Apache" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written
00029  *    permission, please contact apache@apache.org.
00030  *
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  *
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  *
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation.  For more
00051  * information on the Apache Software Foundation, please see
00052  * <http://www.apache.org/>.
00053  */
00054 
00055 #ifndef APREQ_COOKIE_H
00056 #define APREQ_COOKIE_H
00057 
00058 #include "apreq.h"
00059 #include "apr_tables.h"
00060 
00061 #ifdef  __cplusplus
00062 extern "C" {
00063 #endif 
00064 
00078 typedef struct apreq_jar_t {
00079     apr_table_t   *cookies;     
00080     void          *env;         
00081 } apreq_jar_t;
00082 
00083 typedef enum { NETSCAPE, RFC } apreq_cookie_version_t;
00084 
00085 #define APREQ_COOKIE_VERSION               NETSCAPE
00086 #define APREQ_COOKIE_LENGTH                4096
00087 
00089 typedef struct apreq_cookie_t {
00090 
00091     apreq_cookie_version_t version; 
00093     char           *path;
00094     char           *domain; 
00095     char           *port;
00096     unsigned        secure;
00097 
00098     char           *comment;
00099     char           *commentURL;
00100     apr_time_t      max_age;     
00101     apreq_value_t   v;           
00103 } apreq_cookie_t;
00104 
00105 
00106 #define apreq_value_to_cookie(ptr) apreq_attr_to_type(apreq_cookie_t, \
00107                                                       v, ptr)
00108 #define apreq_cookie_name(c)  ((c)->v.name)
00109 #define apreq_cookie_value(c) ((c)->v.data)
00110 
00111 #define apreq_jar_items(j) apr_table_elts(j->cookies)->nelts
00112 #define apreq_jar_nelts(j) apr_table_elts(j->cookies)->nelts
00113 
00121 APREQ_DECLARE(apreq_cookie_t *)apreq_cookie(const apreq_jar_t *jar,
00122                                             const char *name);
00123 
00131 APREQ_DECLARE(void) apreq_add_cookie(apreq_jar_t *jar, 
00132                                      const apreq_cookie_t *c);
00133 
00150 APREQ_DECLARE(apreq_jar_t *) apreq_jar(void *env, const char *hdr);
00151 
00162 APREQ_DECLARE(apreq_cookie_t *) apreq_make_cookie(apr_pool_t *pool, 
00163                                   const char *name, const apr_size_t nlen, 
00164                                   const char *value, const apr_size_t vlen);
00165 
00177 APREQ_DECLARE(apr_status_t) 
00178     apreq_cookie_attr(apr_pool_t *p, apreq_cookie_t *c, 
00179                       const char *attr, apr_size_t alen,
00180                       const char *val, apr_size_t vlen);
00181 
00182 
00190 APREQ_DECLARE(char*) apreq_cookie_as_string(apr_pool_t *p,
00191                                             const apreq_cookie_t *c);
00192 
00204 APREQ_DECLARE(int) apreq_serialize_cookie(char *buf, apr_size_t len,
00205                                           const apreq_cookie_t *c);
00206 
00217 APREQ_DECLARE(void) apreq_cookie_expires(apreq_cookie_t *c, 
00218                                          const char *time_str);
00219 
00225 APREQ_DECLARE(apr_status_t) apreq_cookie_bake(const apreq_cookie_t *c, 
00226                                               void *env);
00227 
00228 /* XXX: how about baking whole cookie jars, too ??? */
00229 
00235 APREQ_DECLARE(apr_status_t) apreq_cookie_bake2(const apreq_cookie_t *c,
00236                                                void *env);
00237 
00238 APREQ_DECLARE(apreq_cookie_version_t) apreq_ua_cookie_version(void *env);
00239 
00242 #ifdef __cplusplus
00243  }
00244 #endif
00245 
00246 #endif /*APREQ_COOKIE_H*/
00247 
00248 

Generated on Sat Nov 15 23:04:48 2003 for libapreq2 by doxygen1.3