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