vector <string> resource_logic_get_names (void * webserver_request)
{
vector <string> names;
// Bibles the user has read access to.
vector <string> bibles = access_bible_bibles (webserver_request);
names.insert (names.end(), bibles.begin (), bibles.end());
// USFM resources.
Database_UsfmResources database_usfmresources;
vector <string> usfm_resources = database_usfmresources.getResources ();
names.insert (names.end(), usfm_resources.begin(), usfm_resources.end());
// External resources.
vector <string> external_resources = resource_external_names ();
names.insert (names.end (), external_resources.begin(), external_resources.end());
// Image resources.
Database_ImageResources database_imageresources;
vector <string> image_resources = database_imageresources.names ();
names.insert (names.end (), image_resources.begin(), image_resources.end());
// Lexicon resources.
vector <string> lexicon_resources = lexicon_logic_resource_names ();
names.insert (names.end (), lexicon_resources.begin(), lexicon_resources.end());
// SWORD resources
vector <string> sword_resources = sword_logic_get_available ();
names.insert (names.end (), sword_resources.begin(), sword_resources.end());
sort (names.begin(), names.end());
return names;
}
// Checks the installed modules, whether they need to be updated.
void sword_logic_update_installed_modules ()
{
Database_Logs::log ("Updating installed SWORD modules");
vector <string> available_modules = sword_logic_get_available ();
vector <string> installed_modules = sword_logic_get_installed ();
for (auto & installed_module : installed_modules) {
string module = sword_logic_get_installed_module (installed_module);
string installed_version = sword_logic_get_version (installed_module);
for (auto & available_module : available_modules) {
if (sword_logic_get_remote_module (available_module) == module) {
if (sword_logic_get_version (available_module) != installed_version) {
string source = sword_logic_get_source (available_module);
// Uninstall module.
sword_logic_uninstall_module (module);
// Clear the cache.
Database_Versifications database_versifications;
vector <int> books = database_versifications.getMaximumBooks ();
for (auto & book : books) {
vector <int> chapters = database_versifications.getMaximumChapters (book);
for (auto & chapter : chapters) {
vector <int> verses = database_versifications.getMaximumVerses (book, chapter);
for (auto & verse : verses) {
string schema = sword_logic_virtual_url (module, book, chapter, verse);
database_filebased_cache_remove (schema);
}
}
}
// Schedule module installation.
sword_logic_install_module_schedule (source, module);
}
continue;
}
}
}
Database_Logs::log ("Ready updating installed SWORD modules");
}
string resource_cache (void * webserver_request)
{
Webserver_Request * request = (Webserver_Request *) webserver_request;
string resource = request->query ["resource"];
string page;
Assets_Header header = Assets_Header (menu_logic_resources_text (), request);
header.addBreadCrumb (menu_logic_settings_menu (), menu_logic_settings_text ());
page = header.run ();
Assets_View view;
if (request->query.count ("clear")) {
sendreceive_resources_clear_all ();
}
vector <string> resources = Database_Config_General::getResourcesToCache ();
if (!resources.empty ()) {
view.enable_zone ("scheduled");
view.set_variable ("scheduled", filter_string_implode (resources, " | "));
}
vector <string> listed_resources;
string block;
// Display the available USFM resources.
resources = client_logic_usfm_resources_get ();
for (auto & resource : resources) {
block.append ("<p>");
block.append ("<a href=\"download?name=" + resource + "\">" + resource + "</a>");
block.append ("</p>\n");
}
listed_resources.insert (listed_resources.end (), resources.begin (), resources.end ());
// Display the available external resources.
resources = resource_external_names ();
for (auto & resource : resources) {
block.append ("<p>");
block.append ("<a href=\"download?name=" + resource + "\">" + resource + "</a>");
block.append ("</p>\n");
}
listed_resources.insert (listed_resources.end (), resources.begin (), resources.end ());
// Display the available SWORD resources.
resources = sword_logic_get_available ();
for (auto & resource : resources) {
string source = sword_logic_get_source (resource);
string module = sword_logic_get_remote_module (resource);
string name = "[" + source + "][" + module + "]";
block.append ("<p>");
block.append ("<a href=\"download?name=" + name + "\">" + resource + "</a>");
block.append ("</p>\n");
}
listed_resources.insert (listed_resources.end (), resources.begin (), resources.end ());
// Display any old USFM resources still available on the client.
Database_UsfmResources database_usfmresources;
resources = database_usfmresources.getResources ();
for (auto & resource : resources) {
if (in_array (resource, listed_resources)) continue;
block.append ("<p>");
block.append ("<a href=\"download?name=" + resource + "&old=yes\">" + resource + "</a>");
block.append ("</p>\n");
}
// Display any offline resources still available on the client.
Database_OfflineResources database_offlineresources;
resources = database_offlineresources.names ();
for (auto & resource : resources) {
if (in_array (resource, listed_resources)) continue;
block.append ("<p>");
block.append ("<a href=\"download?name=" + resource + "&old=yes\">" + resource + "</a>");
block.append ("</p>\n");
}
// Display the list.
view.set_variable ("block", block);
page += view.render ("resource", "cache");
page += Assets_Page::footer ();
return page;
}
string resource_organize (void * webserver_request)
{
Webserver_Request * request = (Webserver_Request *) webserver_request;
string checkbox = request->post ["checkbox"];
bool checked = convert_to_bool (request->post ["checked"]);
if (request->query.count ("add") || request->post.count ("add")) {
string add = request->query["add"];
if (add.empty ()) add = request->post ["add"];
vector <string> resources = request->database_config_user()->getActiveResources ();
resources.push_back (add);
request->database_config_user()->setActiveResources (resources);
request->database_config_user()->addUpdatedSetting (Sync_Logic::settings_send_resources_organization);
}
if (request->query.count ("remove")) {
size_t remove = convert_to_int (request->query["remove"]);
vector <string> resources = request->database_config_user()->getActiveResources ();
if (remove < resources.size ()) {
resources.erase (resources.begin () + remove);
}
request->database_config_user()->setActiveResources (resources);
request->database_config_user()->addUpdatedSetting (Sync_Logic::settings_send_resources_organization);
}
if (request->query.count ("moveup")) {
size_t moveup = convert_to_int (request->query["moveup"]);
vector <string> resources = request->database_config_user()->getActiveResources ();
array_move_up_down (resources, moveup, true);
request->database_config_user()->setActiveResources (resources);
request->database_config_user()->addUpdatedSetting (Sync_Logic::settings_send_resources_organization);
}
if (request->query.count ("movedown")) {
size_t movedown = convert_to_int (request->query["movedown"]);
vector <string> resources = request->database_config_user()->getActiveResources ();
array_move_up_down (resources, movedown, false);
request->database_config_user()->setActiveResources (resources);
request->database_config_user()->addUpdatedSetting (Sync_Logic::settings_send_resources_organization);
}
string page;
Assets_Header header = Assets_Header (translate("Resources"), request);
page = header.run ();
Assets_View view;
// Active resources.
vector <string> active_resources = request->database_config_user()->getActiveResources ();
string activesblock;
for (size_t i = 0; i < active_resources.size (); i++) {
activesblock.append ("<p>");
activesblock.append ("<a href=\"?remove=" + convert_to_string (i) + "\">");
activesblock.append (emoji_wastebasket ());
activesblock.append ("</a>");
activesblock.append (" ");
activesblock.append ("<a href=\"?moveup=" + convert_to_string (i) + "\">");
activesblock.append (unicode_black_up_pointing_triangle ());
activesblock.append ("</a>");
activesblock.append ("<a href=\"?movedown=" + convert_to_string (i) + "\">");
activesblock.append (unicode_black_down_pointing_triangle ());
activesblock.append ("</a>");
activesblock.append (" ");
activesblock.append (active_resources [i]);
activesblock.append ("</p>");
activesblock.append ("\n");
}
view.set_variable ("activesblock", activesblock);
// Context before.
if (request->query.count ("before")) {
Dialog_Entry dialog_entry = Dialog_Entry ("organize", translate("Please enter the number of verses"), convert_to_string (request->database_config_user ()->getResourceVersesBefore ()), "before", translate ("How many verses of context to display before the focused verse."));
page += dialog_entry.run ();
return page;
}
if (request->post.count ("before")) {
int value = convert_to_int (request->post["entry"]);
if ((value >= 0) && (value <= 100)) {
request->database_config_user ()->setResourceVersesBefore (value);
}
}
view.set_variable ("before", convert_to_string (request->database_config_user ()->getResourceVersesBefore ()));
// Context after.
if (request->query.count ("after")) {
Dialog_Entry dialog_entry = Dialog_Entry ("organize", translate("Please enter the number of verses"), convert_to_string (request->database_config_user ()->getResourceVersesAfter ()), "after", translate ("How many verses of context to display after the focused verse."));
page += dialog_entry.run ();
return page;
}
if (request->post.count ("after")) {
int value = convert_to_int (request->post["entry"]);
if ((value >= 0) && (value <= 100)) {
request->database_config_user ()->setResourceVersesAfter (value);
}
}
view.set_variable ("after", convert_to_string (request->database_config_user ()->getResourceVersesAfter ()));
if (checkbox == "related") {
request->database_config_user ()->setIncludeRelatedPassages (checked);
return "";
}
view.set_variable ("related", get_checkbox_status (request->database_config_user ()->getIncludeRelatedPassages ()));
if (request->query.count ("install")) {
vector <string> usfm_resources = client_logic_usfm_resources_get ();
vector <string> original_language_resources = resource_external_get_original_language_resources ();
vector <string> bible_resources = resource_external_get_bibles ();
vector <string> commentary_resources = resource_external_get_commentaries ();
vector <string> general_resources = resource_external_get_general_resources ();
vector <string> sword_resources = sword_logic_get_available ();
vector <string> installable_resources;
installable_resources.insert (installable_resources.end (), usfm_resources.begin (), usfm_resources.end ());
installable_resources.insert (installable_resources.end (), original_language_resources.begin (), original_language_resources.end ());
installable_resources.insert (installable_resources.end (), bible_resources.begin (), bible_resources.end ());
installable_resources.insert (installable_resources.end (), commentary_resources.begin (), commentary_resources.end ());
installable_resources.insert (installable_resources.end (), general_resources.begin (), general_resources.end ());
installable_resources.insert (installable_resources.end (), sword_resources.begin (), sword_resources.end ());
vector <string> installing_resources = Database_Config_General::getResourcesToCache ();
vector <string> active_resources = request->database_config_user()->getActiveResources ();
for (auto & resource : active_resources) {
if (in_array (resource, installable_resources)) {
if (!in_array (resource, installing_resources)) {
installing_resources.push_back (resource);
Database_Config_General::setResourcesToCache (installing_resources);
}
}
}
tasks_logic_queue (SYNCRESOURCES);
view.set_variable ("success", translate ("Will install the resources.") + " " + translate ("The journal displays the progress."));
}
#ifdef HAVE_CLIENT
view.enable_zone ("client");
#endif
page += view.render ("resource", "organize");
page += Assets_Page::footer ();
return page;
}
string resource_sword (void * webserver_request)
{
Webserver_Request * request = (Webserver_Request *) webserver_request;
if (request->query.count ("refresh")) {
tasks_logic_queue (REFRESHSWORDMODULES);
redirect_browser (request, journal_index_url ());
}
if (request->query.count ("update")) {
tasks_logic_queue (UPDATESWORDMODULES, {});
redirect_browser (request, journal_index_url ());
}
/*
It used to be possible to manually install or uninstall SWORD modules.
However it was observed that on the open Bibledit demo,
there were bursts of installed SWORD modules.
That made Bibledit unresponsive or just get stuck.
Likely the web crawlers of the search engines click all links to install all modules.
The answer to this problem was to remove manual install or uninstall of SWORD modules.
*/
string page;
Assets_Header header = Assets_Header (translate("Resources"), request);
header.addBreadCrumb (menu_logic_settings_menu (), menu_logic_settings_text ());
page = header.run ();
Assets_View view;
map <string, string> installed_modules;
{
vector <string> modules = sword_logic_get_installed ();
for (auto module : modules) {
string name = sword_logic_get_installed_module (module);
string version = sword_logic_get_version (module);
installed_modules [name] = version;
}
}
vector <string> available_modules = sword_logic_get_available ();
string moduleblock;
for (auto & available_module : available_modules) {
string source = sword_logic_get_source (available_module);
string module = sword_logic_get_remote_module (available_module);
moduleblock.append ("<p>");
moduleblock.append (available_module);
if (!installed_modules [module].empty ()) {
moduleblock.append (" (" + translate ("installed") + ") ");
string version = sword_logic_get_version (available_module);
if (version != installed_modules[module]) {
moduleblock.append (" (" + translate ("to be updated") + ")");
}
}
moduleblock.append ("</p>\n");
}
view.set_variable ("moduleblock", moduleblock);
#ifdef HAVE_CLIENT
view.enable_zone ("client");
#else
view.enable_zone ("server");
#endif
page += view.render ("resource", "sword");
page += Assets_Page::footer ();
return page;
}
string sword_logic_get_text (string source, string module, int book, int chapter, int verse)
{
#ifdef HAVE_CLIENT
// Client checks for and optionally creates the cache for this SWORD module.
if (!Database_Cache::exists (module, book)) {
Database_Cache::create (module, book);
}
// If this module/passage exists in the cache, return it (it updates the access days in the cache).
if (Database_Cache::exists (module, book, chapter, verse)) {
return Database_Cache::retrieve (module, book, chapter, verse);
}
// Fetch this SWORD resource from the server.
string address = Database_Config_General::getServerAddress ();
int port = Database_Config_General::getServerPort ();
if (!client_logic_client_enabled ()) {
// If the client has not been connected to a cloud instance,
// fetch the SWORD content from the Bibledit Cloud demo.
address = demo_address ();
port = demo_port ();
}
string url = client_logic_url (address, port, sync_resources_url ());
string resource = "[" + source + "][" + module + "]";
url = filter_url_build_http_query (url, "r", resource);
url = filter_url_build_http_query (url, "b", convert_to_string (book));
url = filter_url_build_http_query (url, "c", convert_to_string (chapter));
url = filter_url_build_http_query (url, "v", convert_to_string (verse));
string error;
string html = filter_url_http_get (url, error, true);
// In case of an error, don't cache that error, but let the user see it.
if (!error.empty ()) return error;
// Client caches this info for later.
// Except in case of predefined responses from the Cloud.
if (html != sword_logic_installing_module_text ()) {
if (html != sword_logic_fetch_failure_text ()) {
Database_Cache::cache (module, book, chapter, verse, html);
}
}
return html;
#else
string module_text;
bool module_available = false;
string osis = Database_Books::getOsisFromId (book);
string chapter_verse = convert_to_string (chapter) + ":" + convert_to_string (verse);
// See notes on function sword_logic_diatheke
// for why it is not currently fetching content via a SWORD library call.
// module_text = sword_logic_diatheke (module, osis, chapter, verse, module_available);
// Running diatheke only works when it runs in the SWORD installation directory.
string sword_path = sword_logic_get_path ();
// Running several instances of diatheke simultaneously fails.
sword_logic_diatheke_run_mutex.lock ();
// The server fetches the module text as follows:
// diatheke -b KJV -k Jn 3:16
int result = filter_shell_vfork (module_text, sword_path, "diatheke", "-b", module.c_str(), "-k", osis.c_str(), chapter_verse.c_str());
sword_logic_diatheke_run_mutex.unlock ();
if (result != 0) return sword_logic_fetch_failure_text ();
// Touch the cache so the server knows that the module has been accessed just now.
string url = sword_logic_virtual_url (module, 0, 0, 0);
database_filebased_cache_get (url);
// If the module has not been installed, the output of "diatheke" will be empty.
// If the module was installed, but the requested passage is out of range,
// the output of "diatheke" contains the module name, so it won't be empty.
module_available = !module_text.empty ();
if (!module_available) {
// Check whether the SWORD module exists.
vector <string> modules = sword_logic_get_available ();
string smodules = filter_string_implode (modules, "");
if (smodules.find ("[" + module + "]") != string::npos) {
// Schedule SWORD module installation.
// (It used to be the case that this function, to get the text,
// would wait till the SWORD module was installed, and then after installation,
// return the text from that module.
// But due to long waiting on Bibledit demo, while it would install multiple modules,
// the Bibledit demo would become unresponsive.
// So, it's better to return immediately with an informative text.)
sword_logic_install_module_schedule (source, module);
// Return standard 'installing' information. Client knows not to cache this.
return sword_logic_installing_module_text ();
} else {
return "Cannot find SWORD module " + module;
}
}
// Remove any OSIS elements.
filter_string_replace_between (module_text, "<", ">", "");
// Remove the passage name that diatheke adds.
// A reliable signature for this is the chapter and verse plus subsequent colon.
size_t pos = module_text.find (" " + chapter_verse + ":");
if (pos != string::npos) {
pos += 2;
pos += chapter_verse.size ();
module_text.erase (0, pos);
}
// Remove the module name that diatheke adds.
module_text = filter_string_str_replace ("(" + module + ")", "", module_text);
// Clean whitespace away.
module_text = filter_string_trim (module_text);
return module_text;
#endif
return "";
}
