libervia-web: libervia/server/pages.py annotate

annotate libervia/server/pages.py @ 1199:b300eaec53b6

server: don't raise error anymore if themes_dir is invalid or legacy blog can't be created: legacy blog will be entirely removed with 0.8 release, and themes_dir is only used by it. This patch limit troubles with this old code by not raising an error anymore if option is wrong or if the legacy blog can't be created. fix 317

author	Goffi <goffi@goffi.org>
date	Tue, 09 Jul 2019 20:20:46 +0200
parents	1211dbc3cca7
children	251eba911d4d

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

Mercurial > libervia-web

annotate libervia/server/pages.py @ 1199:b300eaec53b6