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
|
/*
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/changes.h>
#include <assets/header.h>
#include <assets/view.h>
#include <assets/page.h>
#include <filter/roles.h>
#include <filter/url.h>
#include <filter/string.h>
#include <filter/md5.h>
#include <webserver/request.h>
#include <locale/translate.h>
#include <client/logic.h>
#include <demo/logic.h>
#include <database/modifications.h>
#include <database/notes.h>
#include <trash/handler.h>
#include <ipc/focus.h>
#include <navigation/passage.h>
#include <changes/logic.h>
#include <menu/logic.h>
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Weffc++"
#pragma GCC diagnostic ignored "-Wsuggest-override"
#pragma GCC diagnostic ignored "-Wzero-as-null-pointer-constant"
#ifndef HAVE_PUGIXML
#include <pugixml/pugixml.hpp>
#endif
#ifdef HAVE_PUGIXML
#include <pugixml.hpp>
#endif
#pragma GCC diagnostic pop
std::string changes_changes_url ()
{
return "changes/changes";
}
bool changes_changes_acl (Webserver_Request& webserver_request)
{
return roles::access_control (webserver_request, roles::consultant);
}
std::string changes_changes (Webserver_Request& webserver_request)
{
// Handle AJAX call to load the summary of a change notification.
if (webserver_request.query.count ("load")) {
const int identifier = filter::strings::convert_to_int (webserver_request.query["load"]);
std::stringstream block {};
const Passage passage = database::modifications::getNotificationPassage (identifier);
const std::string link = filter_passage_link_for_opening_editor_at (passage.m_book, passage.m_chapter, passage.m_verse);
std::string category = database::modifications::getNotificationCategory (identifier);
if (category == changes_personal_category ())
category = filter::strings::emoji_smiling_face_with_smiling_eyes ();
if (category == changes_bible_category ())
category = filter::strings::emoji_open_book ();
std::string modification = database::modifications::getNotificationModification (identifier);
block << "<div id=" << std::quoted("entry" + std::to_string (identifier)) << + ">\n";
block << "<a href=" << std::quoted ("expand") << ">" << filter::strings::emoji_file_folder () << "</a>\n";
block << "<a href=" << std::quoted("remove") << ">" << filter::strings::emoji_wastebasket () << "</a>\n";
block << link << "\n";
block << category << "\n";
block << modification << "\n";
block << "</div>\n";
return block.str();
}
// Handle AJAX call to remove a change notification.
if (webserver_request.post_count("remove")) {
const int remove = filter::strings::convert_to_int (webserver_request.post_get("remove"));
trash_change_notification (webserver_request, remove);
database::modifications::deleteNotification (remove);
#ifdef HAVE_CLIENT
webserver_request.database_config_user ()->add_removed_change (remove);
#endif
webserver_request.database_config_user ()->set_change_notifications_checksum ("");
return std::string();
}
// Handle AJAX call to navigate to the passage belonging to the change notification.
if (webserver_request.post_count("navigate")) {
const std::string navigate = webserver_request.post_get("navigate");
const int id = filter::strings::convert_to_int (navigate);
const Passage passage = database::modifications::getNotificationPassage (id);
if (passage.m_book) {
Ipc_Focus::set (webserver_request, passage.m_book, passage.m_chapter, filter::strings::convert_to_int (passage.m_verse));
navigation_passage::record_history (webserver_request, passage.m_book, passage.m_chapter, filter::strings::convert_to_int (passage.m_verse));
}
// Set the correct default Bible for the user.
const std::string bible = database::modifications::getNotificationBible (id);
if (!bible.empty ())
webserver_request.database_config_user()->set_bible (bible);
return std::string();
}
// Handle query to update the sorting order.
const std::string sort = webserver_request.query ["sort"];
if (sort == "verse") {
webserver_request.database_config_user ()->set_order_changes_by_author (false);
}
if (sort == "author") {
webserver_request.database_config_user ()->set_order_changes_by_author (true);
}
const std::string& username = webserver_request.session_logic ()->get_username ();
const bool touch = webserver_request.session_logic ()->get_touch_enabled ();
std::string page {};
Assets_Header header = Assets_Header (translate("Changes"), webserver_request);
header.set_stylesheet ();
header.add_bread_crumb (menu_logic_translate_menu (), menu_logic_translate_text ());
page += header.run ();
Assets_View view {};
// The selected Bible, that is, the Bible for which to show the change notifications.
std::string selectedbible = webserver_request.query ["selectedbible"];
if (webserver_request.query.count ("selectbible")) {
selectedbible = webserver_request.query ["selectbible"];
}
view.set_variable ("selectedbible", selectedbible);
// Remove a user's personal changes notifications and their matching change notifications in the Bible.
const std::string matching = webserver_request.query ["matching"];
if (!matching.empty ()) {
std::vector <int> ids = database::modifications::clearNotificationMatches (username, matching, changes_bible_category (), selectedbible);
#ifdef HAVE_CLIENT
// Client records deletions for sending to the Cloud.
for (const auto id : ids) {
webserver_request.database_config_user ()->add_removed_change (id);
}
#endif
// Clear checksum cache.
webserver_request.database_config_user ()->set_change_notifications_checksum ("");
}
// Remove all the personal change notifications.
if (webserver_request.query.count ("personal")) {
std::vector <int> ids = database::modifications::getNotificationTeamIdentifiers (username, changes_personal_category (), selectedbible);
for (const auto id : ids) {
trash_change_notification (webserver_request, id);
database::modifications::deleteNotification (id);
#ifdef HAVE_CLIENT
webserver_request.database_config_user ()->add_removed_change (id);
#endif
webserver_request.database_config_user ()->set_change_notifications_checksum ("");
}
}
// Remove all the Bible change notifications.
if (webserver_request.query.count ("bible")) {
std::vector <int> ids = database::modifications::getNotificationTeamIdentifiers (username, changes_bible_category (), selectedbible);
for (const auto id : ids) {
trash_change_notification (webserver_request, id);
database::modifications::deleteNotification (id);
#ifdef HAVE_CLIENT
webserver_request.database_config_user ()->add_removed_change (id);
#endif
webserver_request.database_config_user ()->set_change_notifications_checksum ("");
}
}
// Remove all the change notifications made by a certain user.
if (webserver_request.query.count ("dismiss")) {
const std::string user = webserver_request.query ["dismiss"];
std::vector <int> ids = database::modifications::getNotificationTeamIdentifiers (username, user, selectedbible);
for (auto id : ids) {
trash_change_notification (webserver_request, id);
database::modifications::deleteNotification (id);
#ifdef HAVE_CLIENT
webserver_request.database_config_user ()->add_removed_change (id);
#endif
webserver_request.database_config_user ()->set_change_notifications_checksum ("");
}
}
// Read the identifiers, optionally sorted on author (that is, category).
bool sort_on_author = webserver_request.database_config_user ()->get_order_changes_by_author ();
const std::vector <int> notification_ids = database::modifications::getNotificationIdentifiers (username, selectedbible, sort_on_author);
// Send the identifiers to the browser for download there.
std::string pendingidentifiers {};
for (const auto id : notification_ids) {
if (!pendingidentifiers.empty ()) pendingidentifiers.append (" ");
pendingidentifiers.append (std::to_string (id));
}
view.set_variable ("pendingidentifiers", pendingidentifiers);
std::stringstream loading {};
loading << "var loading = " << std::quoted(translate("Loading ...")) << ";";
std::string script = loading.str();
config::logic::swipe_enabled (webserver_request, script);
view.set_variable ("script", script);
// Add links to enable the user to show the change notifications for one Bible or for all Bibles.
std::vector <std::string> distinct_bibles = database::modifications::getNotificationDistinctBibles (username);
// Show the Bible selector if there's more than one distinct Bible.
bool show_bible_selector = distinct_bibles.size () > 1;
// Also show the Bible selector if there's no change notifications to display, yet there's at least one distinct Bible.
// This situation often occurs after clearing a Bible's notifications, so there's no notifications after clearing them,
// yet there's notifications for other Bibles.
// Showing the Bible selector in this situation enables the user to select the other Bible(s).
if (notification_ids.empty () && !distinct_bibles.empty ()) show_bible_selector = true;
// Show the Bible selector if needed.
if (show_bible_selector) {
// If there's more than one distinct Bible, add the "All Bibles" selector.
if (distinct_bibles.size () > 1) distinct_bibles.insert (distinct_bibles.begin(), "");
// Iterate over the Bibles and make them all selectable.
for (const auto & bible : distinct_bibles) {
std::string cssclass {};
if (selectedbible == bible) cssclass = "active";
std::string name (bible);
if (name.empty ()) name = translate ("All Bibles");
view.add_iteration ("bibleselector", { std::pair ("selectbible", bible), std::pair ("biblename", name), std::pair ("class", cssclass) } );
}
}
// Enable links to dismiss categories of notifications depending on whether there's anything to dismiss.
// And give details about the number of changes.
std::vector <int> personal_ids = database::modifications::getNotificationTeamIdentifiers (username, changes_personal_category (), selectedbible);
if (!personal_ids.empty ()) {
view.enable_zone ("personal");
view.set_variable ("personalcount", std::to_string (personal_ids.size ()));
}
const std::vector <int> bible_ids = database::modifications::getNotificationTeamIdentifiers (username, changes_bible_category (), selectedbible);
if (!bible_ids.empty ()) {
view.enable_zone ("bible");
view.set_variable ("teamcount", std::to_string (bible_ids.size ()));
}
// Add links to clear the notifications from the individual contributors.
const std::vector <std::string> categories = database::modifications::getCategories ();
for (const auto & category : categories) {
if (category == changes_personal_category ()) continue;
if (category == changes_bible_category ()) continue;
const std::string& user = category;
const std::vector <int> ids = database::modifications::getNotificationTeamIdentifiers (username, user, selectedbible);
if (!ids.empty ()) {
view.add_iteration ("individual", {
std::pair ("user", user),
std::pair ("selectedbible", selectedbible),
std::pair ("count", std::to_string(ids.size()))
});
}
}
// Add links to clear matching notifications of the various users.
for (const auto& category : categories) {
if (category == changes_bible_category ()) continue;
const std::string& user = category;
std::vector <int> personal_ids2 = database::modifications::getNotificationTeamIdentifiers (username, user, selectedbible);
std::string user_and_icon = translate ("user") + " " + category;
if (category == changes_personal_category ()) {
user_and_icon = translate ("me") + " " + filter::strings::emoji_smiling_face_with_smiling_eyes ();
}
if (!personal_ids2.empty () && !bible_ids.empty ()) {
view.add_iteration ("matching", { std::pair ("user", user), std::pair ("icon", user_and_icon) } );
}
}
view.set_variable ("VERSION", config::logic::version ());
if (touch) view.enable_zone ("touch");
view.set_variable ("interlinks", changes_interlinks (webserver_request, changes_changes_url ()));
// Create data for the link for how to sort the change notifications.
std::string sortquery {};
std::string sorttext {};
if (webserver_request.database_config_user ()->get_order_changes_by_author ()) {
sortquery = "verse";
sorttext = translate ("Sort on verse" );
} else {
sortquery = "author";
sorttext = translate ("Sort on author");
}
view.set_variable ("sortquery", sortquery);
view.set_variable ("sorttext", sorttext);
// Whether to show the controls for dismissing the changes.
if (!notification_ids.empty ()) {
// Whether to put those controls at the bottom of the page, as the default location,
// or whether to put them at the top of the page.
if (webserver_request.database_config_user ()->get_dismiss_changes_at_top ()) {
view.enable_zone ("controlsattop");
} else {
view.enable_zone ("controlsatbottom");
}
}
page += view.render ("changes", "changes");
page += assets_page::footer ();
return page;
}
|