flair_bot.py

"""Flair bot."""
import sys
import os
import re
import codecs
import csv
from time import gmtime, strftime
import praw
try:
    from configparser import ConfigParser
except ImportError:
    from ConfigParser import ConfigParser


class FlairBot:
    """Flair bot."""

    def __init__(self):
        """Initial setup."""

        self.conf = ConfigParser()
        self.flairs = {}

        os.chdir(sys.path[0])
        if os.path.exists('conf.ini'):
            self.conf.read('conf.ini')
        else:
            raise FileNotFoundError('Config file, conf.ini, was not found.')

        if self.conf.get('log', 'logging') == 'False':
            self.logging = False
        else:
            self.logging = True

        self.reddit = self.login()
        self.get_flairs()

    def login(self):
        """Log in via script/web app."""

        app_id = self.conf.get('app', 'app_id')
        app_secret = self.conf.get('app', 'app_secret')
        user_agent = self.conf.get('app', 'user_agent')

        if self.conf.get('app', 'auth_type') == 'webapp':
            token = self.conf.get('auth-webapp', 'token')
            r = praw.Reddit(client_id=app_id,
                            client_secret=app_secret,
                            refresh_token=token,
                            user_agent=user_agent)
        else:
            username = self.conf.get('auth-script', 'username')
            password = self.conf.get('auth-script', 'passwd')
            r = praw.Reddit(client_id=app_id,
                            client_secret=app_secret,
                            username=username,
                            password=password,
                            user_agent=user_agent)

        return r

    def get_flairs(self):
        """Read flairs from CSV."""

        with open('flair_list.csv') as csvf:
            csvf = csv.reader(csvf)
            flairs = {}
            for row in csvf:
                if len(row) == 2:
                    flairs[row[0]] = row[1]
                else:
                    flairs[row[0]] = None

        self.flairs = flairs
        self.fetch_pms()

    def fetch_pms(self):
        """Grab unread PMs."""

        target_sub = self.conf.get('subreddit', 'name')
        valid = r'[A-Za-z0-9_-]+'
        subject = self.conf.get('subject', 'subject')
        for msg in self.reddit.inbox.unread():
            if msg.author is None:
                continue # Skip if the author is None
            author = str(msg.author)
            valid_user = re.fullmatch(valid, author)
            if msg.subject == subject and valid_user:
                self.process_pm(msg, author, target_sub)
        sys.exit()

    def process_pm(self, msg, author, target_sub):
        """Process unread PM."""

        content = msg.body.split(',', 1)
        class_name = content[0].rstrip()
        subreddit = self.reddit.subreddit(target_sub)

        if class_name in self.flairs:
            if len(content) > 1:
                flair_text = content[1].lstrip()[:64]
            else:
                flair_text = self.flairs[class_name] or ''

            subreddit.flair.set(author, flair_text, class_name)
            if self.logging:
                self.log(author, flair_text, class_name)

        msg.mark_read()

    @staticmethod
    def log(user, text, cls):
        """Log applied flairs to file."""

        with codecs.open('log.txt', 'a', 'utf-8') as logfile:
            time_now = strftime("%Y-%m-%d %H:%M:%S", gmtime())
            log = 'user: ' + user
            log += ' | class(es): ' + cls
            if len(text):
                log += ' | text: ' + text
            log += ' @ ' + time_now + '\n'
            logfile.write(log)


if __name__ == '__main__':
    FlairBot()