src/net/pterodactylus/util/fcp/FcpConnection.java

   1 /*
   2  * jSite2 - FpcConnection.java -
   3  * Copyright © 2008 David Roden
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 package net.pterodactylus.util.fcp;
  21
  22 import java.io.IOException;
  23 import java.io.InputStream;
  24 import java.io.OutputStream;
  25 import java.net.InetAddress;
  26 import java.net.Socket;
  27 import java.net.UnknownHostException;
  28 import java.util.ArrayList;
  29 import java.util.Collections;
  30 import java.util.HashMap;
  31 import java.util.List;
  32 import java.util.Map;
  33
  34 import net.pterodactylus.util.io.Closer;
  35 import net.pterodactylus.util.io.LimitedInputStream;
  36
  37 /**
  38  * An FCP connection to a Freenet node.
  39  *
  40  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  41  * @version $Id$
  42  */
  43 public class FcpConnection {
  44
  45         /** The default port for FCP v2. */
  46         public static final int DEFAULT_PORT = 9481;
  47
  48         /** The list of FCP listeners. */
  49         private final List<FcpListener> fcpListeners = new ArrayList<FcpListener>();
  50
  51         /** The address of the node. */
  52         private final InetAddress address;
  53
  54         /** The port number of the node’s FCP port. */
  55         private final int port;
  56
  57         /** The remote socket. */
  58         private Socket remoteSocket;
  59
  60         /** The input stream from the node. */
  61         private InputStream remoteInputStream;
  62
  63         /** The output stream to the node. */
  64         private OutputStream remoteOutputStream;
  65
  66         /** The connection handler. */
  67         private FcpConnectionHandler connectionHandler;
  68
  69         /** Incoming message statistics. */
  70         private Map<String, Integer> incomingMessageStatistics = Collections.synchronizedMap(new HashMap<String, Integer>());
  71
  72         /**
  73          * Creates a new FCP connection to the freenet node running on localhost,
  74          * using the default port.
  75          *
  76          * @throws UnknownHostException
  77          *             if the hostname can not be resolved
  78          */
  79         public FcpConnection() throws UnknownHostException {
  80                 this(InetAddress.getLocalHost());
  81         }
  82
  83         /**
  84          * Creates a new FCP connection to the Freenet node running on the given
  85          * host, listening on the default port.
  86          *
  87          * @param host
  88          *            The hostname of the Freenet node
  89          * @throws UnknownHostException
  90          *             if <code>host</code> can not be resolved
  91          */
  92         public FcpConnection(String host) throws UnknownHostException {
  93                 this(host, DEFAULT_PORT);
  94         }
  95
  96         /**
  97          * Creates a new FCP connection to the Freenet node running on the given
  98          * host, listening on the given port.
  99          *
 100          * @param host
 101          *            The hostname of the Freenet node
 102          * @param port
 103          *            The port number of the node’s FCP port
 104          * @throws UnknownHostException
 105          *             if <code>host</code> can not be resolved
 106          */
 107         public FcpConnection(String host, int port) throws UnknownHostException {
 108                 this(InetAddress.getByName(host), port);
 109         }
 110
 111         /**
 112          * Creates a new FCP connection to the Freenet node running at the given
 113          * address, listening on the default port.
 114          *
 115          * @param address
 116          *            The address of the Freenet node
 117          */
 118         public FcpConnection(InetAddress address) {
 119                 this(address, DEFAULT_PORT);
 120         }
 121
 122         /**
 123          * Creates a new FCP connection to the Freenet node running at the given
 124          * address, listening on the given port.
 125          *
 126          * @param address
 127          *            The address of the Freenet node
 128          * @param port
 129          *            The port number of the node’s FCP port
 130          */
 131         public FcpConnection(InetAddress address, int port) {
 132                 this.address = address;
 133                 this.port = port;
 134         }
 135
 136         //
 137         // LISTENER MANAGEMENT
 138         //
 139
 140         /**
 141          * Adds the given listener to the list of listeners.
 142          *
 143          * @param fcpListener
 144          *            The listener to add
 145          */
 146         public void addFcpListener(FcpListener fcpListener) {
 147                 fcpListeners.add(fcpListener);
 148         }
 149
 150         /**
 151          * Removes the given listener from the list of listeners.
 152          *
 153          * @param fcpListener
 154          *            The listener to remove
 155          */
 156         public void removeFcpListener(FcpListener fcpListener) {
 157                 fcpListeners.remove(fcpListener);
 158         }
 159
 160         /**
 161          * Notifies listeners that a “NodeHello” message was received.
 162          *
 163          * @see FcpListener#receivedNodeHello(FcpConnection, NodeHello)
 164          * @param nodeHello
 165          *            The “NodeHello” message
 166          */
 167         private void fireReceivedNodeHello(NodeHello nodeHello) {
 168                 for (FcpListener fcpListener: fcpListeners) {
 169                         fcpListener.receivedNodeHello(this, nodeHello);
 170                 }
 171         }
 172
 173         /**
 174          * Notifies listeners that a “CloseConnectionDuplicateClientName” message
 175          * was received.
 176          *
 177          * @see FcpListener#receivedCloseConnectionDuplicateClientName(FcpConnection,
 178          *      CloseConnectionDuplicateClientName)
 179          * @param closeConnectionDuplicateClientName
 180          *            The “CloseConnectionDuplicateClientName” message
 181          */
 182         private void fireReceivedCloseConnectionDuplicateClientName(CloseConnectionDuplicateClientName closeConnectionDuplicateClientName) {
 183                 for (FcpListener fcpListener: fcpListeners) {
 184                         fcpListener.receivedCloseConnectionDuplicateClientName(this, closeConnectionDuplicateClientName);
 185                 }
 186         }
 187
 188         /**
 189          * Notifies listeners that a “SSKKeypair” message was received.
 190          *
 191          * @see FcpListener#receivedSSKKeypair(FcpConnection, SSKKeypair)
 192          * @param sskKeypair
 193          *            The “SSKKeypair” message
 194          */
 195         private void fireReceivedSSKKeypair(SSKKeypair sskKeypair) {
 196                 for (FcpListener fcpListener: fcpListeners) {
 197                         fcpListener.receivedSSKKeypair(this, sskKeypair);
 198                 }
 199         }
 200
 201         /**
 202          * Notifies listeners that a “Peer” message was received.
 203          *
 204          * @see FcpListener#receivedPeer(FcpConnection, Peer)
 205          * @param peer
 206          *            The “Peer” message
 207          */
 208         private void fireReceivedPeer(Peer peer) {
 209                 for (FcpListener fcpListener: fcpListeners) {
 210                         fcpListener.receivedPeer(this, peer);
 211                 }
 212         }
 213
 214         /**
 215          * Notifies all listeners that an “EndListPeers” message was received.
 216          *
 217          * @see FcpListener#receivedEndListPeers(FcpConnection, EndListPeers)
 218          * @param endListPeers
 219          *            The “EndListPeers” message
 220          */
 221         private void fireReceivedEndListPeers(EndListPeers endListPeers) {
 222                 for (FcpListener fcpListener: fcpListeners) {
 223                         fcpListener.receivedEndListPeers(this, endListPeers);
 224                 }
 225         }
 226
 227         /**
 228          * Notifies all listeners that a “PeerNote” message was received.
 229          *
 230          * @see FcpListener#receivedPeerNote(FcpConnection, PeerNote)
 231          * @param peerNote
 232          */
 233         private void fireReceivedPeerNote(PeerNote peerNote) {
 234                 for (FcpListener fcpListener: fcpListeners) {
 235                         fcpListener.receivedPeerNote(this, peerNote);
 236                 }
 237         }
 238
 239         /**
 240          * Notifies all listeners that an “EndListPeerNotes” message was received.
 241          *
 242          * @see FcpListener#receivedEndListPeerNotes(FcpConnection,
 243          *      EndListPeerNotes)
 244          * @param endListPeerNotes
 245          *            The “EndListPeerNotes” message
 246          */
 247         private void fireReceivedEndListPeerNotes(EndListPeerNotes endListPeerNotes) {
 248                 for (FcpListener fcpListener: fcpListeners) {
 249                         fcpListener.receivedEndListPeerNotes(this, endListPeerNotes);
 250                 }
 251         }
 252
 253         /**
 254          * Notifies all listeners that a “PeerRemoved” message was received.
 255          *
 256          * @see FcpListener#receivedPeerRemoved(FcpConnection, PeerRemoved)
 257          * @param peerRemoved
 258          *            The “PeerRemoved” message
 259          */
 260         private void fireReceivedPeerRemoved(PeerRemoved peerRemoved) {
 261                 for (FcpListener fcpListener: fcpListeners) {
 262                         fcpListener.receivedPeerRemoved(this, peerRemoved);
 263                 }
 264         }
 265
 266         /**
 267          * Notifies all listeners that a “NodeData” message was received.
 268          *
 269          * @see FcpListener#receivedNodeData(FcpConnection, NodeData)
 270          * @param nodeData
 271          *            The “NodeData” message
 272          */
 273         private void fireReceivedNodeData(NodeData nodeData) {
 274                 for (FcpListener fcpListener: fcpListeners) {
 275                         fcpListener.receivedNodeData(this, nodeData);
 276                 }
 277         }
 278
 279         /**
 280          * Notifies all listeners that a “TestDDAReply” message was received.
 281          *
 282          * @see FcpListener#receivedTestDDAReply(FcpConnection, TestDDAReply)
 283          * @param testDDAReply
 284          *            The “TestDDAReply” message
 285          */
 286         private void fireReceivedTestDDAReply(TestDDAReply testDDAReply) {
 287                 for (FcpListener fcpListener: fcpListeners) {
 288                         fcpListener.receivedTestDDAReply(this, testDDAReply);
 289                 }
 290         }
 291
 292         /**
 293          * Notifies all listeners that a “TestDDAComplete” message was received.
 294          *
 295          * @see FcpListener#receivedTestDDAComplete(FcpConnection, TestDDAComplete)
 296          * @param testDDAComplete
 297          *            The “TestDDAComplete” message
 298          */
 299         private void fireReceivedTestDDAComplete(TestDDAComplete testDDAComplete) {
 300                 for (FcpListener fcpListener: fcpListeners) {
 301                         fcpListener.receivedTestDDAComplete(this, testDDAComplete);
 302                 }
 303         }
 304
 305         /**
 306          * Notifies all listeners that a “PersistentGet” message was received.
 307          *
 308          * @param persistentGet
 309          *            The “PersistentGet” message
 310          */
 311         private void fireReceivedPersistentGet(PersistentGet persistentGet) {
 312                 for (FcpListener fcpListener: fcpListeners) {
 313                         fcpListener.receivedPersistentGet(this, persistentGet);
 314                 }
 315         }
 316
 317         /**
 318          * Notifies all listeners that a “PersistentPut” message was received.
 319          *
 320          * @see FcpListener#receivedPersistentPut(FcpConnection, PersistentPut)
 321          * @param persistentPut
 322          *            The “PersistentPut” message
 323          */
 324         private void fireReceivedPersistentPut(PersistentPut persistentPut) {
 325                 for (FcpListener fcpListener: fcpListeners) {
 326                         fcpListener.receivedPersistentPut(this, persistentPut);
 327                 }
 328         }
 329
 330         /**
 331          * Notifies all listeners that a “EndListPersistentRequests” message was
 332          * received.
 333          *
 334          * @param endListPersistentRequests
 335          *            The “EndListPersistentRequests” message
 336          */
 337         private void fireReceivedEndListPersistentRequests(EndListPersistentRequests endListPersistentRequests) {
 338                 for (FcpListener fcpListener: fcpListeners) {
 339                         fcpListener.receivedEndListPersistentRequests(this, endListPersistentRequests);
 340                 }
 341         }
 342
 343         /**
 344          * Notifies all listeners that a “URIGenerated” message was received.
 345          *
 346          * @param uriGenerated
 347          *            The “URIGenerated” message
 348          */
 349         private void fireReceivedURIGenerated(URIGenerated uriGenerated) {
 350                 for (FcpListener fcpListener: fcpListeners) {
 351                         fcpListener.receivedURIGenerated(this, uriGenerated);
 352                 }
 353         }
 354
 355         /**
 356          * Notifies all listeners that a “DataFound” message was received.
 357          *
 358          * @param dataFound
 359          *            The “DataFound” message
 360          */
 361         private void fireReceivedDataFound(DataFound dataFound) {
 362                 for (FcpListener fcpListener: fcpListeners) {
 363                         fcpListener.receivedDataFound(this, dataFound);
 364                 }
 365         }
 366
 367         /**
 368          * Notifies all listeners that an “AllData” message was received.
 369          *
 370          * @param allData
 371          *            The “AllData” message
 372          */
 373         private void fireReceivedAllData(AllData allData) {
 374                 for (FcpListener fcpListener: fcpListeners) {
 375                         fcpListener.receivedAllData(this, allData);
 376                 }
 377         }
 378
 379         /**
 380          * Notifies all listeners that a “SimpleProgress” message was received.
 381          *
 382          * @param simpleProgress
 383          *            The “SimpleProgress” message
 384          */
 385         private void fireReceivedSimpleProgress(SimpleProgress simpleProgress) {
 386                 for (FcpListener fcpListener: fcpListeners) {
 387                         fcpListener.receivedSimpleProgress(this, simpleProgress);
 388                 }
 389         }
 390
 391         /**
 392          * Notifies all listeners that a “StartedCompression” message was received.
 393          *
 394          * @param startedCompression
 395          *            The “StartedCompression” message
 396          */
 397         private void fireReceivedStartedCompression(StartedCompression startedCompression) {
 398                 for (FcpListener fcpListener: fcpListeners) {
 399                         fcpListener.receivedStartedCompression(this, startedCompression);
 400                 }
 401         }
 402
 403         /**
 404          * Notifies all listeners that a “FinishedCompression” message was received.
 405          *
 406          * @param finishedCompression
 407          *            The “FinishedCompression” message
 408          */
 409         private void fireReceivedFinishedCompression(FinishedCompression finishedCompression) {
 410                 for (FcpListener fcpListener: fcpListeners) {
 411                         fcpListener.receviedFinishedCompression(this, finishedCompression);
 412                 }
 413         }
 414
 415         /**
 416          * Notifies all listeners that an “UnknownPeerNoteType” message was
 417          * received.
 418          *
 419          * @param unknownPeerNoteType
 420          *            The “UnknownPeerNoteType” message
 421          */
 422         private void fireReceivedUnknownPeerNoteType(UnknownPeerNoteType unknownPeerNoteType) {
 423                 for (FcpListener fcpListener: fcpListeners) {
 424                         fcpListener.receivedUnknownPeerNoteType(this, unknownPeerNoteType);
 425                 }
 426         }
 427
 428         /**
 429          * Notifies all listeners that an “UnknownNodeIdentifier” message was
 430          * received.
 431          *
 432          * @param unknownNodeIdentifier
 433          *            The “UnknownNodeIdentifier” message
 434          */
 435         private void fireReceivedUnknownNodeIdentifier(UnknownNodeIdentifier unknownNodeIdentifier) {
 436                 for (FcpListener fcpListener: fcpListeners) {
 437                         fcpListener.receivedUnknownNodeIdentifier(this, unknownNodeIdentifier);
 438                 }
 439         }
 440
 441         /**
 442          * Notifies all listeners that a “ProtocolError” message was received.
 443          *
 444          * @param protocolError
 445          *            The “ProtocolError” message
 446          */
 447         private void fireReceivedProtocolError(ProtocolError protocolError) {
 448                 for (FcpListener fcpListener: fcpListeners) {
 449                         fcpListener.receivedProtocolError(this, protocolError);
 450                 }
 451         }
 452
 453         /**
 454          * Notifies all registered listeners that a message has been received.
 455          *
 456          * @see FcpListener#receivedMessage(FcpConnection, FcpMessage)
 457          * @param fcpMessage
 458          *            The message that was received
 459          */
 460         private void fireMessageReceived(FcpMessage fcpMessage) {
 461                 for (FcpListener fcpListener: fcpListeners) {
 462                         fcpListener.receivedMessage(this, fcpMessage);
 463                 }
 464         }
 465
 466         //
 467         // ACTIONS
 468         //
 469
 470         /**
 471          * Connects to the node.
 472          *
 473          * @throws IOException
 474          *             if an I/O error occurs
 475          * @throws IllegalStateException
 476          *             if there is already a connection to the node
 477          */
 478         public synchronized void connect() throws IOException, IllegalStateException {
 479                 if (connectionHandler != null) {
 480                         throw new IllegalStateException("already connected, disconnect first");
 481                 }
 482                 remoteSocket = new Socket(address, port);
 483                 remoteInputStream = remoteSocket.getInputStream();
 484                 remoteOutputStream = remoteSocket.getOutputStream();
 485                 new Thread(connectionHandler = new FcpConnectionHandler(this, remoteInputStream)).start();
 486         }
 487
 488         /**
 489          * Disconnects from the node. If there is no connection to the node, this
 490          * method does nothing.
 491          */
 492         public synchronized void disconnect() {
 493                 if (connectionHandler == null) {
 494                         return;
 495                 }
 496                 Closer.close(remoteSocket);
 497                 connectionHandler.stop();
 498                 connectionHandler = null;
 499         }
 500
 501         /**
 502          * Sends the given FCP message.
 503          *
 504          * @param fcpMessage
 505          *            The FCP message to send
 506          * @throws IOException
 507          *             if an I/O error occurs
 508          */
 509         public synchronized void sendMessage(FcpMessage fcpMessage) throws IOException {
 510                 System.out.println("sending message: " + fcpMessage.getName());
 511                 fcpMessage.write(remoteOutputStream);
 512         }
 513
 514         //
 515         // PACKAGE-PRIVATE METHODS
 516         //
 517
 518         /**
 519          * Handles the given message, notifying listeners. This message should only
 520          * be called by {@link FcpConnectionHandler}.
 521          *
 522          * @param fcpMessage
 523          *            The received message
 524          */
 525         void handleMessage(FcpMessage fcpMessage) {
 526                 String messageName = fcpMessage.getName();
 527                 countMessage(messageName);
 528                 if ("SimpleProgress".equals(messageName)) {
 529                         fireReceivedSimpleProgress(new SimpleProgress(fcpMessage));
 530                 } else if ("ProtocolError".equals(messageName)) {
 531                         fireReceivedProtocolError(new ProtocolError(fcpMessage));
 532                 } else if ("PersistentGet".equals(messageName)) {
 533                         fireReceivedPersistentGet(new PersistentGet(fcpMessage));
 534                 } else if ("PersistentPut".equals(messageName)) {
 535                         fireReceivedPersistentPut(new PersistentPut(fcpMessage));
 536                 } else if ("URIGenerated".equals(messageName)) {
 537                         fireReceivedURIGenerated(new URIGenerated(fcpMessage));
 538                 } else if ("EndListPersistentRequests".equals(messageName)) {
 539                         fireReceivedEndListPersistentRequests(new EndListPersistentRequests(fcpMessage));
 540                 } else if ("Peer".equals(messageName)) {
 541                         fireReceivedPeer(new Peer(fcpMessage));
 542                 } else if ("PeerNote".equals(messageName)) {
 543                         fireReceivedPeerNote(new PeerNote(fcpMessage));
 544                 } else if ("StartedCompression".equals(messageName)) {
 545                         fireReceivedStartedCompression(new StartedCompression(fcpMessage));
 546                 } else if ("FinishedCompression".equals(messageName)) {
 547                         fireReceivedFinishedCompression(new FinishedCompression(fcpMessage));
 548                 } else if ("DataFound".equals(messageName)) {
 549                         fireReceivedDataFound(new DataFound(fcpMessage));
 550                 } else if ("AllData".equals(messageName)) {
 551                         long dataLength;
 552                         try {
 553                                 dataLength = Long.valueOf(fcpMessage.getField("DataLength"));
 554                         } catch (NumberFormatException nfe1) {
 555                                 dataLength = -1;
 556                         }
 557                         LimitedInputStream payloadInputStream = new LimitedInputStream(remoteInputStream, dataLength);
 558                         fireReceivedAllData(new AllData(fcpMessage, payloadInputStream));
 559                         try {
 560                                 payloadInputStream.consume();
 561                         } catch (IOException ioe1) {
 562                                 /* FIXME - what now? */
 563                                 /* well, ignore. when the connection handler fails, all fails. */
 564                         }
 565                 } else if ("EndListPeerNotes".equals(messageName)) {
 566                         fireReceivedEndListPeerNotes(new EndListPeerNotes(fcpMessage));
 567                 } else if ("EndListPeers".equals(messageName)) {
 568                         fireReceivedEndListPeers(new EndListPeers(fcpMessage));
 569                 } else if ("SSKKeypair".equals(messageName)) {
 570                         fireReceivedSSKKeypair(new SSKKeypair(fcpMessage));
 571                 } else if ("PeerRemoved".equals(messageName)) {
 572                         fireReceivedPeerRemoved(new PeerRemoved(fcpMessage));
 573                 } else if ("UnknownPeerNoteType".equals(messageName)) {
 574                         fireReceivedUnknownPeerNoteType(new UnknownPeerNoteType(fcpMessage));
 575                 } else if ("UnknownNodeIdentifier".equals(messageName)) {
 576                         fireReceivedUnknownNodeIdentifier(new UnknownNodeIdentifier(fcpMessage));
 577                 } else if ("NodeData".equals(messageName)) {
 578                         fireReceivedNodeData(new NodeData(fcpMessage));
 579                 } else if ("TestDDAReply".equals(messageName)) {
 580                         fireReceivedTestDDAReply(new TestDDAReply(fcpMessage));
 581                 } else if ("TestDDAComplete".equals(messageName)) {
 582                         fireReceivedTestDDAComplete(new TestDDAComplete(fcpMessage));
 583                 } else if ("NodeHello".equals(messageName)) {
 584                         fireReceivedNodeHello(new NodeHello(fcpMessage));
 585                 } else if ("CloseConnectionDuplicateClientName".equals(messageName)) {
 586                         fireReceivedCloseConnectionDuplicateClientName(new CloseConnectionDuplicateClientName(fcpMessage));
 587                 } else {
 588                         fireMessageReceived(fcpMessage);
 589                 }
 590         }
 591
 592         /**
 593          * Handles a disconnect from the node.
 594          */
 595         synchronized void handleDisconnect() {
 596                 Closer.close(remoteInputStream);
 597                 Closer.close(remoteOutputStream);
 598                 Closer.close(remoteSocket);
 599                 connectionHandler = null;
 600         }
 601
 602         //
 603         // PRIVATE METHODS
 604         //
 605
 606         /**
 607          * Incremets the counter in {@link #incomingMessageStatistics} by <cod>1</code>
 608          * for the given message name.
 609          *
 610          * @param name
 611          *            The name of the message to count
 612          */
 613         private void countMessage(String name) {
 614                 int oldValue = 0;
 615                 if (incomingMessageStatistics.containsKey(name)) {
 616                         oldValue = incomingMessageStatistics.get(name);
 617                 }
 618                 incomingMessageStatistics.put(name, oldValue + 1);
 619         }
 620
 621 }