001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.stream.provider.irc;
031
032import java.io.IOException;
033
034import org.apache.log4j.Logger;
035import org.jibble.pircbot.IrcException;
036import org.jibble.pircbot.NickAlreadyInUseException;
037import org.jibble.pircbot.PircBot;
038import org.openimaj.data.dataset.StreamingDataset;
039import org.openimaj.util.concurrent.BlockingDroppingQueue;
040import org.openimaj.util.stream.BlockingDroppingBufferedStream;
041
042/**
043 * Abstract base class for producing a stream of items from an IRC channel.
044 * 
045 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
046 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
047 * 
048 * @param <T>
049 *            The type of items produced
050 */
051public abstract class AbstractIRCStreamDataset<T> extends BlockingDroppingBufferedStream<T>
052                implements
053                StreamingDataset<T>
054{
055        private static Logger logger = Logger.getLogger(AbstractIRCStreamDataset.class);
056
057        private class IRCStreamBot extends PircBot {
058                public IRCStreamBot() {
059                        this.setName("IRCStreamBot");
060                }
061
062                @Override
063                protected void onMessage(String channel, String sender, String login, String hostname, String message) {
064                        try {
065                                final T construct = AbstractIRCStreamDataset.this.construct(channel, sender, login, hostname, message);
066                                if (construct == null)
067                                        return;
068
069                                AbstractIRCStreamDataset.this.register(construct);
070                        } catch (final Throwable e) {
071                                logger.warn("INTERRUPTED! " + e);
072                        }
073                }
074        }
075
076        protected AbstractIRCStreamDataset(BlockingDroppingQueue<T> buffer, String hostname, String channel)
077                        throws IOException
078        {
079                super(buffer);
080
081                final PircBot bot = new IRCStreamBot();
082                try {
083                        bot.connect(hostname);
084                        bot.joinChannel(channel);
085                        logger.debug("Connected!");
086                } catch (final NickAlreadyInUseException e) {
087                        throw new IOException(e);
088                } catch (final IOException e) {
089                        throw new IOException(e);
090                } catch (final IrcException e) {
091                        throw new IOException(e);
092                }
093        }
094
095        @Override
096        protected void register(T obj) throws InterruptedException {
097                super.register(obj);
098        }
099
100        /**
101         * Called by {@link PircBot#onMessage}
102         * 
103         * @param channel
104         *            the channel to which the message was sent
105         * @param sender
106         *            the sender of the message (their nick)
107         * @param login
108         *            the login of the message sender
109         * @param hostname
110         *            the hostname of the message sender
111         * @param message
112         *            the message itself
113         * @return the object the stream produces
114         */
115        public abstract T construct(String channel, String sender, String login, String hostname, String message);
116
117        @Override
118        public T getRandomInstance() {
119                return this.next();
120        }
121
122        @Override
123        public int numInstances() {
124                return Integer.MAX_VALUE;
125        }
126}