linkchecker/linkcheck/cache/cookie.py
2011-08-03 21:21:44 +02:00

81 lines
3.2 KiB
Python

# -*- coding: iso-8859-1 -*-
# Copyright (C) 2006-2011 Bastian Kleineidam
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
"""
Store and retrieve cookies.
"""
from .. import log, LOG_CACHE, cookies
from ..decorators import synchronized
from ..lock import get_lock
_lock = get_lock("cookie")
class CookieJar (object):
"""Cookie storage, implementing the cookie handling policy."""
def __init__ (self):
"""Initialize empty cookie cache."""
# Store all cookies in a set.
self.cache = set()
@synchronized(_lock)
def add (self, headers, scheme, host, path):
"""Parse cookie values, add to cache."""
errors = []
for h in headers.getallmatchingheaders("Set-Cookie"):
# RFC 2109 (Netscape) cookie type
try:
cookie = cookies.NetscapeCookie(h, scheme, host, path)
if cookie in self.cache:
self.cache.remove(cookie)
if not cookie.is_expired():
self.cache.add(cookie)
except cookies.CookieError, msg:
errmsg = "Invalid cookie %r for %s:%s%s: %s" % (
h, scheme, host, path, msg)
errors.append(errmsg)
for h in headers.getallmatchingheaders("Set-Cookie2"):
# RFC 2965 cookie type
try:
cookie = cookies.Rfc2965Cookie(h, scheme, host, path)
if cookie in self.cache:
self.cache.remove(cookie)
if not cookie.is_expired():
self.cache.add(cookie)
except cookies.CookieError, msg:
errmsg = "Invalid cookie2 %r for %s:%s%s: %s" % (
h, scheme, host, path, msg)
errors.append(errmsg)
return errors
@synchronized(_lock)
def get (self, scheme, host, port, path):
"""Cookie cache getter function. Return ordered list of cookies
which match the given host, port and path.
Cookies with more specific paths are listed first."""
cookies = [x for x in self.cache if x.check_expired() and \
x.is_valid_for(scheme, host, port, path)]
# order cookies with more specific (ie. longer) paths first
cookies.sort(key=lambda c: len(c.attributes['path']), reverse=True)
log.debug(LOG_CACHE, "Found %d cookies for host %r path %r",
len(cookies), host, path)
return cookies
@synchronized(_lock)
def __str__ (self):
"""Return stored cookies as string."""
return "<CookieJar with %s>" % self.cache