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
|
/*
Copyright (C) 2019-2025 Selwin van Dijk
This file is part of signalbackup-tools.
signalbackup-tools is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
signalbackup-tools is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with signalbackup-tools. If not, see <https://www.gnu.org/licenses/>.
*/
#include "signalbackup.ih"
void SignalBackup::initFromFile()
{
if (!d_fd->ok())
{
Logger::message("Failed to create filedecrypter");
return;
}
// open file
std::ifstream backupfile(d_filename, std::ios_base::binary | std::ios_base::in);
if (!backupfile.is_open()) [[unlikely]]
{
Logger::error("Failed to open file '", d_filename, "'");
return;
}
int64_t totalsize = d_fd->total();
int prev_progress = 2000; // note this number will be max 1000 (10 * 100%), so this is an invalid number (to trigger on 0).
if (d_verbose || !d_showprogress) [[unlikely]]
Logger::message_overwrite("Reading backup file...");
else
Logger::message_overwrite("Reading backup file: 000.0%...");
std::unique_ptr<BackupFrame> frame;
d_database.exec("BEGIN TRANSACTION");
// get frames and handle them until file is fully read or error is encountered
while ((frame = d_fd->getFrame(backupfile)))
{
if (d_fd->badMac()) [[unlikely]]
{
dumpInfoOnBadFrame(&frame);
if (d_stoponerror)
return;
}
if (d_showprogress) [[likely]]
{
int64_t progress = (static_cast<float>(backupfile.tellg()) / totalsize) * 1000;
if (progress != prev_progress ||
d_verbose)
{
//std::cout << "Progress: " << progress << " " << std::fixed << (static_cast<float>(progress) / 10) << std::endl;
if (d_verbose) [[unlikely]]
Logger::message_overwrite("FRAME ", frame->frameNumber(), ": ", std::fixed, std::setprecision(1), std::setw(5), std::setfill('0'),
(static_cast<float>(progress) / 10), std::defaultfloat, "%...");
else
Logger::message_overwrite("Reading backup file:", " ", std::fixed, std::setprecision(1), std::setw(5), std::setfill('0'),
(static_cast<float>(progress) / 10), std::defaultfloat, "%...");
prev_progress = progress;
}
}
//if (frame->frameNumber() > 73085)
// frame->printInfo();
//MEMINFO("At frame ", frame->frameNumber(), " (", frame->frameTypeString(), ")");
if (frame->frameType() == BackupFrame::FRAMETYPE::SQLSTATEMENT) [[likely]]
{
SqlStatementFrame *s = reinterpret_cast<SqlStatementFrame *>(frame.get());
if (!STRING_STARTS_WITH(s->bindStatement(), "CREATE TABLE sqlite_")) [[likely]] // skip creation of sqlite_ internal db's
{
// NOTE: in the official import, there are other tables that are skipped (virtual tables for search data)
// we lazily do not check for them here, since we are dealing with official exported files which do not contain
// these tables as they are excluded on the export-side as well. Additionally, the official import should be able
// to properly deal with them anyway (that is: ignore them)
if (!d_database.exec(s->bindStatement(), s->parameters())) [[unlikely]]
Logger::warning("Failed to execute statement: ", s->statement());
}
#ifdef BUILT_FOR_TESTING
else if (s->statement().find("CREATE TABLE sqlite_sequence") != std::string::npos)
{
// force early creation of sqlite_sequence table, this is completely unnecessary and only used
// to get byte-identical backups during testing
Logger::message("BUILT_FOR_TESTING : Forcing early creation of sqlite_sequence");
d_database.exec("CREATE TABLE dummy (_id INTEGER PRIMARY KEY AUTOINCREMENT)");
d_database.exec("DROP TABLE dummy");
d_found_sqlite_sequence_in_backup = true;
}
#endif
}
else if (frame->frameType() == BackupFrame::FRAMETYPE::ATTACHMENT)
{
AttachmentFrame *a = reinterpret_cast<AttachmentFrame *>(frame.release());
if (d_fulldecode) [[unlikely]]
{
a->attachmentData(nullptr, d_verbose);
a->clearData();
}
int64_t attachmentid = a->attachmentId();
d_attachments.emplace(std::make_pair(a->rowId(), attachmentid ? attachmentid : -1), a);
}
else if (frame->frameType() == BackupFrame::FRAMETYPE::AVATAR)
{
AvatarFrame *a = reinterpret_cast<AvatarFrame *>(frame.release());
if (d_fulldecode) [[unlikely]]
{
a->attachmentData(nullptr, d_verbose);
a->clearData();
}
d_avatars.emplace_back(std::string((d_databaseversion < 33) ? a->name() : a->recipient()), a);
}
else if (frame->frameType() == BackupFrame::FRAMETYPE::STICKER)
{
StickerFrame *s = reinterpret_cast<StickerFrame *>(frame.release());
if (d_fulldecode) [[unlikely]]
{
s->attachmentData(nullptr, d_verbose);
s->clearData();
}
d_stickers.emplace(s->rowId(), s);
}
else if (frame->frameType() == BackupFrame::FRAMETYPE::SHAREDPREFERENCE)
{
//frame->printInfo();
d_sharedpreferenceframes.emplace_back(reinterpret_cast<SharedPrefFrame *>(frame.release()));
}
else if (frame->frameType() == BackupFrame::FRAMETYPE::KEYVALUE)
{
//frame->printInfo();
d_keyvalueframes.emplace_back(reinterpret_cast<KeyValueFrame *>(frame.release()));
}
else if (frame->frameType() == BackupFrame::FRAMETYPE::HEADER)
{
d_headerframe.reset(reinterpret_cast<HeaderFrame *>(frame.release()));
d_backupfileversion = d_headerframe->version();
if (d_verbose) [[unlikely]]
d_headerframe->printInfo();
}
else if (frame->frameType() == BackupFrame::FRAMETYPE::DATABASEVERSION)
{
d_databaseversionframe.reset(reinterpret_cast<DatabaseVersionFrame *>(frame.release()));
d_databaseversion = d_databaseversionframe->version();
if (d_verbose) [[unlikely]]
Logger::message("Database version: ", d_databaseversionframe->version());
}
else if (frame->frameType() == BackupFrame::FRAMETYPE::END)
{
//frame->printInfo();
if (d_verbose) [[unlikely]]
Logger::message("Read EndFrame");
d_endframe.reset(reinterpret_cast<EndFrame *>(frame.release()));
}
else [[unlikely]] // if (frame->frameType() == BackupFrame::FRAMETYPE::INVALID)
{
Logger::warning(Logger::Control::BOLD, "SKIPPING INVALID FRAME! (", frame->frameType(), ")", Logger::Control::NORMAL);
}
}
d_database.exec("COMMIT");
if (!d_badattachments.empty()) [[unlikely]]
{
Logger::message("Attachment data with BAD MAC was encountered:");
dumpInfoOnBadFrames();
}
//std::cout << "" << std::endl;
if (d_fd->badMac()) [[unlikely]]
{
if (d_stoponerror)
return;
}
if (!d_endframe) [[unlikely]]
{
Logger::warning("EndFrame was not read: backup is probably incomplete");
addEndFrame();
}
if (backupfile.tellg() == totalsize && d_showprogress) [[likely]]
Logger::message_overwrite("Reading backup file:", " 100.0%... done!", Logger::Control::ENDOVERWRITE);
/*
#warning REMOVE ME
// INJECT SOME OTHER SQLITE DATABASE
{
// NOTE THIS LEAKS
std::pair<unsigned char *, uint64_t> *data = new std::pair<unsigned char *, uint64_t>;
std::ifstream file("WITH_SOME_STORIES_PRESENT/database.sqlite");
file.seekg(0, std::ios_base::end);
data->second = file.tellg();
file.seekg(0);
data->first = new unsigned char[data->second];
file.read(reinterpret_cast<char *>(data->first), data->second);
d_database = MemSqliteDB(data);
}
*/
d_ok = setColumnNames();
}
|
