Mercurial > libervia-backend
annotate libervia/backend/plugins/plugin_dbg_manhole.py @ 4196:8b673bb307c1
plugin XEP-0045: avoir crash if `subject` is not set when `_get_room_joined_args` is called.
author | Goffi <goffi@goffi.org> |
---|---|
date | Wed, 13 Dec 2023 22:00:25 +0100 |
parents | 4b842c1fb686 |
children | 0d7bb4df2343 |
rev | line source |
---|---|
3028 | 1 #!/usr/bin/env python3 |
3137 | 2 |
2755
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
3 |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
4 # SAT plugin for debugging, using a manhole |
3479 | 5 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org) |
2755
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
6 |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
7 # This program is free software: you can redistribute it and/or modify |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
8 # it under the terms of the GNU Affero General Public License as published by |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
9 # the Free Software Foundation, either version 3 of the License, or |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
10 # (at your option) any later version. |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
11 |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
12 # This program is distributed in the hope that it will be useful, |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
15 # GNU Affero General Public License for more details. |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
16 |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
17 # You should have received a copy of the GNU Affero General Public License |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
18 # along with this program. If not, see <http://www.gnu.org/licenses/>. |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
19 |
4071
4b842c1fb686
refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents:
4037
diff
changeset
|
20 from libervia.backend.core.i18n import _ |
4b842c1fb686
refactoring: renamed `sat` package to `libervia.backend`
Goffi <goffi@goffi.org>
parents:
4037
diff
changeset
|
21 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
|
22 from libervia.backend.core.log import getLogger |
2755
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
23 from twisted.conch.insults import insults |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
24 from twisted.conch.telnet import TelnetTransport, TelnetBootstrapProtocol |
3134
48eafdab1c34
plugin manhole: added `d` to namespace as shortcut for defer.ensureDeferred
Goffi <goffi@goffi.org>
parents:
3126
diff
changeset
|
25 from twisted.internet import reactor, protocol, defer |
2837
e2005dd39c92
plugin manhole: added "jid" module to globals
Goffi <goffi@goffi.org>
parents:
2755
diff
changeset
|
26 from twisted.words.protocols.jabber import jid |
2755
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
27 from twisted.conch.manhole import ColoredManhole |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
28 |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
29 log = getLogger(__name__) |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
30 |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
31 PLUGIN_INFO = { |
3028 | 32 C.PI_NAME: "Manhole debug plugin", |
33 C.PI_IMPORT_NAME: "manhole", | |
34 C.PI_TYPE: "DEBUG", | |
2755
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
35 C.PI_PROTOCOLS: [], |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
36 C.PI_DEPENDENCIES: [], |
3028 | 37 C.PI_MAIN: "Manhole", |
38 C.PI_HANDLER: "no", | |
39 C.PI_DESCRIPTION: _("""Debug plugin to have a telnet server"""), | |
2755
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
40 } |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
41 |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
42 |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
43 |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
44 class Manhole(object): |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
45 |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
46 def __init__(self, host): |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
47 self.host = host |
4037
524856bd7b19
massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents:
3479
diff
changeset
|
48 port = int(host.memory.config_get(None, "manhole_debug_dangerous_port_int", 0)) |
2755
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
49 if port: |
4037
524856bd7b19
massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents:
3479
diff
changeset
|
50 self.start_manhole(port) |
2755
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
51 |
4037
524856bd7b19
massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents:
3479
diff
changeset
|
52 def start_manhole(self, port): |
3028 | 53 log.warning(_("/!\\ Manhole debug server activated, be sure to not use it in " |
54 "production, this is dangerous /!\\")) | |
55 log.info(_("You can connect to manhole server using telnet on port {port}") | |
2755
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
56 .format(port=port)) |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
57 f = protocol.ServerFactory() |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
58 namespace = { |
3028 | 59 "host": self.host, |
3126
2b0f739f8a46
plugin manhole: added "C" to namespace
Goffi <goffi@goffi.org>
parents:
3082
diff
changeset
|
60 "C": C, |
3028 | 61 "jid": jid, |
3134
48eafdab1c34
plugin manhole: added `d` to namespace as shortcut for defer.ensureDeferred
Goffi <goffi@goffi.org>
parents:
3126
diff
changeset
|
62 "d": defer.ensureDeferred, |
2755
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
63 } |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
64 f.protocol = lambda: TelnetTransport(TelnetBootstrapProtocol, |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
65 insults.ServerProtocol, |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
66 ColoredManhole, |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
67 namespace=namespace, |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
68 ) |
12d1ca646af1
plugin manhole: manhole debug plugin, first draft:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
69 reactor.listenTCP(port, f) |