bot.py

import json
import logging
import praw
import os
import time

# The subreddit that contains the sales
sales_sub = "teasales"
# The subreddit to look for mentions & follow-up with replies
monitor_sub = "tea"

excluded_flair = set(["Discussion", "Article", "Reference", "Marketing Monday", "Meta"])

logger = logging.getLogger(__name__)

def main():
    init_logging()
    reddit = authenticate()
    logger.debug(f"Authenticated as {reddit.config.username}")
    vendors = load_vendors()
    vendor_names = get_names_only(vendors)
    logger.debug(f"Loaded {len(vendors)} vendors")
    subscribe(reddit, vendors, vendor_names)

def init_logging():
    logger.setLevel(logging.DEBUG)
    fh = logging.FileHandler("bot.log")
    fh.setLevel(logging.DEBUG)
    formatter = logging.Formatter("%(levelname)s: %(asctime)s - %(message)s")
    fh.setFormatter(formatter)
    logger.addHandler(fh)


def authenticate():
    return praw.Reddit("teasalesbot")

def load_vendors():
    """
    Loads the vendors from the JSON file, turning all keys to lowercase
    for later string matching.
    """
    with open("./vendors.json") as vendors:
        vendors = json.load(vendors)

    for vendor in vendors:
        vendor["pretty_name"] = vendor["name"]
        for key, val in vendor.items():
            if key == "nicknames":  # nicknames is a list of strings
                for i, nickname in enumerate(val):
                    val[i] = nickname.lower()
            elif key != "pretty_name":  # everything else is a string
                vendor[key] = val.lower()

    return vendors

def get_names_only(vendors):
    return set([v["reddit_username"] for v in vendors if "reddit_username" in v])

def subscribe(reddit, vendors, vendor_names):
    sub = reddit.subreddit(monitor_sub)
    streams = [sub.stream.submissions(pause_after=0),
               sub.stream.comments(pause_after=0)]

    stream_idx = 0
    while True:
        for item in streams[stream_idx]:
            if item is None or item.author is None:
                break

            if reddit.config.username == item.author.name:
                continue

            if item.author.name.lower() in vendor_names:
                logger.info(f"{item.id}: Not considering since author is a vendor: /u/{item.author.name}")
                continue

            if isinstance(item, praw.models.Submission):
                if item.link_flair_text in excluded_flair:
                    logger.info(f"{item.id}: Not considering due to excluded flair '{item.link_flair_text}'")
                    continue
                search_text = item.title
            else:
                submission = item.submission
                if submission.link_flair_text in excluded_flair:
                    logger.info(f"{item.id}: Not considering due to excluded flair for submission '{submission.link_flair_text}'")
                    continue
                search_text = item.body

            vendors_mentioned = get_vendors_mentioned(search_text, vendors)

            if vendors_mentioned:
                logger.info(f"{item.id}: Vendors {[v['pretty_name'] for v in vendors_mentioned]} found in text: {search_text}")
                try:
                    # Ensure we don't follow-up duplicate times
                    old_id = item.id
                    if already_responded(item, reddit.config.username):
                        logger.debug(f"{item.id}: Already responded to item or its parent")
                        continue
                    assert(old_id == item.id)

                    reply = get_reply(reddit, vendors_mentioned)
                    if reply:
                        respond(item, reply)
                except praw.exceptions.PRAWException as e:
                    logger.exception(f"{item.id}: Unable to respond to item")

        stream_idx = (stream_idx + 1) % len(streams)

def already_responded(comment_or_submission, bot_username):
    """
    Returns True if we've already responded to this comment or any of its
    parent comments, False otherwise
    """
    if isinstance(comment_or_submission, praw.models.Submission):
        for reply in comment_or_submission.comments:
            if reply.author is not None and bot_username == reply.author.name:
                return True
        return False

    ancestor = comment_or_submission
    while True:
        ancestor.body

        ancestor.refresh()
        for reply in ancestor.replies:
            if reply.author is not None and bot_username == reply.author.name:
                return True

        if ancestor.is_root:
            break

        ancestor = ancestor.parent()

    return False

def get_vendors_mentioned(text, vendors):
    """
    Searches through the text for mentions of any of the possible vendors,
    returning a list of vendors which were mentioned.
    """
    text = text.lower()
    mentioned_vendors = []
    for vendor in vendors:
        if vendor["name"] in text:
            mentioned_vendors.append(vendor)
            continue

        ru = "reddit_username"
        if ru in vendor and vendor[ru] in text:
            mentioned_vendors.append(vendor)
            continue

        surl = "store_url"
        if surl in vendor and vendor[surl] in text:
            mentioned_vendors.append(vendor)
            continue

        if "nicknames" in vendor:
            for nickname in vendor["nicknames"]:
                if nickname in text:
                    mentioned_vendors.append(vendor)
                    continue

    return mentioned_vendors

def get_reply(reddit, mentions):
    """
    Creates a table with the appropriate vendor & their sales details.
    Also includes footer with bot information.
    Returns a False-y value if none of the mentioned vendors have active sales.
    """
    rows = ["vendor|sales in /r/TeaSales",
            ":--|:--:"]
    vendors_without_sales = 0
    for vendor in mentions:
        sales = get_recent_sales(reddit, vendor)
        if sales:
            for i, sale in enumerate(sales):
                sale_info = f"|[{create_table_safe_reply(sale.title)}]({sale.url})"
                if i == 0:
                    sale_info = f"{vendor['pretty_name']}{sale_info}"
                else:
                    sale_info = f"|{sale_info}"
                rows.append(sale_info)
        else:
            vendors_without_sales += 1

    if vendors_without_sales == len(mentions):
        return None

    rows = "\n".join(rows)
    logger.debug(f"Created reply table:\n{rows}")
    footer = "^(TeaSalesBot made with 🍵 and ❤️ by) ^[/u\/taylorkline](/user/taylorkline)"
    return "\n".join([rows, footer])

def create_table_safe_reply(reply):
    return "".join([ch if ch != "|" else "-" for ch in reply])

def get_recent_sales(reddit, vendor):
    """
    Returns the vendor's active sales within the past month, in sorted order by newest sale.
    """
    query = "NOT (flair:expired OR flair:meta)"

    terms = []
    terms.append(create_search_term(vendor["name"]))
    if "reddit_username" in vendor:
        ru = vendor["reddit_username"]
        terms.append(f'author:"{ru}" OR {create_search_term(vendor["reddit_username"])}')
    if "nicknames" in vendor:
        for nickname in vendor["nicknames"]:
            terms.append(create_search_term(vendor["nicknames"]))
    if "store_url" in vendor:
        surl = vendor["store_url"]
        terms.append(f'site:"{surl}" OR {create_search_term(surl)}')

    terms = " OR ".join(terms)
    query = " ".join([query, terms])
    sales = reddit.subreddit(sales_sub).search(query, sort="new", time_filter="month")

    return [sale for sale in sales]

def create_search_term(keyword):
    return f'selftext:"{keyword}" OR title:"{keyword}"'

def respond(comment_or_submission, reply):
    replied = False
    for _ in range(20):
        try:
            reply = comment_or_submission.reply(reply)

            if isinstance(comment_or_submission, praw.models.Submission):
                parent_url = comment_or_submission.url
            else:
                parent_url = f"{comment_or_submission.submission.url}{comment_or_submission.id}"

            replied = True
            break
        except praw.exceptions.APIException as e:
            if not e.error_type == "RATELIMIT":
                raise e

            sleep_time_min = 2
            logger.warning(f"Waiting {sleep_time_min} minutes to respond due to error: {e.message}")
            time.sleep(sleep_time_min * 60)
            continue

    # Log the response
    if replied:
        try:
            prefix = "tmp"
            os.makedirs(f"{prefix}", exist_ok=True)
            fname = f"{reply.id}.log"
            with open(f"{prefix}/{fname}", "w") as logfile:
                logfile.write(reply.body)
                logger.debug(f"Response to item {parent_url} logged as {fname} in {prefix}/")
        except Exception as e:
            logger.exception(f"Was not able to log response to {parent_url}")

if __name__ == "__main__":
    main()