67bc56d23e7c92786d4412015a586ccec189b497
[debianmemberportfolio.git] / debianmemberportfolio / controllers / error.py
1 # -*- python -*-
2 # -*- coding: utf-8 -*-
3 #
4 # DDPortfolio service ErrorController
5 # Copyright © 2009, 2010, 2011, 2012 Jan Dittberner <jan@dittberner.info>
6 #
7 # This file is part of DDPortfolio service.
8 #
9 # DDPortfolio service is free software: you can redistribute it and/or
10 # modify it under the terms of the GNU Affero General Public License
11 # as published by the Free Software Foundation, either version 3 of
12 # the License, or (at your option) any later version.
13 #
14 # DDPortfolio service is distributed in the hope that it will be
15 # useful, but WITHOUT ANY WARRANTY; without even the implied warranty
16 # of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 # Affero General Public License for more details.
18 #
19 # You should have received a copy of the GNU Affero General Public
20 # License along with this program.  If not, see
21 # <http://www.gnu.org/licenses/>.
22 #
23 import cgi
24
25 from paste.urlparser import PkgResourcesParser
26 from pylons import request
27 from pylons.controllers.util import forward
28 from pylons.middleware import error_document_template
29 from webhelpers.html.builder import literal
30
31 from ddportfolioservice.lib.base import BaseController
32
33
34 class ErrorController(BaseController):
35     """Generates error documents as and when they are required.
36
37     The ErrorDocuments middleware forwards to ErrorController when error
38     related status codes are returned from the application.
39
40     This behaviour can be altered by changing the parameters to the
41     ErrorDocuments middleware in your config/middleware.py file.
42     """
43
44     def document(self):
45         """Render the error document"""
46         resp = request.environ.get('pylons.original_response')
47         content = literal(resp.body) or cgi.escape(
48             request.GET.get('message', ''))
49         page = error_document_template % \
50             dict(prefix=request.environ.get('SCRIPT_NAME', ''),
51                  code=cgi.escape(
52                     request.GET.get('code', str(resp.status_int))),
53                  message=content)
54         return page
55
56     def img(self, id):
57         """Serve Pylons' stock images"""
58         return self._serve_file('/'.join(['media/img', id]))
59
60     def style(self, id):
61         """Serve Pylons' stock stylesheets"""
62         return self._serve_file('/'.join(['media/style', id]))
63
64     def _serve_file(self, path):
65         """
66         Call Paste's FileApp (a WSGI application) to serve the file at
67         the specified path
68         """
69         request.environ['PATH_INFO'] = '/%s' % path
70         return forward(PkgResourcesParser('pylons', 'pylons'))