def __init__(self,
subreddit,
config_file='config.yaml',
useragent='default'):
#Load config and set up
self.log("Logging in...")
self.config = yaml.load(open(config_file))
self.start_time = time.time()
self.useragent = useragent
self.r = None
if self.config['account']['oauth']:
while True:
try:
self.auth_oauth()
break
except praw.exceptions.APIException:
self.backoff *= 2
self.log("Error logging in! Trying again in {} seconds...".
format(self.backoff),
stderr=True)
time.sleep(self.backoff)
else:
self.log("Error! Password login no longer supported!", stderr=True)
sys.exit()
self.comment_stream = UnseenComments(self.r, subreddit,
self.config['bot']['seen_len'])
self.subreddit = subreddit
self.load_settings()
self.inbox = CommentStore(self.config['bot']['dbfile'])
self.ignores = IgnoreList(self.config['bot']['dbfile'])
def __init__(self, subreddit, config_file='config.yaml', useragent = 'default'):
#Load config and set up
self.log("Logging in...")
self.config = yaml.load(open(config_file))
self.start_time = time.time()
self.useragent = useragent
self.r = praw.Reddit(self.config['bot']['useragent'][self.useragent])
if self.config['account']['oauth']:
self.r.set_oauth_app_info(**self.config['account']['oauth'])
if self.get_refresh_token():
self.refresh_oauth()
else:
rt = self.authorize_oauth()
if rt:
rtfile = open('refresh_token','w')
rtfile.write(rt)
else:
raise praw.errors.OAuthException("Couldn't fetch refresh token!")
else:
self.log("Warning! Using deprecated password login!", stderr=True)
self.r.login(self.config['account']['username'],self.config['account']['password'])
self.comment_stream = UnseenComments(self.r, subreddit, self.config['bot']['seen_len'])
self.subreddit = subreddit
self.load_settings()
self.inbox = CommentStore(self.config['bot']['dbfile'])
self.ignores = IgnoreList(self.config['bot']['dbfile'])
class JoelBot:
max_retries = 50
backoff = 2
def __init__(self,
subreddit,
config_file='config.yaml',
useragent='default'):
#Load config and set up
self.log("Logging in...")
self.config = yaml.load(open(config_file))
self.start_time = time.time()
self.useragent = useragent
self.r = None
if self.config['account']['oauth']:
while True:
try:
self.auth_oauth()
break
except praw.exceptions.APIException:
self.backoff *= 2
self.log("Error logging in! Trying again in {} seconds...".
format(self.backoff),
stderr=True)
time.sleep(self.backoff)
else:
self.log("Error! Password login no longer supported!", stderr=True)
sys.exit()
self.comment_stream = UnseenComments(self.r, subreddit,
self.config['bot']['seen_len'])
self.subreddit = subreddit
self.load_settings()
self.inbox = CommentStore(self.config['bot']['dbfile'])
self.ignores = IgnoreList(self.config['bot']['dbfile'])
def auth_oauth(self):
if self.get_refresh_token():
self.r = praw.Reddit(
user_agent=self.config['bot']['useragent'][self.useragent],
refresh_token=self.refresh_token,
**self.config['account']['oauth'])
else:
self.r = praw.Reddit(
user_agent=self.config['bot']['useragent'][self.useragent],
**self.config['account']['oauth'])
rt = self.authorize_oauth()
if rt:
rtfile = open('refresh_token', 'w')
rtfile.write(rt)
else:
raise prawcore.exceptions.OAuthException(
"Couldn't fetch refresh token!")
def id_string(self):
return "{:s} ({:s}) {:f}".format(self.config['account']['username'],
self.useragent or 'default',
self.start_time)
def authorize_oauth(self):
self.oauth_state = str(random.randint(0, 65000))
auth_url = self.r.auth.url(self.config['bot']['oauth_scopes'],
self.oauth_state, "permanent")
self.log(
'Go to the following URL, copy the URL that you are redirected to, then come back and paste it here:'
)
self.log(auth_url)
redirect_url = raw_input("Redirected URL: ")
urlparts = urlparse.urlsplit(redirect_url)
querydata = urlparse.parse_qs(urlparts.query)
self.refresh_token = self.r.auth.authorize(querydata['code'])
return self.refresh_token
def get_refresh_token(self):
# Check if we have a refresh token available
try:
rtfile = open('refresh_token', 'r')
rt = rtfile.readline().rstrip()
self.refresh_token = rt
rtfile.close()
except IOError:
return None
return self.refresh_token
def log(self, format, params=None, stderr=False, newline=True):
prefix = time.strftime('%Y-%m-%d %H:%M:%S')
logline = prefix + " " + (format if params is None else
(format % params))
if (newline and stderr):
logline += "\n"
if (stderr):
sys.stderr.write(logline)
else:
print(logline)
def load_settings(self):
self.log("Reloading config...")
sys.stdout.flush()
self.config = yaml.load(open('config.yaml'))
#Load banlist
self.log("Loading banlists...")
sys.stdout.flush()
bottiquette = self.r.subreddit('Bottiquette').wiki['robots_txt_json']
banlist = json.loads(bottiquette.content_md)
btqban = (banlist['disallowed'] +\
banlist['posts-only'] +\
banlist['permission'])
try:
mybans = self.get_wiki('conf/blacklist')
mybans = [line for line in mybans.content_md.split('\n')\
if not (line.strip() == '' or line.startswith('#'))]
except prawcore.exceptions.ResponseException:
self.log("Couldn't load bot-specific blacklist")
mybans = []
self.bans = [x.strip().lower() for x in (btqban + mybans)]
self.log("Ignoring subreddits: %s", (', '.join(self.bans)))
def should_ignore(self, comment):
#Don't post in bot-banned subreddits
subreddit = comment.subreddit.display_name.lower()
if subreddit in self.bans:
self.log("Skipping banned subreddit %s", (subreddit))
return True
#Don't reply to self, just in case...
if comment.author.name == self.config['account']['username']:
return True
#Check user ignore list
if self.ignores.check_ignored(comment.author.name):
self.log("Ignoring user %s", (comment.author.name))
return True
return False
def save_seen(self):
self.comment_stream.save_state()
def cleanup(self):
sc = ScoreCheck(self)
sc.run()
sc.print_report()
sc.save_report()
def get_template(self):
if ('status_template' in self.config['bot']):
template = self.config['bot']['status_template']
if (template.find('\n') == -1):
template = open(template, 'r').read()
return template
else:
return '<html><head><title>JoelBot</title></head><body>No template found</body></html>'
def refresh_comments(self):
self.comment_stream.refresh_comments()
def check_messages(self):
last_tid = None
last_message = self.inbox.get_last_message()
if last_message is not None:
_, last_tid = last_message['tid'].split('_', 1)
# TODO: Make continuous/stream-based?
for m in self.r.inbox.messages(params={'after': last_tid}):
if (last_message is not None and m.created < last_message['sent']):
self.log("Found old message, stopping!")
return False
if (self.inbox.add_message(m)):
if (m.body in self.config['bot']['ignore_messages']):
self.log("Ignoring {:s}...".format(m.author.name))
self.ignores.ignore_sender(m)
if ('ignore_reply' in self.config['bot']):
self.reply_to(m, 'Ignore Request',
self.config['bot']['ignore_reply'])
elif (m.body in self.config['bot']['unignore_messages']):
self.log("Unignoring {:s}...".format(m.author.name))
self.ignores.unignore_sender(m)
if ('unignore_reply' in self.config['bot']):
self.reply_to(m, 'Unignore Request',
self.config['bot']['unignore_reply'])
else:
self.log("Found duplicate message, stopping!")
return False
def reply_to(self, m, subject, reply):
if (m.subreddit):
# It's a comment, send a message
self.r.send_message(m.author,
subject,
reply,
raise_captcha_exception=True)
else:
# It's a pm, just reply
m.reply(reply)
def get_wiki(self, page):
return self.r.subreddit(self.config['bot']['subreddit']).wiki[page]
def write_wiki(self, page, content, reason=None):
return self.r.subreddit(
self.config['bot']['subreddit']).wiki[page].edit(content, reason)
# Transform a wiki'd YAML into normal yaml and parse it
def get_wiki_yaml(self, page):
wikipage = self.get_wiki(page)
cleaned_yaml = re.sub(r'^(\s*)\* ',
'\\1',
wikipage.content_md,
flags=re.MULTILINE)
return yaml.load(cleaned_yaml)
class JoelBot:
def __init__(self, subreddit, config_file='config.yaml', useragent = 'default'):
#Load config and set up
self.log("Logging in...")
self.config = yaml.load(open(config_file))
self.start_time = time.time()
self.useragent = useragent
self.r = praw.Reddit(self.config['bot']['useragent'][self.useragent])
if self.config['account']['oauth']:
self.r.set_oauth_app_info(**self.config['account']['oauth'])
if self.get_refresh_token():
self.refresh_oauth()
else:
rt = self.authorize_oauth()
if rt:
rtfile = open('refresh_token','w')
rtfile.write(rt)
else:
raise praw.errors.OAuthException("Couldn't fetch refresh token!")
else:
self.log("Warning! Using deprecated password login!", stderr=True)
self.r.login(self.config['account']['username'],self.config['account']['password'])
self.comment_stream = UnseenComments(self.r, subreddit, self.config['bot']['seen_len'])
self.subreddit = subreddit
self.load_settings()
self.inbox = CommentStore(self.config['bot']['dbfile'])
self.ignores = IgnoreList(self.config['bot']['dbfile'])
def id_string(self):
return "{:s} ({:s}) {:f}".format(
self.config['account']['username'],
self.useragent or 'default',
self.start_time
)
def authorize_oauth(self):
auth_url = self.r.get_authorize_url(
self.id_string(),
' '.join(self.config['bot']['oauth_scopes']),
True
)
self.log('Go to the following URL, copy the URL that you are redirected to, then come back and paste it here:')
self.log(auth_url)
redirect_url = raw_input("Redirected URL: ")
urlparts = urlparse.urlsplit(redirect_url)
querydata = urlparse.parse_qs(urlparts.query)
self.oauth_access = self.r.get_access_information(querydata['code'])
self.refresh_token = self.oauth_access['refresh_token']
return self.refresh_token
def refresh_oauth(self):
return self.r.refresh_access_information(self.refresh_token)
def get_refresh_token(self):
# Check if we have a refresh token available
try:
rtfile = open('refresh_token','r')
rt = rtfile.readline().rstrip()
self.refresh_token = rt
rtfile.close()
except IOError:
return None
return self.refresh_token
def log(self, format, params=None, stderr=False,newline=True):
prefix = time.strftime('%Y-%m-%d %H:%M:%S')
logline = prefix + " " + (format if params is None else (format % params))
if(newline and stderr):
logline += "\n"
if(stderr):
sys.stderr.write(logline)
else:
print(logline)
def load_settings(self):
self.log("Reloading config...")
sys.stdout.flush()
self.config = yaml.load(open('config.yaml'))
#Load banlist
self.log("Loading banlists...")
sys.stdout.flush()
bottiquette = self.r.get_wiki_page('Bottiquette', 'robots_txt_json')
banlist = json.loads(bottiquette.content_md)
btqban = (banlist['disallowed'] +\
banlist['posts-only'] +\
banlist['permission'])
try:
mybans = self.get_wiki('conf/blacklist')
mybans = [line for line in mybans.content_md.split('\n')\
if not (line.strip() == '' or line.startswith('#'))]
except praw.errors.HTTPException:
self.log("Couldn't load bot-specific blacklist")
mybans = []
self.bans = [x.strip().lower() for x in (btqban + mybans)]
self.log("Ignoring subreddits: %s",(', '.join(self.bans)))
def should_ignore(self, comment):
#Don't post in bot-banned subreddits
subreddit = comment.subreddit.display_name.lower()
if subreddit in self.bans:
self.log("Skipping banned subreddit %s",(subreddit))
return True
#Don't reply to self, just in case...
if comment.author.name == self.config['account']['username']:
return True
#Check user ignore list
if self.ignores.check_ignored(comment.author.name):
self.log("Ignoring user %s",(comment.author.name))
return True
return False
def save_seen(self):
self.comment_stream.save_state()
def cleanup(self):
sc = ScoreCheck(self)
sc.run()
sc.print_report()
sc.save_report()
def get_template(self):
if('status_template' in self.config['bot']):
template = self.config['bot']['status_template']
if(template.find('\n') == -1):
template = open(template, 'r').read()
return template
else:
return '<html><head><title>JoelBot</title></head><body>No template found</body></html>'
def refresh_comments(self):
self.comment_stream.refresh_comments()
def check_messages(self):
last_tid = None
last_message = self.inbox.get_last_message()
if last_message is not None:
_, last_tid = last_message['tid'].split('_', 1)
for m in self.r.get_inbox(place_holder=last_tid):
if(last_message is not None and m.created < last_message['sent']):
self.log("Found old message, stopping!")
return False
if(self.inbox.add_message(m)):
if(m.body in self.config['bot']['ignore_messages']):
self.log("Ignoring {:s}...".format(m.author.name))
self.ignores.ignore_sender(m)
if('ignore_reply' in self.config['bot']):
self.reply_to(m, 'Ignore Request', self.config['bot']['ignore_reply'])
elif(m.body in self.config['bot']['unignore_messages']):
self.log("Unignoring {:s}...".format(m.author.name))
self.ignores.unignore_sender(m)
if('unignore_reply' in self.config['bot']):
self.reply_to(m, 'Unignore Request', self.config['bot']['unignore_reply'])
else:
self.log("Found duplicate message, stopping!")
return False
def reply_to(self, m, subject, reply):
if(m.subreddit):
# It's a comment, send a message
self.r.send_message(m.author, subject, reply, raise_captcha_exception=True)
else:
# It's a pm, just reply
m.reply(reply)
def get_wiki(self, page):
return self.r.get_wiki_page(self.config['bot']['subreddit'], page)
def write_wiki(self, page, content, reason=None):
return self.r.edit_wiki_page(self.config['bot']['subreddit'], page, content, reason)
# Transform a wiki'd YAML into normal yaml and parse it
def get_wiki_yaml(self, page):
wikipage = self.get_wiki(page)
cleaned_yaml = re.sub(r'^(\s*)\* ','\\1', wikipage.content_md, flags=re.MULTILINE)
return yaml.load(cleaned_yaml)