mediagoblin/tools/routing.py

   1 # GNU MediaGoblin -- federated, autonomous media hosting
   2 # Copyright (C) 2011, 2012 MediaGoblin contributors.  See AUTHORS.
   3 #
   4 # This program is free software: you can redistribute it and/or modify
   5 # it under the terms of the GNU Affero General Public License as published by
   6 # the Free Software Foundation, either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU Affero General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU Affero General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 import logging
  18
  19 import six
  20
  21 from six.moves.urllib.parse import urlparse
  22 from werkzeug.routing import Map, Rule
  23
  24 from mediagoblin.tools.common import import_component
  25
  26
  27 _log = logging.getLogger(__name__)
  28
  29 url_map = Map()
  30
  31
  32 class MGRoute(Rule):
  33     def __init__(self, endpoint, url, controller, match_slash=True):
  34         Rule.__init__(self, url, endpoint=endpoint)
  35         self.gmg_controller = controller
  36         self.match_slash = match_slash
  37
  38     def empty(self):
  39         new_rule = Rule.empty(self)
  40         new_rule.gmg_controller = self.gmg_controller
  41         return new_rule
  42
  43     def match(self, path, *args, **kwargs):
  44         if not (self.match_slash or path.endswith("/")):
  45             path = path + "/"
  46
  47         return super(MGRoute, self).match(path, *args, **kwargs)
  48
  49
  50 def endpoint_to_controller(rule):
  51     endpoint = rule.endpoint
  52     view_func = rule.gmg_controller
  53
  54     _log.debug('endpoint: {0} view_func: {1}'.format(endpoint, view_func))
  55
  56     # import the endpoint, or if it's already a callable, call that
  57     if isinstance(view_func, six.string_types):
  58         view_func = import_component(view_func)
  59         rule.gmg_controller = view_func
  60
  61     return view_func
  62
  63
  64 def add_route(endpoint, url, controller, *args, **kwargs):
  65     """
  66     Add a route to the url mapping
  67     """
  68     url_map.add(MGRoute(endpoint, url, controller, *args, **kwargs))
  69
  70
  71 def mount(mountpoint, routes):
  72     """
  73     Mount a bunch of routes to this mountpoint
  74     """
  75     for endpoint, url, controller in routes:
  76         url = "%s/%s" % (mountpoint.rstrip('/'), url.lstrip('/'))
  77         add_route(endpoint, url, controller)
  78
  79 def extract_url_arguments(url, urlmap):
  80     """
  81     This extracts the URL arguments from a given URL
  82     """
  83     parsed_url = urlparse(url)
  84     map_adapter = urlmap.bind(
  85         server_name=parsed_url.netloc,
  86         script_name=parsed_url.path,
  87         url_scheme=parsed_url.scheme,
  88         path_info=parsed_url.path
  89     )
  90
  91     return map_adapter.match()[1]