bot.py

#!/usr/bin/python3

"""
This is an AutoMod bot which scans r/unixporn for new posts while making sure
that the rules are being followed. It's a modification & merge of several bots
written by u/GoldenSights for various subs. MIT Licensed, without any warranty
"""

# Required modules
from sys import stdout
from time import sleep, strftime, time
from getpass import getpass
from praw import Reddit
from prawcore import exceptions


# CONFIGURATION

# Bot's Username
USERNAME = "USERNAME"
# Sub to scan for new posts
SUBREDDIT = "SUBREDDIT"
# Short description of what the bot does
USERAGENT = "Automated moderator for r/" + SUBREDDIT

# How many posts to retrieve at once (max 100)
MAXPOSTS = 10
# Time before post is removed
DELAY = 1800
# Toggles whether bot reports before removal
TRUSTME = True
# Time to post weekly threads
THREADTIME = "06:00"

# Reddit URL
RURL = "https://www.reddit.com/"
# Link to a Reddit's rule page
RULELINK = RURL + "r/" + SUBREDDIT + "/about/rules"
# Direct link to submit a post
SUBMITURL = RURL + "r/" + SUBREDDIT + "/submit"
# Direct link to send mod mail
MODMSG = RURL + "message/compose?to=%2Fr%2F" + SUBREDDIT
# Markdown formatted link for details comment template
TEMPLATE = "[details comment]({0}r/{1}/wiki/info/template)"
TEMPLATE = TEMPLATE.format(RURL, SUBREDDIT)


# MESSAGES

# Message about reporting bot errors
CONTACT = "\n\n*^[Contact]({0}) ^[us]({0}) ^if ^our ^bot ^has ^messed " \
          "^(up)*".format(MODMSG)

# Message when haven't added a details comment
NODETAILS = "You have not provided a {0} so the post has been removed. " \
            "Please add one and message the mod team so we can approve " \
            "your post.{1}".format(TEMPLATE, CONTACT)

# Message when karma is not high enough
KARMARM = "Your post has been caught in our spam filter. The mods have been " \
          "notified and will get back to you as soon as possible." + CONTACT

# Message when not using a tag
NOTAGREPLY = "Your post appears to be missing a title [tag] so has " \
             "been removed. See [rule 5]({0}) for more details but " \
             "briefly:\n\n* Screenshots requires [WM/DE]\n\n* Workflow " \
             "requires [WM/DE]\n\n* Hardware requires [DEVICE]\n\n" \
             "* Material requires [OC]{1}".format(RULELINK, CONTACT)

# Message when using a deprecated tag
DEPTAGREPLY = "Your post appears to be using one of the deprecated " \
              "[tags] so has been removed. The bot will automatically " \
              "apply the relevant link flair to posts." + CONTACT

# Message when not using a tag for a self post
SELFTAGREPLY = "Your post appears formatted incorrectly so was removed. " \
               "Please repost as one of the following:\n\n" \
               "* If you're trying share a screenshot or gif please use a " \
               "\"Link\" post or an \"Image & Video\" post.\n\n" \
               "* If you're asking for help with an issue please " \
               "comment in the stickied weekly workshop thread.\n\n" \
               "* If you're trying to start a discussion please follow rule " \
               "5 in the sidebar." + CONTACT

# Message when stating OS in a title tag
OSREPLY = "Your post appears to be using the OS [tag] so has been " \
          "removed. This is now deprecated in favour of userflair." + CONTACT

# Message when not using an approved host
HOSTRESPONSE = "You don't appear to be using an approved host: see " \
               "[rule 3]({0}) for more details. Please resubmit using " \
               "one of them, but feel free to leave mirrors to host " \
               "in your details comment.{1}".format(RULELINK, CONTACT)

# Warning when haven't added a details comment
DETAILSWARN = "Please add a {0}.{1}".format(TEMPLATE, CONTACT)

# Message when a post triggered upmo's spam filter
SPAMCHK = "The following post has triggered the spam filter, " \
          "please investigate. "

# Set threads to be posted on a weekly basis
THREADS = {
    "Fri": {
        "title": "Weekly Workshop",
        "body": "This is a thread to get answers for all your questions, no "
                "matter how stupid you think it may be. Feel free to share "
                "your default setups here too, someone might have some "
                "pointers for what to do next. In short you can make any on "
                "topic comment, in any format you like, and using any host. "
                "We hope this gives new users a chance to get some help "
                "with any problems they're having and older users a chance to "
                "show off their knowledge by helping those in need." + CONTACT
    }
}


# DATA

def fillout(list):
    """
    Takes a list of strings as input and returns a list of tags using a
    variety of brackets & seperators
    """

    openers = ["[", "(", "{", "⟨"]
    closers = ["]", ")", "}", "⟩"]
    seperators = ["|", "·", "+", "/", "\\", ","]
    newlist = []
    for item in list:
        for opener in openers:
            closer = closers[openers.index(opener)]
            toadd = [opener + item + closer,
                     opener + " " + item + " " + closer]
            for seperator in seperators:
                toadd += [opener + item + seperator,
                          seperator + item + closer,
                          opener + " " + item + " " + seperator,
                          seperator + " " + item + " " + closer]
            newlist += toadd
    return newlist


# Website Whitelist
WHITELIST = [
    # Reddit
    "g.redditmedia.com",
    "i.redd.it",
    "i.reddituploads.com",
    "v.redd.it",
    # Imgur
    "imgur.com",
    # Gfycat
    "gfycat.com",
    # Teknik
    "u.teknik.io",
    "upload.teknik.io",
    "v.teknik.io",
    # Other
    "redditmetrics.com/r/unixporn",
    "reddit.com/r/trendingsubreddits"
]

# Workflow extensions
EXTENSIONS = [".webm", ".gif", "gfycat", ".mp4", "v.redd.it"]

# Strings for the "Hardware" flair
HWSTRING = ["[desktop]",
            "[laptop]",
            "[multi]",
            "[phone]",
            "[portable]",
            "[server]",
            "[tablet]"]

# Title tags which shouldn't be used
TAGSTRING = ["discussion", "discussions",
             "hardware",
             "help", "request",
             "material", "materials",
             "meta",
             "mod",
             "other",
             "question", "q",
             "screenshot", "screenshots",
             "thread", "threads",
             "unixporn",
             "workflow",
             "wm/de", "wm", "de"]
TAGSTRING = fillout(TAGSTRING)

# Banned OS title tags
OSSTRING = ["aix",
            "android", "androidx86", "android x86",
            "antergos",
            "arch", "archlinux", "arch linux",
            "bodhi",
            "bsd",
            "centos",
            "chakra",
            "crunchbang", "#!",
            "crux",
            "debian", "debian testing",
            "dragonflybsd",
            "eos", "elementary", "elementaryos", "elementary os",
            "exherbo",
            "fedora",
            "freebsd",
            "funtoo",
            "gentoo",
            "hurd", "gnu/hurd",
            "korora",
            "kubuntu",
            "lfs", "linux", "gnu/linux",
            "linux mint", "linuxmint", "mint", "lmde",
            "lubuntu",
            "macos", "mac os", "osx", "os x", "mac osx",
            "manjaro",
            "netbsd",
            "nixos",
            "openbsd",
            "opensuse",
            "parabola",
            "plan9",
            "slackware",
            "ubuntu", "ubuntu gnome", "ubuntugnome",
            "windows", "windows 7", "windows 10", "win32",
            "xubuntu"]
OSSTRING = fillout(OSSTRING)


# BOT LOGIN

print(SUBREDDIT, "bot\n")
r = Reddit(client_id=getpass("ID: "),
           client_secret=getpass("Secret: "),
           user_agent=USERAGENT,
           username=USERNAME,
           password=getpass("Password: "))

try:
    print("{} running on r/{}".format(r.user.me(), SUBREDDIT))
except (exceptions.OAuthException, exceptions.ResponseException):
    print("Login error! Please try again.")
    exit(1)


# DEFINING FUNCTIONS

def slay(post, response):
    print("\tReplying to OP")
    res = post.reply(response)
    res.mod.distinguish(sticky=True)
    if not TRUSTME:
        print("\tReporting to mods")
        post.report("Reason in comments")
    post.mod.remove(spam=False)
    print("\tPost removed")
    sleep(5)


def tag_check(post, ptitle):
    print("Checking tags...")
    if any(key.lower() in ptitle for key in TAGSTRING):
        slay(post, DEPTAGREPLY)
    elif any(key.lower() in ptitle for key in OSSTRING):
        slay(post, OSREPLY)
    elif post.is_self and not ptitle.startswith('| '):
        slay(post, SELFTAGREPLY)
    elif any(tag in ptitle for tag in ["[", "]"]) or post.is_self:
        pass
    else:
        slay(post, NOTAGREPLY)


def karma_check(post, pauthor):
    """
    Checks if the author's combined link and comment karma is < 5. If so
    the post is removed, reported, and a comment is posted to inform OP
    """
    print("Checking karma...")
    user = r.redditor(pauthor)
    if user.link_karma + user.comment_karma < 5:
        print("\tKARMA KO")
        slay(post, KARMARM)
        r.subreddit(SUBREDDIT).message("Spam Check", SPAMCHK + post.permalink)
    else:
        print("\tKarma OK")


def flair_assign(post, purl, ptitle, flair):
    print("Scanning for flairs...")
    if flair == "":
        print("\tNo Flair")
        if "[oc]" in ptitle:
            print("\tAssigning 'Material' flair")
            post.flair.select("d4539c64-1185-11e4-8276-12313b0d3999")
        elif post.is_self:
            print("\tAssigning 'Discussion' flair")
            post.flair.select("3ca0392e-016b-11e4-9698-12313b0ea137")
        elif any(word in ptitle for word in HWSTRING):
            print("\tAssigning 'Hardware' flair")
            post.flair.select("dcf2ee38-1185-11e4-8b85-12313d195526")
        elif any(word in purl for word in EXTENSIONS):
            print("\tAssigning 'Workflow' flair")
            post.flair.select("3a672136-016b-11e4-ac17-12313b0e95bd")
        else:
            print("\tAssigning 'Screenshot' flair")
            post.flair.select("30184610-016b-11e4-b64a-12313b0a9e38")
        print("\tFlair Assigned")
    else:
        print("\tAlready Flaired")


def approve_host(post, purl, ptitle):
    print("Verifying hosts...")
    if any(domain in purl for domain in WHITELIST) or post.is_self:
        pass
    elif "[oc]" in ptitle:
        # Materials can come from any website
        pass
    else:
        slay(post, HOSTRESPONSE)


def details_scan(post, pauthor, ptime):
    """
    Function which check if a post contains a details comment and then takes
    the appropriate action. Also returns True if done with post and returns
    False if future action on the post will be needed.
    """

    print("Checking details comments...")
    comments = post.comments.list()
    commenters = []
    for comment in comments:
        try:
            commenters.append(comment.author.name)
        except AttributeError:
            commenters.append("[deleted]")

    if post.is_self:
        print("\tSelf post so N/A")
        return True

    elif pauthor in commenters:
        print("\tComment is okay")
        # Deletes all the bot's comments
        for comment, cauthor in zip(comments, commenters):
            if cauthor == USERNAME:
                comment.delete()
        print("\tDeleted old bot comments")
        return True

    else:
        difference = time() - ptime

        if difference > DELAY:
            slay(post, NODETAILS)
            return True

        elif (difference > (DELAY * 0.5)) and ("upmo" not in commenters):
            commenters = [comment.author.name for comment in comments]
            print("\tWarning OP")
            response = post.reply(DETAILSWARN)
            response.mod.distinguish(sticky=True)
            return False

        else:
            if difference < (DELAY * 0.5):
                differences = str("%.0f" % ((DELAY * 0.5) - difference))
                print("\tStill has " + differences + "s before warning")
            elif difference < DELAY:
                differences = str("%.0f" % (DELAY - difference))
                print("\tStill has " + differences + "s before removal")
            return False


def actions(post):
    # Post variables
    pid = post.id
    ptitle = post.title.lower()
    purl = post.url
    ptime = post.created_utc
    try:
        pauthor = post.author.name
    except AttributeError:
        pauthor = "[DELETED]"
    try:
        flair = post.link_flair_text.lower()
    except AttributeError:
            flair = ""
    # Post actions
    print("\nScanning " + pid + " by " + pauthor)
    flair_assign(post, purl, ptitle, flair)
    if details_scan(post, pauthor, ptime):
        with open("oldposts", "a+") as file:
            file.write(pid + "\n")
    tag_check(post, ptitle)
    approve_host(post, purl, ptitle)
    # karma_check(post, pauthor)


def weekly_thread(sub, thread):
    """
    If a thread exists in the THREADS dictionary for the current day, then at
    the THREADTIME that thread is posted to the sub as the bottom sticky
    """
    print("Getting weekly thread...")
    title = "| {} {}".format(thread["title"], strftime("%Y-%m-%d"))
    print("\tPosting", title, "thread")
    thread = sub.submit(title, selftext=thread["body"]).mod.sticky(bottom=True)
    thread.comment_sort = 'new'
    print("\tDone!")


# RUNNING BOT

while True:
    try:
        print("\nRunning at", strftime("%Y-%m-%d %H:%M:%S"))
        subreddit = r.subreddit(SUBREDDIT)
        posts = subreddit.new(limit=MAXPOSTS)

        day = strftime("%a")
        if strftime("%H:%M") == THREADTIME and day in THREADS:
            weekly_thread(subreddit, THREADS[day])

        try:
            with open("oldposts", "r") as file:
                oldposts = [line.strip() for line in file]
        except FileNotFoundError:
            oldposts = []

        for post in posts:
            if post.id not in oldposts and post.approved_by is None:
                actions(post)

    except Exception as e:
        log = strftime("%Y-%m-%d %H:%M:%S") + " " + str(e) + " " + str(type(e))
        with open("errors", "a") as file:
            file.write(log + "\n")

    # Calculates seconds left in current minute
    secs = 60 - int(strftime("%S"))
    # Counts down until the next minute
    for var in range(secs, 0, -1):
        stdout.write("\rRunning again in %ss " % var)
        stdout.flush()
        sleep(1)
    stdout.write("\r" + " "*28 + "\n")
    stdout.flush()