roundup/cgi/client.py

   1 """WWW request handler (also used in the stand-alone server).
   2 """
   3 __docformat__ = 'restructuredtext'
   4
   5 import base64, binascii, cgi, codecs, httplib, mimetypes, os
   6 import quopri, random, re, rfc822, stat, sys, time, urllib, urlparse
   7 import Cookie, socket, errno
   8 from Cookie import CookieError, BaseCookie, SimpleCookie
   9 from cStringIO import StringIO
  10
  11 from roundup import roundupdb, date, hyperdb, password
  12 from roundup.cgi import templating, cgitb, TranslationService
  13 from roundup.cgi.actions import *
  14 from roundup.exceptions import *
  15 from roundup.cgi.exceptions import *
  16 from roundup.cgi.form_parser import FormParser
  17 from roundup.mailer import Mailer, MessageSendError, encode_quopri
  18 from roundup.cgi import accept_language
  19 from roundup import xmlrpc
  20
  21 def initialiseSecurity(security):
  22     '''Create some Permissions and Roles on the security object
  23
  24     This function is directly invoked by security.Security.__init__()
  25     as a part of the Security object instantiation.
  26     '''
  27     p = security.addPermission(name="Web Access",
  28         description="User may access the web interface")
  29     security.addPermissionToRole('Admin', p)
  30
  31     # doing Role stuff through the web - make sure Admin can
  32     # TODO: deprecate this and use a property-based control
  33     p = security.addPermission(name="Web Roles",
  34         description="User may manipulate user Roles through the web")
  35     security.addPermissionToRole('Admin', p)
  36
  37 # used to clean messages passed through CGI variables - HTML-escape any tag
  38 # that isn't <a href="">, <i>, <b> and <br> (including XHTML variants) so
  39 # that people can't pass through nasties like <script>, <iframe>, ...
  40 CLEAN_MESSAGE_RE = r'(<(/?(.*?)(\s*href="[^"]")?\s*/?)>)'
  41 def clean_message(message, mc=re.compile(CLEAN_MESSAGE_RE, re.I)):
  42     return mc.sub(clean_message_callback, message)
  43 def clean_message_callback(match, ok={'a':1,'i':1,'b':1,'br':1}):
  44     """ Strip all non <a>,<i>,<b> and <br> tags from a string
  45     """
  46     if ok.has_key(match.group(3).lower()):
  47         return match.group(1)
  48     return '&lt;%s&gt;'%match.group(2)
  49
  50
  51 error_message = ''"""<html><head><title>An error has occurred</title></head>
  52 <body><h1>An error has occurred</h1>
  53 <p>A problem was encountered processing your request.
  54 The tracker maintainers have been notified of the problem.</p>
  55 </body></html>"""
  56
  57
  58 class LiberalCookie(SimpleCookie):
  59     """ Python's SimpleCookie throws an exception if the cookie uses invalid
  60         syntax.  Other applications on the same server may have done precisely
  61         this, preventing roundup from working through no fault of roundup.
  62         Numerous other python apps have run into the same problem:
  63
  64         trac: http://trac.edgewall.org/ticket/2256
  65         mailman: http://bugs.python.org/issue472646
  66
  67         This particular implementation comes from trac's solution to the
  68         problem. Unfortunately it requires some hackery in SimpleCookie's
  69         internals to provide a more liberal __set method.
  70     """
  71     def load(self, rawdata, ignore_parse_errors=True):
  72         if ignore_parse_errors:
  73             self.bad_cookies = []
  74             self._BaseCookie__set = self._loose_set
  75         SimpleCookie.load(self, rawdata)
  76         if ignore_parse_errors:
  77             self._BaseCookie__set = self._strict_set
  78             for key in self.bad_cookies:
  79                 del self[key]
  80
  81     _strict_set = BaseCookie._BaseCookie__set
  82
  83     def _loose_set(self, key, real_value, coded_value):
  84         try:
  85             self._strict_set(key, real_value, coded_value)
  86         except CookieError:
  87             self.bad_cookies.append(key)
  88             dict.__setitem__(self, key, None)
  89
  90
  91 class Session:
  92     """
  93     Needs DB to be already opened by client
  94
  95     Session attributes at instantiation:
  96
  97     - "client" - reference to client for add_cookie function
  98     - "session_db" - session DB manager
  99     - "cookie_name" - name of the cookie with session id
 100     - "_sid" - session id for current user
 101     - "_data" - session data cache
 102
 103     session = Session(client)
 104     session.set(name=value)
 105     value = session.get(name)
 106
 107     session.destroy()  # delete current session
 108     session.clean_up() # clean up session table
 109
 110     session.update(set_cookie=True, expire=3600*24*365)
 111                        # refresh session expiration time, setting persistent
 112                        # cookie if needed to last for 'expire' seconds
 113
 114     """
 115
 116     def __init__(self, client):
 117         self._data = {}
 118         self._sid  = None
 119
 120         self.client = client
 121         self.session_db = client.db.getSessionManager()
 122
 123         # parse cookies for session id
 124         self.cookie_name = 'roundup_session_%s' % \
 125             re.sub('[^a-zA-Z]', '', client.instance.config.TRACKER_NAME)
 126         cookies = LiberalCookie(client.env.get('HTTP_COOKIE', ''))
 127         if self.cookie_name in cookies:
 128             if not self.session_db.exists(cookies[self.cookie_name].value):
 129                 self._sid = None
 130                 # remove old cookie
 131                 self.client.add_cookie(self.cookie_name, None)
 132             else:
 133                 self._sid = cookies[self.cookie_name].value
 134                 self._data = self.session_db.getall(self._sid)
 135
 136     def _gen_sid(self):
 137         """ generate a unique session key """
 138         while 1:
 139             s = '%s%s'%(time.time(), random.random())
 140             s = binascii.b2a_base64(s).strip()
 141             if not self.session_db.exists(s):
 142                 break
 143
 144         # clean up the base64
 145         if s[-1] == '=':
 146             if s[-2] == '=':
 147                 s = s[:-2]
 148             else:
 149                 s = s[:-1]
 150         return s
 151
 152     def clean_up(self):
 153         """Remove expired sessions"""
 154         self.session_db.clean()
 155
 156     def destroy(self):
 157         self.client.add_cookie(self.cookie_name, None)
 158         self._data = {}
 159         self.session_db.destroy(self._sid)
 160         self.client.db.commit()
 161
 162     def get(self, name, default=None):
 163         return self._data.get(name, default)
 164
 165     def set(self, **kwargs):
 166         self._data.update(kwargs)
 167         if not self._sid:
 168             self._sid = self._gen_sid()
 169             self.session_db.set(self._sid, **self._data)
 170             # add session cookie
 171             self.update(set_cookie=True)
 172
 173             # XXX added when patching 1.4.4 for backward compatibility
 174             # XXX remove
 175             self.client.session = self._sid
 176         else:
 177             self.session_db.set(self._sid, **self._data)
 178             self.client.db.commit()
 179
 180     def update(self, set_cookie=False, expire=None):
 181         """ update timestamp in db to avoid expiration
 182
 183             if 'set_cookie' is True, set cookie with 'expire' seconds lifetime
 184             if 'expire' is None - session will be closed with the browser
 185
 186             XXX the session can be purged within a week even if a cookie
 187                 lifetime is longer
 188         """
 189         self.session_db.updateTimestamp(self._sid)
 190         self.client.db.commit()
 191
 192         if set_cookie:
 193             self.client.add_cookie(self.cookie_name, self._sid, expire=expire)
 194
 195
 196
 197 class Client:
 198     """Instantiate to handle one CGI request.
 199
 200     See inner_main for request processing.
 201
 202     Client attributes at instantiation:
 203
 204     - "path" is the PATH_INFO inside the instance (with no leading '/')
 205     - "base" is the base URL for the instance
 206     - "form" is the cgi form, an instance of FieldStorage from the standard
 207       cgi module
 208     - "additional_headers" is a dictionary of additional HTTP headers that
 209       should be sent to the client
 210     - "response_code" is the HTTP response code to send to the client
 211     - "translator" is TranslationService instance
 212
 213     During the processing of a request, the following attributes are used:
 214
 215     - "db"
 216     - "error_message" holds a list of error messages
 217     - "ok_message" holds a list of OK messages
 218     - "session" is deprecated in favor of session_api (XXX remove)
 219     - "session_api" is the interface to store data in session
 220     - "user" is the current user's name
 221     - "userid" is the current user's id
 222     - "template" is the current :template context
 223     - "classname" is the current class context name
 224     - "nodeid" is the current context item id
 225
 226     User Identification:
 227      Users that are absent in session data are anonymous and are logged
 228      in as that user. This typically gives them all Permissions assigned to the
 229      Anonymous Role.
 230
 231      Every user is assigned a session. "session_api" is the interface to work
 232      with session data.
 233
 234     Special form variables:
 235      Note that in various places throughout this code, special form
 236      variables of the form :<name> are used. The colon (":") part may
 237      actually be one of either ":" or "@".
 238     """
 239
 240     # charset used for data storage and form templates
 241     # Note: must be in lower case for comparisons!
 242     # XXX take this from instance.config?
 243     STORAGE_CHARSET = 'utf-8'
 244
 245     #
 246     # special form variables
 247     #
 248     FV_TEMPLATE = re.compile(r'[@:]template')
 249     FV_OK_MESSAGE = re.compile(r'[@:]ok_message')
 250     FV_ERROR_MESSAGE = re.compile(r'[@:]error_message')
 251
 252     # Note: index page stuff doesn't appear here:
 253     # columns, sort, sortdir, filter, group, groupdir, search_text,
 254     # pagesize, startwith
 255
 256     # list of network error codes that shouldn't be reported to tracker admin
 257     # (error descriptions from FreeBSD intro(2))
 258     IGNORE_NET_ERRORS = (
 259         # A write on a pipe, socket or FIFO for which there is
 260         # no process to read the data.
 261         errno.EPIPE,
 262         # A connection was forcibly closed by a peer.
 263         # This normally results from a loss of the connection
 264         # on the remote socket due to a timeout or a reboot.
 265         errno.ECONNRESET,
 266         # Software caused connection abort.  A connection abort
 267         # was caused internal to your host machine.
 268         errno.ECONNABORTED,
 269         # A connect or send request failed because the connected party
 270         # did not properly respond after a period of time.
 271         errno.ETIMEDOUT,
 272     )
 273
 274     def __init__(self, instance, request, env, form=None, translator=None):
 275         # re-seed the random number generator
 276         random.seed()
 277         self.start = time.time()
 278         self.instance = instance
 279         self.request = request
 280         self.env = env
 281         self.setTranslator(translator)
 282         self.mailer = Mailer(instance.config)
 283
 284         # save off the path
 285         self.path = env['PATH_INFO']
 286
 287         # this is the base URL for this tracker
 288         self.base = self.instance.config.TRACKER_WEB
 289
 290         # check the tracker_we setting
 291         if not self.base.endswith('/'):
 292             self.base = self.base + '/'
 293
 294         # this is the "cookie path" for this tracker (ie. the path part of
 295         # the "base" url)
 296         self.cookie_path = urlparse.urlparse(self.base)[2]
 297         # cookies to set in http responce
 298         # {(path, name): (value, expire)}
 299         self._cookies = {}
 300
 301         # see if we need to re-parse the environment for the form (eg Zope)
 302         if form is None:
 303             self.form = cgi.FieldStorage(environ=env)
 304         else:
 305             self.form = form
 306
 307         # turn debugging on/off
 308         try:
 309             self.debug = int(env.get("ROUNDUP_DEBUG", 0))
 310         except ValueError:
 311             # someone gave us a non-int debug level, turn it off
 312             self.debug = 0
 313
 314         # flag to indicate that the HTTP headers have been sent
 315         self.headers_done = 0
 316
 317         # additional headers to send with the request - must be registered
 318         # before the first write
 319         self.additional_headers = {}
 320         self.response_code = 200
 321
 322         # default character set
 323         self.charset = self.STORAGE_CHARSET
 324
 325         # parse cookies (used for charset lookups)
 326         # use our own LiberalCookie to handle bad apps on the same
 327         # server that have set cookies that are out of spec
 328         self.cookie = LiberalCookie(self.env.get('HTTP_COOKIE', ''))
 329
 330         self.user = None
 331         self.userid = None
 332         self.nodeid = None
 333         self.classname = None
 334         self.template = None
 335
 336     def setTranslator(self, translator=None):
 337         """Replace the translation engine
 338
 339         'translator'
 340            is TranslationService instance.
 341            It must define methods 'translate' (TAL-compatible i18n),
 342            'gettext' and 'ngettext' (gettext-compatible i18n).
 343
 344            If omitted, create default TranslationService.
 345         """
 346         if translator is None:
 347             translator = TranslationService.get_translation(
 348                 language=self.instance.config["TRACKER_LANGUAGE"],
 349                 tracker_home=self.instance.config["TRACKER_HOME"])
 350         self.translator = translator
 351         self._ = self.gettext = translator.gettext
 352         self.ngettext = translator.ngettext
 353
 354     def main(self):
 355         """ Wrap the real main in a try/finally so we always close off the db.
 356         """
 357         try:
 358             if self.env.get('CONTENT_TYPE') == 'text/xml':
 359                 self.handle_xmlrpc()
 360             else:
 361                 self.inner_main()
 362         finally:
 363             if hasattr(self, 'db'):
 364                 self.db.close()
 365
 366
 367     def handle_xmlrpc(self):
 368
 369         # Pull the raw XML out of the form.  The "value" attribute
 370         # will be the raw content of the POST request.
 371         assert self.form.file
 372         input = self.form.value
 373         # So that the rest of Roundup can query the form in the
 374         # usual way, we create an empty list of fields.
 375         self.form.list = []
 376
 377         # Set the charset and language, since other parts of
 378         # Roundup may depend upon that.
 379         self.determine_charset()
 380         self.determine_language()
 381         # Open the database as the correct user.
 382         self.determine_user()
 383
 384         # Call the appropriate XML-RPC method.
 385         handler = xmlrpc.RoundupDispatcher(self.db,
 386                                            self.instance.actions,
 387                                            self.translator,
 388                                            allow_none=True)
 389         output = handler.dispatch(input)
 390
 391         self.setHeader("Content-Type", "text/xml")
 392         self.setHeader("Content-Length", str(len(output)))
 393         self.write(output)
 394
 395     def inner_main(self):
 396         """Process a request.
 397
 398         The most common requests are handled like so:
 399
 400         1. look for charset and language preferences, set up user locale
 401            see determine_charset, determine_language
 402         2. figure out who we are, defaulting to the "anonymous" user
 403            see determine_user
 404         3. figure out what the request is for - the context
 405            see determine_context
 406         4. handle any requested action (item edit, search, ...)
 407            see handle_action
 408         5. render a template, resulting in HTML output
 409
 410         In some situations, exceptions occur:
 411
 412         - HTTP Redirect  (generally raised by an action)
 413         - SendFile       (generally raised by determine_context)
 414           serve up a FileClass "content" property
 415         - SendStaticFile (generally raised by determine_context)
 416           serve up a file from the tracker "html" directory
 417         - Unauthorised   (generally raised by an action)
 418           the action is cancelled, the request is rendered and an error
 419           message is displayed indicating that permission was not
 420           granted for the action to take place
 421         - templating.Unauthorised   (templating action not permitted)
 422           raised by an attempted rendering of a template when the user
 423           doesn't have permission
 424         - NotFound       (raised wherever it needs to be)
 425           percolates up to the CGI interface that called the client
 426         """
 427         self.ok_message = []
 428         self.error_message = []
 429         try:
 430             self.determine_charset()
 431             self.determine_language()
 432
 433             try:
 434                 # make sure we're identified (even anonymously)
 435                 self.determine_user()
 436
 437                 # figure out the context and desired content template
 438                 self.determine_context()
 439
 440                 # possibly handle a form submit action (may change self.classname
 441                 # and self.template, and may also append error/ok_messages)
 442                 html = self.handle_action()
 443
 444                 if html:
 445                     self.write_html(html)
 446                     return
 447
 448                 # now render the page
 449                 # we don't want clients caching our dynamic pages
 450                 self.additional_headers['Cache-Control'] = 'no-cache'
 451                 # Pragma: no-cache makes Mozilla and its ilk
 452                 # double-load all pages!!
 453                 #            self.additional_headers['Pragma'] = 'no-cache'
 454
 455                 # pages with messages added expire right now
 456                 # simple views may be cached for a small amount of time
 457                 # TODO? make page expire time configurable
 458                 # <rj> always expire pages, as IE just doesn't seem to do the
 459                 # right thing here :(
 460                 date = time.time() - 1
 461                 #if self.error_message or self.ok_message:
 462                 #    date = time.time() - 1
 463                 #else:
 464                 #    date = time.time() + 5
 465                 self.additional_headers['Expires'] = rfc822.formatdate(date)
 466
 467                 # render the content
 468                 self.write_html(self.renderContext())
 469             except SendFile, designator:
 470                 # The call to serve_file may result in an Unauthorised
 471                 # exception or a NotModified exception.  Those
 472                 # exceptions will be handled by the outermost set of
 473                 # exception handlers.
 474                 self.serve_file(designator)
 475             except SendStaticFile, file:
 476                 self.serve_static_file(str(file))
 477             except IOError:
 478                 # IOErrors here are due to the client disconnecting before
 479                 # recieving the reply.
 480                 pass
 481
 482         except SeriousError, message:
 483             self.write_html(str(message))
 484         except Redirect, url:
 485             # let's redirect - if the url isn't None, then we need to do
 486             # the headers, otherwise the headers have been set before the
 487             # exception was raised
 488             if url:
 489                 self.additional_headers['Location'] = str(url)
 490                 self.response_code = 302
 491             self.write_html('Redirecting to <a href="%s">%s</a>'%(url, url))
 492         except Unauthorised, message:
 493             # users may always see the front page
 494             self.response_code = 403
 495             self.classname = self.nodeid = None
 496             self.template = ''
 497             self.error_message.append(message)
 498             self.write_html(self.renderContext())
 499         except NotModified:
 500             # send the 304 response
 501             self.response_code = 304
 502             self.header()
 503         except NotFound, e:
 504             self.response_code = 404
 505             self.template = '404'
 506             try:
 507                 cl = self.db.getclass(self.classname)
 508                 self.write_html(self.renderContext())
 509             except KeyError:
 510                 # we can't map the URL to a class we know about
 511                 # reraise the NotFound and let roundup_server
 512                 # handle it
 513                 raise NotFound, e
 514         except FormError, e:
 515             self.error_message.append(self._('Form Error: ') + str(e))
 516             self.write_html(self.renderContext())
 517         except:
 518             if self.instance.config.WEB_DEBUG:
 519                 self.write_html(cgitb.html(i18n=self.translator))
 520             else:
 521                 self.mailer.exception_message()
 522                 return self.write_html(self._(error_message))
 523
 524     def clean_sessions(self):
 525         """Deprecated
 526            XXX remove
 527         """
 528         self.clean_up()
 529
 530     def clean_up(self):
 531         """Remove expired sessions and One Time Keys.
 532
 533            Do it only once an hour.
 534         """
 535         hour = 60*60
 536         now = time.time()
 537
 538         # XXX: hack - use OTK table to store last_clean time information
 539         #      'last_clean' string is used instead of otk key
 540         last_clean = self.db.getOTKManager().get('last_clean', 'last_use', 0)
 541         if now - last_clean < hour:
 542             return
 543
 544         self.session_api.clean_up()
 545         self.db.getOTKManager().clean()
 546         self.db.getOTKManager().set('last_clean', last_use=now)
 547         self.db.commit(fail_ok=True)
 548
 549     def determine_charset(self):
 550         """Look for client charset in the form parameters or browser cookie.
 551
 552         If no charset requested by client, use storage charset (utf-8).
 553
 554         If the charset is found, and differs from the storage charset,
 555         recode all form fields of type 'text/plain'
 556         """
 557         # look for client charset
 558         charset_parameter = 0
 559         if self.form.has_key('@charset'):
 560             charset = self.form['@charset'].value
 561             if charset.lower() == "none":
 562                 charset = ""
 563             charset_parameter = 1
 564         elif self.cookie.has_key('roundup_charset'):
 565             charset = self.cookie['roundup_charset'].value
 566         else:
 567             charset = None
 568         if charset:
 569             # make sure the charset is recognized
 570             try:
 571                 codecs.lookup(charset)
 572             except LookupError:
 573                 self.error_message.append(self._('Unrecognized charset: %r')
 574                     % charset)
 575                 charset_parameter = 0
 576             else:
 577                 self.charset = charset.lower()
 578         # If we've got a character set in request parameters,
 579         # set the browser cookie to keep the preference.
 580         # This is done after codecs.lookup to make sure
 581         # that we aren't keeping a wrong value.
 582         if charset_parameter:
 583             self.add_cookie('roundup_charset', charset)
 584
 585         # if client charset is different from the storage charset,
 586         # recode form fields
 587         # XXX this requires FieldStorage from Python library.
 588         #   mod_python FieldStorage is not supported!
 589         if self.charset != self.STORAGE_CHARSET:
 590             decoder = codecs.getdecoder(self.charset)
 591             encoder = codecs.getencoder(self.STORAGE_CHARSET)
 592             re_charref = re.compile('&#([0-9]+|x[0-9a-f]+);', re.IGNORECASE)
 593             def _decode_charref(matchobj):
 594                 num = matchobj.group(1)
 595                 if num[0].lower() == 'x':
 596                     uc = int(num[1:], 16)
 597                 else:
 598                     uc = int(num)
 599                 return unichr(uc)
 600
 601             for field_name in self.form.keys():
 602                 field = self.form[field_name]
 603                 if (field.type == 'text/plain') and not field.filename:
 604                     try:
 605                         value = decoder(field.value)[0]
 606                     except UnicodeError:
 607                         continue
 608                     value = re_charref.sub(_decode_charref, value)
 609                     field.value = encoder(value)[0]
 610
 611     def determine_language(self):
 612         """Determine the language"""
 613         # look for language parameter
 614         # then for language cookie
 615         # last for the Accept-Language header
 616         if self.form.has_key("@language"):
 617             language = self.form["@language"].value
 618             if language.lower() == "none":
 619                 language = ""
 620             self.add_cookie("roundup_language", language)
 621         elif self.cookie.has_key("roundup_language"):
 622             language = self.cookie["roundup_language"].value
 623         elif self.instance.config["WEB_USE_BROWSER_LANGUAGE"]:
 624             hal = self.env.get('HTTP_ACCEPT_LANGUAGE')
 625             language = accept_language.parse(hal)
 626         else:
 627             language = ""
 628
 629         self.language = language
 630         if language:
 631             self.setTranslator(TranslationService.get_translation(
 632                     language,
 633                     tracker_home=self.instance.config["TRACKER_HOME"]))
 634
 635     def determine_user(self):
 636         """Determine who the user is"""
 637         self.opendb('admin')
 638
 639         # get session data from db
 640         # XXX: rename
 641         self.session_api = Session(self)
 642
 643         # take the opportunity to cleanup expired sessions and otks
 644         self.clean_up()
 645
 646         user = None
 647         # first up, try http authorization if enabled
 648         if self.instance.config['WEB_HTTP_AUTH']:
 649             if self.env.has_key('REMOTE_USER'):
 650                 # we have external auth (e.g. by Apache)
 651                 user = self.env['REMOTE_USER']
 652             elif self.env.get('HTTP_AUTHORIZATION', ''):
 653                 # try handling Basic Auth ourselves
 654                 auth = self.env['HTTP_AUTHORIZATION']
 655                 scheme, challenge = auth.split(' ', 1)
 656                 if scheme.lower() == 'basic':
 657                     try:
 658                         decoded = base64.decodestring(challenge)
 659                     except TypeError:
 660                         # invalid challenge
 661                         pass
 662                     username, password = decoded.split(':')
 663                     try:
 664                         login = self.get_action_class('login')(self)
 665                         login.verifyLogin(username, password)
 666                     except LoginError, err:
 667                         self.make_user_anonymous()
 668                         raise Unauthorised, err
 669                     user = username
 670
 671         # if user was not set by http authorization, try session lookup
 672         if not user:
 673             user = self.session_api.get('user')
 674             if user:
 675                 # update session lifetime datestamp
 676                 self.session_api.update()
 677
 678         # if no user name set by http authorization or session lookup
 679         # the user is anonymous
 680         if not user:
 681             user = 'anonymous'
 682
 683         # sanity check on the user still being valid,
 684         # getting the userid at the same time
 685         try:
 686             self.userid = self.db.user.lookup(user)
 687         except (KeyError, TypeError):
 688             user = 'anonymous'
 689
 690         # make sure the anonymous user is valid if we're using it
 691         if user == 'anonymous':
 692             self.make_user_anonymous()
 693             if not self.db.security.hasPermission('Web Access', self.userid):
 694                 raise Unauthorised, self._("Anonymous users are not "
 695                     "allowed to use the web interface")
 696         else:
 697             self.user = user
 698
 699         # reopen the database as the correct user
 700         self.opendb(self.user)
 701
 702     def opendb(self, username):
 703         """Open the database and set the current user.
 704
 705         Opens a database once. On subsequent calls only the user is set on
 706         the database object the instance.optimize is set. If we are in
 707         "Development Mode" (cf. roundup_server) then the database is always
 708         re-opened.
 709         """
 710         # don't do anything if the db is open and the user has not changed
 711         if hasattr(self, 'db') and self.db.isCurrentUser(username):
 712             return
 713
 714         # open the database or only set the user
 715         if not hasattr(self, 'db'):
 716             self.db = self.instance.open(username)
 717         else:
 718             if self.instance.optimize:
 719                 self.db.setCurrentUser(username)
 720             else:
 721                 self.db.close()
 722                 self.db = self.instance.open(username)
 723                 # The old session API refers to the closed database;
 724                 # we can no longer use it.
 725                 self.session_api = Session(self)
 726
 727
 728     def determine_context(self, dre=re.compile(r'([^\d]+)0*(\d+)')):
 729         """Determine the context of this page from the URL:
 730
 731         The URL path after the instance identifier is examined. The path
 732         is generally only one entry long.
 733
 734         - if there is no path, then we are in the "home" context.
 735         - if the path is "_file", then the additional path entry
 736           specifies the filename of a static file we're to serve up
 737           from the instance "html" directory. Raises a SendStaticFile
 738           exception.(*)
 739         - if there is something in the path (eg "issue"), it identifies
 740           the tracker class we're to display.
 741         - if the path is an item designator (eg "issue123"), then we're
 742           to display a specific item.
 743         - if the path starts with an item designator and is longer than
 744           one entry, then we're assumed to be handling an item of a
 745           FileClass, and the extra path information gives the filename
 746           that the client is going to label the download with (ie
 747           "file123/image.png" is nicer to download than "file123"). This
 748           raises a SendFile exception.(*)
 749
 750         Both of the "*" types of contexts stop before we bother to
 751         determine the template we're going to use. That's because they
 752         don't actually use templates.
 753
 754         The template used is specified by the :template CGI variable,
 755         which defaults to:
 756
 757         - only classname suplied:          "index"
 758         - full item designator supplied:   "item"
 759
 760         We set:
 761
 762              self.classname  - the class to display, can be None
 763
 764              self.template   - the template to render the current context with
 765
 766              self.nodeid     - the nodeid of the class we're displaying
 767         """
 768         # default the optional variables
 769         self.classname = None
 770         self.nodeid = None
 771
 772         # see if a template or messages are specified
 773         template_override = ok_message = error_message = None
 774         for key in self.form.keys():
 775             if self.FV_TEMPLATE.match(key):
 776                 template_override = self.form[key].value
 777             elif self.FV_OK_MESSAGE.match(key):
 778                 ok_message = self.form[key].value
 779                 ok_message = clean_message(ok_message)
 780             elif self.FV_ERROR_MESSAGE.match(key):
 781                 error_message = self.form[key].value
 782                 error_message = clean_message(error_message)
 783
 784         # see if we were passed in a message
 785         if ok_message:
 786             self.ok_message.append(ok_message)
 787         if error_message:
 788             self.error_message.append(error_message)
 789
 790         # determine the classname and possibly nodeid
 791         path = self.path.split('/')
 792         if not path or path[0] in ('', 'home', 'index'):
 793             if template_override is not None:
 794                 self.template = template_override
 795             else:
 796                 self.template = ''
 797             return
 798         elif path[0] in ('_file', '@@file'):
 799             raise SendStaticFile, os.path.join(*path[1:])
 800         else:
 801             self.classname = path[0]
 802             if len(path) > 1:
 803                 # send the file identified by the designator in path[0]
 804                 raise SendFile, path[0]
 805
 806         # see if we got a designator
 807         m = dre.match(self.classname)
 808         if m:
 809             self.classname = m.group(1)
 810             self.nodeid = m.group(2)
 811             try:
 812                 klass = self.db.getclass(self.classname)
 813             except KeyError:
 814                 raise NotFound, '%s/%s'%(self.classname, self.nodeid)
 815             if not klass.hasnode(self.nodeid):
 816                 raise NotFound, '%s/%s'%(self.classname, self.nodeid)
 817             # with a designator, we default to item view
 818             self.template = 'item'
 819         else:
 820             # with only a class, we default to index view
 821             self.template = 'index'
 822
 823         # make sure the classname is valid
 824         try:
 825             self.db.getclass(self.classname)
 826         except KeyError:
 827             raise NotFound, self.classname
 828
 829         # see if we have a template override
 830         if template_override is not None:
 831             self.template = template_override
 832
 833     def serve_file(self, designator, dre=re.compile(r'([^\d]+)(\d+)')):
 834         """ Serve the file from the content property of the designated item.
 835         """
 836         m = dre.match(str(designator))
 837         if not m:
 838             raise NotFound, str(designator)
 839         classname, nodeid = m.group(1), m.group(2)
 840
 841         klass = self.db.getclass(classname)
 842
 843         # make sure we have the appropriate properties
 844         props = klass.getprops()
 845         if not props.has_key('type'):
 846             raise NotFound, designator
 847         if not props.has_key('content'):
 848             raise NotFound, designator
 849
 850         # make sure we have permission
 851         if not self.db.security.hasPermission('View', self.userid,
 852                 classname, 'content', nodeid):
 853             raise Unauthorised, self._("You are not allowed to view "
 854                 "this file.")
 855
 856         mime_type = klass.get(nodeid, 'type')
 857
 858         # if the mime_type is HTML-ish then make sure we're allowed to serve up
 859         # HTML-ish content
 860         if mime_type in ('text/html', 'text/x-html'):
 861             if not self.instance.config['WEB_ALLOW_HTML_FILE']:
 862                 # do NOT serve the content up as HTML
 863                 mime_type = 'application/octet-stream'
 864
 865         # If this object is a file (i.e., an instance of FileClass),
 866         # see if we can find it in the filesystem.  If so, we may be
 867         # able to use the more-efficient request.sendfile method of
 868         # sending the file.  If not, just get the "content" property
 869         # in the usual way, and use that.
 870         content = None
 871         filename = None
 872         if isinstance(klass, hyperdb.FileClass):
 873             try:
 874                 filename = self.db.filename(classname, nodeid)
 875             except AttributeError:
 876                 # The database doesn't store files in the filesystem
 877                 # and therefore doesn't provide the "filename" method.
 878                 pass
 879             except IOError:
 880                 # The file does not exist.
 881                 pass
 882         if not filename:
 883             content = klass.get(nodeid, 'content')
 884
 885         lmt = klass.get(nodeid, 'activity').timestamp()
 886
 887         self._serve_file(lmt, mime_type, content, filename)
 888
 889     def serve_static_file(self, file):
 890         """ Serve up the file named from the templates dir
 891         """
 892         # figure the filename - try STATIC_FILES, then TEMPLATES dir
 893         for dir_option in ('STATIC_FILES', 'TEMPLATES'):
 894             prefix = self.instance.config[dir_option]
 895             if not prefix:
 896                 continue
 897             # ensure the load doesn't try to poke outside
 898             # of the static files directory
 899             prefix = os.path.normpath(prefix)
 900             filename = os.path.normpath(os.path.join(prefix, file))
 901             if os.path.isfile(filename) and filename.startswith(prefix):
 902                 break
 903         else:
 904             raise NotFound, file
 905
 906         # last-modified time
 907         lmt = os.stat(filename)[stat.ST_MTIME]
 908
 909         # detemine meta-type
 910         file = str(file)
 911         mime_type = mimetypes.guess_type(file)[0]
 912         if not mime_type:
 913             if file.endswith('.css'):
 914                 mime_type = 'text/css'
 915             else:
 916                 mime_type = 'text/plain'
 917
 918         self._serve_file(lmt, mime_type, '', filename)
 919
 920     def _serve_file(self, lmt, mime_type, content=None, filename=None):
 921         """ guts of serve_file() and serve_static_file()
 922         """
 923
 924         # spit out headers
 925         self.additional_headers['Content-Type'] = mime_type
 926         self.additional_headers['Last-Modified'] = rfc822.formatdate(lmt)
 927
 928         ims = None
 929         # see if there's an if-modified-since...
 930         # XXX see which interfaces set this
 931         #if hasattr(self.request, 'headers'):
 932             #ims = self.request.headers.getheader('if-modified-since')
 933         if self.env.has_key('HTTP_IF_MODIFIED_SINCE'):
 934             # cgi will put the header in the env var
 935             ims = self.env['HTTP_IF_MODIFIED_SINCE']
 936         if ims:
 937             ims = rfc822.parsedate(ims)[:6]
 938             lmtt = time.gmtime(lmt)[:6]
 939             if lmtt <= ims:
 940                 raise NotModified
 941
 942         if filename:
 943             self.write_file(filename)
 944         else:
 945             self.additional_headers['Content-Length'] = str(len(content))
 946             self.write(content)
 947
 948     def renderContext(self):
 949         """ Return a PageTemplate for the named page
 950         """
 951         name = self.classname
 952         extension = self.template
 953
 954         # catch errors so we can handle PT rendering errors more nicely
 955         args = {
 956             'ok_message': self.ok_message,
 957             'error_message': self.error_message
 958         }
 959         try:
 960             pt = self.instance.templates.get(name, extension)
 961             # let the template render figure stuff out
 962             result = pt.render(self, None, None, **args)
 963             self.additional_headers['Content-Type'] = pt.content_type
 964             if self.env.get('CGI_SHOW_TIMING', ''):
 965                 if self.env['CGI_SHOW_TIMING'].upper() == 'COMMENT':
 966                     timings = {'starttag': '<!-- ', 'endtag': ' -->'}
 967                 else:
 968                     timings = {'starttag': '<p>', 'endtag': '</p>'}
 969                 timings['seconds'] = time.time()-self.start
 970                 s = self._('%(starttag)sTime elapsed: %(seconds)fs%(endtag)s\n'
 971                     ) % timings
 972                 if hasattr(self.db, 'stats'):
 973                     timings.update(self.db.stats)
 974                     s += self._("%(starttag)sCache hits: %(cache_hits)d,"
 975                         " misses %(cache_misses)d."
 976                         " Loading items: %(get_items)f secs."
 977                         " Filtering: %(filtering)f secs."
 978                         "%(endtag)s\n") % timings
 979                 s += '</body>'
 980                 result = result.replace('</body>', s)
 981             return result
 982         except templating.NoTemplate, message:
 983             return '<strong>%s</strong>'%message
 984         except templating.Unauthorised, message:
 985             raise Unauthorised, str(message)
 986         except:
 987             # everything else
 988             if self.instance.config.WEB_DEBUG:
 989                 return cgitb.pt_html(i18n=self.translator)
 990             exc_info = sys.exc_info()
 991             try:
 992                 # If possible, send the HTML page template traceback
 993                 # to the administrator.
 994                 to = [self.mailer.config.ADMIN_EMAIL]
 995                 subject = "Templating Error: %s" % exc_info[1]
 996                 content = cgitb.pt_html()
 997                 message = self.mailer.get_standard_message(to, subject)
 998                 # delete existing content-type headers
 999                 del message['Content-type']
1000                 message['Content-type'] = 'text/html; charset=utf-8'
1001                 message.set_payload(content)
1002                 encode_quopri(message)
1003                 self.mailer.smtp_send(to, str(message))
1004                 # Now report the error to the user.
1005                 return self._(error_message)
1006             except:
1007                 # Reraise the original exception.  The user will
1008                 # receive an error message, and the adminstrator will
1009                 # receive a traceback, albeit with less information
1010                 # than the one we tried to generate above.
1011                 raise exc_info[0], exc_info[1], exc_info[2]
1012
1013     # these are the actions that are available
1014     actions = (
1015         ('edit',        EditItemAction),
1016         ('editcsv',     EditCSVAction),
1017         ('new',         NewItemAction),
1018         ('register',    RegisterAction),
1019         ('confrego',    ConfRegoAction),
1020         ('passrst',     PassResetAction),
1021         ('login',       LoginAction),
1022         ('logout',      LogoutAction),
1023         ('search',      SearchAction),
1024         ('retire',      RetireAction),
1025         ('show',        ShowAction),
1026         ('export_csv',  ExportCSVAction),
1027     )
1028     def handle_action(self):
1029         """ Determine whether there should be an Action called.
1030
1031             The action is defined by the form variable :action which
1032             identifies the method on this object to call. The actions
1033             are defined in the "actions" sequence on this class.
1034
1035             Actions may return a page (by default HTML) to return to the
1036             user, bypassing the usual template rendering.
1037
1038             We explicitly catch Reject and ValueError exceptions and
1039             present their messages to the user.
1040         """
1041         if self.form.has_key(':action'):
1042             action = self.form[':action'].value.lower()
1043         elif self.form.has_key('@action'):
1044             action = self.form['@action'].value.lower()
1045         else:
1046             return None
1047
1048         try:
1049             action_klass = self.get_action_class(action)
1050
1051             # call the mapped action
1052             if isinstance(action_klass, type('')):
1053                 # old way of specifying actions
1054                 return getattr(self, action_klass)()
1055             else:
1056                 return action_klass(self).execute()
1057
1058         except (ValueError, Reject), err:
1059             self.error_message.append(str(err))
1060
1061     def get_action_class(self, action_name):
1062         if (hasattr(self.instance, 'cgi_actions') and
1063                 self.instance.cgi_actions.has_key(action_name)):
1064             # tracker-defined action
1065             action_klass = self.instance.cgi_actions[action_name]
1066         else:
1067             # go with a default
1068             for name, action_klass in self.actions:
1069                 if name == action_name:
1070                     break
1071             else:
1072                 raise ValueError, 'No such action "%s"'%action_name
1073         return action_klass
1074
1075     def _socket_op(self, call, *args, **kwargs):
1076         """Execute socket-related operation, catch common network errors
1077
1078         Parameters:
1079             call: a callable to execute
1080             args, kwargs: call arguments
1081
1082         """
1083         try:
1084             call(*args, **kwargs)
1085         except socket.error, err:
1086             err_errno = getattr (err, 'errno', None)
1087             if err_errno is None:
1088                 try:
1089                     err_errno = err[0]
1090                 except TypeError:
1091                     pass
1092             if err_errno not in self.IGNORE_NET_ERRORS:
1093                 raise
1094         except IOError:
1095             # Apache's mod_python will raise IOError -- without an
1096             # accompanying errno -- when a write to the client fails.
1097             # A common case is that the client has closed the
1098             # connection.  There's no way to be certain that this is
1099             # the situation that has occurred here, but that is the
1100             # most likely case.
1101             pass
1102
1103     def write(self, content):
1104         if not self.headers_done:
1105             self.header()
1106         if self.env['REQUEST_METHOD'] != 'HEAD':
1107             self._socket_op(self.request.wfile.write, content)
1108
1109     def write_html(self, content):
1110         if not self.headers_done:
1111             # at this point, we are sure about Content-Type
1112             if not self.additional_headers.has_key('Content-Type'):
1113                 self.additional_headers['Content-Type'] = \
1114                     'text/html; charset=%s' % self.charset
1115             self.header()
1116
1117         if self.env['REQUEST_METHOD'] == 'HEAD':
1118             # client doesn't care about content
1119             return
1120
1121         if self.charset != self.STORAGE_CHARSET:
1122             # recode output
1123             content = content.decode(self.STORAGE_CHARSET, 'replace')
1124             content = content.encode(self.charset, 'xmlcharrefreplace')
1125
1126         # and write
1127         self._socket_op(self.request.wfile.write, content)
1128
1129     def http_strip(self, content):
1130         """Remove HTTP Linear White Space from 'content'.
1131
1132         'content' -- A string.
1133
1134         returns -- 'content', with all leading and trailing LWS
1135         removed."""
1136
1137         # RFC 2616 2.2: Basic Rules
1138         #
1139         # LWS = [CRLF] 1*( SP | HT )
1140         return content.strip(" \r\n\t")
1141
1142     def http_split(self, content):
1143         """Split an HTTP list.
1144
1145         'content' -- A string, giving a list of items.
1146
1147         returns -- A sequence of strings, containing the elements of
1148         the list."""
1149
1150         # RFC 2616 2.1: Augmented BNF
1151         #
1152         # Grammar productions of the form "#rule" indicate a
1153         # comma-separated list of elements matching "rule".  LWS
1154         # is then removed from each element, and empty elements
1155         # removed.
1156
1157         # Split at commas.
1158         elements = content.split(",")
1159         # Remove linear whitespace at either end of the string.
1160         elements = [self.http_strip(e) for e in elements]
1161         # Remove any now-empty elements.
1162         return [e for e in elements if e]
1163
1164     def handle_range_header(self, length, etag):
1165         """Handle the 'Range' and 'If-Range' headers.
1166
1167         'length' -- the length of the content available for the
1168         resource.
1169
1170         'etag' -- the entity tag for this resources.
1171
1172         returns -- If the request headers (including 'Range' and
1173         'If-Range') indicate that only a portion of the entity should
1174         be returned, then the return value is a pair '(offfset,
1175         length)' indicating the first byte and number of bytes of the
1176         content that should be returned to the client.  In addition,
1177         this method will set 'self.response_code' to indicate Partial
1178         Content.  In all other cases, the return value is 'None'.  If
1179         appropriate, 'self.response_code' will be
1180         set to indicate 'REQUESTED_RANGE_NOT_SATISFIABLE'.  In that
1181         case, the caller should not send any data to the client."""
1182
1183         # RFC 2616 14.35: Range
1184         #
1185         # See if the Range header is present.
1186         ranges_specifier = self.env.get("HTTP_RANGE")
1187         if ranges_specifier is None:
1188             return None
1189         # RFC 2616 14.27: If-Range
1190         #
1191         # Check to see if there is an If-Range header.
1192         # Because the specification says:
1193         #
1194         #  The If-Range header ... MUST be ignored if the request
1195         #  does not include a Range header, we check for If-Range
1196         #  after checking for Range.
1197         if_range = self.env.get("HTTP_IF_RANGE")
1198         if if_range:
1199             # The grammar for the If-Range header is:
1200             #
1201             #   If-Range = "If-Range" ":" ( entity-tag | HTTP-date )
1202             #   entity-tag = [ weak ] opaque-tag
1203             #   weak = "W/"
1204             #   opaque-tag = quoted-string
1205             #
1206             # We only support strong entity tags.
1207             if_range = self.http_strip(if_range)
1208             if (not if_range.startswith('"')
1209                 or not if_range.endswith('"')):
1210                 return None
1211             # If the condition doesn't match the entity tag, then we
1212             # must send the client the entire file.
1213             if if_range != etag:
1214                 return
1215         # The grammar for the Range header value is:
1216         #
1217         #   ranges-specifier = byte-ranges-specifier
1218         #   byte-ranges-specifier = bytes-unit "=" byte-range-set
1219         #   byte-range-set = 1#( byte-range-spec | suffix-byte-range-spec )
1220         #   byte-range-spec = first-byte-pos "-" [last-byte-pos]
1221         #   first-byte-pos = 1*DIGIT
1222         #   last-byte-pos = 1*DIGIT
1223         #   suffix-byte-range-spec = "-" suffix-length
1224         #   suffix-length = 1*DIGIT
1225         #
1226         # Look for the "=" separating the units from the range set.
1227         specs = ranges_specifier.split("=", 1)
1228         if len(specs) != 2:
1229             return None
1230         # Check that the bytes-unit is in fact "bytes".  If it is not,
1231         # we do not know how to process this range.
1232         bytes_unit = self.http_strip(specs[0])
1233         if bytes_unit != "bytes":
1234             return None
1235         # Seperate the range-set into range-specs.
1236         byte_range_set = self.http_strip(specs[1])
1237         byte_range_specs = self.http_split(byte_range_set)
1238         # We only handle exactly one range at this time.
1239         if len(byte_range_specs) != 1:
1240             return None
1241         # Parse the spec.
1242         byte_range_spec = byte_range_specs[0]
1243         pos = byte_range_spec.split("-", 1)
1244         if len(pos) != 2:
1245             return None
1246         # Get the first and last bytes.
1247         first = self.http_strip(pos[0])
1248         last = self.http_strip(pos[1])
1249         # We do not handle suffix ranges.
1250         if not first:
1251             return None
1252        # Convert the first and last positions to integers.
1253         try:
1254             first = int(first)
1255             if last:
1256                 last = int(last)
1257             else:
1258                 last = length - 1
1259         except:
1260             # The positions could not be parsed as integers.
1261             return None
1262         # Check that the range makes sense.
1263         if (first < 0 or last < 0 or last < first):
1264             return None
1265         if last >= length:
1266             # RFC 2616 10.4.17: 416 Requested Range Not Satisfiable
1267             #
1268             # If there is an If-Range header, RFC 2616 says that we
1269             # should just ignore the invalid Range header.
1270             if if_range:
1271                 return None
1272             # Return code 416 with a Content-Range header giving the
1273             # allowable range.
1274             self.response_code = httplib.REQUESTED_RANGE_NOT_SATISFIABLE
1275             self.setHeader("Content-Range", "bytes */%d" % length)
1276             return None
1277         # RFC 2616 10.2.7: 206 Partial Content
1278         #
1279         # Tell the client that we are honoring the Range request by
1280         # indicating that we are providing partial content.
1281         self.response_code = httplib.PARTIAL_CONTENT
1282         # RFC 2616 14.16: Content-Range
1283         #
1284         # Tell the client what data we are providing.
1285         #
1286         #   content-range-spec = byte-content-range-spec
1287         #   byte-content-range-spec = bytes-unit SP
1288         #                             byte-range-resp-spec "/"
1289         #                             ( instance-length | "*" )
1290         #   byte-range-resp-spec = (first-byte-pos "-" last-byte-pos)
1291         #                          | "*"
1292         #   instance-length      = 1 * DIGIT
1293         self.setHeader("Content-Range",
1294                        "bytes %d-%d/%d" % (first, last, length))
1295         return (first, last - first + 1)
1296
1297     def write_file(self, filename):
1298         """Send the contents of 'filename' to the user."""
1299
1300         # Determine the length of the file.
1301         stat_info = os.stat(filename)
1302         length = stat_info[stat.ST_SIZE]
1303         # Assume we will return the entire file.
1304         offset = 0
1305         # If the headers have not already been finalized,
1306         if not self.headers_done:
1307             # RFC 2616 14.19: ETag
1308             #
1309             # Compute the entity tag, in a format similar to that
1310             # used by Apache.
1311             etag = '"%x-%x-%x"' % (stat_info[stat.ST_INO],
1312                                    length,
1313                                    stat_info[stat.ST_MTIME])
1314             self.setHeader("ETag", etag)
1315             # RFC 2616 14.5: Accept-Ranges
1316             #
1317             # Let the client know that we will accept range requests.
1318             self.setHeader("Accept-Ranges", "bytes")
1319             # RFC 2616 14.35: Range
1320             #
1321             # If there is a Range header, we may be able to avoid
1322             # sending the entire file.
1323             content_range = self.handle_range_header(length, etag)
1324             if content_range:
1325                 offset, length = content_range
1326             # RFC 2616 14.13: Content-Length
1327             #
1328             # Tell the client how much data we are providing.
1329             self.setHeader("Content-Length", str(length))
1330             # Send the HTTP header.
1331             self.header()
1332         # If the client doesn't actually want the body, or if we are
1333         # indicating an invalid range.
1334         if (self.env['REQUEST_METHOD'] == 'HEAD'
1335             or self.response_code == httplib.REQUESTED_RANGE_NOT_SATISFIABLE):
1336             return
1337         # Use the optimized "sendfile" operation, if possible.
1338         if hasattr(self.request, "sendfile"):
1339             self._socket_op(self.request.sendfile, filename, offset, length)
1340             return
1341         # Fallback to the "write" operation.
1342         f = open(filename, 'rb')
1343         try:
1344             if offset:
1345                 f.seek(offset)
1346             content = f.read(length)
1347         finally:
1348             f.close()
1349         self.write(content)
1350
1351     def setHeader(self, header, value):
1352         """Override a header to be returned to the user's browser.
1353         """
1354         self.additional_headers[header] = value
1355
1356     def header(self, headers=None, response=None):
1357         """Put up the appropriate header.
1358         """
1359         if headers is None:
1360             headers = {'Content-Type':'text/html; charset=utf-8'}
1361         if response is None:
1362             response = self.response_code
1363
1364         # update with additional info
1365         headers.update(self.additional_headers)
1366
1367         if headers.get('Content-Type', 'text/html') == 'text/html':
1368             headers['Content-Type'] = 'text/html; charset=utf-8'
1369
1370         headers = headers.items()
1371
1372         for ((path, name), (value, expire)) in self._cookies.items():
1373             cookie = "%s=%s; Path=%s;"%(name, value, path)
1374             if expire is not None:
1375                 cookie += " expires=%s;"%Cookie._getdate(expire)
1376             headers.append(('Set-Cookie', cookie))
1377
1378         self._socket_op(self.request.start_response, headers, response)
1379
1380         self.headers_done = 1
1381         if self.debug:
1382             self.headers_sent = headers
1383
1384     def add_cookie(self, name, value, expire=86400*365, path=None):
1385         """Set a cookie value to be sent in HTTP headers
1386
1387         Parameters:
1388             name:
1389                 cookie name
1390             value:
1391                 cookie value
1392             expire:
1393                 cookie expiration time (seconds).
1394                 If value is empty (meaning "delete cookie"),
1395                 expiration time is forced in the past
1396                 and this argument is ignored.
1397                 If None, the cookie will expire at end-of-session.
1398                 If omitted, the cookie will be kept for a year.
1399             path:
1400                 cookie path (optional)
1401
1402         """
1403         if path is None:
1404             path = self.cookie_path
1405         if not value:
1406             expire = -1
1407         self._cookies[(path, name)] = (value, expire)
1408
1409     def set_cookie(self, user, expire=None):
1410         """Deprecated. Use session_api calls directly
1411
1412         XXX remove
1413         """
1414
1415         # insert the session in the session db
1416         self.session_api.set(user=user)
1417         # refresh session cookie
1418         self.session_api.update(set_cookie=True, expire=expire)
1419
1420     def make_user_anonymous(self):
1421         """ Make us anonymous
1422
1423             This method used to handle non-existence of the 'anonymous'
1424             user, but that user is mandatory now.
1425         """
1426         self.userid = self.db.user.lookup('anonymous')
1427         self.user = 'anonymous'
1428
1429     def standard_message(self, to, subject, body, author=None):
1430         """Send a standard email message from Roundup.
1431
1432         "to"      - recipients list
1433         "subject" - Subject
1434         "body"    - Message
1435         "author"  - (name, address) tuple or None for admin email
1436
1437         Arguments are passed to the Mailer.standard_message code.
1438         """
1439         try:
1440             self.mailer.standard_message(to, subject, body, author)
1441         except MessageSendError, e:
1442             self.error_message.append(str(e))
1443             return 0
1444         return 1
1445
1446     def parsePropsFromForm(self, create=0):
1447         return FormParser(self).parse(create=create)
1448
1449 # vim: set et sts=4 sw=4 :