Mercurial Repository: p/roundup/code: roundup/cgi/client.py comparison

comparison roundup/cgi/client.py @ 6638:e1588ae185dc issue2550923_computed_property

merge from default branch. Fix travis.ci so CI builds don't error out

author	John Rouillard <rouilj@ieee.org>
date	Thu, 21 Apr 2022 16:54:17 -0400
parents	91ab3e0ffcd0
children	33616bc80baf

comparison

equal deleted inserted replaced

-:85db90cc1705
+:e1588ae185dc
 from roundup.cgi import templating, cgitb, TranslationService
 from roundup.cgi import actions
 from roundup.exceptions import LoginError, Reject, RejectRaw, \
 Unauthorised, UsageError
 from roundup.cgi.exceptions import (
-FormError, NotFound, NotModified, Redirect, SendFile, SendStaticFile,
+FormError, IndexerQueryError, NotFound, NotModified, Redirect,
-DetectorError, SeriousError)
+SendFile, SendStaticFile, DetectorError, SeriousError)
 from roundup.cgi.form_parser import FormParser
 from roundup.mailer import Mailer, MessageSendError
 from roundup.cgi import accept_language
 from roundup import xmlrpc
 from roundup import rest
 # Cache_Control[key] = Cache-Control header value
 # Key can be explicitly file basename - value applied to just that file
 #     takes precedence over mime type.
 # Key can be mime type - all files of that mimetype will get the value
-Cache_Control = {}
+Cache_Control = {
+'application/javascript': "public, max-age=1209600", # 2 weeks
+'text/css':               "public, max-age=4838400", # 8 weeks/2 months
+}
 # list of valid http compression (Content-Encoding) algorithms
 # we have available
 compressors = []
 try:
 output = handler.dispatch(self.env['REQUEST_METHOD'],
 self.path, self.form)
 # type header set by rest handler
 # self.setHeader("Content-Type", "text/xml")
-self.setHeader("Content-Length", str(len(output)))
+if self.response_code == 204: # no body with 204
-self.write(output)
+self.write("")
+else:
+self.setHeader("Content-Length", str(len(output)))
+self.write(output)
 def add_ok_message(self, msg, escape=True):
 add_message(self._ok_message, msg, escape)
 def add_error_message(self, msg, escape=True):
 self.send_error_to_admin(e.subject, e.html, e.txt)
 self.write_html(e.html)
 else:
 # in debug mode, only write error to screen.
 self.write_html(e.html)
-except:
+except Exception as e:
 # Something has gone badly wrong.  Therefore, we should
 # make sure that the response code indicates failure.
 if self.response_code == http_.client.OK:
 self.response_code = http_.client.INTERNAL_SERVER_ERROR
 # Help the administrator work out what went wrong.
 def _serve_file(self, lmt, mime_type, content=None, filename=None):
 """ guts of serve_file() and serve_static_file()
 """
 # spit out headers
-self.additional_headers['Content-Type'] = mime_type
 self.additional_headers['Last-Modified'] = email.utils.formatdate(lmt)
 ims = None
 # see if there's an if-modified-since...
 #    used if this is run behind a non-caching http proxy
 # set vary header as though we were returning 200
 # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Vary
 self.setVary("Accept-Encoding")
 raise NotModified
+# don't set until we are sure we are sending a response body.
+self.additional_headers['Content-Type'] = mime_type
 if filename:
 self.write_file(filename)
 else:
 self.additional_headers['Content-Length'] = str(len(content))
 self.write(content)
 'ok_message': self._ok_message,
 'error_message': self._error_message
 }
 pt = self.instance.templates.load(tplname)
 # let the template render figure stuff out
-result = pt.render(self, None, None, **args)
+try:
+result = pt.render(self, None, None, **args)
+except IndexerQueryError as e:
+result = self.renderError(e.args[0])
 self.additional_headers['Content-Type'] = pt.content_type
 if self.env.get('CGI_SHOW_TIMING', ''):
 if self.env['CGI_SHOW_TIMING'].upper() == 'COMMENT':
 timings = {'starttag': '<!-- ', 'endtag': ' -->'}
 else:
 if sys.version_info[0] > 2:
 raise exc_info[0](exc_info[1]).with_traceback(exc_info[2])
 else:
 exec('raise exc_info[0], exc_info[1], exc_info[2]')  # nosec
+def renderError(self, error, response_code=400, use_template=True):
+self.response_code = response_code
+# see if error message already logged add if not
+if error not in self._error_message:
+self.add_error_message(error, escape=True)
+# allow use of template for a specific code
+trial_templates = []
+if use_template:
+if response_code == 400:
+trial_templates = [ "400" ]
+else:
+trial_templates = [ str(response_code), "400" ]
+tplname = None
+for rcode in trial_templates:
+try:
+tplname = self.selectTemplate(self.classname, rcode)
+break
+except templating.NoTemplate:
+pass
+if not tplname:
+# call string of serious error to get basic html
+# response.
+return str(SeriousError(error))
+args = {
+'ok_message': self._ok_message,
+'error_message': self._error_message
+}
+try:
+pt = self.instance.templates.load(tplname)
+return pt.render(self, None, None, **args)
+except Exception:
+# report original error
+return str(SeriousError(error))
 # these are the actions that are available
 actions = (
 ('edit',        actions.EditItemAction),
 ('editcsv',     actions.EditCSVAction),
 ('new',         actions.NewItemAction),
 # we changed the data, change existing content-length header
 # and add Content-Encoding and Vary header.
 self.additional_headers['Content-Length'] = str(len(new_content))
 self.additional_headers['Content-Encoding'] = encoder
 self.setVary('Accept-Encoding')
+try:
+current_etag = self.additional_headers['ETag']
+except KeyError:
+pass  # etag not set for non-rest endpoints
+else:
+etag_end = current_etag.rindex('"')
+self.additional_headers['ETag'] = ( current_etag[:etag_end] +
+'-' + encoder + current_etag[etag_end:])
 return new_content
 def write(self, content):
 if not self.headers_done and self.env['REQUEST_METHOD'] != 'HEAD':
 if not self.headers_done:
 # at this point, we are sure about Content-Type
 if 'Content-Type' not in self.additional_headers:
 self.additional_headers['Content-Type'] = \
 'text/html; charset=%s' % self.charset
+if 'Content-Length' not in self.additional_headers:
+self.additional_headers['Content-Length'] = str(len(content))
 self.header()
 if self.env['REQUEST_METHOD'] == 'HEAD':
 # client doesn't care about content
 return
 finally:
 f.close()
 self.write(content)
 def setHeader(self, header, value):
-"""Override a header to be returned to the user's browser.
+"""Override or delete a header to be returned to the user's browser.
 """
-self.additional_headers[header] = value
+if value is None:
+try:
+del(self.additional_headers[header])
+except KeyError:
+pass
+else:
+self.additional_headers[header] = value
 def header(self, headers=None, response=None):
 """Put up the appropriate header.
 """
 if headers is None:
 # update with additional info
 headers.update(self.additional_headers)
 if headers.get('Content-Type', 'text/html') == 'text/html':
 headers['Content-Type'] = 'text/html; charset=utf-8'
+if response in [ 204, 304]: # has no body so no content-type
+del(headers['Content-Type'])
 headers = list(headers.items())
 for ((path, name), (value, expire)) in self._cookies.items():
 cookie = "%s=%s; Path=%s;"%(name, value, path)

Mercurial > p > roundup > code

comparison roundup/cgi/client.py @ 6638:e1588ae185dc issue2550923_computed_property