Child: [16c85e] (diff)

Download this file

routing.py    173 lines (144 with data), 5.7 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# -*- coding: utf-8 -*-
#
# Copyright (C) 2014-2015 Thomas Amland
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
from __future__ import print_function
import re
import sys
from urlparse import urlsplit, parse_qs
from urllib import urlencode
try:
import xbmc
import xbmcaddon
_addon_id = xbmcaddon.Addon().getAddonInfo('id')
def log(msg):
msg = "[%s][routing] %s" % (_addon_id, msg)
xbmc.log(msg, level=xbmc.LOGDEBUG)
except ImportError:
def log(msg):
print(msg, file=sys.stderr)
class RoutingError(Exception):
pass
class Plugin(object):
"""
:ivar handle: The plugin handle from kodi
:type handle: int
:ivar args: The parsed query string.
:type args: dict of byte strings
"""
def __init__(self, base_url=None):
self._rules = {} # function to list of rules
self.handle = -1
#self.handle = int(sys.argv[1]) if sys.argv[1].isdigit() else -1
self.args = {}
self.base_url = base_url
if self.base_url is None:
self.base_url = "plugin://" + xbmcaddon.Addon().getAddonInfo('id')
def route_for(self, path):
"""
Returns the view function for path.
:type path: byte string.
"""
if path.startswith(self.base_url):
path = path.split(self.base_url, 1)[1]
for view_fun, rules in self._rules.iteritems():
for rule in rules:
if rule.match(path) is not None:
return view_fun
return None
def url_for(self, func, *args, **kwargs):
"""
Construct and returns an URL for view function with give arguments.
"""
if func in self._rules:
for rule in self._rules[func]:
path = rule.make_path(*args, **kwargs)
if path is not None:
return self.url_for_path(path)
raise RoutingError("No known paths to '{0}' with args {1} and "
"kwargs {2}".format(func.__name__, args, kwargs))
def url_for_path(self, path):
"""
Returns the complete URL for a path.
"""
path = path if path.startswith('/') else '/' + path
return self.base_url + path
def route(self, pattern):
""" Register a route. """
def decorator(func):
self.add_route(func, pattern)
return func
return decorator
def add_route(self, func, pattern):
""" Register a route. """
rule = UrlRule(pattern)
if func not in self._rules:
self._rules[func] = []
self._rules[func].append(rule)
def run(self, argv=sys.argv):
if len(argv) > 2:
self.args = parse_qs(argv[2].lstrip(b'?'))
path = urlsplit(argv[0]).path or '/'
self._dispatch(path)
def redirect(self, path):
self._dispatch(path)
def _dispatch(self, path):
for view_func, rules in self._rules.iteritems():
for rule in rules:
kwargs = rule.match(path)
if kwargs is not None:
log("Dispatching to '%s', args: %s" % (view_func.__name__, kwargs))
view_func(**kwargs)
return
raise RoutingError('No route to path "%s"' % path)
class UrlRule(object):
def __init__(self, pattern):
kw_pattern = r'<(?:[^:]+:)?([A-z]+)>'
self._pattern = re.sub(kw_pattern, '{\\1}', pattern)
self._keywords = re.findall(kw_pattern, pattern)
p = re.sub('<([A-z]+)>', '<string:\\1>', pattern)
p = re.sub('<string:([A-z]+)>', '(?P<\\1>[^/]+?)', p)
p = re.sub('<path:([A-z]+)>', '(?P<\\1>.*)', p)
self._compiled_pattern = p
self._regex = re.compile('^' + p + '$')
def match(self, path):
"""
Check if path matches this rule. Returns a dictionary of the extracted
arguments if match, otherwise None.
"""
# match = self._regex.search(urlsplit(path).path)
match = self._regex.search(path)
return match.groupdict() if match else None
def make_path(self, *args, **kwargs):
"""Construct a path from arguments."""
if args and kwargs:
return None # can't use both args and kwargs
if args:
# Replace the named groups %s and format
try:
return re.sub(r'{[A-z]+}', r'%s', self._pattern) % args
except TypeError:
return None
# We need to find the keys from kwargs that occur in our pattern.
# Unknown keys are pushed to the query string.
url_kwargs = dict(((k, v) for k, v in kwargs.items() if k in self._keywords))
qs_kwargs = dict(((k, v) for k, v in kwargs.items() if k not in self._keywords))
query = '?' + urlencode(qs_kwargs) if qs_kwargs else ''
try:
return self._pattern.format(**url_kwargs) + query
except KeyError:
return None
def __str__(self):
return b"Rule(pattern=%s, keywords=%s)" % (self._pattern, self._keywords)