Initial commit.
This commit is contained in:
commit
354ada0742
|
|
@ -0,0 +1,2 @@
|
|||
/.idea
|
||||
/queueprocdata
|
||||
|
|
@ -0,0 +1,202 @@
|
|||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
|
@ -0,0 +1,65 @@
|
|||
# Matrix Queue Processor (matrix_queue_proc)
|
||||
|
||||
This is a quickly-thrown-together script which will:
|
||||
|
||||
- retrieve unread text messages in a [Matrix](https://matrix.org) room
|
||||
- execute a script of your choice for each one
|
||||
- mark (✅ reaction) or redact those messages on success (0); or
|
||||
- reply with the process's exit code on failure.
|
||||
- exit once all those messages are processed.
|
||||
- (it is currently intended for occasional usage rather than continuous usage, but continuous usage may appear in the future.)
|
||||
|
||||
|
||||
## Use cases
|
||||
|
||||
- archiving (youtube-dl, archivebox, etc...)
|
||||
- e.g. using the 'Share' function on a mobile phone to enqueue links
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
python3 mxqueueproc.py <room ID> <command to run>
|
||||
```
|
||||
|
||||
If you prefer messages to be **redacted** rather than **✅-reacted**, use
|
||||
|
||||
```
|
||||
MXQP_REDACT=1 python3 mxqueueproc.py <room ID> <command to run>
|
||||
```
|
||||
|
||||
e.g.
|
||||
|
||||
`python3 mxqueueproc.py !some_room_id:example.com youtube-dl`
|
||||
|
||||
### Installation and set-up
|
||||
|
||||
* Set up a Python 3 virtual environment `python3 -m venv path/to/venv`
|
||||
* Activate it! `. path/to/env/activate`
|
||||
* Install requirements `pip install -r requirements.txt`
|
||||
* Activate this venv again whenever you wish to run mxqueueproc.
|
||||
|
||||
On first run, Matrix Queue Processor will guide you through a login.
|
||||
|
||||
You will need:
|
||||
|
||||
* your homeserver URL (e.g. `https://matrix.org`)
|
||||
* your username (e.g. `reivilibre`)
|
||||
* your password (e.g. `nottellingYOUofcourse`)
|
||||
|
||||
|
||||
### For more advanced commands
|
||||
|
||||
For more complicated commands, it may be worthwhile (or even required) to create e.g. a bash script
|
||||
|
||||
```bash
|
||||
#!/bin/bash
|
||||
set -eu
|
||||
task=$1
|
||||
|
||||
do_something --serious-business --wow=very $1
|
||||
```
|
||||
|
||||
(`set -eu` makes undefined variables and command errors cause failure, so that the bot will report it to you.)
|
||||
|
||||
Don't forget to mark it as executable.
|
||||
|
|
@ -0,0 +1,261 @@
|
|||
# Copyright 2021 Olivier 'reivilibre'
|
||||
# This file is part of https://bics.ga/reivilibre/matrix_queue_proc
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
import asyncio
|
||||
import json
|
||||
import os
|
||||
import subprocess
|
||||
import sys
|
||||
from asyncio import Semaphore
|
||||
from getpass import getpass
|
||||
from pathlib import Path
|
||||
from typing import Union, List
|
||||
|
||||
from nio import (
|
||||
AsyncClient,
|
||||
AsyncClientConfig,
|
||||
LoginResponse,
|
||||
LoginError,
|
||||
SyncResponse,
|
||||
RoomGetStateError,
|
||||
RoomGetStateResponse,
|
||||
RoomGetStateEventError,
|
||||
RoomGetStateEventResponse,
|
||||
RoomContextError,
|
||||
RoomContextResponse,
|
||||
BadEvent,
|
||||
Event,
|
||||
UnknownBadEvent,
|
||||
MegolmEvent,
|
||||
EncryptionError,
|
||||
RoomMessageText,
|
||||
RoomMessageNotice,
|
||||
MessageDirection,
|
||||
RoomMessagesError,
|
||||
RoomMessagesResponse,
|
||||
)
|
||||
from nio.client.async_client import ResponseCb
|
||||
from nio.store import SqliteStore
|
||||
|
||||
|
||||
class QueueProcBot:
|
||||
def __init__(self, data_path: Path):
|
||||
self.client: AsyncClient = None # type: ignore
|
||||
self.data_path = data_path
|
||||
self._sync_forever_task = None
|
||||
|
||||
data_path.mkdir(exist_ok=True)
|
||||
|
||||
async def connect(self):
|
||||
cconfig = AsyncClientConfig(
|
||||
# store=SqliteStore
|
||||
)
|
||||
|
||||
login_info_path = Path(self.data_path, "login_info.json")
|
||||
reusing_login = login_info_path.exists()
|
||||
|
||||
user_id = None
|
||||
username = None
|
||||
password = None
|
||||
access_token = None
|
||||
device_id = None
|
||||
|
||||
if reusing_login:
|
||||
print(f"Reusing connection from {login_info_path}.", file=sys.stderr)
|
||||
with open(login_info_path, "r") as fin:
|
||||
login_info = json.load(fin)
|
||||
homeserver = login_info["homeserver"]
|
||||
user_id = login_info["user_id"]
|
||||
access_token = login_info["access_token"]
|
||||
device_id = login_info["device_id"]
|
||||
else:
|
||||
print("New connection.")
|
||||
homeserver = input("Enter homeserver such as https://matrix.org: ")
|
||||
username = input("Enter username: ")
|
||||
password = getpass("Enter Matrix password")
|
||||
|
||||
store_path = Path(self.data_path, "nio_store")
|
||||
store_path.mkdir(exist_ok=True)
|
||||
self.client = AsyncClient(
|
||||
homeserver, user_id or username, store_path=store_path, config=cconfig
|
||||
)
|
||||
|
||||
if reusing_login:
|
||||
self.client.restore_login(user_id, device_id, access_token)
|
||||
return True
|
||||
else:
|
||||
lrp = await self.client.login(
|
||||
password, device_name="Matrix Queue Processor"
|
||||
)
|
||||
if isinstance(lrp, LoginResponse):
|
||||
login_info = {
|
||||
"homeserver": homeserver,
|
||||
"user_id": lrp.user_id,
|
||||
"device_id": lrp.device_id,
|
||||
"access_token": lrp.access_token,
|
||||
}
|
||||
with open(login_info_path, "w") as fout:
|
||||
print("Saving login information.", file=sys.stderr)
|
||||
json.dump(login_info, fout)
|
||||
return True
|
||||
elif isinstance(lrp, LoginError):
|
||||
print(f"Error logging in\n\t{lrp}", file=sys.stderr)
|
||||
return False
|
||||
|
||||
async def startup(self):
|
||||
monitor = Semaphore(value=0)
|
||||
resp_cb = None
|
||||
|
||||
async def good_to_go(_resp):
|
||||
print("Synced!")
|
||||
monitor.release()
|
||||
self.client.response_callbacks.remove(resp_cb)
|
||||
|
||||
resp_cb = ResponseCb(good_to_go, SyncResponse)
|
||||
|
||||
self.client.response_callbacks.append(resp_cb)
|
||||
self._sync_forever_task = asyncio.create_task(self.client.sync_forever())
|
||||
|
||||
await monitor.acquire()
|
||||
|
||||
async def process_events(
|
||||
self,
|
||||
events: List[Union[Event, BadEvent, UnknownBadEvent]],
|
||||
program: str,
|
||||
room_id: str,
|
||||
delete_on_success: bool,
|
||||
):
|
||||
for event in events:
|
||||
# print(event.event_id, event.__class__.__name__)
|
||||
if isinstance(event, MegolmEvent):
|
||||
print("!!! Megolm Event :(", event.event_id)
|
||||
try:
|
||||
await asyncio.sleep(2)
|
||||
print(self.client.decrypt_event(event))
|
||||
except EncryptionError:
|
||||
print("failed to decrypt")
|
||||
elif isinstance(event, RoomMessageText):
|
||||
text = event.body
|
||||
print(f"Task: {text}")
|
||||
|
||||
exit_code = await asyncio.get_event_loop().run_in_executor(
|
||||
None, subprocess.call, [program, text]
|
||||
)
|
||||
|
||||
if exit_code == 0:
|
||||
if delete_on_success:
|
||||
await self.client.room_send(
|
||||
room_id,
|
||||
"m.reaction",
|
||||
{
|
||||
"m.relates_to": {
|
||||
"rel_type": "m.annotation",
|
||||
"event_id": event.event_id,
|
||||
"key": "✅",
|
||||
}
|
||||
},
|
||||
ignore_unverified_devices=True,
|
||||
)
|
||||
else:
|
||||
await self.client.room_redact(room_id, event.event_id)
|
||||
else:
|
||||
await self.client.room_send(
|
||||
room_id,
|
||||
"m.room.message",
|
||||
{
|
||||
"m.relates_to": {
|
||||
"m.in_reply_to": {"event_id": event.event_id}
|
||||
},
|
||||
"msgtype": "m.notice",
|
||||
"body": f"Failed with exit code {exit_code}.",
|
||||
},
|
||||
)
|
||||
|
||||
# update our marker
|
||||
await self.client.room_read_markers(
|
||||
room_id, event.event_id, event.event_id
|
||||
)
|
||||
|
||||
# cooldown.
|
||||
await asyncio.sleep(5)
|
||||
|
||||
async def catch_up(self, room_id: str, program: str, delete_on_success: bool):
|
||||
room = self.client.rooms[room_id]
|
||||
|
||||
start_at = room.fully_read_marker
|
||||
|
||||
if start_at is None:
|
||||
print("No fully read marker")
|
||||
room_creation_event = await self.client.room_get_state_event(
|
||||
room_id, "m.room.create"
|
||||
)
|
||||
if isinstance(room_creation_event, RoomGetStateEventError):
|
||||
raise RuntimeError(str(room_creation_event))
|
||||
assert isinstance(room_creation_event, RoomGetStateEventResponse)
|
||||
|
||||
start_at = room_creation_event.content["event_id"]
|
||||
|
||||
print("Starting at: ", start_at)
|
||||
|
||||
context = await self.client.room_context(room_id, start_at)
|
||||
if isinstance(context, RoomContextError):
|
||||
raise RuntimeError(str(context))
|
||||
assert isinstance(context, RoomContextResponse)
|
||||
|
||||
await self.process_events(
|
||||
context.events_after, program, room_id, delete_on_success
|
||||
)
|
||||
|
||||
next_batch = context.end
|
||||
|
||||
while True:
|
||||
messages = await self.client.room_messages(
|
||||
room_id,
|
||||
next_batch,
|
||||
direction=MessageDirection.front,
|
||||
)
|
||||
if isinstance(messages, RoomMessagesError):
|
||||
raise RuntimeError(str(messages))
|
||||
assert isinstance(messages, RoomMessagesResponse)
|
||||
|
||||
next_batch = messages.end
|
||||
|
||||
if len(messages.chunk) == 0:
|
||||
break
|
||||
|
||||
await self.process_events(messages.chunk, program, room_id)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
if len(sys.argv) < 3:
|
||||
print("Usage: mxprocqueue.py <room_id> <processing script>")
|
||||
print("Set MXQP_REDACT=1 to redact messages on success.")
|
||||
sys.exit(127)
|
||||
room_id = sys.argv[1]
|
||||
command = sys.argv[2]
|
||||
|
||||
bot = QueueProcBot(Path("./queueprocdata")) # TODO configurability
|
||||
|
||||
async def main():
|
||||
print("Logging in...")
|
||||
await bot.connect()
|
||||
print("Syncing...")
|
||||
await bot.startup()
|
||||
print("Catching up...")
|
||||
delete_on_success = os.environ.get("MXQP_REDACT") == "1"
|
||||
await bot.catch_up(room_id, command, delete_on_success)
|
||||
print("Done?")
|
||||
|
||||
asyncio.get_event_loop().run_until_complete(main())
|
||||
|
|
@ -0,0 +1 @@
|
|||
matrix-nio[e2e]
|
||||
Loading…
Reference in New Issue