AFBbot.py

"""Bot to check Reddit comments and threads for USAF base ratings or provide base information."""

import praw
import prawcore
import constants as c
import time
import bases
import stats
import search
import wiki
import wikipedia


def reddit_login():
    """Creates instance of Reddit login."""
    if c.debuglogin:
        print("Logging in...")
    login = praw.Reddit(username=c.reddit_user,
                        password=c.reddit_pass,
                        client_id=c.reddit_api,
                        client_secret=c.reddit_secret,
                        user_agent="Air Force Base Bot /r/AFBbot")
    return login


comments_checked = {}  # This is a fail safe for if the log fails to refrain from rechecking posts.
comment_checking = [None, None, None, None, None, None, None]  # Global var for the comment being checked, for errors.


def checkbases(comment, session):
    """Checks all base instances and a comment for a rating."""
    linebreaktext = list(comment.body.lower())
    checktext = filtertext(linebreaktext).split()
    stringtext = ''.join(checktext)
    if bases.db.query_commentid(comment.id):  # Check log to see if comment is handled, will only happen on restarts.
        if c.debugsearch:
            print("I have already handled this comment. " + str(comment.id))
        pass
    else:
        for trigger in c.triggers:
            if trigger.lower() in checktext:
                if "stats" in checktext:
                    statsreply(comment, comment.submission.id)
                    return True
                elif checkforrating(comment, checktext, stringtext, False):
                    return True
                else:
                    for base in bases.all_bases:
                        for name in base.names:
                            if name in checktext:
                                reply(comment, base, session)
                                bases.db.log('reply', base.names[0], str(comment.author), None, comment.id,
                                             comment.submission.id, None)
                                return True  # Prevents multiple triggers creating multiple comments.


def checkforrating(post, checktext, stringtext, issubmission):
    ratingtypes = ["rate", "arearate", "offbaserate", "onbaserate"]
    israting = False
    truebase = None
    rtypes = []
    rating = None
    update = True
    for rtype in ratingtypes:
        if rtype in checktext and checkvalidrating(stringtext, rtype):
            for base in bases.all_bases:
                for name in base.names:
                    if name in checktext:
                        if c.debugsearch:
                            print("User appears to be rating base.")
                        truebase = base
                        rtypes.append(rtype)
                        if not issubmission:
                            rating = getratingnumber(ratingfilter(list(post.body.lower())), rtype)
                            if base.addrating(str(post.author), rtype, rating, post.id, post.submission.id):
                                update = False
                            else:
                                base.changerating(str(post.author), rtype, rating, post.id, post.submission.id)
                        else:
                            rating = getratingnumber(ratingfilter(list(post.selftext.lower())), rtype)
                            if base.addrating(str(post.author), rtype, rating, post.id, post.id):
                                update = False
                            else:
                                base.changerating(str(post.author), rtype, rating, post.id, post.id)



                        israting = True

    if israting:
        if not c.debugnoreply:
            rated_reply(post, truebase, rtypes, rating, update)
            return True
    else:
        return False  # Prevents multiple base triggers creating multiple comments.


def checkbasesthread(thread, session):
    """Checks all base instances and a thread for a rating."""
    linebreaktext = list(thread.selftext.lower())
    checktext = filtertext(linebreaktext).split()
    stringtext = ''.join(checktext)
    global comments_checking
    if bases.db.query_commentid(thread.id):  # Check log to see if comment is handled, will only happen on restarts.
        if c.debugsearch:
            print("I have already handled this comment. " + str(thread.id))
        pass
    else:
        for trigger in c.triggers:
            if trigger.lower() in checktext:
                if "stats" in checktext:
                    statsreply(thread, thread.id)
                    return True
                elif checkforrating(thread, checktext, stringtext, True):
                    return True  # Prevents multiple base triggers creating multiple comments.
                else:
                    for base in bases.all_bases:
                        for name in base.names:
                            if name in checktext:
                                bases.db.log('reply', base.names[0], str(thread.author), None, thread.id, thread.id, None)
                                reply(thread, base, session)
                                return True  # Prevents multiple triggers creating multiple comments.


def ratingfilter(text):
    """Filters characters from the rating text string."""
    noquotetext = filterqtext(text)
    for num in range(len(noquotetext)):
        if noquotetext[num] == "\n":
            noquotetext[num] = ""
    if c.debugsearch:
        print("start of filtered text: " + str(noquotetext))
    filterchars = '!@#$%^&*()+<>=,?:;'
    filteredtext = ''.join(noquotetext)
    filteredtext = filteredtext.replace("/", " ")
    if c.debugsearch:
        print(str(filteredtext))
    for char in filterchars:
        filteredtext = filteredtext.replace(char, "")
    checktext = filteredtext.split()
    if c.debugsearch:
        print(str(checktext))
    return checktext


def filtertext(text):
    """Filters characters from the comment or thread text string."""
    noquotetext = filterqtext(text)
    if c.debugsearch:
        print(noquotetext)
    for i in range(len(noquotetext)):
        if noquotetext[i] == "'":
            noquotetext[i] = ""
    filterchars = '!@#$%^&*()/-;+<>=,.?:'
    filteredtext = ''.join(noquotetext)
    for char in filterchars:
        filteredtext = filteredtext.replace(char, "")
    if c.debugsearch:
        print("Symbols have been removed: " + str(filteredtext))
    checktext = ''.join(filteredtext)
    if c.debugsearch:
        print("Final check to text: " + checktext)
    return checktext


def filterqtext(text):
    """Prevents replying to quoted text and keeps punctuated text checked"""
    checkquote = text
    if c.debugsearch:
        print("I am checking" + (str(text)) + "for a quote mark, I see " + str(checkquote[0][0]))
    if checkquote[0][0] == '>':
        if c.debugsearch:
            print("Quote found")
        if "\n" in checkquote:
            for z in range(len(checkquote)):
                for char2 in checkquote[z]:
                    if char2 == '\n':
                        if c.debugsearch:
                            print("Line break found")
                            print("Quote: " + str(checkquote))
                        del checkquote[0:(z + 2)]
                        if ">" in checkquote:
                            if c.debugsearch:
                                print("Multi quote comment, will not reply.")
                            return ""
                        else:
                            return checkquote
        else:
            if c.debugsearch:
                print("No line break found, not replying.")
            return ""
    elif ">" in checkquote:
        if c.debugsearch:
            print("Quote within the text, will not reply.")
        return ""
    return checkquote


def checkvalidrating(comment, rtype):
    """Validates rating if debugsearch is enabled."""
    splitlist = comment.split(rtype)
    del splitlist[0]
    joinedlist = ''.join(splitlist)
    if c.debugsearch:
        print(str(joinedlist))
    numbers = [int(x) for x in comment if x.isdigit()]
    if c.debugsearch:
        print(str(numbers))
    if c.debugsearch:
        print("Checking if the rating is valid, I found these numbers: " + str(numbers) + "Length "
              + str(len(numbers)))
    if len(numbers) < 1:
        if c.debugsearch:
            print("No numbers, returning with a reply instead of a rating")
        return False
    else:
        return True


def getratingnumber(text, rtype):
    """Determines the rating of a base.

    Detects the usage of a rating type in a string,
    determines the base and rating, and returns a rating.
    """
    delete = []  # deletes everything up to and including the indexes "rate"
    for i in range(len(text)):
        word = text[i]
        if word == rtype:
            for z in range(0, i):
                delete.append(z)
            break
    for i in sorted(delete, reverse=True):
        del text[i]
    delete = []  # deletes every index that begins with an alpha character, only need numbers/periods at this point.
    for i in range(len(text)):
        word = list(text[i])
        realword = word[0]
        if realword.isalpha():
            delete.append(i)
            continue
    for i in sorted(delete, reverse=True):
        del text[i]

    finalnumbers = []  # List of lists of numbers, decimals and hyphens in the comment after "rate".
    for char in text:  # Filters out anything besides integers, decimals and hyphens.
        number = []
        appenededperiod = False  # Handles decimals and extra periods, places the first one it finds in the number.
        charlist = list(char)
        for i in range(len(charlist)):
            if charlist[i] == ".":
                if not appenededperiod:
                    number.append(".")
                    appenededperiod = True
            elif charlist[i] == "-" and i == 0:  # Checks for negative number, only if the - is the first char.
                number.append("-")
            else:
                try:
                    int(charlist[i])
                    number.append(charlist[i])
                except ValueError:
                    pass
        if c.debugsearch:
            print("Filtered non numbers and extra decimals - " + str(number))
        finalnumbers.append(number)
    if c.debugsearch:
        print("Filtered everything but numbers and decimal point: " + str(finalnumbers))
    finalnumberlist = finalnumbers[0]  # If multiple numbers like "9 out of 10", takes the first.
    joinednumber = ''.join(str(i) for i in finalnumberlist)
    floatnumber = float(joinednumber)
    if floatnumber > 10:
        return 10.00
    elif 1 <= floatnumber <= 10:
        rounded = "%.2f" % floatnumber
        return rounded
    elif floatnumber <= 1:
        return 1.00
    else:
        print("Something weird happened with the getrating number, " + str(floatnumber))
        return 10.00


def reply(comment, base, session):
    """Replies to a comment with the base rating."""
    wikiurl = f"""*For more information check out the [Base Wiki.]
    (https://www.reddit.com/r/ratemyafb/wiki/bases/{base.names[0]})*\n\n"""
    print("Adding reply to " + str(comment.id))
    overallrating = str(base.gettrueoverallrating())
    ranking, rankingcount = base.getoverallranking()
    if not c.debugnoreply:
        comment.reply(f"""{base.displayname}{base.getmajcom()} is located in {base.location}\n\n
{stats.weather.getweather(base.location, base.manualweather)}
{search.getsearch(session, base)}
**Overall base rating:** {overallrating}/10 from {str(bases.db.count_ratings(base.names[0], False))} ratings. 
| **Ranking:** {ranking} out of {rankingcount} bases.\n\n
\n\n{wikiurl}""" + c.bot_signature)


def statsreply(comment, threadid):
    print("Replying with stats to " + str(comment.id))
    if not c.debugnoreply:
        comment.reply(stats.Stats.getreply(stats.thestats) + c.bot_signature)
        bases.db.log("Stats", None, str(comment.author), None, str(comment.id), str(threadid), None)


def rated_reply(comment, base, rtypes, rating, update):
    """Acknowledges a base rating and replies with the updated rating"""
    wikiurl = f"""*For more information check out the [Base Wiki.]
(https://www.reddit.com/r/ratemyafb/wiki/bases/{base.names[0]})*\n\n"""
    singlechange = False
    if len(rtypes) == 1:
        singlechange = True
        if rtypes[0] == "rate":
            ratingtdisplay = "general rating"
        elif rtypes[0] == "arearate":
            ratingtdisplay = "area rating"
        elif rtypes[0] == "offbaserate":
            ratingtdisplay = "off-base housing rating"
        elif rtypes[0] == "onbaserate":
            ratingtdisplay = "on-base housing rating"

    overallrating = str(base.gettrueoverallrating())
    ranking, rankingcount = base.getoverallranking()
    print(f"Adding {rtypes} to " + str(base.names[0]) + "  " + str(comment.id))  # Checks if they have already added a rating to this base
    if singlechange:
        if not update:
            if not c.debugnoreply:
                comment.reply(f'''Your {ratingtdisplay} of {str(rating)} has been added to {base.displayname}.\n\n
**Overall base rating:** {overallrating}/10 from {str(bases.db.count_ratings(base.names[0], False))} ratings. 
| **Ranking:** {ranking} out of {rankingcount} bases.\n\n
**General rating:** {str(base.getrating("rate"))} from {str(bases.db.count_ratings(base.names[0], "rate"))} ratings. 
| **Local Area rating:** {str(base.getrating("arearate"))} from {str(bases.db.count_ratings(base.names[0], "arearate"))} ratings.\n\n
**On-base housing rating:** {str(base.getrating("onbaserate"))} from {str(bases.db.count_ratings(base.names[0], "onbaserate"))} ratings. 
| **Off-base housing rating:** {str(base.getrating("offbaserate"))} from {str(bases.db.count_ratings(base.names[0], "offbaserate"))} ratings.
\n\n{wikiurl}''' + c.bot_signature)
        else:
            if not c.debugnoreply:
                comment.reply(f'''Your {ratingtdisplay} of {base.displayname} has been changed to {str(rating)}.  
**Overall base rating:** {overallrating}/10 from {str(bases.db.count_ratings(base.names[0], False))} ratings. 
| **Ranking:** {ranking} out of {rankingcount} bases.\n\n
**General rating:** {str(base.getrating("rate"))} from {str(bases.db.count_ratings(base.names[0], "rate"))} ratings. 
| **Local Area rating:** {str(base.getrating("arearate"))} from {str(bases.db.count_ratings(base.names[0], "arearate"))} ratings.\n\n
**On-base housing rating:** {str(base.getrating("onbaserate"))} from {str(bases.db.count_ratings(base.names[0], "onbaserate"))} ratings. 
| **Off-base housing rating:** {str(base.getrating("offbaserate"))} from {str(bases.db.count_ratings(base.names[0], "offbaserate"))} ratings.
\n\n{wikiurl}''' + c.bot_signature)
    else:
        if not c.debugnoreply:
            comment.reply(f'''Your ratings of {base.displayname} have been recieved.\n\n
**Overall base rating:** {overallrating}/10 from {str(bases.db.count_ratings(base.names[0], False))} ratings. 
| **Ranking:** {ranking} out of {rankingcount} bases.\n\n
**General rating:** {str(base.getrating("rate"))} from {str(bases.db.count_ratings(base.names[0], "rate"))} ratings. 
| **Local Area rating:** {str(base.getrating("arearate"))} from {str(bases.db.count_ratings(base.names[0], "arearate"))} ratings.\n\n
**On-base housing rating:** {str(base.getrating("onbaserate"))} from {str(bases.db.count_ratings(base.names[0], "onbaserate"))} ratings. 
| **Off-base housing rating:** {str(base.getrating("offbaserate"))} from {str(bases.db.count_ratings(base.names[0], "offbaserate"))} ratings.
\n\n{wikiurl}''' + c.bot_signature)


def bot_main(login):
    """Uses Reddit instance to check comments and threads."""
    global comments_checking
    if c.catcherrors:
        try:
            comments_checking = [None, None, None, None, None, None, None]
            session = login
            if c.debugsearch:
                print("Checking comments...")
            for sub in c.reddit_subs:
                if c.debugsearch:
                    print("Checking in sub " + str(sub))
                for comment in session.subreddit(sub).comments(limit=30):  # Need to check for locked thread, throws except
                    if (not comments_checked.get(comment.id) or comments_checked.get(comment.id) < 3) and comment.author != c.reddit_user\
                            and len(comment.body.lower()) > 0 and not bases.db.checkblacklisted(comment.author, False):
                        comments_checking[1] = comment.author
                        comments_checking[3] = comment.id
                        comments_checking[4] = comment.submission.id
                        if comments_checked.get(comment.id):
                            comments_checked[comment.id] += 1
                        else:
                            comments_checked[comment.id] = 1
                        checkbases(comment, session)
                    else:
                        continue
                if c.debugsearch:
                    print("Checking threads...")
                for thread in session.subreddit(sub).new(limit=5):
                    if (not comments_checked.get(thread.id) or comments_checked.get(thread.id) < 3) and len(thread.selftext.lower()) > 0 and not\
                            bases.db.checkblacklisted(thread.author, False):
                        comments_checking[1] = thread.author
                        comments_checking[3] = thread.id
                        comments_checking[4] = thread.id
                        if comments_checked.get(thread.id):
                            comments_checked[thread.id] += 1
                        else:
                            comments_checked[thread.id] = 1
                        checkbasesthread(thread, session)

        except prawcore.exceptions.ResponseException as e:
            print("Response error, server probably busy. Sleeping and retrying. " + str(e))
            time.sleep(60)

        except prawcore.exceptions.OAuthException as e:
            bases.db.log('Login Error', None, None, None, None, None, str(e))
            print("Invalid credentials while logging in!")
            time.sleep(60)

        except ConnectionError as e:
            print("Connection error, sleeping and retrying. " + str(e))
            time.sleep(60)

        except Exception as e:
            print(f"Logging {comments_checking[0]} {comments_checking[1]} {comments_checking[2]} {comments_checking[3]} {comments_checking[4]} {e}")
            bases.db.log('Error', str(comments_checking[0]), str(comments_checking[1]), comments_checking[2],
                         None, None, str(comments_checking[3]) + " " + str(comments_checking[4]) + " " + str(e))
        else:
            if c.debugsearch:
                print("Completed loop successfully.")

        finally:
            if c.debugsearch:
                print("Sleeping...")
            time.sleep(30)
    else:
        comments_checking = [None, None, None, None, None, None, None]
        session = login
        if c.debugsearch:
            print("Checking comments...")
        for sub in c.reddit_subs:
            if c.debugsearch:
                print("Checking in sub " + str(sub))
            for comment in session.subreddit(sub).comments(limit=30):  # Need to check for locked thread, throws except
                if (not comments_checked.get(comment.id) or comments_checked.get(comment.id) < 3) and comment.author != c.reddit_user \
                        and len(comment.body.lower()) > 0:
                    comments_checking[1] = comment.author
                    comments_checking[3] = comment.id
                    comments_checking[4] = comment.submission.id
                    if comments_checked.get(comment.id):
                        comments_checked[comment.id] += 1
                    else:
                        comments_checked[comment.id] = 1
                    checkbases(comment, session)
                else:
                    continue
            if c.debugsearch:
                print("Checking threads...")
            for thread in session.subreddit(sub).new(limit=5):
                if (not comments_checked.get(thread.id) or comments_checked.get(thread.id) < 3) and len(thread.selftext.lower()) > 0:
                    comments_checking[1] = thread.author
                    comments_checking[3] = thread.id
                    comments_checking[4] = thread.id
                    if comments_checked.get(thread.id):
                        comments_checked[thread.id] += 1
                    else:
                        comments_checked[thread.id] = 1
                    checkbasesthread(thread, session)
        if c.debugsearch:
            print("Sleeping...")
        time.sleep(30)


if __name__ == "__main__":
    print("Running...")
    if c.createdb:
        bases.maketables()

    while True:  # Main loop
        session = reddit_login()
        bot_main(session)

        if c.updatewiki:
            try:
                wiki.maintainer.update(session)
            except wikipedia.exceptions.WikipediaException as e:
                print("Wiki error: " + str(e))
            except prawcore.exceptions.ServerError as e:
                print("Wiki Server error, Sleeping. " + str(e))
                time.sleep(30)
            except Exception as e:
                print("Unhandled exception in wiki main: " + str(e))