__module_name__,__module_version__=("BOT","1.0.0")
__module_description__="Bible bot for displaying and searching bible texts"
print("\0034"+__module_name__+" "+__module_version__+" loaded\003")
import collections,re,string,threading,time,xchat
###
# module variables
###
cmdc=";"
fileName="/home/philip/.config/hexchat/addons/Apologia/resources/<n>.properties"
split,strip,upper=(str.split,str.strip,str.upper)
OrderedDict=collections.OrderedDict
join,lower,replace=(str.join,str.lower,str.replace)
bold,red,underline=("","\0034","\010") # bold ="\002"
versions={}
###
# get bible book names and then version names
###
bookName,versionName=(OrderedDict(),OrderedDict())
bn=replace(fileName,"<n>","Biblebooks")
with open(bn,"r") as booksFile:
for line in booksFile:
k,n=split(line,"=")
n=replace((replace(n,"\r","")),"\n","")
bookName[k]=n
vn=replace(fileName,"<n>","BibleVersions")
with open(vn,"r") as versionsFile:
for line in versionsFile:
k,n=split(line,"=")
n=replace((replace(n,"\r","")),"\n","")
versionName[k]=n
###
# helper functions
###
def displayPassage(version,book,ref,xcContext):
'''
display a passage from a selected bible in the current hexchat context.
'''
reflist=decodeRef(ref)
chapter=reflist[0]
first,last=(0,0)
try:
if len(reflist)==2: first,last=(int(reflist[1]),int(reflist[1]))
elif len(reflist)==3:
first,last=(int(reflist[1]),int(reflist[2]))
if last<=first: last=first
else:
say("passage reference: "+bold+ref+bold+" is incorrect",xcContext)
return
except:
say("passage reference: "+bold+ref+bold+" is incorrect",xcContext)
return
keylist=[]
if lower(book) in ["ccc","cct"]: last=first # allow only one CCC verse
if (last-first)>3: last=first+3
for i in range(first,last+1):
s=book+chapter+"_"+str(i)
keylist.append(s)
verses=versions[version]
for k in keylist:
try:
ref=refExpander(k)
say(bold+ref+bold+" "+verses[k],xcContext)
except:
say("I could not find "+bold+refExpander(k)+bold,xcContext)
def searchVersion(version,phrase,xcContext):
'''
search a bible for a phrase or for a set of words enclosed in [],(), or {}
(technically the enclosure need not be closed with a ],),or })
and display the search results in the current hexchat context.
'''
ss=""
verses,foundVerses=(versions[version],OrderedDict())
i,max=(0,30)
# search by set of words
if (strip(phrase)[0]) in ("[","{","("):
s,b=("[{()}]"," ")
table=string.maketrans(s,b)
sp=strip(string.translate(phrase,table))
sp=lower(sp.translate(string.maketrans("",""),string.punctuation))
swords=set(split(sp," "))
wc=len(swords)
for k in verses:
verse=lower(verses[k].translate(string.maketrans("",""),string.punctuation))
vwords=set(split(strip(verse)))
if swords.issubset(vwords):
i=i+1
if i>max: break # stop reading verses
foundVerses[k]=verses[k]
ref=refExpander(k)
if i==1: ss="found in "+version+": "+ref
else: ss=ss+", "+ref
# search by phrase
else:
rePhrase=r"\b"+lower(phrase)+r"\b"
for k in verses:
verse=verses[k]
foundlist=re.findall(rePhrase,lower(verse.translate(string.maketrans("",""),string.punctuation)))
if len(foundlist)>0:
foundVerses[k]=verses[k]
i=i+1
if i>max: break # stop reading verses
ref=refExpander(k)
if i==1: ss="found in "+version+": "+ref
else: ss=ss+", "+ref
# send search information back to the context from which the request came
if i>max:
say(ss+" ... more than "+str(max)+" found",xcContext)
return
if i==0:
say("I did not find any occurence of: '"
+bold+phrase+bold+"' in version: "+version,xcContext)
return
say(ss,xcContext) # say what was found
if i<5: # say the results if 4 or less were found
for fk in foundVerses:
say(bold+refExpander(fk)+bold+" "+foundVerses[fk],xcContext)
if lower(version) in ["ccc","cct"]:
say(red+"because "+version
+" sections are large only one is displayed",xcContext)
break
###
# utility functions
###
def decodeRef(ref):
'''
decode a book, chapter, and verse (or verses) reference.
'''
s=".,:;-_"
b=" "
table=string.maketrans(s,b)
r=string.translate(ref,table)
return split(r)
def getVersion(version):
'''
get a bible using its key (usually a three letter abbreviation) as recorded
in file "BibleVersions.properties"
'''
bv=OrderedDict()
bn=replace(fileName,"<n>",strip(version))
try:
with open(bn,"r") as properties:
for line in properties:
v=split(line,"=")
k=strip(v[0])
t=replace(v[1],"\r","")
t=replace(t,"\n","")
bv[k]=strip(t)
return bv
except:
bv["error"]="I could not find version "+bold+version+bold
return bv
def refExpander(ref):
'''
separate a reference into book, chapter, and verse components.
book is the first 3 characters, chapter is the token before a "_",
and verse is the token after "_".
'''
book=ref[:3]
bName=bookName[book]
chapter=split(ref[3:],"_")[0]+":"
verse=split(ref[4:],"_")[1]
if bName in ["CCC","CCT"]: chapter=""
r = bName+" "+chapter+verse
return r
def say(ss,xcContext):
'''
send messages back to the IRC server and split them at word boundaries
if the message text is very long
'''
if len(ss)<350: xcContext.command("SAY "+ss)
else:
while len(ss)>300:
pos=ss.find(" ",300,)
if pos!=-1:
ssp=ss[:pos]
ss=ss[pos+1:]
else:
ssp=ss[:300]
ss=ss[300:]
xcContext.command("SAY "+ssp)
xcContext.command("SAY "+ss)
###
# callback functions
###
def parseChannelMessage(word,word_eol,userdata):
'''
parses a message that starts with cmdc (command character)
to see if it is a command for this bot or not. If it is
then formulate a suitable response to the command.
if it isn't then ignore it.
'''
xcContext=xchat.get_context()
sender,message=(word[0],join(" ",split(word[1])))
firstchar=message[0]
if firstchar==cmdc:
cmd=split(message[1:]," ")
firstpart=lower(cmd[0])
if firstpart=="versions":
ss=""
for k in versionName:
ss=ss+bold+k+bold+"("+versionName[k]+") "
say(ss,xcContext)
return
if firstpart=="help":
say("To display a passage type "+bold+";rsv John 3:16"+bold
+" all bible book names are abbreviated to their first 3"
+" letters, for example 1Kings is 1ki, John is joh, and so forth."
+" There are exceptions: Judges is "+bold+"jdg,"+bold
+" Judith is "+bold+"jdt"+bold+", and Philemon is "
+bold+"phm"+bold,xcContext)
say("Searching is done by putting a 's' in front of the"
+" version name like this "+bold+";skjv God so loved"+bold
+" that will find all the verses in the KJV containing"
+" 'God so loved'",xcContext)
say("To display versions type "+bold+";versions"+bold,xcContext)
return
if firstpart[0]=="s":
version=upper(firstpart[1:])
if version not in versionName: return
phrase=lower(join(" ",cmd[1:]))
searchVersion(version,phrase,xcContext)
else:
if len(cmd)<3:
if len(cmd)==2:
if upper(cmd[0]) in ["CCC","CCT"]:
version=book=upper(cmd[0])
ref="1_"+cmd[1].translate(string.maketrans("",""),string.punctuation)
displayPassage(version,book,ref,xcContext)
elif len(cmd)==3:
version=upper(cmd[0])
if version not in versionName: return
book=upper(cmd[1])
if book in ["JUDGES","JUDG"]: book="JDG"
elif book in ["JUDITH", "JUDI"]: book="JDT"
elif book in ["PHILEMON","PHL"]: book="PHM"
elif book in ["RUTH","RUT"]: book="RTH"
bref=book[:3]
ref=cmd[2]
displayPassage(version,bref,ref,xcContext)
###
# load versions
###
for k in versionName:
versions[k]=getVersion(k)
###
# hooks
###
xchat.hook_print("Channel Message", parseChannelMessage)
xchat.hook_print("Private Message to Dialog", parseChannelMessage)
