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

annotate libervia/web/server/server.py @ 1568:67ff59465fe4

install: minimum Python version is now 3.10

author	Goffi <goffi@goffi.org>
date	Wed, 22 Nov 2023 15:25:15 +0100
parents	84f312be53b4
children	9e3f7bf55749

rev	line source
1233 5bd801bd36aa server: fixed shebang Goffi <goffi@goffi.org> parents: 1228 diff changeset	1 #!/usr/bin/env python3
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	2
1397 ed037818d6de core (constants): renaming following global project renaming Goffi <goffi@goffi.org> parents: 1396 diff changeset	3 # Libervia Web
1396 822bd0139769 date update Goffi <goffi@goffi.org> parents: 1383 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/>.
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	18
1505 a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	19 from functools import partial
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	20 import os.path
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	21 from pathlib import Path
1146 76d75423ef53 server: tasks manager first draft: Goffi <goffi@goffi.org> parents: 1144 diff changeset	22 import re
76d75423ef53 server: tasks manager first draft: Goffi <goffi@goffi.org> parents: 1144 diff changeset	23 import sys
76d75423ef53 server: tasks manager first draft: Goffi <goffi@goffi.org> parents: 1144 diff changeset	24 import time
1512 65e063657597 server: move resources to a dedicated module Goffi <goffi@goffi.org> parents: 1509 diff changeset	25 from typing import Callable, Dict, Optional
1505 a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	26 import urllib.error
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	27 import urllib.parse
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	28 import urllib.request
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	29
444 b64e528fb524 server side: use of bridge's getReady to be sure that backend is initialised at launch Goffi <goffi@goffi.org> parents: 438 diff changeset	30 from twisted.application import service
1505 a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	31 from twisted.internet import defer, inotify, reactor
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	32 from twisted.python import failure
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	33 from twisted.python import filepath
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	34 from twisted.python.components import registerAdapter
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	35 from twisted.web import server
858 7dde76708892 server: URL redirections + misc: Goffi <goffi@goffi.org> parents: 856 diff changeset	36 from twisted.web import static
7dde76708892 server: URL redirections + misc: Goffi <goffi@goffi.org> parents: 856 diff changeset	37 from twisted.web import resource as web_resource
7dde76708892 server: URL redirections + misc: Goffi <goffi@goffi.org> parents: 856 diff changeset	38 from twisted.web import util as web_util
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	39 from twisted.web import vhost
750 8ac862f6e5b3 browser and server sides: allow to connect with a JID that is not registered on the local server souliane <souliane@mailoo.org> parents: 746 diff changeset	40 from twisted.words.protocols.jabber import jid
449 981ed669d3b3 /!\ reorganize all the file hierarchy, move the code and launching script to src: souliane <souliane@mailoo.org> parents: 448 diff changeset	41
1518 eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	42 import libervia.web
eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	43 from libervia.web.server import websockets
eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	44 from libervia.web.server import session_iface
eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	45 from libervia.web.server.constants import Const as C
eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	46 from libervia.web.server.pages import LiberviaPage
eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	47 from libervia.web.server.tasks.manager import TasksManager
eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	48 from libervia.web.server.utils import ProgressHandler
eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	49 from libervia.backend.core import exceptions
eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	50 from libervia.backend.core.i18n import _
eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	51 from libervia.backend.core.log import getLogger
eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	52 from libervia.backend.tools import utils
eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	53 from libervia.backend.tools import config
eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	54 from libervia.backend.tools.common import regex
eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	55 from libervia.backend.tools.common import template
eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	56 from libervia.backend.tools.common import data_format
eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	57 from libervia.backend.tools.common import tls
eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	58 from libervia.frontends.bridge.bridge_frontend import BridgeException
eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	59 from libervia.frontends.bridge.dbus_bridge import BridgeExceptionNoService, bridge
eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	60 from libervia.frontends.bridge.dbus_bridge import const_TIMEOUT as BRIDGE_TIMEOUT
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	61
1512 65e063657597 server: move resources to a dedicated module Goffi <goffi@goffi.org> parents: 1509 diff changeset	62 from .resources import LiberviaRootResource, ProtectedFile
1287 1f26d8c2afc1 server: restricted_bridge first draft: Goffi <goffi@goffi.org> parents: 1282 diff changeset	63 from .restricted_bridge import RestrictedBridge
449 981ed669d3b3 /!\ reorganize all the file hierarchy, move the code and launching script to src: souliane <souliane@mailoo.org> parents: 448 diff changeset	64
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	65 log = getLogger(__name__)
682 e6bb64bd6b4d server side: implemented methods to get SàT and Libervia versions Goffi <goffi@goffi.org> parents: 679 diff changeset	66
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	67
1152 1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	68 DEFAULT_MASK = (inotify.IN_CREATE \| inotify.IN_MODIFY \| inotify.IN_MOVE_SELF
1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	69 \| inotify.IN_MOVED_TO)
1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	70
1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	71
1361 626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	72 class SysExit(Exception):
626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	73
626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	74 def __init__(self, exit_code, message=""):
626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	75 self.exit_code = exit_code
626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	76 self.message = message
626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	77
626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	78 def __str__(self):
626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	79 return f"System Exit({self.exit_code}): {self.message}"
626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	80
626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	81
1152 1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	82 class FilesWatcher(object):
1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	83 """Class to check files modifications using iNotify"""
1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	84 _notifier = None
1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	85
1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	86 def __init__(self, host):
1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	87 self.host = host
1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	88
1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	89 @property
1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	90 def notifier(self):
1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	91 if self._notifier == None:
1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	92 notifier = self.__class__._notifier = inotify.INotify()
1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	93 notifier.startReading()
1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	94 return self._notifier
1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	95
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	96 def _check_callback(self, dir_path, callback, recursive):
1251 a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	97 # Twisted doesn't add callback if a watcher was already set on a path
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	98 # but in dev mode Libervia watches whole sites + internal path can be watched
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	99 # by tasks, so several callbacks must be called on some paths.
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	100 # This method check that the new callback is indeed present in the desired path
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	101 # and add it otherwise.
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	102 # FIXME: this should probably be fixed upstream
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	103 if recursive:
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	104 for child in dir_path.walk():
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	105 if child.isdir():
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	106 self._check_callback(child, callback, recursive=False)
1251 a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	107 else:
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	108 watch_id = self.notifier._isWatched(dir_path)
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	109 if watch_id is None:
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	110 log.warning(
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	111 f"There is no watch ID for path {dir_path}, this should not happen"
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	112 )
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	113 else:
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	114 watch_point = self.notifier._watchpoints[watch_id]
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	115 if callback not in watch_point.callbacks:
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	116 watch_point.callbacks.append(callback)
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	117
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	118 def watch_dir(self, dir_path, callback, mask=DEFAULT_MASK, auto_add=False,
1152 1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	119 recursive=False, **kwargs):
1251 a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	120 dir_path = str(dir_path)
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	121 log.info(_("Watching directory {dir_path}").format(dir_path=dir_path))
1251 a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	122 wrapped_callback = lambda __, filepath, mask: callback(
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	123 self.host, filepath, inotify.humanReadableMask(mask), **kwargs)
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	124 callbacks = [wrapped_callback]
a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	125 dir_path = filepath.FilePath(dir_path)
1152 1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	126 self.notifier.watch(
1251 a1606e2a92eb server: fixed watching a directory which is already watched: Goffi <goffi@goffi.org> parents: 1246 diff changeset	127 dir_path, mask=mask, autoAdd=auto_add, recursive=recursive,
1152 1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	128 callbacks=callbacks)
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	129 self._check_callback(dir_path, wrapped_callback, recursive)
682 e6bb64bd6b4d server side: implemented methods to get SàT and Libervia versions Goffi <goffi@goffi.org> parents: 679 diff changeset	130
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	131
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	132 class WebSession(server.Session):
555 db1b330c1eb1 server_side: set the connection attempt timeout to the bridge timeout (2 minutes) souliane <souliane@mailoo.org> parents: 554 diff changeset	133 sessionTimeout = C.SESSION_TIMEOUT
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	134
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	135 def __init__(self, args, *kwargs):
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	136 self.__lock = False
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	137 server.Session.__init__(self, args, *kwargs)
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	138
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	139 def lock(self):
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	140 """Prevent session from expiring"""
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	141 self.__lock = True
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	142 self._expireCall.reset(sys.maxsize)
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	143
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	144 def unlock(self):
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	145 """Allow session to expire again, and touch it"""
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	146 self.__lock = False
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	147 self.touch()
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	148
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	149 def touch(self):
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	150 if not self.__lock:
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	151 server.Session.touch(self)
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	152
451 1a0cec9b0f1e better PEP-8 compliance souliane <souliane@mailoo.org> parents: 449 diff changeset	153
554 471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	154 class WaitingRequests(dict):
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	155 def set_request(self, request, profile, register_with_ext_jid=False):
554 471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	156 """Add the given profile to the waiting list.
471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	157
471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	158 @param request (server.Request): the connection request
471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	159 @param profile (str): %(doc_profile)s
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	160 @param register_with_ext_jid (bool): True if we will try to register the
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	161 profile with an external XMPP account credentials
554 471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	162 """
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	163 dc = reactor.callLater(BRIDGE_TIMEOUT, self.purge_request, profile)
796 fad9c9f82ae3 browser and server sides: alert the user after he created a new profile using his XMPP account credentials souliane <souliane@mailoo.org> parents: 794 diff changeset	164 self[profile] = (request, dc, register_with_ext_jid)
554 471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	165
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	166 def purge_request(self, profile):
554 471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	167 """Remove the given profile from the waiting list.
471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	168
471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	169 @param profile (str): %(doc_profile)s
471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	170 """
471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	171 try:
471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	172 dc = self[profile][1]
471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	173 except KeyError:
471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	174 return
471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	175 if dc.active():
471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	176 dc.cancel()
471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	177 del self[profile]
471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	178
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	179 def get_request(self, profile):
554 471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	180 """Get the waiting request for the given profile.
471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	181
471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	182 @param profile (str): %(doc_profile)s
471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	183 @return: the waiting request or None
471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	184 """
471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	185 return self[profile][0] if profile in self else None
471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	186
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	187 def get_register_with_ext_jid(self, profile):
796 fad9c9f82ae3 browser and server sides: alert the user after he created a new profile using his XMPP account credentials souliane <souliane@mailoo.org> parents: 794 diff changeset	188 """Get the value of the register_with_ext_jid parameter.
fad9c9f82ae3 browser and server sides: alert the user after he created a new profile using his XMPP account credentials souliane <souliane@mailoo.org> parents: 794 diff changeset	189
fad9c9f82ae3 browser and server sides: alert the user after he created a new profile using his XMPP account credentials souliane <souliane@mailoo.org> parents: 794 diff changeset	190 @param profile (str): %(doc_profile)s
fad9c9f82ae3 browser and server sides: alert the user after he created a new profile using his XMPP account credentials souliane <souliane@mailoo.org> parents: 794 diff changeset	191 @return: bool or None
fad9c9f82ae3 browser and server sides: alert the user after he created a new profile using his XMPP account credentials souliane <souliane@mailoo.org> parents: 794 diff changeset	192 """
fad9c9f82ae3 browser and server sides: alert the user after he created a new profile using his XMPP account credentials souliane <souliane@mailoo.org> parents: 794 diff changeset	193 return self[profile][2] if profile in self else None
fad9c9f82ae3 browser and server sides: alert the user after he created a new profile using his XMPP account credentials souliane <souliane@mailoo.org> parents: 794 diff changeset	194
554 471b6babe960 server_side: set a timeout to reset the waiting connection requests after 5 minutes souliane <souliane@mailoo.org> parents: 553 diff changeset	195
1518 eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	196 class LiberviaWeb(service.Service):
995 f88325b56a6a server: dynamic pages first draft: Goffi <goffi@goffi.org> parents: 990 diff changeset	197 debug = defer.Deferred.debug # True if twistd/Libervia is launched in debug mode
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	198
810 3905bc24eb17 server: proper options handling Goffi <goffi@goffi.org> parents: 801 diff changeset	199 def __init__(self, options):
3905bc24eb17 server: proper options handling Goffi <goffi@goffi.org> parents: 801 diff changeset	200 self.options = options
1504 409d10211b20 server, browser: dynamic pages refactoring: Goffi <goffi@goffi.org> parents: 1484 diff changeset	201 websockets.host = self
1236 352e189ab7f8 server: avoid double init Goffi <goffi@goffi.org> parents: 1235 diff changeset	202
352e189ab7f8 server: avoid double init Goffi <goffi@goffi.org> parents: 1235 diff changeset	203 def _init(self):
352e189ab7f8 server: avoid double init Goffi <goffi@goffi.org> parents: 1235 diff changeset	204 # we do init here and not in __init__ to avoid doule initialisation with twistd
352e189ab7f8 server: avoid double init Goffi <goffi@goffi.org> parents: 1235 diff changeset	205 # this _init is called in startService
444 b64e528fb524 server side: use of bridge's getReady to be sure that backend is initialised at launch Goffi <goffi@goffi.org> parents: 438 diff changeset	206 self.initialised = defer.Deferred()
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	207 self.waiting_profiles = WaitingRequests() # FIXME: should be removed
1146 76d75423ef53 server: tasks manager first draft: Goffi <goffi@goffi.org> parents: 1144 diff changeset	208 self._main_conf = None
1152 1c23252958ed server: iNotify support: Goffi <goffi@goffi.org> parents: 1151 diff changeset	209 self.files_watcher = FilesWatcher(self)
470 34ce41e014c4 server side: options managing improvments: Goffi <goffi@goffi.org> parents: 465 diff changeset	210
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	211 if self.options["base_url_ext"]:
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	212 self.base_url_ext = self.options.pop("base_url_ext")
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	213 if self.base_url_ext[-1] != "/":
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	214 self.base_url_ext += "/"
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	215 self.base_url_ext_data = urllib.parse.urlsplit(self.base_url_ext)
881 6bdee34fa2f4 server: added base_url_ext option to handle different external URLs (e.g.: if there is a proxy) Goffi <goffi@goffi.org> parents: 875 diff changeset	216 else:
6bdee34fa2f4 server: added base_url_ext option to handle different external URLs (e.g.: if there is a proxy) Goffi <goffi@goffi.org> parents: 875 diff changeset	217 self.base_url_ext = None
884 763da94ba28b blog (atom): base_url_ext can now only specify scheme, or netloc, or path, it will be used to complete data coming from request's path Goffi <goffi@goffi.org> parents: 881 diff changeset	218 # we split empty string anyway so we can do things like
763da94ba28b blog (atom): base_url_ext can now only specify scheme, or netloc, or path, it will be used to complete data coming from request's path Goffi <goffi@goffi.org> parents: 881 diff changeset	219 # scheme = self.base_url_ext_data.scheme or 'https'
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	220 self.base_url_ext_data = urllib.parse.urlsplit("")
884 763da94ba28b blog (atom): base_url_ext can now only specify scheme, or netloc, or path, it will be used to complete data coming from request's path Goffi <goffi@goffi.org> parents: 881 diff changeset	221
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	222 if not self.options["port_https_ext"]:
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	223 self.options["port_https_ext"] = self.options["port_https"]
470 34ce41e014c4 server side: options managing improvments: Goffi <goffi@goffi.org> parents: 465 diff changeset	224
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	225 self._cleanup = []
470 34ce41e014c4 server side: options managing improvments: Goffi <goffi@goffi.org> parents: 465 diff changeset	226
451 1a0cec9b0f1e better PEP-8 compliance souliane <souliane@mailoo.org> parents: 449 diff changeset	227 self.sessions = {} # key = session value = user
1a0cec9b0f1e better PEP-8 compliance souliane <souliane@mailoo.org> parents: 449 diff changeset	228 self.prof_connected = set() # Profiles connected
985 64826e69f365 pages: cache mechanism, first draft: Goffi <goffi@goffi.org> parents: 984 diff changeset	229 self.ns_map = {} # map of short name to namespaces
470 34ce41e014c4 server side: options managing improvments: Goffi <goffi@goffi.org> parents: 465 diff changeset	230
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	231 ## bridge ##
1367 ce5cfe004d4e server: new `--bridge-retries` option: Goffi <goffi@goffi.org> parents: 1365 diff changeset	232 self._bridge_retry = self.options['bridge-retries']
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	233 self.bridge = bridge()
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	234 self.bridge.bridge_connect(callback=self._bridge_cb, errback=self._bridge_eb)
553 8492c2bb463b server_side: enable HTTP gzip compression souliane <souliane@mailoo.org> parents: 522 diff changeset	235
1505 a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	236 ## libervia app callbacks ##
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	237 # mapping instance id to the callback to call on "started" signal
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	238 self.apps_cb: Dict[str, Callable] = {}
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	239
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	240 @property
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	241 def roots(self):
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	242 """Return available virtual host roots
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	243
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	244 Root resources are only returned once, even if they are present for multiple
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	245 named vhosts. Order is not relevant, except for default vhost which is always
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	246 returned first.
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	247 @return (list[web_resource.Resource]): all vhost root resources
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	248 """
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	249 roots = list(set(self.vhost_root.hosts.values()))
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	250 default = self.vhost_root.default
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	251 if default is not None and default not in roots:
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	252 roots.insert(0, default)
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	253 return roots
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	254
1146 76d75423ef53 server: tasks manager first draft: Goffi <goffi@goffi.org> parents: 1144 diff changeset	255 @property
76d75423ef53 server: tasks manager first draft: Goffi <goffi@goffi.org> parents: 1144 diff changeset	256 def main_conf(self):
1518 eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	257 """SafeConfigParser instance opened on configuration file (libervia.conf)"""
1146 76d75423ef53 server: tasks manager first draft: Goffi <goffi@goffi.org> parents: 1144 diff changeset	258 if self._main_conf is None:
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	259 self._main_conf = config.parse_main_conf(log_filenames=True)
1146 76d75423ef53 server: tasks manager first draft: Goffi <goffi@goffi.org> parents: 1144 diff changeset	260 return self._main_conf
76d75423ef53 server: tasks manager first draft: Goffi <goffi@goffi.org> parents: 1144 diff changeset	261
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	262 def config_get(self, site_root_res, key, default=None, value_type=None):
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	263 """Retrieve configuration associated to a site
02afab1b15c5 server, pages, tasks: moved getConfig to backend, and added shorcut version in LiberviaPage and TasksManager Goffi <goffi@goffi.org> parents: 1146 diff changeset	264
02afab1b15c5 server, pages, tasks: moved getConfig to backend, and added shorcut version in LiberviaPage and TasksManager Goffi <goffi@goffi.org> parents: 1146 diff changeset	265 Section is automatically set to site name
02afab1b15c5 server, pages, tasks: moved getConfig to backend, and added shorcut version in LiberviaPage and TasksManager Goffi <goffi@goffi.org> parents: 1146 diff changeset	266 @param site_root_res(LiberviaRootResource): resource of the site in use
02afab1b15c5 server, pages, tasks: moved getConfig to backend, and added shorcut version in LiberviaPage and TasksManager Goffi <goffi@goffi.org> parents: 1146 diff changeset	267 @param key(unicode): key to use
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	268 @param default: value to use if not found (see [config.config_get])
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	269 @param value_type(unicode, None): filter to use on value
02afab1b15c5 server, pages, tasks: moved getConfig to backend, and added shorcut version in LiberviaPage and TasksManager Goffi <goffi@goffi.org> parents: 1146 diff changeset	270 Note that filters are already automatically used when the key finish
02afab1b15c5 server, pages, tasks: moved getConfig to backend, and added shorcut version in LiberviaPage and TasksManager Goffi <goffi@goffi.org> parents: 1146 diff changeset	271 by a well known suffix ("_path", "_list", "_dict", or "_json")
02afab1b15c5 server, pages, tasks: moved getConfig to backend, and added shorcut version in LiberviaPage and TasksManager Goffi <goffi@goffi.org> parents: 1146 diff changeset	272 None to use no filter, else can be:
02afab1b15c5 server, pages, tasks: moved getConfig to backend, and added shorcut version in LiberviaPage and TasksManager Goffi <goffi@goffi.org> parents: 1146 diff changeset	273 - "path": a path is expected, will be normalized and expanded
02afab1b15c5 server, pages, tasks: moved getConfig to backend, and added shorcut version in LiberviaPage and TasksManager Goffi <goffi@goffi.org> parents: 1146 diff changeset	274
02afab1b15c5 server, pages, tasks: moved getConfig to backend, and added shorcut version in LiberviaPage and TasksManager Goffi <goffi@goffi.org> parents: 1146 diff changeset	275 """
1275 334d044f2713 server: default theme can now be specified in site section of `sat.conf` with `theme` key Goffi <goffi@goffi.org> parents: 1274 diff changeset	276 section = site_root_res.site_name.lower().strip() or C.CONFIG_SECTION
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	277 value = config.config_get(self.main_conf, section, key, default=default)
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	278 if value_type is not None:
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	279 if value_type == 'path':
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	280 v_filter = lambda v: os.path.abspath(os.path.expanduser(v))
02afab1b15c5 server, pages, tasks: moved getConfig to backend, and added shorcut version in LiberviaPage and TasksManager Goffi <goffi@goffi.org> parents: 1146 diff changeset	281 else:
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	282 raise ValueError("unknown value type {value_type}".format(
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	283 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	284 if isinstance(value, list):
02afab1b15c5 server, pages, tasks: moved getConfig to backend, and added shorcut version in LiberviaPage and TasksManager Goffi <goffi@goffi.org> parents: 1146 diff changeset	285 value = [v_filter(v) for v in value]
02afab1b15c5 server, pages, tasks: moved getConfig to backend, and added shorcut version in LiberviaPage and TasksManager Goffi <goffi@goffi.org> parents: 1146 diff changeset	286 elif isinstance(value, dict):
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	287 value = {k:v_filter(v) for k,v in list(value.items())}
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	288 elif value is not None:
1217 fe9782391f63 server: fixed value filtering in getConfig Goffi <goffi@goffi.org> parents: 1216 diff changeset	289 value = v_filter(value)
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	290 return value
02afab1b15c5 server, pages, tasks: moved getConfig to backend, and added shorcut version in LiberviaPage and TasksManager Goffi <goffi@goffi.org> parents: 1146 diff changeset	291
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	292 def _namespaces_get_cb(self, ns_map):
1383 81b472bcf0a1 server: be sure to have strings for ns_map Goffi <goffi@goffi.org> parents: 1370 diff changeset	293 self.ns_map = {str(k): str(v) for k,v in ns_map.items()}
985 64826e69f365 pages: cache mechanism, first draft: Goffi <goffi@goffi.org> parents: 984 diff changeset	294
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	295 def _namespaces_get_eb(self, failure_):
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	296 log.error(_("Can't get namespaces map: {msg}").format(msg=failure_))
985 64826e69f365 pages: cache mechanism, first draft: Goffi <goffi@goffi.org> parents: 984 diff changeset	297
1522 a44f77559279 installation: moved from `setup.py` to `pyproject.toml`: Goffi <goffi@goffi.org> parents: 1519 diff changeset	298 @template.pass_context
1127 9234f29053b0 server, pages: update to handle multi sites themes, first draft: Goffi <goffi@goffi.org> parents: 1126 diff changeset	299 def _front_url_filter(self, ctx, relative_url):
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	300 template_data = ctx['template_data']
1292 e30e96958fb7 server: use C.SITE_NAME_DEFAULT instead of "sat" when suitable Goffi <goffi@goffi.org> parents: 1287 diff changeset	301 return os.path.join(
e30e96958fb7 server: use C.SITE_NAME_DEFAULT instead of "sat" when suitable Goffi <goffi@goffi.org> parents: 1287 diff changeset	302 '/', C.TPL_RESOURCE, template_data.site or C.SITE_NAME_DEFAULT,
1127 9234f29053b0 server, pages: update to handle multi sites themes, first draft: Goffi <goffi@goffi.org> parents: 1126 diff changeset	303 C.TEMPLATE_TPL_DIR, template_data.theme, relative_url)
9234f29053b0 server, pages: update to handle multi sites themes, first draft: Goffi <goffi@goffi.org> parents: 1126 diff changeset	304
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	305 def _move_first_level_to_dict(self, options, key, keys_to_keep):
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	306 """Read a config option and put value at first level into u'' dict
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	307
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	308 This is useful to put values for Libervia official site directly in dictionary,
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	309 and to use site_name as keys when external sites are used.
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	310 options will be modified in place
1132 0cafb79ced6d server: use site names in _moveFirstLevelToDict to better distinguish values for default site at first level + better handling of default menu Goffi <goffi@goffi.org> parents: 1131 diff changeset	311 @param options(dict): options to modify
0cafb79ced6d server: use site names in _moveFirstLevelToDict to better distinguish values for default site at first level + better handling of default menu Goffi <goffi@goffi.org> parents: 1131 diff changeset	312 @param key(unicode): setting key to modify
0cafb79ced6d server: use site names in _moveFirstLevelToDict to better distinguish values for default site at first level + better handling of default menu Goffi <goffi@goffi.org> parents: 1131 diff changeset	313 @param keys_to_keep(list(unicode)): keys allowed in first level
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	314 """
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	315 try:
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	316 conf = options[key]
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	317 except KeyError:
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	318 return
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	319 if not isinstance(conf, dict):
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	320 options[key] = {'': conf}
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	321 return
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	322 default_dict = conf.get('', {})
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	323 to_delete = []
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	324 for key, value in conf.items():
1132 0cafb79ced6d server: use site names in _moveFirstLevelToDict to better distinguish values for default site at first level + better handling of default menu Goffi <goffi@goffi.org> parents: 1131 diff changeset	325 if key not in keys_to_keep:
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	326 default_dict[key] = value
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	327 to_delete.append(key)
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	328 for key in to_delete:
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	329 del conf[key]
1132 0cafb79ced6d server: use site names in _moveFirstLevelToDict to better distinguish values for default site at first level + better handling of default menu Goffi <goffi@goffi.org> parents: 1131 diff changeset	330 if default_dict:
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	331 conf[''] = default_dict
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	332
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	333 async def check_and_connect_service_profile(self):
1362 45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	334 passphrase = self.options["passphrase"]
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	335 if not passphrase:
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	336 raise SysExit(
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	337 C.EXIT_BAD_ARG,
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	338 _("No passphrase set for service profile, please check installation "
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	339 "documentation.")
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	340 )
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	341 try:
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	342 s_prof_connected = await self.bridge_call("is_connected", C.SERVICE_PROFILE)
1362 45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	343 except BridgeException as e:
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	344 if e.classname == "ProfileUnknownError":
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	345 log.info("Service profile doesn't exist, creating it.")
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	346 try:
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	347 xmpp_domain = await self.bridge_call("config_get", "", "xmpp_domain")
1362 45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	348 xmpp_domain = xmpp_domain.strip()
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	349 if not xmpp_domain:
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	350 raise SysExit(
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	351 C.EXIT_BAD_ARG,
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	352 _('"xmpp_domain" must be set to create new accounts, please '
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	353 'check documentation')
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	354 )
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	355 service_profile_jid_s = f"{C.SERVICE_PROFILE}@{xmpp_domain}"
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	356 await self.bridge_call(
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	357 "in_band_account_new",
1362 45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	358 service_profile_jid_s,
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	359 passphrase,
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	360 "",
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	361 xmpp_domain,
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	362 0,
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	363 )
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	364 except BridgeException as e:
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	365 if e.condition == "conflict":
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	366 log.info(
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	367 _("Service's profile JID {profile_jid} already exists")
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	368 .format(profile_jid=service_profile_jid_s)
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	369 )
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	370 elif e.classname == "UnknownMethod":
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	371 raise SysExit(
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	372 C.EXIT_BRIDGE_ERROR,
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	373 _("Can't create service profile XMPP account, In-Band "
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	374 "Registration plugin is not activated, you'll have to "
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	375 "create the {profile!r} profile with {profile_jid!r} JID "
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	376 "manually.").format(
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	377 profile=C.SERVICE_PROFILE,
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	378 profile_jid=service_profile_jid_s)
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	379 )
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	380 elif e.condition == "service-unavailable":
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	381 raise SysExit(
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	382 C.EXIT_BRIDGE_ERROR,
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	383 _("Can't create service profile XMPP account, In-Band "
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	384 "Registration is not activated on your server, you'll have "
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	385 "to create the {profile!r} profile with {profile_jid!r} JID "
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	386 "manually.\nNote that you'll need to activate In-Band "
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	387 "Registation on your server if you want users to be able "
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	388 "to create new account from {app_name}, please check "
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	389 "documentation.").format(
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	390 profile=C.SERVICE_PROFILE,
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	391 profile_jid=service_profile_jid_s,
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	392 app_name=C.APP_NAME)
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	393 )
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	394 elif e.condition == "not-acceptable":
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	395 raise SysExit(
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	396 C.EXIT_BRIDGE_ERROR,
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	397 _("Can't create service profile XMPP account, your XMPP "
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	398 "server doesn't allow us to create new accounts with "
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	399 "In-Band Registration please check XMPP server "
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	400 "configuration: {reason}"
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	401 ).format(
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	402 profile=C.SERVICE_PROFILE,
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	403 profile_jid=service_profile_jid_s,
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	404 reason=e.message)
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	405 )
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	406
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	407 else:
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	408 raise SysExit(
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	409 C.EXIT_BRIDGE_ERROR,
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	410 _("Can't create service profile XMPP account, you'll have "
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	411 "do to it manually: {reason}").format(reason=e.message)
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	412 )
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	413 try:
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	414 await self.bridge_call("profile_create", C.SERVICE_PROFILE, passphrase)
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	415 await self.bridge_call(
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	416 "profile_start_session", passphrase, C.SERVICE_PROFILE)
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	417 await self.bridge_call(
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	418 "param_set", "JabberID", service_profile_jid_s, "Connection", -1,
1362 45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	419 C.SERVICE_PROFILE)
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	420 await self.bridge_call(
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	421 "param_set", "Password", passphrase, "Connection", -1,
1362 45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	422 C.SERVICE_PROFILE)
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	423 except BridgeException as e:
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	424 raise SysExit(
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	425 C.EXIT_BRIDGE_ERROR,
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	426 _("Can't create service profile XMPP account, you'll have "
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	427 "do to it manually: {reason}").format(reason=e.message)
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	428 )
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	429 log.info(_("Service profile has been successfully created"))
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	430 s_prof_connected = False
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	431 else:
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	432 raise SysExit(C.EXIT_BRIDGE_ERROR, e.message)
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	433
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	434 if not s_prof_connected:
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	435 try:
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	436 await self.bridge_call(
1362 45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	437 "connect",
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	438 C.SERVICE_PROFILE,
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	439 passphrase,
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	440 {},
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	441 )
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	442 except BridgeException as e:
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	443 raise SysExit(
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	444 C.EXIT_BRIDGE_ERROR,
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	445 _("Connection of service profile failed: {reason}").format(reason=e)
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	446 )
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	447
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	448 async def backend_ready(self):
1397 ed037818d6de core (constants): renaming following global project renaming Goffi <goffi@goffi.org> parents: 1396 diff changeset	449 log.info(f"Libervia Web v{self.full_version}")
1362 45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	450
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	451 # settings
1364 df40708c4c76 server: renamed `--dev_mode` to `--dev-mode` and set it as a flag: Goffi <goffi@goffi.org> parents: 1362 diff changeset	452 if self.options['dev-mode']:
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	453 log.info(_("Developer mode activated"))
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	454 self.media_dir = await self.bridge_call("config_get", "", "media_dir")
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	455 self.local_dir = await self.bridge_call("config_get", "", "local_dir")
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	456 self.cache_root_dir = os.path.join(self.local_dir, C.CACHE_DIR)
1132 0cafb79ced6d server: use site names in _moveFirstLevelToDict to better distinguish values for default site at first level + better handling of default menu Goffi <goffi@goffi.org> parents: 1131 diff changeset	457 self.renderer = template.Renderer(self, self._front_url_filter)
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	458 sites_names = list(self.renderer.sites_paths.keys())
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	459
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	460 self._move_first_level_to_dict(self.options, "url_redirections_dict", sites_names)
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	461 self._move_first_level_to_dict(self.options, "menu_json", sites_names)
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	462 self._move_first_level_to_dict(self.options, "menu_extra_json", sites_names)
1359 2da573bf3f8b server: new `menu_extra_json` configuration option: Goffi <goffi@goffi.org> parents: 1354 diff changeset	463 menu = self.options["menu_json"]
2da573bf3f8b server: new `menu_extra_json` configuration option: Goffi <goffi@goffi.org> parents: 1354 diff changeset	464 if not '' in menu:
2da573bf3f8b server: new `menu_extra_json` configuration option: Goffi <goffi@goffi.org> parents: 1354 diff changeset	465 menu[''] = C.DEFAULT_MENU
2da573bf3f8b server: new `menu_extra_json` configuration option: Goffi <goffi@goffi.org> parents: 1354 diff changeset	466 for site, value in self.options["menu_extra_json"].items():
2da573bf3f8b server: new `menu_extra_json` configuration option: Goffi <goffi@goffi.org> parents: 1354 diff changeset	467 menu[site].extend(value)
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	468
1362 45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	469 # service profile
1370 2d6cfce0df6c server: typo Goffi <goffi@goffi.org> parents: 1369 diff changeset	470 if not self.options['build-only']:
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	471 await self.check_and_connect_service_profile()
1362 45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	472
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	473 # restricted bridge, the one used by browser code
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	474 self.restricted_bridge = RestrictedBridge(self)
45ebeea1bacd server: improved service profile check + auto creation: Goffi <goffi@goffi.org> parents: 1361 diff changeset	475
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	476 # we create virtual hosts and import Libervia pages into them
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	477 self.vhost_root = vhost.NameVirtualHost()
1518 eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	478 default_site_path = Path(libervia.web.__file__).parent.resolve()
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	479 # self.sat_root is official Libervia site
1253 6d49fae517ba pages: browser metadata + root `_browser`: Goffi <goffi@goffi.org> parents: 1251 diff changeset	480 root_path = default_site_path / C.TEMPLATE_STATIC_DIR
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	481 self.sat_root = default_root = LiberviaRootResource(
1246 aaf28d45ae67 pages: browser code, first draft: Goffi <goffi@goffi.org> parents: 1245 diff changeset	482 host=self, host_name='', site_name='',
aaf28d45ae67 pages: browser code, first draft: Goffi <goffi@goffi.org> parents: 1245 diff changeset	483 site_path=default_site_path, path=root_path)
1364 df40708c4c76 server: renamed `--dev_mode` to `--dev-mode` and set it as a flag: Goffi <goffi@goffi.org> parents: 1362 diff changeset	484 if self.options['dev-mode']:
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	485 self.files_watcher.watch_dir(
1153 94f9d81a475e pages: auto reloading Goffi <goffi@goffi.org> parents: 1152 diff changeset	486 default_site_path, auto_add=True, recursive=True,
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	487 callback=LiberviaPage.on_file_change, site_root=self.sat_root,
1153 94f9d81a475e pages: auto reloading Goffi <goffi@goffi.org> parents: 1152 diff changeset	488 site_path=default_site_path)
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	489 LiberviaPage.import_pages(self, self.sat_root)
1146 76d75423ef53 server: tasks manager first draft: Goffi <goffi@goffi.org> parents: 1144 diff changeset	490 tasks_manager = TasksManager(self, self.sat_root)
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	491 await tasks_manager.parse_tasks()
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	492 await tasks_manager.run_tasks()
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	493 # FIXME: handle _set_menu in a more generic way, taking care of external sites
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	494 await self.sat_root._set_menu(self.options["menu_json"])
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	495 self.vhost_root.default = default_root
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	496 existing_vhosts = {b'': default_root}
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	497
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	498 for host_name, site_name in self.options["vhosts_dict"].items():
1246 aaf28d45ae67 pages: browser code, first draft: Goffi <goffi@goffi.org> parents: 1245 diff changeset	499 if site_name == C.SITE_NAME_DEFAULT:
aaf28d45ae67 pages: browser code, first draft: Goffi <goffi@goffi.org> parents: 1245 diff changeset	500 raise ValueError(
aaf28d45ae67 pages: browser code, first draft: Goffi <goffi@goffi.org> parents: 1245 diff changeset	501 f"{C.DEFAULT_SITE_NAME} is reserved and can't be used in vhosts_dict")
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	502 encoded_site_name = site_name.encode('utf-8')
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	503 try:
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	504 site_path = self.renderer.sites_paths[site_name]
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	505 except KeyError:
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	506 log.warning(_(
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	507 "host {host_name} link to non existing site {site_name}, ignoring "
b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	508 "it").format(host_name=host_name, site_name=site_name))
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	509 continue
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	510 if encoded_site_name in existing_vhosts:
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	511 # we have an alias host, we re-use existing resource
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	512 res = existing_vhosts[encoded_site_name]
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	513 else:
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	514 # for root path we first check if there is a global static dir
1257 1ec41ac1e7cf server: seperation between production build dir and dev build dir: Goffi <goffi@goffi.org> parents: 1256 diff changeset	515 # if not, we use default template's static dir
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	516 root_path = os.path.join(site_path, C.TEMPLATE_STATIC_DIR)
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	517 if not os.path.isdir(root_path):
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	518 root_path = os.path.join(
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	519 site_path, C.TEMPLATE_TPL_DIR, C.TEMPLATE_THEME_DEFAULT,
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	520 C.TEMPLATE_STATIC_DIR)
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	521 res = LiberviaRootResource(
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	522 host=self,
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	523 host_name=host_name,
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	524 site_name=site_name,
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	525 site_path=site_path,
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	526 path=root_path)
1153 94f9d81a475e pages: auto reloading Goffi <goffi@goffi.org> parents: 1152 diff changeset	527
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	528 existing_vhosts[encoded_site_name] = res
1191 ba45dcdbeeaf server: fixed sites alias: Goffi <goffi@goffi.org> parents: 1184 diff changeset	529
1364 df40708c4c76 server: renamed `--dev_mode` to `--dev-mode` and set it as a flag: Goffi <goffi@goffi.org> parents: 1362 diff changeset	530 if self.options['dev-mode']:
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	531 self.files_watcher.watch_dir(
1153 94f9d81a475e pages: auto reloading Goffi <goffi@goffi.org> parents: 1152 diff changeset	532 site_path, auto_add=True, recursive=True,
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	533 callback=LiberviaPage.on_file_change, site_root=res,
1514 16228994ca3b server: fix hot reloading of modules in dev mode Goffi <goffi@goffi.org> parents: 1512 diff changeset	534 # FIXME: site_path should always be a Path, check code above and
16228994ca3b server: fix hot reloading of modules in dev mode Goffi <goffi@goffi.org> parents: 1512 diff changeset	535 # in template module
16228994ca3b server: fix hot reloading of modules in dev mode Goffi <goffi@goffi.org> parents: 1512 diff changeset	536 site_path=Path(site_path))
1191 ba45dcdbeeaf server: fixed sites alias: Goffi <goffi@goffi.org> parents: 1184 diff changeset	537
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	538 LiberviaPage.import_pages(self, res)
1191 ba45dcdbeeaf server: fixed sites alias: Goffi <goffi@goffi.org> parents: 1184 diff changeset	539 # FIXME: default pages are accessible if not overriden by external website
ba45dcdbeeaf server: fixed sites alias: Goffi <goffi@goffi.org> parents: 1184 diff changeset	540 # while necessary for login or re-using existing pages
ba45dcdbeeaf server: fixed sites alias: Goffi <goffi@goffi.org> parents: 1184 diff changeset	541 # we may want to disable access to the page by direct URL
ba45dcdbeeaf server: fixed sites alias: Goffi <goffi@goffi.org> parents: 1184 diff changeset	542 # (e.g. /blog disabled except if called by external site)
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	543 LiberviaPage.import_pages(self, res, root_path=default_site_path)
1245 079e8eb6e327 server (tasks): refactoring: Goffi <goffi@goffi.org> parents: 1242 diff changeset	544 tasks_manager = TasksManager(self, res)
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	545 await tasks_manager.parse_tasks()
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	546 await tasks_manager.run_tasks()
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	547 await res._set_menu(self.options["menu_json"])
1191 ba45dcdbeeaf server: fixed sites alias: Goffi <goffi@goffi.org> parents: 1184 diff changeset	548
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	549 self.vhost_root.addHost(host_name.encode('utf-8'), res)
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	550
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	551 templates_res = web_resource.Resource()
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	552 self.put_child_all(C.TPL_RESOURCE.encode('utf-8'), templates_res)
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	553 for site_name, site_path in self.renderer.sites_paths.items():
1292 e30e96958fb7 server: use C.SITE_NAME_DEFAULT instead of "sat" when suitable Goffi <goffi@goffi.org> parents: 1287 diff changeset	554 templates_res.putChild(site_name.encode() or C.SITE_NAME_DEFAULT.encode(),
e30e96958fb7 server: use C.SITE_NAME_DEFAULT instead of "sat" when suitable Goffi <goffi@goffi.org> parents: 1287 diff changeset	555 static.File(site_path))
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	556
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	557 d = self.bridge_call("namespaces_get")
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	558 d.addCallback(self._namespaces_get_cb)
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	559 d.addErrback(self._namespaces_get_eb)
858 7dde76708892 server: URL redirections + misc: Goffi <goffi@goffi.org> parents: 856 diff changeset	560
995 f88325b56a6a server: dynamic pages first draft: Goffi <goffi@goffi.org> parents: 990 diff changeset	561 # websocket
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	562 if self.options["connection_type"] in ("https", "both"):
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	563 wss = websockets.LiberviaPageWSProtocol.get_resource(secure=True)
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	564 self.put_child_all(b'wss', wss)
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	565 if self.options["connection_type"] in ("http", "both"):
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	566 ws = websockets.LiberviaPageWSProtocol.get_resource(secure=False)
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	567 self.put_child_all(b'ws', ws)
995 f88325b56a6a server: dynamic pages first draft: Goffi <goffi@goffi.org> parents: 990 diff changeset	568
1512 65e063657597 server: move resources to a dedicated module Goffi <goffi@goffi.org> parents: 1509 diff changeset	569 # following signal is needed for cache handling in Libervia pages
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	570 self.bridge.register_signal(
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	571 "ps_event_raw", partial(LiberviaPage.on_node_event, self), "plugin"
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	572 )
1559 410064b31dca browser (calls): add some logs useful for debugging Goffi <goffi@goffi.org> parents: 1549 diff changeset	573
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	574 self.bridge.register_signal(
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	575 "message_new", partial(self.on_signal, "message_new")
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	576 )
1516 a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	577 self.bridge.register_signal(
1549 e47c24204449 browser (calls): update call to handle search, control buttons, and better UI/UX: Goffi <goffi@goffi.org> parents: 1522 diff changeset	578 "call_setup", partial(self.on_signal, "call_setup"), "plugin"
1516 a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	579 )
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	580 self.bridge.register_signal(
1560 84f312be53b4 browser (calls): handle "ringing" info message and update status when received Goffi <goffi@goffi.org> parents: 1559 diff changeset	581 "call_info", partial(self.on_signal, "call_info"), "plugin"
84f312be53b4 browser (calls): handle "ringing" info message and update status when received Goffi <goffi@goffi.org> parents: 1559 diff changeset	582 )
84f312be53b4 browser (calls): handle "ringing" info message and update status when received Goffi <goffi@goffi.org> parents: 1559 diff changeset	583 self.bridge.register_signal(
1516 a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	584 "call_ended", partial(self.on_signal, "call_ended"), "plugin"
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	585 )
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	586 self.bridge.register_signal(
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	587 "ice_candidates_new", partial(self.on_signal, "ice_candidates_new"), "plugin"
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	588 )
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	589 self.bridge.register_signal(
1559 410064b31dca browser (calls): add some logs useful for debugging Goffi <goffi@goffi.org> parents: 1549 diff changeset	590 "ice_restart", partial(self.on_signal, "ice_restart"), "plugin"
410064b31dca browser (calls): add some logs useful for debugging Goffi <goffi@goffi.org> parents: 1549 diff changeset	591 )
410064b31dca browser (calls): add some logs useful for debugging Goffi <goffi@goffi.org> parents: 1549 diff changeset	592 self.bridge.register_signal(
1516 a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	593 "action_new", self.action_new_handler,
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	594 )
917 86563d6c83b0 server: Libervia pages: Goffi <goffi@goffi.org> parents: 915 diff changeset	595
1505 a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	596 # libervia applications handling
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	597 self.bridge.register_signal(
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	598 "application_started", self.application_started_handler, "plugin"
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	599 )
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	600 self.bridge.register_signal(
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	601 "application_error", self.application_error_handler, "plugin"
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	602 )
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	603
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	604 # Progress handling
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	605 self.bridge.register_signal(
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	606 "progress_started", partial(ProgressHandler._signal, "started")
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	607 )
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	608 self.bridge.register_signal(
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	609 "progress_finished", partial(ProgressHandler._signal, "finished")
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	610 )
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	611 self.bridge.register_signal(
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	612 "progress_error", partial(ProgressHandler._signal, "error")
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	613 )
1063 4b69f69c6ffd server: new ProgressHandler helper class, to handle progressing actions Goffi <goffi@goffi.org> parents: 1055 diff changeset	614
914 0c0551967bdf server, browser: partial Libervia fix Goffi <goffi@goffi.org> parents: 913 diff changeset	615 # media dirs
0c0551967bdf server, browser: partial Libervia fix Goffi <goffi@goffi.org> parents: 913 diff changeset	616 # FIXME: get rid of dirname and "/" in C.XXX_DIR
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	617 self.put_child_all(os.path.dirname(C.MEDIA_DIR).encode('utf-8'),
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	618 ProtectedFile(self.media_dir))
1242 8f39d98416c5 server: added a child for common cache Goffi <goffi@goffi.org> parents: 1240 diff changeset	619
914 0c0551967bdf server, browser: partial Libervia fix Goffi <goffi@goffi.org> parents: 913 diff changeset	620 self.cache_resource = web_resource.NoResource()
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	621 self.put_child_all(C.CACHE_DIR.encode('utf-8'), self.cache_resource)
1242 8f39d98416c5 server: added a child for common cache Goffi <goffi@goffi.org> parents: 1240 diff changeset	622 self.cache_resource.putChild(
8f39d98416c5 server: added a child for common cache Goffi <goffi@goffi.org> parents: 1240 diff changeset	623 b"common", ProtectedFile(str(self.cache_root_dir / Path("common"))))
858 7dde76708892 server: URL redirections + misc: Goffi <goffi@goffi.org> parents: 856 diff changeset	624
1037 dc6c8c4d8ff6 server: redirection rework: Goffi <goffi@goffi.org> parents: 1019 diff changeset	625 # redirections
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	626 for root in self.roots:
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	627 await root._init_redirections(self.options)
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	628
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	629 # no need to keep url_redirections_dict, it will not be used anymore
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	630 del self.options["url_redirections_dict"]
858 7dde76708892 server: URL redirections + misc: Goffi <goffi@goffi.org> parents: 856 diff changeset	631
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	632 server.Request.defaultContentType = "text/html; charset=utf-8"
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	633 wrapped = web_resource.EncodingResourceWrapper(
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	634 self.vhost_root, [server.GzipEncoderFactory()]
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	635 )
914 0c0551967bdf server, browser: partial Libervia fix Goffi <goffi@goffi.org> parents: 913 diff changeset	636 self.site = server.Site(wrapped)
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	637 self.site.sessionFactory = WebSession
444 b64e528fb524 server side: use of bridge's getReady to be sure that backend is initialised at launch Goffi <goffi@goffi.org> parents: 438 diff changeset	638
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	639 def _bridge_cb(self):
1367 ce5cfe004d4e server: new `--bridge-retries` option: Goffi <goffi@goffi.org> parents: 1365 diff changeset	640 del self._bridge_retry
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	641 self.bridge.ready_get(
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	642 lambda: self.initialised.callback(None),
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	643 lambda failure: self.initialised.errback(Exception(failure)),
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	644 )
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	645 self.initialised.addCallback(lambda __: defer.ensureDeferred(self.backend_ready()))
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	646
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	647 def _bridge_eb(self, failure_):
1126 7cd89277a129 server: fixed missing backend detection Goffi <goffi@goffi.org> parents: 1124 diff changeset	648 if isinstance(failure_, BridgeExceptionNoService):
1367 ce5cfe004d4e server: new `--bridge-retries` option: Goffi <goffi@goffi.org> parents: 1365 diff changeset	649 if self._bridge_retry:
ce5cfe004d4e server: new `--bridge-retries` option: Goffi <goffi@goffi.org> parents: 1365 diff changeset	650 if self._bridge_retry < 0:
ce5cfe004d4e server: new `--bridge-retries` option: Goffi <goffi@goffi.org> parents: 1365 diff changeset	651 print(_("Can't connect to bridge, will retry indefinitely. "
ce5cfe004d4e server: new `--bridge-retries` option: Goffi <goffi@goffi.org> parents: 1365 diff changeset	652 "Next try in 1s."))
ce5cfe004d4e server: new `--bridge-retries` option: Goffi <goffi@goffi.org> parents: 1365 diff changeset	653 else:
ce5cfe004d4e server: new `--bridge-retries` option: Goffi <goffi@goffi.org> parents: 1365 diff changeset	654 self._bridge_retry -= 1
ce5cfe004d4e server: new `--bridge-retries` option: Goffi <goffi@goffi.org> parents: 1365 diff changeset	655 print(
ce5cfe004d4e server: new `--bridge-retries` option: Goffi <goffi@goffi.org> parents: 1365 diff changeset	656 _(
ce5cfe004d4e server: new `--bridge-retries` option: Goffi <goffi@goffi.org> parents: 1365 diff changeset	657 "Can't connect to bridge, will retry in 1 s ({retries_left} "
ce5cfe004d4e server: new `--bridge-retries` option: Goffi <goffi@goffi.org> parents: 1365 diff changeset	658 "trie(s) left)."
ce5cfe004d4e server: new `--bridge-retries` option: Goffi <goffi@goffi.org> parents: 1365 diff changeset	659 ).format(retries_left=self._bridge_retry)
ce5cfe004d4e server: new `--bridge-retries` option: Goffi <goffi@goffi.org> parents: 1365 diff changeset	660 )
ce5cfe004d4e server: new `--bridge-retries` option: Goffi <goffi@goffi.org> parents: 1365 diff changeset	661 time.sleep(1)
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	662 self.bridge.bridge_connect(callback=self._bridge_cb, errback=self._bridge_eb)
1367 ce5cfe004d4e server: new `--bridge-retries` option: Goffi <goffi@goffi.org> parents: 1365 diff changeset	663 return
ce5cfe004d4e server: new `--bridge-retries` option: Goffi <goffi@goffi.org> parents: 1365 diff changeset	664
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	665 print("Can't connect to SàT backend, are you sure it's launched ?")
1126 7cd89277a129 server: fixed missing backend detection Goffi <goffi@goffi.org> parents: 1124 diff changeset	666 else:
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	667 log.error("Can't connect to bridge: {}".format(failure))
1126 7cd89277a129 server: fixed missing backend detection Goffi <goffi@goffi.org> parents: 1124 diff changeset	668 sys.exit(1)
914 0c0551967bdf server, browser: partial Libervia fix Goffi <goffi@goffi.org> parents: 913 diff changeset	669
682 e6bb64bd6b4d server side: implemented methods to get SàT and Libervia versions Goffi <goffi@goffi.org> parents: 679 diff changeset	670 @property
e6bb64bd6b4d server side: implemented methods to get SàT and Libervia versions Goffi <goffi@goffi.org> parents: 679 diff changeset	671 def version(self):
e6bb64bd6b4d server side: implemented methods to get SàT and Libervia versions Goffi <goffi@goffi.org> parents: 679 diff changeset	672 """Return the short version of Libervia"""
e6bb64bd6b4d server side: implemented methods to get SàT and Libervia versions Goffi <goffi@goffi.org> parents: 679 diff changeset	673 return C.APP_VERSION
e6bb64bd6b4d server side: implemented methods to get SàT and Libervia versions Goffi <goffi@goffi.org> parents: 679 diff changeset	674
e6bb64bd6b4d server side: implemented methods to get SàT and Libervia versions Goffi <goffi@goffi.org> parents: 679 diff changeset	675 @property
e6bb64bd6b4d server side: implemented methods to get SàT and Libervia versions Goffi <goffi@goffi.org> parents: 679 diff changeset	676 def full_version(self):
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	677 """Return the full version of Libervia (with extra data when in dev mode)"""
682 e6bb64bd6b4d server side: implemented methods to get SàT and Libervia versions Goffi <goffi@goffi.org> parents: 679 diff changeset	678 version = self.version
1519 01b8d68edd70 version: use standard Python's `dev0` instead of Libervia specific `D` for dev version Goffi <goffi@goffi.org> parents: 1518 diff changeset	679 if version.split(".")[-1] == "dev0":
682 e6bb64bd6b4d server side: implemented methods to get SàT and Libervia versions Goffi <goffi@goffi.org> parents: 679 diff changeset	680 # we are in debug version, we add extra data
e6bb64bd6b4d server side: implemented methods to get SàT and Libervia versions Goffi <goffi@goffi.org> parents: 679 diff changeset	681 try:
e6bb64bd6b4d server side: implemented methods to get SàT and Libervia versions Goffi <goffi@goffi.org> parents: 679 diff changeset	682 return self._version_cache
e6bb64bd6b4d server side: implemented methods to get SàT and Libervia versions Goffi <goffi@goffi.org> parents: 679 diff changeset	683 except AttributeError:
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	684 self._version_cache = "{} ({})".format(
1518 eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	685 version, utils.get_repository_data(libervia.web)
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	686 )
682 e6bb64bd6b4d server side: implemented methods to get SàT and Libervia versions Goffi <goffi@goffi.org> parents: 679 diff changeset	687 return self._version_cache
e6bb64bd6b4d server side: implemented methods to get SàT and Libervia versions Goffi <goffi@goffi.org> parents: 679 diff changeset	688 else:
e6bb64bd6b4d server side: implemented methods to get SàT and Libervia versions Goffi <goffi@goffi.org> parents: 679 diff changeset	689 return version
e6bb64bd6b4d server side: implemented methods to get SàT and Libervia versions Goffi <goffi@goffi.org> parents: 679 diff changeset	690
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	691 def bridge_call(self, method_name, args, *kwargs):
935 c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	692 """Call an asynchronous bridge method and return a deferred
c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	693
c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	694 @param method_name: name of the method as a unicode
c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	695 @return: a deferred which trigger the result
c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	696
c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	697 """
c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	698 d = defer.Deferred()
c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	699
c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	700 def _callback(*args):
c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	701 if not args:
c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	702 d.callback(None)
c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	703 else:
c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	704 if len(args) != 1:
c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	705 Exception("Multiple return arguments not supported")
c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	706 d.callback(args[0])
c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	707
1138 ef565839dada server: don't convert failure in errback to jsonrpclib.Fault anymore: Goffi <goffi@goffi.org> parents: 1132 diff changeset	708 def _errback(failure_):
ef565839dada server: don't convert failure in errback to jsonrpclib.Fault anymore: Goffi <goffi@goffi.org> parents: 1132 diff changeset	709 d.errback(failure.Failure(failure_))
935 c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	710
c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	711 kwargs["callback"] = _callback
c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	712 kwargs["errback"] = _errback
c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	713 getattr(self.bridge, method_name)(args, *kwargs)
c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	714 return d
c3ae008f7a0f server: move asyncBridgeCall to Libervia.bridgeCall, this way async bridge calls can be used easily everywhere. Goffi <goffi@goffi.org> parents: 931 diff changeset	715
1516 a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	716 def action_new_handler(
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	717 self,
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	718 action_data_s: str,
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	719 action_id: str,
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	720 security_limit: int,
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	721 profile: str
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	722 ) -> None:
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	723 if security_limit > C.SECURITY_LIMIT:
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	724 log.debug(
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	725 f"ignoring action {action_id} due to security limit"
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	726 )
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	727 else:
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	728 self.on_signal(
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	729 "action_new", action_data_s, action_id, security_limit, profile
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	730 )
a3ca1bab6eb1 server, restricted bridge: add new methods and signals to prepare calls implementation: Goffi <goffi@goffi.org> parents: 1514 diff changeset	731
1504 409d10211b20 server, browser: dynamic pages refactoring: Goffi <goffi@goffi.org> parents: 1484 diff changeset	732 def on_signal(self, signal_name, *args):
409d10211b20 server, browser: dynamic pages refactoring: Goffi <goffi@goffi.org> parents: 1484 diff changeset	733 profile = args[-1]
409d10211b20 server, browser: dynamic pages refactoring: Goffi <goffi@goffi.org> parents: 1484 diff changeset	734 if not profile:
409d10211b20 server, browser: dynamic pages refactoring: Goffi <goffi@goffi.org> parents: 1484 diff changeset	735 log.error(f"got signal without profile: {signal_name}, {args}")
409d10211b20 server, browser: dynamic pages refactoring: Goffi <goffi@goffi.org> parents: 1484 diff changeset	736 return
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	737 session_iface.WebSession.send(
ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	738 profile,
ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	739 "bridge",
ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	740 {"signal": signal_name, "args": args}
ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	741 )
1504 409d10211b20 server, browser: dynamic pages refactoring: Goffi <goffi@goffi.org> parents: 1484 diff changeset	742
1505 a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	743 def application_started_handler(
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	744 self,
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	745 name: str,
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	746 instance_id: str,
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	747 extra_s: str
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	748 ) -> None:
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	749 callback = self.apps_cb.pop(instance_id, None)
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	750 if callback is not None:
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	751 defer.ensureDeferred(callback(str(name), str(instance_id)))
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	752
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	753 def application_error_handler(
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	754 self,
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	755 name: str,
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	756 instance_id: str,
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	757 extra_s: str
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	758 ) -> None:
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	759 callback = self.apps_cb.pop(instance_id, None)
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	760 if callback is not None:
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	761 extra = data_format.deserialise(extra_s)
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	762 log.error(
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	763 f"Can't start application {name}: {extra['class']}\n{extra['msg']}"
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	764 )
a169cbc315f0 server: don't wait anymore for libervia app to be fully started: Goffi <goffi@goffi.org> parents: 1504 diff changeset	765
1266 6b7f9c3558cc server, pages: better identities handling: Goffi <goffi@goffi.org> parents: 1258 diff changeset	766 async def _logged(self, profile, request):
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	767 """Set everything when a user just logged in
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	768
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	769 @param profile
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	770 @param request
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	771 @return: a constant indicating the state:
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	772 - C.PROFILE_LOGGED
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	773 - C.PROFILE_LOGGED_EXT_JID
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	774 @raise exceptions.ConflictError: session is already active
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	775 """
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	776 register_with_ext_jid = self.waiting_profiles.get_register_with_ext_jid(profile)
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	777 self.waiting_profiles.purge_request(profile)
1090 9c41b7e91172 server: set jid and started time in session on log-in: Goffi <goffi@goffi.org> parents: 1066 diff changeset	778 session = request.getSession()
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	779 web_session = session_iface.IWebSession(session)
ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	780 if web_session.profile:
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	781 log.error(_("/!\\ Session has already a profile, this should NEVER happen!"))
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	782 raise failure.Failure(exceptions.ConflictError("Already active"))
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	783
1305 db9ea167c409 pages: `profile` is now exposed to scripts Goffi <goffi@goffi.org> parents: 1293 diff changeset	784 # XXX: we force string because python D-Bus has its own string type (dbus.String)
db9ea167c409 pages: `profile` is now exposed to scripts Goffi <goffi@goffi.org> parents: 1293 diff changeset	785 # which may cause trouble when exposing it to scripts
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	786 web_session.profile = str(profile)
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	787 self.prof_connected.add(profile)
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	788 cache_dir = os.path.join(
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	789 self.cache_root_dir, "profiles", regex.path_escape(profile)
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	790 )
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	791 # FIXME: would be better to have a global /cache URL which redirect to
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	792 # profile's cache directory, without uuid
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	793 self.cache_resource.putChild(web_session.uuid.encode('utf-8'),
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	794 ProtectedFile(cache_dir))
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	795 log.debug(
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	796 _("profile cache resource added from {uuid} to {path}").format(
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	797 uuid=web_session.uuid, path=cache_dir
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	798 )
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	799 )
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	800
1504 409d10211b20 server, browser: dynamic pages refactoring: Goffi <goffi@goffi.org> parents: 1484 diff changeset	801 def on_expire():
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	802 log.info("Session expired (profile={profile})".format(profile=profile))
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	803 self.cache_resource.delEntity(web_session.uuid.encode('utf-8'))
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	804 log.debug(
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	805 _("profile cache resource {uuid} deleted").format(uuid=web_session.uuid)
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	806 )
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	807 web_session.on_expire()
ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	808 if web_session.ws_socket is not None:
ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	809 web_session.ws_socket.close()
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	810 # and now we disconnect the profile
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	811 self.bridge_call("disconnect", profile)
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	812
1504 409d10211b20 server, browser: dynamic pages refactoring: Goffi <goffi@goffi.org> parents: 1484 diff changeset	813 session.notifyOnExpire(on_expire)
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	814
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	815 # FIXME: those session infos should be returned by connect or is_connected
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	816 infos = await self.bridge_call("session_infos_get", profile)
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	817 web_session.jid = jid.JID(infos["jid"])
ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	818 own_bare_jid_s = web_session.jid.userhost()
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	819 own_id_raw = await self.bridge_call(
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	820 "identity_get", own_bare_jid_s, [], True, profile)
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	821 web_session.identities[own_bare_jid_s] = data_format.deserialise(own_id_raw)
ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	822 web_session.backend_started = int(infos["started"])
1090 9c41b7e91172 server: set jid and started time in session on log-in: Goffi <goffi@goffi.org> parents: 1066 diff changeset	823
9c41b7e91172 server: set jid and started time in session on log-in: Goffi <goffi@goffi.org> parents: 1066 diff changeset	824 state = C.PROFILE_LOGGED_EXT_JID if register_with_ext_jid else C.PROFILE_LOGGED
1266 6b7f9c3558cc server, pages: better identities handling: Goffi <goffi@goffi.org> parents: 1258 diff changeset	825 return state
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	826
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	827 @defer.inlineCallbacks
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	828 def connect(self, request, login, password):
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	829 """log user in
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	830
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	831 If an other user was already logged, it will be unlogged first
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	832 @param request(server.Request): request linked to the session
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	833 @param login(unicode): user login
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	834 can be profile name
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	835 can be profile@[libervia_domain.ext]
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	836 can be a jid (a new profile will be created with this jid if needed)
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	837 @param password(unicode): user password
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	838 @return (unicode, None): C.SESSION_ACTIVE: if session was aleady active else
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	839 self._logged value
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	840 @raise exceptions.DataError: invalid login
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	841 @raise exceptions.ProfileUnknownError: this login doesn't exist
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	842 @raise exceptions.PermissionError: a login is not accepted (e.g. empty password
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	843 not allowed)
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	844 @raise exceptions.NotReady: a profile connection is already waiting
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	845 @raise exceptions.TimeoutError: didn't received and answer from bridge
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	846 @raise exceptions.InternalError: unknown error
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	847 @raise ValueError(C.PROFILE_AUTH_ERROR): invalid login and/or password
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	848 @raise ValueError(C.XMPP_AUTH_ERROR): invalid XMPP account password
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	849 """
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	850
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	851 # XXX: all security checks must be done here, even if present in javascript
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	852 if login.startswith("@"):
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	853 raise failure.Failure(exceptions.DataError("No profile_key allowed"))
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	854
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	855 if login.startswith("guest@@") and login.count("@") == 2:
1100 5976dcd42591 pages (g): use server's connect method to connect instead of bridge, this way normal Libervia workflow is used, and session attributes are initialised. Goffi <goffi@goffi.org> parents: 1099 diff changeset	856 log.debug("logging a guest account")
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	857 elif "@" in login:
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	858 if login.count("@") != 1:
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	859 raise failure.Failure(
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	860 exceptions.DataError("Invalid login: {login}".format(login=login))
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	861 )
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	862 try:
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	863 login_jid = jid.JID(login)
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	864 except (RuntimeError, jid.InvalidFormat, AttributeError):
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	865 raise failure.Failure(exceptions.DataError("No profile_key allowed"))
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	866
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	867 # FIXME: should it be cached?
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	868 new_account_domain = yield self.bridge_call("account_domain_new_get")
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	869
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	870 if login_jid.host == new_account_domain:
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	871 # redirect "user@libervia.org" to the "user" profile
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	872 login = login_jid.user
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	873 login_jid = None
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	874 else:
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	875 login_jid = None
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	876
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	877 try:
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	878 profile = yield self.bridge_call("profile_name_get", login)
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	879 except Exception: # XXX: ProfileUnknownError wouldn't work, it's encapsulated
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	880 # FIXME: find a better way to handle bridge errors
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	881 if (
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	882 login_jid is not None and login_jid.user
1518 eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	883 ): # try to create a new libervia.backend profile using the XMPP credentials
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	884 if not self.options["allow_registration"]:
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	885 log.warning(
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	886 "Trying to register JID account while registration is not "
b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	887 "allowed")
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	888 raise failure.Failure(
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	889 exceptions.DataError(
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	890 "JID login while registration is not allowed"
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	891 )
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	892 )
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	893 profile = login # FIXME: what if there is a resource?
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	894 connect_method = "credentials_xmpp_connect"
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	895 register_with_ext_jid = True
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	896 else: # non existing username
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	897 raise failure.Failure(exceptions.ProfileUnknownError())
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	898 else:
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	899 if profile != login or (
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	900 not password
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	901 and profile
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	902 not in self.options["empty_password_allowed_warning_dangerous_list"]
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	903 ):
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	904 # profiles with empty passwords are restricted to local frontends
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	905 raise exceptions.PermissionError
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	906 register_with_ext_jid = False
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	907
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	908 connect_method = "connect"
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	909
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	910 # we check if there is not already an active session
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	911 web_session = session_iface.IWebSession(request.getSession())
ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	912 if web_session.profile:
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	913 # yes, there is
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	914 if web_session.profile != profile:
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	915 # it's a different profile, we need to disconnect it
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	916 log.warning(_(
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	917 "{new_profile} requested login, but {old_profile} was already "
b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	918 "connected, disconnecting {old_profile}").format(
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	919 old_profile=web_session.profile, new_profile=profile))
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	920 self.purge_session(request)
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	921
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	922 if self.waiting_profiles.get_request(profile):
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	923 # FIXME: check if and when this can happen
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	924 raise failure.Failure(exceptions.NotReady("Already waiting"))
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	925
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	926 self.waiting_profiles.set_request(request, profile, register_with_ext_jid)
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	927 try:
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	928 connected = yield self.bridge_call(connect_method, profile, password)
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	929 except Exception as failure_:
1204 a2df53dfbf46 server: handle unexpected exceptions on connect: Goffi <goffi@goffi.org> parents: 1203 diff changeset	930 fault = getattr(failure_, 'classname', None)
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	931 self.waiting_profiles.purge_request(profile)
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	932 if fault in ("PasswordError", "ProfileUnknownError"):
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	933 log.info("Profile {profile} doesn't exist or the submitted password is "
b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	934 "wrong".format( profile=profile))
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	935 raise failure.Failure(ValueError(C.PROFILE_AUTH_ERROR))
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	936 elif fault == "SASLAuthError":
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	937 log.info("The XMPP password of profile {profile} is wrong"
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	938 .format(profile=profile))
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	939 raise failure.Failure(ValueError(C.XMPP_AUTH_ERROR))
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	940 elif fault == "NoReply":
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	941 log.info(_("Did not receive a reply (the timeout expired or the "
b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	942 "connection is broken)"))
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	943 raise exceptions.TimeOutError
1204 a2df53dfbf46 server: handle unexpected exceptions on connect: Goffi <goffi@goffi.org> parents: 1203 diff changeset	944 elif fault is None:
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	945 log.info(_("Unexepected failure: {failure_}").format(failure_=failure))
1204 a2df53dfbf46 server: handle unexpected exceptions on connect: Goffi <goffi@goffi.org> parents: 1203 diff changeset	946 raise failure_
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	947 else:
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	948 log.error('Unmanaged fault class "{fault}" in errback for the '
b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	949 'connection of profile {profile}'.format(
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	950 fault=fault, profile=profile))
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	951 raise failure.Failure(exceptions.InternalError(fault))
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	952
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	953 if connected:
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	954 # profile is already connected in backend
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	955 # do we have a corresponding session in Libervia?
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	956 web_session = session_iface.IWebSession(request.getSession())
ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	957 if web_session.profile:
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	958 # yes, session is active
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	959 if web_session.profile != profile:
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	960 # existing session should have been ended above
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	961 # so this line should never be reached
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	962 log.error(_(
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	963 "session profile [{session_profile}] differs from login "
b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	964 "profile [{profile}], this should not happen!")
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	965 .format(session_profile=web_session.profile, profile=profile))
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	966 raise exceptions.InternalError("profile mismatch")
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	967 defer.returnValue(C.SESSION_ACTIVE)
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	968 log.info(
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	969 _(
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	970 "profile {profile} was already connected in backend".format(
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	971 profile=profile
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	972 )
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	973 )
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	974 )
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	975 # no, we have to create it
1090 9c41b7e91172 server: set jid and started time in session on log-in: Goffi <goffi@goffi.org> parents: 1066 diff changeset	976
1266 6b7f9c3558cc server, pages: better identities handling: Goffi <goffi@goffi.org> parents: 1258 diff changeset	977 state = yield defer.ensureDeferred(self._logged(profile, request))
1090 9c41b7e91172 server: set jid and started time in session on log-in: Goffi <goffi@goffi.org> parents: 1066 diff changeset	978 defer.returnValue(state)
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	979
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	980 def register_new_account(self, request, login, password, email):
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	981 """Create a new account, or return error
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	982 @param request(server.Request): request linked to the session
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	983 @param login(unicode): new account requested login
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	984 @param email(unicode): new account email
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	985 @param password(unicode): new account password
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	986 @return(unicode): a constant indicating the state:
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	987 - C.BAD_REQUEST: something is wrong in the request (bad arguments)
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	988 - C.INVALID_INPUT: one of the data is not valid
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	989 - C.REGISTRATION_SUCCEED: new account has been successfully registered
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	990 - C.ALREADY_EXISTS: the given profile already exists
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	991 - C.INTERNAL_ERROR or any unmanaged fault string
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	992 @raise PermissionError: registration is now allowed in server configuration
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	993 """
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	994 if not self.options["allow_registration"]:
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	995 log.warning(
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	996 _("Registration received while it is not allowed, hack attempt?")
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	997 )
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	998 raise failure.Failure(
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	999 exceptions.PermissionError("Registration is not allowed on this server")
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1000 )
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	1001
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1002 if (
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1003 not re.match(C.REG_LOGIN_RE, login)
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1004 or not re.match(C.REG_EMAIL_RE, email, re.IGNORECASE)
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1005 or len(password) < C.PASSWORD_MIN_LENGTH
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1006 ):
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	1007 return C.INVALID_INPUT
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	1008
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	1009 def registered(result):
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	1010 return C.REGISTRATION_SUCCEED
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	1011
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1012 def registering_error(failure_):
1164 ef3adc3f2078 handle invalid certificate on registration + fixed error handling on registration Goffi <goffi@goffi.org> parents: 1158 diff changeset	1013 # FIXME: better error handling for bridge error is needed
1184 eee7a896cf0e server: show BridgeException traceback on unknown registering status Goffi <goffi@goffi.org> parents: 1182 diff changeset	1014 status = failure_.value.fullname.split('.')[-1]
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	1015 if status == "ConflictError":
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	1016 return C.ALREADY_EXISTS
1164 ef3adc3f2078 handle invalid certificate on registration + fixed error handling on registration Goffi <goffi@goffi.org> parents: 1158 diff changeset	1017 elif status == "InvalidCertificate":
ef3adc3f2078 handle invalid certificate on registration + fixed error handling on registration Goffi <goffi@goffi.org> parents: 1158 diff changeset	1018 return C.INVALID_CERTIFICATE
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	1019 elif status == "InternalError":
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	1020 return C.INTERNAL_ERROR
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	1021 else:
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1022 log.error(
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1023 _("Unknown registering error status: {status}\n{traceback}").format(
1184 eee7a896cf0e server: show BridgeException traceback on unknown registering status Goffi <goffi@goffi.org> parents: 1182 diff changeset	1024 status=status, traceback=failure_.value.message
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1025 )
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1026 )
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	1027 return status
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	1028
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1029 d = self.bridge_call("libervia_account_register", email, password, login)
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	1030 d.addCallback(registered)
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1031 d.addErrback(registering_error)
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	1032 return d
22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	1033
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	1034 def addCleanup(self, callback, args, *kwargs):
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	1035 """Add cleaning method to call when service is stopped
961 22fe06569b1a server: moved logging worflow in separated method, so it can be used by Libervia Pages Goffi <goffi@goffi.org> parents: 959 diff changeset	1036
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	1037 cleaning method will be called in reverse order of they insertion
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	1038 @param callback: callable to call on service stop
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	1039 @param *args: list of arguments of the callback
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	1040 @param **kwargs: list of keyword arguments of the callback"""
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	1041 self._cleanup.insert(0, (callback, args, kwargs))
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	1042
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1043 def init_eb(self, failure):
1361 626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	1044 from twisted.application import app
626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	1045 if failure.check(SysExit):
626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	1046 if failure.value.message:
626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	1047 log.error(failure.value.message)
626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	1048 app._exitCode = failure.value.exit_code
626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	1049 reactor.stop()
626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	1050 else:
626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	1051 log.error(_("Init error: {msg}").format(msg=failure))
626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	1052 app._exitCode = C.EXIT_INTERNAL_ERROR
626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	1053 reactor.stop()
626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	1054 return failure
626b7bbb7f90 server: mechanism to exit Libervia with an exit code: Goffi <goffi@goffi.org> parents: 1360 diff changeset	1055
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1056 def _build_only_cb(self, __):
1368 9624c2a89a92 server: new `--build-only` flag: Goffi <goffi@goffi.org> parents: 1367 diff changeset	1057 log.info(_("Stopping here due to --build-only flag"))
9624c2a89a92 server: new `--build-only` flag: Goffi <goffi@goffi.org> parents: 1367 diff changeset	1058 self.stop()
9624c2a89a92 server: new `--build-only` flag: Goffi <goffi@goffi.org> parents: 1367 diff changeset	1059
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	1060 def startService(self):
446 c406e46fe9c0 server_side: update the connection mechanism to handle profile passwords souliane <souliane@mailoo.org> parents: 445 diff changeset	1061 """Connect the profile for Libervia and start the HTTP(S) server(s)"""
1236 352e189ab7f8 server: avoid double init Goffi <goffi@goffi.org> parents: 1235 diff changeset	1062 self._init()
1368 9624c2a89a92 server: new `--build-only` flag: Goffi <goffi@goffi.org> parents: 1367 diff changeset	1063 if self.options['build-only']:
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1064 self.initialised.addCallback(self._build_only_cb)
1368 9624c2a89a92 server: new `--build-only` flag: Goffi <goffi@goffi.org> parents: 1367 diff changeset	1065 else:
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1066 self.initialised.addCallback(self._start_service)
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1067 self.initialised.addErrback(self.init_eb)
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	1068
914 0c0551967bdf server, browser: partial Libervia fix Goffi <goffi@goffi.org> parents: 913 diff changeset	1069 ## URLs ##
919 7b267496da1d server: moved session interfaces to session_iface module + added SATGuestSession Goffi <goffi@goffi.org> parents: 917 diff changeset	1070
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1071 def put_child_sat(self, path, resource):
1518 eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	1072 """Add a child to the libervia.backend resource"""
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1073 if not isinstance(path, bytes):
b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1074 raise ValueError("path must be specified in bytes")
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	1075 self.sat_root.putChild(path, resource)
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	1076
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1077 def put_child_all(self, path, resource):
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	1078 """Add a child to all vhost root resources"""
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1079 if not isinstance(path, bytes):
b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1080 raise ValueError("path must be specified in bytes")
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	1081 # we wrap before calling putChild, to avoid having useless multiple instances
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	1082 # of the resource
914 0c0551967bdf server, browser: partial Libervia fix Goffi <goffi@goffi.org> parents: 913 diff changeset	1083 # FIXME: check that no information is leaked (c.f. https://twistedmatrix.com/documents/current/web/howto/using-twistedweb.html#request-encoders)
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	1084 wrapped_res = web_resource.EncodingResourceWrapper(
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	1085 resource, [server.GzipEncoderFactory()])
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	1086 for root in self.roots:
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	1087 root.putChild(path, wrapped_res)
914 0c0551967bdf server, browser: partial Libervia fix Goffi <goffi@goffi.org> parents: 913 diff changeset	1088
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1089 def get_build_path(self, site_name: str, dev: bool=False) -> Path:
1146 76d75423ef53 server: tasks manager first draft: Goffi <goffi@goffi.org> parents: 1144 diff changeset	1090 """Generate build path for a given site name
76d75423ef53 server: tasks manager first draft: Goffi <goffi@goffi.org> parents: 1144 diff changeset	1091
1257 1ec41ac1e7cf server: seperation between production build dir and dev build dir: Goffi <goffi@goffi.org> parents: 1256 diff changeset	1092 @param site_name: name of the site
1ec41ac1e7cf server: seperation between production build dir and dev build dir: Goffi <goffi@goffi.org> parents: 1256 diff changeset	1093 @param dev: return dev build dir if True, production one otherwise
1ec41ac1e7cf server: seperation between production build dir and dev build dir: Goffi <goffi@goffi.org> parents: 1256 diff changeset	1094 dev build dir is used for installing dependencies needed temporarily (e.g.
1ec41ac1e7cf server: seperation between production build dir and dev build dir: Goffi <goffi@goffi.org> parents: 1256 diff changeset	1095 to compile files), while production build path is the one served by the
1ec41ac1e7cf server: seperation between production build dir and dev build dir: Goffi <goffi@goffi.org> parents: 1256 diff changeset	1096 HTTP server, where final files are downloaded.
1ec41ac1e7cf server: seperation between production build dir and dev build dir: Goffi <goffi@goffi.org> parents: 1256 diff changeset	1097 @return: path to the build directory
1146 76d75423ef53 server: tasks manager first draft: Goffi <goffi@goffi.org> parents: 1144 diff changeset	1098 """
1257 1ec41ac1e7cf server: seperation between production build dir and dev build dir: Goffi <goffi@goffi.org> parents: 1256 diff changeset	1099 sub_dir = C.DEV_BUILD_DIR if dev else C.PRODUCTION_BUILD_DIR
1146 76d75423ef53 server: tasks manager first draft: Goffi <goffi@goffi.org> parents: 1144 diff changeset	1100 build_path_elts = [
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1101 config.config_get(self.main_conf, "", "local_dir"),
1146 76d75423ef53 server: tasks manager first draft: Goffi <goffi@goffi.org> parents: 1144 diff changeset	1102 C.CACHE_DIR,
76d75423ef53 server: tasks manager first draft: Goffi <goffi@goffi.org> parents: 1144 diff changeset	1103 C.LIBERVIA_CACHE,
1257 1ec41ac1e7cf server: seperation between production build dir and dev build dir: Goffi <goffi@goffi.org> parents: 1256 diff changeset	1104 sub_dir,
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1105 regex.path_escape(site_name or C.SITE_NAME_DEFAULT)]
1246 aaf28d45ae67 pages: browser code, first draft: Goffi <goffi@goffi.org> parents: 1245 diff changeset	1106 build_path = Path("/".join(build_path_elts))
aaf28d45ae67 pages: browser code, first draft: Goffi <goffi@goffi.org> parents: 1245 diff changeset	1107 return build_path.expanduser().resolve()
1146 76d75423ef53 server: tasks manager first draft: Goffi <goffi@goffi.org> parents: 1144 diff changeset	1108
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1109 def get_ext_base_url_data(self, request):
1006 d0b27d1e2d50 server: moved code to retrieve external server from legacy blog to server.py, and use it to find websocket URL Goffi <goffi@goffi.org> parents: 1003 diff changeset	1110 """Retrieve external base URL Data
d0b27d1e2d50 server: moved code to retrieve external server from legacy blog to server.py, and use it to find websocket URL Goffi <goffi@goffi.org> parents: 1003 diff changeset	1111
1435 396d5606477f server (proxy): add "Forwarded" and "X-Forwarded-xxx" headers to reverse proxy Goffi <goffi@goffi.org> parents: 1397 diff changeset	1112 this method try to retrieve the base URL found by external user
1006 d0b27d1e2d50 server: moved code to retrieve external server from legacy blog to server.py, and use it to find websocket URL Goffi <goffi@goffi.org> parents: 1003 diff changeset	1113 It does by checking in this order:
d0b27d1e2d50 server: moved code to retrieve external server from legacy blog to server.py, and use it to find websocket URL Goffi <goffi@goffi.org> parents: 1003 diff changeset	1114 - base_url_ext option from configuration
d0b27d1e2d50 server: moved code to retrieve external server from legacy blog to server.py, and use it to find websocket URL Goffi <goffi@goffi.org> parents: 1003 diff changeset	1115 - proxy x-forwarder-host headers
d0b27d1e2d50 server: moved code to retrieve external server from legacy blog to server.py, and use it to find websocket URL Goffi <goffi@goffi.org> parents: 1003 diff changeset	1116 - URL of the request
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	1117 @return (urlparse.SplitResult): SplitResult instance with only scheme and
6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	1118 netloc filled
1006 d0b27d1e2d50 server: moved code to retrieve external server from legacy blog to server.py, and use it to find websocket URL Goffi <goffi@goffi.org> parents: 1003 diff changeset	1119 """
d0b27d1e2d50 server: moved code to retrieve external server from legacy blog to server.py, and use it to find websocket URL Goffi <goffi@goffi.org> parents: 1003 diff changeset	1120 ext_data = self.base_url_ext_data
d0b27d1e2d50 server: moved code to retrieve external server from legacy blog to server.py, and use it to find websocket URL Goffi <goffi@goffi.org> parents: 1003 diff changeset	1121 url_path = request.URLPath()
1467 d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1122
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1123 try:
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1124 forwarded = request.requestHeaders.getRawHeaders(
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1125 "forwarded"
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1126 )[0]
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1127 except TypeError:
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1128 # we try deprecated headers
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1129 try:
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1130 proxy_netloc = request.requestHeaders.getRawHeaders(
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1131 "x-forwarded-host"
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1132 )[0]
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1133 except TypeError:
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1134 proxy_netloc = None
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1135 try:
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1136 proxy_scheme = request.requestHeaders.getRawHeaders(
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1137 "x-forwarded-proto"
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1138 )[0]
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1139 except TypeError:
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1140 proxy_scheme = None
1006 d0b27d1e2d50 server: moved code to retrieve external server from legacy blog to server.py, and use it to find websocket URL Goffi <goffi@goffi.org> parents: 1003 diff changeset	1141 else:
1467 d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1142 fwd_data = {
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1143 k.strip(): v.strip()
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1144 for k,v in (d.split("=") for d in forwarded.split(";"))
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1145 }
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1146 proxy_netloc = fwd_data.get("host")
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1147 proxy_scheme = fwd_data.get("proto")
1006 d0b27d1e2d50 server: moved code to retrieve external server from legacy blog to server.py, and use it to find websocket URL Goffi <goffi@goffi.org> parents: 1003 diff changeset	1148
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1149 return urllib.parse.SplitResult(
1467 d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1150 ext_data.scheme or proxy_scheme or url_path.scheme.decode(),
d6062cccd4c0 server: better reverse proxy headers handling: Goffi <goffi@goffi.org> parents: 1462 diff changeset	1151 ext_data.netloc or proxy_netloc or url_path.netloc.decode(),
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1152 ext_data.path or "/",
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1153 "",
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1154 "",
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1155 )
1006 d0b27d1e2d50 server: moved code to retrieve external server from legacy blog to server.py, and use it to find websocket URL Goffi <goffi@goffi.org> parents: 1003 diff changeset	1156
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1157 def get_ext_base_url(
1459 47db314e60ca server: `getExtBaseURL` type hints Goffi <goffi@goffi.org> parents: 1458 diff changeset	1158 self,
47db314e60ca server: `getExtBaseURL` type hints Goffi <goffi@goffi.org> parents: 1458 diff changeset	1159 request: server.Request,
47db314e60ca server: `getExtBaseURL` type hints Goffi <goffi@goffi.org> parents: 1458 diff changeset	1160 path: str = "",
47db314e60ca server: `getExtBaseURL` type hints Goffi <goffi@goffi.org> parents: 1458 diff changeset	1161 query: str = "",
47db314e60ca server: `getExtBaseURL` type hints Goffi <goffi@goffi.org> parents: 1458 diff changeset	1162 fragment: str = "",
47db314e60ca server: `getExtBaseURL` type hints Goffi <goffi@goffi.org> parents: 1458 diff changeset	1163 scheme: Optional[str] = None,
47db314e60ca server: `getExtBaseURL` type hints Goffi <goffi@goffi.org> parents: 1458 diff changeset	1164 ) -> str:
1006 d0b27d1e2d50 server: moved code to retrieve external server from legacy blog to server.py, and use it to find websocket URL Goffi <goffi@goffi.org> parents: 1003 diff changeset	1165 """Get external URL according to given elements
d0b27d1e2d50 server: moved code to retrieve external server from legacy blog to server.py, and use it to find websocket URL Goffi <goffi@goffi.org> parents: 1003 diff changeset	1166
d0b27d1e2d50 server: moved code to retrieve external server from legacy blog to server.py, and use it to find websocket URL Goffi <goffi@goffi.org> parents: 1003 diff changeset	1167 external URL is the URL seen by external user
1459 47db314e60ca server: `getExtBaseURL` type hints Goffi <goffi@goffi.org> parents: 1458 diff changeset	1168 @param path: same as for urlsplit.urlsplit
1006 d0b27d1e2d50 server: moved code to retrieve external server from legacy blog to server.py, and use it to find websocket URL Goffi <goffi@goffi.org> parents: 1003 diff changeset	1169 path will be prefixed to follow found external URL if suitable
1459 47db314e60ca server: `getExtBaseURL` type hints Goffi <goffi@goffi.org> parents: 1458 diff changeset	1170 @param params: same as for urlsplit.urlsplit
47db314e60ca server: `getExtBaseURL` type hints Goffi <goffi@goffi.org> parents: 1458 diff changeset	1171 @param query: same as for urlsplit.urlsplit
47db314e60ca server: `getExtBaseURL` type hints Goffi <goffi@goffi.org> parents: 1458 diff changeset	1172 @param fragment: same as for urlsplit.urlsplit
47db314e60ca server: `getExtBaseURL` type hints Goffi <goffi@goffi.org> parents: 1458 diff changeset	1173 @param scheme: if not None, will override scheme from base URL
47db314e60ca server: `getExtBaseURL` type hints Goffi <goffi@goffi.org> parents: 1458 diff changeset	1174 @return: external URL
1006 d0b27d1e2d50 server: moved code to retrieve external server from legacy blog to server.py, and use it to find websocket URL Goffi <goffi@goffi.org> parents: 1003 diff changeset	1175 """
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1176 split_result = self.get_ext_base_url_data(request)
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1177 return urllib.parse.urlunsplit(
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1178 (
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1179 split_result.scheme if scheme is None else scheme,
b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1180 split_result.netloc,
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1181 os.path.join(split_result.path, path),
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1182 query,
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1183 fragment,
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1184 )
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1185 )
1006 d0b27d1e2d50 server: moved code to retrieve external server from legacy blog to server.py, and use it to find websocket URL Goffi <goffi@goffi.org> parents: 1003 diff changeset	1186
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1187 def check_redirection(self, vhost_root: LiberviaRootResource, url_path: str) -> str:
1037 dc6c8c4d8ff6 server: redirection rework: Goffi <goffi@goffi.org> parents: 1019 diff changeset	1188 """check is a part of the URL prefix is redirected then replace it
dc6c8c4d8ff6 server: redirection rework: Goffi <goffi@goffi.org> parents: 1019 diff changeset	1189
1458 db13f5c768a0 server: `checkRedirection`: fix range variable + type hints + arg name: Goffi <goffi@goffi.org> parents: 1457 diff changeset	1190 @param vhost_root: root of this virtual host
db13f5c768a0 server: `checkRedirection`: fix range variable + type hints + arg name: Goffi <goffi@goffi.org> parents: 1457 diff changeset	1191 @param url_path: path of the url to check
db13f5c768a0 server: `checkRedirection`: fix range variable + type hints + arg name: Goffi <goffi@goffi.org> parents: 1457 diff changeset	1192 @return: possibly redirected URL which should link to the same location
1037 dc6c8c4d8ff6 server: redirection rework: Goffi <goffi@goffi.org> parents: 1019 diff changeset	1193 """
1128 6414fd795df4 server, pages: multi-sites refactoring: Goffi <goffi@goffi.org> parents: 1127 diff changeset	1194 inv_redirections = vhost_root.inv_redirections
1458 db13f5c768a0 server: `checkRedirection`: fix range variable + type hints + arg name: Goffi <goffi@goffi.org> parents: 1457 diff changeset	1195 url_parts = url_path.strip("/").split("/")
1475 83cd4862b134 server: fix args range in checkRedirection Goffi <goffi@goffi.org> parents: 1467 diff changeset	1196 for idx in range(len(url_parts), -1, -1):
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1197 test_url = "/" + "/".join(url_parts[:idx])
1037 dc6c8c4d8ff6 server: redirection rework: Goffi <goffi@goffi.org> parents: 1019 diff changeset	1198 if test_url in inv_redirections:
dc6c8c4d8ff6 server: redirection rework: Goffi <goffi@goffi.org> parents: 1019 diff changeset	1199 rem_url = url_parts[idx:]
1099 ea0d41ef3719 server: return absolute page in checkRedirection Goffi <goffi@goffi.org> parents: 1098 diff changeset	1200 return os.path.join(
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1201 "/", "/".join([inv_redirections[test_url]] + rem_url)
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1202 )
1458 db13f5c768a0 server: `checkRedirection`: fix range variable + type hints + arg name: Goffi <goffi@goffi.org> parents: 1457 diff changeset	1203 return url_path
1006 d0b27d1e2d50 server: moved code to retrieve external server from legacy blog to server.py, and use it to find websocket URL Goffi <goffi@goffi.org> parents: 1003 diff changeset	1204
920 8cea8bf41b03 server: new purgeSession and getSessionData helper methods Goffi <goffi@goffi.org> parents: 919 diff changeset	1205 ## Sessions ##
8cea8bf41b03 server: new purgeSession and getSessionData helper methods Goffi <goffi@goffi.org> parents: 919 diff changeset	1206
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1207 def purge_session(self, request):
920 8cea8bf41b03 server: new purgeSession and getSessionData helper methods Goffi <goffi@goffi.org> parents: 919 diff changeset	1208 """helper method to purge a session during request handling"""
8cea8bf41b03 server: new purgeSession and getSessionData helper methods Goffi <goffi@goffi.org> parents: 919 diff changeset	1209 session = request.session
8cea8bf41b03 server: new purgeSession and getSessionData helper methods Goffi <goffi@goffi.org> parents: 919 diff changeset	1210 if session is not None:
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1211 log.debug(_("session purge"))
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1212 web_session = self.get_session_data(request, session_iface.IWebSession)
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	1213 socket = web_session.ws_socket
1504 409d10211b20 server, browser: dynamic pages refactoring: Goffi <goffi@goffi.org> parents: 1484 diff changeset	1214 if socket is not None:
409d10211b20 server, browser: dynamic pages refactoring: Goffi <goffi@goffi.org> parents: 1484 diff changeset	1215 socket.close()
409d10211b20 server, browser: dynamic pages refactoring: Goffi <goffi@goffi.org> parents: 1484 diff changeset	1216 session.ws_socket = None
920 8cea8bf41b03 server: new purgeSession and getSessionData helper methods Goffi <goffi@goffi.org> parents: 919 diff changeset	1217 session.expire()
8cea8bf41b03 server: new purgeSession and getSessionData helper methods Goffi <goffi@goffi.org> parents: 919 diff changeset	1218 # FIXME: not clean but it seems that it's the best way to reset
8cea8bf41b03 server: new purgeSession and getSessionData helper methods Goffi <goffi@goffi.org> parents: 919 diff changeset	1219 # session during request handling
8cea8bf41b03 server: new purgeSession and getSessionData helper methods Goffi <goffi@goffi.org> parents: 919 diff changeset	1220 request._secureSession = request._insecureSession = None
8cea8bf41b03 server: new purgeSession and getSessionData helper methods Goffi <goffi@goffi.org> parents: 919 diff changeset	1221
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1222 def get_session_data(self, request, *args):
920 8cea8bf41b03 server: new purgeSession and getSessionData helper methods Goffi <goffi@goffi.org> parents: 919 diff changeset	1223 """helper method to retrieve session data
8cea8bf41b03 server: new purgeSession and getSessionData helper methods Goffi <goffi@goffi.org> parents: 919 diff changeset	1224
8cea8bf41b03 server: new purgeSession and getSessionData helper methods Goffi <goffi@goffi.org> parents: 919 diff changeset	1225 @param request(server.Request): request linked to the session
8cea8bf41b03 server: new purgeSession and getSessionData helper methods Goffi <goffi@goffi.org> parents: 919 diff changeset	1226 @param *args(zope.interface.Interface): interface of the session to get
8cea8bf41b03 server: new purgeSession and getSessionData helper methods Goffi <goffi@goffi.org> parents: 919 diff changeset	1227 @return (iterator(data)): requested session data
8cea8bf41b03 server: new purgeSession and getSessionData helper methods Goffi <goffi@goffi.org> parents: 919 diff changeset	1228 """
8cea8bf41b03 server: new purgeSession and getSessionData helper methods Goffi <goffi@goffi.org> parents: 919 diff changeset	1229 session = request.getSession()
924 94f88277c2e7 libervia (pages): getSessionData return one session if used with one argument, else an iterator Goffi <goffi@goffi.org> parents: 923 diff changeset	1230 if len(args) == 1:
94f88277c2e7 libervia (pages): getSessionData return one session if used with one argument, else an iterator Goffi <goffi@goffi.org> parents: 923 diff changeset	1231 return args[0](session)
94f88277c2e7 libervia (pages): getSessionData return one session if used with one argument, else an iterator Goffi <goffi@goffi.org> parents: 923 diff changeset	1232 else:
94f88277c2e7 libervia (pages): getSessionData return one session if used with one argument, else an iterator Goffi <goffi@goffi.org> parents: 923 diff changeset	1233 return (iface(session) for iface in args)
920 8cea8bf41b03 server: new purgeSession and getSessionData helper methods Goffi <goffi@goffi.org> parents: 919 diff changeset	1234
1093 eda7a1c6532a server: new getAffiliation method: Goffi <goffi@goffi.org> parents: 1090 diff changeset	1235 @defer.inlineCallbacks
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1236 def get_affiliation(self, request, service, node):
1093 eda7a1c6532a server: new getAffiliation method: Goffi <goffi@goffi.org> parents: 1090 diff changeset	1237 """retrieve pubsub node affiliation for current user
eda7a1c6532a server: new getAffiliation method: Goffi <goffi@goffi.org> parents: 1090 diff changeset	1238
eda7a1c6532a server: new getAffiliation method: Goffi <goffi@goffi.org> parents: 1090 diff changeset	1239 use cache first, and request pubsub service if not cache is found
eda7a1c6532a server: new getAffiliation method: Goffi <goffi@goffi.org> parents: 1090 diff changeset	1240 @param request(server.Request): request linked to the session
eda7a1c6532a server: new getAffiliation method: Goffi <goffi@goffi.org> parents: 1090 diff changeset	1241 @param service(jid.JID): pubsub service
eda7a1c6532a server: new getAffiliation method: Goffi <goffi@goffi.org> parents: 1090 diff changeset	1242 @param node(unicode): pubsub node
eda7a1c6532a server: new getAffiliation method: Goffi <goffi@goffi.org> parents: 1090 diff changeset	1243 @return (unicode): affiliation
eda7a1c6532a server: new getAffiliation method: Goffi <goffi@goffi.org> parents: 1090 diff changeset	1244 """
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1245 web_session = self.get_session_data(request, session_iface.IWebSession)
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	1246 if web_session.profile is None:
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1247 raise exceptions.InternalError("profile must be set to use this method")
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1248 affiliation = web_session.get_affiliation(service, node)
1093 eda7a1c6532a server: new getAffiliation method: Goffi <goffi@goffi.org> parents: 1090 diff changeset	1249 if affiliation is not None:
eda7a1c6532a server: new getAffiliation method: Goffi <goffi@goffi.org> parents: 1090 diff changeset	1250 defer.returnValue(affiliation)
eda7a1c6532a server: new getAffiliation method: Goffi <goffi@goffi.org> parents: 1090 diff changeset	1251 else:
eda7a1c6532a server: new getAffiliation method: Goffi <goffi@goffi.org> parents: 1090 diff changeset	1252 try:
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1253 affiliations = yield self.bridge_call(
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1254 "ps_affiliations_get", service.full(), node, web_session.profile
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1255 )
1093 eda7a1c6532a server: new getAffiliation method: Goffi <goffi@goffi.org> parents: 1090 diff changeset	1256 except Exception as e:
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1257 log.warning(
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1258 "Can't retrieve affiliation for {service}/{node}: {reason}".format(
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1259 service=service, node=node, reason=e
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1260 )
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1261 )
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1262 affiliation = ""
1093 eda7a1c6532a server: new getAffiliation method: Goffi <goffi@goffi.org> parents: 1090 diff changeset	1263 else:
eda7a1c6532a server: new getAffiliation method: Goffi <goffi@goffi.org> parents: 1090 diff changeset	1264 try:
eda7a1c6532a server: new getAffiliation method: Goffi <goffi@goffi.org> parents: 1090 diff changeset	1265 affiliation = affiliations[node]
eda7a1c6532a server: new getAffiliation method: Goffi <goffi@goffi.org> parents: 1090 diff changeset	1266 except KeyError:
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1267 affiliation = ""
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1268 web_session.set_affiliation(service, node, affiliation)
1093 eda7a1c6532a server: new getAffiliation method: Goffi <goffi@goffi.org> parents: 1090 diff changeset	1269 defer.returnValue(affiliation)
eda7a1c6532a server: new getAffiliation method: Goffi <goffi@goffi.org> parents: 1090 diff changeset	1270
995 f88325b56a6a server: dynamic pages first draft: Goffi <goffi@goffi.org> parents: 990 diff changeset	1271 ## Websocket (dynamic pages) ##
f88325b56a6a server: dynamic pages first draft: Goffi <goffi@goffi.org> parents: 990 diff changeset	1272
1504 409d10211b20 server, browser: dynamic pages refactoring: Goffi <goffi@goffi.org> parents: 1484 diff changeset	1273 def get_websocket_url(self, request):
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1274 base_url_split = self.get_ext_base_url_data(request)
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1275 if base_url_split.scheme.endswith("s"):
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1276 scheme = "wss"
995 f88325b56a6a server: dynamic pages first draft: Goffi <goffi@goffi.org> parents: 990 diff changeset	1277 else:
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1278 scheme = "ws"
995 f88325b56a6a server: dynamic pages first draft: Goffi <goffi@goffi.org> parents: 990 diff changeset	1279
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1280 return self.get_ext_base_url(request, path=scheme, scheme=scheme)
995 f88325b56a6a server: dynamic pages first draft: Goffi <goffi@goffi.org> parents: 990 diff changeset	1281
f88325b56a6a server: dynamic pages first draft: Goffi <goffi@goffi.org> parents: 990 diff changeset	1282
1019 34240d08f682 pages: HTTP cache headers handling: Goffi <goffi@goffi.org> parents: 1012 diff changeset	1283 ## Various utils ##
34240d08f682 pages: HTTP cache headers handling: Goffi <goffi@goffi.org> parents: 1012 diff changeset	1284
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1285 def get_http_date(self, timestamp=None):
1019 34240d08f682 pages: HTTP cache headers handling: Goffi <goffi@goffi.org> parents: 1012 diff changeset	1286 now = time.gmtime(timestamp)
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1287 fmt_date = "{day_name}, %d {month_name} %Y %H:%M:%S GMT".format(
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1288 day_name=C.HTTP_DAYS[now.tm_wday], month_name=C.HTTP_MONTH[now.tm_mon - 1]
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1289 )
1019 34240d08f682 pages: HTTP cache headers handling: Goffi <goffi@goffi.org> parents: 1012 diff changeset	1290 return time.strftime(fmt_date, now)
34240d08f682 pages: HTTP cache headers handling: Goffi <goffi@goffi.org> parents: 1012 diff changeset	1291
813 6e27604ec95a server: added --tls_private_key and --tls_chain options. --tls_certificate .pem file will be used for private_key if --tls_private_key is not specified. Goffi <goffi@goffi.org> parents: 812 diff changeset	1292 ## service management ##
6e27604ec95a server: added --tls_private_key and --tls_chain options. --tls_certificate .pem file will be used for private_key if --tls_private_key is not specified. Goffi <goffi@goffi.org> parents: 812 diff changeset	1293
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1294 def _start_service(self, __=None):
449 981ed669d3b3 /!\ reorganize all the file hierarchy, move the code and launching script to src: souliane <souliane@mailoo.org> parents: 448 diff changeset	1295 """Actually start the HTTP(S) server(s) after the profile for Libervia is connected.
813 6e27604ec95a server: added --tls_private_key and --tls_chain options. --tls_certificate .pem file will be used for private_key if --tls_private_key is not specified. Goffi <goffi@goffi.org> parents: 812 diff changeset	1296
6e27604ec95a server: added --tls_private_key and --tls_chain options. --tls_certificate .pem file will be used for private_key if --tls_private_key is not specified. Goffi <goffi@goffi.org> parents: 812 diff changeset	1297 @raise ImportError: OpenSSL is not available
449 981ed669d3b3 /!\ reorganize all the file hierarchy, move the code and launching script to src: souliane <souliane@mailoo.org> parents: 448 diff changeset	1298 @raise IOError: the certificate file doesn't exist
981ed669d3b3 /!\ reorganize all the file hierarchy, move the code and launching script to src: souliane <souliane@mailoo.org> parents: 448 diff changeset	1299 @raise OpenSSL.crypto.Error: the certificate file is invalid
981ed669d3b3 /!\ reorganize all the file hierarchy, move the code and launching script to src: souliane <souliane@mailoo.org> parents: 448 diff changeset	1300 """
950 67a59552f3e3 server (blog): fixed avatars handling, there is now a well-known URL to SERVICE_PROFILE cache Goffi <goffi@goffi.org> parents: 937 diff changeset	1301 # now that we have service profile connected, we add resource for its cache
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1302 service_path = regex.path_escape(C.SERVICE_PROFILE)
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1303 cache_dir = os.path.join(self.cache_root_dir, "profiles", service_path)
b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1304 self.cache_resource.putChild(service_path.encode('utf-8'),
b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1305 ProtectedFile(cache_dir))
b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1306 self.service_cache_url = "/" + os.path.join(C.CACHE_DIR, service_path)
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	1307 session_iface.WebSession.service_cache_url = self.service_cache_url
950 67a59552f3e3 server (blog): fixed avatars handling, there is now a well-known URL to SERVICE_PROFILE cache Goffi <goffi@goffi.org> parents: 937 diff changeset	1308
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1309 if self.options["connection_type"] in ("https", "both"):
1274 eb4f03da0d7d server: re-usable Twisted TLS code has been moved to SàT backend Goffi <goffi@goffi.org> parents: 1268 diff changeset	1310 try:
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1311 tls.tls_options_check(self.options)
106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1312 context_factory = tls.get_tls_context_factory(self.options)
1274 eb4f03da0d7d server: re-usable Twisted TLS code has been moved to SàT backend Goffi <goffi@goffi.org> parents: 1268 diff changeset	1313 except exceptions.ConfigError as e:
eb4f03da0d7d server: re-usable Twisted TLS code has been moved to SàT backend Goffi <goffi@goffi.org> parents: 1268 diff changeset	1314 log.warning(
eb4f03da0d7d server: re-usable Twisted TLS code has been moved to SàT backend Goffi <goffi@goffi.org> parents: 1268 diff changeset	1315 f"There is a problem in TLS settings in your configuration file: {e}")
eb4f03da0d7d server: re-usable Twisted TLS code has been moved to SàT backend Goffi <goffi@goffi.org> parents: 1268 diff changeset	1316 self.quit(2)
eb4f03da0d7d server: re-usable Twisted TLS code has been moved to SàT backend Goffi <goffi@goffi.org> parents: 1268 diff changeset	1317 except exceptions.DataError as e:
eb4f03da0d7d server: re-usable Twisted TLS code has been moved to SàT backend Goffi <goffi@goffi.org> parents: 1268 diff changeset	1318 log.warning(
eb4f03da0d7d server: re-usable Twisted TLS code has been moved to SàT backend Goffi <goffi@goffi.org> parents: 1268 diff changeset	1319 f"Can't set TLS: {e}")
eb4f03da0d7d server: re-usable Twisted TLS code has been moved to SàT backend Goffi <goffi@goffi.org> parents: 1268 diff changeset	1320 self.quit(1)
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1321 reactor.listenSSL(self.options["port_https"], self.site, context_factory)
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1322 if self.options["connection_type"] in ("http", "both"):
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1323 if (
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1324 self.options["connection_type"] == "both"
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1325 and self.options["redirect_to_https"]
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1326 ):
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1327 reactor.listenTCP(
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1328 self.options["port"],
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1329 server.Site(
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1330 RedirectToHTTPS(
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1331 self.options["port"], self.options["port_https_ext"]
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1332 )
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1333 ),
cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1334 )
446 c406e46fe9c0 server_side: update the connection mechanism to handle profile passwords souliane <souliane@mailoo.org> parents: 445 diff changeset	1335 else:
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1336 reactor.listenTCP(self.options["port"], self.site)
446 c406e46fe9c0 server_side: update the connection mechanism to handle profile passwords souliane <souliane@mailoo.org> parents: 445 diff changeset	1337
1108 7ec1ba86d38d server: replaced blocking calls to bridge by bridgeCall which is not blocking Goffi <goffi@goffi.org> parents: 1106 diff changeset	1338 @defer.inlineCallbacks
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	1339 def stopService(self):
473 d1565906f228 server_side: fixed some forgotten print statement Goffi <goffi@goffi.org> parents: 472 diff changeset	1340 log.info(_("launching cleaning methods"))
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	1341 for callback, args, kwargs in self._cleanup:
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	1342 callback(args, *kwargs)
859 0e9341e537d6 server: catch exceptions on service profile connection check, and show an helping message if an error is caught Goffi <goffi@goffi.org> parents: 858 diff changeset	1343 try:
1509 106bae41f5c8 massive refactoring from camelCase -> snake_case. See backend commit log for more details Goffi <goffi@goffi.org> parents: 1506 diff changeset	1344 yield self.bridge_call("disconnect", C.SERVICE_PROFILE)
859 0e9341e537d6 server: catch exceptions on service profile connection check, and show an helping message if an error is caught Goffi <goffi@goffi.org> parents: 858 diff changeset	1345 except Exception:
1216 b2d067339de3 python 3 port: Goffi <goffi@goffi.org> parents: 1204 diff changeset	1346 log.warning("Can't disconnect service profile")
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	1347
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	1348 def run(self):
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	1349 reactor.run()
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	1350
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	1351 def stop(self):
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	1352 reactor.stop()
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	1353
812 fd6965c16e7e server: added "quit" method to exit with an exit code when reactor is running Goffi <goffi@goffi.org> parents: 810 diff changeset	1354 def quit(self, exit_code=None):
fd6965c16e7e server: added "quit" method to exit with an exit code when reactor is running Goffi <goffi@goffi.org> parents: 810 diff changeset	1355 """Exit app when reactor is running
fd6965c16e7e server: added "quit" method to exit with an exit code when reactor is running Goffi <goffi@goffi.org> parents: 810 diff changeset	1356
fd6965c16e7e server: added "quit" method to exit with an exit code when reactor is running Goffi <goffi@goffi.org> parents: 810 diff changeset	1357 @param exit_code(None, int): exit code
fd6965c16e7e server: added "quit" method to exit with an exit code when reactor is running Goffi <goffi@goffi.org> parents: 810 diff changeset	1358 """
fd6965c16e7e server: added "quit" method to exit with an exit code when reactor is running Goffi <goffi@goffi.org> parents: 810 diff changeset	1359 self.stop()
fd6965c16e7e server: added "quit" method to exit with an exit code when reactor is running Goffi <goffi@goffi.org> parents: 810 diff changeset	1360 sys.exit(exit_code or 0)
fd6965c16e7e server: added "quit" method to exit with an exit code when reactor is running Goffi <goffi@goffi.org> parents: 810 diff changeset	1361
415 fadbba1d793f server_side: added support for SSL and related parameters: souliane <souliane@mailoo.org> parents: 413 diff changeset	1362
858 7dde76708892 server: URL redirections + misc: Goffi <goffi@goffi.org> parents: 856 diff changeset	1363 class RedirectToHTTPS(web_resource.Resource):
415 fadbba1d793f server_side: added support for SSL and related parameters: souliane <souliane@mailoo.org> parents: 413 diff changeset	1364 def __init__(self, old_port, new_port):
858 7dde76708892 server: URL redirections + misc: Goffi <goffi@goffi.org> parents: 856 diff changeset	1365 web_resource.Resource.__init__(self)
415 fadbba1d793f server_side: added support for SSL and related parameters: souliane <souliane@mailoo.org> parents: 413 diff changeset	1366 self.isLeaf = True
fadbba1d793f server_side: added support for SSL and related parameters: souliane <souliane@mailoo.org> parents: 413 diff changeset	1367 self.old_port = old_port
fadbba1d793f server_side: added support for SSL and related parameters: souliane <souliane@mailoo.org> parents: 413 diff changeset	1368 self.new_port = new_port
fadbba1d793f server_side: added support for SSL and related parameters: souliane <souliane@mailoo.org> parents: 413 diff changeset	1369
fadbba1d793f server_side: added support for SSL and related parameters: souliane <souliane@mailoo.org> parents: 413 diff changeset	1370 def render(self, request):
1354 4751e9febbbf server: fixed HTTPS redirection Goffi <goffi@goffi.org> parents: 1321 diff changeset	1371 netloc = request.URLPath().netloc.decode().replace(
4751e9febbbf server: fixed HTTPS redirection Goffi <goffi@goffi.org> parents: 1321 diff changeset	1372 f":{self.old_port}", f":{self.new_port}"
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1373 )
1354 4751e9febbbf server: fixed HTTPS redirection Goffi <goffi@goffi.org> parents: 1321 diff changeset	1374 url = f"https://{netloc}{request.uri.decode()}"
4751e9febbbf server: fixed HTTPS redirection Goffi <goffi@goffi.org> parents: 1321 diff changeset	1375 return web_util.redirectTo(url.encode(), request)
415 fadbba1d793f server_side: added support for SSL and related parameters: souliane <souliane@mailoo.org> parents: 413 diff changeset	1376
fadbba1d793f server_side: added support for SSL and related parameters: souliane <souliane@mailoo.org> parents: 413 diff changeset	1377
1506 ce879da7fcf7 server: fix `on_signal` callback Goffi <goffi@goffi.org> parents: 1505 diff changeset	1378 registerAdapter(session_iface.WebSession, server.Session, session_iface.IWebSession)
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1379 registerAdapter(
1518 eb00d593801d refactoring: rename `libervia` to `libervia.web` + update imports following backend changes Goffi <goffi@goffi.org> parents: 1516 diff changeset	1380 session_iface.WebGuestSession, server.Session, session_iface.IWebGuestSession
1113 cdd389ef97bc server: code style reformatting using black Goffi <goffi@goffi.org> parents: 1108 diff changeset	1381 )

Mercurial > libervia-web

annotate libervia/web/server/server.py @ 1568:67ff59465fe4