bot-context.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans
	  xmlns="http://www.springframework.org/schema/beans"
	  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	  xmlns:context="http://www.springframework.org/schema/context"
	  xmlns:util="http://www.springframework.org/schema/util"
	  xmlns:p="http://www.springframework.org/schema/p"
	  xsi:schemaLocation="
	    http://www.springframework.org/schema/beans
	    https://www.springframework.org/schema/beans/spring-beans.xsd
	    http://www.springframework.org/schema/context
	    https://www.springframework.org/schema/context/spring-context.xsd
	    http://www.springframework.org/schema/util
	    https://www.springframework.org/schema/util/spring-util.xsd">	

	<!-- Spring reference documentation: https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html -->

	<util:properties id="settings">
	    <!--
	    The path to the logging configuration file.
		(defaults to: logging.properties)
	    -->
	    <prop key="logging.config">logging.properties</prop>

		<!--
		The website to connect to (each site has its own chat system).
		Accepted values are: stackoverflow.com, stackexchange.com, meta.stackexchange.com
		(defaults to: stackoverflow.com) 
		-->
		<prop key="account.site">stackoverflow.com</prop>

		<!--
		The Stack Overflow login credentials for the bot.
		-->
		<prop key="account.email">email@example.com</prop>
		<prop key="account.password">password</prop>

		<!--
		Manually set the username of the bot's account, incase it can't be parsed automatically.
		<prop key="account.username">OakBot</prop>
		-->

		<!--
		Manually set the user ID of the bot's account, incase it can't be parsed automatically.
		The user ID can be found in the URL of the account's profile page.
		<prop key="account.userId">4258326</prop>
		-->

		<!--
		The string sequence that prefixes all commands (typically a single character).
		This cannot contain any spaces and should not contain any of the special characters used in Markdown syntax, including: * _ ` - > ( ) [ ]
		-->
		<prop key="trigger">=</prop>

		<!--
		(optional)
		A string sequence that users can append onto their messages if they want the bot to ignore a message.
		-->
		<prop key="ignoreMessageSuffix">~</prop>

		<!--
		(optional)
		The message to post when the bot joins a room. Chat markdown can be used here.
		-->
		<prop key="greeting">OakBot Online.</prop>

		<!--
		(optional)
		Displays this URL when the "help" command output is condensed.
		-->
		<prop key="help.webpage">https://github.com/JavaChat/OakBot/wiki/Commands</prop>

		<!--
   		(optional)
		Any oneboxes (including images) that the bot posts will be automatically replaced by the onebox's URL after the specified amount of time
		This is mainly here to help prevent the bot from spamming the chat with large images.
		If this property is not defined, then oneboxes will not be replaced.
		Note that this value cannot exceed two minutes, which is the maximum amount of time Stack Overflow Chat gives you to edit/delete your posts.
		-->
		<prop key="hideOneboxesAfter">PT1M50S</prop>

		<!--
		The list of rooms the bot cannot be unsummoned from.
		At least one room must be specified.
		The bot will join these rooms on startup.
		This is a comma-separated list of room IDs.
		A chat room's ID can be found in its URL.
		-->
		<prop key="rooms.home">1,139</prop>

		<!--
		(optional)
		The bot will avoid posting things like awkward silence messages (a message that the bot posts when the room is inactive) to these rooms.
		This is for rooms that like quiet and do not want to receive a lot of "spam".
		This is a comma-separated list of room IDs.
		A chat room's ID can be found in its URL.
		-->
		<prop key="rooms.quiet">1</prop>

		<!--
		(optional)
		The users that are allowed to run admin-level commands against the bot (notably, the "shutdown" command).
		This is a comma-separated list of user IDs.
		A user ID can be found in the URL of the user's profile page.
		-->
		<prop key="users.admins">13379</prop>

		<!--
		(optional)
		The users that have been banned from using the bot (red list).
		The bot will ignore all messages from these users.
		This is a comma-separated list of user IDs.
		A user ID can be found in the URL of the user's profile page.
		-->
		<prop key="users.banned"></prop>

		<!--
		(optional)
		The users that have been given permission to use the bot (green list).
		If this property is not empty, the bot will ignore all messages except those that are from the specified users.
		This is a comma-separated list of user IDs.
		A user ID can be found in the URL of the user's profile page.
		-->
		<prop key="users.allowed"></prop>

		<!--
		(optional)
		The minimum reputation score a user must have to interact with the bot.
		The bot will ignore all messages from users that don't meet this requirement.
		-->
		<prop key="minRepForBotInteraction">50</prop>

		<!--
		Enables or disables learned commands.
		-->
		<prop key="enableLearnedCommands">true</prop>

		<!--
		(optional)
		How often each room's web socket connection is refreshed (a workaround to resolve random disconnects).
		-->
		<prop key="webSocket.refreshInterval">PT4H</prop>

		<!--
		(optional)
		Port number to use for the local command socket.
		The local command socket is used to send commands to the bot process from the command-line.
		Sending the string "shutdown" will cause the bot to gracefully shutdown.
		If this property is not defined or set to 0, a port number will be automatically chosen and displayed on stdout at startup.
		-->
		<prop key="socket.port">6243</prop>
	</util:properties>
	<context:property-placeholder properties-ref="settings"/>

	<!-- database =============================================== -->
	<bean id="database" class="oakbot.JsonDatabase">
		<constructor-arg value="db.json" />
	</bean>
	<!--
	Use this bean if you don't want to persist anything to a file:
	<bean id="database" class="oakbot.MemoryDatabase" />
	-->

	<!-- statistics ============================================= -->
	<bean id="statistics" class="oakbot.Statistics">
		<constructor-arg ref="database" />
	</bean>

	<!-- "catch all" mention listener =========================== -->
	<alias name="chatGPT" alias="catchAllMentionListener" />
	<!--
	Use this if you are not using the ChatGPT listener:
	<bean id="mentionListener" class="oakbot.listener.MentionListener" />
	<alias name="mentionListener" alias="catchAllMentionListener" />
	-->

	<!-- API clients referenced by multiple commands ============ -->
	<bean class="oakbot.command.stands4.Stands4Client" id="stands4Client">
		<!--
		API user ID
		-->
		<constructor-arg value="API_USER_ID" />

		<!--
		API token
		-->
		<constructor-arg value="API_TOKEN" />
	</bean>

	<bean class="oakbot.command.TheCatDogApiClient" id="theCatDogApiClient">
		<!--
		(optional)
		API key for thecatapi.com
		-->
		<constructor-arg value="API_KEY" />
	</bean>

	<!-- /abbr ================================================== -->
	<bean class="oakbot.command.stands4.AbbreviationCommand">
		<constructor-arg ref="stands4Client" />
	</bean>

	<!-- /about ================================================= -->
	<bean class="oakbot.command.AboutCommand">
		<constructor-arg ref="statistics" />

		<!--
		(optional)
		Who the bot is hosted by. Chat markdown allowed.
		-->
		<constructor-arg value="**Michael**" />
	</bean>

	<!-- /afk =================================================== -->
	<bean class="oakbot.command.AfkCommand" />

	<!-- /aoc =================================================== -->
	<bean id="aocApi" class="oakbot.command.aoc.AdventOfCodeApi">
		<!--
		Session token is required in order to query the AoC leaderboards.
		This value can be retrieved from your own Advent of Code login;	just open the site and look at your browser cookies.
		Whatever user account is associated with this session ID must have access to a leaderboard in order for the bot to view it.
		-->
		<constructor-arg value="session token goes here" />
	</bean>

	<bean class="oakbot.command.aoc.AdventOfCodeLeaderboard" id="aocLeaderboard">
		<!--
		Leaderboard ID.
		-->
		<constructor-arg value="123456" />

		<!--
		(optional)
		Leaderboard join code.
		Leave out this argument if you want to keep it private.
		-->
		<constructor-arg value="abc-123" /> 
	</bean>

	<bean class="oakbot.command.aoc.AdventOfCode">
		<constructor-arg ref="aocApi" />

		<!--
		Polling interval.
		AoC asks that this not be less than 15 minutes.
		-->
		<constructor-arg value="PT15M" /> 
		
		<!--
		How many days of puzzles there are this year.
		In ths past, this has always been 25, but he reduced it to 12 starting in 2025.
		-->
		<constructor-arg value="12" /> 

		<!--
		(optional)
		The leaderboard to show for each room if the user does not specify a leaderboard ID. 
		-->
		<constructor-arg>
			<util:map> 
				<entry key="1" value-ref="aocLeaderboard" />
			</util:map>
		</constructor-arg>
	</bean>

	<!-- /botler ================================================ -->
	<bean class="oakbot.listener.BotlerListener">
		<!--
		Botler's trigger
		-->
		<constructor-arg value="Botler," /> 

		<!--
		Botler's user ID
		-->
		<constructor-arg value="13750349" />

		<!--
		The Botler message that the bot will respond to.
		-->
		<constructor-arg value="Hello friends!" />

		<!--
		The response.
		-->
		<constructor-arg value="Hi, Botler." />

		<!--
		Cooldown between responses.
		-->
		<constructor-arg value="P1D" />
	</bean>

	<!-- /cat =================================================== -->
	<bean class="oakbot.command.CatCommand">
		<constructor-arg ref="theCatDogApiClient" />
	</bean>

	<!-- /coffee ================================================ -->
	<bean class="oakbot.command.CoffeeCommand" />

	<!-- /convert =============================================== -->
	<bean class="oakbot.command.stands4.ConvertCommand">
		<constructor-arg ref="stands4Client" />
	</bean>

	<!-- /define ================================================ -->
	<bean class="oakbot.command.define.DefineCommand">
		<!--
		API key for dictionaryapi.com
		-->
		<constructor-arg value="API_KEY" />
	</bean>

	<!-- /delete ================================================ -->
	<bean class="oakbot.command.DeleteCommand">
		<constructor-arg ref="catchAllMentionListener" />
	</bean>

	<!-- /dog =================================================== -->
	<bean class="oakbot.command.DogCommand">
		<constructor-arg ref="theCatDogApiClient" />
	</bean>

	<!-- /echo ================================================== -->
	<bean class="oakbot.command.EchoCommand" />

	<!-- /ed ==================================================== -->
	<bean class="oakbot.command.effective.EffectiveDebuggingCommand" />

	<!-- /ej ==================================================== -->
	<bean class="oakbot.command.effective.EffectiveJavaCommand" />

	<!-- /8ball ================================================= -->
	<bean class="oakbot.command.EightBallCommand" />

	<!-- /explain =============================================== -->
	<bean class="oakbot.command.stands4.ExplainCommand">
		<constructor-arg ref="stands4Client" />
	</bean>

	<!-- /facepalm ============================================== -->
	<bean class="oakbot.command.FacepalmCommand">
		<!--
		API key for tenor.com
		-->
		<constructor-arg value="API_KEY" />
	</bean>

	<!-- /fatcat ================================================ -->
	<bean class="oakbot.command.FatCatCommand">
		<constructor-arg ref="database" />

		<!--
		A list of users who have permission to add/remove pictures from this command.
		Bot admins already have permission to do this.
		-->
		<constructor-arg>
			<util:list>
				<value>12345</value>
			</util:list>
		</constructor-arg>
	</bean>

	<!-- /fish ================================================== -->
	<bean class="oakbot.command.FishCommand">
		<constructor-arg ref="database" />

		<!--
		Min time until quiver.
		-->
		<constructor-arg value="PT15M" />

		<!--
		Max time until quiver.
		-->
		<constructor-arg value="PT2H" />

		<!--
		Amount of time user has to pull up fish after quiver.
		-->
		<constructor-arg value="PT30M" />
	</bean>

	<!-- /grammar =============================================== -->
	<bean class="oakbot.command.stands4.GrammarCommand">
		<constructor-arg ref="stands4Client" />
	</bean>

	<!-- /groot ================================================= -->
	<bean class="oakbot.filter.GrootFilter" />

	<!-- /http ================================================== -->
	<bean class="oakbot.command.http.HttpCommand" />

	<!-- /javadoc =============================================== -->
	<bean class="oakbot.command.javadoc.JavadocCommand">
		<constructor-arg ref="javadocDao" />
	</bean>
	<bean id="javadocDao" class="oakbot.command.javadoc.JavadocDaoUncached">
		<constructor-arg>
			<bean class="java.nio.file.Paths" factory-method="get">
				<!--
				Path to javadoc ZIP file directory
				-->
				<constructor-arg value="javadoc/zip-files" />
				<constructor-arg><array /></constructor-arg>
			</bean>
		</constructor-arg>
	</bean>

	<!-- /juicebox ============================================== -->
	<bean class="oakbot.command.JuiceBoxCommand" />

	<!-- /phish ================================================= -->
	<bean class="oakbot.command.PhishCommand">
		<constructor-arg ref="database" />

		<!--
		Min time until ping.
		-->
		<constructor-arg value="PT15M" />

		<!--
		Max time until ping.
		-->
		<constructor-arg value="PT2H" />
	</bean>

	<!-- /react ================================================= -->
	<bean class="oakbot.command.ReactGiphyCommand">
		<!--
		API key for giphy.com.
		-->
		<constructor-arg value="APT_KEY" />
	</bean>

	<!-- /remind ================================================ -->
	<bean class="oakbot.command.RemindCommand" />

	<!-- /rhyme ================================================= -->
	<bean class="oakbot.command.stands4.RhymeCommand">
		<constructor-arg ref="stands4Client" />
	</bean>

	<!-- /roll ================================================== -->
	<bean class="oakbot.command.RollCommand" />

	<!-- /rollover ============================================== -->
	<bean class="oakbot.filter.UpsidedownTextFilter" />

	<!-- /shrug ================================================= -->
	<bean class="oakbot.command.ShrugCommand" />

	<!-- /shutdown ============================================== -->
	<bean class="oakbot.command.ShutdownCommand" />

	<!-- /summon and /unsummon (/join and /leave) =============== -->
	<bean class="oakbot.command.SummonCommand" />
	<bean class="oakbot.command.UnsummonCommand" />
	
	<!-- /support =============================================== -->
	<bean class="oakbot.command.SupportCommand">
		<!--
		The costs associated with running the bot.
		"$AI_RATE_LIMITS" variable is replaced with chat and image rate limit information.
		-->
		<constructor-arg>
			<list>
				<value>Cloud hosting: $9.99/mo</value>
				<value>OpenAI tokens: $3/mo $AI_RATE_LIMITS</value>
			</list>
		</constructor-arg>

		<!--
		(can be null)
		Donation link.
		-->
		<constructor-arg value="https://paypal.com" />
		
		<!--
		(can be null)
		ChatGPT instance for displaying rate limits.
		-->
		<constructor-arg ref="chatGPT" />
		
		<!--
		(can be null)
		Imagine instance of displaying rate limits.
		-->
		<constructor-arg ref="imagineCore" />
	</bean>

	<!-- /tag =================================================== -->
	<bean class="oakbot.command.TagCommand" />

	<!-- /timeout =============================================== -->
	<bean class="oakbot.command.TimeoutCommand" />

	<!-- /urban ================================================= -->
	<bean class="oakbot.command.urban.UrbanCommand" />

	<!-- /wadu ================================================== -->
	<bean class="oakbot.filter.WaduFilter" />

	<!-- /weather =============================================== -->
	<bean class="oakbot.command.weather.WeatherCommand" />

	<!-- /wiki ================================================== -->
	<bean class="oakbot.command.WikiCommand" />

	<!-- dadjoke listener ======================================= -->
	<bean class="oakbot.listener.DadJokeListener">
		<!--
		Bot's name.
		-->
		<constructor-arg value="Oak" />

		<constructor-arg ref="catchAllMentionListener" />
	</bean>

	<!-- morn listener ========================================== -->
	<bean class="oakbot.listener.MornListener">
		<!--
		Amount of time to wait before responding.
		-->
		<constructor-arg value="PT1S" />

		<constructor-arg ref="catchAllMentionListener" />
	</bean>

	<!-- unitconversion listener ================================ -->
	<bean class="oakbot.listener.UnitConversionListener" />

	<!-- wave listener ========================================== -->
	<bean class="oakbot.listener.WaveListener">
		<!--
		Amount of time to wait before waving back.
		-->
		<constructor-arg value="PT1S" />

		<constructor-arg ref="catchAllMentionListener" />
	</bean>

	<!-- welcome listener ======================================= -->
	<bean class="oakbot.listener.WelcomeListener">
		<constructor-arg ref="database" />

		<!--
		Users with a reputation less than this will be welcomed.
		-->
		<constructor-arg value="1000" />

		<!--
		The welcome message to post for new users that join the room (markdown allowed)
		-->
		<constructor-arg>
			<util:map>
				<entry key="1" value="Welcome to the Sandbox! Use this room to experiment with the features of Stack Overflow Chat." />
			</util:map>
		</constructor-arg>
	</bean>

	<!-- XKCD explained ========================================= -->
	<bean class="oakbot.task.XkcdExplained">
		<!--
		The amount time to wait after the comic is posted to the chat room before crawling explainxkcd.com for the explanation.
		-->
		<constructor-arg value="PT30M" />
	</bean>

	<!-- AI ===================================================== -->
	<bean class="oakbot.ai.openai.OpenAIClient" id="openAIClient">
		<!--
		OpenAI API key.
		-->
		<constructor-arg value="API_KEY" />

		<!--
		(optional)
		Log all requests/responses to a CSV file for debugging.
		-->
		<!--
		<constructor-arg>
			<bean class="oakbot.util.HttpRequestLogger">
				<constructor-arg value="openai-requests.csv" />
			</bean>
		</constructor-arg>
		-->
	</bean>
	<bean class="oakbot.ai.stabilityai.StabilityAIClient" id="stabilityAIClient">
		<!--
		Stability.ai API key.
		-->
		<constructor-arg value="API_KEY" />
	</bean>
	<bean class="oakbot.imgur.ImgurClient" id="imgurClient">
		<!--
		Imgur.com API key.
		-->
		<constructor-arg value="CLIENT_ID" />
	</bean>
	<bean class="oakbot.listener.chatgpt.MoodCommand" id="moodCommand">
		<constructor-arg ref="database" />

		<!--
		Default mood.
		-->
		<constructor-arg value="grumpy" />
	</bean>
	<bean class="oakbot.listener.chatgpt.ChatGPT" factory-method="create" id="chatGPT">
		<constructor-arg ref="openAIClient" />
		<constructor-arg ref="moodCommand" />

		<!--
		The model.
		-->
		<constructor-arg value="gpt-5.4-mini" />

		<!--
		Default prompt.
		A short description of the bot's personality (e.g. "You are a helpful assistant").
		$MOOD = The mood defined by the /mood command.
		$ROOMNAME = The name of the chat room.
		-->
		<constructor-arg value="You are a $MOOD Java developer named 'OakBot'. You are in a room called '$ROOMNAME'." />

		<!--
		Room-specific prompts.
		$MOOD = The mood defined by the /mood command.
		$ROOMNAME = The name of the chat room.
		-->
		<constructor-arg>
			<util:map>
				<entry key="1" value="You are a $MOOD chat bot named 'OakBot'. You are in a room called 'Sandbox', which people use for testing chat features." />
			</util:map>
		</constructor-arg>

		<!--
		Max tokens the response can be.
		If this number is too short, then the completion may end abruptly (e.g. in an unfinished sentence).
		-->
		<constructor-arg value="100" /> 

		<!--
		(can be null)
		Reasoning effort.
		Higher values consume more tokens.
		Only supported by some models.
		-->
		<constructor-arg value="none" />
		
		<!--
		(can be null)
		Verbosity.
		Higher values consume more tokens.
		Only supported by some models.
		-->
		<constructor-arg value="low" />

		<!--
		The amount of time to wait before posting a sponaneous message.
		-->
		<constructor-arg value="PT12H" />

		<!--
		The number of chat room messages to include in the ChatGPT request to give the bot context of the conversation.
		Each message counts against the usage quota. 
		-->
		<constructor-arg value="10" />

		<!--
		Each chat message that is sent to ChatGPT will not exceed this number of characters (including markdown syntax).
		Chat messages that exceed this will be truncated (without cutting off words).
		0 to disable truncation.
		Each message counts against the usage quota.
		-->
		<constructor-arg value="300" />

		<!--
		Requests allowed per user per 24 hours
		0 for no limit.
		-->
		<constructor-arg value="20" />
		
		<!--
		Which chat API to use.
		responses-api or chat-completions
		-->
		<constructor-arg value="responses-api" />
	</bean>
	<bean class="oakbot.listener.chatgpt.ImagineCore" id="imagineCore">
		<constructor-arg ref="openAIClient" />
		<constructor-arg ref="stabilityAIClient" />
		<constructor-arg ref="chatGPT" />

		<!--
		Requests allowed per user per 24 hours.
		0 for no limit.
		-->
		<constructor-arg value="5" />
	</bean>
	<bean class="oakbot.listener.chatgpt.ImagineCommand">
		<constructor-arg ref="imagineCore" />
	</bean>
	<bean class="oakbot.listener.chatgpt.ImagineVagueCommand">
		<constructor-arg ref="imagineCore" />
	</bean>
	<bean class="oakbot.listener.chatgpt.ImagineContextCommand">
		<constructor-arg ref="imagineCore" />

		<!--
		Default model.
		-->
		<constructor-arg value="gpt-image-1-mini" />

		<!--
		Prompt. The chat messages will be appended to this.
		-->
		<constructor-arg value="Create a manga comic strip panel from the following dialog. Each character wears a name tag. Include speech bubbles." />

		<!--
		Each chat message will be truncated to this number of characters.
		0 for no limit.
		-->
		<constructor-arg value="100" />

		<!--
		The number of chat messages to include in the prompt.
		Certain chat messages will be excluded, such as chat messages from system bots.
		-->
		<constructor-arg value="10" />
	</bean>
	<bean class="oakbot.listener.chatgpt.VideoCommand">
		<constructor-arg ref="stabilityAIClient" />
		<constructor-arg ref="imgurClient" />
	</bean>
	<bean class="oakbot.listener.chatgpt.PromptCommand">
		<constructor-arg ref="chatGPT" />
	</bean>
	<bean class="oakbot.listener.chatgpt.QuotaCommand">
		<constructor-arg ref="chatGPT" />
		<constructor-arg ref="imagineCore" />
	</bean>

	<!-- fact of the day task =================================== -->
	<bean class="oakbot.task.FOTD" />

	<!-- health monitor task ==================================== -->
	<bean class="oakbot.task.LinuxHealthMonitor">
		<!--
		The rooms to post health warnings in.
		-->
		<constructor-arg>
			<util:list>
				<value>1</value>
			</util:list>
		</constructor-arg>

		<!--
		Path to "apt-check" command.
		-->
		<constructor-arg value="/usr/lib/update-notifier/apt-check" />
	</bean>

	<!-- quote of the day task ================================== -->
	<bean class="oakbot.task.QOTD" />

	<!-- fill the silence task ================================== -->
	<bean class="oakbot.inactivity.FillTheSilenceTask">
		<!--
		If the room is quiet for this long, bot will post a message
		-->
		<constructor-arg value="PT6H" />
	</bean>

	<!-- leave inactive rooms task ============================== -->
	<bean class="oakbot.inactivity.LeaveRoomTask">
		<!--
		If the room is inactive for this long, bot will leave the room.
		-->
		<constructor-arg value="P3D" />
	</bean>

	<!-- Converts duration strings to Duration objects. -->
	<bean id="conversionService" class="org.springframework.format.support.FormattingConversionServiceFactoryBean" />

</beans>