406 | {{msg.event_data | safe}} has a new safety number
407 |
408 | {% elif msg.type == 'group-update-v1' or msg.type == 'group-update-v2' %}
409 |
410 |
411 | {% if msg.event_data.header %}
{{msg.event_data.header}}{% endif %}
412 |
413 | {% if msg.event_data.name %}- Name: {{msg.event_data.name}}{% endif %}
414 | {% for member_list in msg.event_data.member_lists %}
415 |
- {{member_list.header}}
416 |
417 | {% for member in member_list.members %}
418 | - {{member | safe}}
419 | {% endfor %}
420 |
421 | {% endfor %}
422 |
423 |
424 | {% if msg.attachments %}
425 | {% for attach in msg.attachments %}
426 |
Group photo
427 | {{ attachment(attach) }}
428 | {% endfor %}
429 | {% endif %}
430 | {% if debug_messages %}
431 |
{{msg.body}}
432 | {% endif %}
433 | {% else %}
434 |
435 | {% if msg.isGroup and msg.type == 'incoming' %}
436 |
{{ msg.name }}
437 | {% endif %}
438 | {% if msg.quote %}
439 |
440 |
441 |
{{ msg.quote.name }}
442 |
{{ msg.quote.body | safe }}
443 |
444 | {% if msg.quote.attachments %}
445 |
446 | {% for attach in msg.quote.attachments %}
447 | {{ attachment(attach) }}
448 | {% endfor %}
449 |
450 | {% endif %}
451 |
452 | {% endif %}
453 | {% if msg.attachments %}
454 | {% for attach in msg.attachments %}
455 | {{ attachment(attach) }}
456 | {% endfor %}
457 | {% endif %}
458 | {% if msg.body %}
459 | {% if msg.isAllEmoji %}
460 |
461 | {% else %}
462 |
463 | {% endif %}
464 |
{{ msg.body | safe }}
465 |
466 | {% endif %}
467 | {% endif %}
468 |
{{ message_metadata(msg.date, msg.secure, msg.send_state, msg.isGroup, msg.delivery_receipt_count, msg.read_receipt_count) }}
469 | {% if msg.reactions %}
470 |
471 | {% for reaction in msg.reactions %}
472 | {{reaction.what}}From {{reaction.name}}
Sent {{reaction.time_sent.strftime(date_time_format)}}
Received {{reaction.time_received.strftime(date_time_format)}}
473 | {% endfor %}
474 |
475 | {% endif %}
476 | {% endif %}
477 |
478 | {% endfor %}
479 |
480 |
481 |
482 |
--------------------------------------------------------------------------------
/signal2html/types.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 |
3 | """Utilities for dealing with message types
4 |
5 | These are extracted from the Signal Android app source code.
6 |
7 | License: See LICENSE file.
8 |
9 | """
10 |
11 | from enum import Enum
12 |
13 | BASE_TYPE_MASK = 0x1F
14 |
15 | INCOMING_AUDIO_CALL_TYPE = 1
16 | OUTGOING_AUDIO_CALL_TYPE = 2
17 | MISSED_AUDIO_CALL_TYPE = 3
18 | JOINED_TYPE = 4
19 | UNSUPPORTED_MESSAGE_TYPE = 5
20 | INVALID_MESSAGE_TYPE = 6
21 | MISSED_VIDEO_CALL_TYPE = 8
22 | INCOMING_VIDEO_CALL_TYPE = 10
23 | OUTGOING_VIDEO_CALL_TYPE = 11
24 | GROUP_CALL_TYPE = 12
25 |
26 | KEY_UPDATE_TYPE_BIT = 0x200
27 |
28 | GROUP_CTRL_TYPE_BIT = 0x10000
29 | GROUP_V2_DATA_TYPE_BIT = 0x80000
30 |
31 | SECURE_BIT = 0x800000
32 |
33 | BASE_INBOX_TYPE = 20
34 | BASE_OUTBOX_TYPE = 21
35 | BASE_SENDING_TYPE = 22
36 | BASE_SENT_TYPE = 23
37 | BASE_SENT_FAILED_TYPE = 24
38 | BASE_PENDING_SECURE_SMS_FALLBACK = 25
39 | BASE_PENDING_INSECURE_SMS_FALLBACK = 26
40 | BASE_DRAFT_TYPE = 27
41 |
42 | OUTGOING_MESSAGE_TYPES = [
43 | BASE_OUTBOX_TYPE,
44 | BASE_SENT_TYPE,
45 | BASE_SENDING_TYPE,
46 | BASE_SENT_FAILED_TYPE,
47 | BASE_PENDING_SECURE_SMS_FALLBACK,
48 | BASE_PENDING_INSECURE_SMS_FALLBACK,
49 | ]
50 |
51 |
52 | class DisplayType(Enum):
53 | DISPLAY_TYPE_NONE = 0
54 | DISPLAY_TYPE_PENDING = 1
55 | DISPLAY_TYPE_SENT = 2
56 | DISPLAY_TYPE_FAILED = 3
57 | DISPLAY_TYPE_DELIVERED = 4
58 | DISPLAY_TYPE_READ = 5
59 |
60 | @classmethod
61 | def from_state(
62 | cls, _type: int, is_delivered: bool = False, is_read: bool = False
63 | ):
64 | if not is_outgoing_message_type(_type):
65 | return cls.DISPLAY_TYPE_NONE
66 |
67 | if is_read:
68 | return cls.DISPLAY_TYPE_READ
69 |
70 | if is_delivered:
71 | return cls.DISPLAY_TYPE_DELIVERED
72 |
73 | base_type = _type & BASE_TYPE_MASK
74 |
75 | if base_type == BASE_SENT_FAILED_TYPE:
76 | return cls.DISPLAY_TYPE_FAILED
77 |
78 | if base_type == BASE_SENT_TYPE:
79 | return cls.DISPLAY_TYPE_SENT
80 |
81 | if (
82 | base_type == BASE_OUTBOX_TYPE
83 | or base_type == BASE_SENDING_TYPE
84 | or base_type == BASE_PENDING_SECURE_SMS_FALLBACK
85 | or base_type == BASE_PENDING_INSECURE_SMS_FALLBACK
86 | ):
87 | return cls.DISPLAY_TYPE_PENDING
88 |
89 | return cls.DISPLAY_TYPE_NONE
90 |
91 |
92 | def is_outgoing_message_type(_type):
93 | for outgoingType in OUTGOING_MESSAGE_TYPES:
94 | if _type & BASE_TYPE_MASK == outgoingType:
95 | return True
96 | return False
97 |
98 |
99 | def is_inbox_type(_type):
100 | return _type & BASE_TYPE_MASK == BASE_INBOX_TYPE
101 |
102 |
103 | def is_incoming_call(_type):
104 | return _type in (INCOMING_AUDIO_CALL_TYPE, INCOMING_VIDEO_CALL_TYPE)
105 |
106 |
107 | def is_outgoing_call(_type):
108 | return _type in (OUTGOING_AUDIO_CALL_TYPE, OUTGOING_VIDEO_CALL_TYPE)
109 |
110 |
111 | def is_missed_call(_type):
112 | return _type in (MISSED_AUDIO_CALL_TYPE, MISSED_VIDEO_CALL_TYPE)
113 |
114 |
115 | def is_video_call(_type):
116 | return _type in (
117 | INCOMING_VIDEO_CALL_TYPE,
118 | OUTGOING_VIDEO_CALL_TYPE,
119 | MISSED_VIDEO_CALL_TYPE,
120 | )
121 |
122 |
123 | def is_group_call(_type):
124 | return _type == GROUP_CALL_TYPE
125 |
126 |
127 | def is_key_update(_type):
128 | return _type & KEY_UPDATE_TYPE_BIT == KEY_UPDATE_TYPE_BIT
129 |
130 |
131 | def is_secure(_type):
132 | return _type & SECURE_BIT == SECURE_BIT
133 |
134 |
135 | def is_group_ctrl(_type):
136 | return _type & GROUP_CTRL_TYPE_BIT == GROUP_CTRL_TYPE_BIT
137 |
138 |
139 | def is_group_v2_data(_type):
140 | return _type & GROUP_V2_DATA_TYPE_BIT == GROUP_V2_DATA_TYPE_BIT
141 |
142 |
143 | def is_joined_type(_type):
144 | return _type & BASE_TYPE_MASK == JOINED_TYPE
145 |
146 |
147 | def get_named_message_type(_type):
148 | if is_group_ctrl(_type):
149 | if is_group_v2_data(_type):
150 | return "group-update-v2"
151 | else:
152 | return "group-update-v1"
153 | elif is_key_update(_type):
154 | return "key-update"
155 | elif is_outgoing_message_type(_type):
156 | return "outgoing"
157 | elif is_inbox_type(_type):
158 | return "incoming"
159 | elif is_incoming_call(_type):
160 | return (
161 | "video-call-incoming" if is_video_call(_type) else "call-incoming"
162 | )
163 | elif is_outgoing_call(_type):
164 | return (
165 | "video-call-outgoing" if is_video_call(_type) else "call-outgoing"
166 | )
167 | elif is_missed_call(_type):
168 | return "video-call-missed" if is_video_call(_type) else "call-missed"
169 | elif is_group_call(_type):
170 | return "group-call"
171 | elif is_joined_type(_type):
172 | return "joined"
173 | return "unknown"
174 |
--------------------------------------------------------------------------------
/signal2html/ui.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 |
3 | """User interface for command line script
4 |
5 | License: See LICENSE file.
6 |
7 | """
8 |
9 | import argparse
10 |
11 | from pathlib import Path
12 |
13 | from . import __version__
14 | from .core import process_backup
15 |
16 |
17 | def parse_args():
18 | parser = argparse.ArgumentParser()
19 | parser.add_argument(
20 | "-i", "--input-dir", help="Input directory", required=True, type=Path
21 | )
22 | parser.add_argument(
23 | "-o", "--output-dir", help="Output directory", required=True, type=Path
24 | )
25 | parser.add_argument(
26 | "-V",
27 | "--version",
28 | help="Show version and exit",
29 | action="version",
30 | version=__version__,
31 | )
32 | return parser.parse_args()
33 |
34 |
35 | def main():
36 | args = parse_args()
37 | process_backup(args.input_dir, args.output_dir)
38 |
--------------------------------------------------------------------------------
/signal2html/versioninfo.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 | # -*- coding: utf-8 -*-
3 |
4 | """Class grouping version-specific information from the signal database.
5 |
6 | This file in the Signal source can be used to determine when features were
7 | introduced:
8 |
9 | https://github.com/signalapp/Signal-Android/blob/master/app/src/main/java/org/thoughtcrime/securesms/database/helpers/SignalDatabaseMigrations.kt
10 |
11 | License: See LICENSE file.
12 |
13 | """
14 |
15 | import logging
16 |
17 | logger = logging.getLogger(__name__)
18 |
19 |
20 | class VersionInfo(object):
21 | def __init__(self, version):
22 | self.version = int(version)
23 | logger.info(f"Found Signal database version: {version}.")
24 |
25 | def is_tested_version(self) -> bool:
26 | """Returns whether the database version has been tested.
27 |
28 | Testing and pull requests welcome."""
29 |
30 | return self.version in [18, 23, 65, 80, 89, 110]
31 |
32 | def is_addressbook_using_rids(self) -> bool:
33 | """Returns whether the contacts are structured using recipient IDs.
34 |
35 | Previous versions referred to contacts using their phone numbers or a
36 | special group ID."""
37 |
38 | return self.version >= 24
39 |
40 | def get_reactions_query_column(self) -> str:
41 | """Returns a SQL expression to retrieve reactions to MMS messages."""
42 |
43 | return "reactions" if self.version >= 37 else "''"
44 |
45 | def are_mentions_supported(self) -> bool:
46 | """Returns whether the mentions table is present."""
47 | return self.version >= 68
48 |
49 | def get_quote_mentions_query_column(self) -> str:
50 | """Returns a SQL expression to retrieve quote mentions in MMS messages."""
51 |
52 | return "quote_mentions" if self.are_mentions_supported() else "''"
53 |
54 | def get_viewed_receipt_count_column(self) -> str:
55 | """Returns a SQL expression to retrieve the viewed receipt count of attachments of MMS messages."""
56 |
57 | return "viewed_receipt_count" if self.version >= 83 else "'0'"
58 |
59 | def get_thread_recipient_id_column(self) -> str:
60 | """Returns SQL expression to retrieve recipient id from thread table"""
61 | return (
62 | "thread_recipient_id" if self.version >= 108 else "recipient_ids"
63 | )
64 |
--------------------------------------------------------------------------------
/tests/test_linkify.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 | # -*- coding: utf-8 -*-
3 |
4 | import unittest
5 |
6 | from signal2html.linkify import linkify
7 |
8 |
9 | class TestLinkify(unittest.TestCase):
10 | _CASES = [
11 | (
12 | "Lorem ipsum www.example.com dolor sit amet",
13 | 'Lorem ipsum
www.example.com dolor sit amet',
14 | ),
15 | (
16 | "Lorem ipsum example.com dolor sit amet",
17 | 'Lorem ipsum
example.com dolor sit amet',
18 | ),
19 | (
20 | "Lorem ipsum https://www.example.com",
21 | 'Lorem ipsum
https://www.example.com',
22 | ),
23 | ("lorem.ipsum.dolor sit amet", "lorem.ipsum.dolor sit amet"),
24 | (
25 | "Lorem ipsum www.example.yoga dolor sit amet",
26 | 'Lorem ipsum
www.example.yoga dolor sit amet',
27 | ),
28 | (
29 | "Lorem ipsum https://timhein.ninja dolor sit amet",
30 | 'Lorem ipsum
https://timhein.ninja dolor sit amet',
31 | ),
32 | (
33 | "Lorem ipsum test@example.com etc.",
34 | 'Lorem ipsum
test@example.com etc.',
35 | ),
36 | ]
37 |
38 | def test_linkify(self):
39 | for message, expected in self._CASES:
40 | with self.subTest(message=message):
41 | self.assertEqual(expected, linkify(message))
42 |
43 |
44 | if __name__ == "__main__":
45 | unittest.main()
46 |
--------------------------------------------------------------------------------
/tests/test_versioninfo.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 | # -*- coding: utf-8 -*-
3 |
4 | import unittest
5 |
6 | from signal2html.versioninfo import VersionInfo
7 |
8 |
9 | class TestVersionInfo(unittest.TestCase):
10 | def test_init(self):
11 | vi = VersionInfo(10)
12 | self.assertEqual(vi.version, 10)
13 |
14 | def test_is_addressbook_using_rids(self):
15 | vi = VersionInfo(10)
16 | self.assertFalse(vi.is_addressbook_using_rids())
17 | vi = VersionInfo(24)
18 | self.assertTrue(vi.is_addressbook_using_rids())
19 | vi = VersionInfo(110)
20 | self.assertTrue(vi.is_addressbook_using_rids())
21 |
22 | def test_get_reactions_query_column(self):
23 | vi = VersionInfo(18)
24 | self.assertEqual(vi.get_reactions_query_column(), "''")
25 | vi = VersionInfo(37)
26 | self.assertEqual(vi.get_reactions_query_column(), "reactions")
27 | vi = VersionInfo(80)
28 | self.assertEqual(vi.get_reactions_query_column(), "reactions")
29 |
30 | def test_are_mentions_supported(self):
31 | vi = VersionInfo(18)
32 | self.assertFalse(vi.are_mentions_supported())
33 | vi = VersionInfo(68)
34 | self.assertTrue(vi.are_mentions_supported())
35 | vi = VersionInfo(100)
36 | self.assertTrue(vi.are_mentions_supported())
37 |
38 | def test_get_quote_mentions_query_column(self):
39 | vi = VersionInfo(18)
40 | self.assertEqual(vi.get_quote_mentions_query_column(), "''")
41 | vi = VersionInfo(68)
42 | self.assertEqual(
43 | vi.get_quote_mentions_query_column(), "quote_mentions"
44 | )
45 | vi = VersionInfo(100)
46 | self.assertEqual(
47 | vi.get_quote_mentions_query_column(), "quote_mentions"
48 | )
49 |
50 | def test_get_thread_recipient_id_column(self):
51 | vi = VersionInfo(18)
52 | self.assertEqual(vi.get_thread_recipient_id_column(), "recipient_ids")
53 | vi = VersionInfo(108)
54 | self.assertEqual(
55 | vi.get_thread_recipient_id_column(), "thread_recipient_id"
56 | )
57 | vi = VersionInfo(110)
58 | self.assertEqual(
59 | vi.get_thread_recipient_id_column(), "thread_recipient_id"
60 | )
61 |
62 |
63 | if __name__ == "__main__":
64 | unittest.main()
65 |
--------------------------------------------------------------------------------
12 |