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
|
/*
Copyright (C) 2021-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"
bool SignalBackup::dumpMedia(std::string const &dir, std::vector<std::string> const &daterangelist,
std::vector<long long int> const &threads, bool excludestickers, bool overwrite) const
{
Logger::message("Dumping media to dir '", dir, "'");
if (!d_database.containsTable(d_part_table) || !d_database.tableContainsColumn(d_part_table, "display_order"))
{
Logger::error("Database too badly damaged or too old, dumping media is not (yet) supported, consider a full decrypt by just passing a directory as output");
return false;
}
// check if dir exists, create if not
if (!prepareOutputDirectory(dir, overwrite))
return false;
std::pair<std::vector<int>, std::vector<std::string>> conversations; // links thread_id to thread title, if the
// folder already exists, but from another _id,
// it is a different thread with the same name
// minimal query, for incomplete database
bool fullbackup = false;
std::string query = "SELECT " +
d_part_table + "." + d_part_mid + ", " +
d_part_table + "." + d_part_ct + ", " +
d_part_table + ".file_name, " +
d_part_table + ".display_order"
" FROM " + d_part_table + " WHERE " + d_part_table + "._id == ?" +
(d_database.tableContainsColumn(d_part_table, "unique_id") ? " AND unique_id == ?" : "") +
((excludestickers && d_database.tableContainsColumn(d_part_table, "sticker_id")) ? " AND sticker_id = -1" : "");
// if all tables for detailed info are present...
if (d_database.containsTable(d_mms_table) && d_database.containsTable("thread") &&
d_database.containsTable("groups") && d_database.containsTable("recipient"))
{
fullbackup = true;
query = "SELECT " +
d_part_table + "." + d_part_mid + ", " +
d_part_table + "." + d_part_ct + ", " +
d_part_table + ".file_name, " +
d_part_table + ".display_order, " +
d_mms_table + ".date_received, " +
d_mms_table + "." + d_mms_type + ", " +
d_mms_table + ".thread_id, "
"thread." + d_thread_recipient_id + ", "
"COALESCE(NULLIF(groups.title, ''), " +
(d_database.containsTable("distribution_list") ? "NULLIF(distribution_list.name, ''), " : "") +
(d_database.tableContainsColumn("recipient", "nickname_joined_name") ? "NULLIF(recipient.nickname_joined_name, ''),"s : ""s) +
"NULLIF(recipient." + d_recipient_system_joined_name + ", ''), " +
(d_database.tableContainsColumn("recipient", "profile_joined_name") ? "NULLIF(recipient.profile_joined_name, ''),"s : ""s) +
"NULLIF(recipient." + d_recipient_profile_given_name + ", '')) AS 'chatpartner'"
" FROM " + d_part_table + " "
"LEFT JOIN " + d_mms_table + " ON " + d_part_table + "." + d_part_mid + " == " + d_mms_table + "._id "
"LEFT JOIN thread ON " + d_mms_table + ".thread_id == thread._id "
"LEFT JOIN recipient ON thread." + d_thread_recipient_id + " == recipient._id "
"LEFT JOIN groups ON recipient.group_id == groups.group_id " +
(d_database.containsTable("distribution_list") ? "LEFT JOIN distribution_list ON recipient._id = distribution_list.recipient_id " : "") +
"WHERE " + d_part_table + "._id == ?" +
(d_database.tableContainsColumn(d_part_table, "unique_id") ? " AND unique_id == ?" : "") +
((excludestickers && d_database.tableContainsColumn(d_part_table, "sticker_id")) ? " AND sticker_id = -1" : "");
}
if (!threads.empty())
{
query += " AND thread._id IN (";
for (unsigned int i = 0; i < threads.size(); ++i)
query += bepaald::toString(threads[i]) + ((i == threads.size() - 1) ? ")" : ",");
}
if (!daterangelist.empty())
{
// create dateranges
std::vector<std::pair<std::string, std::string>> dateranges;
if (daterangelist.size() % 2 == 0)
for (unsigned int i = 0; i < daterangelist.size(); i += 2)
dateranges.push_back({daterangelist[i], daterangelist[i + 1]});
std::string datewhereclause;
for (unsigned int i = 0; i < dateranges.size(); ++i)
{
bool needrounding = false;
long long int startrange = dateToMSecsSinceEpoch(dateranges[i].first);
long long int endrange = dateToMSecsSinceEpoch(dateranges[i].second, &needrounding);
if (startrange == -1 || endrange == -1 || endrange < startrange)
{
Logger::error("Skipping range: '", dateranges[i].first, " - ", dateranges[i].second, "'. Failed to parse or invalid range.");
Logger::error_indent(startrange, " ", endrange);
continue;
}
if (d_verbose) [[unlikely]]
Logger::message(" Using range: ", dateranges[i].first, " - ", dateranges[i].second, " (", startrange, " - ", endrange, ")");
if (needrounding)// if called with "YYYY-MM-DD HH:MM:SS"
endrange += 999; // to get everything in the second specified...
dateranges[i].first = bepaald::toString(startrange);
dateranges[i].second = bepaald::toString(endrange);
datewhereclause += (datewhereclause.empty() ? " AND (" : " OR ") + "date_received BETWEEN "s + dateranges[i].first + " AND " + dateranges[i].second;
if (i == dateranges.size() - 1)
datewhereclause += ')';
}
query += datewhereclause;
}
if (d_verbose) [[unlikely]]
Logger::message("Dump media query: ", query);
#if __cplusplus > 201703L
for (int count = 1; auto const &aframe : d_attachments)
#else
int count = 1;
for (auto const &aframe : d_attachments)
#endif
{
Logger::message_overwrite("Saving attachments... ", count, "/", d_attachments.size());
AttachmentFrame *a = aframe.second.get();
//std::cout << "Looking for attachment: " << std::endl;
//std::cout << "rid: " << a->rowId() << std::endl;
//std::cout << "uid: " << a->attachmentId() << std::endl;
SqliteDB::QueryResults results;
uint64_t rowid = a->rowId();
int64_t uniqueid = a->attachmentId();
if (uniqueid == 0)
uniqueid = -1;
if (d_database.tableContainsColumn(d_part_table, "unique_id"))
{
if (!d_database.exec(query, {rowid, uniqueid}, &results))
return false;
}
else // no "unique_id" in part table
if (!d_database.exec(query, rowid, &results))
return false;
//results.prettyPrint();
if (results.rows() == 0 && (!threads.empty() || !daterangelist.empty())) // probably an attachment for a de-selected thread
continue;
if (results.rows() != 1)
{
Logger::error("Unexpected number of results: ", results.rows(), " (rowid: ", a->rowId(), ", uniqueid: ", a->attachmentId(), ")");
continue;
}
std::string filename;
long long int datum = a->attachmentId(); // only works on older dbs...
if (fullbackup && !results.isNull(0, "date_received"))
datum = results.getValueAs<long long int>(0, "date_received");
long long int order = results.getValueAs<long long int>(0, "display_order");
if (!results.isNull(0, "file_name")) // file name IS SET in database
filename = sanitizeFilename(results.valueAsString(0, "file_name"));
if (filename.empty()) // filename was not set in database or was not impossible
{ // to sanitize (eg reserved name in windows 'COM1')
std::ostringstream tmp;
if (datum != -1) [[likely]]
{
// get datestring
std::time_t epoch = datum / 1000;
tmp << std::put_time(std::localtime(&epoch), "signal-%Y-%m-%d-%H%M%S");
//tmp << "." << datum % 1000;
}
else
tmp << "signal";
// get file ext
std::string mime = results.valueAsString(0, d_part_ct);
std::string ext = std::string(MimeTypes::getExtension(mime));
if (ext.empty())
{
ext = "attach";
Logger::warning("mimetype not found in database (", mime, ") -> saving as '", tmp.str(), ".", ext, "'");
}
//build filename
filename = tmp.str() + ((order) ? ("_" + bepaald::toString(order)) : "") + "." + ext;
}
// std::cout << "FILENAME: " << filename << std::endl;
std::string targetdir = dir;
if (fullbackup && !results.isNull(0, "thread_id") && !results.isNull(0, "chatpartner")
&& !results.isNull(0, d_mms_type))
{
long long int tid = results.getValueAs<long long int>(0, "thread_id");
std::string chatpartner = sanitizeFilename(results.valueAsString(0, "chatpartner"));
if (chatpartner.empty())
chatpartner = "Contact " + bepaald::toString(tid);
int idx_of_thread = -1;
if ((idx_of_thread = bepaald::findIdxOf(conversations.first, tid)) == -1) // idx not found
{
if (std::find(conversations.second.begin(), conversations.second.end(), chatpartner) == conversations.second.end()) // chatpartner not used yet
{
// add it
conversations.first.push_back(tid);
conversations.second.push_back(chatpartner);
idx_of_thread = conversations.second.size() - 1;
}
else // new conversation, but another conversation with same name already exists!
{
// get unique conversation name
chatpartner += "(2)";
while (std::find(conversations.second.begin(), conversations.second.end(), chatpartner) != conversations.second.end())
chatpartner += "(2)";
conversations.first.push_back(tid);
conversations.second.push_back(chatpartner);
idx_of_thread = conversations.second.size() - 1;
}
} // else, thread was found, use the name that was used before
// create dir if not exists
if (!bepaald::isDir(dir + "/" + conversations.second[idx_of_thread]))
{
// std::cout << " Creating subdirectory '" << conversations.second[idx_of_thread] << "' for conversation..." << std::endl;
if (!bepaald::createDir(dir + "/" + conversations.second[idx_of_thread]))
{
//std::cout << " ERROR creating directory '" << dir << "/" << conversations.second[idx_of_thread] << "'" << std::endl;
Logger::error("Failed to create directory '", dir, "/", conversations.second[idx_of_thread], "'");
continue;
}
}
long long int msg_box = results.getValueAs<long long int>(0, d_mms_type);
targetdir = dir + "/" + conversations.second[idx_of_thread] + "/" + (Types::isOutgoing(msg_box) ? "sent" : "received");
// create dir if not exists
if (!bepaald::isDir(targetdir))
{
//std::cout << " Creating subdirectory '" << targetdir << "' for conversation..." << std::endl;
if (!bepaald::createDir(targetdir))
{
Logger::error("Failed to create directory '", targetdir, "'");
continue;
}
}
}
// make filename unique
if (!makeFilenameUnique(targetdir, &filename))
{
Logger::error("getting unique filename for '", targetdir, "/", filename, "'");
continue;
}
/*
while (bepaald::fileOrDirExists(targetdir + "/" + filename))
{
//std::cout << std::endl << "File exists: " << targetdir << "/" << filename << " -> ";
std::filesystem::path p(filename);
std::regex numberedfile(".*( \\(([0-9]*)\\))$");
std::smatch sm;
std::string filestem(p.stem().string());
std::string ext(p.extension().string());
int counter = 2;
if (regex_match(filestem, sm, numberedfile) && sm.size() >= 3 && sm[2].matched)
{
// increase the counter
counter = bepaald::toNumber<int>(sm[2]) + 1;
// remove " (xx)" part from stem
filestem.erase(sm[1].first, sm[1].second);
}
filename = filestem + " (" + bepaald::toString(counter) + ")" + p.extension().string();
//std::cout << filename << std::endl;
}
*/
std::ofstream attachmentstream(targetdir + "/" + filename, std::ios_base::binary);
if (!attachmentstream.is_open())
{
Logger::error("Failed to open file for writing: '", targetdir, "/", filename, "'");
continue;
}
++count;
if (!attachmentstream.write(reinterpret_cast<char *>(a->attachmentData()), a->attachmentSize()))
{
Logger::error("Failed to write data to file: '", targetdir, "/", filename, "'");
a->clearData();
continue;
}
attachmentstream.close(); // need to close, or the auto-close will change files mtime again.
a->clearData();
if (!setFileTimeStamp(targetdir + "/" + filename, datum)) [[unlikely]]
Logger::warning("Failed to set timestamp for attachment '", targetdir, "/", filename, "'");
// !! ifdef c++20
//std::error_code ec;
//std::filesystem::last_write_time(dir + "/" + chatpartner + "/" + filename, std::chrono::clock_cast<std::filesystem::file_time_type>(datum / 1000), ec);
}
Logger::message_overwrite("Saving attachments... done.", Logger::Control::ENDOVERWRITE);
return true;
}
|