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 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
|
/*
Copyright (©) 2003-2025 Teus Benschop.
This program 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.
This program 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 this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#include <sendreceive/notes.h>
#include <filter/url.h>
#include <filter/roles.h>
#include <filter/string.h>
#include <filter/merge.h>
#include <filter/date.h>
#include <filter/archive.h>
#include <tasks/logic.h>
#include <config/globals.h>
#include <database/config/general.h>
#include <database/config/bible.h>
#include <database/notes.h>
#include <database/noteactions.h>
#include <database/logs.h>
#include <database/state.h>
#include <client/logic.h>
#include <locale/translate.h>
#include <webserver/request.h>
#include <sync/logic.h>
#include <sync/notes.h>
#include <checksum/logic.h>
#include <bb/logic.h>
#include <notes/logic.h>
int sendreceive_notes_watchdog = 0;
std::string sendreceive_notes_text ()
{
return translate("Notes") + ": ";
}
std::string sendreceive_notes_sendreceive_text ()
{
return sendreceive_notes_text () + translate ("Send/receive");
}
std::string sendreceive_notes_up_to_date_text ()
{
return sendreceive_notes_text () + translate ("Up to date");
}
void sendreceive_notes ()
{
if (sendreceive_notes_watchdog) {
int time = filter::date::seconds_since_epoch ();
if (time < (sendreceive_notes_watchdog + 900)) {
Database_Logs::log (sendreceive_notes_text () + translate("Still busy"), roles::translator);
return;
}
Database_Logs::log (sendreceive_notes_text () + translate("Watchdog timeout"), roles::translator);
}
sendreceive_notes_kick_watchdog ();
config_globals_syncing_notes = true;
bool success = sendreceive_notes_upload ();
// After all note actions have been sent to the server, and the notes updated on the client,
// the client will now sync its notes with the server's notes.
if (success) {
success = sendreceive_notes_download (Notes_Logic::lowNoteIdentifier, Notes_Logic::highNoteIdentifier);
}
if (success) Database_Logs::log (sendreceive_notes_up_to_date_text (), roles::translator);
sendreceive_notes_watchdog = 0;
config_globals_syncing_notes = false;
}
// Upload all note actions to the server.
bool sendreceive_notes_upload ()
{
Webserver_Request webserver_request;
Sync_Logic sync_logic (webserver_request);
Database_Notes database_notes (webserver_request);
Database_NoteActions database_noteactions = Database_NoteActions ();
Database_Logs::log (sendreceive_notes_sendreceive_text (), roles::translator);
std::string response = client_logic_connection_setup ("", "");
int iresponse = filter::strings::convert_to_int (response);
if (iresponse < roles::guest || iresponse > roles::admin) {
Database_Logs::log (sendreceive_notes_text () + translate("Failure to initiate connection"), roles::translator);
return false;
}
// Set the correct user in the session: The sole user on the Client.
std::vector <std::string> users = webserver_request.database_users ()->get_users ();
if (users.empty ()) {
Database_Logs::log (sendreceive_notes_text () + translate("No local user found"), roles::translator);
return false;
}
std::string user = users [0];
webserver_request.session_logic ()->set_username (user);
// The basic request to be POSTed to the server.
// It contains the user's credentials.
std::map <std::string, std::string> post;
post ["u"] = filter::strings::bin2hex (user);
post ["p"] = webserver_request.database_users ()->get_md5 (user);
post ["l"] = std::to_string (webserver_request.database_users ()->get_level (user));
// Error variable.
std::string error;
// Server URL to call.
std::string address = database::config::general::get_server_address ();
int port = database::config::general::get_server_port ();
std::string url = client_logic_url (address, port, sync_notes_url ());
// Check on communication errors to be careful that there will be no loss of notes data on the client.
// While sending updates for a certai note identifier,
// make sure to take the most recent update if there's more than one in the database for that identifier.
// Go through all notes which have actions recorded for them.
// While sending note actions, the database method to retrieve them
// keeps the sequence of the actions as they occurred,
// as later updates can undo or affect earlier updates.
std::vector <int> notes = database_noteactions.getNotes ();
for (auto identifier : notes) {
std::string summary = database_notes.get_summary (identifier);
if (summary.empty ()) summary = "<deleted>";
Database_Logs::log (sendreceive_notes_text () + translate("Sending note to server") + ": " + summary, roles::translator);
// Get all the actions for the current note.
std::vector <Database_Note_Action> note_actions = database_noteactions.getNoteData (identifier);
// Due to some updates sent out here, record final actions to get the updated note from the server.
std::map <int, bool> final_get_actions;
// Deal with the note actions for this note.
for (auto note_action : note_actions) {
int rowid = note_action.rowid;
std::string username = note_action.username;
//int timestamp = note_action.timestamp;
int action = note_action.action;
std::string content = note_action.content;
// Generate a POST request.
post ["i"] = std::to_string (identifier);
post ["a"] = std::to_string (action);
switch (action) {
case Sync_Logic::notes_put_create_initiate: break;
case Sync_Logic::notes_put_create_complete: break;
case Sync_Logic::notes_put_summary:
{
content = database_notes.get_summary (identifier);
break;
}
case Sync_Logic::notes_put_contents: break;
case Sync_Logic::notes_put_comment: break;
case Sync_Logic::notes_put_subscribe: break;
case Sync_Logic::notes_put_unsubscribe: break;
case Sync_Logic::notes_put_assign: break;
case Sync_Logic::notes_put_unassign: break;
case Sync_Logic::notes_put_status:
{
content = database_notes.get_raw_status (identifier);
break;
}
case Sync_Logic::notes_put_passages:
{
content = database_notes.decode_passage (identifier);
break;
}
case Sync_Logic::notes_put_severity:
{
content = std::to_string (database_notes.get_raw_severity (identifier));
break;
}
case Sync_Logic::notes_put_bible:
{
content = database_notes.get_bible (identifier);
break;
}
case Sync_Logic::notes_put_mark_delete: break;
case Sync_Logic::notes_put_unmark_delete: break;
case Sync_Logic::notes_put_delete: break;
default: break;
}
post ["c"] = content;
// Send the request off and receive the response.
sendreceive_notes_kick_watchdog ();
response = sync_logic.post (post, url, error);
if (!error.empty ()) {
Database_Logs::log (sendreceive_notes_text () + "Failure sending note: " + error, roles::translator);
return false;
}
// Delete this note action because it has been dealt with.
database_noteactions.erase (rowid);
// Add final note actions depending on what was updated.
switch (action) {
case Sync_Logic::notes_put_create_initiate: break;
case Sync_Logic::notes_put_create_complete:
{
int i = Sync_Logic::notes_get_contents;
final_get_actions [i] = true;
i = Sync_Logic::notes_get_subscribers;
final_get_actions [i] = true;
i = Sync_Logic::notes_get_assignees;
final_get_actions [i] = true;
i = Sync_Logic::notes_get_modified;
final_get_actions [i] = true;
break;
}
case Sync_Logic::notes_put_summary: break;
case Sync_Logic::notes_put_contents: break;
case Sync_Logic::notes_put_comment:
{
int i = Sync_Logic::notes_get_contents;
final_get_actions [i] = true;
i = Sync_Logic::notes_get_subscribers;
final_get_actions [i] = true;
i = Sync_Logic::notes_get_assignees;
final_get_actions [i] = true;
i = Sync_Logic::notes_get_modified;
final_get_actions [i] = true;
break;
}
case Sync_Logic::notes_put_subscribe: break;
case Sync_Logic::notes_put_unsubscribe: break;
case Sync_Logic::notes_put_assign: break;
case Sync_Logic::notes_put_unassign: break;
case Sync_Logic::notes_put_status: break;
case Sync_Logic::notes_put_passages: break;
case Sync_Logic::notes_put_severity: break;
case Sync_Logic::notes_put_bible: break;
case Sync_Logic::notes_put_mark_delete: break;
case Sync_Logic::notes_put_unmark_delete: break;
case Sync_Logic::notes_put_delete: break;
default: break;
}
}
// Deal with the extra, added, note actions.
for (int action = Sync_Logic::notes_get_total; action <= Sync_Logic::notes_get_modified; action++) {
std::map <std::string, std::string> post2;
post2 ["u"] = filter::strings::bin2hex (user);
post2 ["i"] = std::to_string (identifier);
post2 ["a"] = std::to_string (action);
sendreceive_notes_kick_watchdog ();
response = sync_logic.post (post2, url, error);
if (error.empty ()) {
if (action == Sync_Logic::notes_get_contents) {
if (response != database_notes.get_contents (identifier)) {
database_notes.set_contents (identifier, response);
}
}
if (action == Sync_Logic::notes_get_subscribers) {
std::vector <std::string> subscribers = filter::strings::explode (response, '\n');
database_notes.set_subscribers (identifier, subscribers);
}
if (action == Sync_Logic::notes_get_assignees) {
std::vector <std::string> assignees = filter::strings::explode (response, '\n');
database_notes.set_assignees (identifier, assignees);
}
if (action == Sync_Logic::notes_get_modified) {
database_notes.set_modified (identifier, filter::strings::convert_to_int (response));
}
}
}
}
return true;
}
// The function is called with the first and last note identifier to deal with.
bool sendreceive_notes_download (int lowId, int highId)
{
Webserver_Request webserver_request;
Database_Notes database_notes (webserver_request);
Database_NoteActions database_noteactions = Database_NoteActions ();
Sync_Logic sync_logic (webserver_request);
std::string response = client_logic_connection_setup ("", "");
int iresponse = filter::strings::convert_to_int (response);
if (iresponse < roles::guest || iresponse > roles::admin) {
Database_Logs::log (sendreceive_notes_text () + translate("Failure to initiate connection"), roles::translator);
return false;
}
// The client is supposed to have one user.
// Get this username, plus the md5 hash of the password,
// in preparation for sending it to the server in in the script below.
// The server will use this user to find out the Bibles this user has access to,
// so the server can select the correct notes for this user.
// The client selects all available notes on the system.
std::vector <std::string> users = webserver_request.database_users ()->get_users ();
if (users.empty ()) {
Database_Logs::log (sendreceive_notes_text () + translate("No local user found"), roles::translator);
return false;
}
std::string user = users [0];
webserver_request.session_logic ()->set_username (user);
std::string password = webserver_request.database_users ()->get_md5 (user);
// Check for the health of the notes databases and take action if needed.
bool healthy = true;
if (!database_notes.healthy ()) healthy = false;
if (!database_notes.checksums_healthy ()) healthy = false;
if (!healthy) {
Database_Logs::log (sendreceive_notes_text () + "Abort receive just now because of database problems", roles::translator);
return false;
}
// Server URL to call.
std::string address = database::config::general::get_server_address ();
int port = database::config::general::get_server_port ();
std::string url = client_logic_url (address, port, sync_notes_url ());
// The basic request to be POSTed to the server.
std::map <std::string, std::string> post;
post ["u"] = filter::strings::bin2hex (user);
post ["l"] = std::to_string (lowId);
post ["h"] = std::to_string (highId);
// Error variable.
std::string error;
// The script requests the total note count from the server, and their total checksum.
// It compares this with the local notes.
// If it matches, that means that the local notes match the notes on the server.
// The script is then ready.
post ["a"] = std::to_string (Sync_Logic::notes_get_total);
// Response comes after a relatively long delay: Enable burst mode timing.
sendreceive_notes_kick_watchdog ();
response = sync_logic.post (post, url, error, true);
if (!error.empty ()) {
Database_Logs::log (sendreceive_notes_text () + "Failure requesting totals: " + error, roles::translator);
return false;
}
std::vector <std::string> vresponse = filter::strings::explode (response, '\n');
int server_total = 0;
if (vresponse.size () >= 1) server_total = filter::strings::convert_to_int (vresponse [0]);
std::string server_checksum;
if (vresponse.size () >= 2) server_checksum = vresponse [1];
std::vector <int> identifiers = database_notes.get_notes_in_range_for_bibles (lowId, highId, {}, true);
int client_total = static_cast<int>(identifiers.size());
// Checksum cache to speed things up in case of thousands of notes.
std::string client_checksum = Database_State::getNotesChecksum (lowId, highId);
if (client_checksum.empty ()) {
client_checksum = database_notes.get_multiple_checksum (identifiers);
Database_State::putNotesChecksum (lowId, highId, client_checksum);
}
if (server_total == client_total) {
if (server_checksum == client_checksum) {
return true;
}
}
// At this stage the total note count and/or their checksum on the client differs
// from the total note count and/or their checksum on the server.
// This applies to a certain range of notes for certain Bibles.
// We know the total number of notes.
// If the total note count is too high, divide the range of notes into smaller ranges,
// and then deal with each range.
if (server_total > 20) {
std::vector <Sync_Logic_Range> ranges = sync_logic.create_range (lowId, highId);
for (auto range : ranges) {
sendreceive_notes_download (range.low, range.high);
}
return true;
}
// At this stage the total note count is small enough that the function can
// start to deal with the individual notes.
// It requests the note identifiers, their checksums,
// and compares them with the local notes.
// If needed, it downloads the notes from the server.
// If needed, the client removes local notes no longer available on the server.
// Get note identifiers and checksums as on the server.
post ["a"] = std::to_string (Sync_Logic::notes_get_identifiers);
sendreceive_notes_kick_watchdog ();
response = sync_logic.post (post, url, error);
if (!error.empty ()) {
Database_Logs::log (sendreceive_notes_text () + "Failure requesting identifiers: " + error, roles::translator);
return false;
}
std::vector <int> server_identifiers;
std::vector <std::string> server_checksums;
vresponse = filter::strings::explode (response, '\n');
for (size_t i = 0; i < vresponse.size (); i++) {
if (i % 2 == 0) {
int identifier = filter::strings::convert_to_int (vresponse [i]);
if (identifier > 0) server_identifiers.push_back (identifier);
}
else server_checksums.push_back (vresponse [i]);
}
// Get note identifiers as locally on the client.
std::vector <int> client_identifiers = database_notes.get_notes_in_range_for_bibles (lowId, highId, {}, true);
// The client deletes notes no longer on the server.
// But it skips the notes that have actions recorded for them,
// as these notes are scheduled to be sent to the server first.
identifiers = filter::strings::array_diff (client_identifiers, server_identifiers);
int delete_counter = 0;
for (auto identifier : identifiers) {
if (database_noteactions.exists (identifier)) continue;
// It has been seen that a client started to delete all notes, thousands of them, for an unknown reason.
// The reason may have been a miscommunication between client and server.
// And then, next send/receive, it started to re-download all thousands of them from the server.
// Therefore limit the number of notes a client can delete in one go.
delete_counter++;
if (delete_counter > 15) continue;
std::string summary = database_notes.get_summary (identifier);
database_notes.erase (identifier);
Database_Logs::log (sendreceive_notes_text () + "Deleting because it is not on the server: " + summary, roles::translator);
}
// Check whether the local notes on the client match the ones on the server.
// If needed, download the note from the server.
std::vector <std::string> identifiers_bulk_download;
for (size_t i = 0; i < server_identifiers.size (); i++) {
if (i >= server_checksums.size ()) continue;
int identifier = server_identifiers [i];
// Skip note if it is still to be sent off to the server.
if (database_noteactions.exists (identifier)) continue;
std::string server_checksum_note = server_checksums [i];
std::string client_checksum_note = database_notes.get_checksum (identifier);
if (client_checksum_note == server_checksum_note) continue;
// Store the identifier to be downloaded as part of a bulk download.
identifiers_bulk_download.push_back (std::to_string (identifier));
}
// Download the notes in bulk from the Cloud, for faster transfer.
if (!identifiers_bulk_download.empty ()) {
sendreceive_notes_kick_watchdog ();
if (identifiers_bulk_download.size () >= 3) {
Database_Logs::log (sendreceive_notes_text () + "Receiving multiple notes: " + std::to_string (identifiers_bulk_download.size ()), roles::manager);
}
// Request the JSON from the Cloud: It will contain the requested notes.
post.clear ();
post ["a"] = std::to_string (Sync_Logic::notes_get_bulk);
std::string bulk_identifiers = filter::strings::implode (identifiers_bulk_download, "\n");
post ["b"] = bulk_identifiers;
std::string json = sync_logic.post (post, url, error);
if (!error.empty ()) {
Database_Logs::log (sendreceive_notes_text () + "Failure requesting multiple notes: " + error, roles::consultant);
return false;
}
// Store the notes in the file system.
std::vector <std::string> summaries = database_notes.set_bulk (json);
// More specific feedback in case it downloaded only a few notes, rather than notes in bulk.
if (identifiers_bulk_download.size () < 3) {
for (auto & summary : summaries) {
Database_Logs::log (sendreceive_notes_text () + "Receiving: " + summary, roles::manager);
}
}
}
return true;
}
void sendreceive_notes_kick_watchdog ()
{
sendreceive_notes_watchdog = filter::date::seconds_since_epoch ();
}
|