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

annotate libervia/server/pages.py @ 1406:cffa3ae4d0aa

pages (blog/view): move URL friendly code to backend tools: - the code to render an URL friendly is now in `sat.tools.common.regex` - user friendly extra text is now only displayed when no `-` is found in ID. This is a temporary transition behaviour because new blog items IDs are now user friendly by default, and thus extra text is not wanted anymore. For older IDs it is still needed though, and the presence of `-` is used to guess when an ID is user friendly or not.

author	Goffi <goffi@goffi.org>
date	Fri, 16 Apr 2021 18:44:49 +0200
parents	3dff555fe691
children	80683be8d341

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

Mercurial > libervia-web

annotate libervia/server/pages.py @ 1406:cffa3ae4d0aa