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 static java.lang.String.format;
  21 import static net.pterodactylus.irc.event.ChannelNotJoined.Reason.banned;
  22 import static net.pterodactylus.irc.event.ChannelNotJoined.Reason.registeredNicknamesOnly;
  23 import static net.pterodactylus.irc.util.MessageCleaner.getDefaultInstance;
  24 import static net.pterodactylus.xdcc.data.Channel.TO_NETWORK;
  25 import static net.pterodactylus.xdcc.data.Download.FILTER_RUNNING;
  26
  27 import java.io.File;
  28 import java.io.FileNotFoundException;
  29 import java.io.FileOutputStream;
  30 import java.io.IOException;
  31 import java.io.OutputStream;
  32 import java.util.Collection;
  33 import java.util.Collections;
  34 import java.util.HashSet;
  35 import java.util.Iterator;
  36 import java.util.List;
  37 import java.util.Map;
  38 import java.util.Map.Entry;
  39 import java.util.Set;
  40 import java.util.TreeMap;
  41 import java.util.concurrent.TimeUnit;
  42 import java.util.function.Function;
  43 import java.util.stream.Collectors;
  44
  45 import net.pterodactylus.irc.Connection;
  46 import net.pterodactylus.irc.ConnectionFactory;
  47 import net.pterodactylus.irc.DccReceiver;
  48 import net.pterodactylus.irc.DefaultConnection;
  49 import net.pterodactylus.irc.event.ChannelJoined;
  50 import net.pterodactylus.irc.event.ChannelLeft;
  51 import net.pterodactylus.irc.event.ChannelMessageReceived;
  52 import net.pterodactylus.irc.event.ChannelNotJoined;
  53 import net.pterodactylus.irc.event.ClientQuit;
  54 import net.pterodactylus.irc.event.ConnectionClosed;
  55 import net.pterodactylus.irc.event.ConnectionEstablished;
  56 import net.pterodactylus.irc.event.ConnectionFailed;
  57 import net.pterodactylus.irc.event.DccAcceptReceived;
  58 import net.pterodactylus.irc.event.DccDownloadFailed;
  59 import net.pterodactylus.irc.event.DccDownloadFinished;
  60 import net.pterodactylus.irc.event.DccSendReceived;
  61 import net.pterodactylus.irc.event.KickedFromChannel;
  62 import net.pterodactylus.irc.event.NicknameChanged;
  63 import net.pterodactylus.irc.event.PrivateMessageReceived;
  64 import net.pterodactylus.irc.event.PrivateNoticeReceived;
  65 import net.pterodactylus.irc.event.ReplyReceived;
  66 import net.pterodactylus.irc.util.RandomNickname;
  67 import net.pterodactylus.xdcc.core.event.BotAdded;
  68 import net.pterodactylus.xdcc.core.event.CoreStarted;
  69 import net.pterodactylus.xdcc.core.event.DownloadFailed;
  70 import net.pterodactylus.xdcc.core.event.DownloadFinished;
  71 import net.pterodactylus.xdcc.core.event.DownloadStarted;
  72 import net.pterodactylus.xdcc.core.event.GenericError;
  73 import net.pterodactylus.xdcc.core.event.GenericMessage;
  74 import net.pterodactylus.xdcc.core.event.MessageReceived;
  75 import net.pterodactylus.xdcc.data.Bot;
  76 import net.pterodactylus.xdcc.data.Channel;
  77 import net.pterodactylus.xdcc.data.ConnectedNetwork;
  78 import net.pterodactylus.xdcc.data.Download;
  79 import net.pterodactylus.xdcc.data.Network;
  80 import net.pterodactylus.xdcc.data.Pack;
  81 import net.pterodactylus.xdcc.data.Server;
  82
  83 import com.google.common.base.Optional;
  84 import com.google.common.base.Predicate;
  85 import com.google.common.collect.FluentIterable;
  86 import com.google.common.collect.HashBasedTable;
  87 import com.google.common.collect.HashMultimap;
  88 import com.google.common.collect.ImmutableList;
  89 import com.google.common.collect.ImmutableSet;
  90 import com.google.common.collect.Lists;
  91 import com.google.common.collect.Maps;
  92 import com.google.common.collect.Multimap;
  93 import com.google.common.collect.Sets;
  94 import com.google.common.collect.Table;
  95 import com.google.common.eventbus.EventBus;
  96 import com.google.common.eventbus.Subscribe;
  97 import com.google.common.io.Closeables;
  98 import com.google.common.util.concurrent.AbstractExecutionThreadService;
  99 import com.google.inject.Inject;
 100 import org.apache.log4j.Logger;
 101
 102 /**
 103  * The core of XDCC Downloader.
 104  *
 105  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
 106  */
 107 public class Core extends AbstractExecutionThreadService {
 108
 109         /** The logger. */
 110         private static final Logger logger = Logger.getLogger(Core.class.getName());
 111
 112         private final Object syncObject = new Object();
 113         /** The event bus. */
 114         private final EventBus eventBus;
 115         private final ConnectionFactory connectionFactory;
 116         private final ChannelBanManager channelBanManager =
 117                         new ChannelBanManager();
 118         private final ConnectionBackoff connectionBackoff = new ConnectionBackoff();
 119
 120         /** The temporary directory to download files to. */
 121         private final String temporaryDirectory;
 122
 123         /** The directory to move finished downloads to. */
 124         private final String finalDirectory;
 125
 126         /** The channels that should be monitored. */
 127         private final Collection<Channel> channels = Sets.newHashSet();
 128
 129         /** The channels that are currentlymonitored. */
 130         private final Collection<Channel> joinedChannels = Sets.newHashSet();
 131         private final Set<Channel> channelsBeingJoined = new HashSet<>();
 132
 133         /** The channels that are joined but not configured. */
 134         private final Collection<Channel> extraChannels = Sets.newHashSet();
 135
 136         /** The current network connections. */
 137         private final Map<Network, Connection> networkConnections = Collections.synchronizedMap(Maps.<Network, Connection>newHashMap());
 138
 139         /** The currently known bots. */
 140         private final Table<Network, String, Bot> networkBots = HashBasedTable.create();
 141
 142         /** The current downloads. */
 143         private final Multimap<String, Download> downloads = HashMultimap.create();
 144
 145         /** The current DCC receivers. */
 146         private final Collection<DccReceiver> dccReceivers = Lists.newArrayList();
 147
 148         /**
 149          * Creates a new core.
 150          *
 151          * @param eventBus
 152          *              The event bus
 153          * @param temporaryDirectory
 154          *              The directory to download files to
 155          * @param finalDirectory
 156          *              The directory to move finished files to
 157          */
 158         @Inject
 159         public Core(EventBus eventBus, ConnectionFactory connectionFactory, String temporaryDirectory, String finalDirectory) {
 160                 this.eventBus = eventBus;
 161                 this.connectionFactory = connectionFactory;
 162                 this.temporaryDirectory = temporaryDirectory;
 163                 this.finalDirectory = finalDirectory;
 164         }
 165
 166         //
 167         // ACCESSORS
 168         //
 169
 170         /**
 171          * Returns all currently known connections.
 172          *
 173          * @return All currently known connections
 174          */
 175         public Collection<Connection> connections() {
 176                 return networkConnections.values();
 177         }
 178
 179         /**
 180          * Returns all defined networks.
 181          *
 182          * @return All defined networks
 183          */
 184         public Collection<Network> networks() {
 185                 return FluentIterable.from(channels).transform(TO_NETWORK).toSet();
 186         }
 187
 188         /**
 189          * Returns all connected networks.
 190          *
 191          * @return All connected networks
 192          */
 193         public Collection<ConnectedNetwork> connectedNetworks() {
 194                 return networkConnections.entrySet().stream().map((entry) -> {
 195                         Network network = entry.getKey();
 196                         Collection<Bot> bots = networkBots.row(network).values();
 197                         int packCount = bots.stream().mapToInt((bot) -> bot.packs().size()).reduce((a, b) -> a + b).orElse(0);
 198                         return new ConnectedNetwork(network, entry.getValue().hostname(),
 199                                         entry.getValue().port(), entry.getValue().nickname(),
 200                                         channels.stream()
 201                                                         .filter((channel) -> channel.network()
 202                                                                         .equals(network))
 203                                                         .map(Channel::name)
 204                                                         .collect(Collectors.<String>toList()),
 205                                         extraChannels.stream()
 206                                                         .filter((channel) -> channel.network()
 207                                                                         .equals(network))
 208                                                         .map(Channel::name)
 209                                                         .collect(Collectors.<String>toList()),
 210                                         bots.size(), packCount);
 211                 }).collect(Collectors.<ConnectedNetwork>toList());
 212         }
 213
 214         /**
 215          * Returns all configured channels. Due to various circumstances, configured
 216          * channels might not actually be joined.
 217          *
 218          * @return All configured channels
 219          */
 220         public Collection<Channel> channels() {
 221                 return ImmutableSet.copyOf(channels);
 222         }
 223
 224         /**
 225          * Returns all currently joined channels.
 226          *
 227          * @return All currently joined channels
 228          */
 229         public Collection<Channel> joinedChannels() {
 230                 return ImmutableSet.copyOf(joinedChannels);
 231         }
 232
 233         /**
 234          * Returns all currently joined channels that are not configured.
 235          *
 236          * @return All currently joined but not configured channels
 237          */
 238         public Collection<Channel> extraChannels() {
 239                 return ImmutableSet.copyOf(extraChannels);
 240         }
 241
 242         /**
 243          * Returns all currently known bots.
 244          *
 245          * @return All currently known bots
 246          */
 247         public Collection<Bot> bots() {
 248                 return networkBots.values();
 249         }
 250
 251         /**
 252          * Returns all currently running downloads.
 253          *
 254          * @return All currently running downloads
 255          */
 256         public Collection<Download> downloads() {
 257                 return downloads.values();
 258         }
 259
 260         //
 261         // ACTIONS
 262         //
 263
 264         /**
 265          * Adds a channel to monitor.
 266          *
 267          * @param channel
 268          *              The channel to monitor
 269          */
 270         public void addChannel(Channel channel) {
 271                 channels.add(channel);
 272         }
 273
 274         /**
 275          * Fetches the given pack from the given bot.
 276          *
 277          * @param bot
 278          *              The bot to fetch the pack from
 279          * @param pack
 280          *              The pack to fetch
 281          */
 282         public void fetch(Bot bot, Pack pack) {
 283                 Connection connection = networkConnections.get(bot.network());
 284                 if (connection == null) {
 285                         return;
 286                 }
 287
 288                 /* check if we are already downloading the file? */
 289                 if (downloads.containsKey(pack.name())) {
 290                         Collection<Download> packDownloads = downloads.get(pack.name());
 291                         Collection<Download> runningDownloads = FluentIterable.from(packDownloads).filter(FILTER_RUNNING).toSet();
 292                         if (!runningDownloads.isEmpty()) {
 293                                 Download download = runningDownloads.iterator().next();
 294                                 eventBus.post(new GenericMessage(String.format("File %s is already downloading from %s (%s).", pack.name(), download.bot().name(), download.bot().network().name())));
 295                                 return;
 296                         }
 297                         StringBuilder bots = new StringBuilder();
 298                         for (Download download : packDownloads) {
 299                                 if (bots.length() > 0) {
 300                                         bots.append(", ");
 301                                 }
 302                                 bots.append(download.bot().name()).append(" (").append(download.bot().network().name()).append(')');
 303                         }
 304                         eventBus.post(new GenericMessage(String.format("File %s is already requested from %d bots (%s).", pack.name(), packDownloads.size(), bots.toString())));
 305                 }
 306
 307                 Download download = new Download(bot, pack);
 308                 downloads.put(pack.name(), download);
 309
 310                 try {
 311                         connection.sendMessage(bot.name(), "XDCC SEND " + pack.id());
 312                 } catch (IOException ioe1) {
 313                         logger.warn("Could not send message to bot!", ioe1);
 314                 }
 315         }
 316
 317         /**
 318          * Cancels the download of the given pack from the given bot.
 319          *
 320          * @param bot
 321          *              The bot the pack is being downloaded from
 322          * @param pack
 323          *              The pack being downloaded
 324          */
 325         public void cancelDownload(Bot bot, Pack pack) {
 326                 Optional<Download> download = getDownload(pack, bot);
 327                 if (!download.isPresent()) {
 328                         return;
 329                 }
 330
 331                 /* get connection. */
 332                 Connection connection = networkConnections.get(bot.network());
 333                 if (connection == null) {
 334                         /* request for unknown network? */
 335                         return;
 336                 }
 337
 338                 /* stop the DCC receiver. */
 339                 if (download.get().dccReceiver() != null) {
 340                         download.get().dccReceiver().stop();
 341                 } else {
 342                         /* remove download if it hasn’t started yet. */
 343                         downloads.remove(pack.name(), download.get());
 344                 }
 345
 346                 /* remove the request from the bot, too. */
 347                 try {
 348                         connection.sendMessage(bot.name(), String.format("XDCC %s", (download.get().dccReceiver() != null) ? "CANCEL" : "REMOVE"));
 349                 } catch (IOException ioe1) {
 350                         logger.warn(String.format("Could not cancel DCC from %s (%s)!", bot.name(), bot.network().name()), ioe1);
 351                 }
 352         }
 353
 354         /**
 355          * Closes the given connection.
 356          *
 357          * @param connection
 358          *              The connection to close
 359          */
 360         public void closeConnection(Connection connection) {
 361                 try {
 362                         connection.close();
 363                 } catch (IOException ioe1) {
 364                         /* TODO */
 365                 }
 366         }
 367
 368         //
 369         // ABSTRACTIDLESERVICE METHODS
 370         //
 371
 372         @Override
 373         protected void startUp() {
 374                 for (Channel channel : channels) {
 375                         logger.info(String.format("Connecting to Channel %s on Network %s…", channel.name(), channel.network().name()));
 376                         connectNetwork(channel.network());
 377                 }
 378
 379                 /* notify listeners. */
 380                 eventBus.post(new CoreStarted(this));
 381         }
 382
 383         @Override
 384         protected void run() throws Exception {
 385                 while (isRunning()) {
 386
 387                         Set<Channel> missingChannels = new HashSet<>();
 388                         for (Channel channel : channels) {
 389                                 if (joinedChannels.contains(channel) || channelsBeingJoined.contains(channel)) {
 390                                         continue;
 391                                 }
 392                                 if (channelBanManager.isBanned(channel)) {
 393                                         continue;
 394                                 }
 395                                 if (!networkConnections.containsKey(channel.network()) || networkConnections.get(channel.network()).established()) {
 396                                         missingChannels.add(channel);
 397                                 }
 398                         }
 399                         Set<Network> missingNetworks = missingChannels.stream()
 400                                         .map(Channel::network)
 401                                         .distinct()
 402                                         .filter((network) -> !networkConnections.containsKey(network))
 403                                         .collect(Collectors.toSet());
 404
 405                         if (missingNetworks.isEmpty()) {
 406                                 if (!missingChannels.isEmpty()) {
 407                                         for (Channel missingChannel : missingChannels) {
 408                                                 Network network = missingChannel.network();
 409                                                 eventBus.post(new GenericMessage(String.format("Trying to join %s on %s...", missingChannel.name(), network)));
 410                                                 try {
 411                                                         channelsBeingJoined.add(missingChannel);
 412                                                         networkConnections.get(network).joinChannel(missingChannel.name());
 413                                                 } catch (IOException ioe1) {
 414                                                         logger.warn(String.format("Could not join %s on %s!", missingChannel.name(), network.name()), ioe1);
 415                                                 }
 416                                         }
 417                                 } else {
 418                                         synchronized (syncObject) {
 419                                                 try {
 420                                                         syncObject.wait(TimeUnit.MINUTES.toMillis(1));
 421                                                 } catch (InterruptedException ie1) {
 422                                                 /* ignore. */
 423                                                 }
 424                                         }
 425                                 }
 426                                 continue;
 427                         }
 428
 429                         Map<Long, Network> timesForNextConnects = new TreeMap<>(missingNetworks.stream()
 430                                         .collect(Collectors.toMap(connectionBackoff::getBackoff, Function.identity(), (network, ignore) -> network)));
 431
 432                         Optional<Entry<Long, Network>> firstNetwork = Optional.fromNullable(timesForNextConnects.entrySet().stream().findFirst().orElse(null));
 433                         if (!firstNetwork.isPresent()) {
 434                                 continue;
 435                         }
 436                         if (firstNetwork.get().getKey() > 0) {
 437                                 eventBus.post(new GenericMessage(String.format("Waiting %d minutes to connect to %s...", TimeUnit.MILLISECONDS.toMinutes(firstNetwork.get().getKey()), firstNetwork.get().getValue().name())));
 438                                 synchronized (syncObject) {
 439                                         try {
 440                                                 syncObject.wait(firstNetwork.get().getKey());
 441                                         } catch (InterruptedException ie1) {
 442                                                 /* ignore. */
 443                                         }
 444                                 }
 445                                 if (!isRunning()) {
 446                                         break;
 447                                 }
 448                         }
 449
 450                         connectNetwork(firstNetwork.get().getValue());
 451                 }
 452         }
 453
 454         @Override
 455         protected void triggerShutdown() {
 456                 synchronized (syncObject) {
 457                         syncObject.notifyAll();
 458                 }
 459         }
 460
 461         //
 462         // PRIVATE METHODS
 463         //
 464
 465         /**
 466          * Starts a new connection for the given network if no such connection exists
 467          * already.
 468          *
 469          * @param network
 470          *              The network to connect to
 471          */
 472         private void connectNetwork(Network network) {
 473                 if (!networkConnections.containsKey(network)) {
 474                                 /* select a random server. */
 475                         List<Server> servers = Lists.newArrayList(network.servers());
 476                         if (servers.isEmpty()) {
 477                                 eventBus.post(new GenericError(String.format("Network %s does not have any servers.", network.name())));
 478                                 return;
 479                         }
 480                         Server server = servers.get((int) (Math.random() * servers.size()));
 481                         Connection connection = connectionFactory.createConnection(server.hostname(),
 482                                         server.unencryptedPorts().iterator().next());
 483                         connection.username(RandomNickname.get()).realName(RandomNickname.get());
 484                         networkConnections.put(network, connection);
 485                         connection.open();
 486                 }
 487         }
 488
 489         /**
 490          * Removes the given connection and all its channels and bots.
 491          *
 492          * @param connection
 493          *              The connection to remove
 494          */
 495         private void removeConnection(Connection connection) {
 496                 Optional<Network> network = getNetwork(connection);
 497                 if (!network.isPresent()) {
 498                         return;
 499                 }
 500                 networkConnections.remove(network.get());
 501                 if (!connection.established()) {
 502                         return;
 503                 }
 504
 505                 /* find all channels that need to be removed. */
 506                 for (Collection<Channel> channels : ImmutableList.of(joinedChannels, extraChannels)) {
 507                         for (Iterator<Channel> channelIterator = channels.iterator(); channelIterator.hasNext(); ) {
 508                                 Channel joinedChannel = channelIterator.next();
 509                                 if (!joinedChannel.network().equals(network.get())) {
 510                                         continue;
 511                                 }
 512
 513                                 channelIterator.remove();
 514                         }
 515                 }
 516
 517                 /* now remove all bots for that network. */
 518                 Map<String, Bot> bots = networkBots.row(network.get());
 519                 int botCount = bots.size();
 520                 int packCount = 0;
 521                 for (Bot bot : bots.values()) {
 522                         packCount += bot.packs().size();
 523                 }
 524                 bots.clear();
 525                 eventBus.post(new GenericMessage(String.format("Network %s disconnected, %d bots removed, %d packs removed.", network.get().name(), botCount, packCount)));
 526         }
 527
 528         //
 529         // EVENT HANDLERS
 530         //
 531
 532         /**
 533          * If a connection to a network has been established, the channels associated
 534          * with this network are joined.
 535          *
 536          * @param connectionEstablished
 537          *              The connection established event
 538          */
 539         @Subscribe
 540         public void connectionEstablished(ConnectionEstablished connectionEstablished) {
 541
 542                 /* get network for connection. */
 543                 Optional<Network> network = getNetwork(connectionEstablished.connection());
 544
 545                 /* found network? */
 546                 if (!network.isPresent()) {
 547                         eventBus.post(new GenericMessage(String.format("Connected to unknown network: %s", connectionEstablished.connection().hostname())));
 548                         return;
 549                 }
 550
 551                 connectionBackoff.connectionSuccessful(network.get());
 552                 eventBus.post(new GenericMessage(String.format("Connected to network %s.", network.get().name())));
 553
 554                 /* join all channels on this network. */
 555                 for (Channel channel : channels) {
 556                         if (channel.network().equals(network.get())) {
 557                                 try {
 558                                         eventBus.post(new GenericMessage(String.format("Trying to join %s on %s...", channel.name(), network.get().name())));
 559                                         connectionEstablished.connection().joinChannel(channel.name());
 560                                 } catch (IOException ioe1) {
 561                                         logger.warn(String.format("Could not join %s on %s!", channel.name(), network.get().name()), ioe1);
 562                                 }
 563                         }
 564                 }
 565         }
 566
 567         /**
 568          * Remove all data stored for a network if the connection is closed.
 569          *
 570          * @param connectionClosed
 571          *              The connection closed event
 572          */
 573         @Subscribe
 574         public void connectionClosed(ConnectionClosed connectionClosed) {
 575                 connectionBackoff.connectionFailed(getNetwork(connectionClosed.connection()).get());
 576                 removeConnection(connectionClosed.connection());
 577                 synchronized (syncObject) {
 578                         syncObject.notifyAll();
 579                 }
 580                 eventBus.post(new GenericMessage(String.format("Connection closed by %s.", connectionClosed.connection().hostname())));
 581         }
 582
 583         /**
 584          * Remove all data stored for a network if the connection fails.
 585          *
 586          * @param connectionFailed
 587          *              The connection failed event
 588          */
 589         @Subscribe
 590         public void connectionFailed(ConnectionFailed connectionFailed) {
 591                 connectionBackoff.connectionFailed(getNetwork(connectionFailed.connection()).get());
 592                 removeConnection(connectionFailed.connection());
 593                 synchronized (syncObject) {
 594                         syncObject.notifyAll();
 595                 }
 596                 eventBus.post(new GenericMessage(String.format("Could not connect to %s: %s.", connectionFailed.connection().hostname(), connectionFailed.cause())));
 597         }
 598
 599         /**
 600          * Shows a message when a channel was joined by us.
 601          *
 602          * @param channelJoined
 603          *              The channel joined event
 604          */
 605         @Subscribe
 606         public void channelJoined(ChannelJoined channelJoined) {
 607                 if (channelJoined.connection().isSource(channelJoined.client())) {
 608                         Optional<Network> network = getNetwork(channelJoined.connection());
 609                         if (!network.isPresent()) {
 610                                 return;
 611                         }
 612
 613                         Optional<Channel> channel = getChannel(network.get(), channelJoined.channel());
 614                         if (!channel.isPresent()) {
 615                                 /* it’s an extra channel. */
 616                                 extraChannels.add(new Channel(network.get(), channelJoined.channel()));
 617                                 logger.info(String.format("Joined extra Channel %s on %s.", channelJoined.channel(), network.get().name()));
 618                                 return;
 619                         }
 620
 621                         channelBanManager.unban(channel.get());
 622                         joinedChannels.add(channel.get());
 623                         channelsBeingJoined.remove(channel.get());
 624                         logger.info(String.format("Joined Channel %s on %s.", channelJoined.channel(), network.get().name()));
 625                 }
 626         }
 627
 628         @Subscribe
 629         public void channelNotJoined(ChannelNotJoined channelNotJoined) {
 630                 Optional<Network> network = getNetwork(channelNotJoined.connection());
 631                 if (!network.isPresent()) {
 632                         return;
 633                 }
 634
 635                 Optional<Channel> channel = getChannel(network.get(), channelNotJoined.channel());
 636                 synchronized (syncObject) {
 637                         syncObject.notifyAll();
 638                 }
 639                 if (!channel.isPresent()) {
 640                         eventBus.post(new GenericMessage(format("Could not join %s but didn’t try to join, either.", channelNotJoined.channel())));
 641                         return;
 642                 }
 643                 channelsBeingJoined.remove(channel.get());
 644
 645
 646                 /* remove all bots for this channel, we might have been kicked. */
 647                 Collection<Bot> botsToRemove = networkBots.row(network.get())
 648                                 .values().stream()
 649                                 .filter(bot -> bot.channel()
 650                                                 .equalsIgnoreCase(channel.get().name()))
 651                                 .collect(Collectors.toSet());
 652                 botsToRemove.stream()
 653                                 .forEach(bot -> networkBots.row(network.get())
 654                                                 .remove(bot.name()));
 655
 656                 if (channelNotJoined.reason() == registeredNicknamesOnly) {
 657                         channels.remove(channel.get());
 658                         eventBus.post(new GenericMessage(
 659                                         format("Not trying to join %s anymore.", channel.get())));
 660                         return;
 661                 }
 662                 if (channelNotJoined.reason() == banned) {
 663                         channelBanManager.ban(channel.get());
 664                         eventBus.post(new GenericMessage(
 665                                         format("Banned from %s, suspending join for a day.",
 666                                                         channel.get())));
 667                         return;
 668                 }
 669
 670                 eventBus.post(new GenericMessage(
 671                                 format("Could not join %s: %s", channelNotJoined.channel(),
 672                                                 channelNotJoined.reason())));
 673         }
 674
 675         /**
 676          * Removes bots that leave a channel, or channels when it’s us that’s leaving.
 677          *
 678          * @param channelLeft
 679          *              The channel left event
 680          */
 681         @Subscribe
 682         public void channelLeft(ChannelLeft channelLeft) {
 683                 Optional<Network> network = getNetwork(channelLeft.connection());
 684                 if (!network.isPresent()) {
 685                         return;
 686                 }
 687
 688                 Bot bot = networkBots.get(network.get(), channelLeft.client().nick().get());
 689                 if (bot == null) {
 690                         /* maybe it was us? */
 691                         if (channelLeft.connection().isSource(channelLeft.client())) {
 692                                 Optional<Channel> channel = getChannel(network.get(), channelLeft.channel());
 693                                 if (!channel.isPresent()) {
 694                                         /* maybe it was an extra channel? */
 695                                         channel = getExtraChannel(network.get(), channelLeft.channel());
 696                                         if (!channel.isPresent()) {
 697                                                 /* okay, whatever. */
 698                                                 return;
 699                                         }
 700
 701                                         extraChannels.remove(channel);
 702                                 } else {
 703                                         channels.remove(channel.get());
 704                                 }
 705                                 synchronized (syncObject) {
 706                                         syncObject.notifyAll();
 707                                 }
 708
 709                                 eventBus.post(new GenericMessage(String.format("Left Channel %s on %s.", channel.get().name(), channel.get().network().name())));
 710                         }
 711
 712                         return;
 713                 }
 714
 715                 networkBots.remove(network.get(), channelLeft.client().nick().get());
 716         }
 717
 718         @Subscribe
 719         public void kickedFromChannel(KickedFromChannel kickedFromChannel) {
 720                 Optional<Network> network = getNetwork(kickedFromChannel.connection());
 721                 if (!network.isPresent()) {
 722                         return;
 723                 }
 724
 725                 /* have we been kicked? */
 726                 if (nicknameMatchesConnection(kickedFromChannel.connection(), kickedFromChannel.kickee())) {
 727                         Optional<Channel> channel = getChannel(network.get(), kickedFromChannel.channel());
 728                         if (!channel.isPresent()) {
 729                                 /* maybe it was an extra channel? */
 730                                 channel = getExtraChannel(network.get(), kickedFromChannel.channel());
 731                                 if (!channel.isPresent()) {
 732                                         /* okay, whatever. */
 733                                         return;
 734                                 }
 735
 736                                 extraChannels.remove(channel.get());
 737                         } else {
 738                                 joinedChannels.remove(channel.get());
 739                         }
 740                         synchronized (syncObject) {
 741                                 syncObject.notifyAll();
 742                         }
 743                         eventBus.post(new GenericMessage(format(
 744                                         "Kicked from %s by %s: %s",
 745                                         kickedFromChannel.channel(),
 746                                         kickedFromChannel.kicker(),
 747                                         kickedFromChannel.reason().or("<unknown>")
 748                         )));
 749                 }
 750         }
 751
 752         private boolean nicknameMatchesConnection(Connection connection, String nickname) {
 753                 return connection.nickname().equalsIgnoreCase(nickname);
 754         }
 755
 756         /**
 757          * Removes a client (which may be a bot) from the table of known bots.
 758          *
 759          * @param clientQuit
 760          *              The client quit event
 761          */
 762         @Subscribe
 763         public void clientQuit(ClientQuit clientQuit) {
 764                 Optional<Network> network = getNetwork(clientQuit.connection());
 765                 if (!network.isPresent()) {
 766                         return;
 767                 }
 768
 769                 networkBots.remove(network.get(), clientQuit.client().nick().get());
 770         }
 771
 772         /**
 773          * If the nickname of a bit changes, remove it from the old name and store it
 774          * under the new name.
 775          *
 776          * @param nicknameChanged
 777          *              The nickname changed event
 778          */
 779         @Subscribe
 780         public void nicknameChanged(NicknameChanged nicknameChanged) {
 781                 Optional<Network> network = getNetwork(nicknameChanged.connection());
 782                 if (!network.isPresent()) {
 783                         return;
 784                 }
 785
 786                 Bot bot = networkBots.remove(network.get(), nicknameChanged.client().nick().get());
 787                 if (bot == null) {
 788                         return;
 789                 }
 790
 791                 networkBots.put(network.get(), nicknameChanged.newNickname(), bot);
 792         }
 793
 794         /**
 795          * If a message on a channel is received, it is parsed for pack information
 796          * with is then added to a bot.
 797          *
 798          * @param channelMessageReceived
 799          *              The channel message received event
 800          */
 801         @Subscribe
 802         public void channelMessageReceived(ChannelMessageReceived channelMessageReceived) {
 803                 String message = getDefaultInstance().clean(channelMessageReceived.message());
 804                 if (!message.startsWith("#")) {
 805                         /* most probably not a pack announcement. */
 806                         return;
 807                 }
 808
 809                 Optional<Network> network = getNetwork(channelMessageReceived.connection());
 810                 if (!network.isPresent()) {
 811                         /* message for unknown connection? */
 812                         return;
 813                 }
 814
 815                 /* parse pack information. */
 816                 Optional<Pack> pack = parsePack(message);
 817                 if (!pack.isPresent()) {
 818                         return;
 819                 }
 820
 821                 Bot bot;
 822                 synchronized (networkBots) {
 823                         if (!networkBots.contains(network.get(), channelMessageReceived.source().nick().get())) {
 824                                 bot = new Bot(network.get(), channelMessageReceived.channel(),
 825                                                 channelMessageReceived.source().nick().get());
 826                                 networkBots.put(network.get(), channelMessageReceived.source().nick().get(), bot);
 827                                 eventBus.post(new BotAdded(bot));
 828                         } else {
 829                                 bot = networkBots.get(network.get(), channelMessageReceived.source().nick().get());
 830                         }
 831                 }
 832
 833                 /* add pack. */
 834                 bot.addPack(pack.get());
 835                 logger.debug(String.format("Bot %s now has %d packs.", bot, bot.packs().size()));
 836         }
 837
 838         /**
 839          * Forward all private messages to every console.
 840          *
 841          * @param privateMessageReceived
 842          *              The private message recevied event
 843          */
 844         @Subscribe
 845         public void privateMessageReceived(PrivateMessageReceived privateMessageReceived) {
 846                 eventBus.post(new MessageReceived(privateMessageReceived.source(), privateMessageReceived.message()));
 847         }
 848
 849         /**
 850          * Sends a message to all console when a notice was received.
 851          *
 852          * @param privateNoticeReceived
 853          *              The notice received event
 854          */
 855         @Subscribe
 856         public void privateNoticeReceived(PrivateNoticeReceived privateNoticeReceived) {
 857                 Optional<Network> network = getNetwork(privateNoticeReceived.connection());
 858                 if (!network.isPresent()) {
 859                         return;
 860                 }
 861
 862                 eventBus.post(new GenericMessage(String.format("Notice from %s (%s): %s", privateNoticeReceived.source(), network.get(), privateNoticeReceived.text())));
 863         }
 864
 865         /**
 866          * Starts a DCC download.
 867          *
 868          * @param dccSendReceived
 869          *              The DCC SEND event
 870          */
 871         @Subscribe
 872         public void dccSendReceived(final DccSendReceived dccSendReceived) {
 873                 final Optional<Network> network = getNetwork(dccSendReceived.connection());
 874                 if (!network.isPresent()) {
 875                         return;
 876                 }
 877
 878                 Collection<Download> packDownloads = downloads.get(dccSendReceived.filename());
 879                 if (packDownloads.isEmpty()) {
 880                         /* unknown download, ignore. */
 881                         return;
 882                 }
 883
 884                 /* check if it’s already downloading. */
 885                 Collection<Download> runningDownloads = FluentIterable.from(packDownloads).filter(FILTER_RUNNING).toSet();
 886                 if (!runningDownloads.isEmpty()) {
 887                         eventBus.post(new GenericMessage(String.format("Ignoring offer for %s, it’s already being downloaded.", dccSendReceived.filename())));
 888                         return;
 889                 }
 890
 891                 /* locate the correct download. */
 892                 Collection<Download> requestedDownload = FluentIterable.from(packDownloads).filter(new Predicate<Download>() {
 893
 894                         @Override
 895                         public boolean apply(Download download) {
 896                                 return download.bot().network().equals(network.get()) && download.bot().name().equalsIgnoreCase(dccSendReceived.source().nick().get());
 897                         }
 898                 }).toSet();
 899
 900                 /* we did not request this download. */
 901                 if (requestedDownload.isEmpty()) {
 902                         return;
 903                 }
 904
 905                 Download download = requestedDownload.iterator().next();
 906
 907                 /* check if the file already exists. */
 908                 File outputFile = new File(temporaryDirectory, dccSendReceived.filename());
 909                 if (outputFile.exists()) {
 910                         long existingFileSize = outputFile.length();
 911
 912                         /* file already complete? */
 913                         if ((dccSendReceived.filesize() > -1) && (existingFileSize >= dccSendReceived.filesize())) {
 914                                 /* file is apparently already complete. just move it. */
 915                                 if (outputFile.renameTo(new File(finalDirectory, download.pack().name()))) {
 916                                         eventBus.post(new GenericMessage(String.format("File %s already downloaded.", download.pack().name())));
 917                                 } else {
 918                                         eventBus.post(new GenericMessage(String.format("File %s already downloaded but not moved to %s.", download.pack().name(), finalDirectory)));
 919                                 }
 920
 921                                 /* remove download. */
 922                                 downloads.removeAll(download.pack().name());
 923                                 return;
 924                         }
 925
 926                         /* file not complete yet, DCC resume it. */
 927                         try {
 928                                 download.remoteAddress(dccSendReceived.inetAddress()).filesize(dccSendReceived.filesize());
 929                                 dccSendReceived.connection().sendDccResume(dccSendReceived.source().nick().get(), dccSendReceived.filename(), dccSendReceived.port(), existingFileSize);
 930                         } catch (IOException ioe1) {
 931                                 eventBus.post(new GenericError(String.format("Could not send DCC RESUME %s to %s (%s).", dccSendReceived.filename(), dccSendReceived.source().nick().get(), ioe1.getMessage())));
 932                         }
 933
 934                         return;
 935                 }
 936
 937                 /* file does not exist, start the download. */
 938                 try {
 939                         OutputStream fileOutputStream = new FileOutputStream(outputFile);
 940                         DccReceiver dccReceiver = new DccReceiver(eventBus, dccSendReceived.inetAddress(), dccSendReceived.port(), dccSendReceived.filename(), dccSendReceived.filesize(), fileOutputStream);
 941                         download.filename(outputFile.getPath()).outputStream(fileOutputStream).dccReceiver(dccReceiver);
 942                         dccReceivers.add(dccReceiver);
 943                         dccReceiver.start();
 944                         eventBus.post(new DownloadStarted(download));
 945                 } catch (FileNotFoundException fnfe1) {
 946                         eventBus.post(new GenericError(String.format("Could not start download of %s from %s (%s).", dccSendReceived.filename(), dccSendReceived.source().nick().get(), fnfe1.getMessage())));
 947                 }
 948         }
 949
 950         @Subscribe
 951         public void dccAcceptReceived(final DccAcceptReceived dccAcceptReceived) {
 952                 final Optional<Network> network = getNetwork(dccAcceptReceived.connection());
 953                 if (!network.isPresent()) {
 954                         return;
 955                 }
 956
 957                 Collection<Download> packDownloads = downloads.get(dccAcceptReceived.filename());
 958                 if (packDownloads.isEmpty()) {
 959                         /* unknown download, ignore. */
 960                         return;
 961                 }
 962
 963                 /* check if it’s already downloading. */
 964                 Collection<Download> runningDownloads = FluentIterable.from(packDownloads).filter(FILTER_RUNNING).toSet();
 965                 if (!runningDownloads.isEmpty()) {
 966                         eventBus.post(new GenericMessage(String.format("Ignoring offer for %s, it’s already being downloaded.", dccAcceptReceived.filename())));
 967                         return;
 968                 }
 969
 970                 /* locate the correct download. */
 971                 Collection<Download> requestedDownload = FluentIterable.from(packDownloads).filter(new Predicate<Download>() {
 972
 973                         @Override
 974                         public boolean apply(Download download) {
 975                                 return download.bot().network().equals(network.get()) && download.bot().name().equalsIgnoreCase(dccAcceptReceived.source().nick().get());
 976                         }
 977                 }).toSet();
 978
 979                 /* we did not request this download. */
 980                 if (requestedDownload.isEmpty()) {
 981                         return;
 982                 }
 983
 984                 Download download = requestedDownload.iterator().next();
 985
 986                 try {
 987                         File outputFile = new File(temporaryDirectory, dccAcceptReceived.filename());
 988                         if (outputFile.length() != dccAcceptReceived.position()) {
 989                                 eventBus.post(new GenericError(String.format("Download %s from %s does not start at the right position!")));
 990                                 logger.warn(String.format("Download %s from %s: have %d bytes but wants to resume from %d!", dccAcceptReceived.filename(), dccAcceptReceived.source(), outputFile.length(), dccAcceptReceived.position()));
 991
 992                                 downloads.removeAll(download.pack().name());
 993                                 return;
 994                         }
 995                         OutputStream outputStream = new FileOutputStream(outputFile, true);
 996                         DccReceiver dccReceiver = new DccReceiver(eventBus, download.remoteAddress(), dccAcceptReceived.port(), dccAcceptReceived.filename(), dccAcceptReceived.position(), download.filesize(), outputStream);
 997                         download.filename(outputFile.getPath()).outputStream(outputStream).dccReceiver(dccReceiver);
 998                         dccReceivers.add(dccReceiver);
 999                         dccReceiver.start();
1000                         eventBus.post(new DownloadStarted(download));
1001                 } catch (FileNotFoundException fnfe1) {
1002                 }
1003         }
1004
1005         /**
1006          * Closes the output stream of the download and moves the file to the final
1007          * location.
1008          *
1009          * @param dccDownloadFinished
1010          *              The DCC download finished event
1011          */
1012         @Subscribe
1013         public void dccDownloadFinished(DccDownloadFinished dccDownloadFinished) {
1014
1015                 /* locate the correct download. */
1016                 Collection<Download> requestedDownload = FluentIterable.from(downloads.get(dccDownloadFinished.dccReceiver().filename())).filter(FILTER_RUNNING).toSet();
1017                 if (requestedDownload.isEmpty()) {
1018                         /* this seems wrong. */
1019                         logger.warn("Download finished but could not be located.");
1020                         return;
1021                 }
1022                 Download download = requestedDownload.iterator().next();
1023
1024                 try {
1025                         download.outputStream().close();
1026                         File file = new File(download.filename());
1027                         file.renameTo(new File(finalDirectory, download.pack().name()));
1028                         eventBus.post(new DownloadFinished(download));
1029                         dccReceivers.remove(dccDownloadFinished.dccReceiver());
1030                         downloads.removeAll(download.pack().name());
1031                 } catch (IOException ioe1) {
1032                         /* TODO - handle all the errors. */
1033                         logger.warn(String.format("Could not move file %s to directory %s.", download.filename(), finalDirectory), ioe1);
1034                 }
1035         }
1036
1037         /**
1038          * Closes the output stream and notifies all listeners of the failure.
1039          *
1040          * @param dccDownloadFailed
1041          *              The DCC download failed event
1042          */
1043         @Subscribe
1044         public void dccDownloadFailed(DccDownloadFailed dccDownloadFailed) {
1045
1046                 /* locate the correct download. */
1047                 Collection<Download> requestedDownload = FluentIterable.from(downloads.get(dccDownloadFailed.dccReceiver().filename())).filter(FILTER_RUNNING).toSet();
1048                 if (requestedDownload.isEmpty()) {
1049                         /* this seems wrong. */
1050                         logger.warn("Download finished but could not be located.");
1051                         return;
1052                 }
1053                 Download download = requestedDownload.iterator().next();
1054
1055                 try {
1056                         Closeables.close(download.outputStream(), true);
1057                         eventBus.post(new DownloadFailed(download));
1058                         dccReceivers.remove(dccDownloadFailed.dccReceiver());
1059                         downloads.removeAll(download.pack().name());
1060                 } catch (IOException ioe1) {
1061                         /* swallow silently. */
1062                 }
1063         }
1064
1065         @Subscribe
1066         public void replyReceived(ReplyReceived replyReceived) {
1067                 logger.trace(String.format("%s: %s", replyReceived.connection().hostname(), replyReceived.reply()));
1068         }
1069
1070         //
1071         // PRIVATE METHODS
1072         //
1073
1074         /**
1075          * Returns the download of the given pack from the given bot.
1076          *
1077          * @param pack
1078          *              The pack being downloaded
1079          * @param bot
1080          *              The bot the pack is being downloaded from
1081          * @return The download, or {@link Optional#absent()} if the download could not
1082          *         be found
1083          */
1084         private Optional<Download> getDownload(Pack pack, Bot bot) {
1085                 if (!downloads.containsKey(pack.name())) {
1086                         return Optional.absent();
1087                 }
1088                 for (Download download : Lists.newArrayList(downloads.get(pack.name()))) {
1089                         if (download.bot().equals(bot)) {
1090                                 return Optional.of(download);
1091                         }
1092                 }
1093                 return Optional.absent();
1094         }
1095
1096         /**
1097          * Searches all current connections for the given connection, returning the
1098          * associated network.
1099          *
1100          * @param connection
1101          *              The connection to get the network for
1102          * @return The network belonging to the connection, or {@link
1103          *         Optional#absent()}
1104          */
1105         private Optional<Network> getNetwork(Connection connection) {
1106                 for (Entry<Network, Connection> networkConnectionEntry : networkConnections.entrySet()) {
1107                         if (networkConnectionEntry.getValue().equals(connection)) {
1108                                 return Optional.of(networkConnectionEntry.getKey());
1109                         }
1110                 }
1111                 return Optional.absent();
1112         }
1113
1114         /**
1115          * Returns the configured channel for the given network and name.
1116          *
1117          * @param network
1118          *              The network the channel is located on
1119          * @param channelName
1120          *              The name of the channel
1121          * @return The configured channel, or {@link Optional#absent()} if no
1122          *         configured channel matching the given network and name was found
1123          */
1124         public Optional<Channel> getChannel(Network network, String channelName) {
1125                 for (Channel channel : channels) {
1126                         if (channel.network().equals(network) && (channel.name().equalsIgnoreCase(channelName))) {
1127                                 return Optional.of(channel);
1128                         }
1129                 }
1130                 return Optional.absent();
1131         }
1132
1133         /**
1134          * Returns the extra channel for the given network and name.
1135          *
1136          * @param network
1137          *              The network the channel is located on
1138          * @param channelName
1139          *              The name of the channel
1140          * @return The extra channel, or {@link Optional#absent()} if no extra channel
1141          *         matching the given network and name was found
1142          */
1143         public Optional<Channel> getExtraChannel(Network network, String channelName) {
1144                 for (Channel channel : extraChannels) {
1145                         if (channel.network().equals(network) && (channel.name().equalsIgnoreCase(channelName))) {
1146                                 return Optional.of(channel);
1147                         }
1148                 }
1149                 return Optional.absent();
1150         }
1151
1152         /**
1153          * Parses {@link Pack} information from the given message.
1154          *
1155          * @param message
1156          *              The message to parse pack information from
1157          * @return The parsed pack, or {@link Optional#absent()} if the message could
1158          *         not be parsed into a pack
1159          */
1160         private Optional<Pack> parsePack(String message) {
1161                 int squareOpen = message.indexOf('[');
1162                 int squareClose = message.indexOf(']', squareOpen);
1163                 if ((squareOpen == -1) && (squareClose == -1)) {
1164                         return Optional.absent();
1165                 }
1166                 String packSize = message.substring(squareOpen + 1, squareClose);
1167                 String packName = message.substring(message.lastIndexOf(' ') + 1);
1168                 String packIndex = message.substring(0, message.indexOf(' ')).substring(1);
1169                 return Optional.of(new Pack(packIndex, packSize, packName));
1170         }
1171
1172 }