bulkFlairUpdater.py

#!/usr/bin/python3

import praw
import os
import logging.handlers
import sys
import configparser
import signal
import time
import traceback

USER_AGENT = "Bulk flair updater (by /u/Watchful1)"
REDDIT_OWNER = "Watchful1"
LOG_LEVEL = logging.INFO

SUBREDDIT = "SubTestBot1"
USERNAME = ""
PASSWORD = ""
CLIENT_ID = ""
CLIENT_SECRET = ""
# By default, this script just lists out the changes it would do, but doesn't actually do them
# Change this is false to actually run the changes
DEBUG = True

# use this section to switch every flair of one css class to a new css class, leaving the text alone
# turn it on by changing the False on the next line to True
flair_css_mapping_enabled = False
flair_css_mapping = {
	'oldCss1': 'newCss1',
	'oldCss2': 'newCss2',
}

# use this section to change all flair with one text to a new text, leaving the text alone
# turn it on by changing the False on the next line to True
flair_text_mapping_enabled = False
flair_text_mapping = {
	'oldText1': 'newText1',
	'oldText2': 'newText2',
}

# use this section to change combinations of css class and text into a different css class and text
# if either the css or text keys are not included in the result, it doesn't change that
# if this is enabled and a users flair matches something here, it will override the settings above
# turn it on by changing the False on the next line to True
flair_css_text_mapping_enabled = False
flair_css_text_mapping = {
	'oldCss1': {
		'oldText1': {'css': 'newCss1', 'text': 'newText1'},
		'oldText2': {'css': 'newCss2'},
	},
	'oldCss3': {
		'oldText3': {'css': 'newCss3', 'text': 'newText3'},
		'oldText4': {'text': 'newText4'},
	},
}

LOG_FOLDER_NAME = "logs"
if not os.path.exists(LOG_FOLDER_NAME):
	os.makedirs(LOG_FOLDER_NAME)
LOG_FILENAME = LOG_FOLDER_NAME+"/"+"bot.log"
LOG_FILE_BACKUPCOUNT = 5
LOG_FILE_MAXSIZE = 1024 * 1024 * 16

log = logging.getLogger("bot")
log.setLevel(LOG_LEVEL)
log_formatter = logging.Formatter('%(asctime)s - %(levelname)s: %(message)s')
log_stderrHandler = logging.StreamHandler()
log_stderrHandler.setFormatter(log_formatter)
log.addHandler(log_stderrHandler)
if LOG_FILENAME is not None:
	log_fileHandler = logging.handlers.RotatingFileHandler(LOG_FILENAME,
	                                                       maxBytes=LOG_FILE_MAXSIZE,
	                                                       backupCount=LOG_FILE_BACKUPCOUNT)
	log_fileHandler.setFormatter(log_formatter)
	log.addHandler(log_fileHandler)


debug = False
user = None
prawIni = False
if len(sys.argv) >= 2:
	user = sys.argv[1]
	for arg in sys.argv:
		if arg == 'debug':
			debug = True
			log.setLevel(logging.DEBUG)
		elif arg == 'prawini':
			prawIni = True


if prawIni:
	if user is None:
		log.error("No user specified, aborting")
		sys.exit(0)
	try:
		r = praw.Reddit(
			user
			, user_agent=USER_AGENT)
	except configparser.NoSectionError:
		log.error(f"User {user} not in praw.ini, aborting")
		sys.exit(0)
else:
	r = praw.Reddit(
		username=USERNAME
		,password=PASSWORD
		,client_id=CLIENT_ID
		,client_secret=CLIENT_SECRET
		,user_agent=USER_AGENT)

log.info("Logged into reddit as /u/{}".format(str(r.user.me())))

try:
	sub = r.subreddit(SUBREDDIT)

	template_ids = set()
	for template in sub.flair.templates:
		template_ids.add(template['id'])

	startTime = time.perf_counter()

	numFlairs = 0
	flair_map_old = []
	flair_map_new = []
	for flair in sub.flair(limit=None):
		numFlairs += 1

		item = {
			'user': flair['user'].name,
			'flair_text': flair['flair_text'],
			'flair_css_class': flair['flair_css_class'],
		}
		updated = False

		if flair_css_mapping_enabled:
			if flair['flair_css_class'] in flair_css_mapping:
				item['flair_css_class'] = flair_css_mapping[flair['flair_css_class']]
				updated = True

		if flair_text_mapping_enabled:
			if flair['flair_text'] in flair_text_mapping:
				item['flair_text'] = flair_text_mapping[flair['flair_text']]
				updated = True

		if flair_css_text_mapping_enabled:
			if flair['flair_css_class'] in flair_css_text_mapping and \
					flair['flair_text'] in flair_css_text_mapping[flair['flair_css_class']]:
				result = flair_css_text_mapping[flair['flair_css_class']][flair['flair_text']]
				if 'css' in result:
					item['flair_css_class'] = result['css']
				if 'text' in result:
					item['flair_text'] = result['text']
				updated = True

		if updated:
			log.info("/u/%s from '%s|%s' to '%s|%s'",
					 flair['user'].name,
					 flair['flair_css_class'],
					 flair['flair_text'],
					 item['flair_css_class'],
					 item['flair_text'])
			if item['flair_css_class'] in template_ids:
				flair_map_new.append(item)
			else:
				flair_map_old.append(item)
		else:
			log.debug("/u/%s unchanged from '%s|%s'", flair['user'].name, flair['flair_css_class'], flair['flair_text'])

	log.info("Processed %d flairs in %d seconds", numFlairs, int(time.perf_counter() - startTime))
	log.info("Found %d flairs that can be bulk updated and %d flairs that have to be single updated", len(flair_map_old), len(flair_map_new))
	if DEBUG:
		log.info("Debug mode enabled, not updating and flairs")
	else:
		if len(flair_map_old):
			startTime = time.perf_counter()
			log.info("Updating %d flairs with bulk updater. This could take a while.", len(flair_map_old))
			sub.flair.update(flair_map_old)
			log.info("Done in %d seconds", int(time.perf_counter() - startTime))
		if len(flair_map_new):
			startTime = time.perf_counter()
			log.info("Updating %d flairs with single updater. This takes approximately one second per flair.", len(flair_map_new))
			for flair in flair_map_new:
				sub.flair.set(
					redditor=flair['user'],
					text=flair['flair_text'],
					flair_template_id=flair['flair_css_class']
				)
			log.info("Done in %d seconds", int(time.perf_counter() - startTime))

except Exception as err:
	log.warning("Hit an error in main loop")
	log.warning(traceback.format_exc())