10 |
12 | This will not notify any other hooks with a reference to this hook, nor will it attempt to remove it from their state.
11 |
7 |
70 | {%- endblock %}
71 |
--------------------------------------------------------------------------------
/immp/hook/webui/templates/add.j2:
--------------------------------------------------------------------------------
1 | {% extends ctx.module + "/base.j2" %}
2 | {% from ctx.module + "/macros.j2" import render_doc %}
3 | {% set title = "Add" %}
4 |
5 | {% block body -%}
6 |
8 |
69 |
9 |
16 |
17 | {%- for channel, name in zipped(public, titles) %}
18 |
36 | {%- endif %}
37 |
38 | Public channels
10 | {%- if public is none %} 11 |No support for retrieving a list of channels.
12 | {%- elif not public %} 13 |No channels available.
14 | {%- else %} 15 || 20 | {{ channel.source }} 21 | | 22 |{% if name %}{{ name }}{% endif %} | 23 |
24 | {% if channels[channel] %}
25 | {{ channels[channel] | join(" ") }} 26 | {% else %} 27 | 28 | Add 29 | 30 | {% endif %} 31 | |
32 |
39 |
46 |
47 | {%- for channel, users in zipped(private, users) %}
48 |
66 | {%- endif %}
67 |
68 | Private channels
40 | {%- if private is none %} 41 |No support for retrieving a list of channels.
42 | {%- elif not private %} 43 |No channels available.
44 | {%- else %} 45 || 50 | {{ channel.source }} 51 | | 52 |{% for user in users %}{% if not loop.first %}, {% endif %}{{ user.real_name or user.username }}{% endfor %} | 53 |
54 | {% if channels[channel] %}
55 | {{ channels[channel] | join(" ") }} 56 | {% else %} 57 | 58 | Add 59 | 60 | {% endif %} 61 | |
62 |
7 |
68 | {{ render_doc(doc, doc_html) }}
69 |
70 | {%- endblock %}
71 |
--------------------------------------------------------------------------------
/immp/hook/hangoutslock.py:
--------------------------------------------------------------------------------
1 | """
2 | History and link-join setting locks for Hangouts.
3 |
4 | Dependencies:
5 | :class:`.HangoutsPlug`
6 |
7 | Config:
8 | history ((str, bool) dict):
9 | Mapping from channel names to desired conversation history settings -- ``True`` to keep
10 | history enabled, ``False`` to keep it disabled.
11 | linkjoin ((str, bool) dict):
12 | Mapping from channel names to desired link join settings -- ``True`` to enable joining the
13 | hangout via link, ``False`` to disable it.
14 | """
15 |
16 | import hangups
17 | from hangups import hangouts_pb2
18 |
19 | import immp
20 | from immp.plug.hangouts import HangoutsPlug
21 |
22 |
23 | HISTORY = {True: hangouts_pb2.OFF_THE_RECORD_STATUS_ON_THE_RECORD,
24 | False: hangouts_pb2.OFF_THE_RECORD_STATUS_OFF_THE_RECORD}
25 |
26 | LINK_JOIN = {True: hangouts_pb2.GROUP_LINK_SHARING_STATUS_ON,
27 | False: hangouts_pb2.GROUP_LINK_SHARING_STATUS_OFF}
28 |
29 |
30 | class HangoutsLockHook(immp.Hook):
31 | """
32 | Hook to enforce the history and link-join settings in Hangouts.
33 | """
34 |
35 | schema = immp.Schema({immp.Optional("history", dict): {str: bool},
36 | immp.Optional("linkjoin", dict): {str: bool}})
37 |
38 | @property
39 | def channels(self):
40 | try:
41 | return {key: {self.host.channels[label]: setting
42 | for label, setting in mapping.items()}
43 | for key, mapping in self.config.items()}
44 | except KeyError as e:
45 | raise immp.HookError("No channel named '{}'".format(e.args[0]))
46 |
47 | async def on_receive(self, sent, source, primary):
48 | await super().on_receive(sent, source, primary)
49 | if sent != source or not isinstance(sent.channel.plug, HangoutsPlug):
50 | return
51 | conv = sent.channel.plug._convs.get(sent.channel.source)
52 | if isinstance(sent.raw, hangups.OTREvent):
53 | setting = HISTORY.get(self.channels["history"].get(sent.channel))
54 | if setting is None:
55 | return
56 | if setting != sent.raw.new_otr_status:
57 | request = hangouts_pb2.ModifyOTRStatusRequest(
58 | request_header=sent.channel.plug._client.get_request_header(),
59 | event_request_header=conv._get_event_request_header(),
60 | otr_status=setting)
61 | await sent.channel.plug._client.modify_otr_status(request)
62 | elif isinstance(sent.raw, hangups.GroupLinkSharingModificationEvent):
63 | setting = LINK_JOIN.get(self.channels["linkjoin"].get(sent.channel))
64 | if setting is None:
65 | return
66 | if setting != sent.raw.new_status:
67 | request = hangouts_pb2.SetGroupLinkSharingEnabledRequest(
68 | request_header=sent.channel.plug._client.get_request_header(),
69 | event_request_header=conv._get_event_request_header(),
70 | group_link_sharing_status=setting)
71 | await sent.channel.plug._client.set_group_link_sharing_enabled(request)
72 |
--------------------------------------------------------------------------------
/immp/hook/autorespond.py:
--------------------------------------------------------------------------------
1 | """
2 | Basic text request/response handler.
3 |
4 | Config:
5 | groups (str list):
6 | List of groups to process responses in.
7 | responses ((str, str) dict):
8 | Mapping from match regex to response text.
9 |
10 | Commands:
11 | ar-add
66 |
75 |
67 | {%- if title %}
68 |
74 | {{ title }}
69 | {%- endif %} 70 | {%- if subtitle %} 71 |{{ subtitle }}
72 | {%- endif %} 73 |
8 |
55 |
91 | {%- endblock %}
92 |
--------------------------------------------------------------------------------
/immp/hook/webui/templates/channel.j2:
--------------------------------------------------------------------------------
1 | {% extends ctx.module + "/base.j2" %}
2 | {% set title = "Channel: " + channel.source %}
3 | {% if title_ %}
4 | {% set subtitle = title_ %}
5 | {% endif %}
6 | {% set nav = [("Plug: " + channel.plug.name, ctx.url_for("plug", name=channel.plug.name))] %}
7 |
8 | {% block body -%}
9 | Edit
56 | {%- if hook.schema %} 57 | 89 | {{ render_doc(doc, doc_html) }} 90 |
10 |
30 |
76 |
77 | {%- for member in members %}
78 |
130 | {%- endif %}
131 |
132 | {%- endblock %}
133 |
--------------------------------------------------------------------------------
/immp/core/stream.py:
--------------------------------------------------------------------------------
1 | from asyncio import FIRST_COMPLETED, CancelledError, Event, ensure_future, wait
2 | import logging
3 |
4 |
5 | log = logging.getLogger(__name__)
6 |
7 |
8 | class PlugStream:
9 | """
10 | Message multiplexer, to read messages from multiple asynchronous generators in parallel.
11 |
12 | Instances of this class are async-iterable -- for each incoming message, a tuple is produced:
13 | the physical message received by the plug, a source message if originating from within the
14 | system, and a primary flag to indicate supplementary messages created when a system-sourced
15 | message can't be represented in a single plug message.
16 |
17 | .. warning::
18 | As per :meth:`.Plug.stream`, only one iterator of this class should be used at once.
19 |
20 | Yields:
21 | (.SentMessage, .Message, bool) tuple:
22 | Messages received and processed by any connected plug.
23 | """
24 |
25 | __slots__ = ("_agens", "_tasks", "_sync", "_close")
26 |
27 | def __init__(self):
28 | # Mapping from plugs to their stream() generator coroutines.
29 | self._agens = {}
30 | # Mapping from coroutine task wrappers back to their tasks.
31 | self._tasks = {}
32 | # When a plug is added or removed, the stream wouldn't be able to update until an event
33 | # arrives. This is a signal used to recreate the task list without a message.
34 | self._sync = Event()
35 | # Generators can't be closed synchronously, schedule the plugs to be done on the next sync.
36 | self._close = set()
37 |
38 | def add(self, *plugs):
39 | """
40 | Connect plugs to the stream. When the stream is active, their :meth:`.Plug.stream`
41 | methods will be called to start collecting queued messages.
42 |
43 | Args:
44 | plugs (.Plug list):
45 | New plugs to merge in.
46 | """
47 | for plug in plugs:
48 | if plug not in self._agens:
49 | self._agens[plug] = plug.stream()
50 | self._sync.set()
51 |
52 | def remove(self, *plugs):
53 | """
54 | Disconnect plugs from the stream. Their :meth:`.Plug.stream` tasks will be cancelled, and
55 | any last messages will be collected before removing.
56 |
57 | Args:
58 | plugs (.Plug list):
59 | Active plugs to remove.
60 | """
61 | for plug in plugs:
62 | if plug in self._agens:
63 | self._close.add(plug)
64 | self._sync.set()
65 |
66 | async def _queue(self):
67 | for plug, coro in self._agens.items():
68 | if plug not in self._tasks.values():
69 | log.debug("Queueing receive task for plug %r", plug.name)
70 | # Poor man's async iteration -- there's no async equivalent to next(gen).
71 | self._tasks[ensure_future(coro.asend(None))] = plug
72 | for task, plug in list(self._tasks.items()):
73 | if plug not in self._agens and plug is not self._sync:
74 | task.cancel()
75 | self._close.add(plug)
76 | del self._tasks[task]
77 | for plug in self._close:
78 | log.debug("Cancelling receive task for plug %r", plug.name)
79 | await self._agens[plug].aclose()
80 | self._close.clear()
81 | if self._sync not in self._tasks.values():
82 | log.debug("Recreating sync task")
83 | self._sync.clear()
84 | self._tasks[ensure_future(self._sync.wait())] = self._sync
85 |
86 | async def __aiter__(self):
87 | log.info("Ready for first message")
88 | while True:
89 | try:
90 | await self._queue()
91 | done, _ = await wait(self._tasks, return_when=FIRST_COMPLETED)
92 | except (GeneratorExit, CancelledError):
93 | for task in self._tasks:
94 | task.cancel()
95 | return
96 | for task in done:
97 | plug = self._tasks.pop(task)
98 | if plug is self._sync:
99 | continue
100 | try:
101 | sent, source, primary = task.result()
102 | except CancelledError:
103 | del self._agens[plug]
104 | except Exception:
105 | log.warning("Generator for plug %r exited, recreating",
106 | plug.name, exc_info=True)
107 | self._agens[plug] = plug.stream()
108 | else:
109 | log.info("Received message ID %r in channel %r%s",
110 | sent.id, sent.channel, " (primary)" if primary else "")
111 | log.debug("Message content: %r", sent)
112 | if sent is not source:
113 | log.debug("Source message: %r", source)
114 | yield (sent, source, primary)
115 | log.debug("Waiting for next message")
116 |
117 | def __repr__(self):
118 | done = sum(1 for task in self._tasks if task.done())
119 | pending = len(self._tasks) - done
120 | return "<{}: {} done, {} pending>".format(self.__class__.__name__, done, pending)
121 |
--------------------------------------------------------------------------------
/immp/hook/database.py:
--------------------------------------------------------------------------------
1 | """
2 | Provider of database access to other hooks. All first-party hooks with database support will
3 | require the asynchronous database provider to be present.
4 |
5 | Asynchronous
6 | ~~~~~~~~~~~~
7 |
8 | Requirements:
9 | Extra name: ``db``
10 |
11 | `Tortoise Migrate
31 |Transfer hook data from this channel to a replacement. Caution: this action is irreversible.
32 | 51 | 73 | {%- if members %} 74 |Members ({{ members|length }})
75 ||
80 | {%- if member.avatar %}
81 | |
86 |
87 | {%- if member.link -%}{%- endif %}
88 | {{- member.id }}
89 | {%- if member.link %}{% endif %}
90 | {%- if member.plug.name != channel.plug.name %}
91 | 92 | {{ member.plug.name }} 93 | {%- endif %} 94 | |
95 |
96 | {{ member.real_name or member.username or "" }}
97 | {%- if member.real_name and member.username -%}
98 | {{ member.username }} 99 | {%- endif %} 100 | |
101 | {%- if not channel.plug.virtual %}
102 | 103 | 106 | | 107 | {%- endif %} 108 |
11 |
58 | {%- if not plug.virtual %}
59 |
61 |
62 | {%- for name, channel in channels.items() %}
63 |
110 | {%- endif %}
111 | {%- if plug.schema %}
112 |
140 | {%- endblock %}
141 |
--------------------------------------------------------------------------------
/immp/hook/webui/templates/main.j2:
--------------------------------------------------------------------------------
1 | {% extends ctx.module + "/base.j2" %}
2 |
3 | {%- macro plural(count, template, one="", many="s") -%}
4 | {{- template.format(count, one if count == 1 else many) -}}
5 | {%- endmacro -%}
6 |
7 | {% set title = "Status" %}
8 | {% set subtitle = plural(host.plugs|length, "{} plug{}") + ", " +
9 | plural(host.resources|length, "{} resource{}") + ", " +
10 | plural(host.hooks|length, "{} hook{}") %}
11 |
12 | {% macro qualname(openable) -%}
13 | {{ openable.__class__.__module__ }}.{{ openable.__class__.__name__ }}
14 | {%- endmacro %}
15 |
16 | {% block body -%}
17 | Channels
60 || {{ name }} | 65 |{{ channel.source }} | 66 |67 | 77 | | 78 |
| No channels defined. | 83 |||
Edit
113 | 137 | {% endif %} 138 | {{ render_doc(doc, doc_html) }} 139 |
18 |
21 |
146 | {%- endblock %}
147 |
--------------------------------------------------------------------------------
/immp/hook/shell.py:
--------------------------------------------------------------------------------
1 | """
2 | Interact with and debug a running app in the console.
3 |
4 | Asynchronous
5 | ~~~~~~~~~~~~
6 |
7 | Requirements:
8 | Extra name: ``console``
9 |
10 | `aioconsole
22 |
145 |
23 |
81 | Plugs
24 | {%- if host.plugs %} 25 | 36 | {%- else %} 37 |None loaded.
38 | {%- endif %} 39 |Channels
40 | {%- if host.channels %} 41 | 51 | {%- else %} 52 |None defined.
53 | {%- endif %} 54 |Groups
55 | {%- if host.groups %} 56 | 65 | {%- else %} 66 |None defined.
67 | {%- endif %} 68 | 80 |
82 |
144 | Resources
83 | {%- if host.resources %} 84 | 95 | {%- else %} 96 |None loaded.
97 | {%- endif %} 98 |Hooks
99 | {%- if host.hooks %} 100 | 111 | {%- else %} 112 |None loaded.
113 | {%- endif %} 114 |