API Documentation GitHub repo Project website

Source

frontend/helpers/sword_module_helper.js

  1. /* This file is part of Ezra Bible App.
  3.    Copyright (C) 2019 - 2023 Ezra Bible App Development Team <contact@ezrabibleapp.net>
  5.    Ezra Bible App is free software: you can redistribute it and/or modify
  6.    it under the terms of the GNU General Public License as published by
  7.    the Free Software Foundation, either version 2 of the License, or
  8.    (at your option) any later version.
  10.    Ezra Bible App is distributed in the hope that it will be useful,
  11.    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12.    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13.    GNU General Public License for more details.
  15.    You should have received a copy of the GNU General Public License
  16.    along with Ezra Bible App. See the file LICENSE.
  17.    If not, see <http://www.gnu.org/licenses/>. */
  19. /**
  20.  * This module offers sword module related functionality
  21.  * @module sword_module_helper
  22.  * @category Helper
  23.  */
  25. const i18nHelper = require('./i18n_helper.js');
  27. const PUBLIC_LICENSES = ['Public Domain', 'General public license for distribution for any purpose'];
  29. var _moduleVersificationCache = {};
  30. var _cachedModule;
  32. module.exports.getSwordModule = async function(moduleId, isRemote=false) {
  33.   if (moduleId == null) {
  34.     return null;
  35.   }
  37.   if (!_cachedModule || _cachedModule.name !== moduleId || (_cachedModule.name === moduleId && _cachedModule.remote !== isRemote)) {
  38.     let swordModule = null;
  40.     try {
  41.       if (isRemote) {
  42.         swordModule = await ipcNsi.getRepoModule(moduleId);
  43.       } else {
  44.         swordModule = await ipcNsi.getLocalModule(moduleId);
  45.       }
  46.       swordModule.remote = isRemote;
  48.       _cachedModule = swordModule;
  49.     } catch (e) {
  50.       console.log(`Could not get ${isRemote ? 'remote' : 'local'} sword module for ${moduleId}`);
  51.     }
  53.   }
  54.   return _cachedModule;
  55. };
  57. module.exports.resetModuleCache = function() {
  58.   _cachedModule = null;
  59. };
  61. module.exports.getModuleDescription = async function(moduleId, isRemote=false) {
  63.   const swordModule = await this.getSwordModule(moduleId, isRemote);
  65.   if (!swordModule) {
  66.     return "No info available!";
  67.   }
  69.   var moduleInfo = "";   
  70.   if (isRemote) {
  71.     moduleInfo += "<b>" + swordModule.description + "</b><br><br>";
  72.   }
  73.   moduleInfo += await this.getModuleAbout(swordModule);
  75.   moduleInfo = urlify(moduleInfo);
  77.   return moduleInfo;
  78. };
  80. module.exports.getModuleInfo = async function(moduleId, isRemote=false, includeModuleDescription=true) {
  82.   const swordModule = await this.getSwordModule(moduleId, isRemote);
  84.   if (!swordModule) {
  85.     return "No info available!";
  86.   }
  88.   var moduleInfo = "No info available!";
  90.   try {
  91.     
  92.     moduleInfo = "";
  94.     if (includeModuleDescription) {
  95.       moduleInfo += await this.getModuleDescription(moduleId, isRemote);
  96.     }
  97.     
  98.     var yes = i18n.t("general.yes");
  99.     var no = i18n.t("general.no");
  101.     if (includeModuleDescription) {
  102.       moduleInfo += `<p style='margin-top: 1em; padding-top: 1em; border-top: 1px solid grey; font-weight: bold'>${i18n.t("general.sword-module-info")}</p>`;
  103.     }
  105.     let lastUpdate = swordModule.lastUpdate;
  107.     if (lastUpdate != "") {
  108.       try {
  109.         lastUpdate = i18nHelper.getLocalizedDate(lastUpdate);
  110.       } catch (e) {
  111.         console.log(e);
  112.       }
  113.     }
  115.     moduleInfo += "<table>";
  116.     moduleInfo += "<tr><td style='width: 11em;'>" + i18n.t("general.module-name") + ":</td><td>" + swordModule.name + "</td></tr>";
  117.     moduleInfo += "<tr><td>" + i18n.t("general.module-version") + ":</td><td>" + swordModule.version + "</td></tr>";
  118.     moduleInfo += "<tr><td>" + i18n.t("general.module-last-update") + ":</td><td>" + lastUpdate + "</td></tr>";
  119.     moduleInfo += "<tr><td>" + i18n.t("general.module-language") + ":</td><td>" + i18nHelper.getLanguageName(swordModule.language) + "</td></tr>";
  120.     moduleInfo += "<tr><td>" + i18n.t("general.module-license") + ":</td><td>" + swordModule.distributionLicense + "</td></tr>";
  122.     if (swordModule.type == 'Biblical Texts') {
  123.       moduleInfo += "<tr><td>" + i18n.t("general.module-strongs") + ":</td><td>" + (swordModule.hasStrongs ? yes : no) + "</td></tr>";
  124.       moduleInfo += "<tr><td>" + i18n.t("general.module-headings") + ":</td><td>" + (swordModule.hasHeadings ? yes : no) + "</td></tr>";
  125.       moduleInfo += "<tr><td>" + i18n.t("general.module-footnotes") + ":</td><td>" + (swordModule.hasFootnotes ? yes : no) + "</td></tr>";
  126.       moduleInfo += "<tr><td>" + i18n.t("general.module-xrefs") + ":</td><td>" + (swordModule.hasCrossReferences ? yes : no) + "</td></tr>";
  127.       moduleInfo += "<tr><td>" + i18n.t("general.module-redletter") + ":</td><td>" + (swordModule.hasRedLetterWords ? yes : no) + "</td></tr>";
  128.     }
  130.     moduleInfo += "<tr><td>" + i18n.t("general.module-size") + ":</td><td>" + this.getModuleSize(swordModule) + "</td></tr>";
  132.     if (swordModule.repository != '') {
  133.       moduleInfo += "<tr><td>" + i18n.t("module-assistant.repository_singular") + ":</td><td>" + swordModule.repository + "</td></tr>";
  134.     }
  136.     if (!isRemote) {
  137.       moduleInfo += "<tr><td>" + i18n.t("general.module-location") + ":</td><td>" + swordModule.location + "</td></tr>";
  138.     }
  140.     moduleInfo += "</table>";
  142.     if (isRemote && swordModule.locked && swordModule.unlockInfo != "") {
  143.       moduleInfo += "<p style='margin-top: 1em; padding-top: 1em; border-top: 1px solid grey; font-weight: bold'>" + i18n.t("general.sword-unlock-info") + "</p>";
  144.       moduleInfo += "<p class='external'>" + swordModule.unlockInfo + "</p>";
  145.     }
  146.   } catch (ex) {
  147.     console.error("Got exception while trying to get module info: " + ex);
  148.   }
  150.   return moduleInfo;
  151. };
  153. module.exports.getModuleAbout = async function(swordModuleOrId) {
  154.   var swordModule;
  155.   if (typeof swordModuleOrId === 'string') {
  156.     swordModule = await this.getSwordModule(swordModuleOrId);
  157.   } else {
  158.     swordModule = swordModuleOrId;
  159.   }
  161.   if (!swordModule || !swordModule.about) {
  162.     return '';
  163.   }
  164.   
  165.   const about = `
  166.     <p class="external">
  167.       ${swordModule.about.replace(/\\pard/g, "").replace(/\\par/g, "<br>")}
  168.     </p>`;
  170.   return about;
  171. };
  173. module.exports.getModuleSize = function(swordModule) {
  174.   return Math.round(swordModule.size / 1024) + " KB";
  175. };
  177. module.exports.moduleHasStrongs = async function(moduleId) {
  178.   const swordModule = await this.getSwordModule(moduleId);
  180.   if (swordModule != null) {
  181.     return swordModule.hasStrongs;
  182.   } else {
  183.     return false;
  184.   }
  185. };
  187. module.exports.moduleIsRTL = async function(moduleId) {
  188.   const swordModule = await this.getSwordModule(moduleId);
  190.   if (swordModule != null) {
  191.     return swordModule.isRightToLeft;
  192.   } else {
  193.     return false;
  194.   }
  195. };
  197. module.exports.bookHasHeaders = async function(moduleId, book, validate=true) {
  198.   var hasHeaders = false;
  199.   const swordModule = await this.getSwordModule(moduleId);
  201.   if (swordModule != null) {
  202.     hasHeaders = swordModule.hasHeadings;
  204.     if (hasHeaders && validate) {
  205.       const headerList = await ipcNsi.getBookHeaderList(moduleId, book);
  206.       if (headerList.length == 0) {
  207.         hasHeaders = false;
  208.       }
  209.     }
  210.   }
  212.   return hasHeaders;
  213. };
  215. module.exports.moduleHasApocryphalBooks = async function(moduleId) {
  216.   return await ipcNsi.moduleHasApocryphalBooks(moduleId);
  217. };
  219. module.exports.getVersification = async function(moduleId) {
  220.   if (moduleId == null) {
  221.     return null;
  222.   }
  224.   if (moduleId in _moduleVersificationCache) {
  225.     return _moduleVersificationCache[moduleId];
  226.   }
  228.   var versification = null;
  229.   var psalm3Verses = [];
  230.   var revelation12Verses = [];
  232.   try {
  233.     psalm3Verses = await ipcNsi.getChapterText(moduleId, 'Psa', 3);
  234.   } catch (e) {
  235.     console.log("TranslationController.getVersification: Could not retrieve chapter text for Psalm 3 of " + moduleId);
  236.   }
  238.   try {
  239.     revelation12Verses = await ipcNsi.getChapterText(moduleId, 'Rev', 12);
  240.   } catch (e) {
  241.     console.log("TranslationController.getVersification: Could not retrieve chapter text for Revelation 12 of " + moduleId);
  242.   }
  244.   if (psalm3Verses.length == 8 || revelation12Verses.length == 17) { // ENGLISH versification
  245.     versification = "ENGLISH";
  247.   } else if (psalm3Verses.length == 9 || revelation12Verses.length == 18) { // HEBREW versification
  248.     versification = "HEBREW";
  250.   } else { // Unknown versification
  252.     versification = "UNKNOWN";
  254.     /*console.log("Unknown versification!");
  255.     console.log("Psalm 3 has " + psalm3Verses.length + " verses.");
  256.     console.log("Revelation 12 has " + revelation12Verses.length + " verses.");*/
  257.   }
  259.   _moduleVersificationCache[moduleId] = versification;
  260.   return versification;
  261. };
  263. module.exports.getThreeLetterVersification = async function(moduleId) {
  264.   var versification = (await this.getVersification(moduleId) == 'ENGLISH' ? 'eng' : 'heb');
  265.   return versification;
  266. };
  268. module.exports.getModuleLanguage = async function(moduleId) {
  269.   const swordModule = await this.getSwordModule(moduleId);
  271.   if (swordModule != null) {
  272.     return swordModule.language;
  273.   } else {
  274.     return false;
  275.   }
  276. };
  278. module.exports.getModuleFullName = async function(moduleId) {
  279.   const swordModule = await this.getSwordModule(moduleId);
  281.   if (swordModule != null) {
  282.     return swordModule.description;
  283.   } else {
  284.     return moduleId;
  285.   }
  286. };
  288. module.exports.getModuleCopyright = async function(moduleId) {
  289.   const swordModule = await this.getSwordModule(moduleId);
  291.   if (swordModule != null) {
  292.     return swordModule.shortCopyright || swordModule.copyright;
  293.   } else {
  294.     return false;
  295.   }
  296. };
  298. module.exports.getModuleLicense = async function(moduleId) {
  299.   const swordModule = await this.getSwordModule(moduleId);
  301.   if (swordModule != null) {
  302.     return swordModule.distributionLicense;
  303.   } else {
  304.     return false;
  305.   }
  306. };
  308. module.exports.isPublicDomain = async function(moduleId) {
  309.   const license = await this.getModuleLicense(moduleId);
  310.   return !license || PUBLIC_LICENSES.includes(license);
  311. };
  313. module.exports.getLanguages = async function(moduleType='BIBLE', localModules=undefined) {
  314.   if (localModules == undefined) {
  315.     localModules = await ipcNsi.getAllLocalModules(moduleType);
  316.   }
  318.   if (localModules == null) {
  319.     return [];
  320.   }
  321.   
  322.   var languages = [];
  323.   var languageCodes = [];
  325.   for (let i = 0; i < localModules.length; i++) {
  326.     const module = localModules[i];
  327.     const languageName = i18nHelper.getLanguageName(module.language);
  329.     if (!languageCodes.includes(module.language)) {
  330.       languages.push({
  331.         'languageName': languageName,
  332.         'languageCode': module.language
  333.       });
  334.       languageCodes.push(module.language);
  335.     }
  336.   }
  338.   return languages;
  339. };
  341. module.exports.isStrongsTranslationAvailable = async function() {
  342.   var allTranslations = await ipcNsi.getAllLocalModules();
  344.   if (allTranslations == null) {
  345.     return false;
  346.   }
  348.   for (var dbTranslation of allTranslations) {
  349.     if (dbTranslation.hasStrongs) {
  350.       return true;
  351.     }
  352.   }
  354.   return false;
  355. };
  357. module.exports.sortModules = function(a,b) {
  358.   const isMobile = platformHelper.isMobile();
  359.   let aDescription = isMobile ? a.name : a.description;
  360.   aDescription = aDescription.toLowerCase();
  362.   let bDescription = isMobile ? b.name : b.description;
  363.   bDescription = bDescription.toLowerCase();
  365.   if (aDescription < bDescription) {
  366.     return -1;
  367.   } else if (aDescription > bDescription) {
  368.     return 1;
  369.   } else {
  370.     return 0;
  371.   }
  372. };
  374. function urlify(text) {
  375.   // replace urls in text with <a> html tag
  376.   var aTagRegex = /(<a href.*?>.*?<\/a>)/g;
  377.   var aSplits = text.split(aTagRegex);
  379.   // regex extracted from https://www.codegrepper.com/code-examples/whatever/use+regex+to+get+urls+from+string
  380.   // eslint-disable-next-line no-useless-escape
  381.   var urlRegex = /(?:(?:https?|ftp|file):\/\/|www\.|ftp\.)(?:\([-A-Z0-9+&@#/%=~_|$?!:,.]*\)|[-A-Z0-9+&@#/%=~_|$?!:,.])*(?:\([-A-Z0-9+&@#\/%=~_|$?!:,.]*\)|[A-Z0-9+&@#/%=~_|$])/igm;
  383.   var cleanedText = "";
  385.   for (let index = 0; index < aSplits.length; index++) {
  386.     var split = aSplits[index];
  388.     if (split.substring(0, 2) === '<a') {
  389.       cleanedText += split;
  390.     } else {
  391.       cleanedText += split.replace(urlRegex, function (url) {
  392.         if (url.startsWith('www')) {
  393.           url = 'http://' + url;
  394.         }
  396.         return `<a href="${url}" target="_blank">${url}</a>`;
  397.       });
  398.     }
  399.   }
  401.   return cleanedText;
  402. }