root / snf-django-lib / snf_django / utils / urls.py @ 0a83201b
History | View | Annotate | Download (3.9 kB)
1 |
# Copyright 2011-2012 GRNET S.A. All rights reserved.
|
---|---|
2 |
#
|
3 |
# Redistribution and use in source and binary forms, with or
|
4 |
# without modification, are permitted provided that the following
|
5 |
# conditions are met:
|
6 |
#
|
7 |
# 1. Redistributions of source code must retain the above
|
8 |
# copyright notice, this list of conditions and the following
|
9 |
# disclaimer.
|
10 |
#
|
11 |
# 2. Redistributions in binary form must reproduce the above
|
12 |
# copyright notice, this list of conditions and the following
|
13 |
# disclaimer in the documentation and/or other materials
|
14 |
# provided with the distribution.
|
15 |
#
|
16 |
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
|
17 |
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
18 |
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
19 |
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
|
20 |
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
21 |
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
22 |
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
23 |
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
24 |
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
25 |
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
26 |
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
27 |
# POSSIBILITY OF SUCH DAMAGE.
|
28 |
#
|
29 |
# The views and conclusions contained in the software and
|
30 |
# documentation are those of the authors and should not be
|
31 |
# interpreted as representing official policies, either expressed
|
32 |
# or implied, of GRNET S.A.
|
33 |
|
34 |
from django.conf.urls import url, patterns |
35 |
|
36 |
from snf_django.lib.api.utils import prefix_pattern |
37 |
from synnefo.lib.services import get_service_path |
38 |
from synnefo.lib import join_urls |
39 |
|
40 |
|
41 |
def extend_path_with_slash(patterns_obj, path): |
42 |
if not path.endswith('/'): |
43 |
pattern = prefix_pattern(path, append_slash=False) + '$' |
44 |
entry = url(pattern, 'redirect_to', {'url': path + '/'}) |
45 |
patterns_obj += patterns('django.views.generic.simple', entry)
|
46 |
|
47 |
|
48 |
def extend_endpoint_with_slash(patterns_obj, filled_services, service_type, |
49 |
version=None):
|
50 |
path = get_service_path(filled_services, service_type, version) |
51 |
extend_path_with_slash(patterns_obj, path) |
52 |
|
53 |
|
54 |
def extend_with_root_redirects(patterns_obj, filled_services, service_type, |
55 |
base_path, with_slash=True):
|
56 |
"""
|
57 |
Append additional redirect url entries for `/` and `/<base_path>` paths.
|
58 |
|
59 |
`/` redirects to `/<base_path>` and `/<base_path>` to the resolved service
|
60 |
type url.
|
61 |
|
62 |
This is used in synnefo components root urlpatterns to append sane default
|
63 |
redirects to the chosen service url.
|
64 |
|
65 |
"""
|
66 |
service_path = get_service_path(filled_services, service_type) |
67 |
if with_slash:
|
68 |
service_path = service_path.rstrip('/') + '/' |
69 |
|
70 |
root_url_entry = None
|
71 |
if base_path and base_path != '/': |
72 |
# redirect slash to /<base_path>/
|
73 |
root_url_entry = url('^$', 'redirect_to', |
74 |
{'url': join_urls('/', base_path.rstrip('/'), |
75 |
'/')})
|
76 |
|
77 |
base_path_pattern = prefix_pattern(base_path) + '$'
|
78 |
base_path_pattern_no_slash = prefix_pattern(base_path).rstrip('/') + '$' |
79 |
|
80 |
# redirect /<base_path> and /<base_path>/ to service_path public endpoint
|
81 |
base_url_entry = url(base_path_pattern, 'redirect_to', {'url': |
82 |
service_path}) |
83 |
base_url_entry_no_slash = url(base_path_pattern_no_slash, |
84 |
'redirect_to', {'url': service_path}) |
85 |
# urls order matter. Setting base_url_entry first allows us to avoid
|
86 |
# redirect loops when base_path is empty or `/`
|
87 |
patterns_obj += patterns('django.views.generic.simple',
|
88 |
base_url_entry, base_url_entry_no_slash) |
89 |
if root_url_entry:
|
90 |
# register root entry only for non root base_path deployments
|
91 |
patterns_obj += patterns('django.views.generic.simple', root_url_entry)
|