1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
#!/usr/bin/env python3
"""
matrix-mcnt: A CLI script to count unread messages from a Matrix account.
"""
import asyncio
import argparse
import getpass
import sys
import subprocess
from nio import(
AsyncClient,
MatrixRoom,
RoomMessageText,
LoginResponse,
RoomInfo,
responses
)
from typing import Optional
FETCH_DELAY = 30 # if running in the background, check for new messages every 30 seconds
async def get_creds(pw_path: str) -> Optional[str]:
try:
res = subprocess.run(
["pass", pw_path],
capture_output=True,
text=True,
check=True
)
return res.stdout.strip()
except FileNotFoundError:
print(f"Warning: 'pass' command not found", file=sys.stderr)
return None
except subprocess.CalledProcessError as e:
if e.stderr:
print(f"Warning: Failed to get password from store: {e.stderr.strip()}",
file=sys.stderr)
return None
async def client_login(
hserv: str,
usr_id: str,
pw_path: str
) -> Optional[AsyncClient]:
client = AsyncClient(hserv, usr_id)
passwd = await get_creds(pw_path) or getpass.getpass(f"Password for {usr_id}: ")
if not isinstance(await client.login(passwd), LoginResponse):
return None
return client
async def main(args) -> None:
client = None
HOME = args.homeserver
USERNAME = args.username
USER_ID = f"@{USERNAME}:{HOME}"
EXCLUDE = args.exclude_rooms
INCLUDE = args.rooms
PW_PATH = args.pass_path
try:
client = await client_login(
f"https://{HOME}", USER_ID, PW_PATH)
if not client:
sys.exit(1)
sync_resp = await client.sync(timeout=30000, full_state=True)
rooms = await get_rooms(
client,
sync_resp,
INCLUDE,
EXCLUDE
)
if args.print_rooms:
for room in rooms:
print(f"{room['room_id']} | {room['display_name']} | Unread: {room['unread_count']}")
if args.bg:
try:
next_batch = sync_resp.next_batch
while True:
sync_resp = await client.sync(
timeout=10000,
since=next_batch,
full_state=True
)
next_batch = sync_resp.next_batch
rooms = await get_rooms(
client,
sync_resp,
INCLUDE,
EXCLUDE
)
print('\r', end='')
print(await sum_unread(client, rooms), end='', flush=True)
await asyncio.sleep(FETCH_DELAY)
except KeyboardInterrupt:
print("\nStopping background sync...")
else:
print(await sum_unread(client, rooms))
except Exception as e:
print(f"Error: {e}")
finally:
if client:
await client.logout()
await client.close()
async def sum_unread(client: AsyncClient, rooms: list[dict]) -> int:
return sum(room["unread_count"] for room in rooms)
async def get_rooms(
client: AsyncClient,
sync_response,
INCLUDE_ONLY_ROOM_IDS: list[str],
EXCLUDE_ROOM_IDS: list[str]
) -> list[dict]:
rooms = []
for room_id, room in client.rooms.items():
if INCLUDE_ONLY_ROOM_IDS and room_id not in INCLUDE_ONLY_ROOM_IDS:
continue
if room_id in EXCLUDE_ROOM_IDS:
continue
unread = 0
if room_id in sync_response.rooms.join:
room_info = sync_response.rooms.join[room_id]
if hasattr(room_info, "unread_notifications"):
unread = room_info.unread_notifications.notification_count
rooms.append({
"room_id": room_id,
"display_name": room.display_name,
"unread_count": unread
})
return rooms
if __name__ == "__main__":
parser = argparse.ArgumentParser(
description="matrix-mcnt: Matrix Unread Message Count"
)
parser.add_argument(
"--username",
required=True,
help="eg. 'myusername' not '@myusername:matrix.org'"
# otherwise conflict arises if --homeserver is supplied
)
parser.add_argument(
"--pass-path",
help="Password-store path ie. 'Matrix/my_user_name/access-token'" + "or 'Matrix/my_user_name/pass'",
)
parser.add_argument(
"--homeserver",
default="matrix.org",
help="eg. 'matrix.org' or 'matrix.server.com'"
)
parser.add_argument(
"--rooms",
help="A list of Room(s) ID(s) to strictly include (eg. '!Abcdefghijklmnopqr' '!2Abcdefghijklmnopq')",
nargs="+",
default=[],
)
parser.add_argument(
"--exclude-rooms",
help="Room IDs to strictly exclude eg. '!Abcdefghijklmnopqr' '!2Abcdefghijklmnopq'",
nargs="+",
default=[],
)
parser.add_argument(
"--print-rooms",
help="Print all matching rooms",
action="store_true"
)
parser.add_argument(
"--bg",
help="Run script in background",
action="store_true"
)
asyncio.run(main(parser.parse_args()))
|