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.ReplyReceived;
63 import net.pterodactylus.irc.event.UnknownReplyReceived;
64 import net.pterodactylus.irc.util.RandomNickname;
65 import net.pterodactylus.xdcc.util.io.BandwidthCountingInputStream;
66 import net.pterodactylus.xdcc.util.io.BandwidthCountingOutputStream;
68 import com.google.common.base.Optional;
69 import com.google.common.collect.Maps;
70 import com.google.common.collect.Sets;
71 import com.google.common.eventbus.EventBus;
72 import com.google.common.io.Closeables;
73 import com.google.common.primitives.Ints;
74 import com.google.common.primitives.Longs;
75 import com.google.common.util.concurrent.AbstractExecutionThreadService;
76 import com.google.common.util.concurrent.Service;
79 * A connection to an IRC server.
81 * @author <a href="mailto:bombe@pterodactylus.net">David āBombeā Roden</a>
83 public class Connection extends AbstractExecutionThreadService implements Service {
86 private static final Logger logger = Logger.getLogger(Connection.class.getName());
89 private final EventBus eventBus;
91 /** The socket factory. */
92 private final SocketFactory socketFactory;
94 /** The hostname to connect to. */
95 private final String hostname;
97 /** The port to connect to. */
98 private final int port;
100 /** The nickname chooser. */
101 private NicknameChooser nicknameChooser = new NicknameChooser() {
104 public String getNickname() {
105 return RandomNickname.get();
110 private String nickname = null;
113 private Optional<String> username = Optional.absent();
115 /** The real name. */
116 private Optional<String> realName = Optional.absent();
118 /** The optional password for the connection. */
119 private Optional<String> password = Optional.absent();
121 /** The connection handler. */
122 private ConnectionHandler connectionHandler;
124 /** Whether the connection has already been established. */
125 private boolean established;
128 * Creates a new connection.
132 * @param socketFactory
135 * The hostname of the IRC server
137 * The port number of the IRC server
139 public Connection(EventBus eventBus, SocketFactory socketFactory, String hostname, int port) {
140 this.eventBus = eventBus;
141 this.socketFactory = socketFactory;
142 this.hostname = hostname;
151 * Returns the hostname of the remote end of the connection.
153 * @return The remoteās hostname
155 public String hostname() {
160 * Returns the port number of the remote end of the connection.
162 * @return The remoteās port number
169 * Returns whether this connection has already been established.
171 * @return {@code true} as long as this connection is established, {@code
174 public boolean established() {
179 * Returns the nickname that is currently in use by this connection. The
180 * nickname is only available once the connection has been {@link #start()}ed.
182 * @return The current nickname
184 public String nickname() {
193 * Sets the nickname chooser. The nickname chooser is only used during the
194 * creation of the connection.
196 * @param nicknameChooser
197 * The nickname chooser
198 * @return This connection
200 public Connection nicknameChooser(NicknameChooser nicknameChooser) {
201 this.nicknameChooser = nicknameChooser;
206 * Sets the username to use.
209 * The username to use
210 * @return This connection
212 public Connection username(String username) {
213 this.username = Optional.fromNullable(username);
218 * Sets the real name to use.
221 * The real name to use
222 * @return This connection
224 public Connection realName(String realName) {
225 this.realName = Optional.fromNullable(realName);
230 * Sets the optional password for the connection.
233 * The password for the connection
234 * @return This connection
236 public Connection password(String password) {
237 this.password = Optional.fromNullable(password);
246 * Returns the current rate of the connectionās incoming side.
248 * @return The current input rate (in bytes per second)
250 public long getInputRate() {
251 return (connectionHandler != null) ? connectionHandler.getInputRate() : 0;
255 * Returns the current rate of the connectionās outgoing side.
257 * @return The current output rate (in bytes per second)
259 public long getOutputRate() {
260 return (connectionHandler != null) ? connectionHandler.getOutputRate() : 0;
264 * Checks whether the given source is the client represented by this
268 * The source to check
269 * @return {@code true} if this connection represents the given source, {@code
272 public boolean isSource(Source source) {
273 return source.nick().isPresent() && source.nick().get().equals(nickname);
277 * Joins the given channel.
280 * The channel to join
281 * @throws IOException
282 * if an I/O error occurs
284 public void joinChannel(final String channel) throws IOException {
285 connectionHandler.sendCommand("JOIN", channel);
289 * Sends a message to the given recipient, which may be a channel or another
293 * The recipient of the message
296 * @throws IOException
297 * if an I/O error occurs
299 public void sendMessage(String recipient, String message) throws IOException {
300 connectionHandler.sendCommand("PRIVMSG", recipient, message);
304 * Sends a DCC RESUME request to the given recipient.
307 * The recipient of the request
309 * The name of the file to resume
311 * The port number from the original DCC SEND request
313 * The position at which to resume the transfer
314 * @throws IOException
315 * if an I/O error occurs
317 public void sendDccResume(String recipient, String filename, int port, long position) throws IOException {
318 connectionHandler.sendCommand("PRIVMSG", recipient, String.format("\u0001DCC RESUME %s %d %d\u0001", filename, port, position));
322 * Closes this connection.
324 * @throws IOException
325 * if an I/O error occurs
327 public void close() throws IOException {
328 connectionHandler.close();
332 // ABSTRACTEXECUTIONTHREADSERVICE METHODS
336 protected void startUp() throws IllegalStateException {
337 checkState(username.isPresent(), "username must be set");
338 checkState(realName.isPresent(), "realName must be set");
342 protected void run() {
344 /* connect to remote socket. */
346 Socket socket = socketFactory.createSocket(hostname, port);
347 connectionHandler = new ConnectionHandler(socket.getInputStream(), socket.getOutputStream());
349 /* register connection. */
350 if (password.isPresent()) {
351 connectionHandler.sendCommand("PASSWORD", password.get());
353 connectionHandler.sendCommand("USER", username.get(), "8", "*", realName.get());
354 nickname = nicknameChooser.getNickname();
355 connectionHandler.sendCommand("NICK", nickname);
357 } catch (IOException ioe1) {
358 eventBus.post(new ConnectionFailed(this, ioe1));
362 /* now read replies and react. */
364 /* some status variables. */
365 int oldConnectionStatus = 0;
366 int connectionStatus = 0;
367 boolean connected = true;
368 StringBuilder motd = new StringBuilder();
369 Set<Nickname> nicks = Sets.newHashSet();
372 Map<String, String> nickPrefixes = Maps.newHashMap();
373 Set<Character> channelTypes = Sets.newHashSet();
376 Reply reply = connectionHandler.readReply();
377 eventBus.post(new ReplyReceived(this, reply));
378 logger.finest(String.format("<< %s", reply));
379 String command = reply.command();
380 List<String> parameters = reply.parameters();
382 /* most common events. */
383 if (command.equalsIgnoreCase("PRIVMSG")) {
384 String recipient = parameters.get(0);
385 String message = parameters.get(1);
386 if (message.startsWith("\u0001") && message.endsWith("\u0001")) {
388 handleCtcp(reply.source().get(), message);
389 } else if (!channelTypes.contains(recipient.charAt(0))) {
390 eventBus.post(new PrivateMessageReceived(this, reply.source().get(), message));
392 eventBus.post(new ChannelMessageReceived(this, recipient, reply.source().get(), message));
395 } else if (command.equalsIgnoreCase("NOTICE")) {
396 String recipient = parameters.get(0);
397 String message = parameters.get(1);
398 if (message.startsWith("\u0001") && message.endsWith("\u0001")) {
400 handleCtcp(reply.source().get(), message);
401 } else if (!channelTypes.contains(recipient.charAt(0))) {
402 eventBus.post(new PrivateNoticeReceived(this, reply));
404 eventBus.post(new ChannelNoticeReceived(this, reply.source().get(), recipient, message));
407 /* 43x replies are for nick change errors. */
408 } else if (command.equals("431")) {
409 eventBus.post(new NoNicknameGivenReceived(this, reply));
410 } else if (command.equals("433")) {
411 if (connectionStatus == 0) {
412 nickname = nicknameChooser.getNickname();
413 connectionHandler.sendCommand("NICK", nickname);
415 eventBus.post(new NicknameInUseReceived(this, reply));
419 } else if (command.equalsIgnoreCase("NICK")) {
420 eventBus.post(new NicknameChanged(this, reply.source().get(), parameters.get(0)));
423 } else if (command.equalsIgnoreCase("JOIN")) {
424 eventBus.post(new ChannelJoined(this, parameters.get(0), reply.source().get()));
425 } else if (command.equals("331")) {
426 /* no topic is set. */
427 } else if (command.equals("332")) {
428 eventBus.post(new ChannelTopic(this, parameters.get(1), parameters.get(2)));
429 } else if (command.equals("353")) {
430 for (String nickname : parameters.get(3).split(" ")) {
431 if (nickPrefixes.containsKey(nickname.substring(0, 1))) {
432 nicks.add(new Nickname(nickname.substring(1), nickname.substring(0, 1)));
434 nicks.add(new Nickname(nickname, ""));
437 } else if (command.equals("366")) {
438 eventBus.post(new ChannelNicknames(this, parameters.get(1), nicks));
440 } else if (command.equalsIgnoreCase("PART")) {
441 eventBus.post(new ChannelLeft(this, parameters.get(0), reply.source().get(), getOptional(parameters, 1)));
442 } else if (command.equalsIgnoreCase("QUIT")) {
443 eventBus.post(new ClientQuit(this, reply.source().get(), parameters.get(0)));
445 /* common channel join errors. */
446 } else if (command.equals("474")) {
447 eventBus.post(new ChannelNotJoined(this, parameters.get(1), Reason.banned));
448 } else if (command.equals("473")) {
449 eventBus.post(new ChannelNotJoined(this, parameters.get(1), Reason.inviteOnly));
450 } else if (command.equals("475")) {
451 eventBus.post(new ChannelNotJoined(this, parameters.get(1), Reason.badChannelKey));
453 /* basic connection housekeeping. */
454 } else if (command.equalsIgnoreCase("PING")) {
455 connectionHandler.sendCommand("PONG", getOptional(parameters, 0), getOptional(parameters, 1));
457 /* replies 001-004 donāt hold information but they have to be sent on a successful connection. */
458 } else if (command.equals("001")) {
459 connectionStatus |= 0x01;
460 } else if (command.equals("002")) {
461 connectionStatus |= 0x02;
462 } else if (command.equals("003")) {
463 connectionStatus |= 0x04;
464 } else if (command.equals("004")) {
465 connectionStatus |= 0x08;
467 /* 005 originally was a bounce message, now used to transmit useful information about the server. */
468 } else if (command.equals("005")) {
469 for (String parameter : parameters) {
470 if (parameter.startsWith("PREFIX=")) {
471 int openParen = parameter.indexOf('(');
472 int closeParen = parameter.indexOf(')');
473 if ((openParen != -1) && (closeParen != -1)) {
474 for (int modeCharacterIndex = 1; modeCharacterIndex < (closeParen - openParen); ++modeCharacterIndex) {
475 char modeCharacter = parameter.charAt(openParen + modeCharacterIndex);
476 char modeSymbol = parameter.charAt(closeParen + modeCharacterIndex);
477 nickPrefixes.put(String.valueOf(modeSymbol), String.valueOf(modeCharacter));
479 logger.fine(String.format("Parsed Prefixes: %s", nickPrefixes));
481 } else if (parameter.startsWith("CHANTYPES=")) {
482 for (int typeIndex = 10; typeIndex < parameter.length(); ++typeIndex) {
483 channelTypes.add(parameter.charAt(typeIndex));
485 logger.fine(String.format("Parsed Channel Types: %s", channelTypes));
489 /* 375, 372, and 376 handle the serverās MOTD. */
490 } else if (command.equals("375")) {
492 motd.append(parameters.get(1)).append('\n');
493 } else if (command.equals("372")) {
494 motd.append(parameters.get(1)).append('\n');
495 } else if (command.equals("376")) {
496 motd.append(parameters.get(1)).append('\n');
497 eventBus.post(new MotdReceived(this, motd.toString()));
500 /* okay, everything else. */
502 eventBus.post(new UnknownReplyReceived(this, reply));
505 if ((connectionStatus == 0x0f) && (connectionStatus != oldConnectionStatus)) {
506 /* connection succeeded! */
508 eventBus.post(new ConnectionEstablished(this));
510 oldConnectionStatus = connectionStatus;
512 eventBus.post(new ConnectionClosed(this));
513 } catch (IOException ioe1) {
514 logger.log(Level.WARNING, "I/O error", ioe1);
515 eventBus.post(new ConnectionClosed(this, ioe1));
516 } catch (RuntimeException re1) {
517 logger.log(Level.SEVERE, "Runtime error", re1);
518 eventBus.post(new ConnectionClosed(this, re1));
521 logger.info("Closing Connection.");
523 Closeables.close(connectionHandler, true);
524 } catch (IOException ioe1) {
525 /* will not be thrown. */
536 * Handles a CTCP message.
539 * The client sending the message
543 private void handleCtcp(Source client, String message) {
544 String[] messageWords = message.substring(1, message.length() - 1).split(" +");
545 String ctcpCommand = messageWords[0];
546 if (ctcpCommand.equalsIgnoreCase("DCC")) {
547 if (messageWords[1].equalsIgnoreCase("SEND")) {
548 Optional<InetAddress> inetAddress = parseInetAddress(messageWords[3]);
549 Optional<Integer> port = Optional.fromNullable(Ints.tryParse(messageWords[4]));
550 long fileSize = Optional.fromNullable(Longs.tryParse(messageWords[5])).or(-1L);
551 if (inetAddress.isPresent() && port.isPresent()) {
552 eventBus.post(new DccSendReceived(this, client, messageWords[2], inetAddress.get(), port.get(), fileSize));
554 logger.warning(String.format("Received malformed DCC SEND: ā%sā", message));
556 } else if (messageWords[1].equalsIgnoreCase("ACCEPT")) {
557 Optional<Integer> port = Optional.fromNullable(Ints.tryParse(messageWords[3]));
558 long position = (messageWords.length > 4) ? Optional.fromNullable(Longs.tryParse(messageWords[4])).or(-1L) : -1;
559 if (port.isPresent()) {
560 eventBus.post(new DccAcceptReceived(this, client, messageWords[2], port.get(), position));
562 logger.warning(String.format("Received malformed DCC ACCEPT: ā%sā", message));
569 * Returns an item from the list, or {@link Optional#absent()} if the list is
570 * shorter than required for the given index.
573 * The list to get an item from
575 * The index of the item
577 * The type of the list items
578 * @return This list item wrapped in an {@link Optional}, or {@link
579 * Optional#absent()} if the list is not long enough
581 private static <T> Optional<T> getOptional(List<T> list, int index) {
582 if (index < list.size()) {
583 return Optional.fromNullable(list.get(index));
585 return Optional.absent();
589 * Parses the given {@code ip} and returns an {@link InetAddress} from it.
593 * @return The parsed inet address, or {@link Optional#absent()} if no inet
594 * address could be parsed
596 private Optional<InetAddress> parseInetAddress(String ip) {
597 Long ipNumber = Longs.tryParse(ip);
598 if (ipNumber == null) {
599 return Optional.absent();
602 StringBuilder hostname = new StringBuilder(15);
603 hostname.append((ipNumber >>> 24) & 0xff).append('.');
604 hostname.append((ipNumber >>> 16) & 0xff).append('.');
605 hostname.append((ipNumber >>> 8) & 0xff).append('.');
606 hostname.append(ipNumber & 0xff);
608 return Optional.of(InetAddress.getByName(hostname.toString()));
609 } catch (UnknownHostException uhe1) {
610 return Optional.absent();
614 /** Handles input and output for the connection. */
615 private class ConnectionHandler implements Closeable {
617 /** The output stream of the connection. */
618 private final BandwidthCountingOutputStream outputStream;
620 /** The input stream. */
621 private final BandwidthCountingInputStream inputStream;
623 /** The input stream of the connection. */
624 private final BufferedReader inputStreamReader;
627 * Creates a new connection handler for the given input stream and output
631 * The input stream of the connection
632 * @param outputStream
633 * The output stream of the connection
634 * @throws UnsupportedEncodingException
635 * if the encoding (currently āUTF-8ā) is not valid
637 private ConnectionHandler(InputStream inputStream, OutputStream outputStream) throws UnsupportedEncodingException {
638 this.outputStream = new BandwidthCountingOutputStream(outputStream, 5, SECONDS);
639 this.inputStream = new BandwidthCountingInputStream(inputStream, 5, SECONDS);
640 inputStreamReader = new BufferedReader(new InputStreamReader(this.inputStream, "UTF-8"));
648 * Returns the current rate of the connectionās incoming side.
650 * @return The current input rate (in bytes per second)
652 public long getInputRate() {
653 return inputStream.getCurrentRate();
657 * Returns the current rate of the connectionās outgoing side.
659 * @return The current output rate (in bytes per second)
661 public long getOutputRate() {
662 return outputStream.getCurrentRate();
666 * Sends a command with the given parameters, skipping all {@link
667 * Optional#absent()} optionals.
670 * The command to send
673 * @throws IOException
674 * if an I/O error occurs
676 public void sendCommand(String command, Optional<String>... parameters) throws IOException {
677 List<String> setParameters = new ArrayList<String>();
678 for (Optional<String> maybeSetParameter : parameters) {
679 if (maybeSetParameter.isPresent()) {
680 setParameters.add(maybeSetParameter.get());
683 sendCommand(command, setParameters.toArray(new String[setParameters.size()]));
687 * Sends a command with the given parameters.
690 * The command to send
692 * The parameters of the command
693 * @throws IOException
694 * if an I/O error occurs
695 * @throws IllegalArgumentException
696 * if any parameter but that last contains a space character
698 public void sendCommand(String command, String... parameters) throws IOException, IllegalArgumentException {
699 StringBuilder commandBuilder = new StringBuilder();
701 commandBuilder.append(command);
702 for (int parameterIndex = 0; parameterIndex < parameters.length; ++parameterIndex) {
703 String parameter = parameters[parameterIndex];
704 /* space is only allowed in the last parameter. */
705 commandBuilder.append(' ');
706 if (parameter.contains(" ")) {
707 if (parameterIndex == (parameters.length - 1)) {
708 commandBuilder.append(':');
710 throw new IllegalArgumentException(String.format("parameter ā%sā must not contain space!", parameter));
713 commandBuilder.append(parameter);
716 logger.finest(String.format(">> %s", commandBuilder));
717 outputStream.write((commandBuilder.toString() + "\r\n").getBytes("UTF-8"));
718 outputStream.flush();
722 * Reads a line of reply from the connection.
725 * @throws IOException
726 * if an I/O error occurs
727 * @throws EOFException
730 public Reply readReply() throws IOException, EOFException {
731 String line = inputStreamReader.readLine();
733 throw new EOFException();
736 return Reply.parseLine(line);
744 public void close() throws IOException {
745 Closeables.close(outputStream, true);
746 Closeables.close(inputStreamReader, true);