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;
22 import java.io.BufferedReader;
23 import java.io.Closeable;
24 import java.io.EOFException;
25 import java.io.IOException;
26 import java.io.InputStream;
27 import java.io.InputStreamReader;
28 import java.io.OutputStream;
29 import java.io.UnsupportedEncodingException;
30 import java.net.InetAddress;
31 import java.net.Socket;
32 import java.net.UnknownHostException;
33 import java.util.ArrayList;
34 import java.util.List;
37 import java.util.logging.Level;
38 import java.util.logging.Logger;
39 import javax.net.SocketFactory;
41 import net.pterodactylus.irc.event.ChannelJoined;
42 import net.pterodactylus.irc.event.ChannelLeft;
43 import net.pterodactylus.irc.event.ChannelMessageReceived;
44 import net.pterodactylus.irc.event.ChannelNicknames;
45 import net.pterodactylus.irc.event.ChannelNotJoined;
46 import net.pterodactylus.irc.event.ChannelNotJoined.Reason;
47 import net.pterodactylus.irc.event.ChannelTopic;
48 import net.pterodactylus.irc.event.ClientQuit;
49 import net.pterodactylus.irc.event.ConnectionClosed;
50 import net.pterodactylus.irc.event.ConnectionEstablished;
51 import net.pterodactylus.irc.event.ConnectionFailed;
52 import net.pterodactylus.irc.event.DccAcceptReceived;
53 import net.pterodactylus.irc.event.DccSendReceived;
54 import net.pterodactylus.irc.event.MotdReceived;
55 import net.pterodactylus.irc.event.NicknameChanged;
56 import net.pterodactylus.irc.event.NicknameInUseReceived;
57 import net.pterodactylus.irc.event.NoNicknameGivenReceived;
58 import net.pterodactylus.irc.event.PrivateMessageReceived;
59 import net.pterodactylus.irc.event.UnknownReplyReceived;
60 import net.pterodactylus.irc.util.RandomNickname;
62 import com.google.common.base.Optional;
63 import com.google.common.collect.Maps;
64 import com.google.common.collect.Sets;
65 import com.google.common.eventbus.EventBus;
66 import com.google.common.io.Closeables;
67 import com.google.common.primitives.Ints;
68 import com.google.common.primitives.Longs;
69 import com.google.common.util.concurrent.AbstractExecutionThreadService;
70 import com.google.common.util.concurrent.Service;
73 * A connection to an IRC server.
75 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
77 public class Connection extends AbstractExecutionThreadService implements Service {
80 private static final Logger logger = Logger.getLogger(Connection.class.getName());
83 private final EventBus eventBus;
85 /** The socket factory. */
86 private final SocketFactory socketFactory;
88 /** The hostname to connect to. */
89 private final String hostname;
91 /** The port to connect to. */
92 private final int port;
94 /** The nickname chooser. */
95 private NicknameChooser nicknameChooser = new NicknameChooser() {
98 public String getNickname() {
99 return RandomNickname.get();
104 private String nickname = null;
107 private Optional<String> username = Optional.absent();
109 /** The real name. */
110 private Optional<String> realName = Optional.absent();
112 /** The optional password for the connection. */
113 private Optional<String> password = Optional.absent();
115 /** The connection handler. */
116 private ConnectionHandler connectionHandler;
118 /** Whether the connection has already been established. */
119 private boolean established;
122 * Creates a new connection.
126 * @param socketFactory
129 * The hostname of the IRC server
131 * The port number of the IRC server
133 public Connection(EventBus eventBus, SocketFactory socketFactory, String hostname, int port) {
134 this.eventBus = eventBus;
135 this.socketFactory = socketFactory;
136 this.hostname = hostname;
145 * Returns whether this connection has already been established.
147 * @return {@code true} as long as this connection is established, {@code
150 public boolean established() {
155 * Returns the nickname that is currently in use by this connection. The
156 * nickname is only available once the connection has been {@link #start()}ed.
158 * @return The current nickname
160 public String nickname() {
169 * Sets the nickname chooser. The nickname chooser is only used during the
170 * creation of the connection.
172 * @param nicknameChooser
173 * The nickname chooser
174 * @return This connection
176 public Connection nicknameChooser(NicknameChooser nicknameChooser) {
177 this.nicknameChooser = nicknameChooser;
182 * Sets the username to use.
185 * The username to use
186 * @return This connection
188 public Connection username(String username) {
189 this.username = Optional.fromNullable(username);
194 * Sets the real name to use.
197 * The real name to use
198 * @return This connection
200 public Connection realName(String realName) {
201 this.realName = Optional.fromNullable(realName);
206 * Sets the optional password for the connection.
209 * The password for the connection
210 * @return This connection
212 public Connection password(String password) {
213 this.password = Optional.fromNullable(password);
222 * Checks whether the given source is the client represented by this
226 * The source to check
227 * @return {@code true} if this connection represents the given source, {@code
230 public boolean isSource(Source source) {
231 return source.nick().isPresent() && source.nick().get().equals(nickname);
235 * Joins the given channel.
238 * The channel to join
239 * @throws IOException
240 * if an I/O error occurs
242 public void joinChannel(final String channel) throws IOException {
243 connectionHandler.sendCommand("JOIN", channel);
247 * Sends a message to the given recipient, which may be a channel or another
251 * The recipient of the message
254 * @throws IOException
255 * if an I/O error occurs
257 public void sendMessage(String recipient, String message) throws IOException {
258 connectionHandler.sendCommand("PRIVMSG", recipient, message);
262 * Sends a DCC RESUME request to the given recipient.
265 * The recipient of the request
267 * The name of the file to resume
269 * The port number from the original DCC SEND request
271 * The position at which to resume the transfer
272 * @throws IOException
273 * if an I/O error occurs
275 public void sendDccResume(String recipient, String filename, int port, long position) throws IOException {
276 connectionHandler.sendCommand("PRIVMSG", recipient, String.format("\u0001DCC RESUME %s %d %d\u0001", filename, port, position));
280 // ABSTRACTEXECUTIONTHREADSERVICE METHODS
284 protected void startUp() throws IllegalStateException {
285 checkState(username.isPresent(), "username must be set");
286 checkState(realName.isPresent(), "realName must be set");
290 protected void run() {
292 /* connect to remote socket. */
294 Socket socket = socketFactory.createSocket(hostname, port);
295 connectionHandler = new ConnectionHandler(socket.getInputStream(), socket.getOutputStream());
297 /* register connection. */
298 if (password.isPresent()) {
299 connectionHandler.sendCommand("PASSWORD", password.get());
301 connectionHandler.sendCommand("USER", username.get(), "8", "*", realName.get());
302 nickname = nicknameChooser.getNickname();
303 connectionHandler.sendCommand("NICK", nickname);
305 } catch (IOException ioe1) {
306 eventBus.post(new ConnectionFailed(this, ioe1));
310 /* now read replies and react. */
312 /* some status variables. */
313 int oldConnectionStatus = 0;
314 int connectionStatus = 0;
315 boolean connected = true;
316 StringBuilder motd = new StringBuilder();
317 Set<Nickname> nicks = Sets.newHashSet();
320 Map<String, String> nickPrefixes = Maps.newHashMap();
321 Set<Character> channelTypes = Sets.newHashSet();
324 Reply reply = connectionHandler.readReply();
325 logger.finest(String.format("<< %s", reply));
326 String command = reply.command();
327 List<String> parameters = reply.parameters();
329 /* most common events. */
330 if (command.equalsIgnoreCase("PRIVMSG")) {
331 String recipient = parameters.get(0);
332 String message = parameters.get(1);
333 if (message.startsWith("\u0001") && message.endsWith("\u0001")) {
335 handleCtcp(reply.source().get(), message);
336 } else if (!channelTypes.contains(recipient.charAt(0))) {
337 eventBus.post(new PrivateMessageReceived(this, reply.source().get(), message));
339 eventBus.post(new ChannelMessageReceived(this, recipient, reply.source().get(), message));
344 /* 43x replies are for nick change errors. */
345 } else if (command.equals("431")) {
346 eventBus.post(new NoNicknameGivenReceived(this, reply));
347 } else if (command.equals("433")) {
348 if (connectionStatus == 0) {
349 nickname = nicknameChooser.getNickname();
350 connectionHandler.sendCommand("NICK", nickname);
352 eventBus.post(new NicknameInUseReceived(this, reply));
356 } else if (command.equalsIgnoreCase("NICK")) {
357 eventBus.post(new NicknameChanged(this, reply.source().get(), parameters.get(0)));
360 } else if (command.equalsIgnoreCase("JOIN")) {
361 eventBus.post(new ChannelJoined(this, parameters.get(0), reply.source().get()));
362 } else if (command.equals("331")) {
363 /* no topic is set. */
364 } else if (command.equals("332")) {
365 eventBus.post(new ChannelTopic(this, parameters.get(1), parameters.get(2)));
366 } else if (command.equals("353")) {
367 for (String nickname : parameters.get(3).split(" ")) {
368 if (nickPrefixes.containsKey(nickname.substring(0, 1))) {
369 nicks.add(new Nickname(nickname.substring(1), nickname.substring(0, 1)));
371 nicks.add(new Nickname(nickname, ""));
374 } else if (command.equals("366")) {
375 eventBus.post(new ChannelNicknames(this, parameters.get(1), nicks));
377 } else if (command.equalsIgnoreCase("PART")) {
378 eventBus.post(new ChannelLeft(this, parameters.get(0), reply.source().get(), getOptional(parameters, 1)));
379 } else if (command.equalsIgnoreCase("QUIT")) {
380 eventBus.post(new ClientQuit(this, reply.source().get(), parameters.get(0)));
382 /* common channel join errors. */
383 } else if (command.equals("474")) {
384 eventBus.post(new ChannelNotJoined(this, parameters.get(1), Reason.banned));
385 } else if (command.equals("473")) {
386 eventBus.post(new ChannelNotJoined(this, parameters.get(1), Reason.inviteOnly));
387 } else if (command.equals("475")) {
388 eventBus.post(new ChannelNotJoined(this, parameters.get(1), Reason.badChannelKey));
390 /* basic connection housekeeping. */
391 } else if (command.equalsIgnoreCase("PING")) {
392 connectionHandler.sendCommand("PONG", getOptional(parameters, 0), getOptional(parameters, 1));
394 /* replies 001-004 don’t hold information but they have to be sent on a successful connection. */
395 } else if (command.equals("001")) {
396 connectionStatus |= 0x01;
397 } else if (command.equals("002")) {
398 connectionStatus |= 0x02;
399 } else if (command.equals("003")) {
400 connectionStatus |= 0x04;
401 } else if (command.equals("004")) {
402 connectionStatus |= 0x08;
404 /* 005 originally was a bounce message, now used to transmit useful information about the server. */
405 } else if (command.equals("005")) {
406 for (String parameter : parameters) {
407 if (parameter.startsWith("PREFIX=")) {
408 int openParen = parameter.indexOf('(');
409 int closeParen = parameter.indexOf(')');
410 if ((openParen != -1) && (closeParen != -1)) {
411 for (int modeCharacterIndex = 1; modeCharacterIndex < (closeParen - openParen); ++modeCharacterIndex) {
412 char modeCharacter = parameter.charAt(openParen + modeCharacterIndex);
413 char modeSymbol = parameter.charAt(closeParen + modeCharacterIndex);
414 nickPrefixes.put(String.valueOf(modeSymbol), String.valueOf(modeCharacter));
416 logger.fine(String.format("Parsed Prefixes: %s", nickPrefixes));
418 } else if (parameter.startsWith("CHANTYPES=")) {
419 for (int typeIndex = 10; typeIndex < parameter.length(); ++typeIndex) {
420 channelTypes.add(parameter.charAt(typeIndex));
422 logger.fine(String.format("Parsed Channel Types: %s", channelTypes));
426 /* 375, 372, and 376 handle the server’s MOTD. */
427 } else if (command.equals("375")) {
429 motd.append(parameters.get(1)).append('\n');
430 } else if (command.equals("372")) {
431 motd.append(parameters.get(1)).append('\n');
432 } else if (command.equals("376")) {
433 motd.append(parameters.get(1)).append('\n');
434 eventBus.post(new MotdReceived(this, motd.toString()));
437 /* okay, everything else. */
439 eventBus.post(new UnknownReplyReceived(this, reply));
442 if ((connectionStatus == 0x0f) && (connectionStatus != oldConnectionStatus)) {
443 /* connection succeeded! */
445 eventBus.post(new ConnectionEstablished(this));
447 oldConnectionStatus = connectionStatus;
449 eventBus.post(new ConnectionClosed(this));
450 } catch (IOException ioe1) {
451 logger.log(Level.WARNING, "I/O error", ioe1);
452 eventBus.post(new ConnectionClosed(this, ioe1));
455 logger.info("Closing Connection.");
457 Closeables.close(connectionHandler, true);
458 } catch (IOException ioe1) {
459 /* will not be thrown. */
470 * Handles a CTCP message.
473 * The client sending the message
477 private void handleCtcp(Source client, String message) {
478 String[] messageWords = message.substring(1, message.length() - 1).split(" +");
479 String ctcpCommand = messageWords[0];
480 if (ctcpCommand.equalsIgnoreCase("DCC")) {
481 if (messageWords[1].equalsIgnoreCase("SEND")) {
482 Optional<InetAddress> inetAddress = parseInetAddress(messageWords[3]);
483 Optional<Integer> port = Optional.fromNullable(Ints.tryParse(messageWords[4]));
484 long fileSize = Optional.fromNullable(Longs.tryParse(messageWords[5])).or(-1L);
485 if (inetAddress.isPresent() && port.isPresent()) {
486 eventBus.post(new DccSendReceived(this, client, messageWords[2], inetAddress.get(), port.get(), fileSize));
488 logger.warning(String.format("Received malformed DCC SEND: “%s”", message));
490 } else if (messageWords[1].equalsIgnoreCase("ACCEPT")) {
491 Optional<Integer> port = Optional.fromNullable(Ints.tryParse(messageWords[3]));
492 long position = Optional.fromNullable(Longs.tryParse(messageWords[4])).or(-1L);
493 if (port.isPresent()) {
494 eventBus.post(new DccAcceptReceived(this, client, messageWords[2], port.get(), position));
496 logger.warning(String.format("Received malformed DCC ACCEPT: “%s”", message));
503 * Returns an item from the list, or {@link Optional#absent()} if the list is
504 * shorter than required for the given index.
507 * The list to get an item from
509 * The index of the item
511 * The type of the list items
512 * @return This list item wrapped in an {@link Optional}, or {@link
513 * Optional#absent()} if the list is not long enough
515 private static <T> Optional<T> getOptional(List<T> list, int index) {
516 if (index < list.size()) {
517 return Optional.fromNullable(list.get(index));
519 return Optional.absent();
523 * Parses the given {@code ip} and returns an {@link InetAddress} from it.
527 * @return The parsed inet address, or {@link Optional#absent()} if no inet
528 * address could be parsed
530 private Optional<InetAddress> parseInetAddress(String ip) {
531 Long ipNumber = Longs.tryParse(ip);
532 if (ipNumber == null) {
533 return Optional.absent();
536 StringBuilder hostname = new StringBuilder(15);
537 hostname.append((ipNumber >>> 24) & 0xff).append('.');
538 hostname.append((ipNumber >>> 16) & 0xff).append('.');
539 hostname.append((ipNumber >>> 8) & 0xff).append('.');
540 hostname.append(ipNumber & 0xff);
542 return Optional.of(InetAddress.getByName(hostname.toString()));
543 } catch (UnknownHostException uhe1) {
544 return Optional.absent();
548 /** Handles input and output for the connection. */
549 private class ConnectionHandler implements Closeable {
551 /** The output stream of the connection. */
552 private final OutputStream outputStream;
554 /** The input stream of the connection. */
555 private final BufferedReader inputStreamReader;
558 * Creates a new connection handler for the given input stream and output
562 * The input stream of the connection
563 * @param outputStream
564 * The output stream of the connection
565 * @throws UnsupportedEncodingException
566 * if the encoding (currently “UTF-8”) is not valid
568 private ConnectionHandler(InputStream inputStream, OutputStream outputStream) throws UnsupportedEncodingException {
569 this.outputStream = outputStream;
570 inputStreamReader = new BufferedReader(new InputStreamReader(inputStream, "UTF-8"));
578 * Sends a command with the given parameters, skipping all {@link
579 * Optional#absent()} optionals.
582 * The command to send
585 * @throws IOException
586 * if an I/O error occurs
588 public void sendCommand(String command, Optional<String>... parameters) throws IOException {
589 List<String> setParameters = new ArrayList<String>();
590 for (Optional<String> maybeSetParameter : parameters) {
591 if (maybeSetParameter.isPresent()) {
592 setParameters.add(maybeSetParameter.get());
595 sendCommand(command, setParameters.toArray(new String[setParameters.size()]));
599 * Sends a command with the given parameters.
602 * The command to send
604 * The parameters of the command
605 * @throws IOException
606 * if an I/O error occurs
607 * @throws IllegalArgumentException
608 * if any parameter but that last contains a space character
610 public void sendCommand(String command, String... parameters) throws IOException, IllegalArgumentException {
611 StringBuilder commandBuilder = new StringBuilder();
613 commandBuilder.append(command);
614 for (int parameterIndex = 0; parameterIndex < parameters.length; ++parameterIndex) {
615 String parameter = parameters[parameterIndex];
616 /* space is only allowed in the last parameter. */
617 commandBuilder.append(' ');
618 if (parameter.contains(" ")) {
619 if (parameterIndex == (parameters.length - 1)) {
620 commandBuilder.append(':');
622 throw new IllegalArgumentException(String.format("parameter “%s” must not contain space!", parameter));
625 commandBuilder.append(parameter);
628 logger.finest(String.format(">> %s", commandBuilder));
629 outputStream.write((commandBuilder.toString() + "\r\n").getBytes("UTF-8"));
630 outputStream.flush();
634 * Reads a line of reply from the connection.
637 * @throws IOException
638 * if an I/O error occurs
639 * @throws EOFException
642 public Reply readReply() throws IOException, EOFException {
643 String line = inputStreamReader.readLine();
645 throw new EOFException();
648 return Reply.parseLine(line);
656 public void close() throws IOException {
657 Closeables.close(outputStream, true);
658 Closeables.close(inputStreamReader, true);