src/main/java/net/pterodactylus/xdcc/core/Core.java

   1 /*
   2  * XdccDownloader - Core.java - Copyright © 2013 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.xdcc.core;
  19
  20 import java.io.IOException;
  21 import java.util.Collection;
  22 import java.util.Collections;
  23 import java.util.List;
  24 import java.util.Map;
  25 import java.util.Map.Entry;
  26 import java.util.logging.Level;
  27 import java.util.logging.Logger;
  28
  29 import net.pterodactylus.irc.Connection;
  30 import net.pterodactylus.irc.ConnectionBuilder;
  31 import net.pterodactylus.irc.DccReceiver;
  32 import net.pterodactylus.irc.event.ChannelMessageReceived;
  33 import net.pterodactylus.irc.event.ConnectionEstablished;
  34 import net.pterodactylus.irc.util.MessageCleaner;
  35 import net.pterodactylus.irc.util.RandomNickname;
  36 import net.pterodactylus.xdcc.core.event.BotAdded;
  37 import net.pterodactylus.xdcc.core.event.CoreStarted;
  38 import net.pterodactylus.xdcc.data.Bot;
  39 import net.pterodactylus.xdcc.data.Channel;
  40 import net.pterodactylus.xdcc.data.Network;
  41 import net.pterodactylus.xdcc.data.Pack;
  42 import net.pterodactylus.xdcc.data.Server;
  43
  44 import com.google.common.base.Optional;
  45 import com.google.common.collect.HashBasedTable;
  46 import com.google.common.collect.Lists;
  47 import com.google.common.collect.Maps;
  48 import com.google.common.collect.Sets;
  49 import com.google.common.collect.Table;
  50 import com.google.common.eventbus.EventBus;
  51 import com.google.common.eventbus.Subscribe;
  52 import com.google.common.util.concurrent.AbstractIdleService;
  53 import com.google.inject.Inject;
  54
  55 /**
  56  * The core of XDCC Downloader.
  57  *
  58  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  59  */
  60 public class Core extends AbstractIdleService {
  61
  62         /** The logger. */
  63         private static final Logger logger = Logger.getLogger(Core.class.getName());
  64
  65         /** The event bus. */
  66         private final EventBus eventBus;
  67
  68         /** The channels that should be monitored. */
  69         private final Collection<Channel> channels = Sets.newHashSet();
  70
  71         /** The current network connections. */
  72         private final Map<Network, Connection> networkConnections = Collections.synchronizedMap(Maps.<Network, Connection>newHashMap());
  73
  74         /** The currently known bots. */
  75         private final Table<Network, String, Bot> networkBots = HashBasedTable.create();
  76
  77         /** The current DCC receivers. */
  78         private final Collection<DccReceiver> dccReceivers = Sets.newHashSet();
  79
  80         /**
  81          * Creates a new core.
  82          *
  83          * @param eventBus
  84          *              The event bus
  85          */
  86         @Inject
  87         public Core(EventBus eventBus) {
  88                 this.eventBus = eventBus;
  89         }
  90
  91         //
  92         // ACCESSORS
  93         //
  94
  95         /**
  96          * Returns all currently known bots.
  97          *
  98          * @return All currently known bots
  99          */
 100         public Collection<Bot> bots() {
 101                 return networkBots.values();
 102         }
 103
 104         /**
 105          * Returns the currently active DCC receivers.
 106          *
 107          * @return The currently active DCC receivers
 108          */
 109         public Collection<DccReceiver> dccReceivers() {
 110                 return dccReceivers;
 111         }
 112
 113         //
 114         // ACTIONS
 115         //
 116
 117         /**
 118          * Adds a channel to monitor.
 119          *
 120          * @param channel
 121          *              The channel to monitor
 122          */
 123         public void addChannel(Channel channel) {
 124                 channels.add(channel);
 125         }
 126
 127         //
 128         // ABSTRACTIDLESERVICE METHODS
 129         //
 130
 131         @Override
 132         protected void startUp() {
 133                 for (Channel channel : channels) {
 134                         logger.info(String.format("Connecting to Channel %s on Network %s…", channel.name(), channel.network().name()));
 135                         if (!networkConnections.containsKey(channel.network())) {
 136                                 /* select a random server. */
 137                                 List<Server> servers = Lists.newArrayList(channel.network().servers());
 138                                 Server server = servers.get((int) (Math.random() * servers.size()));
 139                                 Connection connection = new ConnectionBuilder(eventBus).connect(server.hostname()).port(server.unencryptedPorts().iterator().next()).build();
 140                                 connection.username(RandomNickname.get()).realName(RandomNickname.get());
 141                                 networkConnections.put(channel.network(), connection);
 142                                 connection.start();
 143                         }
 144                 }
 145
 146                 /* notify listeners. */
 147                 eventBus.post(new CoreStarted(this));
 148         }
 149
 150         @Override
 151         protected void shutDown() {
 152         }
 153
 154         //
 155         // EVENT HANDLERS
 156         //
 157
 158         /**
 159          * If a connection to a network has been established, the channels associated
 160          * with this network are joined.
 161          *
 162          * @param connectionEstablished
 163          *              The connection established event
 164          */
 165         @Subscribe
 166         public void connectionEstablished(ConnectionEstablished connectionEstablished) {
 167
 168                 /* get network for connection. */
 169                 Optional<Network> network = getNetwork(connectionEstablished.connection());
 170
 171                 /* found network? */
 172                 if (!network.isPresent()) {
 173                         return;
 174                 }
 175
 176                 /* join all channels on this network. */
 177                 for (Channel channel : channels) {
 178                         if (channel.network().equals(network.get())) {
 179                                 try {
 180                                         connectionEstablished.connection().joinChannel(channel.name());
 181                                 } catch (IOException ioe1) {
 182                                         logger.log(Level.WARNING, String.format("Could not join %s on %s!", channel.name(), network.get().name()), ioe1);
 183                                 }
 184                         }
 185                 }
 186         }
 187
 188         /**
 189          * If a message on a channel is received, it is parsed for pack information
 190          * with is then added to a bot.
 191          *
 192          * @param channelMessageReceived
 193          *              The channel message received event
 194          */
 195         @Subscribe
 196         public void channelMessageReceived(ChannelMessageReceived channelMessageReceived) {
 197                 String message = MessageCleaner.getDefaultInstance().clean(channelMessageReceived.message());
 198                 if (!message.startsWith("#")) {
 199                         /* most probably not a pack announcement. */
 200                         return;
 201                 }
 202
 203                 Optional<Network> network = getNetwork(channelMessageReceived.connection());
 204                 if (!network.isPresent()) {
 205                         /* message for unknown connection? */
 206                         return;
 207                 }
 208
 209                 /* parse pack information. */
 210                 Optional<Pack> pack = parsePack(message);
 211                 if (!pack.isPresent()) {
 212                         return;
 213                 }
 214
 215                 Bot bot;
 216                 synchronized (networkBots) {
 217                         if (!networkBots.contains(network.get(), channelMessageReceived.source().nick().get())) {
 218                                 bot = new Bot(network.get()).name(channelMessageReceived.source().nick().get());
 219                                 networkBots.put(network.get(), channelMessageReceived.source().nick().get(), bot);
 220                                 eventBus.post(new BotAdded(bot));
 221                         } else {
 222                                 bot = networkBots.get(network.get(), channelMessageReceived.source().nick().get());
 223                         }
 224                 }
 225
 226                 /* add pack. */
 227                 bot.addPack(pack.get());
 228                 logger.fine(String.format("Bot %s now has %d packs.", bot, bot.packs().size()));
 229         }
 230
 231         //
 232         // PRIVATE METHODS
 233         //
 234
 235         /**
 236          * Searches all current connections for the given connection, returning the
 237          * associated network.
 238          *
 239          * @param connection
 240          *              The connection to get the network for
 241          * @return The network belonging to the connection, or {@link
 242          *         Optional#absent()}
 243          */
 244         private Optional<Network> getNetwork(Connection connection) {
 245                 for (Entry<Network, Connection> networkConnectionEntry : networkConnections.entrySet()) {
 246                         if (networkConnectionEntry.getValue().equals(connection)) {
 247                                 return Optional.of(networkConnectionEntry.getKey());
 248                         }
 249                 }
 250                 return Optional.absent();
 251         }
 252
 253         /**
 254          * Parses {@link Pack} information from the given message.
 255          *
 256          * @param message
 257          *              The message to parse pack information from
 258          * @return The parsed pack, or {@link Optional#absent()} if the message could
 259          *         not be parsed into a pack
 260          */
 261         private Optional<Pack> parsePack(String message) {
 262                 int squareOpen = message.indexOf('[');
 263                 int squareClose = message.indexOf(']', squareOpen);
 264                 if ((squareOpen == -1) && (squareClose == -1)) {
 265                         return Optional.absent();
 266                 }
 267                 String packSize = message.substring(squareOpen + 1, squareClose);
 268                 String packName = message.substring(message.lastIndexOf(' ') + 1);
 269                 String packIndex = message.substring(0, message.indexOf(' ')).substring(1);
 270                 return Optional.of(new Pack(packIndex, packSize, packName));
 271         }
 272
 273 }