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
|
/*
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 <changes/modifications.h>
#include <filter/string.h>
#include <filter/url.h>
#include <filter/roles.h>
#include <filter/usfm.h>
#include <filter/text.h>
#include <filter/diff.h>
#include <filter/shell.h>
#include <filter/passage.h>
#include <filter/date.h>
#include <html/text.h>
#include <text/text.h>
#include <database/logs.h>
#include <database/modifications.h>
#include <database/config/general.h>
#include <database/config/bible.h>
#include <database/statistics.h>
#include <webserver/request.h>
#include <locale/translate.h>
#include <client/logic.h>
#include <access/bible.h>
#include <config/globals.h>
#include <changes/logic.h>
#include <styles/css.h>
#include <email/send.h>
// Internal function declarations.
void changes_process_identifiers (Webserver_Request& webserver_request,
const std::string& user,
const std::vector <std::string>& recipients,
const std::string& bible,
int book, int chapter,
const std::map <std::string, std::vector<std::string>> & bibles_per_user,
int oldId, int newId,
std::string& email,
int& change_count, float& time_total, int& time_count);
// Helper function.
// $user: The user whose changes are being processed.
// $recipients: The users who opted for receiving online notifications of any contributor.
void changes_process_identifiers (Webserver_Request& webserver_request,
const std::string& user,
const std::vector <std::string>& recipients,
const std::string& bible,
int book, int chapter,
const std::map <std::string, std::vector<std::string>> & bibles_per_user,
int oldId, int newId,
std::string& email,
int& change_count, float& time_total, int& time_count)
{
if (oldId != 0) {
const std::string stylesheet = database::config::bible::get_export_stylesheet (bible);
database::modifications::text_bundle old_chapter_text = database::modifications::getUserChapter (user, bible, book, chapter, oldId);
const std::string old_chapter_usfm = old_chapter_text.oldtext;
database::modifications::text_bundle new_chapter_text = database::modifications::getUserChapter (user, bible, book, chapter, newId);
const std::string new_chapter_usfm = new_chapter_text.newtext;
const std::vector <int> old_verse_numbers = filter::usfm::get_verse_numbers (old_chapter_usfm);
const std::vector <int> new_verse_numbers = filter::usfm::get_verse_numbers (new_chapter_usfm);
std::vector <int> verses = old_verse_numbers;
verses.insert (verses.end (), new_verse_numbers.begin (), new_verse_numbers.end ());
verses = filter::strings::array_unique (verses);
std::sort (verses.begin(), verses.end());
for (const auto verse : verses) {
const std::string old_verse_usfm = filter::usfm::get_verse_text (old_chapter_usfm, verse);
const std::string new_verse_usfm = filter::usfm::get_verse_text (new_chapter_usfm, verse);
if (old_verse_usfm != new_verse_usfm) {
Filter_Text filter_text_old = Filter_Text (bible);
Filter_Text filter_text_new = Filter_Text (bible);
filter_text_old.html_text_standard = new HtmlText (translate("Bible"));
filter_text_new.html_text_standard = new HtmlText (translate("Bible"));
filter_text_old.text_text = new Text_Text ();
filter_text_new.text_text = new Text_Text ();
filter_text_old.add_usfm_code (old_verse_usfm);
filter_text_new.add_usfm_code (new_verse_usfm);
filter_text_old.run (stylesheet);
filter_text_new.run (stylesheet);
const std::string old_html = filter_text_old.html_text_standard->get_inner_html ();
const std::string new_html = filter_text_new.html_text_standard->get_inner_html ();
const std::string old_text = filter_text_old.text_text->get ();
const std::string new_text = filter_text_new.text_text->get ();
if (old_text != new_text) {
const std::string modification = filter_diff_diff (old_text, new_text);
email += "<div>";
email += filter_passage_display (book, chapter, std::to_string (verse));
email += " ";
email += modification;
email += "</div>";
if (webserver_request.database_config_user()->get_user_user_changes_notifications_online (user)) {
database::modifications::recordNotification ({user}, changes_personal_category (), bible, book, chapter, verse, old_html, modification, new_html);
}
// Go over all the receipients to record the change for them.
for (const auto& recipient : recipients) {
// The author of this change does not get a notification for it.
if (recipient == user) continue;
// The recipient may have set which Bibles to get the change notifications for.
// This is stored like this:
// container [user] = list of bibles.
bool receive {true};
try {
const std::vector <std::string>& bibles = bibles_per_user.at(recipient);
receive = in_array(bible, bibles);
} catch (...) {}
if (!receive) continue;
// Store the notification.
database::modifications::recordNotification ({recipient}, user, bible, book, chapter, verse, old_html, modification, new_html);
}
}
// Statistics: Count yet another change made by this hard-working user!
change_count++;
int timestamp = database::modifications::getUserTimestamp (user, bible, book, chapter, newId);
time_total += static_cast<float>(timestamp);
time_count++;
}
}
}
}
// This mutex ensures that only one single process can generate the changes modifications at any time.
std::timed_mutex mutex;
void changes_modifications ()
{
// Ensure only one process at any time generates the changes,
// even if multiple order to generate then were given by the user.
std::unique_lock<std::timed_mutex> lock (mutex, std::defer_lock);
if (!lock.try_lock_for(std::chrono::milliseconds(200))) {
Database_Logs::log ("Change notifications: Skipping just now because another process is already generating them", roles::translator);
return;
}
Database_Logs::log ("Change notifications: Generating", roles::translator);
// Notifications are not available to clients to download while processing them.
config_globals_change_notifications_available = false;
// Data objects.
Webserver_Request webserver_request {};
// Check on the health of the modifications database and (re)create it if needed.
if (!database::modifications::healthy ()) database::modifications::erase ();
database::modifications::create ();
// Get the users who will receive the changes entered by the named contributors.
std::vector <std::string> recipients_named_contributors;
{
const std::vector <std::string> users = webserver_request.database_users ()->get_users ();
for (const auto& user : users) {
if (webserver_request.database_config_user ()->get_contributor_changes_notifications_online (user)) {
recipients_named_contributors.push_back (user);
}
}
}
// Storage for the statistics.
std::map <std::string, int> user_change_statistics {};
float modification_time_total {0.0f};
int modification_time_count {0};
// There is a setting per user indicating which Bible(s) a user
// will get the change notifications from.
// This setting affects the changes made by all users.
// Note: A user will always receive notificatons of changes made by that same user.
std::map <std::string, std::vector<std::string> > notification_bibles_per_user {};
{
const std::vector <std::string> users = webserver_request.database_users ()->get_users ();
for (const auto & user : users) {
const std::vector <std::string> bibles = webserver_request.database_config_user ()->get_change_notifications_bibles_for_user (user);
notification_bibles_per_user [user] = bibles;
}
}
// Create online change notifications for users who made changes in Bibles.
// (The changes were made through the web editor or through a client).
// It runs before the team changes.
// This produces the desired order of the notifications in the GUI.
// At the same time, produce change statistics per user.
std::vector <std::string> users = database::modifications::getUserUsernames ();
for (const auto& user : users) {
// Total changes made by this user.
int change_count {0};
// Go through the Bibles changed by the current user.
std::vector <std::string> bibles = database::modifications::getUserBibles (user);
for (const auto& bible : bibles) {
// Body of the email to be sent.
std::string email = "<p>" + translate("You have entered the changes below in a Bible editor.") + " " + translate ("You may check if it made its way into the Bible text.") + "</p>";
size_t empty_email_length = email.length ();
// Go through the books in that Bible.
const std::vector <int> books = database::modifications::getUserBooks (user, bible);
for (auto book : books) {
// Go through the chapters in that book.
const std::vector <int> chapters = database::modifications::getUserChapters (user, bible, book);
for (auto chapter : chapters) {
Database_Logs::log ("Change notifications: User " + user + " - Bible " + bible + " " + filter_passage_display (book, chapter, ""), roles::translator);
// Get the sets of identifiers for that chapter, and set some variables.
const std::vector <database::modifications::id_bundle> IdSets = database::modifications::getUserIdentifiers (user, bible, book, chapter);
int reference_new_id {0};
int new_id {0};
int last_new_id {0};
bool restart = true;
// Go through the sets of identifiers.
for (const auto & id_set : IdSets) {
int oldId {id_set.oldid};
new_id = id_set.newid;
if (restart) {
changes_process_identifiers (webserver_request, user, recipients_named_contributors, bible, book, chapter, notification_bibles_per_user, reference_new_id, new_id, email, change_count, modification_time_total, modification_time_count);
reference_new_id = new_id;
last_new_id = new_id;
restart = false;
continue;
}
if (oldId == last_new_id) {
last_new_id = new_id;
} else {
restart = true;
}
}
// Process the last set of identifiers.
changes_process_identifiers (webserver_request, user, recipients_named_contributors, bible, book, chapter, notification_bibles_per_user, reference_new_id, new_id, email, change_count, modification_time_total, modification_time_count);
}
}
// Check whether there's any email to be sent.
if (email.length () != empty_email_length) {
// Send the user email with the user's personal changes if the user opted to receive it.
if (webserver_request.database_config_user()->get_user_user_changes_notification (user)) {
const std::string subject = translate("Changes you entered in") + " " + bible;
if (!client_logic_client_enabled ()) email::schedule (user, subject, email);
}
}
}
// Store change statistics for this user.
user_change_statistics [user] = change_count;
// Clear the user's changes in the database.
database::modifications::clearUserUser (user);
// Clear checksum cache.
webserver_request.database_config_user ()->set_user_change_notifications_checksum (user, "");
}
// Generate the notifications, online and by email,
// for the changes in the Bibles entered by anyone
// since the previous notifications were generated.
std::vector <std::string> bibles = database::modifications::getTeamDiffBibles ();
for (const auto & bible : bibles) {
const std::string stylesheet = database::config::bible::get_export_stylesheet (bible);
std::vector <std::string> changeNotificationUsers;
std::vector <std::string> all_users = webserver_request.database_users ()->get_users ();
for (const auto& user : all_users) {
if (access_bible::read (webserver_request, bible, user)) {
if (webserver_request.database_config_user()->get_user_generate_change_notifications (user)) {
// The recipient may have set which Bibles to get the change notifications for.
// This is stored like this:
// container [user] = list of bibles.
bool receive {true};
try {
const std::vector <std::string> & user_bibles = notification_bibles_per_user.at(user);
receive = in_array(bible, user_bibles);
} catch (...) {}
if (receive) {
changeNotificationUsers.push_back (user);
}
}
}
}
all_users.clear ();
// The number of changes processed so far for this Bible.
int processedChangesCount = 0;
// The files get stored at https://site.org:<port>/revisions/<Bible>/<date>
const int seconds = filter::date::seconds_since_epoch ();
std::string timepath;
timepath.append (std::to_string (filter::date::numerical_year (seconds)));
timepath.append ("-");
timepath.append (filter::strings::fill (std::to_string (filter::date::numerical_month (seconds)), 2, '0'));
timepath.append ("-");
timepath.append (filter::strings::fill (std::to_string (filter::date::numerical_month_day (seconds)), 2, '0'));
timepath.append (" ");
timepath.append (filter::strings::fill (std::to_string (filter::date::numerical_hour (seconds)), 2, '0'));
timepath.append (":");
timepath.append (filter::strings::fill (std::to_string (filter::date::numerical_minute (seconds)), 2, '0'));
timepath.append (":");
timepath.append (filter::strings::fill (std::to_string (filter::date::numerical_second (seconds)), 2, '0'));
const std::string directory = filter_url_create_root_path ({"revisions", bible, timepath});
filter_url_mkdir (directory);
// Produce the USFM and html files.
filter_diff_produce_verse_level (bible, directory);
// Create online page with changed verses.
const std::string versesoutputfile = filter_url_create_path ({directory, "changed_verses.html"});
filter_diff_run_file (filter_url_create_path ({directory, "verses_old.txt"}), filter_url_create_path ({directory, "verses_new.txt"}), versesoutputfile);
// Storage for body of the email with the changes.
std::vector <std::string> email_changes {};
// Generate the online change notifications.
const std::vector <int> books = database::modifications::getTeamDiffBooks (bible);
for (auto book : books) {
const std::vector <int> chapters = database::modifications::getTeamDiffChapters (bible, book);
for (auto chapter : chapters) {
Database_Logs::log ("Change notifications: " + bible + " " + filter_passage_display (book, chapter, ""), roles::translator);
const std::string old_chapter_usfm = database::modifications::getTeamDiff (bible, book, chapter);
const std::string new_chapter_usfm = database::bibles::get_chapter (bible, book, chapter);
const std::vector <int> old_verse_numbers = filter::usfm::get_verse_numbers (old_chapter_usfm);
const std::vector <int> new_verse_numbers = filter::usfm::get_verse_numbers (new_chapter_usfm);
std::vector <int> verses = old_verse_numbers;
verses.insert (verses.end (), new_verse_numbers.begin (), new_verse_numbers.end ());
verses = filter::strings::array_unique (verses);
std::sort (verses.begin (), verses.end());
for (auto verse : verses) {
const std::string old_verse_usfm = filter::usfm::get_verse_text (old_chapter_usfm, verse);
const std::string new_verse_usfm = filter::usfm::get_verse_text (new_chapter_usfm, verse);
if (old_verse_usfm != new_verse_usfm) {
processedChangesCount++;
// In case of too many change notifications, processing them would take too much time, so take a few shortcuts.
std::string old_html = "<p>" + old_verse_usfm + "</p>";
std::string new_html = "<p>" + new_verse_usfm + "</p>";
std::string old_text = old_verse_usfm;
std::string new_text = new_verse_usfm;
if (processedChangesCount < 800) {
Filter_Text filter_text_old = Filter_Text (bible);
Filter_Text filter_text_new = Filter_Text (bible);
filter_text_old.html_text_standard = new HtmlText ("");
filter_text_new.html_text_standard = new HtmlText ("");
filter_text_old.text_text = new Text_Text ();
filter_text_new.text_text = new Text_Text ();
filter_text_old.add_usfm_code (old_verse_usfm);
filter_text_new.add_usfm_code (new_verse_usfm);
filter_text_old.run (stylesheet);
filter_text_new.run (stylesheet);
old_html = filter_text_old.html_text_standard->get_inner_html ();
new_html = filter_text_new.html_text_standard->get_inner_html ();
old_text = filter_text_old.text_text->get ();
new_text = filter_text_new.text_text->get ();
}
const std::string modification = filter_diff_diff (old_text, new_text);
database::modifications::recordNotification (changeNotificationUsers, changes_bible_category (), bible, book, chapter, verse, old_html, modification, new_html);
const std::string passage = filter_passage_display (book, chapter, std::to_string (verse)) + ": ";
if (old_text != new_text) {
email_changes.push_back (passage + modification);
} else {
email_changes.push_back (translate ("The following passage has no change in the text.") + " " + translate ("Only the formatting was changed.") + " " + translate ("The USFM code is given for reference."));
email_changes.push_back (passage);
email_changes.push_back (translate ("Old code:") + " " + old_verse_usfm);
email_changes.push_back (translate ("New code:") + " " + new_verse_usfm);
}
}
}
// Delete the diff data for this chapter, for two reasons:
// 1. New diffs for this chapter can be stored straightaway.
// 2. In case of large amounts of diff data, and this function gets killed,
// then the next time it runs again, it will continue from where it was killed.
database::modifications::deleteTeamDiffChapter (bible, book, chapter);
}
}
// Email the changes to the subscribed users.
if (!email_changes.empty ()) {
constexpr const int max_body_size {static_cast<int>(email::max_email_size * 0.8)};
// Split large emails up into parts.
// The size of the parts has been found by checking the maximum size that the emailer will send,
// then each part should remain well below that maximum size.
// The size was reduced even more later on:
// https://github.com/bibledit/cloud/issues/727
std::vector <std::string> bodies {};
std::string body {};
for (const auto & line : email_changes) {
body.append ("<div>");
body.append (line);
body.append ("</div>\n");
if (body.size() >= max_body_size) {
bodies.push_back (std::move(body));
body.clear ();
}
}
if (!body.empty ())
bodies.push_back (body);
for (size_t b = 0; b < bodies.size (); b++) {
std::string subject = translate("Recent changes:") + " " + bible;
if (bodies.size () > 1) {
subject.append (" (" + std::to_string (b + 1) + "/" + std::to_string (bodies.size ()) + ")");
}
const std::vector <std::string> all_users_2 = webserver_request.database_users ()->get_users ();
for (const auto& user : all_users_2) {
if (webserver_request.database_config_user()->get_user_bible_changes_notification (user)) {
if (access_bible::read (webserver_request, bible, user)) {
if (!client_logic_client_enabled ()) {
email::schedule (user, subject, bodies[b]);
}
}
}
}
}
}
}
// Index the data and remove expired notifications.
Database_Logs::log ("Change notifications: Indexing", roles::translator);
database::modifications::indexTrimAllNotifications ();
// Remove expired downloadable revisions.
const std::string directory = filter_url_create_root_path ({"revisions"});
const int now = filter::date::seconds_since_epoch ();
bibles = filter_url_scandir (directory);
for (const auto & bible : bibles) {
const std::string folder = filter_url_create_path ({directory, bible});
int time = filter_url_file_modification_time (folder);
int days = (now - time) / 86400;
if (days > 31) {
filter_url_rmdir (folder);
} else {
const std::vector <std::string> revisions = filter_url_scandir (folder);
for (const auto& revision : revisions) {
const std::string path = filter_url_create_path ({folder, revision});
const int time2 = filter_url_file_modification_time (path);
const int days2 = (now - time2) / 86400;
if (days2 > 31) {
filter_url_rmdir (path);
Database_Logs::log ("Removing expired downloadable revision notification: " + bible + " " + revision, roles::translator);
}
}
}
}
// Clear checksum caches.
users = webserver_request.database_users ()->get_users ();
for (const auto & user : users) {
webserver_request.database_config_user ()->set_user_change_notifications_checksum (user, "");
}
// Vacuum the modifications index, as it might have been updated.
database::modifications::vacuum ();
// Make the notifications available again to clients.
config_globals_change_notifications_available = true;
#ifdef HAVE_CLOUD
// Store the statistics in the database.
if (modification_time_count) {
// Take average timestamp of all timestamps.
const int timestamp = static_cast <int> (round (modification_time_total / static_cast<float>(modification_time_count)));
for (const auto & element : user_change_statistics) {
// Store dated change statistics per user.
const std::string& user = element.first;
const int count = element.second;
Database_Statistics::store_changes (timestamp, user, count);
}
}
#endif
Database_Logs::log ("Change notifications: Ready", roles::translator);
}
|