node-sword-interface 0.237.0 → 0.241.0

package/.github/workflows/build.yml

@@ -10,7 +10,7 @@ jobs:
         - uses: actions/checkout@v2
         - uses: actions/setup-node@v2
           with:
-            node-version: '10'
+            node-version: '12'
 
         - run: sudo apt update && sudo apt install -y libcurl4-gnutls-dev
         - run: npm install

package/API.md

@@ -61,7 +61,7 @@ This is the main class of node-sword-interface and it provides a set of static f
     * [.getBibleText(moduleCode)](#NodeSwordInterface+getBibleText) ⇒ [<code>Array.&lt;VerseObject&gt;</code>](#VerseObject)
     * [.getBookIntroduction(moduleCode, bookCode)](#NodeSwordInterface+getBookIntroduction) ⇒ <code>String</code>
     * [.moduleHasBook(moduleCode, bookCode)](#NodeSwordInterface+moduleHasBook) ⇒ <code>Boolean</code>
-    * [.getModuleSearchResults(moduleCode, searchTerm, progressCB, searchType, isCaseSensitive, useExtendedVerseBoundaries)](#NodeSwordInterface+getModuleSearchResults) ⇒ <code>Promise</code>
+    * [.getModuleSearchResults(moduleCode, searchTerm, progressCB, searchType, searchScope, isCaseSensitive, useExtendedVerseBoundaries)](#NodeSwordInterface+getModuleSearchResults) ⇒ <code>Promise</code>
     * [.terminateModuleSearch()](#NodeSwordInterface+terminateModuleSearch)
     * [.hebrewStrongsAvailable()](#NodeSwordInterface+hebrewStrongsAvailable) ⇒ <code>Boolean</code>
     * [.greekStrongsAvailable()](#NodeSwordInterface+greekStrongsAvailable) ⇒ <code>Boolean</code>
@@ -91,7 +91,8 @@ This function must be called initially before using any other repository-related
 initialized, the use of this function is optional. However, the cached repository configuration may not contain the latest information
 if this function is not called.
 
-This function works asynchronously and returns a Promise object.
+This function works asynchronously and returns a Promise object. The Promise delivers a detailed status object which contains one
+entry for each of the repositories of the master repo list as well as one result entry.
 
 **Kind**: instance method of [<code>NodeSwordInterface</code>](#NodeSwordInterface)  
 
@@ -446,7 +447,7 @@ Checks whether a module has a certain book
 
 <a name="NodeSwordInterface+getModuleSearchResults"></a>
 
-### nodeSwordInterface.getModuleSearchResults(moduleCode, searchTerm, progressCB, searchType, isCaseSensitive, useExtendedVerseBoundaries) ⇒ <code>Promise</code>
+### nodeSwordInterface.getModuleSearchResults(moduleCode, searchTerm, progressCB, searchType, searchScope, isCaseSensitive, useExtendedVerseBoundaries) ⇒ <code>Promise</code>
 Returns the results of a module search.
 
 **Kind**: instance method of [<code>NodeSwordInterface</code>](#NodeSwordInterface)  
@@ -457,6 +458,7 @@ Returns the results of a module search.
 | searchTerm | <code>String</code> |  | The term to search for. |
 | progressCB | <code>function</code> |  | Optional callback function that is called on progress events. |
 | searchType | <code>String</code> | <code>phrase</code> | Options: phrase, multiWord, strongsNumber |
+| searchScope | <code>String</code> | <code>BIBLE</code> | Options: BIBLE, OT, NT |
 | isCaseSensitive | <code>Boolean</code> | <code>false</code> | Whether the search is case sensitive |
 | useExtendedVerseBoundaries | <code>Boolean</code> | <code>false</code> | Whether the search should use extended verse boundaries (Two verses instead of one) in case of a multi word search. |
 

package/README.md

@@ -112,10 +112,11 @@ To install the dependencies issue the following command on a Debian/Ubuntu based
 
 #### Install dependencies on Windows
 
-1. Install [git](https://git-scm.com/download/win) and [nodejs](https://nodejs.org).
-2. Install [windows-build-tools][windows-build-tools] (VS 2015 Compiler) by running the following command in an administrator powershell:<br/> `npm install --vs2015 --global windows-build-tools`.
+1. Install [git](https://git-scm.com/download/win).
+2. Install [nodejs](https://nodejs.org). Important note: Ensure to install the *x86 version* (32-bit) of nodejs 14.x.
+   Furthermore, when the setup assistant asks about *Tools for native modules*, make sure to tick the checkbox *Automatically install the necessary tools*. This will then install the windows build tools required to build node-sword-interface.
 
-[windows-build-tools]: https://www.npmjs.com/package/windows-build-tools
+![Tools for native addons](https://raw.githubusercontent.com/ezra-bible-app/ezrabibleapp.net/master/assets/screenshots/nodejs_tools_for_native_addons.png)
 
 ### Install from npmjs
 

package/index.js

@@ -104,7 +104,8 @@ class NodeSwordInterface {
    * initialized, the use of this function is optional. However, the cached repository configuration may not contain the latest information
    * if this function is not called.
    *
-   * This function works asynchronously and returns a Promise object.
+   * This function works asynchronously and returns a Promise object. The Promise delivers a detailed status object which contains one
+   * entry for each of the repositories of the master repo list as well as one result entry.
    *
    * @param {Function} progressCB - Optional callback function that is called on progress events.
    * @return {Promise}
@@ -115,12 +116,8 @@ class NodeSwordInterface {
         progressCB = function(progress) {};
       }
 
-      this.nativeInterface.updateRepositoryConfig(true, progressCB, function(updateSuccessful) {
-        if (updateSuccessful) {
-          resolve(0);
-        } else {
-          reject(-1);
-        }
+      this.nativeInterface.updateRepositoryConfig(true, progressCB, function(repoUpdateStatus) {
+        resolve(repoUpdateStatus);
       });
     });
   }
@@ -462,20 +459,33 @@ class NodeSwordInterface {
    * @param {String} searchTerm - The term to search for.
    * @param {Function} progressCB - Optional callback function that is called on progress events.
    * @param {String} searchType - Options: phrase, multiWord, strongsNumber
+   * @param {String} searchScope - Options: BIBLE, OT, NT
    * @param {Boolean} isCaseSensitive - Whether the search is case sensitive
    * @param {Boolean} useExtendedVerseBoundaries - Whether the search should use extended verse boundaries (Two verses instead of one) in case of a multi word search.
    * @return {Promise}
    */
-  getModuleSearchResults(moduleCode, searchTerm, progressCB=undefined, searchType="phrase", isCaseSensitive=false, useExtendedVerseBoundaries=false) {
+  getModuleSearchResults(moduleCode,
+                         searchTerm,
+                         progressCB=undefined,
+                         searchType="phrase",
+                         searchScope="BIBLE",
+                         isCaseSensitive=false,
+                         useExtendedVerseBoundaries=false) {
+
     if (progressCB === undefined) {
       progressCB = function(progress) {};
     }
 
     return new Promise((resolve, reject) => {
       try {
-        this.nativeInterface.getModuleSearchResults(moduleCode, searchTerm, searchType, isCaseSensitive, useExtendedVerseBoundaries, progressCB, function(searchResults) {
-          resolve(searchResults);
-        });
+        this.nativeInterface.getModuleSearchResults(moduleCode,
+                                                    searchTerm,
+                                                    searchType,
+                                                    searchScope,
+                                                    isCaseSensitive,
+                                                    useExtendedVerseBoundaries,
+                                                    progressCB,
+                                                    function(searchResults) { resolve(searchResults); });
       } catch (error) {
         reject(error);
       }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-sword-interface",
-  "version": "0.237.0",
+  "version": "0.241.0",
   "description": "Javascript (N-API) interface to SWORD library",
   "keywords": [
     "C++",
@@ -21,14 +21,14 @@
   "author": "Tobias Klein",
   "license": "GPL-2.0+",
   "dependencies": {
-    "node-addon-api": "^3.2.0"
+    "node-addon-api": "^4.2.0"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/ezra-project/node-sword-interface.git"
   },
   "devDependencies": {
-    "jsdoc-to-markdown": "^7.0.1",
+    "jsdoc-to-markdown": "^7.1.0",
     "node-gyp": "^8.0.0"
   }
 }

package/src/napi_module/module_search_worker.cpp

@@ -35,6 +35,7 @@ void ModuleSearchWorker::Execute(const ExecutionProgress& progress)
     this->_stdSearchResults = this->_moduleSearch.getModuleSearchResults(this->_moduleName,
                                                                          this->_searchTerm,
                                                                          this->_searchType,
+                                                                         this->_searchScope,
                                                                          this->_isCaseSensitive,
                                                                          this->_useExtendedVerseBoundaries);
     

package/src/napi_module/module_search_worker.hpp

@@ -36,6 +36,7 @@ public:
                        std::string moduleName,
                        std::string searchTerm,
                        SearchType searchType,
+                       SearchScope searchScope,
                        bool isCaseSensitive=false,
                        bool useExtendedVerseBoundaries=false)
 
@@ -45,6 +46,7 @@ public:
         _moduleName(moduleName),
         _searchTerm(searchTerm),
         _searchType(searchType),
+        _searchScope(searchScope),
         _isCaseSensitive(isCaseSensitive),
         _useExtendedVerseBoundaries(useExtendedVerseBoundaries),
         _searchTerminated(false) {
@@ -66,6 +68,7 @@ private:
     std::string _moduleName;
     std::string _searchTerm;
     SearchType _searchType;
+    SearchScope _searchScope;
     bool _isCaseSensitive;
     bool _useExtendedVerseBoundaries;
     bool _searchTerminated;

package/src/napi_module/node_sword_interface.cpp

@@ -695,6 +695,7 @@ Napi::Value NodeSwordInterface::getModuleSearchResults(const Napi::CallbackInfo&
     INIT_SCOPE_AND_VALIDATE(ParamType::string, // moduleName
                             ParamType::string, // searchTerm
                             ParamType::string, // searchType
+                            ParamType::string, // searchScope
                             ParamType::boolean, // isCaseSensitive
                             ParamType::boolean, // useExtendedVerseBoundaries
                             ParamType::function, // progressCallback
@@ -703,10 +704,11 @@ Napi::Value NodeSwordInterface::getModuleSearchResults(const Napi::CallbackInfo&
     Napi::String moduleName = info[0].As<Napi::String>();
     Napi::String searchTerm = info[1].As<Napi::String>();
     string searchTypeString = string(info[2].As<Napi::String>());
-    Napi::Boolean isCaseSensitive = info[3].As<Napi::Boolean>();
-    Napi::Boolean useExtendedVerseBoundaries = info[4].As<Napi::Boolean>();
-    Napi::Function jsProgressCallback = info[5].As<Napi::Function>();
-    Napi::Function callback = info[6].As<Napi::Function>();
+    string searchScopeString = string(info[3].As<Napi::String>());
+    Napi::Boolean isCaseSensitive = info[4].As<Napi::Boolean>();
+    Napi::Boolean useExtendedVerseBoundaries = info[5].As<Napi::Boolean>();
+    Napi::Function jsProgressCallback = info[6].As<Napi::Function>();
+    Napi::Function callback = info[7].As<Napi::Function>();
     SearchType searchType = SearchType::multiWord;
     
     if (searchTypeString == "phrase") {
@@ -725,6 +727,18 @@ Napi::Value NodeSwordInterface::getModuleSearchResults(const Napi::CallbackInfo&
         }
     }
 
+    SearchScope searchScope = SearchScope::BIBLE;
+
+    if (searchScopeString == "BIBLE") {
+        searchScope = SearchScope::BIBLE;
+    } else if (searchScopeString == "OT") {
+        searchScope = SearchScope::OT;
+    } else if (searchScopeString == "NT") {
+        searchScope = SearchScope::NT;
+    } else {
+        THROW_JS_EXCEPTION("Unknown search scope!");
+    }
+
     this->_currentModuleSearchWorker = new ModuleSearchWorker(*(this->_moduleHelper),
                                                               *(this->_moduleSearch),
                                                               *(this->_moduleStore),
@@ -735,6 +749,7 @@ Napi::Value NodeSwordInterface::getModuleSearchResults(const Napi::CallbackInfo&
                                                               moduleName,
                                                               searchTerm,
                                                               searchType,
+                                                              searchScope,
                                                               isCaseSensitive,
                                                               useExtendedVerseBoundaries);
     this->_currentModuleSearchWorker->Queue();

package/src/napi_module/worker.hpp

@@ -21,6 +21,7 @@
 
 #include <napi.h>
 #include <iostream>
+#include <map>
 
 #include "api_lock.hpp"
 #include "napi_sword_helper.hpp"
@@ -115,20 +116,29 @@ public:
                                                                         this,
                                                                         std::placeholders::_1);
 
-        int ret = this->_repoInterface.refreshRemoteSources(this->_forced, &_progressCallback);
+        int ret = this->_repoInterface.refreshRemoteSources(this->_forced, &this->_repoUpdateStatus, &_progressCallback);
         this->_isSuccessful = (ret == 0);
         unlockApi();
     }
 
     void OnOK() {
         Napi::HandleScope scope(this->Env());
-        Napi::Boolean isSuccessful = Napi::Boolean::New(this->Env(), this->_isSuccessful);
-        Callback().Call({ isSuccessful });
+
+        Napi::Object repoUpdateStatusObject = Napi::Object::New(this->Env());
+        repoUpdateStatusObject["result"] = this->_isSuccessful;
+
+        map<string, bool>::iterator it;
+        for (it = this->_repoUpdateStatus.begin(); it != this->_repoUpdateStatus.end(); it++) {
+          repoUpdateStatusObject[it->first] = it->second;
+        }
+        
+        Callback().Call({ repoUpdateStatusObject });
     }
 
 private:
     bool _isSuccessful;
     bool _forced;
+    map<string, bool> _repoUpdateStatus;
 };
 
 class UninstallModuleWorker : public BaseWorker {

package/src/node_sword_cli.cpp

@@ -197,7 +197,7 @@ int main(int argc, char** argv)
 
     //get_strongs_entry(textProcessor);
 
-    get_module_text(textProcessor);
+    //get_module_text(textProcessor);
 
     //get_book_intro(textProcessor);
 
@@ -206,11 +206,11 @@ int main(int argc, char** argv)
     //string translation = sword_facade.getSwordTranslation(string("/usr/share/sword/locales.d"), string("de"), string("locales"));
     //cout << translation << endl;
 
-    /*vector<Verse> searchResults = moduleSearch.getModuleSearchResults("NASB", "Jesus faith", SearchType::multiWord, false, true);
+    vector<Verse> searchResults = moduleSearch.getModuleSearchResults("NASB", "faith", SearchType::multiWord, SearchScope::NT, true);
     cout << "Got " << searchResults.size() << " results!" << endl;
     for (unsigned int i=0; i < searchResults.size(); i++) {
         cout << searchResults[i].reference << endl;
-    }*/
+    }
 
     return 0;
 }

package/src/sword_backend/file_system_helper.cpp

@@ -82,6 +82,13 @@ void FileSystemHelper::createBasicDirectories()
     #endif
 #endif
 
+    if (!this->fileExists(this->getUserDir())) {
+      ret = this->makeDirectory(this->getUserDir());
+      if (ret != 0) {
+        cerr << "Failed to create user dir at " << this->getUserDir() << endl;
+      }
+    }
+
     if (!this->fileExists(this->getUserSwordDir())) {
         ret = this->makeDirectory(this->getUserSwordDir());
         if (ret != 0) {

package/src/sword_backend/module_search.cpp

@@ -50,17 +50,52 @@
 using namespace std;
 using namespace sword;
 
+ListKey ModuleSearch::getScopeKey(SearchScope scope)
+{
+    ListKey key;
+
+    switch (scope) {
+        case SearchScope::OT:
+        {
+            const char* otBooks = "Genesis;Exodus;Leviticus;Numbers;Joshua;Judges;"
+                                  "Ruth;I Samuel;II Samuel;I Kings;II Kings;I Chronicles;II Chronicles;"
+                                  "Ezra;Nehemiah;Esther;Job;Psalms;Proverbs;Ecclesiastes;Song of Solomon;"
+                                  "Isaiah;Jeremiah;Lamentations;Ezekiel;Daniel;Hosea;Joel;Amos;Obadiah;"
+                                  "Jonah;Micah;Nahum;Habakkuk;Zephaniah;Haggai;Zechariah;Malachi;";
+
+            key = VerseKey().parseVerseList(otBooks, "", true);
+            break;
+        }
+        
+        case SearchScope::NT:
+        {
+            const char* ntBooks = "Matthew;Mark;Luke;John;Acts;Romans;I Corinthians;II Corinthians;"
+                                  "Galatians;Ephesians;Philippians;Colossians;I Thessalonians;II Thessalonians;"
+                                  "I Timothy;II Timothy;Titus;Philemon;Hebrews;James;I Peter;II Peter;"
+                                  "I John;II John;III John;Jude;Revelation of John;";
+
+            key = VerseKey().parseVerseList(ntBooks, "", true);
+            break;
+        }
+        
+        default:
+            break;
+    }
+
+    return key;
+}
 
 vector<Verse> ModuleSearch::getModuleSearchResults(string moduleName,
                                                    string searchTerm,
                                                    SearchType searchType,
+                                                   SearchScope searchScope,
                                                    bool isCaseSensitive,
                                                    bool useExtendedVerseBoundaries)
 {
     this->_currentModuleName = moduleName;
     SWModule* module = this->_moduleStore.getLocalModule(moduleName);
     ListKey listKey;
-    ListKey* scope = 0;
+    SWKey* scope = 0;
     int flags = 0;
     // This holds the text that we will return
     vector<Verse> searchResults;
@@ -81,6 +116,13 @@ vector<Verse> ModuleSearch::getModuleSearchResults(string moduleName,
     } else if (searchTerm == "") {
         cerr << "ModuleSearch::getModuleSearchResults: cannot work with empty search term!" << endl;
     } else {
+        ListKey scopeKey;
+
+        if (searchScope != SearchScope::BIBLE) {
+            scopeKey = this->getScopeKey(searchScope);
+            scope = &scopeKey;
+        }
+
         bool hasStrongs = this->_moduleHelper.moduleHasGlobalOption(module, "Strongs");
 
         if (searchType == SearchType::strongsNumber) {

package/src/sword_backend/module_search.hpp

@@ -29,6 +29,7 @@ void internalModuleSearchProgressCB(char percent, void* userData);
 
 namespace sword {
     class SWModule;
+    class ListKey;
 };
 
 enum class SearchType {
@@ -37,6 +38,12 @@ enum class SearchType {
     strongsNumber = -3
 };
 
+enum class SearchScope {
+    BIBLE = 0,
+    OT = 1,
+    NT = 2
+};
+
 class ModuleStore;
 class ModuleHelper;
 class TextProcessor;
@@ -51,12 +58,15 @@ public:
     std::vector<Verse> getModuleSearchResults(std::string moduleName,
                                               std::string searchTerm,
                                               SearchType searchType=SearchType::multiWord,
+                                              SearchScope searchScope=SearchScope::BIBLE,
                                               bool isCaseSensitive=false,
                                               bool useExtendedVerseBoundaries=false);
     
     void terminate();
 
 private:
+    sword::ListKey getScopeKey(SearchScope scope);
+
     ModuleStore& _moduleStore;
     ModuleHelper& _moduleHelper;
     TextProcessor& _textProcessor;

package/src/sword_backend/repository_interface.cpp

@@ -67,6 +67,9 @@ void RepositoryInterface::resetMgr()
 
     this->_installMgr = new InstallMgr(this->_fileSystemHelper.getInstallMgrDir().c_str(), &this->_statusReporter);
     this->_installMgr->setUserDisclaimerConfirmed(true);
+
+    long timeoutMillis = 20000;
+    this->_installMgr->setTimeoutMillis(timeoutMillis);
 }
 
 int RepositoryInterface::refreshRepositoryConfig()
@@ -84,7 +87,7 @@ int RepositoryInterface::refreshRepositoryConfig()
     return 0;
 }
 
-int RepositoryInterface::refreshRemoteSources(bool force, std::function<void(unsigned int progress)>* progressCallback)
+int RepositoryInterface::refreshRemoteSources(bool force, map<string, bool>* repoUpdateStatus, std::function<void(unsigned int progress)>* progressCallback)
 {
     vector<future<int>> refreshFutures;
     this->_remoteSourceUpdateCount = 0;
@@ -111,6 +114,10 @@ int RepositoryInterface::refreshRemoteSources(bool force, std::function<void(uns
             if (ret != 0) {
               refreshSuccessful = false;
             }
+
+            if (repoUpdateStatus != 0) {
+              (*repoUpdateStatus)[sourceNames[i]] = (ret == 0);
+            }
         }
     }
 

package/src/sword_backend/repository_interface.hpp

@@ -21,6 +21,7 @@
 
 #include <vector>
 #include <string>
+#include <map>
 #include <future>
 
 #include "common_defs.hpp"
@@ -45,7 +46,7 @@ public:
     void resetMgr();
 
     int refreshRepositoryConfig();
-    int refreshRemoteSources(bool force=false, std::function<void(unsigned int progress)>* progressCallback=0);
+    int refreshRemoteSources(bool force=false, std::map<std::string, bool>* repoUpdateStatus=0, std::function<void(unsigned int progress)>* progressCallback=0);
 
     std::vector<std::string> getRepoNames();
     sword::SWModule* getRepoModule(std::string moduleName, std::string repoName="all");