2 * jFCPlib - FpcConnection.java - Copyright © 2008 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 2 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, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 package net.pterodactylus.fcp;
21 import java.io.Closeable;
22 import java.io.FilterInputStream;
23 import java.io.IOException;
24 import java.io.InputStream;
25 import java.io.OutputStream;
26 import java.net.InetAddress;
27 import java.net.Socket;
28 import java.net.UnknownHostException;
29 import java.util.Collections;
30 import java.util.HashMap;
32 import java.util.logging.Logger;
35 * An FCP connection to a Freenet node.
37 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
39 public class FcpConnection implements Closeable {
42 private static final Logger logger = Logger.getLogger(FcpConnection.class.getName());
44 /** The default port for FCP v2. */
45 public static final int DEFAULT_PORT = 9481;
47 /** Listener management. */
48 private final FcpListenerManager fcpListenerManager = new FcpListenerManager(this);
50 /** The address of the node. */
51 private final InetAddress address;
53 /** The port number of the node’s FCP port. */
54 private final int port;
56 /** The remote socket. */
57 private Socket remoteSocket;
59 /** The input stream from the node. */
60 private InputStream remoteInputStream;
62 /** The output stream to the node. */
63 private OutputStream remoteOutputStream;
65 /** The connection handler. */
66 private FcpConnectionHandler connectionHandler;
68 /** Incoming message statistics. */
69 private static final Map<String, Integer> incomingMessageStatistics = Collections.synchronizedMap(new HashMap<String, Integer>());
72 * Creates a new FCP connection to the freenet node running on localhost,
73 * using the default port.
75 * @throws UnknownHostException
76 * if the hostname can not be resolved
78 public FcpConnection() throws UnknownHostException {
79 this(InetAddress.getLocalHost());
83 * Creates a new FCP connection to the Freenet node running on the given
84 * host, listening on the default port.
87 * The hostname of the Freenet node
88 * @throws UnknownHostException
89 * if <code>host</code> can not be resolved
91 public FcpConnection(String host) throws UnknownHostException {
92 this(host, DEFAULT_PORT);
96 * Creates a new FCP connection to the Freenet node running on the given
97 * host, listening on the given port.
100 * The hostname of the Freenet node
102 * The port number of the node’s FCP port
103 * @throws UnknownHostException
104 * if <code>host</code> can not be resolved
106 public FcpConnection(String host, int port) throws UnknownHostException {
107 this(InetAddress.getByName(host), port);
111 * Creates a new FCP connection to the Freenet node running at the given
112 * address, listening on the default port.
115 * The address of the Freenet node
117 public FcpConnection(InetAddress address) {
118 this(address, DEFAULT_PORT);
122 * Creates a new FCP connection to the Freenet node running at the given
123 * address, listening on the given port.
126 * The address of the Freenet node
128 * The port number of the node’s FCP port
130 public FcpConnection(InetAddress address, int port) {
131 this.address = address;
136 // LISTENER MANAGEMENT
140 * Adds the given listener to the list of listeners.
143 * The listener to add
145 public void addFcpListener(FcpListener fcpListener) {
146 fcpListenerManager.addListener(fcpListener);
150 * Removes the given listener from the list of listeners.
153 * The listener to remove
155 public void removeFcpListener(FcpListener fcpListener) {
156 fcpListenerManager.removeListener(fcpListener);
164 * Connects to the node.
166 * @throws IOException
167 * if an I/O error occurs
168 * @throws IllegalStateException
169 * if there is already a connection to the node
171 public synchronized void connect() throws IOException, IllegalStateException {
172 if (connectionHandler != null) {
173 throw new IllegalStateException("already connected, disconnect first");
175 logger.info("connecting to " + address + ":" + port + "…");
176 remoteSocket = new Socket(address, port);
177 remoteInputStream = remoteSocket.getInputStream();
178 remoteOutputStream = remoteSocket.getOutputStream();
179 new Thread(connectionHandler = new FcpConnectionHandler(this, remoteInputStream)).start();
183 * Disconnects from the node. If there is no connection to the node, this
184 * method does nothing.
186 * @deprecated Use {@link #close()} instead
189 public synchronized void disconnect() {
194 * Closes the connection. If there is no connection to the node, this
195 * method does nothing.
198 public void close() {
199 handleDisconnect(null);
203 * Sends the given FCP message.
206 * The FCP message to send
207 * @throws IOException
208 * if an I/O error occurs
210 public synchronized void sendMessage(FcpMessage fcpMessage) throws IOException {
211 logger.fine("sending message: " + fcpMessage.getName());
212 fcpMessage.write(remoteOutputStream);
216 // PACKAGE-PRIVATE METHODS
220 * Handles the given message, notifying listeners. This message should only
221 * be called by {@link FcpConnectionHandler}.
224 * The received message
226 void handleMessage(FcpMessage fcpMessage) {
227 logger.fine("received message: " + fcpMessage.getName());
228 String messageName = fcpMessage.getName();
229 countMessage(messageName);
230 if ("SimpleProgress".equals(messageName)) {
231 fcpListenerManager.fireReceivedSimpleProgress(new SimpleProgress(fcpMessage));
232 } else if ("ProtocolError".equals(messageName)) {
233 fcpListenerManager.fireReceivedProtocolError(new ProtocolError(fcpMessage));
234 } else if ("PersistentGet".equals(messageName)) {
235 fcpListenerManager.fireReceivedPersistentGet(new PersistentGet(fcpMessage));
236 } else if ("PersistentPut".equals(messageName)) {
237 fcpListenerManager.fireReceivedPersistentPut(new PersistentPut(fcpMessage));
238 } else if ("PersistentPutDir".equals(messageName)) {
239 fcpListenerManager.fireReceivedPersistentPutDir(new PersistentPutDir(fcpMessage));
240 } else if ("URIGenerated".equals(messageName)) {
241 fcpListenerManager.fireReceivedURIGenerated(new URIGenerated(fcpMessage));
242 } else if ("EndListPersistentRequests".equals(messageName)) {
243 fcpListenerManager.fireReceivedEndListPersistentRequests(new EndListPersistentRequests(fcpMessage));
244 } else if ("Peer".equals(messageName)) {
245 fcpListenerManager.fireReceivedPeer(new Peer(fcpMessage));
246 } else if ("PeerNote".equals(messageName)) {
247 fcpListenerManager.fireReceivedPeerNote(new PeerNote(fcpMessage));
248 } else if ("StartedCompression".equals(messageName)) {
249 fcpListenerManager.fireReceivedStartedCompression(new StartedCompression(fcpMessage));
250 } else if ("FinishedCompression".equals(messageName)) {
251 fcpListenerManager.fireReceivedFinishedCompression(new FinishedCompression(fcpMessage));
252 } else if ("GetFailed".equals(messageName)) {
253 fcpListenerManager.fireReceivedGetFailed(new GetFailed(fcpMessage));
254 } else if ("PutFetchable".equals(messageName)) {
255 fcpListenerManager.fireReceivedPutFetchable(new PutFetchable(fcpMessage));
256 } else if ("PutSuccessful".equals(messageName)) {
257 fcpListenerManager.fireReceivedPutSuccessful(new PutSuccessful(fcpMessage));
258 } else if ("PutFailed".equals(messageName)) {
259 fcpListenerManager.fireReceivedPutFailed(new PutFailed(fcpMessage));
260 } else if ("DataFound".equals(messageName)) {
261 fcpListenerManager.fireReceivedDataFound(new DataFound(fcpMessage));
262 } else if ("SubscribedUSKUpdate".equals(messageName)) {
263 fcpListenerManager.fireReceivedSubscribedUSKUpdate(new SubscribedUSKUpdate(fcpMessage));
264 } else if ("IdentifierCollision".equals(messageName)) {
265 fcpListenerManager.fireReceivedIdentifierCollision(new IdentifierCollision(fcpMessage));
266 } else if ("AllData".equals(messageName)) {
267 LimitedInputStream payloadInputStream = getInputStream(FcpUtils.safeParseLong(fcpMessage.getField("DataLength")));
268 fcpListenerManager.fireReceivedAllData(new AllData(fcpMessage, payloadInputStream));
270 payloadInputStream.consume();
271 } catch (IOException ioe1) {
272 /* well, ignore. when the connection handler fails, all fails. */
274 } else if ("EndListPeerNotes".equals(messageName)) {
275 fcpListenerManager.fireReceivedEndListPeerNotes(new EndListPeerNotes(fcpMessage));
276 } else if ("EndListPeers".equals(messageName)) {
277 fcpListenerManager.fireReceivedEndListPeers(new EndListPeers(fcpMessage));
278 } else if ("SSKKeypair".equals(messageName)) {
279 fcpListenerManager.fireReceivedSSKKeypair(new SSKKeypair(fcpMessage));
280 } else if ("PeerRemoved".equals(messageName)) {
281 fcpListenerManager.fireReceivedPeerRemoved(new PeerRemoved(fcpMessage));
282 } else if ("PersistentRequestModified".equals(messageName)) {
283 fcpListenerManager.fireReceivedPersistentRequestModified(new PersistentRequestModified(fcpMessage));
284 } else if ("PersistentRequestRemoved".equals(messageName)) {
285 fcpListenerManager.fireReceivedPersistentRequestRemoved(new PersistentRequestRemoved(fcpMessage));
286 } else if ("UnknownPeerNoteType".equals(messageName)) {
287 fcpListenerManager.fireReceivedUnknownPeerNoteType(new UnknownPeerNoteType(fcpMessage));
288 } else if ("UnknownNodeIdentifier".equals(messageName)) {
289 fcpListenerManager.fireReceivedUnknownNodeIdentifier(new UnknownNodeIdentifier(fcpMessage));
290 } else if ("FCPPluginReply".equals(messageName)) {
291 LimitedInputStream payloadInputStream = getInputStream(FcpUtils.safeParseLong(fcpMessage.getField("DataLength")));
292 fcpListenerManager.fireReceivedFCPPluginReply(new FCPPluginReply(fcpMessage, payloadInputStream));
294 payloadInputStream.consume();
295 } catch (IOException ioe1) {
298 } else if ("PluginInfo".equals(messageName)) {
299 fcpListenerManager.fireReceivedPluginInfo(new PluginInfo(fcpMessage));
300 } else if ("PluginRemoved".equals(messageName)) {
301 fcpListenerManager.fireReceivedPluginRemoved(new PluginRemoved(fcpMessage));
302 } else if ("NodeData".equals(messageName)) {
303 fcpListenerManager.fireReceivedNodeData(new NodeData(fcpMessage));
304 } else if ("TestDDAReply".equals(messageName)) {
305 fcpListenerManager.fireReceivedTestDDAReply(new TestDDAReply(fcpMessage));
306 } else if ("TestDDAComplete".equals(messageName)) {
307 fcpListenerManager.fireReceivedTestDDAComplete(new TestDDAComplete(fcpMessage));
308 } else if ("ConfigData".equals(messageName)) {
309 fcpListenerManager.fireReceivedConfigData(new ConfigData(fcpMessage));
310 } else if ("NodeHello".equals(messageName)) {
311 fcpListenerManager.fireReceivedNodeHello(new NodeHello(fcpMessage));
312 } else if ("CloseConnectionDuplicateClientName".equals(messageName)) {
313 fcpListenerManager.fireReceivedCloseConnectionDuplicateClientName(new CloseConnectionDuplicateClientName(fcpMessage));
314 } else if ("SentFeed".equals(messageName)) {
315 fcpListenerManager.fireSentFeed(new SentFeed(fcpMessage));
316 } else if ("ReceivedBookmarkFeed".equals(messageName)) {
317 fcpListenerManager.fireReceivedBookmarkFeed(new ReceivedBookmarkFeed(fcpMessage));
319 fcpListenerManager.fireMessageReceived(fcpMessage);
324 * Handles a disconnect from the node.
327 * The exception that caused the disconnect, or
328 * <code>null</code> if there was no exception
330 synchronized void handleDisconnect(Throwable throwable) {
331 FcpUtils.close(remoteInputStream);
332 FcpUtils.close(remoteOutputStream);
333 FcpUtils.close(remoteSocket);
334 if (connectionHandler != null) {
335 connectionHandler.stop();
336 connectionHandler = null;
337 fcpListenerManager.fireConnectionClosed(throwable);
346 * Incremets the counter in {@link #incomingMessageStatistics} by
347 * <cod>1</code> for the given message name.
350 * The name of the message to count
352 private void countMessage(String name) {
354 if (incomingMessageStatistics.containsKey(name)) {
355 oldValue = incomingMessageStatistics.get(name);
357 incomingMessageStatistics.put(name, oldValue + 1);
358 logger.finest("count for " + name + ": " + (oldValue + 1));
362 * Returns a limited input stream from the node’s input stream.
365 * The length of the stream
366 * @return The limited input stream
368 private synchronized LimitedInputStream getInputStream(long dataLength) {
369 if (dataLength <= 0) {
370 return new LimitedInputStream(null, 0);
372 return new LimitedInputStream(remoteInputStream, dataLength);
376 * A wrapper around an {@link InputStream} that only supplies a limit
377 * number of bytes from the underlying input stream.
379 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
381 private static class LimitedInputStream extends FilterInputStream {
383 /** The remaining number of bytes that can be read. */
384 private long remaining;
387 * Creates a new LimitedInputStream that supplies at most
388 * <code>length</code> bytes from the given input stream.
393 * The number of bytes to read
395 public LimitedInputStream(InputStream inputStream, long length) {
401 * @see java.io.FilterInputStream#available()
404 public synchronized int available() throws IOException {
405 if (remaining == 0) {
408 return (int) Math.min(super.available(), Math.min(Integer.MAX_VALUE, remaining));
412 * @see java.io.FilterInputStream#read()
415 public synchronized int read() throws IOException {
425 * @see java.io.FilterInputStream#read(byte[], int, int)
428 public synchronized int read(byte[] b, int off, int len) throws IOException {
429 if (remaining == 0) {
432 int toCopy = (int) Math.min(len, Math.min(remaining, Integer.MAX_VALUE));
433 int read = super.read(b, off, toCopy);
439 * @see java.io.FilterInputStream#skip(long)
442 public synchronized long skip(long n) throws IOException {
443 if ((n < 0) || (remaining == 0)) {
446 long skipped = super.skip(Math.min(n, remaining));
447 remaining -= skipped;
452 * {@inheritDoc} This method does nothing, as {@link #mark(int)} and
453 * {@link #reset()} are not supported.
455 * @see java.io.FilterInputStream#mark(int)
458 public synchronized void mark(int readlimit) {
465 * @see java.io.FilterInputStream#markSupported()
466 * @return <code>false</code>
469 public boolean markSupported() {
474 * {@inheritDoc} This method does nothing, as {@link #mark(int)} and
475 * {@link #reset()} are not supported.
477 * @see java.io.FilterInputStream#reset()
480 public synchronized void reset() throws IOException {
485 * Consumes the input stream, i.e. read all bytes until the limit is
488 * @throws IOException
489 * if an I/O error occurs
491 public synchronized void consume() throws IOException {
492 while (remaining > 0) {