Mercurial > libervia-backend
annotate twisted/plugins/libervia_backend_plugin.py @ 4311:073bb1d1a7f8
doc (cli/message): add documentation for new addressing commands:
rel 450
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Thu, 26 Sep 2024 16:12:01 +0200 |
| parents | 84f6bee6440d |
| children |
| rev | line source |
|---|---|
| 3040 | 1 #!/usr/bin/env python3 |
| 3137 | 2 |
|
3480
7550ae9cfbac
Renamed the project from "Salut à Toi" to "Libervia":
Goffi <goffi@goffi.org>
parents:
3479
diff
changeset
|
3 # Libervia: an XMPP client |
| 3479 | 4 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org) |
| 0 | 5 |
|
609
84a6e83157c2
fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents:
572
diff
changeset
|
6 # This program is free software: you can redistribute it and/or modify |
|
84a6e83157c2
fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents:
572
diff
changeset
|
7 # it under the terms of the GNU Affero General Public License as published by |
|
84a6e83157c2
fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents:
572
diff
changeset
|
8 # the Free Software Foundation, either version 3 of the License, or |
|
84a6e83157c2
fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents:
572
diff
changeset
|
9 # (at your option) any later version. |
| 0 | 10 |
|
609
84a6e83157c2
fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents:
572
diff
changeset
|
11 # This program is distributed in the hope that it will be useful, |
|
84a6e83157c2
fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents:
572
diff
changeset
|
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
84a6e83157c2
fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents:
572
diff
changeset
|
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
84a6e83157c2
fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents:
572
diff
changeset
|
14 # GNU Affero General Public License for more details. |
| 0 | 15 |
|
609
84a6e83157c2
fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents:
572
diff
changeset
|
16 # You should have received a copy of the GNU Affero General Public License |
|
84a6e83157c2
fixed licences in docstrings (they are now in comments)
Goffi <goffi@goffi.org>
parents:
572
diff
changeset
|
17 # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 0 | 18 |
|
1014
e40d9858cb83
core: if in debug mode and ipdb is present, use ipdb instead of pdb
Goffi <goffi@goffi.org>
parents:
1010
diff
changeset
|
19 |
| 3028 | 20 from zope.interface import implementer |
|
1122
9ae01ccf89c1
core: sat bakcend is now a twisted plugin (no more .tac file)
Goffi <goffi@goffi.org>
parents:
1021
diff
changeset
|
21 from twisted.python import usage |
|
9ae01ccf89c1
core: sat bakcend is now a twisted plugin (no more .tac file)
Goffi <goffi@goffi.org>
parents:
1021
diff
changeset
|
22 from twisted.plugin import IPlugin |
|
9ae01ccf89c1
core: sat bakcend is now a twisted plugin (no more .tac file)
Goffi <goffi@goffi.org>
parents:
1021
diff
changeset
|
23 from twisted.application.service import IServiceMaker |
| 0 | 24 |
|
994
652c01ca69b1
core (log): configuration and environment variables are now checked for log level and colors:
Goffi <goffi@goffi.org>
parents:
991
diff
changeset
|
25 # XXX: We need to configure logs before any log method is used, so here is the best place. |
|
4071
4b842c1fb686
refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents:
4037
diff
changeset
|
26 from libervia.backend.core.constants import Const as C |
|
4b842c1fb686
refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents:
4037
diff
changeset
|
27 from libervia.backend.core.i18n import _ |
| 1130 | 28 |
|
3476
11003f9f92fb
core: moved `sat_tmp.wokkel` install `sat_plugin`:
Goffi <goffi@goffi.org>
parents:
3475
diff
changeset
|
29 from sat_tmp.wokkel import install as install_wokkel_patches |
|
11003f9f92fb
core: moved `sat_tmp.wokkel` install `sat_plugin`:
Goffi <goffi@goffi.org>
parents:
3475
diff
changeset
|
30 |
|
11003f9f92fb
core: moved `sat_tmp.wokkel` install `sat_plugin`:
Goffi <goffi@goffi.org>
parents:
3475
diff
changeset
|
31 |
|
11003f9f92fb
core: moved `sat_tmp.wokkel` install `sat_plugin`:
Goffi <goffi@goffi.org>
parents:
3475
diff
changeset
|
32 install_wokkel_patches() |
|
11003f9f92fb
core: moved `sat_tmp.wokkel` install `sat_plugin`:
Goffi <goffi@goffi.org>
parents:
3475
diff
changeset
|
33 |
|
991
05e02f8b7eb4
core: logging refactoring, first step:
Goffi <goffi@goffi.org>
parents:
811
diff
changeset
|
34 |
| 1130 | 35 def initialise(options): |
| 36 """Method to initialise global modules""" | |
| 37 # XXX: We need to configure logs before any log method is used, so here is the best place. | |
|
4071
4b842c1fb686
refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents:
4037
diff
changeset
|
38 from libervia.backend.core import log_config |
|
4078
15055a00162c
refactoring: rename `sat_configure` to `libervia_configure`
Goffi <goffi@goffi.org>
parents:
4073
diff
changeset
|
39 log_config.libervia_configure(C.LOG_BACKEND_TWISTED, C, backend_data=options) |
|
1122
9ae01ccf89c1
core: sat bakcend is now a twisted plugin (no more .tac file)
Goffi <goffi@goffi.org>
parents:
1021
diff
changeset
|
40 |
|
9ae01ccf89c1
core: sat bakcend is now a twisted plugin (no more .tac file)
Goffi <goffi@goffi.org>
parents:
1021
diff
changeset
|
41 |
|
9ae01ccf89c1
core: sat bakcend is now a twisted plugin (no more .tac file)
Goffi <goffi@goffi.org>
parents:
1021
diff
changeset
|
42 class Options(usage.Options): |
|
9ae01ccf89c1
core: sat bakcend is now a twisted plugin (no more .tac file)
Goffi <goffi@goffi.org>
parents:
1021
diff
changeset
|
43 optParameters = [] |
| 101 | 44 |
|
994
652c01ca69b1
core (log): configuration and environment variables are now checked for log level and colors:
Goffi <goffi@goffi.org>
parents:
991
diff
changeset
|
45 |
| 3028 | 46 @implementer(IPlugin, IServiceMaker) |
|
4081
84f6bee6440d
installation: moved from `setup.py` to `pyproject.toml`:
Goffi <goffi@goffi.org>
parents:
4078
diff
changeset
|
47 class LiberviaMaker: |
|
1122
9ae01ccf89c1
core: sat bakcend is now a twisted plugin (no more .tac file)
Goffi <goffi@goffi.org>
parents:
1021
diff
changeset
|
48 |
|
9ae01ccf89c1
core: sat bakcend is now a twisted plugin (no more .tac file)
Goffi <goffi@goffi.org>
parents:
1021
diff
changeset
|
49 tapname = C.APP_NAME_FILE |
| 3028 | 50 description = _("%s XMPP client backend") % C.APP_NAME_FULL |
|
1122
9ae01ccf89c1
core: sat bakcend is now a twisted plugin (no more .tac file)
Goffi <goffi@goffi.org>
parents:
1021
diff
changeset
|
51 options = Options |
|
9ae01ccf89c1
core: sat bakcend is now a twisted plugin (no more .tac file)
Goffi <goffi@goffi.org>
parents:
1021
diff
changeset
|
52 |
|
4037
524856bd7b19
massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents:
3537
diff
changeset
|
53 def set_debugger(self): |
|
3053
8b36e5c3f28f
misc: don't import memory in launch script:
Goffi <goffi@goffi.org>
parents:
3040
diff
changeset
|
54 from twisted.internet import defer |
|
8b36e5c3f28f
misc: don't import memory in launch script:
Goffi <goffi@goffi.org>
parents:
3040
diff
changeset
|
55 if defer.Deferred.debug: |
|
8b36e5c3f28f
misc: don't import memory in launch script:
Goffi <goffi@goffi.org>
parents:
3040
diff
changeset
|
56 # if we are in debug mode, we want to use ipdb instead of pdb |
|
8b36e5c3f28f
misc: don't import memory in launch script:
Goffi <goffi@goffi.org>
parents:
3040
diff
changeset
|
57 try: |
|
8b36e5c3f28f
misc: don't import memory in launch script:
Goffi <goffi@goffi.org>
parents:
3040
diff
changeset
|
58 import ipdb |
|
8b36e5c3f28f
misc: don't import memory in launch script:
Goffi <goffi@goffi.org>
parents:
3040
diff
changeset
|
59 import pdb |
|
8b36e5c3f28f
misc: don't import memory in launch script:
Goffi <goffi@goffi.org>
parents:
3040
diff
changeset
|
60 pdb.set_trace = ipdb.set_trace |
|
8b36e5c3f28f
misc: don't import memory in launch script:
Goffi <goffi@goffi.org>
parents:
3040
diff
changeset
|
61 pdb.post_mortem = ipdb.post_mortem |
|
8b36e5c3f28f
misc: don't import memory in launch script:
Goffi <goffi@goffi.org>
parents:
3040
diff
changeset
|
62 except ImportError: |
|
8b36e5c3f28f
misc: don't import memory in launch script:
Goffi <goffi@goffi.org>
parents:
3040
diff
changeset
|
63 pass |
|
8b36e5c3f28f
misc: don't import memory in launch script:
Goffi <goffi@goffi.org>
parents:
3040
diff
changeset
|
64 |
|
1122
9ae01ccf89c1
core: sat bakcend is now a twisted plugin (no more .tac file)
Goffi <goffi@goffi.org>
parents:
1021
diff
changeset
|
65 def makeService(self, options): |
|
3537
f9a5b810f14d
core (memory/storage): backend storage is now based on SQLAlchemy
Goffi <goffi@goffi.org>
parents:
3480
diff
changeset
|
66 from twisted.internet import asyncioreactor |
|
f9a5b810f14d
core (memory/storage): backend storage is now based on SQLAlchemy
Goffi <goffi@goffi.org>
parents:
3480
diff
changeset
|
67 asyncioreactor.install() |
|
4037
524856bd7b19
massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents:
3537
diff
changeset
|
68 self.set_debugger() |
|
3537
f9a5b810f14d
core (memory/storage): backend storage is now based on SQLAlchemy
Goffi <goffi@goffi.org>
parents:
3480
diff
changeset
|
69 # XXX: Libervia must be imported after log configuration, |
|
f9a5b810f14d
core (memory/storage): backend storage is now based on SQLAlchemy
Goffi <goffi@goffi.org>
parents:
3480
diff
changeset
|
70 # because it write stuff to logs |
| 1130 | 71 initialise(options.parent) |
|
4073
7c5654c54fed
refactoring: rename `core.sat_main` to `core.main`
Goffi <goffi@goffi.org>
parents:
4072
diff
changeset
|
72 from libervia.backend.core.main import LiberviaBackend |
|
4072
040095a5dc7f
refactoring: rename `SAT` class to `LiberviaBackend`
Goffi <goffi@goffi.org>
parents:
4071
diff
changeset
|
73 return LiberviaBackend() |
|
1122
9ae01ccf89c1
core: sat bakcend is now a twisted plugin (no more .tac file)
Goffi <goffi@goffi.org>
parents:
1021
diff
changeset
|
74 |
|
9ae01ccf89c1
core: sat bakcend is now a twisted plugin (no more .tac file)
Goffi <goffi@goffi.org>
parents:
1021
diff
changeset
|
75 |
|
4081
84f6bee6440d
installation: moved from `setup.py` to `pyproject.toml`:
Goffi <goffi@goffi.org>
parents:
4078
diff
changeset
|
76 serviceMaker = LiberviaMaker() |