plugin.py

###
# Copyright (c) 2021, 2023 nvz <https://github.com/enveezee>
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
#   * Redistributions of source code must retain the above copyright notice,
#     this list of conditions, and the following disclaimer.
#   * Redistributions in binary form must reproduce the above copyright notice,
#     this list of conditions, and the following disclaimer in the
#     documentation and/or other materials provided with the distribution.
#   * Neither the name of the author of this software nor the name of
#     contributors to this software may be used to endorse or promote products
#     derived from this software without specific prior written consent.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
###
from json import loads, JSONDecodeError
from re import findall
from urllib.error import HTTPError
from urllib.request import Request, urlopen

from supybot.commands import *
import supybot.ircmsgs as ircmsgs
import supybot.callbacks as callbacks
import supybot.log as log

# List of lists containing valid book names to match against.
Books = [
    # * Include alternate short names that aren't startswith() of actual name.
    # ! Last entry of the list should be the one you want the API to use.
    # ! Books must be in order since getbible v2 API uses numbers not names.

    # Old Testament (1-39)
    ['Gn','Genesis'], ['Exodus'], ['Lv','Leviticus'], ['Nb','Nm','Numbers'],
    ['Dt','Deuteronomy'], ['Js','Joshua'], ['Jg','Judges'], ['Rth','Ruth'],
    ['1Sm','1Samuel'], ['2Sm','2Samuel'], ['1Kings'], ['2Kings'],
    ['1Chronicles'], ['2Chronicles'], ['Er','Ezra'], ['Nehemiah'], ['Esther'],
    ['Jb','Job'], ['Psm','Psalms'], ['Pv','Prv','Proverbs'], ['Ecclesiastes'],
    ['SongofSolomon'], ['Isaiah'], ['Jeremiah'], ['Lm','Lamentations'], 
    ['Ezekiel'], ['Dn','Daniel'], ['Hosea'], ['Jl','Joel'], ['Amos'], 
    ['Obadiah'],  ['Jonah'], ['Micah'], ['Nahum'], ['Hb','Habakkuk'], 
    ['Zp','Zephaniah'], ['Hg','Haggai'], ['Zc','Zechariah'], ['Malachi'],

    # New Testament (40-66)
    ['Mt','Matthew'], ['Mk','Mark'], ['Lk','Luke'], ['Jn','John'],
    ['At','Acts'], ['Romans'],  ['1Corinthians'], ['2Corinthians'],
    ['Galatians'], ['Ephesians'], ['Philippians'], ['Colossians'], 
    ['1Thessalonians'], ['2Thessalonians'], ['1Tm','1Timothy'], 
    ['2Tm','2Timothy'], ['Tt','Titus'], ['Pm','Philemon'], ['Hebrews'],
    ['James'], ['1Peter'], ['2Peter'], ['1Jn','1John'], ['2Jn','2John'],
    ['3Jn','3John'], ['Jd','Jude'], ['Re','Revelation'],
]

RegExp = [
    # Regular expression for matching (possible) citations.
    r'([\d]?[\s]*[a-zA-Z]{2,}[\s]*)',       # Match group 1 (Book).
    r'([\d]{1,3})[:]{1}',                   # Match group 2 (Chapter).
    r'([\d]{1,3}[-]?[\s]*[\d]{0,3})',       # Match group 3 (Verse).
    r'([\d\s,;:-]*)',                       # Match group 4 (List).
    r'(\([a-zA-Z]*\))?',                    # Match group 5 (Translation).
]

Translations = {
    'afrikaans': [  ['aov', 'Ou Vertaling']],
    'albanian': [   ['albanian', 'Albanian']],
    'amharic': [    ['amharic', 'Amharic NT'],
                    ['hsab', 'Haile Selassie Amharic Bible']],
    'arabic': [     ['arabicsv', 'Smith and Van Dyke']],
    'aramaic': [    ['peshitta', 'Peshitta NT']],
    'armenian': [   ['easternarmenian', 'Eastern Genesis Exodus Gospels'],
                    ['westernarmenian', 'Western NT']],
    'basque': [     ['basque', 'Navarro Labourdin NT']],
    'breton': [     ['breton', 'Gospels']],
    'bulgarian': [  ['bulgarian1940', 'Bulgarian Bible 1940']],
    'chamorro': [   ['chamorro', 'Psalms Gospels Acts']],
    'chinese': [    ['cns', 'NCV Simplified'],
                    ['cnt', 'NCV Traditional'],
                    ['cus', 'Union Simplified'],
                    ['cut', 'Union Traditional']],
    'coptic': [     ['bohairic', 'Bohairic NT'],
                    ['coptic', 'New Testament'],
                    ['sahidic', 'Sahidic NT']],
    'croatian': [   ['croatia', 'Croatian']],
    'czech': [      ['bkr', 'Czech BKR'],
                    ['cep', 'Czech CEP'],
                    ['kms', 'Czech KMS'],
                    ['nkb', 'Czech NKB']],
    'danish': [     ['danish', 'Danish']],
    'dutch': [      ['statenvertaling', 'Dutch Staten Vertaling']],
    'english': [    ['kjv', 'King James Version'],
                    ['akjv', 'American King James Version'],
                    ['asv', 'American Standard Version'],
                    ['basicenglish', 'Basic English Bible'],
                    ['douayrheims', 'Douay Rheims'],
                    ['wb', 'Websters Bible'],
                    ['weymouth', 'Weymouth NT'],
                    ['web', 'World English Bible'],
                    ['ylt', 'Youngs Literal Translation']],
    'esperanto': [  ['esperanto', 'Esperanto']],
    'estonian': [   ['estonian', 'Estonian']],
    'finnish': [    ['finnish1776', 'Finnish Bible 1776'],
                    ['pyharaamattu1933', 'Pyha Raamattu 1933'],
                    ['pyharaamattu1992', 'Pyha Raamattu 1992']],
    'french': [     ['darby', 'Darby'],
                    ['ls1910', 'Louis Segond 1910'],
                    ['martin', 'Martin 1744'],
                    ['ostervald', 'Ostervald 1996 revision']],
    'georgian': [   ['Gospels Acts James', 'Georgian']],
    'german': [     ['elberfelder', 'Elberfelder 1871'],
                    ['elberfelder1905', 'Elberfelder 1905'],
                    ['luther1545', 'Luther 1545'],
                    ['luther1912', 'Luther 1912'],
                    ['schlachter', 'Schlachter 1951']],
    'gothic': [     ['gothic', 'Gothic Nehemiah NT Portions']],
    'greek': [      ['moderngreek', 'Greek Modern'],
                    ['majoritytext', 'NT Byzantine Majority Text 2000 Parsed'],
                    ['byzantine', 'NT Byzantine Majority Text 2000'],
                    ['textusreceptus', 'NT Textus Receptus 1550 1894 Parsed'],
                    ['text', 'Textus Receptus'],
                    ['tischendorf', 'NT Tischendorf 8th Ed'],
                    ['westcotthort', 'NT Westcott Hort UBS4 variants Parsed'],
                    ['westcott', 'NT Westcott Hort UBS4 variants'],
                    ['lxxpar', 'OT LXX Accented Roots Parsing'],
                    ['lxx', 'OT LXX Accented'],
                    ['lxxunaccentspar', 'OT LXX Unaccented Roots Parsing'],
                    ['lxxunaccents', 'OT LXX Unaccented']],
    'hebrew': [     ['aleppo', 'Aleppo Codex'],
                    ['modernhebrew', 'Hebrew Modern'],
                    ['bhsnovowels', 'OT BHS Consonants Only'],
                    ['bhs', 'OT BHS Consonants and Vowels'],
                    ['wlcnovowels', 'OT WLC Consonants Only'],
                    ['wlc', 'OT WLC Consonants and Vowels'],
                    ['codex', 'OT Westminster Leningrad Codex']],
    'hungarian': [  ['karoli', 'Hungarian Karoli']],
    'italian': [    ['giovanni', 'Giovanni Diodati Bible 1649'],
                    ['riveduta', 'Riveduta Bible 1927']],
    'kabyle': [     ['kabyle', 'Kabyle NT']],
    'korean': [     ['korean', 'Korean']],
    'latin': [      ['newvulgate', 'Nova Vulgata'],
                    ['vulgate', 'Vulgata Clementina']],
    'latvian': [    ['latvian', 'New Testament']],
    'lithuanian': [ ['lithuanian', 'Lithuanian']],
    'manx_Gaelic': [['manxgaelic', 'Manx Gaelic Esther Jonah 4 Gospels']],
    'maori': [      ['maori', 'Maori']],
    'myanmar_Burmse': [['judson', 'Judson 1835']],
    'norwegian': [  ['bibelselskap', 'Det Norsk Bibelselskap 1930']],
    'portuguese': [ ['almeida', 'Almeida Atualizada']],
    'potawatomi': [ ['potawatomi', 'Potawatomi Matthew Acts Lykins 1844']],
    'romani': [     ['rom', 'Romani NT E Lashi Viasta Gypsy']],
    'romanian': [   ['cornilescu', 'Cornilescu']],
    'russian': [    ['makarij', 'Makarij Translation Pentateuch 1825'],
                    ['synodal', 'Synodal Translation 1876'],
                    ['zhuromsky', 'Victor Zhuromsky NT']],
    'scottish_Gaelic': [['gaelic', 'Scots Gaelic Gospel of Mark']],
    'spanish': [    ['valera', 'Reina Valera 1909'],
                    ['rv1858', 'Reina Valera NT 1858'],
                    ['sse', 'Sagradas Escrituras 1569']],
    'swahili': [    ['swahili', 'Swahili']],
    'swedish': [    ['swedish', 'Swedish 1917']],
    'tagalog': [    ['tagalog', 'Ang Dating Biblia 1905']],
    'tamajaq': [    ['tamajaq', 'Tamajaq Portions']],
    'thai': [       ['thai', 'Thai from kjv']],
    'turkish': [    ['tnt', 'NT 1987 1994'],
                    ['turkish', 'Turkish']],
    'ukrainian': [  ['ukranian', 'NT P Kulish 1871']],
    'uma': [        ['uma', 'Uma NT']],
    'vietnamese': [ ['vietnamese', 'Vietnamese 1934']],
    'wolof': [      ['wolof', 'Wolof NT']],
    'xhosa': [      ['xhosa', 'Xhosa']]
}


class INRI(callbacks.Plugin):
    def __init__(self, irc):
        self.__parent = super(INRI, self)
        self.__parent.__init__(irc)


    def doPrivmsg(self, irc, msg):
        '''Look for Bible citations made in the channel.'''
        channel = msg.args[0]

        # Ignore the message if it came from the bot.
        if msg.nick.casefold() == irc.nick.casefold():
            return
        # Ignore the message if it isn't in a channel.
        if not irc.isChannel(channel):
            return
        # Ignore the message if it is addressed to the bot.
        if callbacks.addressed(irc.nick, msg):
            return
        # Ignore the message if it is an action.
        if ircmsgs.isCtcp(msg) or ircmsgs.isAction(msg):
            return

        self.iam(irc, msg)


    def getbible(self, t, b, c):
        '''Make a request to getbible.net JSON API and parse response.'''
        # JSON API query URL.
        url = f'https://api.getbible.net/v2/{t}/{b}/{c}.json'
        # Form API request for passage and version.
        request = Request(url)
        # Set a User-Agent header.
        request.add_header('User-Agent', 'Mozilla/5.0')
        try:
            # Make the request and capture the response.
            response = urlopen(request)
        except HTTPError as e:
            # Log and errors during the request and return.
            log.error(f'HTTPError opening {url}: {e.code} {e.msg}')
            log.debug(f'{e.hdr}')
            return None

        # Extract headers from the HTTPResponse.
        headers = dict(response.getheaders())
        # Check to see if the response is JSON.
        if 'application/json' in headers['Content-Type']:
            try:
                # Parse the JSON response.
                bible = loads(response.read()) 
            except JSONDecodeError as e:
                # Log JSON parsing errors and return.
                log.error(f'JSONDecodeError: {e.msg}')
                log.debug(f'Pos:{e.pos} Line:{e.lineno} Col:{e.colno}')
                log.debug(f'{e.doc}')
                return None
            log.error(f'JSON Decoded.')
            # Return successfully parsed JSON.
            return bible
        else:
            # ! Log error if response wasn't JSON and return.
            log.error(f'Error making Bible API call to {url}:')
            log.error('API request succeeded but response was not JSON.')
            return None


    def iam(self, irc, msg, text=None):
        '''Before Jesus was...'''
        channel = msg.args[0]
        message = msg.args[1]

        # Search message for (possible) Bible citations.
        citations = findall(''.join(RegExp), message)

        if citations:
            # Iterate over each possible citation found.
            for citation in citations:
                # Strip matches, casefold, and extract them.
                bk, ch, vs, ls, tr = [s.strip().casefold() for s in citation]
                # Check bk against Books list, return book number if found.
                book = None
                bookNo = 0
                # Each valid book in Books list.
                for Book in Books:
                    bookNo = bookNo + 1
                    # Each matchable title for that book.
                    for title in Book:
                        # If bk matches a title.
                        if title.casefold().startswith(bk) or title == bk:
                            book = bookNo
                            log.error(f'{Book} : {book}')
                            break
                        
                if not book:
                    log.error(f'Book not found.')
                    return

                if bk == 'ez':   # Fix for Ezekial over Ezra
                    book = 26

                # If translation is specified, check to make sure its available.
                translate = None
                if tr:
                    tr = tr[1:-1]
                    translate = None
                    for lang in Translations:
                        for translation in Translations[lang]:
                            if tr == translation[0].casefold():
                                translate = tr
                                break
                        if translate:
                            break

                if not translate:
                    translate = self.registryValue('defaultBible', channel=channel)

                versesText=[]
                payload = self.getbible(translate, book, ch)
                verses = payload['verses']

                # if the verses are a range, enumerate a list of those verses
                if '-' in vs:
                    b, e = vs.split('-')
                    versesCited = list(range(int(b), int(e) + 1))
                # if the verses are a list, make a list of verses
                elif ls:
                    versesCited = [int(vs)] + [int(v) for v in ls.split(',')[1:]]
                else:
                    versesCited = [int(vs)]

                for verse in versesCited:
                    text = verses[verse - 1]['text']
                    irc.reply(
                        f'{Books[book - 1][-1]} {ch}: "{verse}.'
                        f' {text}" ({translate})', 
                        prefixNick=False
                        )


    def bibles(self, irc, msg, args, language=None):
        '''bibles <language>

        Lists bible translations for a particular language or all languages.
        '''
        translations = []
        if language:
            for translation in Translations[language[0].casefold()]:
                tr = translation[0]
                name = translation[1]
                translations.append(f'{name} ({tr})')
        else:
            for language in Translations:
                translations.append(language)
        translations = ', '.join(translations)
        irc.reply(f'{translations}', prefixNick=False)
    bibles = wrap(bibles, [any('text')])


Class = INRI