author | Pawel Solyga <Pawel.Solyga@gmail.com> |
Tue, 04 Nov 2008 20:06:36 +0000 | |
changeset 442 | 92c17629af0e |
parent 395 | c2cbf8ebe100 |
child 482 | 839740b061ad |
permissions | -rw-r--r-- |
281
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
1 |
#!/usr/bin/python2.5 |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
2 |
# |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
3 |
# Copyright 2008 the Melange authors. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
4 |
# |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
5 |
# Licensed under the Apache License, Version 2.0 (the "License"); |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
6 |
# you may not use this file except in compliance with the License. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
7 |
# You may obtain a copy of the License at |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
8 |
# |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
9 |
# http://www.apache.org/licenses/LICENSE-2.0 |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
10 |
# |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
11 |
# Unless required by applicable law or agreed to in writing, software |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
12 |
# distributed under the License is distributed on an "AS IS" BASIS, |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
13 |
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
14 |
# See the License for the specific language governing permissions and |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
15 |
# limitations under the License. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
16 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
17 |
"""Page properties, used to generate sidebar menus, urlpatterns, etc. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
18 |
""" |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
19 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
20 |
__authors__ = [ |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
21 |
'"Todd Larsen" <tlarsen@google.com>', |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
22 |
] |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
23 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
24 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
25 |
import copy |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
26 |
import re |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
27 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
28 |
from django.conf.urls import defaults |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
29 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
30 |
from python25src import urllib |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
31 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
32 |
from soc.logic import menu |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
33 |
from soc.logic.no_overwrite_sorted_dict import NoOverwriteSortedDict |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
34 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
35 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
36 |
class Url: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
37 |
"""The components of a Django URL pattern. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
38 |
""" |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
39 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
40 |
def __init__(self, regex, view, kwargs=None, name=None, prefix=''): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
41 |
"""Collects Django urlpatterns info into a simple object. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
42 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
43 |
The arguments to this constructor correspond directly to the items in |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
44 |
the urlpatterns tuple, which also correspond to the parameters of |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
45 |
django.conf.urls.defaults.url(). |
395
c2cbf8ebe100
Add documentation in response to Pawel's comments:
Todd Larsen <tlarsen@google.com>
parents:
390
diff
changeset
|
46 |
|
281
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
47 |
Args: |
395
c2cbf8ebe100
Add documentation in response to Pawel's comments:
Todd Larsen <tlarsen@google.com>
parents:
390
diff
changeset
|
48 |
regex: a Django URL regex pattern, which, for obvious reason, must |
c2cbf8ebe100
Add documentation in response to Pawel's comments:
Todd Larsen <tlarsen@google.com>
parents:
390
diff
changeset
|
49 |
be unique |
c2cbf8ebe100
Add documentation in response to Pawel's comments:
Todd Larsen <tlarsen@google.com>
parents:
390
diff
changeset
|
50 |
view: a Django view, either a string or a callable; if a callable, |
c2cbf8ebe100
Add documentation in response to Pawel's comments:
Todd Larsen <tlarsen@google.com>
parents:
390
diff
changeset
|
51 |
a unique 'name' string must be supplied |
281
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
52 |
kwargs: optional dict of extra arguments passed to the view |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
53 |
function as keyword arguments, which is copy.deepcopy()'d; |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
54 |
default is None, which supplies an empty dict {} |
395
c2cbf8ebe100
Add documentation in response to Pawel's comments:
Todd Larsen <tlarsen@google.com>
parents:
390
diff
changeset
|
55 |
name: optional name of the view; used instead of 'view' if supplied; |
c2cbf8ebe100
Add documentation in response to Pawel's comments:
Todd Larsen <tlarsen@google.com>
parents:
390
diff
changeset
|
56 |
the 'name' or 'view' string, whichever is used, must be unique |
c2cbf8ebe100
Add documentation in response to Pawel's comments:
Todd Larsen <tlarsen@google.com>
parents:
390
diff
changeset
|
57 |
amongst *all* Url objects supplied to a Page object |
281
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
58 |
prefix: optional view prefix |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
59 |
""" |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
60 |
self.regex = regex |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
61 |
self.view = view |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
62 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
63 |
if kwargs: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
64 |
self.kwargs = copy.deepcopy(kwargs) |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
65 |
else: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
66 |
self.kwargs = {} |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
67 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
68 |
self.name = name |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
69 |
self.prefix = prefix |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
70 |
|
372
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
71 |
def makeDjangoUrl(self, **extra_kwargs): |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
72 |
"""Returns a Django url() used by urlpatterns, or None if not a view. |
281
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
73 |
""" |
372
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
74 |
if not self.view: |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
75 |
return None |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
76 |
|
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
77 |
kwargs = copy.deepcopy(self.kwargs) |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
78 |
kwargs.update(extra_kwargs) |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
79 |
return defaults.url(self.regex, self.view, kwargs=kwargs, |
281
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
80 |
name=self.name, prefix=self.prefix) |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
81 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
82 |
_STR_FMT = '''%(indent)sregex: %(regex)s |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
83 |
%(indent)sview: %(view)s |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
84 |
%(indent)skwargs: %(kwargs)s |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
85 |
%(indent)sname: %(name)s |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
86 |
%(indent)sprefix: %(prefix)s |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
87 |
''' |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
88 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
89 |
def asIndentedStr(self, indent=''): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
90 |
"""Returns an indented string representation useful for logging. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
91 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
92 |
Args: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
93 |
indent: an indentation string that is prepended to each line present |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
94 |
in the multi-line string returned by this method. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
95 |
""" |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
96 |
return self._STR_FMT % {'indent': indent, 'regex': self.regex, |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
97 |
'view': self.view, 'kwargs': self.kwargs, |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
98 |
'name': self.name, 'prefix': self.prefix} |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
99 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
100 |
def __str__(self): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
101 |
"""Returns a string representation useful for logging. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
102 |
""" |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
103 |
return self.asIndentedStr() |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
104 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
105 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
106 |
class Page: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
107 |
"""An abstraction that combines a Django view with sidebar menu info. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
108 |
""" |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
109 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
110 |
def __init__(self, url, long_name, short_name=None, selected=False, |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
111 |
annotation=None, parent=None, link_url=None, |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
112 |
in_breadcrumb=True, force_in_menu=False): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
113 |
"""Initializes the menu item attributes from supplied arguments. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
114 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
115 |
Args: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
116 |
url: a Url object |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
117 |
long_name: title of the Page |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
118 |
short_name: optional menu item and breadcrumb name; default is |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
119 |
None, in which case long_name is used |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
120 |
selected: Boolean indicating if this menu item is selected; |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
121 |
default is False |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
122 |
annotation: optional annotation associated with the menu item; |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
123 |
default is None |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
124 |
parent: optional Page that is the logical "parent" of this page; |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
125 |
used to construct hierarchical menus and breadcrumb trails |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
126 |
link_url: optional alternate URL link; if supplied, it is returned |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
127 |
by makeLinkUrl(); default is None, and makeLinkUrl() attempts to |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
128 |
create a URL link from url.regex |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
129 |
in_breadcrumb: if True, the Page appears in breadcrumb trails; |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
130 |
default is True |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
131 |
force_in_menu: if True, the Page appears in menus even if it does |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
132 |
not have a usable link_url; default is False, which excludes |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
133 |
the Page if makeLinkUrl() returns None |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
134 |
""" |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
135 |
self.url = url |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
136 |
self.long_name = long_name |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
137 |
self.annotation = annotation |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
138 |
self.in_breadcrumb = in_breadcrumb |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
139 |
self.force_in_menu = force_in_menu |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
140 |
self.link_url = link_url |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
141 |
self.selected = selected |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
142 |
self.parent = parent |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
143 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
144 |
# create ordered, unique mappings of URLs and view names to Pages |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
145 |
self.child_by_urls = NoOverwriteSortedDict() |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
146 |
self.child_by_views = NoOverwriteSortedDict() |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
147 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
148 |
if not short_name: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
149 |
short_name = long_name |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
150 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
151 |
self.short_name = short_name |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
152 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
153 |
if parent: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
154 |
# tell parent Page about parent <- child relationship |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
155 |
parent.addChild(self) |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
156 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
157 |
# TODO(tlarsen): build some sort of global Page dictionary to detect |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
158 |
# collisions sooner and to make global queries from URLs to pages |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
159 |
# and views to Pages possible (without requiring a recursive search) |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
160 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
161 |
def getChildren(self): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
162 |
"""Returns an iterator over any child Pages |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
163 |
""" |
372
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
164 |
for page in self.child_by_views.itervalues(): |
281
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
165 |
yield page |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
166 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
167 |
children = property(getChildren) |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
168 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
169 |
def getChild(self, url=None, regex=None, view=None, |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
170 |
name=None, prefix=None, request_path=None): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
171 |
"""Returns a child Page if one can be identified; or None otherwise. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
172 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
173 |
All of the parameters to this method are optional, but at least one |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
174 |
must be supplied to return anything other than None. The parameters |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
175 |
are tried in the order they are listed in the "Args:" section, and |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
176 |
this method exits on the first "match". |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
177 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
178 |
Args: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
179 |
url: a Url object, used to overwrite the regex, view, name, and |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
180 |
prefix parameters if present; default is None |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
181 |
regex: a regex pattern string, used to return the associated |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
182 |
child Page |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
183 |
view: a view string, used to return the associated child Page |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
184 |
name: a name string, used to return the associated child Page |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
185 |
prefix: (currently unused, see TODO below in code) |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
186 |
request_path: optional HTTP request path string (request.path) |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
187 |
with no query arguments |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
188 |
""" |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
189 |
# this code is yucky; there is probably a better way... |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
190 |
if url: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
191 |
regex = url.regex |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
192 |
view = url.view |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
193 |
name = url.name |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
194 |
prefix = url.prefix |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
195 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
196 |
if regex in self.child_by_urls: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
197 |
# regex supplied and Page found, so return that Page |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
198 |
return self.child_by_urls[regex][0] |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
199 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
200 |
# TODO(tlarsen): make this work correctly with prefixes |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
201 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
202 |
if view in self.child_views: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
203 |
# view supplied and Page found, so return that Page |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
204 |
return self.child_by_views[view] |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
205 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
206 |
if name in self.child_views: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
207 |
# name supplied and Page found, so return that Page |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
208 |
return self.child_by_views[name] |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
209 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
210 |
if request_path.startswith('/'): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
211 |
request_path = request_path[1:] |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
212 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
213 |
# attempt to match the HTTP request path with a Django URL pattern |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
214 |
for pattern, (page, regex) in self.child_by_urls: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
215 |
if regex.match(request_path): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
216 |
return page |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
217 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
218 |
return None |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
219 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
220 |
def addChild(self, page): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
221 |
"""Adds a unique Page as a child Page of this parent. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
222 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
223 |
Raises: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
224 |
ValueError if page.url.regex is not a string. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
225 |
ValueError if page.url.view is not a string. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
226 |
ValueError if page.url.name is supplied but is not a string. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
227 |
KeyError if page.url.regex is already associated with another Page. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
228 |
KeyError if page.url.view/name is already associated with another Page. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
229 |
""" |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
230 |
# TODO(tlarsen): see also TODO in __init__() about global Page dictionary |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
231 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
232 |
url = page.url |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
233 |
|
372
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
234 |
if url.regex: |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
235 |
if not isinstance(url.regex, basestring): |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
236 |
raise ValueError('"regex" must be a string, not a compiled regex') |
281
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
237 |
|
372
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
238 |
# TODO(tlarsen): see if Django has some way exposed in its API to get |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
239 |
# the view name from the request path matched against urlpatterns; |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
240 |
# if so, there would be no need for child_by_urls, because the |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
241 |
# request path could be converted for us by Django into a view/name, |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
242 |
# and we could just use child_by_views with that string instead |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
243 |
self.child_by_urls[url.regex] = (page, re.compile(url.regex)) |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
244 |
# else: NonUrl does not get indexed by regex, because it has none |
281
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
245 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
246 |
# TODO(tlarsen): make this work correctly if url has a prefix |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
247 |
# (not sure how to make this work with include() views...) |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
248 |
if url.name: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
249 |
if not isinstance(url.name, basestring): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
250 |
raise ValueError('"name" must be a string if it is supplied') |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
251 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
252 |
view = url.name |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
253 |
elif isinstance(url.view, basestring): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
254 |
view = url.view |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
255 |
else: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
256 |
raise ValueError('"view" must be a string if "name" is not supplied') |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
257 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
258 |
self.child_by_views[view] = page |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
259 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
260 |
def delChild(self, url=None, regex=None, view=None, name=None, |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
261 |
prefix=None): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
262 |
"""Removes a child Page if one can be identified. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
263 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
264 |
All of the parameters to this method are optional, but at least one |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
265 |
must be supplied in order to remove a child Page. The parameters |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
266 |
are tried in the order they are listed in the "Args:" section, and |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
267 |
this method uses the first "match". |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
268 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
269 |
Args: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
270 |
url: a Url object, used to overwrite the regex, view, name, and |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
271 |
prefix parameters if present; default is None |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
272 |
regex: a regex pattern string, used to remove the associated |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
273 |
child Page |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
274 |
view: a view string, used to remove the associated child Page |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
275 |
name: a name string, used to remove the associated child Page |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
276 |
prefix: (currently unused, see TODO below in code) |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
277 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
278 |
Raises: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
279 |
KeyError if the child Page could not be definitively identified in |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
280 |
order to delete it. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
281 |
""" |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
282 |
# this code is yucky; there is probably a better way... |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
283 |
if url: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
284 |
regex = url.regex |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
285 |
view = url.view |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
286 |
name = url.name |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
287 |
prefix = url.prefix |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
288 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
289 |
# try to find page by regex, view, or name, in turn |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
290 |
if regex in self.child_by_urls: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
291 |
url = self.child_by_urls[regex][0].url |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
292 |
view = url.view |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
293 |
name = url.name |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
294 |
prefix = url.prefix |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
295 |
elif view in self.child_views: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
296 |
# TODO(tlarsen): make this work correctly with prefixes |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
297 |
regex = self.child_by_views[view].url.regex |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
298 |
elif name in self.child_views: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
299 |
regex = self.child_by_views[name].url.regex |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
300 |
|
372
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
301 |
if regex: |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
302 |
# regex must refer to an existing Page at this point |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
303 |
del self.child_urls[regex] |
281
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
304 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
305 |
if not isinstance(view, basestring): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
306 |
# use name if view is callable() or None, etc. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
307 |
view = name |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
308 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
309 |
# TODO(tlarsen): make this work correctly with prefixes |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
310 |
del self.child_by_views[view] |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
311 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
312 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
313 |
def makeLinkUrl(self): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
314 |
"""Makes a URL link suitable for <A HREF> use. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
315 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
316 |
Returns: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
317 |
self.link_url if link_url was supplied to the __init__() constructor |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
318 |
and it is a non-False value |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
319 |
-OR- |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
320 |
a suitable URL extracted from the url.regex, if possible |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
321 |
-OR- |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
322 |
None if url.regex contains quotable characters that have not already |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
323 |
been quoted (that is, % is left untouched, so quote suspect |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
324 |
characters in url.regex that would otherwise be quoted) |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
325 |
""" |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
326 |
if self.link_url: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
327 |
return self.link_url |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
328 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
329 |
link = self.url.regex |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
330 |
|
372
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
331 |
if not link: |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
332 |
return None |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
333 |
|
281
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
334 |
if link.startswith('^'): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
335 |
link = link[1:] |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
336 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
337 |
if link.endswith('$'): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
338 |
link = link[:-1] |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
339 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
340 |
if not link.startswith('/'): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
341 |
link = '/' + link |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
342 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
343 |
# path separators and already-quoted characters are OK |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
344 |
if link != urllib.quote(link, safe='/%'): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
345 |
return None |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
346 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
347 |
return link |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
348 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
349 |
def makeMenuItem(self): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
350 |
"""Returns a menu.MenuItem for the Page (and any child Pages). |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
351 |
""" |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
352 |
child_items = [] |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
353 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
354 |
for child in self.children: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
355 |
child_item = child.makeMenuItem() |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
356 |
if child_item: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
357 |
child_items.append(child_item) |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
358 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
359 |
if child_items: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
360 |
sub_menu = menu.Menu(items=child_items) |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
361 |
else: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
362 |
sub_menu = None |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
363 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
364 |
link_url = self.makeLinkUrl() |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
365 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
366 |
if (not sub_menu) and (not link_url) and (not self.force_in_menu): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
367 |
# no sub-menu, no valid link URL, and not forced to be in menu |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
368 |
return None |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
369 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
370 |
return menu.MenuItem( |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
371 |
self.short_name, value=link_url, sub_menu=sub_menu) |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
372 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
373 |
def makeDjangoUrl(self): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
374 |
"""Returns the Django url() for the underlying self.url. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
375 |
""" |
372
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
376 |
return self.url.makeDjangoUrl(page=self) |
281
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
377 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
378 |
def makeDjangoUrls(self): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
379 |
"""Returns an ordered mapping of unique Django url() objects. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
380 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
381 |
Raises: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
382 |
KeyError if more than one Page has the same urlpattern. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
383 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
384 |
TODO(tlarsen): this really needs to be detected earlier via a |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
385 |
global Page dictionary |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
386 |
""" |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
387 |
return self._makeDjangoUrlsDict().values() |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
388 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
389 |
def _makeDjangoUrlsDict(self): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
390 |
"""Returns an ordered mapping of unique Django url() objects. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
391 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
392 |
Used to implement makeDjangoUrls(). See that method for details. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
393 |
""" |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
394 |
urlpatterns = NoOverwriteSortedDict() |
372
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
395 |
|
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
396 |
django_url = self.makeDjangoUrl() |
281
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
397 |
|
372
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
398 |
if django_url: |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
399 |
urlpatterns[self.url.regex] = django_url |
281
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
400 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
401 |
for child in self.children: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
402 |
urlpatterns.update(child._makeDjangoUrlsDict()) |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
403 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
404 |
return urlpatterns |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
405 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
406 |
_STR_FMT = '''%(indent)slong_name: %(long_name)s |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
407 |
%(indent)sshort_name: %(short_name)s |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
408 |
%(indent)sselected: %(selected)s |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
409 |
%(indent)sannotation: %(annotation)s |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
410 |
%(indent)surl: %(url)s |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
411 |
''' |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
412 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
413 |
def asIndentedStr(self, indent=''): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
414 |
"""Returns an indented string representation useful for logging. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
415 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
416 |
Args: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
417 |
indent: an indentation string that is prepended to each line present |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
418 |
in the multi-line string returned by this method. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
419 |
""" |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
420 |
strings = [ |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
421 |
self._STR_FMT % {'indent': indent, 'long_name': self.long_name, |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
422 |
'short_name': self.short_name, |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
423 |
'selected': self.selected, |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
424 |
'annotation': self.annotation, |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
425 |
'url': self.url.asIndentedStr(indent + ' ')}] |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
426 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
427 |
for child in self.children: |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
428 |
strings.extend(child.asIndentedStr(indent + ' ')) |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
429 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
430 |
return ''.join(strings) |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
431 |
|
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
432 |
def __str__(self): |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
433 |
"""Returns a string representation useful for logging. |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
434 |
""" |
7caa8951cbc9
Url and Page classes used to encapsulate the "site map" information (URL
Todd Larsen <tlarsen@google.com>
parents:
diff
changeset
|
435 |
return self.asIndentedStr() |
372
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
436 |
|
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
437 |
|
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
438 |
class NonUrl(Url): |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
439 |
"""Placeholder for when a site-map entry is not a linkable URL. |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
440 |
""" |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
441 |
|
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
442 |
def __init__(self, name): |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
443 |
"""Creates a non-linkable Url placeholder. |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
444 |
|
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
445 |
Args: |
395
c2cbf8ebe100
Add documentation in response to Pawel's comments:
Todd Larsen <tlarsen@google.com>
parents:
390
diff
changeset
|
446 |
name: name of the non-view placeholder; see Url.__init__() |
372
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
447 |
""" |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
448 |
Url.__init__(self, None, None, name=name) |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
449 |
|
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
450 |
def makeDjangoUrl(self, **extra_kwargs): |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
451 |
"""Always returns None, since NonUrl is never a Django view. |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
452 |
""" |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
453 |
return None |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
454 |
|
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
455 |
|
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
456 |
class NonPage(Page): |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
457 |
"""Placeholder for when a site-map entry is not a displayable page. |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
458 |
""" |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
459 |
|
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
460 |
def __init__(self, non_url_name, long_name, **page_kwargs): |
395
c2cbf8ebe100
Add documentation in response to Pawel's comments:
Todd Larsen <tlarsen@google.com>
parents:
390
diff
changeset
|
461 |
"""Constructs a NonUrl and passes it to base Page class __init__(). |
c2cbf8ebe100
Add documentation in response to Pawel's comments:
Todd Larsen <tlarsen@google.com>
parents:
390
diff
changeset
|
462 |
|
c2cbf8ebe100
Add documentation in response to Pawel's comments:
Todd Larsen <tlarsen@google.com>
parents:
390
diff
changeset
|
463 |
Args: |
c2cbf8ebe100
Add documentation in response to Pawel's comments:
Todd Larsen <tlarsen@google.com>
parents:
390
diff
changeset
|
464 |
non_url_name: unique (it *must* be) string that does not match |
c2cbf8ebe100
Add documentation in response to Pawel's comments:
Todd Larsen <tlarsen@google.com>
parents:
390
diff
changeset
|
465 |
the 'name' or 'view' of any other Url or NonUrl object; |
c2cbf8ebe100
Add documentation in response to Pawel's comments:
Todd Larsen <tlarsen@google.com>
parents:
390
diff
changeset
|
466 |
see Url.__init__() for details |
c2cbf8ebe100
Add documentation in response to Pawel's comments:
Todd Larsen <tlarsen@google.com>
parents:
390
diff
changeset
|
467 |
long_name: see Page.__init__() |
c2cbf8ebe100
Add documentation in response to Pawel's comments:
Todd Larsen <tlarsen@google.com>
parents:
390
diff
changeset
|
468 |
**page_kwargs: keyword arguments passed directly to the base |
c2cbf8ebe100
Add documentation in response to Pawel's comments:
Todd Larsen <tlarsen@google.com>
parents:
390
diff
changeset
|
469 |
Page class __init__() |
372
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
470 |
""" |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
471 |
non_url = NonUrl(non_url_name) |
8595c1129c74
Formalize the concept of a NonPage that can appear in the site-map, useful for
Todd Larsen <tlarsen@google.com>
parents:
281
diff
changeset
|
472 |
Page.__init__(self, non_url, long_name, **page_kwargs) |