added json and raw html API endpoints

Author: eliranwong

setup.py

@@ -47,7 +47,7 @@
 # https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/
 setup(
     name=package,
-    version="0.1.35",
+    version="0.1.36",
     python_requires=">=3.8, <3.13",
     description=f"UniqueBible App is a cross-platform & offline bible application, integrated with high-quality resources and unique features. Developers: Eliran Wong and Oliver Tseng",
     long_description=long_description,

uniquebible/db/ToolsSqlite.py

@@ -1,6 +1,7 @@
 from uniquebible import config
 from uniquebible.util.BibleBooks import BibleBooks
 from uniquebible.util.CatalogUtil import CatalogUtil
+from uniquebible.util.RegexSearch import RegexSearch
 
 if __name__ == "__main__":
     from uniquebible.util.ConfigUtil import ConfigUtil
@@ -738,7 +739,7 @@ def getMenu(self, command):
         else:
             return "INVALID_COMMAND_ENTERED"
 
-    def getContent(self, verse):
+    def getContent(self, verse, fullVerseList=[]):
         if self.text in self.getCommentaryList():
             b, c, v, *_ = verse
             if c > 0:
@@ -750,9 +751,25 @@ def getContent(self, verse):
             scripture = self.cursor.fetchone()
             if scripture:
                 data = scripture[0]
+                if fullVerseList:
+                    fullVerseList = [f'<vid id="v{b}.{c}.{v}"' for b, c, v, *_ in fullVerseList]
+
+                    pattern = '(<vid id="v[0-9]+?.[0-9]+?.[0-9]+?"></vid>)<hr>'
+                    searchReplaceItems = ((pattern, r"<hr>\1"),)
+                    chapterCommentary = RegexSearch.deepReplace(data, pattern, searchReplaceItems)
+                    verseCommentaries = chapterCommentary.split("<hr>")
+
+                    loaded = []
+                    for i in verseCommentaries:
+                        for ii in fullVerseList:
+                            if i.strip() and not i in loaded and ii in i:
+                                loaded.append(i)
+                    data = "<hr>".join(loaded)
                 if c == 0:
                     data = data.replace("<b>0:0</b>", "")
                     data = data.replace("<u><b>0</b></u>", "")
+                if config.rawOutput:
+                    return data
                 if config.theme in ("dark", "night"):
                     data = data.replace('color:#000080;', 'color:gray;')
                 chapter += re.sub(r'onclick="luV\(([0-9]+?)\)"', r'onclick="luV(\1)" onmouseover="qV(\1)" ondblclick="mV(\1)"', data)

uniquebible/gui/MainWindow.py

@@ -4543,7 +4543,7 @@ def passRunTextCommand(self, textCommand, addRecord=True, source="main", forceEx
                 elif view:
                     views[view].setHtml(html, baseUrl)
 
-                if view == "instant" and (config.instantMode == 0 or (config.iModeSplitterSizes[-1] == 0 and not config.instantMode > 0)):
+                if hasattr(config, "iModeSplitterSizes") and view == "instant" and (config.instantMode == 0 or (config.iModeSplitterSizes[-1] == 0 and not config.instantMode > 0)):
                     self.showFlotableInstantView(html)
 
                 if addRecord:

uniquebible/latest_changes.txt

@@ -1,5 +1,19 @@
 PIP package:
 
+0.1.36
+
+* improved commentary output for terminal and stream mode
+
+* added API endpoints `/html` and `/json`, in addition to `/plain`
+
+See the differences:
+
+http://bible.gospelchurch.uk/html?cmd=Commentary:::John%202:4-7
+
+http://bible.gospelchurch.uk/json?cmd=Commentary:::John%202:4-7
+
+http://bible.gospelchurch.uk/plain?cmd=Commentary:::John%202:4-7
+
 0.1.35
 
 * refine commentary output via api endpoint

uniquebible/startup/nonGui.py

@@ -177,7 +177,7 @@ def run_terminal_mode():
             command = ".menu"
             config.mainWindow.printRunningCommand(command)
             content = config.mainWindow.getContent(command)
-        if content.strip():
+        if content is not None and content.strip():
             config.mainWindow.displayOutputOnTerminal(content)
         else:
             command = ".latestbible"

uniquebible/util/ConfigUtil.py

@@ -75,6 +75,7 @@ def setup(noQt=None, cli=None, enableCli=None, enableApiServer=None, enableHttpS
 
         # Temporary configurations
         # Their values are not saved on exit.
+        config.rawOutput = True if config.runMode == "stream" else False
         config.controlPanel = False
         config.miniControl = False
         config.tempRecord = ""

uniquebible/util/RemoteHttpHandler.py

@@ -19,7 +19,6 @@
 from uniquebible.util.TextCommandParser import TextCommandParser
 from uniquebible.util.RemoteCliMainWindow import RemoteCliMainWindow
 from uniquebible.util.TextUtil import TextUtil
-from uniquebible.util.RegexSearch import RegexSearch
 from urllib.parse import urlparse, parse_qs
 from uniquebible.util.FileUtil import FileUtil
 from uniquebible.util.LanguageUtil import LanguageUtil
@@ -245,11 +244,11 @@ def runStartupPlugins(self):
     def execPythonFile(self, script):
         self.textCommandParser.parent.execPythonFile(script)
 
-    def updateData(self, plainOutput=False, allowPrivateData=False):
-        if plainOutput:
+    def updateData(self, rawOutput=False, allowPrivateData=False):
+        if rawOutput:
             config.displayLanguage = "en_GB"
             config.standardAbbreviation = "ENG"
-            self.path = re.sub("^/plain", "/index.html", self.path)
+            self.path = re.sub("^/(html|json|plain)", "/index.html", self.path)
             config.webHomePage = "{0}.html".format(config.webPrivateHomePage) if allowPrivateData else "index.html"
         # Check language
         # Traditional Chinese
@@ -321,21 +320,6 @@ def handleBadRequests(self):
         else:
             self.blankPage()
 
-    def getCommentaryContent(self, chapterCommentary, fullVerseList):
-        pattern = '(<vid id="v[0-9]+?.[0-9]+?.[0-9]+?"></vid>)<hr>'
-        searchReplaceItems = ((pattern, r"<hr>\1"),)
-        chapterCommentary = RegexSearch.deepReplace(chapterCommentary, pattern, searchReplaceItems)
-        verseCommentaries = chapterCommentary.split("<hr>")
-
-        fullVerseList = [f'<vid id="v{b}.{c}.{v}"' for b, c, v, *_ in fullVerseList]
-
-        loaded = []
-        for i in verseCommentaries:
-            for ii in fullVerseList:
-                if i.strip() and not i in loaded and ii in i:
-                    loaded.append(i)
-        return "<hr>".join(loaded)
-
     def do_GET(self):
         try:
             self.clientIP = self.client_address[0]
@@ -356,11 +340,12 @@ def do_GET(self):
             query_components = parse_qs(urlparse(self.path).query)
             private = query_components.get("private", [])
             allowPrivateData = True if private and private[0].strip() == config.webPrivateHomePage else False
-            plainOutput = True if self.path.startswith("/plain?") else False
+            config.rawOutput = True if re.search(r"^/(html|json|plain)\?", self.path) else False
+            api = re.sub(r"^/(html|json|plain)\?.*?$", r"\1", self.path) if config.rawOutput else ""
             # update resource path
-            self.updateData(plainOutput=plainOutput, allowPrivateData=allowPrivateData)
+            self.updateData(rawOutput=config.rawOutput, allowPrivateData=allowPrivateData)
 
-            if plainOutput:
+            if config.rawOutput:
                 cmd = query_components.get("cmd", [])
                 if cmd:
                     self.command = query_components["cmd"][0].strip()
@@ -373,15 +358,20 @@ def do_GET(self):
                 # output
                 self.commonHeader()
                 _, content, _ = self.textCommandParser.parser(self.command, "http")
-                # refine commentary output
-                if content and self.command.strip().lower().startswith("commentary:::"):
-                    verseList = self.parser.extractAllReferences(self.command)
-                    if verseList:
-                        fullVerseList = Bible(text="KJV").getEverySingleVerseList(verseList[:1])
-                        content = self.getCommentaryContent(content, fullVerseList)
                 content = content.replace("<u><b>", "<u><b># ")
-                plainText = TextUtil.htmlToPlainText(content).strip()
-                self.wfile.write(bytes(plainText, "utf8"))
+                # convert to plain text for plain endpoint
+                if api in ("json", "plain"):
+                    content = TextUtil.htmlToPlainText(content).strip()
+                if api == "json":
+                    output = {}
+                    for index, item in enumerate(self.command.split(":::")):
+                        if index == 0:
+                            output["keyword"] = item.strip()
+                        else:
+                            output[f"parameter_{index}"] = item.strip()
+                    output["content"] = content
+                    content = json.dumps(output)
+                self.wfile.write(bytes(content, "utf8"))
                 # restore user config
                 config.addFavouriteToMultiRef = addFavouriteToMultiRef
             elif self.ignoreCommand(self.path):

uniquebible/util/TextCommandParser.py

@@ -1418,6 +1418,8 @@ def textPlainBible(self, verseList, text):
         return verses
 
     def textFormattedBible(self, verse, text, source=""):
+        if config.rawOutput:
+            return self.textPlainBible([verse], text)
         formattedBiblesFolder = os.path.join(config.marvelData, "bibles")
         formattedBibles = [f[:-6] for f in os.listdir(formattedBiblesFolder) if os.path.isfile(os.path.join(formattedBiblesFolder, f)) and f.endswith(".bible") and not re.search(r"^[\._]", f)]
         #marvelBibles = ("MOB", "MIB", "MAB", "MPB", "MTB", "LXX1", "LXX1i", "LXX2", "LXX2i")
@@ -3403,7 +3405,11 @@ def textCommentary(self, command, source):
                     config.mainB, config.mainC, config.mainV, *_ = bcvTuple
                 module = commandList[0]
                 commentary = Commentary(module)
-                content = commentary.getContent(bcvTuple)
+                fullVerseList = Bible("KJV").getEverySingleVerseList((bcvTuple,))
+                if config.runMode == "terminal" or config.rawOutput:
+                    content = commentary.getContent(bcvTuple, fullVerseList=fullVerseList)
+                else:
+                    content = commentary.getContent(bcvTuple)
                 if not content == "INVALID_COMMAND_ENTERED":
                     self.setCommentaryVerse(module, bcvTuple)
                 return ("study", content, {'tab_title':'Com:' + module})