2 * XdccDownloader - Connection.java - Copyright © 2013 David Roden
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.
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.
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/>.
18 package net.pterodactylus.irc;
20 import static com.google.common.base.Preconditions.checkState;
21 import static java.util.concurrent.TimeUnit.SECONDS;
23 import java.io.BufferedReader;
24 import java.io.Closeable;
25 import java.io.EOFException;
26 import java.io.IOException;
27 import java.io.InputStream;
28 import java.io.InputStreamReader;
29 import java.io.OutputStream;
30 import java.io.UnsupportedEncodingException;
31 import java.net.InetAddress;
32 import java.net.Socket;
33 import java.net.UnknownHostException;
34 import java.util.ArrayList;
35 import java.util.List;
38 import java.util.logging.Level;
39 import java.util.logging.Logger;
40 import javax.net.SocketFactory;
42 import net.pterodactylus.irc.event.ChannelJoined;
43 import net.pterodactylus.irc.event.ChannelLeft;
44 import net.pterodactylus.irc.event.ChannelMessageReceived;
45 import net.pterodactylus.irc.event.ChannelNicknames;
46 import net.pterodactylus.irc.event.ChannelNotJoined;
47 import net.pterodactylus.irc.event.ChannelNotJoined.Reason;
48 import net.pterodactylus.irc.event.ChannelNoticeReceived;
49 import net.pterodactylus.irc.event.ChannelTopic;
50 import net.pterodactylus.irc.event.ClientQuit;
51 import net.pterodactylus.irc.event.ConnectionClosed;
52 import net.pterodactylus.irc.event.ConnectionEstablished;
53 import net.pterodactylus.irc.event.ConnectionFailed;
54 import net.pterodactylus.irc.event.DccAcceptReceived;
55 import net.pterodactylus.irc.event.DccSendReceived;
56 import net.pterodactylus.irc.event.MotdReceived;
57 import net.pterodactylus.irc.event.NicknameChanged;
58 import net.pterodactylus.irc.event.NicknameInUseReceived;
59 import net.pterodactylus.irc.event.NoNicknameGivenReceived;
60 import net.pterodactylus.irc.event.PrivateMessageReceived;
61 import net.pterodactylus.irc.event.PrivateNoticeReceived;
62 import net.pterodactylus.irc.event.UnknownReplyReceived;
63 import net.pterodactylus.irc.util.RandomNickname;
64 import net.pterodactylus.xdcc.util.io.BandwidthCountingInputStream;
65 import net.pterodactylus.xdcc.util.io.BandwidthCountingOutputStream;
67 import com.google.common.base.Optional;
68 import com.google.common.collect.Maps;
69 import com.google.common.collect.Sets;
70 import com.google.common.eventbus.EventBus;
71 import com.google.common.io.Closeables;
72 import com.google.common.primitives.Ints;
73 import com.google.common.primitives.Longs;
74 import com.google.common.util.concurrent.AbstractExecutionThreadService;
75 import com.google.common.util.concurrent.Service;
78 * A connection to an IRC server.
80 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
82 public class Connection extends AbstractExecutionThreadService implements Service {
85 private static final Logger logger = Logger.getLogger(Connection.class.getName());
88 private final EventBus eventBus;
90 /** The socket factory. */
91 private final SocketFactory socketFactory;
93 /** The hostname to connect to. */
94 private final String hostname;
96 /** The port to connect to. */
97 private final int port;
99 /** The nickname chooser. */
100 private NicknameChooser nicknameChooser = new NicknameChooser() {
103 public String getNickname() {
104 return RandomNickname.get();
109 private String nickname = null;
112 private Optional<String> username = Optional.absent();
114 /** The real name. */
115 private Optional<String> realName = Optional.absent();
117 /** The optional password for the connection. */
118 private Optional<String> password = Optional.absent();
120 /** The connection handler. */
121 private ConnectionHandler connectionHandler;
123 /** Whether the connection has already been established. */
124 private boolean established;
127 * Creates a new connection.
131 * @param socketFactory
134 * The hostname of the IRC server
136 * The port number of the IRC server
138 public Connection(EventBus eventBus, SocketFactory socketFactory, String hostname, int port) {
139 this.eventBus = eventBus;
140 this.socketFactory = socketFactory;
141 this.hostname = hostname;
150 * Returns the hostname of the remote end of the connection.
152 * @return The remote’s hostname
154 public String hostname() {
159 * Returns the port number of the remote end of the connection.
161 * @return The remote’s port number
168 * Returns whether this connection has already been established.
170 * @return {@code true} as long as this connection is established, {@code
173 public boolean established() {
178 * Returns the nickname that is currently in use by this connection. The
179 * nickname is only available once the connection has been {@link #start()}ed.
181 * @return The current nickname
183 public String nickname() {
192 * Sets the nickname chooser. The nickname chooser is only used during the
193 * creation of the connection.
195 * @param nicknameChooser
196 * The nickname chooser
197 * @return This connection
199 public Connection nicknameChooser(NicknameChooser nicknameChooser) {
200 this.nicknameChooser = nicknameChooser;
205 * Sets the username to use.
208 * The username to use
209 * @return This connection
211 public Connection username(String username) {
212 this.username = Optional.fromNullable(username);
217 * Sets the real name to use.
220 * The real name to use
221 * @return This connection
223 public Connection realName(String realName) {
224 this.realName = Optional.fromNullable(realName);
229 * Sets the optional password for the connection.
232 * The password for the connection
233 * @return This connection
235 public Connection password(String password) {
236 this.password = Optional.fromNullable(password);
245 * Returns the current rate of the connection’s incoming side.
247 * @return The current input rate (in bytes per second)
249 public long getInputRate() {
250 return (connectionHandler != null) ? connectionHandler.getInputRate() : 0;
254 * Returns the current rate of the connection’s outgoing side.
256 * @return The current output rate (in bytes per second)
258 public long getOutputRate() {
259 return (connectionHandler != null) ? connectionHandler.getOutputRate() : 0;
263 * Checks whether the given source is the client represented by this
267 * The source to check
268 * @return {@code true} if this connection represents the given source, {@code
271 public boolean isSource(Source source) {
272 return source.nick().isPresent() && source.nick().get().equals(nickname);
276 * Joins the given channel.
279 * The channel to join
280 * @throws IOException
281 * if an I/O error occurs
283 public void joinChannel(final String channel) throws IOException {
284 connectionHandler.sendCommand("JOIN", channel);
288 * Sends a message to the given recipient, which may be a channel or another
292 * The recipient of the message
295 * @throws IOException
296 * if an I/O error occurs
298 public void sendMessage(String recipient, String message) throws IOException {
299 connectionHandler.sendCommand("PRIVMSG", recipient, message);
303 * Sends a DCC RESUME request to the given recipient.
306 * The recipient of the request
308 * The name of the file to resume
310 * The port number from the original DCC SEND request
312 * The position at which to resume the transfer
313 * @throws IOException
314 * if an I/O error occurs
316 public void sendDccResume(String recipient, String filename, int port, long position) throws IOException {
317 connectionHandler.sendCommand("PRIVMSG", recipient, String.format("\u0001DCC RESUME %s %d %d\u0001", filename, port, position));
321 * Closes this connection.
323 * @throws IOException
324 * if an I/O error occurs
326 public void close() throws IOException {
327 connectionHandler.close();
331 // ABSTRACTEXECUTIONTHREADSERVICE METHODS
335 protected void startUp() throws IllegalStateException {
336 checkState(username.isPresent(), "username must be set");
337 checkState(realName.isPresent(), "realName must be set");
341 protected void run() {
343 /* connect to remote socket. */
345 Socket socket = socketFactory.createSocket(hostname, port);
346 connectionHandler = new ConnectionHandler(socket.getInputStream(), socket.getOutputStream());
348 /* register connection. */
349 if (password.isPresent()) {
350 connectionHandler.sendCommand("PASSWORD", password.get());
352 connectionHandler.sendCommand("USER", username.get(), "8", "*", realName.get());
353 nickname = nicknameChooser.getNickname();
354 connectionHandler.sendCommand("NICK", nickname);
356 } catch (IOException ioe1) {
357 eventBus.post(new ConnectionFailed(this, ioe1));
361 /* now read replies and react. */
363 /* some status variables. */
364 int oldConnectionStatus = 0;
365 int connectionStatus = 0;
366 boolean connected = true;
367 StringBuilder motd = new StringBuilder();
368 Set<Nickname> nicks = Sets.newHashSet();
371 Map<String, String> nickPrefixes = Maps.newHashMap();
372 Set<Character> channelTypes = Sets.newHashSet();
375 Reply reply = connectionHandler.readReply();
376 logger.finest(String.format("<< %s", reply));
377 String command = reply.command();
378 List<String> parameters = reply.parameters();
380 /* most common events. */
381 if (command.equalsIgnoreCase("PRIVMSG")) {
382 String recipient = parameters.get(0);
383 String message = parameters.get(1);
384 if (message.startsWith("\u0001") && message.endsWith("\u0001")) {
386 handleCtcp(reply.source().get(), message);
387 } else if (!channelTypes.contains(recipient.charAt(0))) {
388 eventBus.post(new PrivateMessageReceived(this, reply.source().get(), message));
390 eventBus.post(new ChannelMessageReceived(this, recipient, reply.source().get(), message));
393 } else if (command.equalsIgnoreCase("NOTICE")) {
394 String recipient = parameters.get(0);
395 String message = parameters.get(1);
396 if (message.startsWith("\u0001") && message.endsWith("\u0001")) {
398 handleCtcp(reply.source().get(), message);
399 } else if (!channelTypes.contains(recipient.charAt(0))) {
400 eventBus.post(new PrivateNoticeReceived(this, reply));
402 eventBus.post(new ChannelNoticeReceived(this, reply.source().get(), recipient, message));
405 /* 43x replies are for nick change errors. */
406 } else if (command.equals("431")) {
407 eventBus.post(new NoNicknameGivenReceived(this, reply));
408 } else if (command.equals("433")) {
409 if (connectionStatus == 0) {
410 nickname = nicknameChooser.getNickname();
411 connectionHandler.sendCommand("NICK", nickname);
413 eventBus.post(new NicknameInUseReceived(this, reply));
417 } else if (command.equalsIgnoreCase("NICK")) {
418 eventBus.post(new NicknameChanged(this, reply.source().get(), parameters.get(0)));
421 } else if (command.equalsIgnoreCase("JOIN")) {
422 eventBus.post(new ChannelJoined(this, parameters.get(0), reply.source().get()));
423 } else if (command.equals("331")) {
424 /* no topic is set. */
425 } else if (command.equals("332")) {
426 eventBus.post(new ChannelTopic(this, parameters.get(1), parameters.get(2)));
427 } else if (command.equals("353")) {
428 for (String nickname : parameters.get(3).split(" ")) {
429 if (nickPrefixes.containsKey(nickname.substring(0, 1))) {
430 nicks.add(new Nickname(nickname.substring(1), nickname.substring(0, 1)));
432 nicks.add(new Nickname(nickname, ""));
435 } else if (command.equals("366")) {
436 eventBus.post(new ChannelNicknames(this, parameters.get(1), nicks));
438 } else if (command.equalsIgnoreCase("PART")) {
439 eventBus.post(new ChannelLeft(this, parameters.get(0), reply.source().get(), getOptional(parameters, 1)));
440 } else if (command.equalsIgnoreCase("QUIT")) {
441 eventBus.post(new ClientQuit(this, reply.source().get(), parameters.get(0)));
443 /* common channel join errors. */
444 } else if (command.equals("474")) {
445 eventBus.post(new ChannelNotJoined(this, parameters.get(1), Reason.banned));
446 } else if (command.equals("473")) {
447 eventBus.post(new ChannelNotJoined(this, parameters.get(1), Reason.inviteOnly));
448 } else if (command.equals("475")) {
449 eventBus.post(new ChannelNotJoined(this, parameters.get(1), Reason.badChannelKey));
451 /* basic connection housekeeping. */
452 } else if (command.equalsIgnoreCase("PING")) {
453 connectionHandler.sendCommand("PONG", getOptional(parameters, 0), getOptional(parameters, 1));
455 /* replies 001-004 don’t hold information but they have to be sent on a successful connection. */
456 } else if (command.equals("001")) {
457 connectionStatus |= 0x01;
458 } else if (command.equals("002")) {
459 connectionStatus |= 0x02;
460 } else if (command.equals("003")) {
461 connectionStatus |= 0x04;
462 } else if (command.equals("004")) {
463 connectionStatus |= 0x08;
465 /* 005 originally was a bounce message, now used to transmit useful information about the server. */
466 } else if (command.equals("005")) {
467 for (String parameter : parameters) {
468 if (parameter.startsWith("PREFIX=")) {
469 int openParen = parameter.indexOf('(');
470 int closeParen = parameter.indexOf(')');
471 if ((openParen != -1) && (closeParen != -1)) {
472 for (int modeCharacterIndex = 1; modeCharacterIndex < (closeParen - openParen); ++modeCharacterIndex) {
473 char modeCharacter = parameter.charAt(openParen + modeCharacterIndex);
474 char modeSymbol = parameter.charAt(closeParen + modeCharacterIndex);
475 nickPrefixes.put(String.valueOf(modeSymbol), String.valueOf(modeCharacter));
477 logger.fine(String.format("Parsed Prefixes: %s", nickPrefixes));
479 } else if (parameter.startsWith("CHANTYPES=")) {
480 for (int typeIndex = 10; typeIndex < parameter.length(); ++typeIndex) {
481 channelTypes.add(parameter.charAt(typeIndex));
483 logger.fine(String.format("Parsed Channel Types: %s", channelTypes));
487 /* 375, 372, and 376 handle the server’s MOTD. */
488 } else if (command.equals("375")) {
490 motd.append(parameters.get(1)).append('\n');
491 } else if (command.equals("372")) {
492 motd.append(parameters.get(1)).append('\n');
493 } else if (command.equals("376")) {
494 motd.append(parameters.get(1)).append('\n');
495 eventBus.post(new MotdReceived(this, motd.toString()));
498 /* okay, everything else. */
500 eventBus.post(new UnknownReplyReceived(this, reply));
503 if ((connectionStatus == 0x0f) && (connectionStatus != oldConnectionStatus)) {
504 /* connection succeeded! */
506 eventBus.post(new ConnectionEstablished(this));
508 oldConnectionStatus = connectionStatus;
510 eventBus.post(new ConnectionClosed(this));
511 } catch (IOException ioe1) {
512 logger.log(Level.WARNING, "I/O error", ioe1);
513 eventBus.post(new ConnectionClosed(this, ioe1));
514 } catch (RuntimeException re1) {
515 logger.log(Level.SEVERE, "Runtime error", re1);
516 eventBus.post(new ConnectionClosed(this, re1));
519 logger.info("Closing Connection.");
521 Closeables.close(connectionHandler, true);
522 } catch (IOException ioe1) {
523 /* will not be thrown. */
534 * Handles a CTCP message.
537 * The client sending the message
541 private void handleCtcp(Source client, String message) {
542 String[] messageWords = message.substring(1, message.length() - 1).split(" +");
543 String ctcpCommand = messageWords[0];
544 if (ctcpCommand.equalsIgnoreCase("DCC")) {
545 if (messageWords[1].equalsIgnoreCase("SEND")) {
546 Optional<InetAddress> inetAddress = parseInetAddress(messageWords[3]);
547 Optional<Integer> port = Optional.fromNullable(Ints.tryParse(messageWords[4]));
548 long fileSize = Optional.fromNullable(Longs.tryParse(messageWords[5])).or(-1L);
549 if (inetAddress.isPresent() && port.isPresent()) {
550 eventBus.post(new DccSendReceived(this, client, messageWords[2], inetAddress.get(), port.get(), fileSize));
552 logger.warning(String.format("Received malformed DCC SEND: “%s”", message));
554 } else if (messageWords[1].equalsIgnoreCase("ACCEPT")) {
555 Optional<Integer> port = Optional.fromNullable(Ints.tryParse(messageWords[3]));
556 long position = (messageWords.length > 4) ? Optional.fromNullable(Longs.tryParse(messageWords[4])).or(-1L) : -1;
557 if (port.isPresent()) {
558 eventBus.post(new DccAcceptReceived(this, client, messageWords[2], port.get(), position));
560 logger.warning(String.format("Received malformed DCC ACCEPT: “%s”", message));
567 * Returns an item from the list, or {@link Optional#absent()} if the list is
568 * shorter than required for the given index.
571 * The list to get an item from
573 * The index of the item
575 * The type of the list items
576 * @return This list item wrapped in an {@link Optional}, or {@link
577 * Optional#absent()} if the list is not long enough
579 private static <T> Optional<T> getOptional(List<T> list, int index) {
580 if (index < list.size()) {
581 return Optional.fromNullable(list.get(index));
583 return Optional.absent();
587 * Parses the given {@code ip} and returns an {@link InetAddress} from it.
591 * @return The parsed inet address, or {@link Optional#absent()} if no inet
592 * address could be parsed
594 private Optional<InetAddress> parseInetAddress(String ip) {
595 Long ipNumber = Longs.tryParse(ip);
596 if (ipNumber == null) {
597 return Optional.absent();
600 StringBuilder hostname = new StringBuilder(15);
601 hostname.append((ipNumber >>> 24) & 0xff).append('.');
602 hostname.append((ipNumber >>> 16) & 0xff).append('.');
603 hostname.append((ipNumber >>> 8) & 0xff).append('.');
604 hostname.append(ipNumber & 0xff);
606 return Optional.of(InetAddress.getByName(hostname.toString()));
607 } catch (UnknownHostException uhe1) {
608 return Optional.absent();
612 /** Handles input and output for the connection. */
613 private class ConnectionHandler implements Closeable {
615 /** The output stream of the connection. */
616 private final BandwidthCountingOutputStream outputStream;
618 /** The input stream. */
619 private final BandwidthCountingInputStream inputStream;
621 /** The input stream of the connection. */
622 private final BufferedReader inputStreamReader;
625 * Creates a new connection handler for the given input stream and output
629 * The input stream of the connection
630 * @param outputStream
631 * The output stream of the connection
632 * @throws UnsupportedEncodingException
633 * if the encoding (currently “UTF-8”) is not valid
635 private ConnectionHandler(InputStream inputStream, OutputStream outputStream) throws UnsupportedEncodingException {
636 this.outputStream = new BandwidthCountingOutputStream(outputStream, 5, SECONDS);
637 this.inputStream = new BandwidthCountingInputStream(inputStream, 5, SECONDS);
638 inputStreamReader = new BufferedReader(new InputStreamReader(this.inputStream, "UTF-8"));
646 * Returns the current rate of the connection’s incoming side.
648 * @return The current input rate (in bytes per second)
650 public long getInputRate() {
651 return inputStream.getCurrentRate();
655 * Returns the current rate of the connection’s outgoing side.
657 * @return The current output rate (in bytes per second)
659 public long getOutputRate() {
660 return outputStream.getCurrentRate();
664 * Sends a command with the given parameters, skipping all {@link
665 * Optional#absent()} optionals.
668 * The command to send
671 * @throws IOException
672 * if an I/O error occurs
674 public void sendCommand(String command, Optional<String>... parameters) throws IOException {
675 List<String> setParameters = new ArrayList<String>();
676 for (Optional<String> maybeSetParameter : parameters) {
677 if (maybeSetParameter.isPresent()) {
678 setParameters.add(maybeSetParameter.get());
681 sendCommand(command, setParameters.toArray(new String[setParameters.size()]));
685 * Sends a command with the given parameters.
688 * The command to send
690 * The parameters of the command
691 * @throws IOException
692 * if an I/O error occurs
693 * @throws IllegalArgumentException
694 * if any parameter but that last contains a space character
696 public void sendCommand(String command, String... parameters) throws IOException, IllegalArgumentException {
697 StringBuilder commandBuilder = new StringBuilder();
699 commandBuilder.append(command);
700 for (int parameterIndex = 0; parameterIndex < parameters.length; ++parameterIndex) {
701 String parameter = parameters[parameterIndex];
702 /* space is only allowed in the last parameter. */
703 commandBuilder.append(' ');
704 if (parameter.contains(" ")) {
705 if (parameterIndex == (parameters.length - 1)) {
706 commandBuilder.append(':');
708 throw new IllegalArgumentException(String.format("parameter “%s” must not contain space!", parameter));
711 commandBuilder.append(parameter);
714 logger.finest(String.format(">> %s", commandBuilder));
715 outputStream.write((commandBuilder.toString() + "\r\n").getBytes("UTF-8"));
716 outputStream.flush();
720 * Reads a line of reply from the connection.
723 * @throws IOException
724 * if an I/O error occurs
725 * @throws EOFException
728 public Reply readReply() throws IOException, EOFException {
729 String line = inputStreamReader.readLine();
731 throw new EOFException();
734 return Reply.parseLine(line);
742 public void close() throws IOException {
743 Closeables.close(outputStream, true);
744 Closeables.close(inputStreamReader, true);