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.Arrays.asList;
22 import static java.util.concurrent.TimeUnit.SECONDS;
24 import java.io.BufferedReader;
25 import java.io.Closeable;
26 import java.io.EOFException;
27 import java.io.IOException;
28 import java.io.InputStream;
29 import java.io.InputStreamReader;
30 import java.io.OutputStream;
31 import java.io.UnsupportedEncodingException;
32 import java.net.InetAddress;
33 import java.net.Socket;
34 import java.net.UnknownHostException;
35 import java.util.ArrayList;
36 import java.util.List;
38 import java.util.concurrent.TimeUnit;
39 import java.util.concurrent.atomic.AtomicBoolean;
41 import javax.net.SocketFactory;
43 import net.pterodactylus.irc.connection.ChannelNotJoinedHandler;
44 import net.pterodactylus.irc.connection.ConnectionEstablishHandler;
45 import net.pterodactylus.irc.connection.Handler;
46 import net.pterodactylus.irc.connection.MotdHandler;
47 import net.pterodactylus.irc.connection.PrefixHandler;
48 import net.pterodactylus.irc.event.ChannelJoined;
49 import net.pterodactylus.irc.event.ChannelLeft;
50 import net.pterodactylus.irc.event.ChannelMessageReceived;
51 import net.pterodactylus.irc.event.ChannelNicknames;
52 import net.pterodactylus.irc.event.ChannelNoticeReceived;
53 import net.pterodactylus.irc.event.ChannelTopic;
54 import net.pterodactylus.irc.event.ClientQuit;
55 import net.pterodactylus.irc.event.ConnectionClosed;
56 import net.pterodactylus.irc.event.ConnectionEstablished;
57 import net.pterodactylus.irc.event.ConnectionFailed;
58 import net.pterodactylus.irc.event.DccAcceptReceived;
59 import net.pterodactylus.irc.event.DccSendReceived;
60 import net.pterodactylus.irc.event.KickedFromChannel;
61 import net.pterodactylus.irc.event.NicknameChanged;
62 import net.pterodactylus.irc.event.NicknameInUseReceived;
63 import net.pterodactylus.irc.event.NoNicknameGivenReceived;
64 import net.pterodactylus.irc.event.PrivateMessageReceived;
65 import net.pterodactylus.irc.event.PrivateNoticeReceived;
66 import net.pterodactylus.irc.event.ReplyReceived;
67 import net.pterodactylus.irc.event.UnknownReplyReceived;
68 import net.pterodactylus.irc.util.RandomNickname;
69 import net.pterodactylus.xdcc.util.io.BandwidthCountingInputStream;
70 import net.pterodactylus.xdcc.util.io.BandwidthCountingOutputStream;
72 import com.google.common.base.Optional;
73 import com.google.common.collect.Sets;
74 import com.google.common.eventbus.EventBus;
75 import com.google.common.eventbus.Subscribe;
76 import com.google.common.io.Closeables;
77 import com.google.common.primitives.Ints;
78 import com.google.common.primitives.Longs;
79 import com.google.common.util.concurrent.AbstractExecutionThreadService;
80 import com.google.common.util.concurrent.Service;
81 import org.apache.log4j.Logger;
84 * A connection to an IRC server.
86 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
88 public class Connection extends AbstractExecutionThreadService implements Service {
91 private static final Logger logger = Logger.getLogger(Connection.class.getName());
94 private final EventBus eventBus;
96 /** The socket factory. */
97 private final SocketFactory socketFactory;
99 /** The hostname to connect to. */
100 private final String hostname;
102 /** The port to connect to. */
103 private final int port;
105 /** The nickname chooser. */
106 private NicknameChooser nicknameChooser = new NicknameChooser() {
109 public String getNickname() {
110 return RandomNickname.get();
115 private String nickname = null;
118 private Optional<String> username = Optional.absent();
120 /** The real name. */
121 private Optional<String> realName = Optional.absent();
123 /** The optional password for the connection. */
124 private Optional<String> password = Optional.absent();
126 /** The connection handler. */
127 private ConnectionHandler connectionHandler;
129 /** Whether the connection has already been established. */
130 private final AtomicBoolean established = new AtomicBoolean();
133 * Creates a new connection.
137 * @param socketFactory
140 * The hostname of the IRC server
142 * The port number of the IRC server
144 public Connection(EventBus eventBus, SocketFactory socketFactory, String hostname, int port) {
145 this.eventBus = eventBus;
146 this.socketFactory = socketFactory;
147 this.hostname = hostname;
156 * Returns the hostname of the remote end of the connection.
158 * @return The remote’s hostname
160 public String hostname() {
165 * Returns the port number of the remote end of the connection.
167 * @return The remote’s port number
174 * Returns whether this connection has already been established.
176 * @return {@code true} as long as this connection is established, {@code
179 public boolean established() {
180 return established.get();
184 * Returns the nickname that is currently in use by this connection. The
185 * nickname is only available once the connection has been {@link #start()}ed.
187 * @return The current nickname
189 public String nickname() {
198 * Sets the nickname chooser. The nickname chooser is only used during the
199 * creation of the connection.
201 * @param nicknameChooser
202 * The nickname chooser
203 * @return This connection
205 public Connection nicknameChooser(NicknameChooser nicknameChooser) {
206 this.nicknameChooser = nicknameChooser;
211 * Sets the username to use.
214 * The username to use
215 * @return This connection
217 public Connection username(String username) {
218 this.username = Optional.fromNullable(username);
223 * Sets the real name to use.
226 * The real name to use
227 * @return This connection
229 public Connection realName(String realName) {
230 this.realName = Optional.fromNullable(realName);
235 * Sets the optional password for the connection.
238 * The password for the connection
239 * @return This connection
241 public Connection password(String password) {
242 this.password = Optional.fromNullable(password);
251 * Returns the current rate of the connection’s incoming side.
253 * @return The current input rate (in bytes per second)
255 public long getInputRate() {
256 return (connectionHandler != null) ? connectionHandler.getInputRate() : 0;
260 * Returns the current rate of the connection’s outgoing side.
262 * @return The current output rate (in bytes per second)
264 public long getOutputRate() {
265 return (connectionHandler != null) ? connectionHandler.getOutputRate() : 0;
269 * Checks whether the given source is the client represented by this
273 * The source to check
274 * @return {@code true} if this connection represents the given source, {@code
277 public boolean isSource(Source source) {
278 return source.nick().isPresent() && source.nick().get().equals(nickname);
282 * Joins the given channel.
285 * The channel to join
286 * @throws IOException
287 * if an I/O error occurs
289 public void joinChannel(final String channel) throws IOException {
290 connectionHandler.sendCommand("JOIN", channel);
294 * Sends a message to the given recipient, which may be a channel or another
298 * The recipient of the message
301 * @throws IOException
302 * if an I/O error occurs
304 public void sendMessage(String recipient, String message) throws IOException {
305 connectionHandler.sendCommand("PRIVMSG", recipient, message);
309 * Sends a DCC RESUME request to the given recipient.
312 * The recipient of the request
314 * The name of the file to resume
316 * The port number from the original DCC SEND request
318 * The position at which to resume the transfer
319 * @throws IOException
320 * if an I/O error occurs
322 public void sendDccResume(String recipient, String filename, int port, long position) throws IOException {
323 connectionHandler.sendCommand("PRIVMSG", recipient, String.format("\u0001DCC RESUME %s %d %d\u0001", filename, port, position));
327 * Closes this connection.
329 * @throws IOException
330 * if an I/O error occurs
332 public void close() throws IOException {
333 if (connectionHandler != null) {
334 connectionHandler.close();
339 // ABSTRACTEXECUTIONTHREADSERVICE METHODS
343 protected void startUp() throws IllegalStateException {
344 checkState(username.isPresent(), "username must be set");
345 checkState(realName.isPresent(), "realName must be set");
349 protected void run() {
351 /* connect to remote socket. */
353 Socket socket = socketFactory.createSocket(hostname, port);
354 socket.setSoTimeout((int) TimeUnit.MINUTES.toMillis(3));
355 connectionHandler = new ConnectionHandler(socket.getInputStream(), socket.getOutputStream());
357 /* register connection. */
358 if (password.isPresent()) {
359 connectionHandler.sendCommand("PASSWORD", password.get());
361 connectionHandler.sendCommand("USER", username.get(), "8", "*", realName.get());
362 nickname = nicknameChooser.getNickname();
363 connectionHandler.sendCommand("NICK", nickname);
365 } catch (IOException ioe1) {
366 eventBus.post(new ConnectionFailed(this, ioe1));
370 eventBus.register(this);
371 /* now read replies and react. */
373 /* some status variables. */
374 boolean connected = true;
375 Set<Nickname> nicks = Sets.newHashSet();
377 PrefixHandler prefixHandler = new PrefixHandler();
378 List<Handler> handlers = asList(
379 new MotdHandler(eventBus, this),
380 new ChannelNotJoinedHandler(eventBus, this),
381 new ConnectionEstablishHandler(eventBus, this),
386 Reply reply = connectionHandler.readReply();
387 eventBus.post(new ReplyReceived(this, reply));
388 logger.trace(String.format("<< %s", reply));
389 String command = reply.command();
390 List<String> parameters = reply.parameters();
392 for (Handler handler : handlers) {
393 if (handler.willHandle(reply)) {
394 handler.handleReply(reply);
399 /* most common events. */
400 if (command.equalsIgnoreCase("PRIVMSG")) {
401 String recipient = parameters.get(0);
402 String message = parameters.get(1);
403 if (message.startsWith("\u0001") && message.endsWith("\u0001")) {
405 handleCtcp(reply.source().get(), message);
406 } else if (!prefixHandler.isChannel(recipient)) {
407 eventBus.post(new PrivateMessageReceived(this, reply.source().get(), message));
409 eventBus.post(new ChannelMessageReceived(this, recipient, reply.source().get(), message));
412 } else if (command.equalsIgnoreCase("NOTICE")) {
413 String recipient = parameters.get(0);
414 String message = parameters.get(1);
415 if (message.startsWith("\u0001") && message.endsWith("\u0001")) {
417 handleCtcp(reply.source().get(), message);
418 } else if (!prefixHandler.isChannel(recipient)) {
419 eventBus.post(new PrivateNoticeReceived(this, reply));
421 eventBus.post(new ChannelNoticeReceived(this, reply.source().get(), recipient, message));
424 /* 43x replies are for nick change errors. */
425 } else if (command.equals("431")) {
426 eventBus.post(new NoNicknameGivenReceived(this, reply));
427 } else if (command.equals("433")) {
428 if (!established.get()) {
429 nickname = nicknameChooser.getNickname();
430 connectionHandler.sendCommand("NICK", nickname);
432 eventBus.post(new NicknameInUseReceived(this, reply));
436 } else if (command.equalsIgnoreCase("NICK")) {
437 eventBus.post(new NicknameChanged(this, reply.source().get(), parameters.get(0)));
440 } else if (command.equalsIgnoreCase("JOIN")) {
441 eventBus.post(new ChannelJoined(this, parameters.get(0), reply.source().get()));
442 } else if (command.equals("331")) {
443 /* no topic is set. */
444 } else if (command.equals("332")) {
445 eventBus.post(new ChannelTopic(this, parameters.get(1), parameters.get(2)));
446 } else if (command.equals("353")) {
447 for (String nickname : parameters.get(3).split(" ")) {
448 if (prefixHandler.isNickPrefixed(nickname)) {
449 nicks.add(new Nickname(nickname.substring(1), nickname.substring(0, 1)));
451 nicks.add(new Nickname(nickname, ""));
454 } else if (command.equals("366")) {
455 eventBus.post(new ChannelNicknames(this, parameters.get(1), nicks));
457 } else if (command.equalsIgnoreCase("PART")) {
458 eventBus.post(new ChannelLeft(this, parameters.get(0), reply.source().get(), getOptional(parameters, 1)));
459 } else if (command.equalsIgnoreCase("QUIT")) {
460 eventBus.post(new ClientQuit(this, reply.source().get(), parameters.get(0)));
462 /* basic connection housekeeping. */
463 } else if (command.equalsIgnoreCase("PING")) {
464 connectionHandler.sendCommand("PONG", getOptional(parameters, 0), getOptional(parameters, 1));
466 } else if (command.equalsIgnoreCase("KICK")) {
467 eventBus.post(new KickedFromChannel(this, parameters.get(0), reply.source().get(), parameters.get(1), getOptional(parameters, 2)));
469 /* okay, everything else. */
471 eventBus.post(new UnknownReplyReceived(this, reply));
474 eventBus.post(new ConnectionClosed(this));
475 } catch (IOException ioe1) {
476 logger.warn("I/O error", ioe1);
477 eventBus.post(new ConnectionClosed(this, ioe1));
478 } catch (RuntimeException re1) {
479 logger.error("Runtime error", re1);
480 eventBus.post(new ConnectionClosed(this, re1));
482 established.set(false);
483 eventBus.unregister(this);
484 logger.info("Closing Connection.");
486 Closeables.close(connectionHandler, true);
487 } catch (IOException ioe1) {
488 /* will not be thrown. */
495 public void connectionEstablished(ConnectionEstablished connectionEstablished) {
496 if (connectionEstablished.connection() == this) {
497 established.set(true);
506 * Handles a CTCP message.
509 * The client sending the message
513 private void handleCtcp(Source client, String message) {
514 String[] messageWords = message.substring(1, message.length() - 1).split(" +");
515 String ctcpCommand = messageWords[0];
516 if (ctcpCommand.equalsIgnoreCase("DCC")) {
517 if (messageWords[1].equalsIgnoreCase("SEND")) {
518 Optional<InetAddress> inetAddress = parseInetAddress(messageWords[3]);
519 Optional<Integer> port = Optional.fromNullable(Ints.tryParse(messageWords[4]));
520 long fileSize = Optional.fromNullable(Longs.tryParse(messageWords[5])).or(-1L);
521 if (inetAddress.isPresent() && port.isPresent()) {
522 eventBus.post(new DccSendReceived(this, client, messageWords[2], inetAddress.get(), port.get(), fileSize));
524 logger.warn(String.format("Received malformed DCC SEND: “%s”", message));
526 } else if (messageWords[1].equalsIgnoreCase("ACCEPT")) {
527 Optional<Integer> port = Optional.fromNullable(Ints.tryParse(messageWords[3]));
528 long position = (messageWords.length > 4) ? Optional.fromNullable(Longs.tryParse(messageWords[4])).or(-1L) : -1;
529 if (port.isPresent()) {
530 eventBus.post(new DccAcceptReceived(this, client, messageWords[2], port.get(), position));
532 logger.warn(String.format("Received malformed DCC ACCEPT: “%s”", message));
539 * Returns an item from the list, or {@link Optional#absent()} if the list is
540 * shorter than required for the given index.
543 * The list to get an item from
545 * The index of the item
547 * The type of the list items
548 * @return This list item wrapped in an {@link Optional}, or {@link
549 * Optional#absent()} if the list is not long enough
551 private static <T> Optional<T> getOptional(List<T> list, int index) {
552 if (index < list.size()) {
553 return Optional.fromNullable(list.get(index));
555 return Optional.absent();
559 * Parses the given {@code ip} and returns an {@link InetAddress} from it.
563 * @return The parsed inet address, or {@link Optional#absent()} if no inet
564 * address could be parsed
566 private Optional<InetAddress> parseInetAddress(String ip) {
567 Long ipNumber = Longs.tryParse(ip);
568 if (ipNumber == null) {
569 return Optional.absent();
572 StringBuilder hostname = new StringBuilder(15);
573 hostname.append((ipNumber >>> 24) & 0xff).append('.');
574 hostname.append((ipNumber >>> 16) & 0xff).append('.');
575 hostname.append((ipNumber >>> 8) & 0xff).append('.');
576 hostname.append(ipNumber & 0xff);
578 return Optional.of(InetAddress.getByName(hostname.toString()));
579 } catch (UnknownHostException uhe1) {
580 return Optional.absent();
584 /** Handles input and output for the connection. */
585 private class ConnectionHandler implements Closeable {
587 /** The output stream of the connection. */
588 private final BandwidthCountingOutputStream outputStream;
590 /** The input stream. */
591 private final BandwidthCountingInputStream inputStream;
593 /** The input stream of the connection. */
594 private final BufferedReader inputStreamReader;
597 * Creates a new connection handler for the given input stream and output
601 * The input stream of the connection
602 * @param outputStream
603 * The output stream of the connection
604 * @throws UnsupportedEncodingException
605 * if the encoding (currently “UTF-8”) is not valid
607 private ConnectionHandler(InputStream inputStream, OutputStream outputStream) throws UnsupportedEncodingException {
608 this.outputStream = new BandwidthCountingOutputStream(outputStream, 5, SECONDS);
609 this.inputStream = new BandwidthCountingInputStream(inputStream, 5, SECONDS);
610 inputStreamReader = new BufferedReader(new InputStreamReader(this.inputStream, "UTF-8"));
618 * Returns the current rate of the connection’s incoming side.
620 * @return The current input rate (in bytes per second)
622 public long getInputRate() {
623 return inputStream.getCurrentRate();
627 * Returns the current rate of the connection’s outgoing side.
629 * @return The current output rate (in bytes per second)
631 public long getOutputRate() {
632 return outputStream.getCurrentRate();
636 * Sends a command with the given parameters, skipping all {@link
637 * Optional#absent()} optionals.
640 * The command to send
643 * @throws IOException
644 * if an I/O error occurs
646 public void sendCommand(String command, Optional<String>... parameters) throws IOException {
647 List<String> setParameters = new ArrayList<String>();
648 for (Optional<String> maybeSetParameter : parameters) {
649 if (maybeSetParameter.isPresent()) {
650 setParameters.add(maybeSetParameter.get());
653 sendCommand(command, setParameters.toArray(new String[setParameters.size()]));
657 * Sends a command with the given parameters.
660 * The command to send
662 * The parameters of the command
663 * @throws IOException
664 * if an I/O error occurs
665 * @throws IllegalArgumentException
666 * if any parameter but that last contains a space character
668 public void sendCommand(String command, String... parameters) throws IOException, IllegalArgumentException {
669 StringBuilder commandBuilder = new StringBuilder();
671 commandBuilder.append(command);
672 for (int parameterIndex = 0; parameterIndex < parameters.length; ++parameterIndex) {
673 String parameter = parameters[parameterIndex];
674 /* space is only allowed in the last parameter. */
675 commandBuilder.append(' ');
676 if (parameter.contains(" ")) {
677 if (parameterIndex == (parameters.length - 1)) {
678 commandBuilder.append(':');
680 throw new IllegalArgumentException(String.format("parameter “%s” must not contain space!", parameter));
683 commandBuilder.append(parameter);
686 logger.trace(String.format(">> %s", commandBuilder));
687 outputStream.write((commandBuilder.toString() + "\r\n").getBytes("UTF-8"));
688 outputStream.flush();
692 * Reads a line of reply from the connection.
695 * @throws IOException
696 * if an I/O error occurs
697 * @throws EOFException
700 public Reply readReply() throws IOException, EOFException {
701 String line = inputStreamReader.readLine();
703 throw new EOFException();
706 return Reply.parseLine(line);
714 public void close() throws IOException {
715 Closeables.close(outputStream, true);
716 Closeables.close(inputStreamReader, true);
717 Closeables.close(inputStream, true);