Renamed setCookie to addCookie. Also changed addCookie so that you can

grisha · grisha · commit 7c0dd0e56186 · 2003-07-26T19:25:18.000Z
just give it a couple of strings as args and it will automatically construct
a cookie for you.

PR:
Obtained from:
Submitted by:
Reviewed by:
diff --git a/Doc/modpython4.tex b/Doc/modpython4.tex
@@ -1616,16 +1616,28 @@ \subsection{Classes\label{pyapi-cookie-classes}}
 
 \subsection{Functions\label{pyapi-cookie-func}}
 
-\begin{funcdesc}{setCookie}{req, cookie}
+\begin{funcdesc}{addCookie}{req, cookie\optional{, value, attributes}}
   This is a convenience function for setting a cookie in request
-  headers. \var{req} is a mod_python \class{Request} object,
-  \var{cookie} is an object whose string representation is a valid
-  cookie. (Most often it is an instance of mod_python \class{Cookie}
-  or any of its subclasses).
+  headers. \var{req} is a mod_python \class{Request} object.  If
+  \var{cookie} is an instance of \class{Cookie} (or subclass thereof),
+  then the cookie is set, otherwise, \var{cookie} must be a string, in
+  which case a \class{Cookie} is constructed using \var{cookie} as
+  name, \var{value} as the value, along with any valid \class{Cookie}
+  attributes specified as keyword arguments.
 
   This function will also set \samp{Cache-Control:
   no-cache="set-cookie"} header to inform caches that the cookie value
   should not be cached.
+
+  Here is one way to use this function:
+  \begin{verbatim}
+c = Cookie.Cookie('spam', 'eggs', expires=time.time()+300)
+Cookie.addCookie(req, c)
+  \end{verbatim}
+  Here is another:
+  \begin{verbatim}
+Cookie.addCookie(req, 'spam', 'eggs', expires=time.time()+300)
+  \end{verbatim}
 \end{funcdesc}
 
 \begin{funcdesc}{getCookies}{req \optional{, Class, data}}
@@ -1651,7 +1663,7 @@ \subsection{Examples\label{pyapi-cookie-example}}
 
     cookie = Cookie.Cookie('eggs', 'spam')
     cookie.expires = time.time() + 300
-    Cookie.setCookie(req, cookie)
+    Cookie.addCookie(req, cookie)
 
     req.write('This response contains a cookie!\n')
     return apache.OK
@@ -1685,7 +1697,7 @@ \subsection{Examples\label{pyapi-cookie-example}}
 
         # MarshaCookie allows value to be any marshallable object
         value = {'egg_count': 32, 'color': 'white'}
-        Cookie.setCookie(req, Cookie.MarshalCookie('spam', value, \
+        Cookie.addCookie(req, Cookie.MarshalCookie('spam', value, \
                          'secret007'))
         req.write('Spam cookie not found, but we just set one!\n')
 
diff --git a/lib/python/mod_python/Cookie.py b/lib/python/mod_python/Cookie.py
@@ -54,7 +54,7 @@
  #
  # Originally developed by Gregory Trubetskoy.
  #
- # $Id: Cookie.py,v 1.7 2003/07/24 20:51:08 grisha Exp $
+ # $Id: Cookie.py,v 1.8 2003/07/26 19:25:18 grisha Exp $
 
 """
 
@@ -374,11 +374,17 @@ def _parseCookie(str, Class):
 
     return result
 
-def setCookie(req, cookie):
+def addCookie(req, cookie, value="", **kw):
     """
     Sets a cookie in outgoing headers and adds a cache
     directive so that caches don't cache the cookie.
     """
+
+    # is this a cookie?
+    if not isinstance(cookie, Cookie):
+
+        # make a cookie
+        cookie = Cookie(cookie, value, **kw)
         
     if not req.headers_out.has_key("Set-Cookie"):
         req.headers_out.add("Cache-Control", 'no-cache="set-cookie"')
