ipsilon/util/page.py

   1 # Copyright (C) 2013  Simo Sorce <simo@redhat.com>
   2 #
   3 # see file 'COPYING' for use and warranty information
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation, either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 import cherrypy
  19 from ipsilon.util.endpoint import Endpoint
  20 from ipsilon.util.user import UserSession
  21 from ipsilon.util.trans import Transaction
  22 from urllib import unquote
  23 try:
  24     from urlparse import urlparse
  25     from urlparse import parse_qs
  26 except ImportError:
  27     # pylint: disable=no-name-in-module, import-error
  28     from urllib.parse import urlparse
  29     from urllib.parse import parse_qs
  30
  31
  32 def admin_protect(fn):
  33
  34     def check(*args, **kwargs):
  35         if UserSession().get_user().is_admin:
  36             return fn(*args, **kwargs)
  37
  38         raise cherrypy.HTTPError(403)
  39
  40     return check
  41
  42
  43 class Page(Endpoint):
  44     def __init__(self, site, form=False):
  45         super(Page, self).__init__(site)
  46         if 'template_env' not in site:
  47             raise ValueError('Missing template environment')
  48         self._site = site
  49         self.basepath = cherrypy.config.get('base.mount', "")
  50         self.user = None
  51         self._is_form_page = form
  52         self.auth_protect = False
  53
  54     def get_url(self):
  55         return cherrypy.url(relative=False)
  56
  57     def instance_base_url(self):
  58         url = self.get_url()
  59         s = urlparse(unquote(url))
  60         return '%s://%s%s' % (s.scheme, s.netloc, self.basepath)
  61
  62     def _check_referer(self, referer, url):
  63         r = urlparse(unquote(referer))
  64         u = urlparse(unquote(url))
  65         if r.scheme != u.scheme:
  66             return False
  67         if r.netloc != u.netloc:
  68             return False
  69         if r.path.startswith(self.basepath):
  70             return True
  71         return False
  72
  73     def __call__(self, *args, **kwargs):
  74         cherrypy.response.headers.update(self.default_headers)
  75
  76         self.user = UserSession().get_user()
  77
  78         if self.auth_protect and self.user.is_anonymous:
  79             raise cherrypy.HTTPError(401)
  80
  81         if len(args) > 0:
  82             op = getattr(self, args[0], None)
  83             if callable(op) and getattr(op, 'public_function', None):
  84                 return op(*args[1:], **kwargs)
  85         else:
  86             if self._is_form_page:
  87                 self.debug("method: %s" % cherrypy.request.method)
  88                 op = getattr(self, cherrypy.request.method, None)
  89                 if callable(op):
  90                     # Basic CSRF protection
  91                     if cherrypy.request.method != 'GET':
  92                         url = self.get_url()
  93                         if 'referer' not in cherrypy.request.headers:
  94                             self.debug("Missing referer in %s request to %s"
  95                                        % (cherrypy.request.method, url))
  96                             raise cherrypy.HTTPError(403)
  97                         referer = cherrypy.request.headers['referer']
  98                         if not self._check_referer(referer, url):
  99                             self.debug("Wrong referer %s in request to %s"
 100                                        % (referer, url))
 101                             raise cherrypy.HTTPError(403)
 102                     return op(*args, **kwargs)
 103             else:
 104                 op = getattr(self, 'root', None)
 105                 if callable(op):
 106                     return op(*args, **kwargs)
 107
 108         return self.default(*args, **kwargs)
 109
 110     def _template_model(self):
 111         model = dict()
 112         model['basepath'] = self.basepath
 113         model['title'] = 'IPSILON'
 114         model['user'] = self.user
 115         return model
 116
 117     def _template(self, *args, **kwargs):
 118         t = self._site['template_env'].get_template(args[0])
 119         m = self._template_model()
 120         m.update(kwargs)
 121         return t.render(**m)
 122
 123     def default(self, *args, **kwargs):
 124         raise cherrypy.NotFound()
 125
 126     def add_subtree(self, name, page):
 127         self.__dict__[name] = page
 128
 129     def del_subtree(self, name):
 130         del self.__dict__[name]
 131
 132     def get_valid_transaction(self, provider, **kwargs):
 133         try:
 134             t = Transaction(provider)
 135             # Try with kwargs first
 136             tid = t.find_tid(kwargs)
 137             if not tid:
 138                 # If no TID yet See if we have it in a referer or in the
 139                 # environment in the REDIRECT_URL
 140                 url = None
 141                 if 'referer' in cherrypy.request.headers:
 142                     url = cherrypy.request.headers['referer']
 143                     r = urlparse(unquote(url))
 144                     if r.query:
 145                         tid = t.find_tid(parse_qs(r.query))
 146                 if not tid and 'REQUEST_URI' in cherrypy.request.wsgi_environ:
 147                     url = cherrypy.request.wsgi_environ['REQUEST_URI']
 148                     r = urlparse(unquote(url))
 149                     if r.query:
 150                         tid = t.find_tid(parse_qs(r.query))
 151                 if not tid:
 152                     t.create_tid()
 153             return t
 154         except ValueError:
 155             msg = 'Transaction expired, or cookies not available'
 156             raise cherrypy.HTTPError(401, msg)
 157
 158     exposed = True