PircBotXExample.java

/**
 * Copyright (C) 2010-2014 Leon Blakey <lord.quackstar at gmail.com>
 *
 * This file is part of PircBotX.
 *
 * PircBotX is free software: you can redistribute it and/or modify it under the
 * terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 *
 * PircBotX is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * PircBotX. If not, see <http://www.gnu.org/licenses/>.
 */
package org.pircbotx.impl;

import org.pircbotx.Configuration;
import org.pircbotx.PircBotX;
import org.pircbotx.UtilSSLSocketFactory;
import org.pircbotx.cap.TLSCapHandler;
import org.pircbotx.dcc.ReceiveChat;
import org.pircbotx.hooks.ListenerAdapter;
import org.pircbotx.hooks.WaitForQueue;
import org.pircbotx.hooks.events.IncomingChatRequestEvent;
import org.pircbotx.hooks.events.MessageEvent;
import org.pircbotx.hooks.managers.ListenerManager;
import org.pircbotx.hooks.types.GenericMessageEvent;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Basic example class for various features of PircBotX. Heavily documented to
 * explain what's going on
 * <p/>
 * @author Leon Blakey <lord.quackstar at gmail.com>
 */
public class PircBotXExample extends ListenerAdapter {
	public static Logger log = LoggerFactory.getLogger(PircBotXExample.class);

	/**
	 * This example shows how to handle messages, actions, and notices from both
	 * channels and private messages. It also shows how to use WaitForQueue to
	 * have multi-line commands.
	 *
	 * @param event A GenericMessageEvent from a channel or private message
	 * @throws Exception If any Exceptions might be thrown, throw them up and
	 * let the {@link ListenerManager} handle it. This can be removed though if
	 * not needed
	 */
	@Override
	public void onGenericMessage(final GenericMessageEvent event) throws Exception {
		//Hello world
		//This way to handle commands is useful for listeners that listen for multiple commands
		if (event.getMessage().startsWith("?hello"))
			event.respond("Hello World!");

		//If this isn't a waittest, ignore
		//This way to handle commands is useful for listers that only listen for one command
		if (!event.getMessage().startsWith("?waitTest start"))
			return;

		//WaitTest has started
		event.respond("Started...");
		WaitForQueue queue = new WaitForQueue(event.getBot());
		//Infinate loop since we might recieve messages that aren't WaitTest's.
		while (true) {
			//Use the waitFor() method to wait for a MessageEvent.
			//This will block (wait) until a message event comes in, ignoring
			//everything else
			MessageEvent currentEvent = queue.waitFor(MessageEvent.class);
			//Check if this message is the "ping" command
			if (currentEvent.getMessage().startsWith("?waitTest ping"))
				event.respond("pong");
			//Check if this message is the "end" command
			else if (currentEvent.getMessage().startsWith("?waitTest end")) {
				event.respond("Stopping");
				queue.close();
				//Very important that we end the infinate loop or else the test
				//will continue forever!
				return;
			}
		}
	}

	/**
	 * This basic example shows how to handle incoming DCC chat requests. It
	 * basically repeats what the user said and says how many characters are in
	 * their message
	 *
	 * @param event A incoming DCC chat request event
	 * @throws Exception
	 */
	@Override
	public void onIncomingChatRequest(IncomingChatRequestEvent event) throws Exception {
		//Accept the incoming chat request. If it fails it will throw an exception
		ReceiveChat chat = event.accept();
		//Read lines from the server
		String line;
		while ((line = chat.readLine()) != null)
			if (line.equalsIgnoreCase("done")) {
				//Shut down the chat
				chat.close();
				break;
			} else {
				//Fun example
				int lineLength = line.length();
				chat.sendLine("Line '" + line + "' contains " + lineLength + " characters");
			}
	}

	public static void main(String[] args) {
		//Setup this bot
		Configuration configuration = new Configuration.Builder()
				.setName("PircBotX") //Set the nick of the bot. CHANGE IN YOUR CODE
				.setLogin("LQ") //login part of hostmask, eg name:login@host
				.setAutoNickChange(true) //Automatically change nick when the current one is in use
				.setCapEnabled(true) //Enable CAP features
				.addCapHandler(new TLSCapHandler(new UtilSSLSocketFactory().trustAllCertificates(), true))
				.addListener(new PircBotXExample()) //This class is a listener, so add it to the bots known listeners
				.addServer("irc.freenode.net")
				.addAutoJoinChannel("#pircbotx") //Join the official #pircbotx channel
				.buildConfiguration();

		//bot.connect throws various exceptions for failures
		try {
			PircBotX bot = new PircBotX(configuration);
			//Connect to the freenode IRC network
			bot.startBot();
		} //In your code you should catch and handle each exception seperately,
		//but here we just lump them all togeather for simpliciy
		catch (Exception ex) {
			log.error("Failed to start bot", ex);
		}
	}
}