PointsBot/pointsbot/bot.py

import re

import praw

from . import config, database, level, reply

### Globals ###

USER_AGENT = 'PointsBot (by u/GlipGlorp7)'

# The pattern that determines whether a post is marked as solved
# Could also just use re.IGNORECASE flag
SOLVED_PAT = re.compile('![Ss]olved')
MOD_SOLVED_PAT = re.compile('/[Ss]olved')

TEST_COMMENTS = False

### Main Function ###


def run():
    cfg = config.load()
    levels = cfg.levels

    reddit = praw.Reddit(client_id=cfg.client_id,
                         client_secret=cfg.client_secret,
                         username=cfg.username,
                         password=cfg.password,
                         user_agent=USER_AGENT)
    subreddit = reddit.subreddit(cfg.subreddit)

    print_level(0, f'Connected to Reddit as {reddit.user.me()}')
    print_level(1, f'Read-only? {reddit.read_only}')
    print_level(0, f'Watching subreddit {subreddit.title}')
    is_mod = bool(subreddit.moderator(redditor=reddit.user.me()))
    print_level(1, f'Is mod? {is_mod}')

    if TEST_COMMENTS:
        make_comments(subreddit, levels)
        return

    db = database.Database(cfg.database_path)

    # Monitor new comments for confirmed solutions
    # Passing pause_after=0 will bypass the internal exponential delay; instead,
    # have to check if any comments are returned with each query
    for comm in subreddit.stream.comments(skip_existing=True, pause_after=0):
        if comm is None:
            continue

        print_level(0, '\nFound comment')
        print_level(1, f'Comment text: "{comm.body}"')

        if marks_as_solved(comm):
            if not is_first_solution(comm):
                # Skip this "!solved" comment and wait for the next
                print_level(1, 'Not the first solution')
                continue

            print_level(1, 'This is the first solution')
            print_solution_info(comm)

            solver = comm.parent().author
            print_level(1, f'Adding point for {solver.name}')
            db.add_point(solver)
            points = db.get_points(solver)
            print_level(1, f'Points for {solver.name}: {points}')

            level_info = level.user_level_info(points, levels)

            # Reply to the comment marking the submission as solved
            reply_body = reply.make(solver, points, level_info)
            print_level(1, f'Replying with: "{reply_body}"')
            comm.reply(reply_body)

            # Check if (non-mod) user flair should be updated to new level
            lvl = level_info.current
            if lvl and lvl.points == points:
                print_level(1, f'User reached level: {lvl.name}')
                if not subreddit.moderator(redditor=solver):
                    print_level(2, 'Setting flair')
                    print_level(3, f'Flair text: {lvl.name}')
                    print_level(3, f'Flair template ID: {lvl.flair_template_id}')
                    subreddit.flair.set(solver,
                                        text=lvl.name,
                                        flair_template_id=lvl.flair_template_id)
                else:
                    print_level(2, 'Solver is mod; don\'t alter flair')
        else:
            print_level(1, 'Not a "!solved" comment')


### Reddit Comment Functions ###


def marks_as_solved(comment):
    '''Return True if the comment meets the criteria for marking the submission
    as solved, False otherwise.
    '''
    op_resp_to_solver = (not comment.is_root
                         and comment.is_submitter
                         and not comment.parent().is_submitter
                         and SOLVED_PAT.search(comment.body))

    # Mod can only used MOD_SOLVED_PAT on any post, including their own
    mod_resp_to_solver = (not comment.is_root
                          and comment.subreddit.moderator(redditor=comment.author)
                          and MOD_SOLVED_PAT.search(comment.body))

    return op_resp_to_solver or mod_resp_to_solver


def is_first_solution(solved_comment):
    # Retrieve any comments hidden by "more comments"
    # Passing limit=0 will replace all "more comments"
    submission = solved_comment.submission
    submission.comments.replace_more(limit=0)

    # Search the flattened comments tree
    for comment in submission.comments.list():
        if (comment.id != solved_comment.id
                and marks_as_solved(comment)
                and comment.created_utc < solved_comment.created_utc):
            # There is an earlier comment for the same submission
            # already marked as a solution by the OP
            return False
    return True


### Debugging & Logging ###


def print_level(num_levels, string):
    print('\t' * num_levels + string)


def print_solution_info(comm):
    print_level(1, 'Submission solved')
    print_level(2, 'Solution comment:')
    print_level(3, f'Author: {comm.parent().author.name}')
    print_level(3, f'Body:   {comm.parent().body}')
    print_level(2, '"Solved" comment:')
    print_level(3, f'Author: {comm.author.name}')
    print_level(3, f'Body:   {comm.body}')


def make_comments(subreddit, levels):
    testpoints = [1, 3, 5, 10, 15, 30, 45, 75] + list(range(100, 551, 50))

    for sub in subreddit.new():
        if sub.title == 'Testing comment scenarios':
            redditor = sub.author
            for points in testpoints:
                body = f'Solver: {redditor}\n\nTotal points after solving: {points}'
                print_level(0, body)
                comm = sub.reply(body)
                if comm:
                    level_info = level.user_level_info(points, levels)
                    body = reply.make(redditor, points, level_info)
                    comm.reply(body)
                else:
                    print_level(1, 'ERROR: Unable to comment')
            break