-
Notifications
You must be signed in to change notification settings - Fork 0
/
signal_formatter.py
331 lines (292 loc) · 10.5 KB
/
signal_formatter.py
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
#!/usr/bin/env python3
"""Format the contents of a Signal backup as HTML."""
__author__ = "Adrian Welcker"
__version__ = "0.1"
__license__ = """Copyright 2021 Adrian Welcker
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE."""
import datetime
import pathlib
import sqlite3
import sys
import typing
from dataclasses import dataclass
from shutil import copy2
MIME_EXT = {
'image/png': 'png',
'image/jpeg': 'jpg',
'image/webp': 'webp',
'image/gif': 'gif',
'application/pdf': 'pdf',
'video/mp4': 'mp4',
'video/webm': 'webm',
'audio/aac': 'aac'
}
def prepare_output(target: pathlib.Path):
"""Create target directory and write stylesheet."""
target.mkdir(parents=True, exist_ok=True)
with open(target/'style.css', 'w') as f:
f.write("""
/* Heavily inspired by: https://codepen.io/samuelkraft/pen/Farhl */
:root {
--send-bg: #0B93F6;
--send-color: white;
--receive-bg: #E5E5EA;
--receive-text: black;
--page-background: white;
--info-text: #777;
}
body {
font-family: "Helvetica Neue", Helvetica, sans-serif;
font-size: 20px;
font-weight: normal;
max-width: 500px;
margin: 50px auto;
display: flex;
flex-direction: column;
background-color: var(--page-background);
}
div {
max-width: 305px;
word-wrap: break-word;
margin-bottom: 12px;
line-height: 24px;
position: relative;
padding: 10px 20px;
border-radius: 25px;
}
div::before, div::after {
content: "";
position: absolute;
bottom: 0;
height: 25px;
}
.send {
color: var(--send-color);
background: var(--send-bg);
align-self: flex-end;
}
.send::before {
right: -7px;
width: 20px;
background-color: var(--send-bg);
border-bottom-left-radius: 16px 14px;
}
.send::after {
right: -26px;
width: 26px;
background-color: var(--page-background);
border-bottom-left-radius: 10px;
}
.receive {
background: var(--receive-bg);
color: black;
align-self: flex-start;
}
.receive::before {
left: -7px;
width: 20px;
background-color: var(--receive-bg);
border-bottom-right-radius: 16px 14px;
}
.receive::after {
left: -26px;
width: 26px;
background-color: var(--page-background);
border-bottom-right-radius: 10px;
}
.sender {
font-size: small;
margin-top: 0px;
margin-bottom: 0px;
padding-top: 2px;
padding-bottom: 1px;
padding-left: 10px;
bottom: 0px;
color: var(--info-text);
font-weight: bold;
}
p.sent {
font-size: x-small;
line-height: 0px;
font-weight: bold;
}
.receive>p.sent {
text-align: right;
margin-right: -5px;
color: #555555;
}
.send>p.sent {
margin-left: -5px;
color: #eaeaea;
}
.date {
display: block;
margin-left: auto;
margin-right: auto;
margin-bottom: 0px;
padding-bottom: 0px;
font-size: small;
font-weight: bold;
color: var(--info-text);
}
""")
def write_prelude(target: typing.TextIO, name: str):
"""Write the prelude of a particular thread file."""
target.write(f"""
<!DOCTYPE html>
<html>
<head>
<title>{name}</title>
<link rel="stylesheet" href="style.css">
</head>
<body>
<h1>{name}</h1>
""")
def write_footer(target: typing.TextIO):
target.write("""
<a href="index.html">Return</a>
</body>
</html>
""")
@dataclass
class Message:
id: int
date: int
sender: int
body: str
def to_html(self, senders=None):
if self.body is not None:
result = ""
if senders is not None and self.sender is not None:
result = f"""<p class="sender">{senders[self.sender]}</p>"""
result += f"""<div class="{'send' if self.sender is None else 'receive'}">{self.body.replace(chr(10), '<br/>')}<p class="sent">{datetime.datetime.fromtimestamp(self.date/1000).strftime("%H:%M")}</p></div>"""
return result
class SMS(Message):
pass
class MMS(Message):
def mms_to_html(self, src, target, cursor, senders=None):
"""Render this message as HTML.
Produces HTML code to display this message. Also copies attachments
as necessary.
"""
content = ""
cursor.execute('select _id as id, ct, file_name, unique_id from part where mid = ?', (self.id,))
atts = cursor.fetchall()
for att in atts:
src_file = src/f'Attachment_{att[0]}_{att[3]}.bin'
if att[1] in MIME_EXT:
target_file = target/(f'{att[3]}_{att[2]}' if att[2] is not None else f'Attachment{att[0]}.{MIME_EXT[att[1]]}')
else:
target_file = target / src_file.name
copy2(src_file, target_file)
if att[1] in ('image/png', 'image/jpeg', 'image/webp', 'image/gif'):
content += f'<img src="{target_file.name}" width="100%">'
elif att[1] == 'audio/aac' and att[2] is None:
content += f'Voice message:<audio controls src="{target_file.name}"></audio>'
elif att[1] == 'video/mp4':
content += f'<video controls width="100%"><source src="{target_file.name}" type="video/mp4"></video>'
elif att[1] == 'application/pdf':
content += f'<a href="{target_file.name}">PDF Document</a>'
else:
content += f'<a href="{target_file.name}">Unknown attachment</a>'
if self.body:
content += self.body.replace('\n', '<br>')
if content:
if senders is not None and self.sender is not None:
sendinfo = f'<p class="sender">{senders[self.sender]}</p>'
else:
sendinfo = ''
return f"""{sendinfo}<div class="{'send' if self.sender is None else 'receive'}">{content}<p class="sent">{datetime.datetime.fromtimestamp(self.date/1000).strftime("%H:%M")}</p></div>"""
return ""
def format_indiv_thread(cursor: sqlite3.Cursor, thread, src: pathlib.Path, target: pathlib.Path) -> bool:
"""
:param cursor: The connection cursor
:param thread: The thread to format
:param src: The source folder.
:param target: The output folder in which to write the HTML file, if necessary
:return: True if any messages were found and written.
"""
msgs = load_messages(cursor, thread)
if not msgs:
# no results, this thread is empty
return False
last_date_written = datetime.date(1970, 1, 1)
with open(target/f'{thread[0]}.html', 'w', encoding='utf-8') as f:
write_prelude(f, thread[4])
for msg in msgs:
msg_date = datetime.datetime.fromtimestamp(msg.date/1000).date()
if msg_date != last_date_written:
f.write(f'<div class="date">{msg_date}</div>')
last_date_written = msg_date
if isinstance(msg, SMS) and msg.body is not None:
f.write(msg.to_html())
elif isinstance(msg, MMS):
f.write(msg.mms_to_html(src, target, cursor))
write_footer(f)
return True
def format_group_thread(cursor: sqlite3.Cursor, thread, recips, src: pathlib.Path, target: pathlib.Path) -> bool:
msgs = load_messages(cursor, thread)
if not msgs:
# no results, this thread is empty
return False
last_date_written = datetime.date(1970, 1, 1)
with open(target/f'{thread[0]}.html', 'w', encoding='utf-8') as f:
write_prelude(f, thread[3])
for msg in msgs:
msg_date = datetime.datetime.fromtimestamp(msg.date / 1000).date()
if msg_date != last_date_written:
f.write(f'<div class="date">{msg_date.strftime("%Y-%m-%d")}</div>')
last_date_written = msg_date
if isinstance(msg, SMS) and msg.body is not None:
f.write(msg.to_html(recips))
elif isinstance(msg, MMS):
f.write(msg.mms_to_html(src, target, cursor, recips))
write_footer(f)
return True
def load_messages(cursor, thread):
"""Load text and multimedia messages for a particular thread from the DB"""
sms: list[Message] = [SMS(*m) for m in cursor.execute(
'select _id, date, NULL, body from sms where thread_id = ? and protocol is NULL union select _id, date, address, body from sms where thread_id = ? and protocol is not null',
(thread[0], thread[0]))]
mms: list[Message] = [MMS(*m) for m in cursor.execute(
'select _id, date, NULL, body from mms where thread_id = ? and m_type = 128 union select _id, date, address, body from mms where thread_id = ? and m_type != 128',
(thread[0], thread[0]))]
msgs: list[Message] = sorted(sms + mms, key=lambda x: x.date)
return msgs
def main(argv):
src = pathlib.Path(argv[1])
target = pathlib.Path(argv[2])
conn = sqlite3.connect(src/'database.sqlite')
cur = conn.cursor()
cur.execute('select _id, phone, system_display_name from recipient')
recipients = {x[0]: (x[2] if x[2] is not None else x[1]) for x in cur.fetchall()}
cur.execute('select thread._id, thread_recipient_id AS recipient, uuid, phone, system_display_name from thread join recipient r on thread.thread_recipient_id = r._id where group_id is null')
indiv_threads = cur.fetchall()
cur.execute('select thread._id, recipient_id, group_id, title from thread join groups g on thread_recipient_id = g.recipient_id')
group_threads = cur.fetchall()
prepare_output(target)
index = open(target/'index.html', 'w')
for t in indiv_threads:
print(f"Writing {t[4]}", file=sys.stderr)
if format_indiv_thread(cur, t, src, target):
index.write(f'<p><a href="{t[0]}.html">{t[4]}</a></p>')
for t in group_threads:
print(f"Writing {t[3]}", file=sys.stderr)
if format_group_thread(cur, t, recipients, src, target):
index.write(f'<p><a href="{t[0]}.html">{t[3]}</a></p>')
if __name__ == "__main__":
sys.exit(main(sys.argv))