me.timothy.bots

Class BotDriver

java.lang.Object

me.timothy.bots.BotDriver

All Implemented Interfaces:

java.lang.Runnable

public class BotDriver
extends java.lang.Object
implements java.lang.Runnable

The driver for the bot, based on summons. Uses bot-specific logic for looping through the comments, submissions, and personal messages looking for summons, and then applying them via the Summon's implementation.

Author:

Timothy

See Also:

Summon

Field Summary

Fields

Modifier and Type	Field and Description
protected Bot	bot The bot.
protected static int	BRIEF_PAUSE_MS Time in seconds between touching the reddit api
protected CommentSummon[]	commentSummons The comment summons.
protected FileConfiguration	config The config.
protected Database	database The database.
protected org.apache.logging.log4j.Logger	logger The logger.
protected java.lang.Runnable	maybeLoginAgainRunnable A runnable that simply calls maybeLoginAgain
protected PMSummon[]	pmSummons The pm summons.
protected LinkSummon[]	submissionSummons The submission summons.

Constructor Summary

Constructors

Constructor and Description
BotDriver(Database database, FileConfiguration config, Bot bot, CommentSummon[] commentSummons, PMSummon[] pmSummons, LinkSummon[] submissionSummons) Creates a bot driver based on the specified database, configuration info, rest client, and bot.

Method Summary

Modifier and Type	Method and Description
protected void	doLoop() Performs one loop for the bot
protected void	fail(java.lang.String message, java.lang.Throwable... errors) Terminates the program after logging message at Level.ERROR, as well as logging the list of errors
protected me.timothy.jreddit.info.Listing	getRecentComments() Gets a list of recent comments, utilizing exponential-backoff.
protected me.timothy.jreddit.info.Listing	getRecentMessages() Gets a list of recent messages, utilizing exponential back-off.
protected me.timothy.jreddit.info.Listing	getRecentSubmissions() Gets a list of recent submissions, utilizing exponential back-off.
protected boolean	handleComment(me.timothy.jreddit.info.Comment comment, boolean debug, boolean silentMode) Handles a single comment
protected void	handleFlair(java.lang.String linkId, java.lang.String flair) Flairs a link
protected void	handlePM(me.timothy.jreddit.info.Thing m, boolean silentMode) Handles a single message in our inbox
protected void	handlePMResponses(SummonResponse response) Handles the PMResponses that are contained in the summon response, if any, by sending pms to the specified users with the specified title and content.
protected void	handleReply(me.timothy.jreddit.info.Thing replyable, java.lang.String response) Replies to the thing, utilizing exponential back-off.
protected void	handleReport(java.lang.String thingFullname, java.lang.String reportMessage)
protected void	handleSubmission(me.timothy.jreddit.info.Link submission, boolean silentMode) Handles a single submission
protected void	login() Logs into reddit based on the configuration.
protected void	markRead(me.timothy.jreddit.info.Listing messages) Marks the specified messages as read.
protected void	maybeLoginAgain() Checks if we need to refresh our access token, and if so, purges it and logs in.
void	run() Runs the bot.
protected void	scanComments() Loops through recent comments, ignoring comments by banned users or remembered fullnames, and handles them via the appropriate summons.
protected void	scanPersonalMessages() Loops through unread personal messages and replies to the bot.
protected void	scanSubmissions() Loops through recent submissions, ignoring remembered fullnames, and checks for "req" (case insensitive) in the title.
protected void	sendMessage(java.lang.String to, java.lang.String title, java.lang.String message) Sends a message to the specified user with the specified title & message, using exponential back-off.
protected void	sleepFor(long ms) Sleeps for the specified time in milliseconds, as if by Thread.sleep(ms).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BRIEF_PAUSE_MS

protected static int BRIEF_PAUSE_MS

Time in seconds between touching the reddit api

commentSummons

protected final CommentSummon[] commentSummons

The comment summons.

pmSummons

protected final PMSummon[] pmSummons

The pm summons.

submissionSummons

protected final LinkSummon[] submissionSummons

The submission summons.

config

protected FileConfiguration config

The config.

database

protected Database database

The database.

bot

protected Bot bot

The bot.

logger

protected org.apache.logging.log4j.Logger logger

The logger.

maybeLoginAgainRunnable

protected java.lang.Runnable maybeLoginAgainRunnable

A runnable that simply calls maybeLoginAgain

See Also:

maybeLoginAgain()

Constructor Detail

BotDriver

public BotDriver(Database database,
                 FileConfiguration config,
                 Bot bot,
                 CommentSummon[] commentSummons,
                 PMSummon[] pmSummons,
                 LinkSummon[] submissionSummons)

Creates a bot driver based on the specified database, configuration info, rest client, and bot.

Parameters:

database - the database

config - the configuration

restClient - rest client

bot - the bot

commentSummons - the comment summons

pmSummons - the pm summons

submissionSummons - the submission summons

Method Detail

run

public void run()

Runs the bot.

Specified by:

run in interface java.lang.Runnable

doLoop

protected void doLoop()
               throws java.io.IOException,
                      org.json.simple.parser.ParseException,
                      java.text.ParseException

Performs one loop for the bot

Throws:

java.io.IOException - if an i/o related exception occurs

org.json.simple.parser.ParseException - if a parse exception occurs

java.text.ParseException - if a parse exception occurs

maybeLoginAgain

protected void maybeLoginAgain()

Checks if we need to refresh our access token, and if so, purges it and logs in.

scanComments

protected void scanComments()

Loops through recent comments, ignoring comments by banned users or remembered fullnames, and handles them via the appropriate summons.

handleComment

protected boolean handleComment(me.timothy.jreddit.info.Comment comment,
                                boolean debug,
                                boolean silentMode)

Handles a single comment

Parameters:

comment - the comment to handle

debug - if debug messages should be printed

silentMode - if this should not reply

Returns:

if the comment was meaningfull

scanSubmissions

protected void scanSubmissions()
                        throws java.io.IOException,
                               org.json.simple.parser.ParseException,
                               java.text.ParseException

Loops through recent submissions, ignoring remembered fullnames, and checks for "req" (case insensitive) in the title. If req exists, performs an automatic check on the author of the submission as a top-level comment in the submission thread.

Throws:

java.io.IOException - if an i/o related exception occurs

java.text.ParseException - if the parse via Summon.CHECK_SUMMON is invalid (should not happen since the check is automatic)

java.text.ParseException - if the parse via Summon.CHECK_SUMMON is invalid (should not happen since the check is automatic)

org.json.simple.parser.ParseException

handleSubmission

protected void handleSubmission(me.timothy.jreddit.info.Link submission,
                                boolean silentMode)

Handles a single submission

Parameters:

submission - the submission the handle

silentMode - if the bot should not respond

scanPersonalMessages

protected void scanPersonalMessages()

Loops through unread personal messages and replies to the bot. Prints them out, and in the case of personal messages checks if any summons are applicable and if they are, applies them.

handlePM

protected void handlePM(me.timothy.jreddit.info.Thing m,
                        boolean silentMode)

Handles a single message in our inbox

Parameters:

m - the pm to handle

silentMode - if this should not respond

markRead

protected void markRead(me.timothy.jreddit.info.Listing messages)

Marks the specified messages as read. Utilizes exponential-backoff

Parameters:

messages - the messages

See Also:

Retryable

login

protected void login()

Logs into reddit based on the configuration. Terminates the program as if by fail() on failure.

getRecentComments

protected me.timothy.jreddit.info.Listing getRecentComments()

Gets a list of recent comments, utilizing exponential-backoff.

Returns:

recent comments

See Also:

Retryable

handleReply

protected void handleReply(me.timothy.jreddit.info.Thing replyable,
                           java.lang.String response)

Replies to the thing, utilizing exponential back-off.

Parameters:

replyable - the thing to reply to

response - the thing to reply with

See Also:

Retryable

getRecentSubmissions

protected me.timothy.jreddit.info.Listing getRecentSubmissions()

Gets a list of recent submissions, utilizing exponential back-off.

Returns:

a list of recent submissions

See Also:

Retryable

getRecentMessages

protected me.timothy.jreddit.info.Listing getRecentMessages()

Gets a list of recent messages, utilizing exponential back-off.

Returns:

a list of recent messages

See Also:

Retryable

handleFlair

protected void handleFlair(java.lang.String linkId,
                           java.lang.String flair)

Flairs a link

Parameters:

linkId - the link to flair

flair - the css class of the flair

handleReport

protected void handleReport(java.lang.String thingFullname,
                            java.lang.String reportMessage)

sleepFor

protected void sleepFor(long ms)

Sleeps for the specified time in milliseconds, as if by Thread.sleep(ms). Logs the exception and terminates the program on error.

Parameters:

ms - the time in milliseconds to sleep

fail

protected void fail(java.lang.String message,
                    java.lang.Throwable... errors)

Terminates the program after logging message at Level.ERROR, as well as logging the list of errors

Parameters:

message - the message to put in Level.ERROR

errors - a list of applicable errors to output

sendMessage

protected void sendMessage(java.lang.String to,
                           java.lang.String title,
                           java.lang.String message)

Sends a message to the specified user with the specified title & message, using exponential back-off.

Parameters:

user - the user to send the message to

title - the title of the message

message - the text of the message

handlePMResponses

protected void handlePMResponses(SummonResponse response)

Handles the PMResponses that are contained in the summon response, if any, by sending pms to the specified users with the specified title and content.

Parameters:

response - the response which might have pmresponses.