Mercurial > libervia-web
annotate libervia/server/pages.py @ 1286:63328c793a9e
pages: new method `exposeToScripts` to make variables accessible to scripts in browser
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Fri, 19 Jun 2020 16:47:51 +0200 |
| parents | 37a582b0fe53 |
| children | de3b15d68bb6 |
| rev | line source |
|---|---|
| 1239 | 1 #!/usr/bin/env python3 |
| 2 | |
|
339
2067d6241927
fixed docstrings wrong usage for licence informations
Goffi <goffi@goffi.org>
parents:
336
diff
changeset
|
3 # Libervia: a Salut à Toi frontend |
| 1237 | 4 # Copyright (C) 2011-2020 Jérôme Poisson <goffi@goffi.org> |
|
331
06a48d805547
server side: make Libervia a Twisted plugin, and add it the --port argument + add a config file for the port.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
330
diff
changeset
|
5 |
|
339
2067d6241927
fixed docstrings wrong usage for licence informations
Goffi <goffi@goffi.org>
parents:
336
diff
changeset
|
6 # This program is free software: you can redistribute it and/or modify |
|
2067d6241927
fixed docstrings wrong usage for licence informations
Goffi <goffi@goffi.org>
parents:
336
diff
changeset
|
7 # it under the terms of the GNU Affero General Public License as published by |
|
2067d6241927
fixed docstrings wrong usage for licence informations
Goffi <goffi@goffi.org>
parents:
336
diff
changeset
|
8 # the Free Software Foundation, either version 3 of the License, or |
|
2067d6241927
fixed docstrings wrong usage for licence informations
Goffi <goffi@goffi.org>
parents:
336
diff
changeset
|
9 # (at your option) any later version. |
|
331
06a48d805547
server side: make Libervia a Twisted plugin, and add it the --port argument + add a config file for the port.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
330
diff
changeset
|
10 |
|
339
2067d6241927
fixed docstrings wrong usage for licence informations
Goffi <goffi@goffi.org>
parents:
336
diff
changeset
|
11 # This program is distributed in the hope that it will be useful, |
|
2067d6241927
fixed docstrings wrong usage for licence informations
Goffi <goffi@goffi.org>
parents:
336
diff
changeset
|
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
2067d6241927
fixed docstrings wrong usage for licence informations
Goffi <goffi@goffi.org>
parents:
336
diff
changeset
|
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
2067d6241927
fixed docstrings wrong usage for licence informations
Goffi <goffi@goffi.org>
parents:
336
diff
changeset
|
14 # GNU Affero General Public License for more details. |
|
331
06a48d805547
server side: make Libervia a Twisted plugin, and add it the --port argument + add a config file for the port.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
330
diff
changeset
|
15 |
|
339
2067d6241927
fixed docstrings wrong usage for licence informations
Goffi <goffi@goffi.org>
parents:
336
diff
changeset
|
16 # You should have received a copy of the GNU Affero General Public License |
|
2067d6241927
fixed docstrings wrong usage for licence informations
Goffi <goffi@goffi.org>
parents:
336
diff
changeset
|
17 # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 1246 | 18 |
|
1253
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
19 from __future__ import annotations |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
20 |
| 1246 | 21 import uuid |
| 22 import os.path | |
| 23 import urllib.request, urllib.parse, urllib.error | |
| 24 import time | |
| 25 import hashlib | |
| 26 import copy | |
|
1253
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
27 import json |
|
1276
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
28 import traceback |
|
1253
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
29 from pathlib import Path |
| 1246 | 30 from functools import reduce |
|
1253
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
31 from typing import Optional, List |
| 1246 | 32 |
|
331
06a48d805547
server side: make Libervia a Twisted plugin, and add it the --port argument + add a config file for the port.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
330
diff
changeset
|
33 from twisted.web import server |
| 858 | 34 from twisted.web import resource as web_resource |
| 35 from twisted.web import util as web_util | |
|
984
f0fc28b3bd1e
server: moved LiberviaPage code in its own module
Goffi <goffi@goffi.org>
parents:
980
diff
changeset
|
36 from twisted.internet import defer |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
37 from twisted.words.protocols.jabber import jid |
| 917 | 38 from twisted.python import failure |
|
449
981ed669d3b3
/!\ reorganize all the file hierarchy, move the code and launching script to src:
souliane <souliane@mailoo.org>
parents:
448
diff
changeset
|
39 |
|
984
f0fc28b3bd1e
server: moved LiberviaPage code in its own module
Goffi <goffi@goffi.org>
parents:
980
diff
changeset
|
40 from sat.core.i18n import _ |
|
f0fc28b3bd1e
server: moved LiberviaPage code in its own module
Goffi <goffi@goffi.org>
parents:
980
diff
changeset
|
41 from sat.core import exceptions |
|
1276
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
42 from sat.tools.utils import asDeferred |
|
1109
3a7b2b239d3e
pages: change module for date_parse, following backend change
Goffi <goffi@goffi.org>
parents:
1092
diff
changeset
|
43 from sat.tools.common import date_utils |
|
1253
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
44 from sat.tools.common import utils |
|
438
582c435dab6b
server side: new log system is used
Goffi <goffi@goffi.org>
parents:
435
diff
changeset
|
45 from sat.core.log import getLogger |
|
1177
75c5e8d21c7d
server: catch "not-allowed" error from bridge and show the appropriate error page in this case
Goffi <goffi@goffi.org>
parents:
1175
diff
changeset
|
46 from sat_frontends.bridge.bridge_frontend import BridgeException |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
47 |
|
1286
63328c793a9e
pages: new method `exposeToScripts` to make variables accessible to scripts in browser
Goffi <goffi@goffi.org>
parents:
1285
diff
changeset
|
48 from .constants import Const as C |
|
63328c793a9e
pages: new method `exposeToScripts` to make variables accessible to scripts in browser
Goffi <goffi@goffi.org>
parents:
1285
diff
changeset
|
49 from . import session_iface |
|
63328c793a9e
pages: new method `exposeToScripts` to make variables accessible to scripts in browser
Goffi <goffi@goffi.org>
parents:
1285
diff
changeset
|
50 from .utils import quote, SubPage |
|
63328c793a9e
pages: new method `exposeToScripts` to make variables accessible to scripts in browser
Goffi <goffi@goffi.org>
parents:
1285
diff
changeset
|
51 from .classes import WebsocketMeta |
|
63328c793a9e
pages: new method `exposeToScripts` to make variables accessible to scripts in browser
Goffi <goffi@goffi.org>
parents:
1285
diff
changeset
|
52 from .classes import Script |
|
331
06a48d805547
server side: make Libervia a Twisted plugin, and add it the --port argument + add a config file for the port.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
330
diff
changeset
|
53 |
|
1145
29eb15062416
pages: set __name__ for imported pages
Goffi <goffi@goffi.org>
parents:
1144
diff
changeset
|
54 log = getLogger(__name__) |
|
29eb15062416
pages: set __name__ for imported pages
Goffi <goffi@goffi.org>
parents:
1144
diff
changeset
|
55 |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
56 |
| 1018 | 57 class CacheBase(object): |
| 58 def __init__(self): | |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
59 self._created = time.time() |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
60 self._last_access = self._created |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
61 |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
62 @property |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
63 def created(self): |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
64 return self._created |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
65 |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
66 @property |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
67 def last_access(self): |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
68 return self._last_access |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
69 |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
70 @last_access.setter |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
71 def last_access(self, timestamp): |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
72 self._last_access = timestamp |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
73 |
| 1018 | 74 |
| 75 class CachePage(CacheBase): | |
| 76 def __init__(self, rendered): | |
| 77 super(CachePage, self).__init__() | |
| 78 self._created = time.time() | |
| 79 self._last_access = self._created | |
| 80 self._rendered = rendered | |
|
1019
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
81 self._hash = hashlib.sha256(rendered).hexdigest() |
| 1018 | 82 |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
83 @property |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
84 def rendered(self): |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
85 return self._rendered |
|
331
06a48d805547
server side: make Libervia a Twisted plugin, and add it the --port argument + add a config file for the port.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
330
diff
changeset
|
86 |
|
1019
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
87 @property |
|
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
88 def hash(self): |
|
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
89 return self._hash |
|
331
06a48d805547
server side: make Libervia a Twisted plugin, and add it the --port argument + add a config file for the port.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
330
diff
changeset
|
90 |
| 1018 | 91 |
| 92 class CacheURL(CacheBase): | |
| 93 def __init__(self, request): | |
| 94 super(CacheURL, self).__init__() | |
| 95 try: | |
|
1193
aee3d8fa679f
pages: fixed cached data when `url_cache` is used:
Goffi <goffi@goffi.org>
parents:
1188
diff
changeset
|
96 self._data = copy.deepcopy(request.data) |
| 1018 | 97 except AttributeError: |
| 98 self._data = {} | |
|
1193
aee3d8fa679f
pages: fixed cached data when `url_cache` is used:
Goffi <goffi@goffi.org>
parents:
1188
diff
changeset
|
99 self._template_data = copy.deepcopy(request.template_data) |
| 1018 | 100 self._prepath = request.prepath[:] |
| 101 self._postpath = request.postpath[:] | |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
102 del self._template_data["csrf_token"] |
| 1018 | 103 |
| 104 def use(self, request): | |
| 105 self.last_access = time.time() | |
|
1193
aee3d8fa679f
pages: fixed cached data when `url_cache` is used:
Goffi <goffi@goffi.org>
parents:
1188
diff
changeset
|
106 request.data = copy.deepcopy(self._data) |
|
aee3d8fa679f
pages: fixed cached data when `url_cache` is used:
Goffi <goffi@goffi.org>
parents:
1188
diff
changeset
|
107 request.template_data.update(copy.deepcopy(self._template_data)) |
| 1018 | 108 request.prepath = self._prepath[:] |
| 109 request.postpath = self._postpath[:] | |
| 110 | |
| 111 | |
| 917 | 112 class LiberviaPage(web_resource.Resource): |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
113 isLeaf = True # we handle subpages ourself |
| 995 | 114 signals_handlers = {} |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
115 cache = {} |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
116 # Set of tuples (service/node/sub_id) of nodes subscribed for caching |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
117 # sub_id can be empty string if not handled by service |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
118 cache_pubsub_sub = set() |
| 917 | 119 |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
120 def __init__( |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
121 self, host, vhost_root, root_dir, url, name=None, redirect=None, access=None, |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
122 dynamic=False, parse_url=None, prepare_render=None, render=None, template=None, |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
123 on_data_post=None, on_data=None, on_signal=None, url_cache=False, |
| 1153 | 124 replace_on_conflict=False |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
125 ): |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
126 """Initiate LiberviaPage instance |
| 917 | 127 |
| 128 LiberviaPages are the main resources of Libervia, using easy to set python files | |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
129 The non mandatory arguments are the variables found in page_meta.py |
| 917 | 130 @param host(Libervia): the running instance of Libervia |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
131 @param vhost_root(web_resource.Resource): root resource of the virtual host which |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
132 handle this page. |
|
1282
0e4e413eb8db
server: user new OrderedSet to handle scripts:
Goffi <goffi@goffi.org>
parents:
1277
diff
changeset
|
133 @param root_dir(Path): absolute file path of the page |
| 962 | 134 @param url(unicode): relative URL to the page |
| 135 this URL may not be valid, as pages may require path arguments | |
| 917 | 136 @param name(unicode, None): if not None, a unique name to identify the page |
| 137 can then be used for e.g. redirection | |
|
923
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
138 "/" is not allowed in names (as it can be used to construct URL paths) |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
139 @param redirect(unicode, None): if not None, this page will be redirected. |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
140 A redirected parameter is used as in self.pageRedirect. |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
141 parse_url will not be skipped |
|
923
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
142 using this redirect parameter is called "full redirection" |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
143 using self.pageRedirect is called "partial redirection" (because some |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
144 rendering method can still be used, e.g. parse_url) |
| 917 | 145 @param access(unicode, None): permission needed to access the page |
| 146 None means public access. | |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
147 Pages inherit from parent pages: e.g. if a "settings" page is restricted |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
148 to admins, and if "settings/blog" is public, it still can only be accessed by |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
149 admins. See C.PAGES_ACCESS_* for details |
| 995 | 150 @param dynamic(bool): if True, activate websocket for bidirectional communication |
| 917 | 151 @param parse_url(callable, None): if set it will be called to handle the URL path |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
152 after this method, the page will be rendered if noting is left in path |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
153 (request.postpath) else a the request will be transmitted to a subpage |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
154 @param prepare_render(callable, None): if set, will be used to prepare the |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
155 rendering. That often means gathering data using the bridge |
|
1256
08cd652dea14
server, pages, tasks (brython): common_scripts:
Goffi <goffi@goffi.org>
parents:
1255
diff
changeset
|
156 @param render(callable, None): if template is not set, this method will be |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
157 called and what it returns will be rendered. |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
158 This method is mutually exclusive with template and must return a unicode |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
159 string. |
| 917 | 160 @param template(unicode, None): path to the template to render. |
| 161 This method is mutually exclusive with render | |
|
931
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
162 @param on_data_post(callable, None): method to call when data is posted |
|
1188
263fed3ce354
server (pages): on_data_post can now raise an exceptions.DataError to reload the page with a warning message (without validating data posted)
Goffi <goffi@goffi.org>
parents:
1187
diff
changeset
|
163 None if data post is not handled |
|
1284
65c43eec15ad
pages: `on_data_post` can be set to the string `continue` instead of a callable:
Goffi <goffi@goffi.org>
parents:
1283
diff
changeset
|
164 "continue" if data post is not handled there, and we must not interrupt |
|
65c43eec15ad
pages: `on_data_post` can be set to the string `continue` instead of a callable:
Goffi <goffi@goffi.org>
parents:
1283
diff
changeset
|
165 workflow (i.e. it's handled in "render" method). |
|
65c43eec15ad
pages: `on_data_post` can be set to the string `continue` instead of a callable:
Goffi <goffi@goffi.org>
parents:
1283
diff
changeset
|
166 otherwise, on_data_post can return a string with following value: |
| 962 | 167 - C.POST_NO_CONFIRM: confirm flag will not be set |
|
1188
263fed3ce354
server (pages): on_data_post can now raise an exceptions.DataError to reload the page with a warning message (without validating data posted)
Goffi <goffi@goffi.org>
parents:
1187
diff
changeset
|
168 on_data_post can raise following exceptions: |
|
263fed3ce354
server (pages): on_data_post can now raise an exceptions.DataError to reload the page with a warning message (without validating data posted)
Goffi <goffi@goffi.org>
parents:
1187
diff
changeset
|
169 - exceptions.DataError: value is incorrect, message will be displayed |
|
263fed3ce354
server (pages): on_data_post can now raise an exceptions.DataError to reload the page with a warning message (without validating data posted)
Goffi <goffi@goffi.org>
parents:
1187
diff
changeset
|
170 as a notification |
| 995 | 171 @param on_data(callable, None): method to call when dynamic data is sent |
| 172 this method is used with Libervia's websocket mechanism | |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
173 @param on_signal(callable, None): method to call when a registered signal is |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
174 received. This method is used with Libervia's websocket mechanism |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
175 @param url_cache(boolean): if set, result of parse_url is cached (per profile). |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
176 Useful when costly calls (e.g. network) are done while parsing URL. |
| 1153 | 177 @param replace_on_conflict(boolean): if True, don't raise ConflictError if a |
| 178 page of this name already exists, but replace it | |
| 917 | 179 """ |
| 180 | |
| 181 web_resource.Resource.__init__(self) | |
| 182 self.host = host | |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
183 self.vhost_root = vhost_root |
| 917 | 184 self.root_dir = root_dir |
| 962 | 185 self.url = url |
|
980
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
186 self.name = name |
| 1246 | 187 self.dyn_data = {} |
| 917 | 188 if name is not None: |
| 1153 | 189 if (name in self.named_pages |
| 190 and not (replace_on_conflict and self.named_pages[name].url == url)): | |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
191 raise exceptions.ConflictError( |
| 1216 | 192 _('a Libervia page named "{}" already exists'.format(name))) |
| 193 if "/" in name: | |
| 194 raise ValueError(_('"/" is not allowed in page names')) | |
|
923
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
195 if not name: |
| 1216 | 196 raise ValueError(_("a page name can't be empty")) |
| 917 | 197 self.named_pages[name] = self |
| 198 if access is None: | |
| 199 access = C.PAGES_ACCESS_PUBLIC | |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
200 if access not in ( |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
201 C.PAGES_ACCESS_PUBLIC, |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
202 C.PAGES_ACCESS_PROFILE, |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
203 C.PAGES_ACCESS_NONE, |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
204 ): |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
205 raise NotImplementedError( |
| 1216 | 206 _("{} access is not implemented yet").format(access) |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
207 ) |
|
922
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
208 self.access = access |
| 995 | 209 self.dynamic = dynamic |
|
923
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
210 if redirect is not None: |
|
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
211 # only page access and name make sense in case of full redirection |
|
980
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
212 # so we check that rendering methods/values are not set |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
213 if not all( |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
214 lambda x: x is not None |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
215 for x in (parse_url, prepare_render, render, template) |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
216 ): |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
217 raise ValueError( |
| 1216 | 218 _("you can't use full page redirection with other rendering" |
| 219 "method, check self.pageRedirect if you need to use them")) | |
|
923
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
220 self.redirect = redirect |
|
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
221 else: |
|
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
222 self.redirect = None |
| 917 | 223 self.parse_url = parse_url |
| 224 self.prepare_render = prepare_render | |
| 225 self.template = template | |
| 226 self.render_method = render | |
|
931
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
227 self.on_data_post = on_data_post |
| 995 | 228 self.on_data = on_data |
| 229 self.on_signal = on_signal | |
| 1018 | 230 self.url_cache = url_cache |
|
922
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
231 if access == C.PAGES_ACCESS_NONE: |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
232 # none pages just return a 404, no further check is needed |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
233 return |
|
1059
d127a85b2fee
pages: don't log error anymore when empty page_meta.py are used
Goffi <goffi@goffi.org>
parents:
1056
diff
changeset
|
234 if template is not None and render is not None: |
| 1216 | 235 log.error(_("render and template methods can't be used at the same time")) |
| 917 | 236 |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
237 # if not None, next rendering will be cached |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
238 # it must then contain a list of the the keys to use (without the page instance) |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
239 # e.g. [C.SERVICE_PROFILE, "pubsub", server@example.tld, pubsub_node] |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
240 self._do_cache = None |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
241 |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
242 def __str__(self): |
| 1216 | 243 return "LiberviaPage {name} at {url} (vhost: {vhost_root})".format( |
| 244 name=self.name or "<anonymous>", url=self.url, vhost_root=self.vhost_root) | |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
245 |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
246 @property |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
247 def named_pages(self): |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
248 return self.vhost_root.named_pages |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
249 |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
250 @property |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
251 def uri_callbacks(self): |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
252 return self.vhost_root.uri_callbacks |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
253 |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
254 @property |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
255 def pages_redirects(self): |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
256 return self.vhost_root.pages_redirects |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
257 |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
258 @property |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
259 def cached_urls(self): |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
260 return self.vhost_root.cached_urls |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
261 |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
262 @property |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
263 def main_menu(self): |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
264 return self.vhost_root.main_menu |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
265 |
|
1275
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
266 @property |
|
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
267 def default_theme(self): |
|
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
268 return self.vhost_root.default_theme |
|
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
269 |
|
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
270 |
|
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
271 @property |
|
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
272 def site_themes(self): |
|
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
273 return self.vhost_root.site_themes |
|
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
274 |
| 1153 | 275 @staticmethod |
| 276 def createPage(host, meta_path, vhost_root, url_elts, replace_on_conflict=False): | |
| 277 """Create a LiberviaPage instance | |
| 278 | |
|
1253
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
279 @param meta_path(Path): path to the page_meta.py file |
| 1153 | 280 @param vhost_root(resource.Resource): root resource of the virtual host |
| 281 @param url_elts(list[unicode]): list of path element from root site to this page | |
| 282 @param replace_on_conflict(bool): same as for [LiberviaPage] | |
| 283 @return (tuple[dict, LiberviaPage]): tuple with: | |
| 284 - page_data: dict containing data of the page | |
| 285 - libervia_page: created resource | |
| 286 """ | |
|
1253
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
287 dir_path = meta_path.parent |
| 1216 | 288 page_data = {"__name__": ".".join(["page"] + url_elts)} |
| 1153 | 289 # we don't want to force the presence of __init__.py |
| 290 # so we use execfile instead of import. | |
| 291 # TODO: when moved to Python 3, __init__.py is not mandatory anymore | |
| 292 # so we can switch to import | |
| 1216 | 293 exec(compile(open(meta_path, "rb").read(), meta_path, 'exec'), page_data) |
| 1153 | 294 return page_data, LiberviaPage( |
| 295 host=host, | |
| 296 vhost_root=vhost_root, | |
| 297 root_dir=dir_path, | |
| 1216 | 298 url="/" + "/".join(url_elts), |
| 299 name=page_data.get("name"), | |
| 300 redirect=page_data.get("redirect"), | |
| 301 access=page_data.get("access"), | |
| 302 dynamic=page_data.get("dynamic", False), | |
| 303 parse_url=page_data.get("parse_url"), | |
| 304 prepare_render=page_data.get("prepare_render"), | |
| 305 render=page_data.get("render"), | |
| 306 template=page_data.get("template"), | |
| 307 on_data_post=page_data.get("on_data_post"), | |
| 308 on_data=page_data.get("on_data"), | |
| 309 on_signal=page_data.get("on_signal"), | |
| 310 url_cache=page_data.get("url_cache", False), | |
| 1153 | 311 replace_on_conflict=replace_on_conflict |
| 312 ) | |
| 313 | |
|
1253
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
314 @staticmethod |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
315 def createBrowserData( |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
316 vhost_root, |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
317 resource: Optional(LiberviaPage), |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
318 browser_path: Path, |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
319 path_elts: Optional(List[str]), |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
320 engine: str = "brython" |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
321 ) -> None: |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
322 """create and store data for browser dynamic code""" |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
323 dyn_data = { |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
324 "path": browser_path, |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
325 "url_hash": ( |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
326 hashlib.sha256('/'.join(path_elts).encode()).hexdigest() |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
327 if path_elts is not None else None |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
328 ), |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
329 } |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
330 browser_meta_path = browser_path / C.PAGES_BROWSER_META_FILE |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
331 if browser_meta_path.is_file(): |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
332 with browser_meta_path.open() as f: |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
333 browser_meta = json.load(f) |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
334 utils.recursive_update(vhost_root.browser_modules, browser_meta) |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
335 if resource is not None: |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
336 utils.recursive_update(resource.dyn_data, browser_meta) |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
337 |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
338 init_path = browser_path / '__init__.py' |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
339 if init_path.is_file(): |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
340 vhost_root.browser_modules.setdefault( |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
341 engine, []).append(dyn_data) |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
342 if resource is not None: |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
343 resource.dyn_data[engine] = dyn_data |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
344 elif path_elts is None: |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
345 try: |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
346 next(browser_path.glob('*.py')) |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
347 except StopIteration: |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
348 # no python file, nothing for Brython |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
349 pass |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
350 else: |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
351 vhost_root.browser_modules.setdefault( |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
352 engine, []).append(dyn_data) |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
353 |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
354 |
| 925 | 355 @classmethod |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
356 def importPages(cls, host, vhost_root, root_path=None, _parent=None, _path=None, |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
357 _extra_pages=False): |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
358 """Recursively import Libervia pages |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
359 |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
360 @param host(Libervia): Libervia instance |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
361 @param vhost_root(LiberviaRootResource): root of this VirtualHost |
|
1253
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
362 @param root_path(Path, None): use this root path instead of vhost_root's one |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
363 Used to add default site pages to external sites |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
364 @param _parent(Resource, None): _parent page. Do not set yourself, this is for |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
365 internal use only |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
366 @param _path(list(unicode), None): current path. Do not set yourself, this is for |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
367 internal use only |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
368 @param _extra_pages(boolean): set to True when extra pages are used (i.e. |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
369 root_path is set). Do not set yourself, this is for internal use only |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
370 """ |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
371 if _path is None: |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
372 _path = [] |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
373 if _parent is None: |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
374 if root_path is None: |
|
1253
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
375 root_dir = vhost_root.site_path / C.PAGES_DIR |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
376 else: |
|
1253
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
377 root_dir = root_path / C.PAGES_DIR |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
378 _extra_pages = True |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
379 _parent = vhost_root |
|
1253
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
380 root_browser_path = root_dir / C.PAGES_BROWSER_DIR |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
381 if root_browser_path.is_dir(): |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
382 cls.createBrowserData(vhost_root, None, root_browser_path, None) |
| 917 | 383 else: |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
384 root_dir = _parent.root_dir |
|
1253
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
385 |
| 917 | 386 for d in os.listdir(root_dir): |
|
1253
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
387 dir_path = root_dir / d |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
388 if not dir_path.is_dir(): |
| 917 | 389 continue |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
390 if _extra_pages and d in _parent.children: |
| 1216 | 391 log.debug(_("[{host_name}] {path} is already present, ignoring it") |
| 392 .format(host_name=vhost_root.host_name, path='/'.join(_path+[d]))) | |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
393 continue |
|
1253
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
394 meta_path = dir_path / C.PAGES_META_FILE |
|
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
395 if meta_path.is_file(): |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
396 new_path = _path + [d] |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
397 try: |
| 1246 | 398 page_data, resource = cls.createPage( |
| 399 host, meta_path, vhost_root, new_path) | |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
400 except exceptions.ConflictError as e: |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
401 if _extra_pages: |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
402 # extra pages are discarded if there is already an existing page |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
403 continue |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
404 else: |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
405 raise e |
|
1253
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
406 _parent.putChild(str(d).encode(), resource) |
| 1216 | 407 log_msg = ("[{host_name}] Added /{path} page".format( |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
408 host_name=vhost_root.host_name, |
| 1216 | 409 path="[…]/".join(new_path))) |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
410 if _extra_pages: |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
411 log.debug(log_msg) |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
412 else: |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
413 log.info(log_msg) |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
414 if "uri_handlers" in page_data: |
| 925 | 415 if not isinstance(page_data, dict): |
| 1216 | 416 log.error(_("uri_handlers must be a dict")) |
| 925 | 417 else: |
| 1216 | 418 for uri_tuple, cb_name in page_data["uri_handlers"].items(): |
| 419 if len(uri_tuple) != 2 or not isinstance(cb_name, str): | |
| 420 log.error(_("invalid uri_tuple")) | |
| 925 | 421 continue |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
422 if not _extra_pages: |
| 1216 | 423 log.info(_("setting {}/{} URIs handler") |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
424 .format(*uri_tuple)) |
| 925 | 425 try: |
| 426 cb = page_data[cb_name] | |
| 427 except KeyError: | |
| 1216 | 428 log.error(_("missing {name} method to handle {1}/{2}") |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
429 .format(name=cb_name, *uri_tuple)) |
| 925 | 430 continue |
| 431 else: | |
| 1038 | 432 resource.registerURI(uri_tuple, cb) |
| 925 | 433 |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
434 LiberviaPage.importPages( |
| 1153 | 435 host, vhost_root, _parent=resource, _path=new_path, |
| 436 _extra_pages=_extra_pages) | |
| 1246 | 437 # now we check if there is some code for browser |
|
1253
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
438 browser_path = dir_path / C.PAGES_BROWSER_DIR |
| 1246 | 439 if browser_path.is_dir(): |
|
1253
6d49fae517ba
pages: browser metadata + root `_browser`:
Goffi <goffi@goffi.org>
parents:
1246
diff
changeset
|
440 cls.createBrowserData(vhost_root, resource, browser_path, new_path) |
| 1153 | 441 |
| 442 @classmethod | |
| 443 def onFileChange(cls, host, file_path, flags, site_root, site_path): | |
| 444 """Method triggered by file_watcher when something is changed in files | |
| 445 | |
| 446 This method is used in dev mode to reload pages when needed | |
| 447 @param file_path(filepath.FilePath): path of the file which triggered the event | |
| 448 @param flags[list[unicode]): human readable flags of the event (from | |
| 449 internet.inotify) | |
| 450 @param site_root(LiberviaRootResource): root of the site | |
| 451 @param site_path(unicode): absolute path of the site | |
| 452 """ | |
| 453 if flags == ['create']: | |
| 454 return | |
|
1277
2e4fcd31f2a9
pages: use Path in onFileChange + fixed encoding issue
Goffi <goffi@goffi.org>
parents:
1276
diff
changeset
|
455 path = Path(file_path.path.decode()) |
|
2e4fcd31f2a9
pages: use Path in onFileChange + fixed encoding issue
Goffi <goffi@goffi.org>
parents:
1276
diff
changeset
|
456 base_name = path.name |
| 1216 | 457 if base_name != "page_meta.py": |
| 1153 | 458 # we only handle libervia pages |
| 459 return | |
| 460 | |
| 1216 | 461 log.debug("{flags} event(s) received for {file_path}".format( |
| 462 flags=", ".join(flags), file_path=file_path)) | |
| 1153 | 463 |
|
1277
2e4fcd31f2a9
pages: use Path in onFileChange + fixed encoding issue
Goffi <goffi@goffi.org>
parents:
1276
diff
changeset
|
464 dir_path = path.parent |
|
2e4fcd31f2a9
pages: use Path in onFileChange + fixed encoding issue
Goffi <goffi@goffi.org>
parents:
1276
diff
changeset
|
465 |
|
2e4fcd31f2a9
pages: use Path in onFileChange + fixed encoding issue
Goffi <goffi@goffi.org>
parents:
1276
diff
changeset
|
466 if dir_path == site_path: |
|
2e4fcd31f2a9
pages: use Path in onFileChange + fixed encoding issue
Goffi <goffi@goffi.org>
parents:
1276
diff
changeset
|
467 return |
| 1153 | 468 |
|
1277
2e4fcd31f2a9
pages: use Path in onFileChange + fixed encoding issue
Goffi <goffi@goffi.org>
parents:
1276
diff
changeset
|
469 if not site_path in dir_path.parents: |
|
2e4fcd31f2a9
pages: use Path in onFileChange + fixed encoding issue
Goffi <goffi@goffi.org>
parents:
1276
diff
changeset
|
470 raise exceptions.InternalError("watched file should be in a subdirectory of site path") |
|
2e4fcd31f2a9
pages: use Path in onFileChange + fixed encoding issue
Goffi <goffi@goffi.org>
parents:
1276
diff
changeset
|
471 |
|
2e4fcd31f2a9
pages: use Path in onFileChange + fixed encoding issue
Goffi <goffi@goffi.org>
parents:
1276
diff
changeset
|
472 path_elts = list(dir_path.relative_to(site_path).parts) |
| 1153 | 473 |
| 474 if path_elts[0] == C.PAGES_DIR: | |
| 475 # a page has been modified | |
| 476 del path_elts[0] | |
| 477 if not path_elts: | |
| 478 # we need at least one element to parse | |
| 479 return | |
| 480 # we retrieve page by starting from site root and finding each path element | |
| 481 parent = page = site_root | |
| 482 new_page = False | |
| 483 for idx, child_name in enumerate(path_elts): | |
|
1277
2e4fcd31f2a9
pages: use Path in onFileChange + fixed encoding issue
Goffi <goffi@goffi.org>
parents:
1276
diff
changeset
|
484 child_name = child_name.encode() |
| 1153 | 485 try: |
|
1157
64952ba7affe
pages: fixed children retrieval in onFileChange
Goffi <goffi@goffi.org>
parents:
1153
diff
changeset
|
486 try: |
|
64952ba7affe
pages: fixed children retrieval in onFileChange
Goffi <goffi@goffi.org>
parents:
1153
diff
changeset
|
487 page = page.original.children[child_name] |
|
64952ba7affe
pages: fixed children retrieval in onFileChange
Goffi <goffi@goffi.org>
parents:
1153
diff
changeset
|
488 except AttributeError: |
|
64952ba7affe
pages: fixed children retrieval in onFileChange
Goffi <goffi@goffi.org>
parents:
1153
diff
changeset
|
489 page = page.children[child_name] |
| 1153 | 490 except KeyError: |
| 491 if idx != len(path_elts)-1: | |
| 492 # a page has been created in a subdir when one or more | |
| 493 # page_meta.py are missing on the way | |
| 1216 | 494 log.warning(_("Can't create a page at {path}, missing parents") |
| 1153 | 495 .format(path=path)) |
| 496 return | |
| 497 new_page = True | |
| 498 else: | |
| 499 if idx<len(path_elts)-1: | |
| 500 parent = page.original | |
| 501 | |
| 502 try: | |
| 503 # we (re)create a page with the new/modified code | |
| 504 __, resource = cls.createPage(host, path, site_root, path_elts, | |
| 505 replace_on_conflict=True) | |
| 506 if not new_page: | |
|
1157
64952ba7affe
pages: fixed children retrieval in onFileChange
Goffi <goffi@goffi.org>
parents:
1153
diff
changeset
|
507 try: |
|
64952ba7affe
pages: fixed children retrieval in onFileChange
Goffi <goffi@goffi.org>
parents:
1153
diff
changeset
|
508 resource.children = page.original.children |
|
64952ba7affe
pages: fixed children retrieval in onFileChange
Goffi <goffi@goffi.org>
parents:
1153
diff
changeset
|
509 except AttributeError: |
|
64952ba7affe
pages: fixed children retrieval in onFileChange
Goffi <goffi@goffi.org>
parents:
1153
diff
changeset
|
510 # FIXME: this .original handling madness is due to EncodingResourceWrapper |
|
64952ba7affe
pages: fixed children retrieval in onFileChange
Goffi <goffi@goffi.org>
parents:
1153
diff
changeset
|
511 # EncodingResourceWrapper should probably be removed |
|
64952ba7affe
pages: fixed children retrieval in onFileChange
Goffi <goffi@goffi.org>
parents:
1153
diff
changeset
|
512 resource.children = page.children |
| 1153 | 513 except Exception as e: |
| 1216 | 514 log.warning(_("Can't create page: {reason}").format(reason=e)) |
| 1153 | 515 else: |
|
1277
2e4fcd31f2a9
pages: use Path in onFileChange + fixed encoding issue
Goffi <goffi@goffi.org>
parents:
1276
diff
changeset
|
516 url_elt = path_elts[-1].encode() |
| 1153 | 517 if not new_page: |
| 518 # the page was already existing, we remove it | |
| 519 del parent.children[url_elt] | |
| 520 # we can now add the new page | |
| 521 parent.putChild(url_elt, resource) | |
| 522 if new_page: | |
| 1216 | 523 log.info(_("{page} created").format(page=resource)) |
| 1153 | 524 else: |
| 1216 | 525 log.info(_("{page} reloaded").format(page=resource)) |
|
990
6daa59d44ee2
pages: menu implementation, first draft:
Goffi <goffi@goffi.org>
parents:
985
diff
changeset
|
526 |
|
1283
436ef2ad92af
pages: moved CSRF checking code to a separate method:
Goffi <goffi@goffi.org>
parents:
1282
diff
changeset
|
527 def checkCSRF(self, request): |
|
436ef2ad92af
pages: moved CSRF checking code to a separate method:
Goffi <goffi@goffi.org>
parents:
1282
diff
changeset
|
528 csrf_token = self.host.getSessionData( |
|
436ef2ad92af
pages: moved CSRF checking code to a separate method:
Goffi <goffi@goffi.org>
parents:
1282
diff
changeset
|
529 request, session_iface.ISATSession |
|
436ef2ad92af
pages: moved CSRF checking code to a separate method:
Goffi <goffi@goffi.org>
parents:
1282
diff
changeset
|
530 ).csrf_token |
|
436ef2ad92af
pages: moved CSRF checking code to a separate method:
Goffi <goffi@goffi.org>
parents:
1282
diff
changeset
|
531 given_csrf = request.getHeader("X-Csrf-Token") |
|
436ef2ad92af
pages: moved CSRF checking code to a separate method:
Goffi <goffi@goffi.org>
parents:
1282
diff
changeset
|
532 if given_csrf is None: |
|
436ef2ad92af
pages: moved CSRF checking code to a separate method:
Goffi <goffi@goffi.org>
parents:
1282
diff
changeset
|
533 try: |
|
436ef2ad92af
pages: moved CSRF checking code to a separate method:
Goffi <goffi@goffi.org>
parents:
1282
diff
changeset
|
534 given_csrf = self.getPostedData(request, "csrf_token") |
|
436ef2ad92af
pages: moved CSRF checking code to a separate method:
Goffi <goffi@goffi.org>
parents:
1282
diff
changeset
|
535 except KeyError: |
|
436ef2ad92af
pages: moved CSRF checking code to a separate method:
Goffi <goffi@goffi.org>
parents:
1282
diff
changeset
|
536 pass |
|
436ef2ad92af
pages: moved CSRF checking code to a separate method:
Goffi <goffi@goffi.org>
parents:
1282
diff
changeset
|
537 if given_csrf is None or given_csrf != csrf_token: |
|
436ef2ad92af
pages: moved CSRF checking code to a separate method:
Goffi <goffi@goffi.org>
parents:
1282
diff
changeset
|
538 log.warning( |
|
436ef2ad92af
pages: moved CSRF checking code to a separate method:
Goffi <goffi@goffi.org>
parents:
1282
diff
changeset
|
539 _("invalid CSRF token, hack attempt? URL: {url}, IP: {ip}").format( |
|
436ef2ad92af
pages: moved CSRF checking code to a separate method:
Goffi <goffi@goffi.org>
parents:
1282
diff
changeset
|
540 url=request.uri, ip=request.getClientIP() |
|
436ef2ad92af
pages: moved CSRF checking code to a separate method:
Goffi <goffi@goffi.org>
parents:
1282
diff
changeset
|
541 ) |
|
436ef2ad92af
pages: moved CSRF checking code to a separate method:
Goffi <goffi@goffi.org>
parents:
1282
diff
changeset
|
542 ) |
|
436ef2ad92af
pages: moved CSRF checking code to a separate method:
Goffi <goffi@goffi.org>
parents:
1282
diff
changeset
|
543 self.pageError(request, C.HTTP_FORBIDDEN) |
|
436ef2ad92af
pages: moved CSRF checking code to a separate method:
Goffi <goffi@goffi.org>
parents:
1282
diff
changeset
|
544 |
|
1286
63328c793a9e
pages: new method `exposeToScripts` to make variables accessible to scripts in browser
Goffi <goffi@goffi.org>
parents:
1285
diff
changeset
|
545 def exposeToScripts( |
|
63328c793a9e
pages: new method `exposeToScripts` to make variables accessible to scripts in browser
Goffi <goffi@goffi.org>
parents:
1285
diff
changeset
|
546 self, |
|
63328c793a9e
pages: new method `exposeToScripts` to make variables accessible to scripts in browser
Goffi <goffi@goffi.org>
parents:
1285
diff
changeset
|
547 request: server.Request, |
|
63328c793a9e
pages: new method `exposeToScripts` to make variables accessible to scripts in browser
Goffi <goffi@goffi.org>
parents:
1285
diff
changeset
|
548 **kwargs: str |
|
63328c793a9e
pages: new method `exposeToScripts` to make variables accessible to scripts in browser
Goffi <goffi@goffi.org>
parents:
1285
diff
changeset
|
549 ) -> None: |
|
63328c793a9e
pages: new method `exposeToScripts` to make variables accessible to scripts in browser
Goffi <goffi@goffi.org>
parents:
1285
diff
changeset
|
550 """Make a local variable available to page script as a global variable |
|
63328c793a9e
pages: new method `exposeToScripts` to make variables accessible to scripts in browser
Goffi <goffi@goffi.org>
parents:
1285
diff
changeset
|
551 |
|
63328c793a9e
pages: new method `exposeToScripts` to make variables accessible to scripts in browser
Goffi <goffi@goffi.org>
parents:
1285
diff
changeset
|
552 No check is done for conflicting name, use this carefully |
|
63328c793a9e
pages: new method `exposeToScripts` to make variables accessible to scripts in browser
Goffi <goffi@goffi.org>
parents:
1285
diff
changeset
|
553 """ |
|
63328c793a9e
pages: new method `exposeToScripts` to make variables accessible to scripts in browser
Goffi <goffi@goffi.org>
parents:
1285
diff
changeset
|
554 template_data = request.template_data |
|
63328c793a9e
pages: new method `exposeToScripts` to make variables accessible to scripts in browser
Goffi <goffi@goffi.org>
parents:
1285
diff
changeset
|
555 scripts = template_data.setdefault("scripts", utils.OrderedSet()) |
|
63328c793a9e
pages: new method `exposeToScripts` to make variables accessible to scripts in browser
Goffi <goffi@goffi.org>
parents:
1285
diff
changeset
|
556 for name, value in kwargs.items(): |
|
63328c793a9e
pages: new method `exposeToScripts` to make variables accessible to scripts in browser
Goffi <goffi@goffi.org>
parents:
1285
diff
changeset
|
557 scripts.add(Script(content=f"var {name}={value!r};")) |
|
63328c793a9e
pages: new method `exposeToScripts` to make variables accessible to scripts in browser
Goffi <goffi@goffi.org>
parents:
1285
diff
changeset
|
558 |
| 1038 | 559 def registerURI(self, uri_tuple, get_uri_cb): |
| 1153 | 560 """Register a URI handler |
| 925 | 561 |
| 562 @param uri_tuple(tuple[unicode, unicode]): type or URIs handler | |
| 563 type/subtype as returned by tools/common/parseXMPPUri | |
| 1038 | 564 or type/None to handle all subtypes |
| 925 | 565 @param get_uri_cb(callable): method which take uri_data dict as only argument |
| 1038 | 566 and return absolute path with correct arguments or None if the page |
| 567 can't handle this URL | |
| 925 | 568 """ |
| 1038 | 569 if uri_tuple in self.uri_callbacks: |
| 1216 | 570 log.info(_("{}/{} URIs are already handled, replacing by the new handler") |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
571 .format( *uri_tuple)) |
| 1038 | 572 self.uri_callbacks[uri_tuple] = (self, get_uri_cb) |
| 925 | 573 |
|
1203
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
574 def getSignalId(self, request): |
|
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
575 """Retrieve signal_id for a request |
|
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
576 |
|
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
577 signal_id is used for dynamic page, to associate a initial request with a |
|
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
578 signal handler. For WebsocketRequest, signal_id attribute is used (which must |
|
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
579 be orginal request's id) |
|
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
580 For server.Request it's id(request) |
|
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
581 """ |
|
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
582 return getattr(request, 'signal_id', id(request)) |
|
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
583 |
| 995 | 584 def registerSignal(self, request, signal, check_profile=True): |
| 585 r"""register a signal handler | |
| 586 | |
| 587 the page must be dynamic | |
| 588 when signal is received, self.on_signal will be called with: | |
| 589 - request | |
| 590 - signal name | |
| 591 - signal arguments | |
| 592 signal handler will be removed when connection with dynamic page will be lost | |
| 593 @param signal(unicode): name of the signal | |
| 594 last arg of signal must be profile, as it will be checked to filter signals | |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
595 @param check_profile(bool): if True, signal profile (which MUST be last arg) |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
596 will be checked against session profile. |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
597 /!\ if False, profile will not be checked/filtered, be sure to know what you |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
598 are doing if you unset this option /!\ |
| 995 | 599 """ |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
600 # FIXME: add a timeout; if socket is not opened before it, signal handler |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
601 # must be removed |
| 995 | 602 if not self.dynamic: |
| 1216 | 603 log.error(_("You can't register signal if page is not dynamic")) |
| 995 | 604 return |
|
1203
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
605 signal_id = self.getSignalId(request) |
|
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
606 LiberviaPage.signals_handlers.setdefault(signal, {})[signal_id] = [ |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
607 self, |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
608 request, |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
609 check_profile, |
|
1203
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
610 ] |
| 995 | 611 request._signals_registered.append(signal) |
| 612 | |
|
1147
02afab1b15c5
server, pages, tasks: moved getConfig to backend, and added shorcut version in LiberviaPage and TasksManager
Goffi <goffi@goffi.org>
parents:
1146
diff
changeset
|
613 def getConfig(self, key, default=None, value_type=None): |
|
02afab1b15c5
server, pages, tasks: moved getConfig to backend, and added shorcut version in LiberviaPage and TasksManager
Goffi <goffi@goffi.org>
parents:
1146
diff
changeset
|
614 return self.host.getConfig(self.vhost_root, key=key, default=default, |
|
02afab1b15c5
server, pages, tasks: moved getConfig to backend, and added shorcut version in LiberviaPage and TasksManager
Goffi <goffi@goffi.org>
parents:
1146
diff
changeset
|
615 value_type=value_type) |
|
02afab1b15c5
server, pages, tasks: moved getConfig to backend, and added shorcut version in LiberviaPage and TasksManager
Goffi <goffi@goffi.org>
parents:
1146
diff
changeset
|
616 |
|
1146
76d75423ef53
server: tasks manager first draft:
Goffi <goffi@goffi.org>
parents:
1145
diff
changeset
|
617 def getBuildPath(self, session_data): |
|
76d75423ef53
server: tasks manager first draft:
Goffi <goffi@goffi.org>
parents:
1145
diff
changeset
|
618 return session_data.cache_dir + self.vhost.site_name |
|
76d75423ef53
server: tasks manager first draft:
Goffi <goffi@goffi.org>
parents:
1145
diff
changeset
|
619 |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
620 def getPageByName(self, name): |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
621 return self.vhost_root.getPageByName(name) |
|
927
bb4dfc2802c0
server (pages): added getPagePathFromURI method to retrieve page handling an URI
Goffi <goffi@goffi.org>
parents:
926
diff
changeset
|
622 |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
623 def getPagePathFromURI(self, uri): |
| 1175 | 624 return self.vhost_root.getPagePathFromURI(uri) |
|
936
78692d47340d
server (pages): added getPageByName
Goffi <goffi@goffi.org>
parents:
935
diff
changeset
|
625 |
| 1216 | 626 def getPageRedirectURL(self, request, page_name="login", url=None): |
| 962 | 627 """generate URL for a page with redirect_url parameter set |
| 628 | |
| 629 mainly used for login page with redirection to current page | |
| 630 @param request(server.Request): current HTTP request | |
| 631 @param page_name(unicode): name of the page to go | |
| 632 @param url(None, unicode): url to redirect to | |
| 633 None to use request path (i.e. current page) | |
| 634 @return (unicode): URL to use | |
| 635 """ | |
| 1216 | 636 return "{root_url}?redirect_url={redirect_url}".format( |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
637 root_url=self.getPageByName(page_name).url, |
| 1216 | 638 redirect_url=urllib.parse.quote_plus(request.uri) |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
639 if url is None |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
640 else url.encode("utf-8"), |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
641 ) |
| 962 | 642 |
|
972
c4e58c4dba75
server: getURL + minor improvments:
Goffi <goffi@goffi.org>
parents:
968
diff
changeset
|
643 def getURL(self, *args): |
|
c4e58c4dba75
server: getURL + minor improvments:
Goffi <goffi@goffi.org>
parents:
968
diff
changeset
|
644 """retrieve URL of the page set arguments |
|
c4e58c4dba75
server: getURL + minor improvments:
Goffi <goffi@goffi.org>
parents:
968
diff
changeset
|
645 |
|
c4e58c4dba75
server: getURL + minor improvments:
Goffi <goffi@goffi.org>
parents:
968
diff
changeset
|
646 *args(list[unicode]): argument to add to the URL as path elements |
|
1014
dfced7992460
pages: ignore empty or unset arguments in getURL
Goffi <goffi@goffi.org>
parents:
1013
diff
changeset
|
647 empty or None arguments will be ignored |
|
972
c4e58c4dba75
server: getURL + minor improvments:
Goffi <goffi@goffi.org>
parents:
968
diff
changeset
|
648 """ |
|
1014
dfced7992460
pages: ignore empty or unset arguments in getURL
Goffi <goffi@goffi.org>
parents:
1013
diff
changeset
|
649 url_args = [quote(a) for a in args if a] |
|
980
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
650 |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
651 if self.name is not None and self.name in self.pages_redirects: |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
652 # we check for redirection |
|
980
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
653 redirect_data = self.pages_redirects[self.name] |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
654 args_hash = tuple(args) |
| 1216 | 655 for limit in range(len(args) + 1): |
|
980
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
656 current_hash = args_hash[:limit] |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
657 if current_hash in redirect_data: |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
658 url_base = redirect_data[current_hash] |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
659 remaining = args[limit:] |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
660 remaining_url = "/".join(remaining) |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
661 return os.path.join("/", url_base, remaining_url) |
|
980
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
662 |
|
972
c4e58c4dba75
server: getURL + minor improvments:
Goffi <goffi@goffi.org>
parents:
968
diff
changeset
|
663 return os.path.join(self.url, *url_args) |
|
c4e58c4dba75
server: getURL + minor improvments:
Goffi <goffi@goffi.org>
parents:
968
diff
changeset
|
664 |
|
1010
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
665 def getCurrentURL(self, request): |
| 1015 | 666 """retrieve URL used to access this page |
|
1010
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
667 |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
668 @return(unicode): current URL |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
669 """ |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
670 # we get url in the following way (splitting request.path instead of using |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
671 # request.prepath) because request.prepath may have been modified by |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
672 # redirection (if redirection args have been specified), while path reflect |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
673 # the real request |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
674 |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
675 # we ignore empty path elements (i.e. double '/' or '/' at the end) |
| 1216 | 676 path_elts = [p for p in request.path.decode('utf-8').split("/") if p] |
|
1010
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
677 |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
678 if request.postpath: |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
679 if not request.postpath[-1]: |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
680 # we remove trailing slash |
|
1010
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
681 request.postpath = request.postpath[:-1] |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
682 if request.postpath: |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
683 # getSubPageURL must return subpage from the point where |
|
1010
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
684 # the it is called, so we have to remove remanining |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
685 # path elements |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
686 path_elts = path_elts[: -len(request.postpath)] |
|
1010
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
687 |
| 1216 | 688 return "/" + "/".join(path_elts) |
|
1010
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
689 |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
690 def getParamURL(self, request, **kwargs): |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
691 """use URL of current request but modify the parameters in query part |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
692 |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
693 **kwargs(dict[str, unicode]): argument to use as query parameters |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
694 @return (unicode): constructed URL |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
695 """ |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
696 current_url = self.getCurrentURL(request) |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
697 if kwargs: |
| 1216 | 698 encoded = urllib.parse.urlencode( |
| 699 {k: v for k, v in kwargs.items()} | |
| 700 ) | |
| 701 current_url = current_url + "?" + encoded | |
|
1010
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
702 return current_url |
|
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
703 |
|
1092
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
704 def getSubPageByName(self, subpage_name, parent=None): |
|
1030
66a050b32df8
pages: moved code getting subpage from getSubPageURL to new getSubPageByName method.
Goffi <goffi@goffi.org>
parents:
1019
diff
changeset
|
705 """retrieve a subpage and its path using its name |
|
66a050b32df8
pages: moved code getting subpage from getSubPageURL to new getSubPageByName method.
Goffi <goffi@goffi.org>
parents:
1019
diff
changeset
|
706 |
|
1092
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
707 @param subpage_name(unicode): name of the sub page |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
708 it must be a direct children of parent page |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
709 @param parent(LiberviaPage, None): parent page |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
710 None to use current page |
|
1030
66a050b32df8
pages: moved code getting subpage from getSubPageURL to new getSubPageByName method.
Goffi <goffi@goffi.org>
parents:
1019
diff
changeset
|
711 @return (tuple[str, LiberviaPage]): page subpath and instance |
|
66a050b32df8
pages: moved code getting subpage from getSubPageURL to new getSubPageByName method.
Goffi <goffi@goffi.org>
parents:
1019
diff
changeset
|
712 @raise exceptions.NotFound: no page has been found |
|
66a050b32df8
pages: moved code getting subpage from getSubPageURL to new getSubPageByName method.
Goffi <goffi@goffi.org>
parents:
1019
diff
changeset
|
713 """ |
|
1092
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
714 if parent is None: |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
715 parent = self |
| 1216 | 716 for path, child in parent.children.items(): |
|
1030
66a050b32df8
pages: moved code getting subpage from getSubPageURL to new getSubPageByName method.
Goffi <goffi@goffi.org>
parents:
1019
diff
changeset
|
717 try: |
|
66a050b32df8
pages: moved code getting subpage from getSubPageURL to new getSubPageByName method.
Goffi <goffi@goffi.org>
parents:
1019
diff
changeset
|
718 child_name = child.name |
|
66a050b32df8
pages: moved code getting subpage from getSubPageURL to new getSubPageByName method.
Goffi <goffi@goffi.org>
parents:
1019
diff
changeset
|
719 except AttributeError: |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
720 # LiberviaPages have a name, but maybe this is an other Resource |
|
1030
66a050b32df8
pages: moved code getting subpage from getSubPageURL to new getSubPageByName method.
Goffi <goffi@goffi.org>
parents:
1019
diff
changeset
|
721 continue |
|
66a050b32df8
pages: moved code getting subpage from getSubPageURL to new getSubPageByName method.
Goffi <goffi@goffi.org>
parents:
1019
diff
changeset
|
722 if child_name == subpage_name: |
| 1216 | 723 return path.decode('utf-8'), child |
| 724 raise exceptions.NotFound(_("requested sub page has not been found")) | |
|
1030
66a050b32df8
pages: moved code getting subpage from getSubPageURL to new getSubPageByName method.
Goffi <goffi@goffi.org>
parents:
1019
diff
changeset
|
725 |
|
980
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
726 def getSubPageURL(self, request, page_name, *args): |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
727 """retrieve a page in direct children and build its URL according to request |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
728 |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
729 request's current path is used as base (at current parsing point, |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
730 i.e. it's more prepath than path). |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
731 Requested page is checked in children and an absolute URL is then built |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
732 by the resulting combination. |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
733 This method is useful to construct absolute URLs for children instead of |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
734 using relative path, which may not work in subpages, and are linked to the |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
735 names of directories (i.e. relative URL will break if subdirectory is renamed |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
736 while getSubPageURL won't as long as page_name is consistent). |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
737 Also, request.path is used, keeping real path used by user, |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
738 and potential redirections. |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
739 @param request(server.Request): current HTTP request |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
740 @param page_name(unicode): name of the page to retrieve |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
741 it must be a direct children of current page |
|
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
742 @param *args(list[unicode]): arguments to add as path elements |
|
1110
045e8bdaed4f
pages: ignore args if they are None in getSubPageURL
Goffi <goffi@goffi.org>
parents:
1109
diff
changeset
|
743 if an arg is None, it will be ignored |
|
1092
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
744 @return (unicode): absolute URL to the sub page |
|
980
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
745 """ |
|
1010
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
746 current_url = self.getCurrentURL(request) |
|
1092
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
747 path, child = self.getSubPageByName(page_name) |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
748 return os.path.join( |
| 1216 | 749 "/", current_url, path, *[quote(a) for a in args if a is not None] |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
750 ) |
|
980
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
751 |
|
1031
4ba7df23b976
pages: new method getURLByNames to retrieve URL from list of page names/path arguments
Goffi <goffi@goffi.org>
parents:
1030
diff
changeset
|
752 def getURLByNames(self, named_path): |
|
1171
469d0de8da0e
pages (blog, u): added atom feed link in "links" template data.
Goffi <goffi@goffi.org>
parents:
1169
diff
changeset
|
753 """Retrieve URL from pages names and arguments |
|
1031
4ba7df23b976
pages: new method getURLByNames to retrieve URL from list of page names/path arguments
Goffi <goffi@goffi.org>
parents:
1030
diff
changeset
|
754 |
|
4ba7df23b976
pages: new method getURLByNames to retrieve URL from list of page names/path arguments
Goffi <goffi@goffi.org>
parents:
1030
diff
changeset
|
755 @param named_path(list[tuple[unicode, list[unicode]]]): path to the page as a list |
|
4ba7df23b976
pages: new method getURLByNames to retrieve URL from list of page names/path arguments
Goffi <goffi@goffi.org>
parents:
1030
diff
changeset
|
756 of tuples of 2 items: |
|
4ba7df23b976
pages: new method getURLByNames to retrieve URL from list of page names/path arguments
Goffi <goffi@goffi.org>
parents:
1030
diff
changeset
|
757 - first item is page name |
|
4ba7df23b976
pages: new method getURLByNames to retrieve URL from list of page names/path arguments
Goffi <goffi@goffi.org>
parents:
1030
diff
changeset
|
758 - second item is list of path arguments of this page |
|
4ba7df23b976
pages: new method getURLByNames to retrieve URL from list of page names/path arguments
Goffi <goffi@goffi.org>
parents:
1030
diff
changeset
|
759 @return (unicode): URL to the requested page with given path arguments |
|
4ba7df23b976
pages: new method getURLByNames to retrieve URL from list of page names/path arguments
Goffi <goffi@goffi.org>
parents:
1030
diff
changeset
|
760 @raise exceptions.NotFound: one of the page was not found |
|
4ba7df23b976
pages: new method getURLByNames to retrieve URL from list of page names/path arguments
Goffi <goffi@goffi.org>
parents:
1030
diff
changeset
|
761 """ |
|
4ba7df23b976
pages: new method getURLByNames to retrieve URL from list of page names/path arguments
Goffi <goffi@goffi.org>
parents:
1030
diff
changeset
|
762 current_page = None |
|
4ba7df23b976
pages: new method getURLByNames to retrieve URL from list of page names/path arguments
Goffi <goffi@goffi.org>
parents:
1030
diff
changeset
|
763 path = [] |
|
4ba7df23b976
pages: new method getURLByNames to retrieve URL from list of page names/path arguments
Goffi <goffi@goffi.org>
parents:
1030
diff
changeset
|
764 for page_name, page_args in named_path: |
|
4ba7df23b976
pages: new method getURLByNames to retrieve URL from list of page names/path arguments
Goffi <goffi@goffi.org>
parents:
1030
diff
changeset
|
765 if current_page is None: |
|
4ba7df23b976
pages: new method getURLByNames to retrieve URL from list of page names/path arguments
Goffi <goffi@goffi.org>
parents:
1030
diff
changeset
|
766 current_page = self.getPageByName(page_name) |
|
4ba7df23b976
pages: new method getURLByNames to retrieve URL from list of page names/path arguments
Goffi <goffi@goffi.org>
parents:
1030
diff
changeset
|
767 path.append(current_page.getURL(*page_args)) |
|
4ba7df23b976
pages: new method getURLByNames to retrieve URL from list of page names/path arguments
Goffi <goffi@goffi.org>
parents:
1030
diff
changeset
|
768 else: |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
769 sub_path, current_page = self.getSubPageByName( |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
770 page_name, parent=current_page |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
771 ) |
|
1031
4ba7df23b976
pages: new method getURLByNames to retrieve URL from list of page names/path arguments
Goffi <goffi@goffi.org>
parents:
1030
diff
changeset
|
772 path.append(sub_path) |
|
4ba7df23b976
pages: new method getURLByNames to retrieve URL from list of page names/path arguments
Goffi <goffi@goffi.org>
parents:
1030
diff
changeset
|
773 if page_args: |
|
4ba7df23b976
pages: new method getURLByNames to retrieve URL from list of page names/path arguments
Goffi <goffi@goffi.org>
parents:
1030
diff
changeset
|
774 path.extend([quote(a) for a in page_args]) |
| 1216 | 775 return self.host.checkRedirection(self.vhost_root, "/".join(path)) |
|
980
bcacf970f970
core (pages redirection): inverted redirection + getSubPageURL:
Goffi <goffi@goffi.org>
parents:
979
diff
changeset
|
776 |
|
1092
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
777 def getURLByPath(self, *args): |
|
1171
469d0de8da0e
pages (blog, u): added atom feed link in "links" template data.
Goffi <goffi@goffi.org>
parents:
1169
diff
changeset
|
778 """Generate URL by path |
|
1092
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
779 |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
780 this method as a similar effect as getURLByNames, but it is more readable |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
781 by using SubPage to get pages instead of using tuples |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
782 @param *args: path element: |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
783 - if unicode, will be used as argument |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
784 - if util.SubPage instance, must be the name of a subpage |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
785 @return (unicode): generated path |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
786 """ |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
787 args = list(args) |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
788 if not args: |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
789 raise ValueError("You must specify path elements") |
|
1092
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
790 # root page is the one needed to construct the base of the URL |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
791 # if first arg is not a SubPage instance, we use current page |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
792 if not isinstance(args[0], SubPage): |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
793 root = self |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
794 else: |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
795 root = self.getPageByName(args.pop(0)) |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
796 # we keep track of current page to check subpage |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
797 current_page = root |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
798 url_elts = [] |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
799 arguments = [] |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
800 while True: |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
801 while args and not isinstance(args[0], SubPage): |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
802 arguments.append(quote(args.pop(0))) |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
803 if not url_elts: |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
804 url_elts.append(root.getURL(*arguments)) |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
805 else: |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
806 url_elts.extend(arguments) |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
807 if not args: |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
808 break |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
809 else: |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
810 path, current_page = current_page.getSubPageByName(args.pop(0)) |
|
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
811 arguments = [path] |
| 1216 | 812 return self.host.checkRedirection(self.vhost_root, "/".join(url_elts)) |
|
1092
63ed5f6bd4eb
pages: new "getURLByPath" method in LiberviaPage, which is similar to getURLByNames, but which a more readable way to request a path with named pages.
Goffi <goffi@goffi.org>
parents:
1071
diff
changeset
|
813 |
| 917 | 814 def getChildWithDefault(self, path, request): |
| 815 # we handle children ourselves | |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
816 raise exceptions.InternalError( |
| 1216 | 817 "this method should not be used with LiberviaPage" |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
818 ) |
| 917 | 819 |
| 820 def nextPath(self, request): | |
| 821 """get next URL path segment, and update request accordingly | |
| 822 | |
| 823 will move first segment of postpath in prepath | |
| 824 @param request(server.Request): current HTTP request | |
| 825 @return (unicode): unquoted segment | |
| 826 @raise IndexError: there is no segment left | |
| 827 """ | |
| 828 pathElement = request.postpath.pop(0) | |
| 829 request.prepath.append(pathElement) | |
| 1216 | 830 return urllib.parse.unquote(pathElement.decode('utf-8')) |
| 917 | 831 |
|
1060
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
832 def _filterPathValue(self, value, handler, name, request): |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
833 """Modify a path value according to handler (see [getPathArgs])""" |
| 1216 | 834 if handler in ("@", "@jid") and value == "@": |
|
1060
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
835 value = None |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
836 |
| 1216 | 837 if handler in ("", "@"): |
|
1060
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
838 if value is None: |
| 1216 | 839 return "" |
| 840 elif handler in ("jid", "@jid"): | |
|
1060
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
841 if value: |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
842 try: |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
843 return jid.JID(value) |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
844 except RuntimeError: |
| 1216 | 845 log.warning(_("invalid jid argument: {value}").format(value=value)) |
|
1060
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
846 self.pageError(request, C.HTTP_BAD_REQUEST) |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
847 else: |
| 1216 | 848 return "" |
|
1060
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
849 else: |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
850 return handler(self, value, name, request) |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
851 |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
852 return value |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
853 |
|
1056
47c354ca66a3
pages: new getPathArgs helper method to retrieve several path arguments at once
Goffi <goffi@goffi.org>
parents:
1054
diff
changeset
|
854 def getPathArgs(self, request, names, min_args=0, **kwargs): |
|
47c354ca66a3
pages: new getPathArgs helper method to retrieve several path arguments at once
Goffi <goffi@goffi.org>
parents:
1054
diff
changeset
|
855 """get several path arguments at once |
|
47c354ca66a3
pages: new getPathArgs helper method to retrieve several path arguments at once
Goffi <goffi@goffi.org>
parents:
1054
diff
changeset
|
856 |
|
47c354ca66a3
pages: new getPathArgs helper method to retrieve several path arguments at once
Goffi <goffi@goffi.org>
parents:
1054
diff
changeset
|
857 Arguments will be put in request data. |
|
47c354ca66a3
pages: new getPathArgs helper method to retrieve several path arguments at once
Goffi <goffi@goffi.org>
parents:
1054
diff
changeset
|
858 Missing arguments will have None value |
|
47c354ca66a3
pages: new getPathArgs helper method to retrieve several path arguments at once
Goffi <goffi@goffi.org>
parents:
1054
diff
changeset
|
859 @param names(list[unicode]): list of arguments to get |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
860 @param min_args(int): if less than min_args are found, PageError is used with |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
861 C.HTTP_BAD_REQUEST |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
862 Use 0 to ignore |
|
1056
47c354ca66a3
pages: new getPathArgs helper method to retrieve several path arguments at once
Goffi <goffi@goffi.org>
parents:
1054
diff
changeset
|
863 @param **kwargs: special value or optional callback to use for arguments |
|
47c354ca66a3
pages: new getPathArgs helper method to retrieve several path arguments at once
Goffi <goffi@goffi.org>
parents:
1054
diff
changeset
|
864 names of the arguments must correspond to those in names |
|
47c354ca66a3
pages: new getPathArgs helper method to retrieve several path arguments at once
Goffi <goffi@goffi.org>
parents:
1054
diff
changeset
|
865 special values may be: |
|
47c354ca66a3
pages: new getPathArgs helper method to retrieve several path arguments at once
Goffi <goffi@goffi.org>
parents:
1054
diff
changeset
|
866 - '': use empty string instead of None when no value is specified |
|
47c354ca66a3
pages: new getPathArgs helper method to retrieve several path arguments at once
Goffi <goffi@goffi.org>
parents:
1054
diff
changeset
|
867 - '@': if value of argument is empty or '@', empty string will be used |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
868 - 'jid': value must be converted to jid.JID if it exists, else empty |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
869 string is used |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
870 - '@jid': if value of arguments is empty or '@', empty string will be |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
871 used, else it will be converted to jid |
|
1056
47c354ca66a3
pages: new getPathArgs helper method to retrieve several path arguments at once
Goffi <goffi@goffi.org>
parents:
1054
diff
changeset
|
872 """ |
|
47c354ca66a3
pages: new getPathArgs helper method to retrieve several path arguments at once
Goffi <goffi@goffi.org>
parents:
1054
diff
changeset
|
873 data = self.getRData(request) |
|
47c354ca66a3
pages: new getPathArgs helper method to retrieve several path arguments at once
Goffi <goffi@goffi.org>
parents:
1054
diff
changeset
|
874 |
|
47c354ca66a3
pages: new getPathArgs helper method to retrieve several path arguments at once
Goffi <goffi@goffi.org>
parents:
1054
diff
changeset
|
875 for idx, name in enumerate(names): |
| 1216 | 876 if name[0] == "*": |
|
1060
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
877 value = data[name[1:]] = [] |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
878 while True: |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
879 try: |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
880 value.append(self.nextPath(request)) |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
881 except IndexError: |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
882 idx -= 1 |
|
1060
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
883 break |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
884 else: |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
885 idx += 1 |
|
1060
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
886 else: |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
887 try: |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
888 value = data[name] = self.nextPath(request) |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
889 except IndexError: |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
890 data[name] = None |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
891 idx -= 1 |
|
1060
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
892 break |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
893 |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
894 values_count = idx + 1 |
|
1071
8f77e36cd51d
pages: fixed args count in getPathArgs
Goffi <goffi@goffi.org>
parents:
1065
diff
changeset
|
895 if values_count < min_args: |
| 1216 | 896 log.warning(_("Missing arguments in URL (got {count}, expected at least " |
| 897 "{min_args})").format(count=values_count, min_args=min_args)) | |
|
1060
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
898 self.pageError(request, C.HTTP_BAD_REQUEST) |
|
1056
47c354ca66a3
pages: new getPathArgs helper method to retrieve several path arguments at once
Goffi <goffi@goffi.org>
parents:
1054
diff
changeset
|
899 |
|
1071
8f77e36cd51d
pages: fixed args count in getPathArgs
Goffi <goffi@goffi.org>
parents:
1065
diff
changeset
|
900 for name in names[values_count:]: |
|
1056
47c354ca66a3
pages: new getPathArgs helper method to retrieve several path arguments at once
Goffi <goffi@goffi.org>
parents:
1054
diff
changeset
|
901 data[name] = None |
|
47c354ca66a3
pages: new getPathArgs helper method to retrieve several path arguments at once
Goffi <goffi@goffi.org>
parents:
1054
diff
changeset
|
902 |
| 1216 | 903 for name, handler in kwargs.items(): |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
904 if name[0] == "*": |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
905 data[name] = [ |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
906 self._filterPathValue(v, handler, name, request) for v in data[name] |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
907 ] |
|
1060
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
908 else: |
|
f0f7b3324749
pages: '*' can now be used to prefix the last arg name in getPathArgs, in which case the data will be a list of remaining path arguments.
Goffi <goffi@goffi.org>
parents:
1059
diff
changeset
|
909 data[name] = self._filterPathValue(data[name], handler, name, request) |
|
1056
47c354ca66a3
pages: new getPathArgs helper method to retrieve several path arguments at once
Goffi <goffi@goffi.org>
parents:
1054
diff
changeset
|
910 |
|
1141
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
911 ## Pagination/Filtering ## |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
912 |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
913 def getPubsubExtra(self, request, page_max=10, params=None, extra=None, |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
914 order_by=C.ORDER_BY_CREATION): |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
915 """Set extra dict to retrieve PubSub items corresponding to URL parameters |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
916 |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
917 Following parameters are used: |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
918 - after: set rsm_after with ID of item |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
919 - before: set rsm_before with ID of item |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
920 @param request(server.Request): current HTTP request |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
921 @param page_max(int): required number of items per page |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
922 @param params(None, dict[unicode, list[unicode]]): params as returned by |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
923 self.getAllPostedData. |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
924 None to parse URL automatically |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
925 @param extra(None, dict): extra dict to use, or None to use a new one |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
926 @param order_by(unicode, None): key to order by |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
927 None to not specify order |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
928 @return (dict): fill extra data |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
929 """ |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
930 if params is None: |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
931 params = self.getAllPostedData(request, multiple=False) |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
932 if extra is None: |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
933 extra = {} |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
934 else: |
| 1216 | 935 assert not {"rsm_max", "rsm_after", "rsm_before", |
| 936 C.KEY_ORDER_BY}.intersection(list(extra.keys())) | |
| 937 extra["rsm_max"] = str(page_max) | |
|
1141
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
938 if order_by is not None: |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
939 extra[C.KEY_ORDER_BY] = order_by |
| 1216 | 940 if 'after' in params: |
| 941 extra['rsm_after'] = params['after'] | |
| 942 elif 'before' in params: | |
| 943 extra['rsm_before'] = params['before'] | |
|
1141
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
944 return extra |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
945 |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
946 def setPagination(self, request, pubsub_data): |
|
1256
08cd652dea14
server, pages, tasks (brython): common_scripts:
Goffi <goffi@goffi.org>
parents:
1255
diff
changeset
|
947 """Add to template_data if suitable |
|
1141
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
948 |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
949 "previous_page_url" and "next_page_url" will be added using respectively |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
950 "before" and "after" URL parameters |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
951 @param request(server.Request): current HTTP request |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
952 @param pubsub_data(dict): pubsub metadata parsed with |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
953 data_objects.parsePubSubMetadata |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
954 """ |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
955 template_data = request.template_data |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
956 try: |
| 1216 | 957 last_id = pubsub_data["rsm_last"] |
|
1141
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
958 except KeyError: |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
959 # no pagination available |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
960 return |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
961 |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
962 if pubsub_data.get("rsm_index", 1) > 0: |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
963 # We only show previous button if it's not the first page already. |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
964 # If we have no index, we default to display the button anyway |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
965 # as we can't know if we are on the first page or not. |
| 1216 | 966 first_id = pubsub_data["rsm_first"] |
|
1141
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
967 template_data['previous_page_url'] = self.getParamURL(request, |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
968 before=first_id) |
| 1216 | 969 if not pubsub_data["complete"]: |
|
1141
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
970 # we also show the page next button if complete is None because we |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
971 # can't know where we are in the feed in this case. |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
972 template_data['next_page_url'] = self.getParamURL(request, after=last_id) |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
973 |
|
02fc28aac2b6
pages: move pagination core from blog to LiberviaPage so it can be reused:
Goffi <goffi@goffi.org>
parents:
1128
diff
changeset
|
974 |
|
1019
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
975 ## Cache handling ## |
|
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
976 |
|
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
977 def _setCacheHeaders(self, request, cache): |
|
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
978 """Set ETag and Last-Modified HTTP headers, used for caching""" |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
979 request.setHeader("ETag", cache.hash) |
|
1019
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
980 last_modified = self.host.getHTTPDate(cache.created) |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
981 request.setHeader("Last-Modified", last_modified) |
|
1019
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
982 |
|
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
983 def _checkCacheHeaders(self, request, cache): |
|
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
984 """Check if a cache condition is set on the request |
|
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
985 |
|
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
986 if condition is valid, C.HTTP_NOT_MODIFIED is returned |
|
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
987 """ |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
988 etag_match = request.getHeader("If-None-Match") |
|
1019
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
989 if etag_match is not None: |
|
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
990 if cache.hash == etag_match: |
|
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
991 self.pageError(request, C.HTTP_NOT_MODIFIED, no_body=True) |
|
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
992 else: |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
993 modified_match = request.getHeader("If-Modified-Since") |
|
1019
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
994 if modified_match is not None: |
|
1109
3a7b2b239d3e
pages: change module for date_parse, following backend change
Goffi <goffi@goffi.org>
parents:
1092
diff
changeset
|
995 modified = date_utils.date_parse(modified_match) |
|
1019
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
996 if modified >= int(cache.created): |
|
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
997 self.pageError(request, C.HTTP_NOT_MODIFIED, no_body=True) |
|
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
998 |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
999 def checkCacheSubscribeCb(self, sub_id, service, node): |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1000 self.cache_pubsub_sub.add((service, node, sub_id)) |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1001 |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1002 def checkCacheSubscribeEb(self, failure_, service, node): |
| 1216 | 1003 log.warning(_("Can't subscribe to node: {msg}").format(msg=failure_)) |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1004 # FIXME: cache must be marked as unusable here |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1005 |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1006 def psNodeWatchAddEb(self, failure_, service, node): |
| 1216 | 1007 log.warning(_("Can't add node watched: {msg}").format(msg=failure_)) |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1008 |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1009 def checkCache(self, request, cache_type, **kwargs): |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1010 """check if a page is in cache and return cached version if suitable |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1011 |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1012 this method may perform extra operation to handle cache (e.g. subscribing to a |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1013 pubsub node) |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1014 @param request(server.Request): current HTTP request |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1015 @param cache_type(int): on of C.CACHE_* const. |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1016 @param **kwargs: args according to cache_type: |
|
1010
4de970de87d7
pages: added getCurrentURL and getParamURL:
Goffi <goffi@goffi.org>
parents:
1009
diff
changeset
|
1017 C.CACHE_PUBSUB: |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1018 service: pubsub service |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1019 node: pubsub node |
|
1019
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
1020 short: short name of feature (needed if node is empty to find namespace) |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1021 |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1022 """ |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1023 if request.postpath: |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1024 # we are not on the final page, no need to go further |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1025 return |
|
1033
c34f08e05cdf
pages: cache is now working even after pageRedirect
Goffi <goffi@goffi.org>
parents:
1032
diff
changeset
|
1026 |
|
1267
b5f920845d34
pages: delete existing cache instead of just ignoring it when `no-cache` is used
Goffi <goffi@goffi.org>
parents:
1266
diff
changeset
|
1027 no_cache = request.getHeader('cache-control') == 'no-cache' |
|
1255
b1fb57e9176d
pages: don't use cache when `cache-control` header is set to `no-cache`
Goffi <goffi@goffi.org>
parents:
1253
diff
changeset
|
1028 |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1029 profile = self.getProfile(request) or C.SERVICE_PROFILE |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1030 |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1031 if cache_type == C.CACHE_PUBSUB: |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1032 service, node = kwargs["service"], kwargs["node"] |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1033 if not node: |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1034 try: |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1035 short = kwargs["short"] |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1036 node = self.host.ns_map[short] |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1037 except KeyError: |
| 1216 | 1038 log.warning(_('Can\'t use cache for empty node without namespace ' |
| 1039 'set, please ensure to set "short" and that it is ' | |
| 1040 'registered')) | |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1041 return |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1042 if profile != C.SERVICE_PROFILE: |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1043 # only service profile is cache for now |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1044 return |
|
1167
7d2e098ea3f4
pages (cache): separate cached pages using locales, to avoid having a page cache in a specific locale used for an other one.
Goffi <goffi@goffi.org>
parents:
1165
diff
changeset
|
1045 session_data = self.host.getSessionData(request, session_iface.ISATSession) |
|
7d2e098ea3f4
pages (cache): separate cached pages using locales, to avoid having a page cache in a specific locale used for an other one.
Goffi <goffi@goffi.org>
parents:
1165
diff
changeset
|
1046 locale = session_data.locale |
|
7d2e098ea3f4
pages (cache): separate cached pages using locales, to avoid having a page cache in a specific locale used for an other one.
Goffi <goffi@goffi.org>
parents:
1165
diff
changeset
|
1047 if locale == C.DEFAULT_LOCALE: |
|
7d2e098ea3f4
pages (cache): separate cached pages using locales, to avoid having a page cache in a specific locale used for an other one.
Goffi <goffi@goffi.org>
parents:
1165
diff
changeset
|
1048 # no need to duplicate cache here |
|
7d2e098ea3f4
pages (cache): separate cached pages using locales, to avoid having a page cache in a specific locale used for an other one.
Goffi <goffi@goffi.org>
parents:
1165
diff
changeset
|
1049 locale = None |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1050 try: |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1051 cache = (self.cache[profile][cache_type][service][node] |
|
1167
7d2e098ea3f4
pages (cache): separate cached pages using locales, to avoid having a page cache in a specific locale used for an other one.
Goffi <goffi@goffi.org>
parents:
1165
diff
changeset
|
1052 [self.vhost_root][request.uri][locale][self]) |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1053 except KeyError: |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1054 # no cache yet, let's subscribe to the pubsub node |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1055 d1 = self.host.bridgeCall( |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1056 "psSubscribe", service.full(), node, {}, profile |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1057 ) |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1058 d1.addCallback(self.checkCacheSubscribeCb, service, node) |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1059 d1.addErrback(self.checkCacheSubscribeEb, service, node) |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1060 d2 = self.host.bridgeCall("psNodeWatchAdd", service.full(), node, profile) |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1061 d2.addErrback(self.psNodeWatchAddEb, service, node) |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1062 self._do_cache = [self, profile, cache_type, service, node, |
|
1167
7d2e098ea3f4
pages (cache): separate cached pages using locales, to avoid having a page cache in a specific locale used for an other one.
Goffi <goffi@goffi.org>
parents:
1165
diff
changeset
|
1063 self.vhost_root, request.uri, locale] |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1064 # we don't return the Deferreds as it is not needed to wait for |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1065 # the subscription to continue with page rendering |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1066 return |
|
1267
b5f920845d34
pages: delete existing cache instead of just ignoring it when `no-cache` is used
Goffi <goffi@goffi.org>
parents:
1266
diff
changeset
|
1067 else: |
|
b5f920845d34
pages: delete existing cache instead of just ignoring it when `no-cache` is used
Goffi <goffi@goffi.org>
parents:
1266
diff
changeset
|
1068 if no_cache: |
|
b5f920845d34
pages: delete existing cache instead of just ignoring it when `no-cache` is used
Goffi <goffi@goffi.org>
parents:
1266
diff
changeset
|
1069 del (self.cache[profile][cache_type][service][node] |
|
b5f920845d34
pages: delete existing cache instead of just ignoring it when `no-cache` is used
Goffi <goffi@goffi.org>
parents:
1266
diff
changeset
|
1070 [self.vhost_root][request.uri][locale][self]) |
|
b5f920845d34
pages: delete existing cache instead of just ignoring it when `no-cache` is used
Goffi <goffi@goffi.org>
parents:
1266
diff
changeset
|
1071 log.debug(f"cache removed for {self}") |
|
b5f920845d34
pages: delete existing cache instead of just ignoring it when `no-cache` is used
Goffi <goffi@goffi.org>
parents:
1266
diff
changeset
|
1072 return |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1073 |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1074 else: |
| 1216 | 1075 raise exceptions.InternalError("Unknown cache_type") |
| 1076 log.debug("using cache for {page}".format(page=self)) | |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1077 cache.last_access = time.time() |
|
1019
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
1078 self._setCacheHeaders(request, cache) |
|
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
1079 self._checkCacheHeaders(request, cache) |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1080 request.write(cache.rendered) |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1081 request.finish() |
| 1216 | 1082 raise failure.Failure(exceptions.CancelError("cache is used")) |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1083 |
|
1276
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1084 def _cacheURL(self, request, profile): |
| 1018 | 1085 self.cached_urls.setdefault(profile, {})[request.uri] = CacheURL(request) |
| 1086 | |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1087 @classmethod |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1088 def onNodeEvent(cls, host, service, node, event_type, items, profile): |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1089 """Invalidate cache for all pages linked to this node""" |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1090 try: |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1091 cache = cls.cache[profile][C.CACHE_PUBSUB][jid.JID(service)][node] |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1092 except KeyError: |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1093 log.info(_( |
| 1216 | 1094 "Removing subscription for {service}/{node}: " |
| 1095 "the page is not cached").format(service=service, node=node)) | |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1096 d1 = host.bridgeCall("psUnsubscribe", service, node, profile) |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1097 d1.addErrback( |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1098 lambda failure_: log.warning( |
| 1216 | 1099 _("Can't unsubscribe from {service}/{node}: {msg}").format( |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1100 service=service, node=node, msg=failure_))) |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1101 d2 = host.bridgeCall("psNodeWatchAdd", service, node, profile) |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1102 # TODO: check why the page is not in cache, remove subscription? |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1103 d2.addErrback( |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1104 lambda failure_: log.warning( |
| 1216 | 1105 _("Can't remove watch for {service}/{node}: {msg}").format( |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1106 service=service, node=node, msg=failure_))) |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1107 else: |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1108 cache.clear() |
|
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1109 |
| 995 | 1110 @classmethod |
| 1111 def onSignal(cls, host, signal, *args): | |
| 1112 """Generic method which receive registered signals | |
| 1113 | |
| 1114 if a callback is registered for this signal, call it | |
| 1115 @param host: Libervia instance | |
| 1116 @param signal(unicode): name of the signal | |
| 1117 @param *args: args of the signals | |
| 1118 """ | |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1119 for page, request, check_profile in cls.signals_handlers.get( |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1120 signal, {} |
| 1216 | 1121 ).values(): |
| 995 | 1122 if check_profile: |
| 1123 signal_profile = args[-1] | |
| 1124 request_profile = page.getProfile(request) | |
| 1125 if not request_profile: | |
| 1126 # if you want to use signal without session, unset check_profile | |
| 1127 # (be sure to know what you are doing) | |
| 1216 | 1128 log.error(_("no session started, signal can't be checked")) |
| 995 | 1129 continue |
| 1130 if signal_profile != request_profile: | |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1131 # we ignore the signal, it's not for our profile |
| 995 | 1132 continue |
| 1133 if request._signals_cache is not None: | |
| 1134 # socket is not yet opened, we cache the signal | |
| 1135 request._signals_cache.append((request, signal, args)) | |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1136 log.debug( |
| 1216 | 1137 "signal [{signal}] cached: {args}".format(signal=signal, args=args) |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1138 ) |
| 995 | 1139 else: |
| 1140 page.on_signal(page, request, signal, *args) | |
| 1141 | |
| 1142 def onSocketOpen(self, request): | |
| 1143 """Called for dynamic pages when socket has just been opened | |
| 1144 | |
| 1145 we send all cached signals | |
| 1146 """ | |
| 1147 assert request._signals_cache is not None | |
|
1203
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
1148 # we need to replace corresponding original requests by this websocket request |
|
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
1149 # in signals_handlers |
|
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
1150 signal_id = request.signal_id |
| 1216 | 1151 for signal_handlers_map in self.__class__.signals_handlers.values(): |
|
1203
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
1152 if signal_id in signal_handlers_map: |
|
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
1153 signal_handlers_map[signal_id][1] = request |
|
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
1154 |
| 995 | 1155 cache = request._signals_cache |
| 1156 request._signals_cache = None | |
| 1157 for request, signal, args in cache: | |
| 1158 self.on_signal(self, request, signal, *args) | |
| 1159 | |
| 1160 def onSocketClose(self, request): | |
| 1161 """Called for dynamic pages when socket has just been closed | |
| 1162 | |
| 1163 we remove signal handler | |
| 1164 """ | |
| 1165 for signal in request._signals_registered: | |
|
1203
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
1166 signal_id = self.getSignalId(request) |
| 995 | 1167 try: |
|
1203
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
1168 del LiberviaPage.signals_handlers[signal][signal_id] |
| 995 | 1169 except KeyError: |
| 1216 | 1170 log.error(_("Can't find signal handler for [{signal}], this should not " |
| 1171 "happen").format(signal=signal)) | |
| 995 | 1172 else: |
| 1216 | 1173 log.debug(_("Removed signal handler")) |
| 995 | 1174 |
|
1062
c80649cdadd5
pages: new delegateToResource method to continue workflow with a Twisted Resource
Goffi <goffi@goffi.org>
parents:
1061
diff
changeset
|
1175 def delegateToResource(self, request, resource): |
|
c80649cdadd5
pages: new delegateToResource method to continue workflow with a Twisted Resource
Goffi <goffi@goffi.org>
parents:
1061
diff
changeset
|
1176 """continue workflow with Twisted Resource""" |
|
c80649cdadd5
pages: new delegateToResource method to continue workflow with a Twisted Resource
Goffi <goffi@goffi.org>
parents:
1061
diff
changeset
|
1177 buf = resource.render(request) |
|
c80649cdadd5
pages: new delegateToResource method to continue workflow with a Twisted Resource
Goffi <goffi@goffi.org>
parents:
1061
diff
changeset
|
1178 if buf == server.NOT_DONE_YET: |
|
c80649cdadd5
pages: new delegateToResource method to continue workflow with a Twisted Resource
Goffi <goffi@goffi.org>
parents:
1061
diff
changeset
|
1179 pass |
|
c80649cdadd5
pages: new delegateToResource method to continue workflow with a Twisted Resource
Goffi <goffi@goffi.org>
parents:
1061
diff
changeset
|
1180 else: |
|
c80649cdadd5
pages: new delegateToResource method to continue workflow with a Twisted Resource
Goffi <goffi@goffi.org>
parents:
1061
diff
changeset
|
1181 request.write(buf) |
|
c80649cdadd5
pages: new delegateToResource method to continue workflow with a Twisted Resource
Goffi <goffi@goffi.org>
parents:
1061
diff
changeset
|
1182 request.finish() |
| 1216 | 1183 raise failure.Failure(exceptions.CancelError("resource delegation")) |
|
1062
c80649cdadd5
pages: new delegateToResource method to continue workflow with a Twisted Resource
Goffi <goffi@goffi.org>
parents:
1061
diff
changeset
|
1184 |
| 962 | 1185 def HTTPRedirect(self, request, url): |
| 1186 """redirect to an URL using HTTP redirection | |
| 1187 | |
| 1188 @param request(server.Request): current HTTP request | |
| 1189 @param url(unicode): url to redirect to | |
| 1190 """ | |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1191 web_util.redirectTo(url.encode("utf-8"), request) |
| 962 | 1192 request.finish() |
| 1216 | 1193 raise failure.Failure(exceptions.CancelError("HTTP redirection is used")) |
| 962 | 1194 |
| 1216 | 1195 def redirectOrContinue(self, request, redirect_arg="redirect_url"): |
| 962 | 1196 """helper method to redirect a page to an url given as arg |
| 1197 | |
| 1198 if the arg is not present, the page will continue normal workflow | |
| 1199 @param request(server.Request): current HTTP request | |
| 1200 @param redirect_arg(unicode): argument to use to get redirection URL | |
| 1201 @interrupt: redirect the page to requested URL | |
| 1202 @interrupt pageError(C.HTTP_BAD_REQUEST): empty or non local URL is used | |
| 1203 """ | |
| 1216 | 1204 redirect_arg = redirect_arg.encode('utf-8') |
| 962 | 1205 try: |
| 1216 | 1206 url = request.args[redirect_arg][0].decode('utf-8') |
|
1061
bacb8f229742
pages: fixed unicode escaping when using a redirecting URL
Goffi <goffi@goffi.org>
parents:
1060
diff
changeset
|
1207 except (KeyError, IndexError): |
| 962 | 1208 pass |
| 1209 else: | |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1210 # a redirection is requested |
| 1216 | 1211 if not url or url[0] != "/": |
| 962 | 1212 # we only want local urls |
| 1213 self.pageError(request, C.HTTP_BAD_REQUEST) | |
| 1214 else: | |
| 1215 self.HTTPRedirect(request, url) | |
| 1216 | |
|
1032
863cc6f97068
pages: path arguments can now be specified in pageRedirect
Goffi <goffi@goffi.org>
parents:
1031
diff
changeset
|
1217 def pageRedirect(self, page_path, request, skip_parse_url=True, path_args=None): |
|
923
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1218 """redirect a page to a named page |
|
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1219 |
|
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1220 the workflow will continue with the workflow of the named page, |
|
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1221 skipping named page's parse_url method if it exist. |
| 962 | 1222 If you want to do a HTTP redirection, use HTTPRedirect |
|
923
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1223 @param page_path(unicode): path to page (elements are separated by "/"): |
|
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1224 if path starts with a "/": |
|
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1225 path is a full path starting from root |
|
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1226 else: |
|
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1227 - first element is name as registered in name variable |
|
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1228 - following element are subpages path |
|
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1229 e.g.: "blog" redirect to page named "blog" |
|
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1230 "blog/atom.xml" redirect to atom.xml subpage of "blog" |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1231 "/common/blog/atom.xml" redirect to the page at the given full path |
|
923
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1232 @param request(server.Request): current HTTP request |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1233 @param skip_parse_url(bool): if True, parse_url method on redirect page will be |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1234 skipped |
|
1032
863cc6f97068
pages: path arguments can now be specified in pageRedirect
Goffi <goffi@goffi.org>
parents:
1031
diff
changeset
|
1235 @param path_args(list[unicode], None): path arguments to use in redirected page |
|
923
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1236 @raise KeyError: there is no known page with this name |
|
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1237 """ |
|
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1238 # FIXME: render non LiberviaPage resources |
| 1216 | 1239 path = page_path.rstrip("/").split("/") |
|
923
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1240 if not path[0]: |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1241 redirect_page = self.vhost_root |
|
923
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1242 else: |
|
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1243 redirect_page = self.named_pages[path[0]] |
|
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1244 |
|
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1245 for subpage in path[1:]: |
| 1216 | 1246 subpage = subpage.encode('utf-8') |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1247 if redirect_page is self.vhost_root: |
| 962 | 1248 redirect_page = redirect_page.children[subpage] |
| 1249 else: | |
| 1250 redirect_page = redirect_page.original.children[subpage] | |
|
923
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1251 |
|
1032
863cc6f97068
pages: path arguments can now be specified in pageRedirect
Goffi <goffi@goffi.org>
parents:
1031
diff
changeset
|
1252 if path_args is not None: |
|
1224
62bf4f87c249
server: some encoding fixes following python 3 port
Goffi <goffi@goffi.org>
parents:
1216
diff
changeset
|
1253 args = [quote(a).encode() for a in path_args] |
|
1032
863cc6f97068
pages: path arguments can now be specified in pageRedirect
Goffi <goffi@goffi.org>
parents:
1031
diff
changeset
|
1254 request.postpath = args + request.postpath |
|
863cc6f97068
pages: path arguments can now be specified in pageRedirect
Goffi <goffi@goffi.org>
parents:
1031
diff
changeset
|
1255 |
|
1033
c34f08e05cdf
pages: cache is now working even after pageRedirect
Goffi <goffi@goffi.org>
parents:
1032
diff
changeset
|
1256 if self._do_cache: |
|
c34f08e05cdf
pages: cache is now working even after pageRedirect
Goffi <goffi@goffi.org>
parents:
1032
diff
changeset
|
1257 # if cache is needed, it will be handled by final page |
|
c34f08e05cdf
pages: cache is now working even after pageRedirect
Goffi <goffi@goffi.org>
parents:
1032
diff
changeset
|
1258 redirect_page._do_cache = self._do_cache |
|
c34f08e05cdf
pages: cache is now working even after pageRedirect
Goffi <goffi@goffi.org>
parents:
1032
diff
changeset
|
1259 self._do_cache = None |
|
c34f08e05cdf
pages: cache is now working even after pageRedirect
Goffi <goffi@goffi.org>
parents:
1032
diff
changeset
|
1260 |
|
1276
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1261 defer.ensureDeferred( |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1262 redirect_page.renderPage(request, skip_parse_url=skip_parse_url) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1263 ) |
| 1216 | 1264 raise failure.Failure(exceptions.CancelError("page redirection is used")) |
|
923
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1265 |
|
1019
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
1266 def pageError(self, request, code=C.HTTP_NOT_FOUND, no_body=False): |
| 917 | 1267 """generate an error page and terminate the request |
| 1268 | |
| 1269 @param request(server.Request): HTTP request | |
| 1270 @param core(int): error code to use | |
|
1019
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
1271 @param no_body: don't write body if True |
| 917 | 1272 """ |
|
1198
1211dbc3cca7
pages: don't put error pages in cache
Goffi <goffi@goffi.org>
parents:
1193
diff
changeset
|
1273 if self._do_cache is not None: |
|
1211dbc3cca7
pages: don't put error pages in cache
Goffi <goffi@goffi.org>
parents:
1193
diff
changeset
|
1274 # we don't want to cache error pages |
|
1211dbc3cca7
pages: don't put error pages in cache
Goffi <goffi@goffi.org>
parents:
1193
diff
changeset
|
1275 self._do_cache = None |
| 917 | 1276 request.setResponseCode(code) |
|
1019
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
1277 if no_body: |
|
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
1278 request.finish() |
|
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
1279 else: |
| 1216 | 1280 template = "error/" + str(code) + ".html" |
| 1165 | 1281 template_data = request.template_data |
| 1282 session_data = self.host.getSessionData(request, session_iface.ISATSession) | |
| 1283 if session_data.locale is not None: | |
| 1216 | 1284 template_data['locale'] = session_data.locale |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1285 if self.vhost_root.site_name: |
| 1216 | 1286 template_data['site'] = self.vhost_root.site_name |
| 917 | 1287 |
|
1019
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
1288 rendered = self.host.renderer.render( |
|
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
1289 template, |
|
1275
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
1290 theme=session_data.theme or self.default_theme, |
|
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
1291 site_themes=self.site_themes, |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1292 error_code=code, |
| 1165 | 1293 **template_data |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1294 ) |
| 917 | 1295 |
|
1019
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
1296 self.writeData(rendered, request) |
| 1216 | 1297 raise failure.Failure(exceptions.CancelError("error page is used")) |
| 917 | 1298 |
| 1299 def writeData(self, data, request): | |
|
937
00236973e138
server (pages): an HTTP internal error is raised if an error is uncatched during page workflow
Goffi <goffi@goffi.org>
parents:
936
diff
changeset
|
1300 """write data to transport and finish the request""" |
| 917 | 1301 if data is None: |
| 1302 self.pageError(request) | |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1303 data_encoded = data.encode("utf-8") |
|
1019
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
1304 |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1305 if self._do_cache is not None: |
|
1033
c34f08e05cdf
pages: cache is now working even after pageRedirect
Goffi <goffi@goffi.org>
parents:
1032
diff
changeset
|
1306 redirected_page = self._do_cache.pop(0) |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1307 cache = reduce(lambda d, k: d.setdefault(k, {}), self._do_cache, self.cache) |
|
1033
c34f08e05cdf
pages: cache is now working even after pageRedirect
Goffi <goffi@goffi.org>
parents:
1032
diff
changeset
|
1308 page_cache = cache[redirected_page] = CachePage(data_encoded) |
|
1019
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
1309 self._setCacheHeaders(request, page_cache) |
| 1216 | 1310 log.debug(_("{page} put in cache for [{profile}]") |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1311 .format( page=self, profile=self._do_cache[0])) |
|
985
64826e69f365
pages: cache mechanism, first draft:
Goffi <goffi@goffi.org>
parents:
984
diff
changeset
|
1312 self._do_cache = None |
|
1019
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
1313 self._checkCacheHeaders(request, page_cache) |
|
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
1314 |
|
1208
584e29d9510a
pages: display a warning instead or raising exception if write fails:
Goffi <goffi@goffi.org>
parents:
1205
diff
changeset
|
1315 try: |
|
584e29d9510a
pages: display a warning instead or raising exception if write fails:
Goffi <goffi@goffi.org>
parents:
1205
diff
changeset
|
1316 request.write(data_encoded) |
|
584e29d9510a
pages: display a warning instead or raising exception if write fails:
Goffi <goffi@goffi.org>
parents:
1205
diff
changeset
|
1317 except AttributeError: |
| 1216 | 1318 log.warning(_("Can't write page, the request has probably been cancelled " |
| 1319 "(browser tab closed or reloaded)")) | |
|
1208
584e29d9510a
pages: display a warning instead or raising exception if write fails:
Goffi <goffi@goffi.org>
parents:
1205
diff
changeset
|
1320 return |
|
1019
34240d08f682
pages: HTTP cache headers handling:
Goffi <goffi@goffi.org>
parents:
1018
diff
changeset
|
1321 request.finish() |
| 917 | 1322 |
|
1276
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1323 def _subpagesHandler(self, request): |
| 917 | 1324 """render subpage if suitable |
| 1325 | |
| 1326 this method checks if there is still an unmanaged part of the path | |
| 1327 and check if it corresponds to a subpage. If so, it render the subpage | |
| 1328 else it render a NoResource. | |
| 1329 If there is no unmanaged part of the segment, current page workflow is pursued | |
| 1330 """ | |
| 1331 if request.postpath: | |
| 1216 | 1332 subpage = self.nextPath(request).encode('utf-8') |
| 917 | 1333 try: |
| 1334 child = self.children[subpage] | |
| 1335 except KeyError: | |
| 1336 self.pageError(request) | |
| 1337 else: | |
| 1338 child.render(request) | |
| 1216 | 1339 raise failure.Failure(exceptions.CancelError("subpage page is used")) |
| 917 | 1340 |
|
1276
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1341 def _prepare_dynamic(self, request): |
|
998
0848b8b0188d
pages: dynamic set up is now done just before prepare_render call:
Goffi <goffi@goffi.org>
parents:
995
diff
changeset
|
1342 # we need to activate dynamic page |
|
0848b8b0188d
pages: dynamic set up is now done just before prepare_render call:
Goffi <goffi@goffi.org>
parents:
995
diff
changeset
|
1343 # we set data for template, and create/register token |
| 1216 | 1344 socket_token = str(uuid.uuid4()) |
|
998
0848b8b0188d
pages: dynamic set up is now done just before prepare_render call:
Goffi <goffi@goffi.org>
parents:
995
diff
changeset
|
1345 socket_url = self.host.getWebsocketURL(request) |
|
0848b8b0188d
pages: dynamic set up is now done just before prepare_render call:
Goffi <goffi@goffi.org>
parents:
995
diff
changeset
|
1346 socket_debug = C.boolConst(self.host.debug) |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1347 request.template_data["websocket"] = WebsocketMeta( |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1348 socket_url, socket_token, socket_debug |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1349 ) |
|
998
0848b8b0188d
pages: dynamic set up is now done just before prepare_render call:
Goffi <goffi@goffi.org>
parents:
995
diff
changeset
|
1350 # we will keep track of handlers to remove |
|
0848b8b0188d
pages: dynamic set up is now done just before prepare_render call:
Goffi <goffi@goffi.org>
parents:
995
diff
changeset
|
1351 request._signals_registered = [] |
|
0848b8b0188d
pages: dynamic set up is now done just before prepare_render call:
Goffi <goffi@goffi.org>
parents:
995
diff
changeset
|
1352 # we will cache registered signals until socket is opened |
|
0848b8b0188d
pages: dynamic set up is now done just before prepare_render call:
Goffi <goffi@goffi.org>
parents:
995
diff
changeset
|
1353 request._signals_cache = [] |
|
1203
251eba911d4d
server (websockets): fixed websocket handling on HTTPS connections:
Goffi <goffi@goffi.org>
parents:
1198
diff
changeset
|
1354 self.host.registerWSToken(socket_token, self, request) |
|
998
0848b8b0188d
pages: dynamic set up is now done just before prepare_render call:
Goffi <goffi@goffi.org>
parents:
995
diff
changeset
|
1355 |
|
1276
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1356 def _render_template(self, request): |
| 962 | 1357 template_data = request.template_data |
| 1358 | |
| 1359 # if confirm variable is set in case of successfuly data post | |
| 1360 session_data = self.host.getSessionData(request, session_iface.ISATSession) | |
|
1266
6b7f9c3558cc
server, pages: better identities handling:
Goffi <goffi@goffi.org>
parents:
1258
diff
changeset
|
1361 template_data['identities'] = session_data.identities |
| 962 | 1362 if session_data.popPageFlag(self, C.FLAG_CONFIRM): |
| 1216 | 1363 template_data["confirm"] = True |
|
1186
352865f4a268
server: added a generic way to have notification messages in pages
Goffi <goffi@goffi.org>
parents:
1185
diff
changeset
|
1364 notifs = session_data.popPageNotifications(self) |
|
352865f4a268
server: added a generic way to have notification messages in pages
Goffi <goffi@goffi.org>
parents:
1185
diff
changeset
|
1365 if notifs: |
| 1216 | 1366 template_data["notifications"] = notifs |
|
1266
6b7f9c3558cc
server, pages: better identities handling:
Goffi <goffi@goffi.org>
parents:
1258
diff
changeset
|
1367 if session_data.jid is not None: |
|
6b7f9c3558cc
server, pages: better identities handling:
Goffi <goffi@goffi.org>
parents:
1258
diff
changeset
|
1368 template_data["own_jid"] = session_data.jid |
| 1165 | 1369 if session_data.locale is not None: |
| 1216 | 1370 template_data['locale'] = session_data.locale |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1371 if self.vhost_root.site_name: |
| 1216 | 1372 template_data['site'] = self.vhost_root.site_name |
| 1246 | 1373 if self.dyn_data: |
| 1374 for data in self.dyn_data.values(): | |
| 1375 try: | |
|
1256
08cd652dea14
server, pages, tasks (brython): common_scripts:
Goffi <goffi@goffi.org>
parents:
1255
diff
changeset
|
1376 scripts = data['scripts'] |
| 1246 | 1377 except KeyError: |
| 1378 pass | |
| 1379 else: | |
|
1282
0e4e413eb8db
server: user new OrderedSet to handle scripts:
Goffi <goffi@goffi.org>
parents:
1277
diff
changeset
|
1380 template_data.setdefault('scripts', utils.OrderedSet()).update(scripts) |
|
1256
08cd652dea14
server, pages, tasks (brython): common_scripts:
Goffi <goffi@goffi.org>
parents:
1255
diff
changeset
|
1381 template_data.update(data.get('template', {})) |
|
1268
e628724530ec
pages, tasks (brython): use set for scripts + common template data:
Goffi <goffi@goffi.org>
parents:
1267
diff
changeset
|
1382 data_common = self.vhost_root.dyn_data_common |
|
e628724530ec
pages, tasks (brython): use set for scripts + common template data:
Goffi <goffi@goffi.org>
parents:
1267
diff
changeset
|
1383 common_scripts = data_common['scripts'] |
|
1256
08cd652dea14
server, pages, tasks (brython): common_scripts:
Goffi <goffi@goffi.org>
parents:
1255
diff
changeset
|
1384 if common_scripts: |
|
1282
0e4e413eb8db
server: user new OrderedSet to handle scripts:
Goffi <goffi@goffi.org>
parents:
1277
diff
changeset
|
1385 template_data.setdefault('scripts', utils.OrderedSet()).update(common_scripts) |
|
1268
e628724530ec
pages, tasks (brython): use set for scripts + common template data:
Goffi <goffi@goffi.org>
parents:
1267
diff
changeset
|
1386 if "template" in data_common: |
|
e628724530ec
pages, tasks (brython): use set for scripts + common template data:
Goffi <goffi@goffi.org>
parents:
1267
diff
changeset
|
1387 for key, value in data_common["template"].items(): |
|
e628724530ec
pages, tasks (brython): use set for scripts + common template data:
Goffi <goffi@goffi.org>
parents:
1267
diff
changeset
|
1388 if key not in template_data: |
|
e628724530ec
pages, tasks (brython): use set for scripts + common template data:
Goffi <goffi@goffi.org>
parents:
1267
diff
changeset
|
1389 template_data[key] = value |
| 962 | 1390 |
| 917 | 1391 return self.host.renderer.render( |
| 1392 self.template, | |
|
1275
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
1393 theme=session_data.theme or self.default_theme, |
|
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
1394 site_themes=self.site_themes, |
|
1148
3c7a64adfd42
pages: use absolute path for build_path + added page_url to template (which is getURL() without argument)
Goffi <goffi@goffi.org>
parents:
1147
diff
changeset
|
1395 page_url=self.getURL(), |
|
1256
08cd652dea14
server, pages, tasks (brython): common_scripts:
Goffi <goffi@goffi.org>
parents:
1255
diff
changeset
|
1396 media_path=f"/{C.MEDIA_DIR}", |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1397 cache_path=session_data.cache_dir, |
|
1256
08cd652dea14
server, pages, tasks (brython): common_scripts:
Goffi <goffi@goffi.org>
parents:
1255
diff
changeset
|
1398 build_path=f"/{C.BUILD_DIR}/", |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1399 main_menu=self.main_menu, |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1400 **template_data) |
| 917 | 1401 |
|
956
dabecab10faa
server (pages): impleted CSRF protection:
Goffi <goffi@goffi.org>
parents:
955
diff
changeset
|
1402 def _on_data_post_redirect(self, ret, request): |
|
968
4d37b23777c3
pages (core, tickets/new): replaced post_redirect_uri mechanism by post_redirect_page:
Goffi <goffi@goffi.org>
parents:
966
diff
changeset
|
1403 """called when page's on_data_post has been done successfuly |
|
956
dabecab10faa
server (pages): impleted CSRF protection:
Goffi <goffi@goffi.org>
parents:
955
diff
changeset
|
1404 |
|
968
4d37b23777c3
pages (core, tickets/new): replaced post_redirect_uri mechanism by post_redirect_page:
Goffi <goffi@goffi.org>
parents:
966
diff
changeset
|
1405 This will do a Post/Redirect/Get pattern. |
|
4d37b23777c3
pages (core, tickets/new): replaced post_redirect_uri mechanism by post_redirect_page:
Goffi <goffi@goffi.org>
parents:
966
diff
changeset
|
1406 this method redirect to the same page or to request.data['post_redirect_page'] |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1407 post_redirect_page can be either a page or a tuple with page as first item, then |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1408 a list of unicode arguments to append to the url. |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1409 if post_redirect_page is not used, initial request.uri (i.e. the same page as |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1410 where the data have been posted) will be used for redirection. |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1411 HTTP status code "See Other" (303) is used as it is the recommanded code in |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1412 this case. |
| 962 | 1413 @param ret(None, unicode, iterable): on_data_post return value |
| 1414 see LiberviaPage.__init__ on_data_post docstring | |
|
956
dabecab10faa
server (pages): impleted CSRF protection:
Goffi <goffi@goffi.org>
parents:
955
diff
changeset
|
1415 """ |
| 962 | 1416 if ret is None: |
| 1417 ret = () | |
| 1216 | 1418 elif isinstance(ret, str): |
| 962 | 1419 ret = (ret,) |
| 1420 else: | |
| 1421 ret = tuple(ret) | |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1422 raise NotImplementedError( |
| 1216 | 1423 _("iterable in on_data_post return value is not used yet") |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1424 ) |
|
957
67bf14c91d5c
server (pages): added a confirm flag on successful post:
Goffi <goffi@goffi.org>
parents:
956
diff
changeset
|
1425 session_data = self.host.getSessionData(request, session_iface.ISATSession) |
|
974
4aa38c49bff7
pages: fixed use of request data in _on_data_post_redirect
Goffi <goffi@goffi.org>
parents:
972
diff
changeset
|
1426 request_data = self.getRData(request) |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1427 if "post_redirect_page" in request_data: |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1428 redirect_page_data = request_data["post_redirect_page"] |
|
968
4d37b23777c3
pages (core, tickets/new): replaced post_redirect_uri mechanism by post_redirect_page:
Goffi <goffi@goffi.org>
parents:
966
diff
changeset
|
1429 if isinstance(redirect_page_data, tuple): |
|
4d37b23777c3
pages (core, tickets/new): replaced post_redirect_uri mechanism by post_redirect_page:
Goffi <goffi@goffi.org>
parents:
966
diff
changeset
|
1430 redirect_page = redirect_page_data[0] |
|
972
c4e58c4dba75
server: getURL + minor improvments:
Goffi <goffi@goffi.org>
parents:
968
diff
changeset
|
1431 redirect_page_args = redirect_page_data[1:] |
|
c4e58c4dba75
server: getURL + minor improvments:
Goffi <goffi@goffi.org>
parents:
968
diff
changeset
|
1432 redirect_uri = redirect_page.getURL(*redirect_page_args) |
|
968
4d37b23777c3
pages (core, tickets/new): replaced post_redirect_uri mechanism by post_redirect_page:
Goffi <goffi@goffi.org>
parents:
966
diff
changeset
|
1433 else: |
|
4d37b23777c3
pages (core, tickets/new): replaced post_redirect_uri mechanism by post_redirect_page:
Goffi <goffi@goffi.org>
parents:
966
diff
changeset
|
1434 redirect_page = redirect_page_data |
|
972
c4e58c4dba75
server: getURL + minor improvments:
Goffi <goffi@goffi.org>
parents:
968
diff
changeset
|
1435 redirect_uri = redirect_page.url |
|
968
4d37b23777c3
pages (core, tickets/new): replaced post_redirect_uri mechanism by post_redirect_page:
Goffi <goffi@goffi.org>
parents:
966
diff
changeset
|
1436 else: |
|
4d37b23777c3
pages (core, tickets/new): replaced post_redirect_uri mechanism by post_redirect_page:
Goffi <goffi@goffi.org>
parents:
966
diff
changeset
|
1437 redirect_page = self |
|
4d37b23777c3
pages (core, tickets/new): replaced post_redirect_uri mechanism by post_redirect_page:
Goffi <goffi@goffi.org>
parents:
966
diff
changeset
|
1438 redirect_uri = request.uri |
|
4d37b23777c3
pages (core, tickets/new): replaced post_redirect_uri mechanism by post_redirect_page:
Goffi <goffi@goffi.org>
parents:
966
diff
changeset
|
1439 |
| 962 | 1440 if not C.POST_NO_CONFIRM in ret: |
|
968
4d37b23777c3
pages (core, tickets/new): replaced post_redirect_uri mechanism by post_redirect_page:
Goffi <goffi@goffi.org>
parents:
966
diff
changeset
|
1441 session_data.setPageFlag(redirect_page, C.FLAG_CONFIRM) |
|
956
dabecab10faa
server (pages): impleted CSRF protection:
Goffi <goffi@goffi.org>
parents:
955
diff
changeset
|
1442 request.setResponseCode(C.HTTP_SEE_OTHER) |
| 1216 | 1443 request.setHeader(b"location", redirect_uri) |
|
955
4f7cb6335a33
server(pages): do Post/Redirect/Get pattern when on_data_post is used (avoid double posting on refresh)
Goffi <goffi@goffi.org>
parents:
950
diff
changeset
|
1444 request.finish() |
| 1216 | 1445 raise failure.Failure(exceptions.CancelError("Post/Redirect/Get is used")) |
|
955
4f7cb6335a33
server(pages): do Post/Redirect/Get pattern when on_data_post is used (avoid double posting on refresh)
Goffi <goffi@goffi.org>
parents:
950
diff
changeset
|
1446 |
|
1276
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1447 async def _on_data_post(self, request): |
|
1283
436ef2ad92af
pages: moved CSRF checking code to a separate method:
Goffi <goffi@goffi.org>
parents:
1282
diff
changeset
|
1448 self.checkCSRF(request) |
|
1276
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1449 try: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1450 ret = await asDeferred(self.on_data_post, self, request) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1451 except exceptions.DataError as e: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1452 # something is wrong with the posted data, we re-display the page with a |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1453 # warning notification |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1454 session_data = self.host.getSessionData(request, session_iface.ISATSession) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1455 session_data.setPageNotification(self, e.value.message, C.LVL_WARNING) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1456 request.setResponseCode(C.HTTP_SEE_OTHER) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1457 request.setHeader("location", request.uri) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1458 request.finish() |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1459 raise failure.Failure(exceptions.CancelError("Post/Redirect/Get is used")) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1460 else: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1461 self._on_data_post_redirect(ret, request) |
|
956
dabecab10faa
server (pages): impleted CSRF protection:
Goffi <goffi@goffi.org>
parents:
955
diff
changeset
|
1462 |
|
1187
dab7a2b151ea
server (pages): added raise_on_missing arguments in getPostedData:
Goffi <goffi@goffi.org>
parents:
1186
diff
changeset
|
1463 def getPostedData(self, request, keys, multiple=False, raise_on_missing=True): |
|
dab7a2b151ea
server (pages): added raise_on_missing arguments in getPostedData:
Goffi <goffi@goffi.org>
parents:
1186
diff
changeset
|
1464 """Get data from a POST request or from URL's query part and decode it |
|
931
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1465 |
|
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1466 @param request(server.Request): request linked to the session |
|
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1467 @param keys(unicode, iterable[unicode]): name of the value(s) to get |
|
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1468 unicode to get one value |
|
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1469 iterable to get more than one |
|
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1470 @param multiple(bool): True if multiple values are possible/expected |
|
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1471 if False, the first value is returned |
|
1187
dab7a2b151ea
server (pages): added raise_on_missing arguments in getPostedData:
Goffi <goffi@goffi.org>
parents:
1186
diff
changeset
|
1472 @param raise_on_missing(bool): raise KeyError on missing key if True |
|
dab7a2b151ea
server (pages): added raise_on_missing arguments in getPostedData:
Goffi <goffi@goffi.org>
parents:
1186
diff
changeset
|
1473 else use None for missing values |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1474 @return (iterator[unicode], list[iterator[unicode], unicode, list[unicode]): |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1475 values received for this(these) key(s) |
|
956
dabecab10faa
server (pages): impleted CSRF protection:
Goffi <goffi@goffi.org>
parents:
955
diff
changeset
|
1476 @raise KeyError: one specific key has been requested, and it is missing |
|
931
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1477 """ |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1478 # FIXME: request.args is already unquoting the value, it seems we are doing |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1479 # double unquote |
| 1216 | 1480 if isinstance(keys, str): |
|
931
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1481 keys = [keys] |
|
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1482 get_first = True |
|
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1483 else: |
|
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1484 get_first = False |
|
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1485 |
| 1216 | 1486 keys = [k.encode('utf-8') for k in keys] |
| 1487 | |
|
931
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1488 ret = [] |
|
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1489 for key in keys: |
| 1216 | 1490 gen = (urllib.parse.unquote(v.decode("utf-8")) |
| 1491 for v in request.args.get(key, [])) | |
|
931
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1492 if multiple: |
|
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1493 ret.append(gen) |
|
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1494 else: |
|
956
dabecab10faa
server (pages): impleted CSRF protection:
Goffi <goffi@goffi.org>
parents:
955
diff
changeset
|
1495 try: |
|
dabecab10faa
server (pages): impleted CSRF protection:
Goffi <goffi@goffi.org>
parents:
955
diff
changeset
|
1496 ret.append(next(gen)) |
|
dabecab10faa
server (pages): impleted CSRF protection:
Goffi <goffi@goffi.org>
parents:
955
diff
changeset
|
1497 except StopIteration: |
|
1187
dab7a2b151ea
server (pages): added raise_on_missing arguments in getPostedData:
Goffi <goffi@goffi.org>
parents:
1186
diff
changeset
|
1498 if raise_on_missing: |
|
dab7a2b151ea
server (pages): added raise_on_missing arguments in getPostedData:
Goffi <goffi@goffi.org>
parents:
1186
diff
changeset
|
1499 raise KeyError(key) |
|
dab7a2b151ea
server (pages): added raise_on_missing arguments in getPostedData:
Goffi <goffi@goffi.org>
parents:
1186
diff
changeset
|
1500 else: |
|
dab7a2b151ea
server (pages): added raise_on_missing arguments in getPostedData:
Goffi <goffi@goffi.org>
parents:
1186
diff
changeset
|
1501 ret.append(None) |
|
931
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1502 |
|
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1503 return ret[0] if get_first else ret |
|
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1504 |
|
1009
b57f86bc1177
pages: added "multiple" argument to getAllPostedData
Goffi <goffi@goffi.org>
parents:
1003
diff
changeset
|
1505 def getAllPostedData(self, request, except_=(), multiple=True): |
| 959 | 1506 """get all posted data |
| 1507 | |
| 1508 @param request(server.Request): request linked to the session | |
| 1509 @param except_(iterable[unicode]): key of values to ignore | |
| 1510 csrf_token will always be ignored | |
|
1009
b57f86bc1177
pages: added "multiple" argument to getAllPostedData
Goffi <goffi@goffi.org>
parents:
1003
diff
changeset
|
1511 @param multiple(bool): if False, only the first values are returned |
| 959 | 1512 @return (dict[unicode, list[unicode]]): post values |
| 1513 """ | |
| 1216 | 1514 except_ = tuple(except_) + ("csrf_token",) |
| 959 | 1515 ret = {} |
| 1216 | 1516 for key, values in request.args.items(): |
| 1517 key = key.decode('utf-8') | |
| 1518 key = urllib.parse.unquote(key) | |
| 959 | 1519 if key in except_: |
| 1520 continue | |
| 1216 | 1521 values = [v.decode('utf-8') for v in values] |
|
1009
b57f86bc1177
pages: added "multiple" argument to getAllPostedData
Goffi <goffi@goffi.org>
parents:
1003
diff
changeset
|
1522 if not multiple: |
| 1216 | 1523 ret[key] = urllib.parse.unquote(values[0]) |
|
1009
b57f86bc1177
pages: added "multiple" argument to getAllPostedData
Goffi <goffi@goffi.org>
parents:
1003
diff
changeset
|
1524 else: |
| 1216 | 1525 ret[key] = [urllib.parse.unquote(v) for v in values] |
| 959 | 1526 return ret |
| 1527 | |
|
922
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1528 def getProfile(self, request): |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1529 """helper method to easily get current profile |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1530 |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1531 @return (unicode, None): current profile |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1532 None if no profile session is started |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1533 """ |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1534 sat_session = self.host.getSessionData(request, session_iface.ISATSession) |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1535 return sat_session.profile |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1536 |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1537 def getRData(self, request): |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1538 """helper method to get request data dict |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1539 |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1540 this dictionnary if for the request only, it is not saved in session |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1541 It is mainly used to pass data between pages/methods called during request |
|
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1542 workflow |
|
922
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1543 @return (dict): request data |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1544 """ |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1545 try: |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1546 return request.data |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1547 except AttributeError: |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1548 request.data = {} |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1549 return request.data |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1550 |
|
1276
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1551 def _checkAccess(self, request): |
|
922
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1552 """Check access according to self.access |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1553 |
|
1173
0f37b65fe7c2
server: replaced wrong usage of C.HTTP_UNAUTHORIZED by C.HTTP_FORBIDDEN
Goffi <goffi@goffi.org>
parents:
1171
diff
changeset
|
1554 if access is not granted, show a HTTP_FORBIDDEN pageError and stop request, |
|
922
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1555 else return data (so it can be inserted in deferred chain |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1556 """ |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1557 if self.access == C.PAGES_ACCESS_PUBLIC: |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1558 pass |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1559 elif self.access == C.PAGES_ACCESS_PROFILE: |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1560 profile = self.getProfile(request) |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1561 if not profile: |
| 962 | 1562 # no session started |
| 1563 if not self.host.options["allow_registration"]: | |
| 1564 # registration not allowed, access is not granted | |
|
1173
0f37b65fe7c2
server: replaced wrong usage of C.HTTP_UNAUTHORIZED by C.HTTP_FORBIDDEN
Goffi <goffi@goffi.org>
parents:
1171
diff
changeset
|
1565 self.pageError(request, C.HTTP_FORBIDDEN) |
| 962 | 1566 else: |
| 1567 # registration allowed, we redirect to login page | |
| 1568 login_url = self.getPageRedirectURL(request) | |
| 1569 self.HTTPRedirect(request, login_url) | |
|
922
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1570 |
|
1169
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1571 def setBestLocale(self, request): |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1572 """Guess the best locale when it is not specified explicitly by user |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1573 |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1574 This method will check "accept-language" header, and set locale to first |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1575 matching value with available translations. |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1576 """ |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1577 accept_language = request.getHeader("accept-language") |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1578 if not accept_language: |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1579 return |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1580 accepted = {a.strip() for a in accept_language.split(',')} |
| 1216 | 1581 available = [str(l) for l in self.host.renderer.translations] |
|
1169
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1582 for lang in accepted: |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1583 lang = lang.split(';')[0].strip().lower() |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1584 if not lang: |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1585 continue |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1586 for a in available: |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1587 if a.lower().startswith(lang): |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1588 session_data = self.host.getSessionData(request, |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1589 session_iface.ISATSession) |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1590 session_data.locale = a |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1591 return |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1592 |
| 995 | 1593 def renderPartial(self, request, template, template_data): |
| 1594 """Render a template to be inserted in dynamic page | |
| 1595 | |
| 1596 this is NOT the normal page rendering method, it is used only to update | |
| 1597 dynamic pages | |
| 1598 @param template(unicode): path of the template to render | |
| 1599 @param template_data(dict): template_data to use | |
| 1600 """ | |
| 1601 if not self.dynamic: | |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1602 raise exceptions.InternalError( |
| 1216 | 1603 _("renderPartial must only be used with dynamic pages") |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1604 ) |
| 995 | 1605 session_data = self.host.getSessionData(request, session_iface.ISATSession) |
| 1165 | 1606 if session_data.locale is not None: |
| 1216 | 1607 template_data['locale'] = session_data.locale |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1608 if self.vhost_root.site_name: |
| 1216 | 1609 template_data['site'] = self.vhost_root.site_name |
| 995 | 1610 |
| 1611 return self.host.renderer.render( | |
| 1612 template, | |
|
1275
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
1613 theme=session_data.theme or self.default_theme, |
|
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
1614 site_themes=self.site_themes, |
|
1148
3c7a64adfd42
pages: use absolute path for build_path + added page_url to template (which is getURL() without argument)
Goffi <goffi@goffi.org>
parents:
1147
diff
changeset
|
1615 page_url=self.getURL(), |
| 1216 | 1616 media_path="/" + C.MEDIA_DIR, |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1617 cache_path=session_data.cache_dir, |
| 1216 | 1618 build_path="/" + C.BUILD_DIR + "/", |
|
1128
6414fd795df4
server, pages: multi-sites refactoring:
Goffi <goffi@goffi.org>
parents:
1127
diff
changeset
|
1619 main_menu=self.main_menu, |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1620 **template_data |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1621 ) |
| 995 | 1622 |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1623 def renderAndUpdate( |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1624 self, request, template, selectors, template_data_update, update_type="append" |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1625 ): |
| 995 | 1626 """Helper method to render a partial page element and update the page |
| 1627 | |
| 1628 this is NOT the normal page rendering method, it is used only to update | |
| 1629 dynamic pages | |
| 1630 @param request(server.Request): current HTTP request | |
| 1631 @param template: same as for [renderPartial] | |
| 1632 @param selectors: CSS selectors to use | |
| 1633 @param template_data_update: template data to use | |
| 1634 template data cached in request will be copied then updated | |
| 1635 with this data | |
| 1636 @parap update_type(unicode): one of: | |
| 1637 append: append rendered element to selected element | |
| 1638 """ | |
| 1639 template_data = request.template_data.copy() | |
| 1640 template_data.update(template_data_update) | |
| 1641 html = self.renderPartial(request, template, template_data) | |
|
1205
92d0a2b785fd
pages: show rendered html on failed renderAndUpdate
Goffi <goffi@goffi.org>
parents:
1203
diff
changeset
|
1642 try: |
|
92d0a2b785fd
pages: show rendered html on failed renderAndUpdate
Goffi <goffi@goffi.org>
parents:
1203
diff
changeset
|
1643 request.sendData( |
| 1216 | 1644 "dom", selectors=selectors, update_type=update_type, html=html) |
|
1205
92d0a2b785fd
pages: show rendered html on failed renderAndUpdate
Goffi <goffi@goffi.org>
parents:
1203
diff
changeset
|
1645 except Exception as e: |
| 1216 | 1646 log.error("Can't renderAndUpdate, html was: {html}".format(html=html)) |
|
1205
92d0a2b785fd
pages: show rendered html on failed renderAndUpdate
Goffi <goffi@goffi.org>
parents:
1203
diff
changeset
|
1647 raise e |
| 995 | 1648 |
|
1276
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1649 async def renderPage(self, request, skip_parse_url=False): |
|
937
00236973e138
server (pages): an HTTP internal error is raised if an error is uncatched during page workflow
Goffi <goffi@goffi.org>
parents:
936
diff
changeset
|
1650 """Main method to handle the workflow of a LiberviaPage""" |
|
994
b92b06f023cb
pages: profile is now always set in template_data, and None if there is no user logged
Goffi <goffi@goffi.org>
parents:
990
diff
changeset
|
1651 |
|
923
edb322c87ea4
server (pages): pages now handle redirection, check self.pageRedirect docstring for details
Goffi <goffi@goffi.org>
parents:
922
diff
changeset
|
1652 # template_data are the variables passed to template |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1653 if not hasattr(request, "template_data"): |
|
1275
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
1654 # if template_data doesn't exist, it's the beginning of the request workflow |
|
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
1655 # so we fill essential data |
|
957
67bf14c91d5c
server (pages): added a confirm flag on successful post:
Goffi <goffi@goffi.org>
parents:
956
diff
changeset
|
1656 session_data = self.host.getSessionData(request, session_iface.ISATSession) |
|
67bf14c91d5c
server (pages): added a confirm flag on successful post:
Goffi <goffi@goffi.org>
parents:
956
diff
changeset
|
1657 csrf_token = session_data.csrf_token |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1658 request.template_data = { |
| 1216 | 1659 "profile": session_data.profile, |
| 1660 "csrf_token": csrf_token, | |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1661 } |
|
922
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1662 |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1663 # XXX: here is the code which need to be executed once |
|
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1664 # at the beginning of the request hanling |
| 917 | 1665 if request.postpath and not request.postpath[-1]: |
| 1666 # we don't differenciate URLs finishing with '/' or not | |
| 1667 del request.postpath[-1] | |
|
922
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1668 |
|
1168
ea0caa7b1bcc
pages (i18n): check presence of u"/" in locale:
Goffi <goffi@goffi.org>
parents:
1167
diff
changeset
|
1669 # i18n |
|
1224
62bf4f87c249
server: some encoding fixes following python 3 port
Goffi <goffi@goffi.org>
parents:
1216
diff
changeset
|
1670 key_lang = C.KEY_LANG.encode() |
|
62bf4f87c249
server: some encoding fixes following python 3 port
Goffi <goffi@goffi.org>
parents:
1216
diff
changeset
|
1671 if key_lang in request.args: |
| 1165 | 1672 try: |
|
1224
62bf4f87c249
server: some encoding fixes following python 3 port
Goffi <goffi@goffi.org>
parents:
1216
diff
changeset
|
1673 locale = request.args.pop(key_lang)[0].decode() |
| 1165 | 1674 except IndexError: |
| 1216 | 1675 log.warning("empty lang received") |
|
1168
ea0caa7b1bcc
pages (i18n): check presence of u"/" in locale:
Goffi <goffi@goffi.org>
parents:
1167
diff
changeset
|
1676 else: |
| 1216 | 1677 if "/" in locale: |
|
1168
ea0caa7b1bcc
pages (i18n): check presence of u"/" in locale:
Goffi <goffi@goffi.org>
parents:
1167
diff
changeset
|
1678 # "/" is refused because locale may sometime be used to access |
|
ea0caa7b1bcc
pages (i18n): check presence of u"/" in locale:
Goffi <goffi@goffi.org>
parents:
1167
diff
changeset
|
1679 # path, if localised documents are available for instance |
| 1216 | 1680 log.warning(_('illegal char found in locale ("/"), hack ' |
| 1681 'attempt? locale={locale}').format(locale=locale)) | |
|
1168
ea0caa7b1bcc
pages (i18n): check presence of u"/" in locale:
Goffi <goffi@goffi.org>
parents:
1167
diff
changeset
|
1682 locale = None |
|
ea0caa7b1bcc
pages (i18n): check presence of u"/" in locale:
Goffi <goffi@goffi.org>
parents:
1167
diff
changeset
|
1683 session_data.locale = locale |
| 1165 | 1684 |
|
1169
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1685 # if locale is not specified, we try to find one requested by browser |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1686 if session_data.locale is None: |
|
97e850e6fae9
pages (i18n): if locale is not specified, "accept-language" header is used to try to determine the best one
Goffi <goffi@goffi.org>
parents:
1168
diff
changeset
|
1687 self.setBestLocale(request) |
| 1165 | 1688 |
|
1270
6dfcdbeb0d33
pages: handle themes using `theme` request argument
Goffi <goffi@goffi.org>
parents:
1268
diff
changeset
|
1689 # theme |
|
6dfcdbeb0d33
pages: handle themes using `theme` request argument
Goffi <goffi@goffi.org>
parents:
1268
diff
changeset
|
1690 key_theme = C.KEY_THEME.encode() |
|
6dfcdbeb0d33
pages: handle themes using `theme` request argument
Goffi <goffi@goffi.org>
parents:
1268
diff
changeset
|
1691 if key_theme in request.args: |
|
1275
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
1692 theme = request.args.pop(key_theme)[0].decode() |
|
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
1693 if key_theme != session_data.theme: |
|
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
1694 if theme not in self.site_themes: |
|
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
1695 log.warning(_( |
|
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
1696 "Theme {theme!r} doesn't exist for {vhost}" |
|
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
1697 .format(theme=theme, vhost=self.vhost_root))) |
|
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
1698 else: |
|
334d044f2713
server: default theme can now be specified in site section of `sat.conf` with `theme` key
Goffi <goffi@goffi.org>
parents:
1271
diff
changeset
|
1699 session_data.theme = theme |
|
1276
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1700 try: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1701 |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1702 try: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1703 self._checkAccess(request) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1704 |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1705 if self.redirect is not None: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1706 self.pageRedirect(self.redirect, request, skip_parse_url=False) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1707 |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1708 if self.parse_url is not None and not skip_parse_url: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1709 if self.url_cache: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1710 profile = self.getProfile(request) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1711 try: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1712 cache_url = self.cached_urls[profile][request.uri] |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1713 except KeyError: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1714 # no cache for this URI yet |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1715 # we do normal URL parsing, and then the cache |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1716 await asDeferred(self.parse_url, self, request) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1717 self._cacheURL(request, profile) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1718 else: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1719 log.debug(f"using URI cache for {self}") |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1720 cache_url.use(request) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1721 else: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1722 await asDeferred(self.parse_url, self, request) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1723 |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1724 self._subpagesHandler(request) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1725 |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1726 if request.method not in (C.HTTP_METHOD_GET, C.HTTP_METHOD_POST): |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1727 # only HTTP GET and POST are handled so far |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1728 self.pageError(request, C.HTTP_BAD_REQUEST) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1729 |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1730 if request.method == C.HTTP_METHOD_POST: |
|
1284
65c43eec15ad
pages: `on_data_post` can be set to the string `continue` instead of a callable:
Goffi <goffi@goffi.org>
parents:
1283
diff
changeset
|
1731 if self.on_data_post == 'continue': |
|
65c43eec15ad
pages: `on_data_post` can be set to the string `continue` instead of a callable:
Goffi <goffi@goffi.org>
parents:
1283
diff
changeset
|
1732 pass |
|
65c43eec15ad
pages: `on_data_post` can be set to the string `continue` instead of a callable:
Goffi <goffi@goffi.org>
parents:
1283
diff
changeset
|
1733 elif self.on_data_post is None: |
|
1276
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1734 # if we don't have on_data_post, the page was not expecting POST |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1735 # so we return an error |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1736 self.pageError(request, C.HTTP_BAD_REQUEST) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1737 else: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1738 await self._on_data_post(request) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1739 # by default, POST follow normal behaviour after on_data_post is called |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1740 # this can be changed by a redirection or other method call in on_data_post |
|
922
16d1084d1371
server (pages): added "None" access (page is not rendered at all) and some HTTP code constants + helper methods to get session data
Goffi <goffi@goffi.org>
parents:
921
diff
changeset
|
1741 |
|
1276
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1742 if self.dynamic: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1743 self._prepare_dynamic(request) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1744 |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1745 if self.prepare_render: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1746 await asDeferred(self.prepare_render, self, request) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1747 |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1748 if self.template: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1749 rendered = self._render_template(request) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1750 elif self.render_method: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1751 rendered = await asDeferred(self.render_method, self, request) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1752 else: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1753 raise exceptions.InternalError( |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1754 "No method set to render page, please set a template or use a " |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1755 "render method" |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1756 ) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1757 |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1758 self.writeData(rendered, request) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1759 |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1760 except failure.Failure as f: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1761 # we have to unpack to Failure to catch the right Exception |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1762 raise f.value |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1763 |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1764 except exceptions.CancelError: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1765 pass |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1766 except BridgeException as e: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1767 if e.condition == 'not-allowed': |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1768 log.warning("not allowed exception catched") |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1769 self.pageError(request, C.HTTP_FORBIDDEN) |
|
1285
37a582b0fe53
pages: 404 is now returne if a remote server is not found
Goffi <goffi@goffi.org>
parents:
1284
diff
changeset
|
1770 elif e.condition == 'remote-server-not-found': |
|
37a582b0fe53
pages: 404 is now returne if a remote server is not found
Goffi <goffi@goffi.org>
parents:
1284
diff
changeset
|
1771 self.pageError(request, C.HTTP_NOT_FOUND) |
|
1276
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1772 else: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1773 log.error(_("Uncatched bridge exception for HTTP request on {url}: {e}") |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1774 .format(url=request.URLPath(), e=e)) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1775 try: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1776 self.pageError(request, C.HTTP_INTERNAL_ERROR) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1777 except exceptions.CancelError: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1778 pass |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1779 except Exception as e: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1780 tb = traceback.format_exc() |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1781 log.error( |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1782 _("Uncatched error for HTTP request on {url}:\n{tb}") |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1783 .format( |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1784 url=request.URLPath(), |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1785 e_name=e.__class__.__name__, |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1786 e=e, |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1787 tb=tb, |
|
1113
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1788 ) |
|
cdd389ef97bc
server: code style reformatting using black
Goffi <goffi@goffi.org>
parents:
1110
diff
changeset
|
1789 ) |
|
1276
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1790 try: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1791 self.pageError(request, C.HTTP_INTERNAL_ERROR) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1792 except exceptions.CancelError: |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1793 pass |
|
931
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1794 |
|
1276
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1795 def render_GET(self, request): |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1796 defer.ensureDeferred(self.renderPage(request)) |
| 917 | 1797 return server.NOT_DONE_YET |
| 1798 | |
|
931
8a393ae90f8c
server (pages): post requests are now handled:
Goffi <goffi@goffi.org>
parents:
927
diff
changeset
|
1799 def render_POST(self, request): |
|
1276
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1800 defer.ensureDeferred(self.renderPage(request)) |
|
cad8f24e23d4
pages: use a coroutine for renderPage:
Goffi <goffi@goffi.org>
parents:
1275
diff
changeset
|
1801 return server.NOT_DONE_YET |