Mercurial > libervia-pubsub
annotate twisted/plugins/pubsub.py @ 491:4e8e8788bc86
Bookmark compatibility layer:
The new `bookmark_compat` module add a compatibility layer between XEP-0048 (with
XEP-0049 private XML storage) and XEP-0402, i.e. it implements the
`urn:xmpp:bookmarks:1#compat` feature.
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Thu, 21 Nov 2024 11:03:51 +0100 |
| parents | b544109ab4c4 |
| children |
| rev | line source |
|---|---|
| 414 | 1 #!/usr/bin/env python3 |
| 233 | 2 |
| 440 | 3 # Copyright (c) 2012-2021 Jérôme Poisson |
|
312
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
4 # Copyright (c) 2003-2011 Ralph Meijer |
| 233 | 5 |
| 6 | |
|
312
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
7 # This program is free software: you can redistribute it and/or modify |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
8 # it under the terms of the GNU Affero General Public License as published by |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
9 # the Free Software Foundation, either version 3 of the License, or |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
10 # (at your option) any later version. |
| 233 | 11 |
|
312
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
12 # This program is distributed in the hope that it will be useful, |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
15 # GNU Affero General Public License for more details. |
| 233 | 16 |
|
312
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
17 # You should have received a copy of the GNU Affero General Public License |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
18 # along with this program. If not, see <http://www.gnu.org/licenses/>. |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
19 # -- |
| 233 | 20 |
|
312
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
21 # This program is based on Idavoll (http://idavoll.ik.nu/), |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
22 # originaly written by Ralph Meijer (http://ralphm.net/blog/) |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
23 # It is sublicensed under AGPL v3 (or any later version) as allowed by the original |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
24 # license. |
| 233 | 25 |
|
312
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
26 # -- |
| 233 | 27 |
|
312
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
28 # Here is a copy of the original license: |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
29 |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
30 # Copyright (c) 2003-2011 Ralph Meijer |
| 233 | 31 |
|
312
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
32 # Permission is hereby granted, free of charge, to any person obtaining |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
33 # a copy of this software and associated documentation files (the |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
34 # "Software"), to deal in the Software without restriction, including |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
35 # without limitation the rights to use, copy, modify, merge, publish, |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
36 # distribute, sublicense, and/or sell copies of the Software, and to |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
37 # permit persons to whom the Software is furnished to do so, subject to |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
38 # the following conditions: |
| 233 | 39 |
|
312
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
40 # The above copyright notice and this permission notice shall be |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
41 # included in all copies or substantial portions of the Software. |
| 233 | 42 |
|
312
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
43 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
44 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
45 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
46 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
47 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
48 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION |
|
5d7c3787672e
fixed copyright put in docstring instead of comments
Goffi <goffi@goffi.org>
parents:
311
diff
changeset
|
49 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| 233 | 50 |
| 155 | 51 |
| 491 | 52 import configparser |
| 380 | 53 import csv |
|
428
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
54 import os |
|
418
89736353f6be
install sat_tmp's twisted patches for Python 3.8 compatibility
Goffi <goffi@goffi.org>
parents:
417
diff
changeset
|
55 from os.path import expanduser, realpath |
| 491 | 56 import sys |
| 57 | |
| 369 | 58 from twisted.application import service |
| 491 | 59 from twisted.application.service import IServiceMaker |
|
418
89736353f6be
install sat_tmp's twisted patches for Python 3.8 compatibility
Goffi <goffi@goffi.org>
parents:
417
diff
changeset
|
60 from twisted.plugin import IPlugin |
| 491 | 61 from twisted.python import log, usage |
| 369 | 62 from twisted.words.protocols.jabber.jid import JID |
| 491 | 63 from zope.interface import implementer |
| 64 | |
|
418
89736353f6be
install sat_tmp's twisted patches for Python 3.8 compatibility
Goffi <goffi@goffi.org>
parents:
417
diff
changeset
|
65 import sat_pubsub |
|
453
1a179ad10125
backend: service name can now be specified with `service_name` parameter
Goffi <goffi@goffi.org>
parents:
447
diff
changeset
|
66 from sat_pubsub import const |
| 369 | 67 |
| 68 | |
| 380 | 69 def coerceListType(value): |
| 414 | 70 return next(csv.reader( |
| 380 | 71 [value], delimiter=",", quotechar='"', skipinitialspace=True |
| 414 | 72 )) |
| 380 | 73 |
| 74 | |
| 75 def coerceJidListType(value): | |
| 76 values = [JID(v) for v in coerceListType(value)] | |
| 77 if any((j.resource for j in values)): | |
| 414 | 78 raise ValueError("you must use bare jids") |
| 380 | 79 return values |
| 80 | |
| 81 | |
| 460 | 82 def coerceJidDomainType(value): |
| 83 try: | |
| 84 jid_ = JID(value) | |
| 85 except Exception as e: | |
| 86 raise ValueError(f"JID set in configuration ({value!r}) is invalid: {e}") | |
| 87 if jid_.resource or jid_.user: | |
| 88 raise ValueError( | |
| 89 f"JID in configuration ({jid_!r}) must have no local part and no resource" | |
| 90 ) | |
| 91 return jid_ | |
| 92 | |
| 380 | 93 |
| 369 | 94 OPT_PARAMETERS_BOTH = [ |
| 460 | 95 ['jid', None, None, 'JID this component will be available at', coerceJidDomainType], |
| 369 | 96 ['xmpp_pwd', None, None, 'XMPP server component password'], |
| 460 | 97 ['server_jid', None, None, 'jid of the server this component is plugged to', |
| 98 coerceJidDomainType], | |
| 369 | 99 ['rhost', None, '127.0.0.1', 'XMPP server host'], |
| 100 ['rport', None, '5347', 'XMPP server port'], | |
| 101 ['backend', None, 'pgsql', 'Choice of storage backend'], | |
| 102 ['db_user', None, None, 'Database user (pgsql backend)'], | |
| 103 ['db_name', None, 'pubsub', 'Database name (pgsql backend)'], | |
| 104 ['db_pass', None, None, 'Database password (pgsql backend)'], | |
| 105 ['db_host', None, None, 'Database host (pgsql backend)'], | |
| 106 ['db_port', None, None, 'Database port (pgsql backend)'], | |
|
453
1a179ad10125
backend: service name can now be specified with `service_name` parameter
Goffi <goffi@goffi.org>
parents:
447
diff
changeset
|
107 ['service_name', None, const.SERVICE_NAME, 'Name of this Pubsub service'], |
| 369 | 108 ] |
|
428
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
109 |
| 380 | 110 OPT_PARAMETERS_CFG = [ |
| 111 ["admins_jids_list", None, [], "List of administrators' bare jids", | |
| 112 coerceJidListType] | |
| 113 ] | |
| 369 | 114 |
|
428
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
115 # prefix used for environment variables |
|
447
cc29a62fb64c
renaming following global Salut à Toi => Libervia renaming:
Goffi <goffi@goffi.org>
parents:
445
diff
changeset
|
116 ENV_PREFIX = "LIBERVIA_PUBSUB_" |
|
428
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
117 # mapping from option name to environment variables to use |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
118 # each parameter name links to a list of variable environment name |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
119 # if an environment variable of one of the names exists it will be used |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
120 # as default value, with priority over config file |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
121 ENV_OPT_MAP = { |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
122 # we use the same environment variables as PostgreSQL |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
123 'db_user': ['PGUSER'], |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
124 'db_name': ['PGDATABASE'], |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
125 'db_pass': ['PGPASSWORD'], |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
126 'db_host': ['PGHOST'], |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
127 'db_port': ['PGPORT'], |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
128 } |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
129 for opt in OPT_PARAMETERS_BOTH + OPT_PARAMETERS_CFG: |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
130 name = opt[0] |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
131 env_name = f"{ENV_PREFIX}{name.upper()}" |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
132 ENV_OPT_MAP.setdefault(name, []).append(env_name) |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
133 |
|
445
fe24bb60236f
core: update conf file name following project renaming:
Goffi <goffi@goffi.org>
parents:
440
diff
changeset
|
134 CONFIG_FILENAME = 'libervia' |
| 369 | 135 # List of the configuration filenames sorted by ascending priority |
|
445
fe24bb60236f
core: update conf file name following project renaming:
Goffi <goffi@goffi.org>
parents:
440
diff
changeset
|
136 CONFIG_FILES = ( |
|
fe24bb60236f
core: update conf file name following project renaming:
Goffi <goffi@goffi.org>
parents:
440
diff
changeset
|
137 [realpath(expanduser(path) + CONFIG_FILENAME + '.conf') for path in ( |
| 369 | 138 '/etc/', '/etc/{}/'.format(CONFIG_FILENAME), |
| 139 '~/', '~/.', | |
| 140 '.config/', '.config/.', | |
|
426
6f8e1c180c83
added "~/.config/sat" as search patch for config
Goffi <goffi@goffi.org>
parents:
418
diff
changeset
|
141 '.config/{}/'.format(CONFIG_FILENAME), |
| 369 | 142 '', '.')] |
|
445
fe24bb60236f
core: update conf file name following project renaming:
Goffi <goffi@goffi.org>
parents:
440
diff
changeset
|
143 + |
|
fe24bb60236f
core: update conf file name following project renaming:
Goffi <goffi@goffi.org>
parents:
440
diff
changeset
|
144 # "sat.conf" is the legacy name of the config file |
|
fe24bb60236f
core: update conf file name following project renaming:
Goffi <goffi@goffi.org>
parents:
440
diff
changeset
|
145 [realpath(expanduser(path) + "sat.conf") for path in ( |
|
fe24bb60236f
core: update conf file name following project renaming:
Goffi <goffi@goffi.org>
parents:
440
diff
changeset
|
146 '/etc/', '/etc/{}/'.format("sat"), |
|
fe24bb60236f
core: update conf file name following project renaming:
Goffi <goffi@goffi.org>
parents:
440
diff
changeset
|
147 '~/', '~/.', |
|
fe24bb60236f
core: update conf file name following project renaming:
Goffi <goffi@goffi.org>
parents:
440
diff
changeset
|
148 '.config/', '.config/.', |
|
fe24bb60236f
core: update conf file name following project renaming:
Goffi <goffi@goffi.org>
parents:
440
diff
changeset
|
149 '.config/{}/'.format("sat"), |
|
fe24bb60236f
core: update conf file name following project renaming:
Goffi <goffi@goffi.org>
parents:
440
diff
changeset
|
150 '', '.')] |
|
fe24bb60236f
core: update conf file name following project renaming:
Goffi <goffi@goffi.org>
parents:
440
diff
changeset
|
151 ) |
| 369 | 152 CONFIG_SECTION = 'pubsub' |
| 153 | |
| 154 | |
| 155 class Options(usage.Options): | |
| 156 optParameters = OPT_PARAMETERS_BOTH | |
| 157 | |
| 158 optFlags = [ | |
| 159 ('verbose', 'v', 'Show traffic'), | |
| 160 ('hide-nodes', None, 'Hide all nodes for disco') | |
| 161 ] | |
| 162 | |
| 163 def __init__(self): | |
| 460 | 164 """Read Libervia Pubsub configuration file in order to overwrite the hard-coded default values. |
| 369 | 165 |
| 166 Priority for the usage of the values is (from lowest to highest): | |
| 167 - hard-coded default values | |
| 168 - values from SàT configuration files | |
| 169 - values passed on the command line | |
| 170 """ | |
| 171 # If we do it the reading later: after the command line options have been parsed, there's no good way to know | |
| 172 # if the options values are the hard-coded ones or if they have been passed on the command line. | |
| 173 | |
| 174 # FIXME: must be refactored + code can be factorised with backend | |
| 414 | 175 config_parser = configparser.ConfigParser() |
| 369 | 176 config_parser.read(CONFIG_FILES) |
| 177 for param in self.optParameters + OPT_PARAMETERS_CFG: | |
| 178 name = param[0] | |
|
428
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
179 for env_name in ENV_OPT_MAP[name]: |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
180 # we first check if value is set as an environment variable |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
181 value = os.getenv(env_name) |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
182 if value is not None: |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
183 self.setDefaultOption(param, value) |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
184 break |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
185 else: |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
186 # no environment variable set, let's try with configuration |
| 369 | 187 try: |
|
428
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
188 value = config_parser.get(CONFIG_SECTION, name) |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
189 self.setDefaultOption(param, value) |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
190 except (configparser.NoSectionError, configparser.NoOptionError): |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
191 pass |
| 369 | 192 usage.Options.__init__(self) |
| 193 for opt_data in OPT_PARAMETERS_CFG: | |
| 194 self[opt_data[0]] = opt_data[2] | |
| 155 | 195 |
|
428
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
196 def setDefaultOption(self, param, value): |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
197 """Set default option value using coerce method when needed |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
198 |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
199 If the value is invalid, we quit the program with exit code 1 |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
200 """ |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
201 try: |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
202 param[2] = param[4](value) |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
203 except IndexError: # the coerce method is optional |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
204 param[2] = value |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
205 except Exception as e: |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
206 log.err('Invalid value for setting "{name}": {msg}'.format( |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
207 name=name, msg=e)) |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
208 sys.exit(1) |
|
34bd55179e22
environment variables can now be used to set options:
Goffi <goffi@goffi.org>
parents:
426
diff
changeset
|
209 |
| 369 | 210 def postOptions(self): |
| 211 if self['backend'] not in ['pgsql', 'memory']: | |
| 406 | 212 raise usage.UsageError("Unknown backend!") |
| 369 | 213 if self['backend'] == 'memory': |
| 214 raise NotImplementedError('memory backend is not available at the moment') | |
| 215 | |
| 216 | |
| 414 | 217 @implementer(IServiceMaker, IPlugin) |
| 369 | 218 class SatPubsubMaker(object): |
|
447
cc29a62fb64c
renaming following global Salut à Toi => Libervia renaming:
Goffi <goffi@goffi.org>
parents:
445
diff
changeset
|
219 tapname = "libervia-pubsub" |
|
cc29a62fb64c
renaming following global Salut à Toi => Libervia renaming:
Goffi <goffi@goffi.org>
parents:
445
diff
changeset
|
220 description = "Libervia's Publish-Subscribe Service Component" |
| 369 | 221 options = Options |
| 222 | |
| 223 def makeService(self, config): | |
|
417
412d26a9b2c2
import sat/wokkel modules only when making service:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
224 from wokkel.component import Component |
|
412d26a9b2c2
import sat/wokkel modules only when making service:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
225 from wokkel.disco import DiscoHandler |
|
412d26a9b2c2
import sat/wokkel modules only when making service:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
226 from wokkel.generic import FallbackHandler, VersionHandler |
|
412d26a9b2c2
import sat/wokkel modules only when making service:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
227 from wokkel.iwokkel import IPubSubResource |
|
412d26a9b2c2
import sat/wokkel modules only when making service:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
228 from wokkel import data_form |
|
412d26a9b2c2
import sat/wokkel modules only when making service:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
229 from wokkel import pubsub |
|
412d26a9b2c2
import sat/wokkel modules only when making service:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
230 from wokkel import rsm |
|
412d26a9b2c2
import sat/wokkel modules only when making service:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
231 from wokkel import mam |
|
412d26a9b2c2
import sat/wokkel modules only when making service:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
232 from sat_pubsub import mam as pubsub_mam |
|
412d26a9b2c2
import sat/wokkel modules only when making service:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
233 from sat_pubsub import pubsub_admin |
|
412d26a9b2c2
import sat/wokkel modules only when making service:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
234 from sat_pubsub.backend import BackendService, ExtraDiscoHandler |
|
412d26a9b2c2
import sat/wokkel modules only when making service:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
235 from sat_pubsub.privilege import PrivilegesHandler |
|
412d26a9b2c2
import sat/wokkel modules only when making service:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
236 from sat_pubsub.delegation import DelegationsHandler |
|
478
b544109ab4c4
Privileged Entity update + Pubsub Account Management partial implementation + Public Pubsub Subscription
Goffi <goffi@goffi.org>
parents:
460
diff
changeset
|
237 from sat_pubsub.pam import PAMHandler |
| 491 | 238 from sat_pubsub.bookmark_compat import BookmarkCompatHandler |
|
417
412d26a9b2c2
import sat/wokkel modules only when making service:
Goffi <goffi@goffi.org>
parents:
414
diff
changeset
|
239 |
| 369 | 240 if not config['jid'] or not config['xmpp_pwd']: |
| 241 raise usage.UsageError("You must specify jid and xmpp_pwd") | |
| 242 s = service.MultiService() | |
| 243 | |
| 244 # Create backend service with storage | |
| 245 | |
| 246 if config['backend'] == 'pgsql': | |
| 247 from twisted.enterprise import adbapi | |
| 248 from sat_pubsub.pgsql_storage import Storage | |
| 249 from psycopg2.extras import NamedTupleConnection | |
| 250 keys_map = { | |
| 251 'db_user': 'user', | |
| 252 'db_pass': 'password', | |
| 253 'db_name': 'database', | |
| 254 'db_host': 'host', | |
| 255 'db_port': 'port', | |
| 256 } | |
| 257 kwargs = {} | |
| 414 | 258 for config_k, k in keys_map.items(): |
| 369 | 259 v = config.get(config_k) |
| 260 if v is None: | |
| 261 continue | |
| 262 kwargs[k] = v | |
| 263 dbpool = adbapi.ConnectionPool('psycopg2', | |
| 264 cp_reconnect=True, | |
| 265 client_encoding='utf-8', | |
| 266 connection_factory=NamedTupleConnection, | |
| 267 **kwargs | |
| 268 ) | |
| 269 st = Storage(dbpool) | |
| 270 elif config['backend'] == 'memory': | |
| 406 | 271 raise NotImplementedError('memory backend is not available at the moment') |
| 369 | 272 |
| 380 | 273 bs = BackendService(st, config) |
| 369 | 274 bs.setName('backend') |
| 275 bs.setServiceParent(s) | |
| 276 | |
| 277 # Set up XMPP server-side component with publish-subscribe capabilities | |
| 278 | |
| 279 cs = Component(config["rhost"], int(config["rport"]), | |
| 280 config["jid"].full(), config["xmpp_pwd"]) | |
| 281 cs.setName('component') | |
| 282 cs.setServiceParent(s) | |
| 283 | |
| 284 cs.factory.maxDelay = 900 | |
| 285 | |
| 286 if config["verbose"]: | |
| 287 cs.logTraffic = True | |
| 288 | |
| 289 FallbackHandler().setHandlerParent(cs) | |
|
458
bc2e04a4d3c1
version handler name updated following global renaming
Goffi <goffi@goffi.org>
parents:
453
diff
changeset
|
290 VersionHandler('Libervia Pubsub', sat_pubsub.__version__).setHandlerParent(cs) |
| 369 | 291 DiscoHandler().setHandlerParent(cs) |
| 292 | |
| 293 ph = PrivilegesHandler(config['jid']) | |
| 294 ph.setHandlerParent(cs) | |
| 295 bs.privilege = ph | |
| 296 | |
|
478
b544109ab4c4
Privileged Entity update + Pubsub Account Management partial implementation + Public Pubsub Subscription
Goffi <goffi@goffi.org>
parents:
460
diff
changeset
|
297 pam = PAMHandler(config["jid"]) |
|
b544109ab4c4
Privileged Entity update + Pubsub Account Management partial implementation + Public Pubsub Subscription
Goffi <goffi@goffi.org>
parents:
460
diff
changeset
|
298 pam.setHandlerParent(cs) |
|
b544109ab4c4
Privileged Entity update + Pubsub Account Management partial implementation + Public Pubsub Subscription
Goffi <goffi@goffi.org>
parents:
460
diff
changeset
|
299 bs.pam = pam |
|
b544109ab4c4
Privileged Entity update + Pubsub Account Management partial implementation + Public Pubsub Subscription
Goffi <goffi@goffi.org>
parents:
460
diff
changeset
|
300 |
| 491 | 301 bookmark_compat = BookmarkCompatHandler(config["jid"]) |
| 302 bookmark_compat.setHandlerParent(cs) | |
| 303 | |
| 369 | 304 resource = IPubSubResource(bs) |
| 305 resource.hideNodes = config["hide-nodes"] | |
| 306 resource.serviceJID = config["jid"] | |
| 307 | |
| 308 ps = (rsm if const.FLAG_ENABLE_RSM else pubsub).PubSubService(resource) | |
| 309 ps.setHandlerParent(cs) | |
| 310 resource.pubsubService = ps | |
| 311 | |
| 312 if const.FLAG_ENABLE_MAM: | |
| 313 mam_resource = pubsub_mam.MAMResource(bs) | |
| 314 mam_s = mam.MAMService(mam_resource) | |
| 315 mam_s.addFilter(data_form.Field(var=const.MAM_FILTER_CATEGORY)) | |
| 430 | 316 mam_s.addFilter(data_form.Field(var=const.MAM_FILTER_FTS)) |
| 369 | 317 mam_s.setHandlerParent(cs) |
| 318 | |
|
382
77b52dbda89a
pubsub_admin: Pubsub Admin experimental protocol first draft:
Goffi <goffi@goffi.org>
parents:
380
diff
changeset
|
319 pa = pubsub_admin.PubsubAdminHandler(bs) |
|
77b52dbda89a
pubsub_admin: Pubsub Admin experimental protocol first draft:
Goffi <goffi@goffi.org>
parents:
380
diff
changeset
|
320 pa.setHandlerParent(cs) |
|
77b52dbda89a
pubsub_admin: Pubsub Admin experimental protocol first draft:
Goffi <goffi@goffi.org>
parents:
380
diff
changeset
|
321 |
|
375
9a787881b824
implemented Order-By ProtoXEP (MAM + PubSub)
Goffi <goffi@goffi.org>
parents:
369
diff
changeset
|
322 # wokkel.pubsub doesn't handle non pubsub# disco |
|
9a787881b824
implemented Order-By ProtoXEP (MAM + PubSub)
Goffi <goffi@goffi.org>
parents:
369
diff
changeset
|
323 # and we need to announce other feature, so this is a workaround |
|
9a787881b824
implemented Order-By ProtoXEP (MAM + PubSub)
Goffi <goffi@goffi.org>
parents:
369
diff
changeset
|
324 # to add them |
|
9a787881b824
implemented Order-By ProtoXEP (MAM + PubSub)
Goffi <goffi@goffi.org>
parents:
369
diff
changeset
|
325 # FIXME: propose a patch upstream to fix this situation |
|
9a787881b824
implemented Order-By ProtoXEP (MAM + PubSub)
Goffi <goffi@goffi.org>
parents:
369
diff
changeset
|
326 ed = ExtraDiscoHandler() |
|
9a787881b824
implemented Order-By ProtoXEP (MAM + PubSub)
Goffi <goffi@goffi.org>
parents:
369
diff
changeset
|
327 ed.setHandlerParent(cs) |
|
9a787881b824
implemented Order-By ProtoXEP (MAM + PubSub)
Goffi <goffi@goffi.org>
parents:
369
diff
changeset
|
328 |
| 369 | 329 # XXX: delegation must be instancied at the end, |
| 330 # because it does some MonkeyPatching on handlers | |
| 331 dh = DelegationsHandler() | |
| 332 dh.setHandlerParent(cs) | |
| 333 bs.delegation = dh | |
| 334 | |
| 335 return s | |
| 336 | |
| 337 serviceMaker = SatPubsubMaker() |