--- /dev/null
+/*
+ * XdccDownloader - Connection.java - Copyright © 2013 David Roden
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+package net.pterodactylus.irc;
+
+import static com.google.common.base.Preconditions.checkState;
+import static java.util.Arrays.asList;
+import static java.util.concurrent.TimeUnit.SECONDS;
+
+import java.io.BufferedReader;
+import java.io.Closeable;
+import java.io.EOFException;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.io.OutputStream;
+import java.io.UnsupportedEncodingException;
+import java.net.Socket;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicBoolean;
+
+import javax.net.SocketFactory;
+
+import net.pterodactylus.irc.connection.ChannelNickHandler;
+import net.pterodactylus.irc.connection.ChannelNotJoinedHandler;
+import net.pterodactylus.irc.connection.ConnectionEstablishHandler;
+import net.pterodactylus.irc.connection.CtcpHandler;
+import net.pterodactylus.irc.connection.Handler;
+import net.pterodactylus.irc.connection.MessageHandler;
+import net.pterodactylus.irc.connection.MotdHandler;
+import net.pterodactylus.irc.connection.PrefixHandler;
+import net.pterodactylus.irc.connection.SimpleCommandHandler;
+import net.pterodactylus.irc.event.ChannelJoined;
+import net.pterodactylus.irc.event.ChannelLeft;
+import net.pterodactylus.irc.event.ChannelTopic;
+import net.pterodactylus.irc.event.ClientQuit;
+import net.pterodactylus.irc.event.ConnectionClosed;
+import net.pterodactylus.irc.event.ConnectionEstablished;
+import net.pterodactylus.irc.event.ConnectionFailed;
+import net.pterodactylus.irc.event.KickedFromChannel;
+import net.pterodactylus.irc.event.NicknameChanged;
+import net.pterodactylus.irc.event.NicknameInUseReceived;
+import net.pterodactylus.irc.event.NoNicknameGivenReceived;
+import net.pterodactylus.irc.event.ReplyReceived;
+import net.pterodactylus.irc.event.UnknownReplyReceived;
+import net.pterodactylus.irc.util.RandomNickname;
+import net.pterodactylus.xdcc.util.io.BandwidthCountingInputStream;
+import net.pterodactylus.xdcc.util.io.BandwidthCountingOutputStream;
+
+import com.google.common.base.Optional;
+import com.google.common.eventbus.EventBus;
+import com.google.common.eventbus.Subscribe;
+import com.google.common.io.Closeables;
+import com.google.common.util.concurrent.AbstractExecutionThreadService;
+import com.google.common.util.concurrent.Service;
+import org.apache.log4j.Logger;
+
+/**
+ * A connection to an IRC server.
+ *
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+ */
+public class DefaultConnection extends AbstractExecutionThreadService implements Service,
+ Connection {
+
+ /* The logger. */
+ private static final Logger logger = Logger.getLogger(DefaultConnection.class.getName());
+
+ /** The event bus. */
+ private final EventBus eventBus;
+
+ /** The socket factory. */
+ private final SocketFactory socketFactory;
+
+ /** The hostname to connect to. */
+ private final String hostname;
+
+ /** The port to connect to. */
+ private final int port;
+
+ /** The nickname chooser. */
+ private NicknameChooser nicknameChooser = new NicknameChooser() {
+
+ @Override
+ public String getNickname() {
+ return RandomNickname.get();
+ }
+ };
+
+ /** The nickname. */
+ private String nickname = null;
+
+ /** The username. */
+ private Optional<String> username = Optional.absent();
+
+ /** The real name. */
+ private Optional<String> realName = Optional.absent();
+
+ /** The optional password for the connection. */
+ private Optional<String> password = Optional.absent();
+
+ /** The connection handler. */
+ private ConnectionHandler connectionHandler;
+
+ /** Whether the connection has already been established. */
+ private final AtomicBoolean established = new AtomicBoolean();
+
+ /**
+ * Creates a new connection.
+ *
+ * @param eventBus
+ * The event bus
+ * @param socketFactory
+ * The socket factory
+ * @param hostname
+ * The hostname of the IRC server
+ * @param port
+ * The port number of the IRC server
+ */
+ public DefaultConnection(EventBus eventBus, SocketFactory socketFactory, String hostname,
+ int port) {
+ this.eventBus = eventBus;
+ this.socketFactory = socketFactory;
+ this.hostname = hostname;
+ this.port = port;
+ }
+
+ //
+ // ACCESSORS
+ //
+
+ @Override
+ public String hostname() {
+ return hostname;
+ }
+
+ @Override
+ public int port() {
+ return port;
+ }
+
+ @Override
+ public boolean established() {
+ return established.get();
+ }
+
+ @Override
+ public String nickname() {
+ return nickname;
+ }
+
+ @Override
+ public Connection username(String username) {
+ this.username = Optional.fromNullable(username);
+ return this;
+ }
+
+ @Override
+ public Connection realName(String realName) {
+ this.realName = Optional.fromNullable(realName);
+ return this;
+ }
+
+ @Override
+ public Connection password(String password) {
+ this.password = Optional.fromNullable(password);
+ return this;
+ }
+
+ //
+ // ACTIONS
+ //
+
+ @Override
+ public long getInputRate() {
+ return (connectionHandler != null) ? connectionHandler.getInputRate() : 0;
+ }
+
+ @Override
+ public long getOutputRate() {
+ return (connectionHandler != null) ? connectionHandler.getOutputRate() : 0;
+ }
+
+ @Override
+ public boolean isSource(Source source) {
+ return source.nick().isPresent() && source.nick().get().equals(nickname);
+ }
+
+ @Override
+ public void joinChannel(final String channel) throws IOException {
+ connectionHandler.sendCommand("JOIN", channel);
+ }
+
+ @Override
+ public void sendMessage(String recipient, String message) throws IOException {
+ connectionHandler.sendCommand("PRIVMSG", recipient, message);
+ }
+
+ @Override
+ public void sendDccResume(String recipient, String filename, int port, long position) throws IOException {
+ connectionHandler.sendCommand("PRIVMSG", recipient,
+ String.format("\u0001DCC RESUME %s %d %d\u0001", filename, port, position));
+ }
+
+ @Override
+ public void open() {
+ start();
+ }
+
+ @Override
+ public void close() throws IOException {
+ if (connectionHandler != null) {
+ connectionHandler.close();
+ }
+ }
+
+ //
+ // ABSTRACTEXECUTIONTHREADSERVICE METHODS
+ //
+
+ @Override
+ protected void startUp() throws IllegalStateException {
+ checkState(username.isPresent(), "username must be set");
+ checkState(realName.isPresent(), "realName must be set");
+ }
+
+ @Override
+ protected void run() {
+
+ /* connect to remote socket. */
+ try {
+ Socket socket = socketFactory.createSocket(hostname, port);
+ socket.setSoTimeout((int) TimeUnit.MINUTES.toMillis(3));
+ connectionHandler = new ConnectionHandler(socket.getInputStream(), socket.getOutputStream());
+
+ /* register connection. */
+ if (password.isPresent()) {
+ connectionHandler.sendCommand("PASSWORD", password.get());
+ }
+ connectionHandler.sendCommand("USER", username.get(), "8", "*", realName.get());
+ nickname = nicknameChooser.getNickname();
+ connectionHandler.sendCommand("NICK", nickname);
+
+ } catch (IOException ioe1) {
+ eventBus.post(new ConnectionFailed(this, ioe1));
+ return;
+ }
+
+ eventBus.register(this);
+ /* now read replies and react. */
+ try {
+ /* some status variables. */
+ boolean connected = true;
+
+ PrefixHandler prefixHandler = new PrefixHandler();
+ List<Handler> handlers = asList(
+ new MessageHandler(eventBus, this, prefixHandler),
+ new CtcpHandler(eventBus, this),
+ new ChannelNickHandler(eventBus, this, prefixHandler),
+ new SimpleCommandHandler(eventBus)
+ .addCommand("431",
+ (s, p) -> new NoNicknameGivenReceived(
+ this))
+ .addCommand("NICK",
+ (s, p) -> new NicknameChanged(this,
+ s.get(), p.get(0)))
+ .addCommand("JOIN",
+ (s, p) -> new ChannelJoined(this,
+ p.get(0), s.get()))
+ .addCommand("332",
+ (s, p) -> new ChannelTopic(this, p.get(1),
+ p.get(2)))
+ .addCommand("PART",
+ (s, p) -> new ChannelLeft(this, p.get(0),
+ s.get(), getOptional(p, 1)))
+ .addCommand("QUIT",
+ (s, p) -> new ClientQuit(this, s.get(),
+ p.get(0)))
+ .addCommand("KICK",
+ (s, p) -> new KickedFromChannel(this,
+ p.get(0), s.get(), p.get(1),
+ getOptional(p, 2))),
+ new MotdHandler(eventBus, this),
+ new ChannelNotJoinedHandler(eventBus, this),
+ new ConnectionEstablishHandler(eventBus, this),
+ prefixHandler
+ );
+
+ while (connected) {
+ Reply reply = connectionHandler.readReply();
+ eventBus.post(new ReplyReceived(this, reply));
+ logger.trace(String.format("<< %s", reply));
+ String command = reply.command();
+ List<String> parameters = reply.parameters();
+
+ for (Handler handler : handlers) {
+ if (handler.willHandle(reply)) {
+ handler.handleReply(reply);
+ break;
+ }
+ }
+
+ /* 43x replies are for nick change errors. */
+ if (command.equals("433")) {
+ if (!established.get()) {
+ nickname = nicknameChooser.getNickname();
+ connectionHandler.sendCommand("NICK", nickname);
+ } else {
+ eventBus.post(new NicknameInUseReceived(this, reply));
+ }
+
+
+ /* basic connection housekeeping. */
+ } else if (command.equalsIgnoreCase("PING")) {
+ connectionHandler.sendCommand("PONG", getOptional(parameters, 0), getOptional(parameters, 1));
+
+ /* okay, everything else. */
+ } else {
+ eventBus.post(new UnknownReplyReceived(this, reply));
+ }
+ }
+ eventBus.post(new ConnectionClosed(this));
+ } catch (IOException ioe1) {
+ logger.warn("I/O error", ioe1);
+ eventBus.post(new ConnectionClosed(this, ioe1));
+ } catch (RuntimeException re1) {
+ logger.error("Runtime error", re1);
+ eventBus.post(new ConnectionClosed(this, re1));
+ } finally {
+ established.set(false);
+ eventBus.unregister(this);
+ logger.info("Closing Connection.");
+ try {
+ Closeables.close(connectionHandler, true);
+ } catch (IOException ioe1) {
+ /* will not be thrown. */
+ }
+ }
+
+ }
+
+ @Subscribe
+ public void connectionEstablished(ConnectionEstablished connectionEstablished) {
+ if (connectionEstablished.connection() == this) {
+ established.set(true);
+ }
+ }
+
+ //
+ // PRIVATE METHODS
+ //
+
+ /**
+ * Returns an item from the list, or {@link Optional#absent()} if the list is
+ * shorter than required for the given index.
+ *
+ * @param list
+ * The list to get an item from
+ * @param index
+ * The index of the item
+ * @param <T>
+ * The type of the list items
+ * @return This list item wrapped in an {@link Optional}, or {@link
+ * Optional#absent()} if the list is not long enough
+ */
+ private static <T> Optional<T> getOptional(List<T> list, int index) {
+ if (index < list.size()) {
+ return Optional.fromNullable(list.get(index));
+ }
+ return Optional.absent();
+ }
+
+ /** Handles input and output for the connection. */
+ private class ConnectionHandler implements Closeable {
+
+ /** The output stream of the connection. */
+ private final BandwidthCountingOutputStream outputStream;
+
+ /** The input stream. */
+ private final BandwidthCountingInputStream inputStream;
+
+ /** The input stream of the connection. */
+ private final BufferedReader inputStreamReader;
+
+ /**
+ * Creates a new connection handler for the given input stream and output
+ * stream.
+ *
+ * @param inputStream
+ * The input stream of the connection
+ * @param outputStream
+ * The output stream of the connection
+ * @throws UnsupportedEncodingException
+ * if the encoding (currently “UTF-8”) is not valid
+ */
+ private ConnectionHandler(InputStream inputStream, OutputStream outputStream) throws UnsupportedEncodingException {
+ this.outputStream = new BandwidthCountingOutputStream(outputStream, 5, SECONDS);
+ this.inputStream = new BandwidthCountingInputStream(inputStream, 5, SECONDS);
+ inputStreamReader = new BufferedReader(new InputStreamReader(this.inputStream, "UTF-8"));
+ }
+
+ //
+ // ACTIONS
+ //
+
+ /**
+ * Returns the current rate of the connection’s incoming side.
+ *
+ * @return The current input rate (in bytes per second)
+ */
+ public long getInputRate() {
+ return inputStream.getCurrentRate();
+ }
+
+ /**
+ * Returns the current rate of the connection’s outgoing side.
+ *
+ * @return The current output rate (in bytes per second)
+ */
+ public long getOutputRate() {
+ return outputStream.getCurrentRate();
+ }
+
+ /**
+ * Sends a command with the given parameters, skipping all {@link
+ * Optional#absent()} optionals.
+ *
+ * @param command
+ * The command to send
+ * @param parameters
+ * The parameters
+ * @throws IOException
+ * if an I/O error occurs
+ */
+ public void sendCommand(String command, Optional<String>... parameters) throws IOException {
+ List<String> setParameters = new ArrayList<String>();
+ for (Optional<String> maybeSetParameter : parameters) {
+ if (maybeSetParameter.isPresent()) {
+ setParameters.add(maybeSetParameter.get());
+ }
+ }
+ sendCommand(command, setParameters.toArray(new String[setParameters.size()]));
+ }
+
+ /**
+ * Sends a command with the given parameters.
+ *
+ * @param command
+ * The command to send
+ * @param parameters
+ * The parameters of the command
+ * @throws IOException
+ * if an I/O error occurs
+ * @throws IllegalArgumentException
+ * if any parameter but that last contains a space character
+ */
+ public void sendCommand(String command, String... parameters) throws IOException, IllegalArgumentException {
+ StringBuilder commandBuilder = new StringBuilder();
+
+ commandBuilder.append(command);
+ for (int parameterIndex = 0; parameterIndex < parameters.length; ++parameterIndex) {
+ String parameter = parameters[parameterIndex];
+ /* space is only allowed in the last parameter. */
+ commandBuilder.append(' ');
+ if (parameter.contains(" ")) {
+ if (parameterIndex == (parameters.length - 1)) {
+ commandBuilder.append(':');
+ } else {
+ throw new IllegalArgumentException(String.format("parameter “%s” must not contain space!", parameter));
+ }
+ }
+ commandBuilder.append(parameter);
+ }
+
+ logger.trace(String.format(">> %s", commandBuilder));
+ outputStream.write((commandBuilder.toString() + "\r\n").getBytes("UTF-8"));
+ outputStream.flush();
+ }
+
+ /**
+ * Reads a line of reply from the connection.
+ *
+ * @return The reply
+ * @throws IOException
+ * if an I/O error occurs
+ * @throws EOFException
+ * if EOF was reached
+ */
+ public Reply readReply() throws IOException, EOFException {
+ String line = inputStreamReader.readLine();
+ if (line == null) {
+ throw new EOFException();
+ }
+
+ return Reply.parseLine(line);
+ }
+
+ //
+ // CLOSEABLE METHODS
+ //
+
+ @Override
+ public void close() throws IOException {
+ Closeables.close(outputStream, true);
+ Closeables.close(inputStreamReader, true);
+ Closeables.close(inputStream, true);
+ }
+
+ }
+
+}
projects / xudocci.git / blobdiff