Skip to content

Specify listeners in config file #155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Kevin-Mok wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Specify listeners in config file #155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

### Create config file

cp cfg/vilebot.conf.example cfg/vilebot.conf
cp vilebot/cfg/vilebot.conf.example vilebot/cfg/vilebot.conf
$EDITOR vilebot/cfg/vilebot.conf

### Eclipse import
Expand Down
9 changes: 5 additions & 4 deletions vilebot/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/target/
/db/
/cfg/vilebot*.conf
/db-backups/
/db/
/files/fonts/
/log/
/cfg/vilebot*.conf
/files/fonts/
/target/
utils/delete-backups.sh
9 changes: 7 additions & 2 deletions vilebot/server-control.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ set -f
: "${VB_PID_PATH:=/tmp/vb-server-pid-$USER}"
: "${VB_LOG_PATH:=log}"
: "${VB_REMOTE_DEBUG:=0}"

: "${VB_JAVA_STDOUT:=0}"

die() {
if [ -n "$*" ]
Expand Down Expand Up @@ -103,7 +103,12 @@ mode_start() {
msg ">> Starting Vilebot"
fi

nohup java $extra_opts -jar "$VB_JAR_PATH" 1>>"$VB_LOG_PATH/vilebot-stdout.log" 2>&1 &
if [ "$VB_JAVA_STDOUT" = "1" ]
then
java $extra_opts -jar "$VB_JAR_PATH" 1
else
nohup java $extra_opts -jar "$VB_JAR_PATH" 1>>"$VB_LOG_PATH/vilebot-stdout.log" 2>&1 &
fi
echo -n "$!" >| "$VB_PID_PATH"
fi

Expand Down
71 changes: 66 additions & 5 deletions vilebot/src/main/java/com/oldterns/vilebot/Vilebot.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;
Expand Down Expand Up @@ -61,6 +62,7 @@
import com.oldterns.vilebot.util.BaseNick;
import org.pircbotx.Configuration;
import org.pircbotx.MultiBotManager;
import org.pircbotx.hooks.Listener;
import org.pircbotx.hooks.ListenerAdapter;
import org.pircbotx.hooks.types.GenericMessageEvent;
import org.slf4j.Logger;
Expand All @@ -79,6 +81,12 @@ public class Vilebot

private static Map<String, String> cfg = getConfigMap();

private static final String[] allListenerClasses = { "AnswerQuestion", "Ascii", "ChatLogger", "Church", "Countdown",
Copy link
Contributor

@Christopher-Chianelli Christopher-Chianelli Aug 3, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recommend this being a Class array instead of a String array, so that a missing class is a compile time error and to make it easier to rename classes when refactoring.

"Decide", "DownOrJustMe", "Excuses", "FakeNews", "Fortune", "GetInfoOn", "Help", "ImageToAscii", "Inspiration",
"Jaziz", "Jokes", "Kaomoji", "Karma", "KarmaRoll", "KarmaTransfer", "LastMessageSed", "LastSeen", "Markov",
"News", "Omgword", "Ops", "QuotesAndFacts", "RemindMe", "RockPaperScissors", "Summon", "Trivia", "Ttc",
"TwitterCorrection", "UrlTitleAnnouncer", "UrlTweetAnnouncer", "UserPing", "Userlists", "Weather" };

private static JedisPool pool;

public static void main( String[] args )
Expand Down Expand Up @@ -113,20 +121,73 @@ public static void main( String[] args )
String ircServerAddress = cfg.get( "ircServerAddress" + i );
int ircPort = Integer.parseInt( cfg.get( "ircPort" + i ) );
String ircChannel = cfg.get( "ircChannel" + i );
String listenerCsvString = cfg.get( "listeners" + i );
Copy link

@cuijulian cuijulian Aug 5, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This additional cfg entry should also be added in vilebot/cfg/vilebot.conf.example (ie. listeners1=all).


BaseNick.addBotNick( ircNick );

Configuration botConfiguration =
new Configuration.Builder().setName( ircNick ).setLogin( ircUser ).setRealName( ircRealName ).addServer( ircServerAddress,
ircPort ).addAutoJoinChannel( ircChannel ).setAutoReconnect( true ).addListener( new Vilebot() ).addListener( new AdminManagement() ).addListener( new AdminPing() ).addListener( new Auth() ).addListener( new DownOrJustMe() ).addListener( new GetLog() ).addListener( new com.oldterns.vilebot.handlers.admin.Help() ).addListener( new NickChange() ).addListener( new com.oldterns.vilebot.handlers.admin.Ops() ).addListener( new Quit() ).addListener( new AnswerQuestion() ).addListener( new Ascii() ).addListener( new ChatLogger() ).addListener( new Church() ).addListener( new Countdown() ).addListener( new Decide() ).addListener( new Excuses() ).addListener( new FakeNews() ).addListener( new Fortune() ).addListener( new GetInfoOn() ).addListener( new Help() ).addListener( new ImageToAscii() ).addListener( new Inspiration() ).addListener( new Jaziz() ).addListener( new Jokes() ).addListener( new Kaomoji() ).addListener( new Karma() ).addListener( new KarmaRoll() ).addListener( new KarmaTransfer() ).addListener( new LastMessageSed() ).addListener( new LastSeen() ).addListener( new Markov() ).addListener( new News() ).addListener( new Omgword() ).addListener( new Ops() ).addListener( new QuotesAndFacts() ).addListener( new RemindMe() ).addListener( new RockPaperScissors() ).addListener( new Summon() ).addListener( new Trivia() ).addListener( new Ttc() ).addListener( new TwitterCorrection() ).addListener( new UrlTitleAnnouncer() ).addListener( new UrlTweetAnnouncer() ).addListener( new Userlists() ).addListener( new UserPing() ).addListener( new Weather() ).buildConfiguration();

botManager.addBot( botConfiguration );
Configuration.Builder botCfg = new Configuration.Builder();
botCfg.setName( ircNick );
botCfg.setLogin( ircUser );
botCfg.setRealName( ircRealName );
botCfg.addServer( ircServerAddress, ircPort );
botCfg.addAutoJoinChannel( ircChannel );
botCfg.setAutoReconnect( true );
botCfg.addListeners( convertListenerStrings( listenerCsvString ) );
botManager.addBot( botCfg.buildConfiguration() );
}

botManager.start();
// Done
}

/**
* Returns list of Listener object based on a CSV string of Listener class names.
Copy link

@cuijulian cuijulian Aug 5, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Returns list of Listener object based on a CSV string of Listener class names.
* Returns list of Listener objects based on a CSV string of Listener class names.

*
* @param listenerCsvString CSV list of listener class names.
* @return List of Listener objects.
**/
private static ArrayList<Listener> convertListenerStrings( String listenerCsvString )
{
ArrayList<Listener> listeners = new ArrayList<Listener>();

// add admin listeners
listeners.add( new AdminManagement() );
listeners.add( new AdminPing() );
listeners.add( new Auth() );
listeners.add( new GetLog() );
listeners.add( new NickChange() );
listeners.add( new Quit() );

// add user listeners
String[] listenerStrings =
( listenerCsvString.equals( "all" ) ) ? allListenerClasses : listenerCsvString.split( "," );
for ( String listenerString : listenerStrings )
{
listeners.add( createListenerFromString( listenerString ) );
}

return listeners;
}

/**
* Returns Listener object based on class name.
*
* @param listenerString Name of class.
* @return Listener object of class name.
**/
private static Listener createListenerFromString( String listenerString )
{
final String className = "com.oldterns.vilebot.handlers.user." + listenerString;
try
{
return (Listener) Class.forName( className ).newInstance();
}
catch ( InstantiationException | IllegalAccessException | ClassNotFoundException e )
{
throw new IllegalStateException( e );
}
}

private static Map<String, String> getConfigMap()
{
Map<String, String> cfg = new HashMap<>();
Expand Down