Don't need ILocalUtility any more.

http.py

@@ -0,0 +1,274 @@
+##############################################################################
+#
+# Copyright (c) 2004 Zope Corporation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Session implementation using cookies
+
+$Id$
+"""
+from cStringIO import StringIO
+from persistent import Persistent
+from zope.app.annotation.interfaces import IAttributeAnnotatable
+from zope.app.i18n import ZopeMessageFactory as _
+from zope.app import zapi
+from zope.app.session.interfaces import IClientIdManager
+from zope import schema
+from zope.interface import implements
+from zope.app.http.httpdate import build_http_date
+from zope.publisher.interfaces.http import IHTTPApplicationRequest
+import hmac
+import random
+import re
+import sha
+import string
+import time
+
+__docformat__ = 'restructuredtext'
+
+cookieSafeTrans = string.maketrans("+/", "-.")
+
+def digestEncode(s):
+    """Encode SHA digest for cookie."""
+    return s.encode("base64")[:-2].translate(cookieSafeTrans)
+
+class ICookieClientIdManager(IClientIdManager):
+    """Manages sessions using a cookie"""
+
+    namespace = schema.TextLine(
+            title=_('Cookie Name'),
+            description=_(
+                "Name of cookie used to maintain state. "
+                "Must be unique to the site domain name, and only contain "
+                "ASCII letters, digits and '_'"
+                ),
+            required=True,
+            min_length=1,
+            max_length=30,
+            constraint=re.compile("^[\d\w_]+$").search,
+            )
+
+    cookieLifetime = schema.Int(
+            title=_('Cookie Lifetime'),
+            description=_(
+                "Number of seconds until the browser expires the cookie. "
+                "Leave blank expire the cookie when the browser is quit. "
+                "Set to 0 to never expire. "
+                ),
+            min=0,
+            required=False,
+            default=None,
+            missing_value=None,
+            )
+
+class CookieClientIdManager(Persistent):
+    """Session utility implemented using cookies."""
+
+    implements(IClientIdManager, ICookieClientIdManager, IAttributeAnnotatable)
+
+    __parent__ = __name__ = None
+
+    def __init__(self):
+        self.namespace = "zope3_cs_%x" % (int(time.time()) - 1000000000)
+        self.secret = "%.20f" % random.random()
+        self.cookieLifetime = None
+
+    def getClientId(self, request):
+        """Get the client id
+
+        This creates one if necessary:
+
+          >>> from zope.publisher.http import HTTPRequest
+          >>> request = HTTPRequest(StringIO(''), {}, None)
+          >>> bim = CookieClientIdManager()
+          >>> id = bim.getClientId(request)
+          >>> id == bim.getClientId(request)
+          True
+
+        The id is retained accross requests:
+
+          >>> request2 = HTTPRequest(StringIO(''), {}, None)
+          >>> request2._cookies = dict(
+          ...   [(name, cookie['value'])
+          ...    for (name, cookie) in request.response._cookies.items()
+          ...   ])
+          >>> id == bim.getClientId(request2)
+          True
+          >>> bool(id)
+          True
+
+        Note that the return value of this function is a string, not
+        an IClientId. This is because this method is used to implement
+        the IClientId Adapter.
+
+          >>> type(id) == type('')
+          True
+
+        """
+        sid = self.getRequestId(request)
+        if sid is None:
+            sid = self.generateUniqueId()
+        self.setRequestId(request, sid)
+        return sid
+
+    def generateUniqueId(self):
+        """Generate a new, random, unique id.
+
+            >>> bim = CookieClientIdManager()
+            >>> id1 = bim.generateUniqueId()
+            >>> id2 = bim.generateUniqueId()
+            >>> id1 != id2
+            True
+
+        """
+        data = "%.20f%.20f%.20f" % (random.random(), time.time(), time.clock())
+        digest = sha.sha(data).digest()
+        s = digestEncode(digest)
+        # we store a HMAC of the random value together with it, which makes
+        # our session ids unforgeable.
+        mac = hmac.new(s, self.secret, digestmod=sha).digest()
+        return s + digestEncode(mac)
+
+    def getRequestId(self, request):
+        """Return the browser id encoded in request as a string
+
+        Return None if an id is not set.
+
+        For example:
+
+            >>> from zope.publisher.http import HTTPRequest
+            >>> request = HTTPRequest(StringIO(''), {}, None)
+            >>> bim = CookieClientIdManager()
+
+        Because no cookie has been set, we get no id:
+
+            >>> bim.getRequestId(request) is None
+            True
+
+        We can set an id:
+
+            >>> id1 = bim.generateUniqueId()
+            >>> bim.setRequestId(request, id1)
+
+        And get it back:
+
+            >>> bim.getRequestId(request) == id1
+            True
+
+        When we set the request id, we also set a response cookie.  We
+        can simulate getting this cookie back in a subsequent request:
+
+            >>> request2 = HTTPRequest(StringIO(''), {}, None)
+            >>> request2._cookies = dict(
+            ...   [(name, cookie['value'])
+            ...    for (name, cookie) in request.response._cookies.items()
+            ...   ])
+
+        And we get the same id back from the new request:
+
+            >>> bim.getRequestId(request) == bim.getRequestId(request2)
+            True
+
+        """
+        request = IHTTPApplicationRequest(request)
+        # If there is an id set on the response, use that but don't trust it.
+        # We need to check the response in case there has already been a new
+        # session created during the course of this request.
+        response_cookie = request.response.getCookie(self.namespace)
+        if response_cookie:
+            sid = response_cookie['value']
+        else:
+            sid = request.getCookies().get(self.namespace, None)
+        if sid is None or len(sid) != 54:
+            return None
+        s, mac = sid[:27], sid[27:]
+        if (digestEncode(hmac.new(s, self.secret, digestmod=sha).digest())
+            != mac):
+            return None
+        else:
+            return sid
+
+    def setRequestId(self, request, id):
+        """Set cookie with id on request.
+
+        This sets the response cookie:
+
+        See the examples in getRequestId.
+
+        Note that the id is checkec for validity. Setting an
+        invalid value is silently ignored:
+
+            >>> from zope.publisher.http import HTTPRequest
+            >>> request = HTTPRequest(StringIO(''), {}, None)
+            >>> bim = CookieClientIdManager()
+            >>> bim.getRequestId(request)
+            >>> bim.setRequestId(request, 'invalid id')
+            >>> bim.getRequestId(request)
+
+        For now, the cookie path is the application URL:
+
+            >>> cookie = request.response.getCookie(bim.namespace)
+            >>> cookie['path'] == request.getApplicationURL(path_only=True)
+            True
+
+        In the future, it should be the site containing the
+        CookieClientIdManager
+
+        By default, session cookies don't expire:
+
+            >>> cookie.has_key('expires')
+            False
+
+        Expiry time of 0 means never (well - close enough)
+
+            >>> bim.cookieLifetime = 0
+            >>> request = HTTPRequest(StringIO(''), {}, None)
+            >>> bid = bim.getClientId(request)
+            >>> cookie = request.response.getCookie(bim.namespace)
+            >>> cookie['expires']
+            'Tue, 19 Jan 2038 00:00:00 GMT'
+
+        A non-zero value means to expire after than number of seconds:
+
+            >>> bim.cookieLifetime = 3600
+            >>> request = HTTPRequest(StringIO(''), {}, None)
+            >>> bid = bim.getClientId(request)
+            >>> cookie = request.response.getCookie(bim.namespace)
+            >>> import rfc822
+            >>> expires = time.mktime(rfc822.parsedate(cookie['expires']))
+            >>> expires > time.mktime(time.gmtime()) + 55*60
+            True
+
+        """
+        # TODO: Currently, the path is the ApplicationURL. This is reasonable,
+        #     and will be adequate for most purposes.
+        #     A better path to use would be that of the folder that contains
+        #     the site manager this service is registered within. However,
+        #     that would be expensive to look up on each request, and would
+        #     have to be altered to take virtual hosting into account.
+        #     Seeing as this utility instance has a unique namespace for its
+        #     cookie, using ApplicationURL shouldn't be a problem.
+
+        if self.cookieLifetime is not None:
+            if self.cookieLifetime:
+                expires = build_http_date(time.time() + self.cookieLifetime)
+            else:
+                expires = 'Tue, 19 Jan 2038 00:00:00 GMT'
+            request.response.setCookie(
+                    self.namespace, id, expires=expires,
+                    path=request.getApplicationURL(path_only=True)
+                    )
+        else:
+            request.response.setCookie(
+                    self.namespace, id,
+                    path=request.getApplicationURL(path_only=True)
+                    )
+