X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fnet%2Fpterodactylus%2Ffcp%2Fhighlevel%2FHighLevelClient.java;h=e263454b6f0e38fd3f4a192a47f05133ad34d174;hb=dca50466338d343fe4acb888554d8b11a8de0385;hp=018c1154aa7a1b7c7c62c90a18517daf70b49c02;hpb=ecd58cf259ca44c419221435ee881a711775e07f;p=jFCPlib.git diff --git a/src/net/pterodactylus/fcp/highlevel/HighLevelClient.java b/src/net/pterodactylus/fcp/highlevel/HighLevelClient.java index 018c115..e263454 100644 --- a/src/net/pterodactylus/fcp/highlevel/HighLevelClient.java +++ b/src/net/pterodactylus/fcp/highlevel/HighLevelClient.java @@ -27,10 +27,13 @@ import java.io.IOException; import java.net.InetAddress; import java.net.URL; import java.net.UnknownHostException; +import java.util.ArrayList; import java.util.Collections; import java.util.HashMap; +import java.util.List; import java.util.Map; import java.util.Map.Entry; +import java.util.logging.Level; import java.util.logging.Logger; import net.pterodactylus.fcp.AddPeer; @@ -53,6 +56,7 @@ import net.pterodactylus.fcp.GenerateSSK; import net.pterodactylus.fcp.GetFailed; import net.pterodactylus.fcp.IdentifierCollision; import net.pterodactylus.fcp.ListPeers; +import net.pterodactylus.fcp.ListPersistentRequests; import net.pterodactylus.fcp.NodeData; import net.pterodactylus.fcp.NodeHello; import net.pterodactylus.fcp.NodeRef; @@ -81,11 +85,12 @@ import net.pterodactylus.fcp.TestDDAResponse; import net.pterodactylus.fcp.URIGenerated; import net.pterodactylus.fcp.UnknownNodeIdentifier; import net.pterodactylus.fcp.UnknownPeerNoteType; +import net.pterodactylus.fcp.WatchGlobal; /** * A high-level client that allows simple yet full-featured access to a Freenet * node. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> * @version $Id$ */ @@ -100,19 +105,19 @@ public class HighLevelClient { /** The name of the client. */ private final String clientName; - /** The address of the node. */ - private InetAddress address; - - /** The port number of the node. */ - private int port; - /** The FCP connection to the node. */ - private FcpConnection fcpConnection; + private FcpConnection fcpConnection = null; + + /** Listeners for high-level client events. */ + private List highLevelClientListeners = Collections.synchronizedList(new ArrayList()); /** The listener for the connection. */ private HighLevelClientFcpListener highLevelClientFcpListener = new HighLevelClientFcpListener(); - /** The callback for {@link #connect()}. */ + /** The listeners for progress events. */ + private List highLevelProgressListeners = Collections.synchronizedList(new ArrayList()); + + /** The callback for {@link #connect(String)}. */ private HighLevelCallback connectCallback; /** Mapping from request identifiers to callbacks. */ @@ -130,107 +135,208 @@ public class HighLevelClient { /** Mapping from request identifiers to download callbacks. */ private Map> downloadCallbacks = Collections.synchronizedMap(new HashMap>()); + /** The callback for {@link #getRequests()}. */ + private HighLevelCallback requestListCallback; + /** * Creates a new high-level client that connects to a node on * localhost. - * + * * @param clientName * The name of the client - * @throws UnknownHostException - * if the hostname of the node can not be resolved. */ - public HighLevelClient(String clientName) throws UnknownHostException { - this(clientName, "localhost"); + public HighLevelClient(String clientName) { + this.clientName = clientName; } + // + // EVENT MANAGEMENT + // + /** - * Creates a new high-level client that connects to a node on the given - * host. - * - * @param clientName - * The name of the client - * @param host - * The hostname of the node - * @throws UnknownHostException - * if the hostname of the node can not be resolved. + * Adds the given high-level client listener to list of listeners. + * + * @param highLevelClientListener + * The listener to add */ - public HighLevelClient(String clientName, String host) throws UnknownHostException { - this(clientName, host, FcpConnection.DEFAULT_PORT); + public void addHighLevelClientListener(HighLevelClientListener highLevelClientListener) { + highLevelClientListeners.add(highLevelClientListener); } /** - * Creates a new high-level client that connects to a node on the given - * host. - * - * @param clientName - * The name of the client - * @param host - * The hostname of the node - * @param port - * The port number of the node - * @throws UnknownHostException - * if the hostname of the node can not be resolved. + * Removes the given high-level client listener from the list of listeners. + * + * @param highLevelClientListener + * The listener to remove */ - public HighLevelClient(String clientName, String host, int port) throws UnknownHostException { - this(clientName, InetAddress.getByName(host), port); + public void removeHighLevelClientListener(HighLevelClientListener highLevelClientListener) { + highLevelClientListeners.remove(highLevelClientListener); } /** - * Creates a new high-level client that connects to a node at the given - * address. - * - * @param clientName - * The name of the client - * @param address - * The address of the node - * @param port - * The port number of the node + * Notifies all listeners that a client has connected. */ - public HighLevelClient(String clientName, InetAddress address, int port) { - this.clientName = clientName; - this.address = address; - this.port = port; + private void fireClientConnected() { + for (HighLevelClientListener highLevelClientListener : highLevelClientListeners) { + highLevelClientListener.clientConnected(this); + } + } + + /** + * Notifies all listeners that a client has disconnected. + * + * @param throwable + * The exception that caused the disconnect, or null + * if there was no exception + */ + private void fireClientDisconnected(Throwable throwable) { + for (HighLevelClientListener highLevelClientListener : highLevelClientListeners) { + highLevelClientListener.clientDisconnected(this, throwable); + } + } + + /** + * Adds a high-level progress listener. + * + * @param highLevelProgressListener + * The high-level progress listener to add + */ + public void addHighLevelProgressListener(HighLevelProgressListener highLevelProgressListener) { + highLevelProgressListeners.add(highLevelProgressListener); + } + + /** + * Removes a high-level progress listener. + * + * @param highLevelProgressListener + * The high-level progress listener to remove + */ + public void removeHighLevelProgressListener(HighLevelProgressListener highLevelProgressListener) { + highLevelProgressListeners.remove(highLevelProgressListener); + } + + /** + * Notifies all listeners that the request with the given identifier made + * some progress. + * + * @param identifier + * The identifier of the request + * @param highLevelProgress + * The progress of the request + */ + private void fireProgressReceived(String identifier, HighLevelProgress highLevelProgress) { + for (HighLevelProgressListener highLevelProgressListener : highLevelProgressListeners) { + highLevelProgressListener.progressReceived(this, identifier, highLevelProgress); + } } // // ACCESSORS // + /** + * Returns the FCP connection that backs this high-level client. This method + * should be used with care as fiddling around with the FCP connection can + * easily break the high-level client if you don’t know what you’re doing! + * + * @return The FCP connection of this client + */ + public FcpConnection getFcpConnection() { + return fcpConnection; + } + + /** + * Returns whether the node is connected. + * + * @return true if the node is currently connected, + * false otherwise + */ + public boolean isConnected() { + return fcpConnection != null; + } + // // ACTIONS // /** * Connects the client. - * + * + * @param hostname + * The hostname of the node + * @return A callback with a connection result + * @throws UnknownHostException + * if the hostname can not be resolved + * @throws IOException + * if an I/O error occurs communicating with the node + */ + public HighLevelCallback connect(String hostname) throws UnknownHostException, IOException { + return connect(hostname, 9481); + } + + /** + * Connects the client. + * + * @param hostname + * The hostname of the node + * @param port + * The port number of the node + * @return A callback with a connection result + * @throws UnknownHostException + * if the hostname can not be resolved + * @throws IOException + * if an I/O error occurs communicating with the node + */ + public HighLevelCallback connect(String hostname, int port) throws UnknownHostException, IOException { + return connect(InetAddress.getByName(hostname), port); + } + + /** + * Connects the client. + * + * @param address + * The address of the node + * @param port + * The port number of the node * @return A callback with a connection result * @throws IOException * if an I/O error occurs communicating with the node */ - public HighLevelCallback connect() throws IOException { - fcpConnection = new FcpConnection(address, port); - fcpConnection.addFcpListener(highLevelClientFcpListener); - ClientHello clientHello = new ClientHello(clientName); - connectCallback = new HighLevelCallback(new ConnectResult()); - fcpConnection.sendMessage(clientHello); - return connectCallback; + public HighLevelCallback connect(InetAddress address, int port) throws IOException { + try { + synchronized (this) { + fcpConnection = new FcpConnection(address, port); + } + fcpConnection.addFcpListener(highLevelClientFcpListener); + fcpConnection.connect(); + ClientHello clientHello = new ClientHello(clientName); + connectCallback = new HighLevelCallback(new ConnectResult()); + fcpConnection.sendMessage(clientHello); + return connectCallback; + } catch (IOException ioe1) { + fcpConnection = null; + throw ioe1; + } } /** * Disconnects the client from the node. */ public void disconnect() { - fcpConnection.disconnect(); + disconnect(null); } /** * Generates a new SSK keypair. - * + * * @return A callback with the keypair * @throws IOException * if an I/O error occurs communicating with the node + * @throws HighLevelException + * if the client is not connected */ - public HighLevelCallback generateKey() throws IOException { + public HighLevelCallback generateKey() throws IOException, HighLevelException { + checkConnection(); String identifier = generateIdentifier("generateSSK"); GenerateSSK generateSSK = new GenerateSSK(identifier); HighLevelCallback keyGenerationCallback = new HighLevelCallback(new KeyGenerationResult(identifier)); @@ -240,13 +346,34 @@ public class HighLevelClient { } /** + * Sets whether to watch the global queue. + * + * @param enabled + * true to watch the global queue in addition to + * the client-local queue, false to only watch the + * client-local queue + * @throws IOException + * if an I/O error occurs communicating with the node + * @throws HighLevelException + * if the client is not connected + */ + public void setWatchGlobal(boolean enabled) throws IOException, HighLevelException { + checkConnection(); + WatchGlobal watchGlobal = new WatchGlobal(enabled); + fcpConnection.sendMessage(watchGlobal); + } + + /** * Gets a list of all peers from the node. - * + * * @return A callback with the peer list * @throws IOException * if an I/O error occurs with the node + * @throws HighLevelException + * if the client is not connected */ - public HighLevelCallback getPeers() throws IOException { + public HighLevelCallback getPeers() throws IOException, HighLevelException { + checkConnection(); String identifier = generateIdentifier("listPeers"); ListPeers listPeers = new ListPeers(identifier, true, true); HighLevelCallback peerListCallback = new HighLevelCallback(new PeerListResult(identifier)); @@ -257,14 +384,17 @@ public class HighLevelClient { /** * Adds the peer whose noderef is stored in the given file. - * + * * @param nodeRefFile * The name of the file the peer’s noderef is stored in * @return A peer callback * @throws IOException * if an I/O error occurs communicating with the node + * @throws HighLevelException + * if the client is not connected */ - public HighLevelCallback addPeer(String nodeRefFile) throws IOException { + public HighLevelCallback addPeer(String nodeRefFile) throws IOException, HighLevelException { + checkConnection(); String identifier = generateIdentifier("addPeer"); AddPeer addPeer = new AddPeer(nodeRefFile); HighLevelCallback peerCallback = new HighLevelCallback(new PeerResult(identifier)); @@ -275,14 +405,17 @@ public class HighLevelClient { /** * Adds the peer whose noderef is stored in the given file. - * + * * @param nodeRefURL * The URL where the peer’s noderef is stored * @return A peer callback * @throws IOException * if an I/O error occurs communicating with the node + * @throws HighLevelException + * if the client is not connected */ - public HighLevelCallback addPeer(URL nodeRefURL) throws IOException { + public HighLevelCallback addPeer(URL nodeRefURL) throws IOException, HighLevelException { + checkConnection(); String identifier = generateIdentifier("addPeer"); AddPeer addPeer = new AddPeer(nodeRefURL); HighLevelCallback peerCallback = new HighLevelCallback(new PeerResult(identifier)); @@ -293,14 +426,17 @@ public class HighLevelClient { /** * Adds the peer whose noderef is stored in the given file. - * + * * @param nodeRef * The peer’s noderef * @return A peer callback * @throws IOException * if an I/O error occurs communicating with the node + * @throws HighLevelException + * if the client is not connected */ - public HighLevelCallback addPeer(NodeRef nodeRef) throws IOException { + public HighLevelCallback addPeer(NodeRef nodeRef) throws IOException, HighLevelException { + checkConnection(); String identifier = generateIdentifier("addPeer"); AddPeer addPeer = new AddPeer(nodeRef); HighLevelCallback peerCallback = new HighLevelCallback(new PeerResult(identifier)); @@ -313,7 +449,7 @@ public class HighLevelClient { * Checks whether direct disk access for the given directory is possible. * You have to perform this check before you can upload or download anything * from or the disk directly! - * + * * @param directory * The directory to check * @param wantRead @@ -322,8 +458,12 @@ public class HighLevelClient { * Whether you want to write to the given directory * @return A direct disk access callback * @throws IOException + * if an I/O error occurs communicating with the node + * @throws HighLevelException + * if the client is not connected */ - public HighLevelCallback checkDirectDiskAccess(String directory, boolean wantRead, boolean wantWrite) throws IOException { + public HighLevelCallback checkDirectDiskAccess(String directory, boolean wantRead, boolean wantWrite) throws IOException, HighLevelException { + checkConnection(); TestDDARequest testDDARequest = new TestDDARequest(directory, wantRead, wantWrite); HighLevelCallback directDiskAccessCallback = new HighLevelCallback(new DirectDiskAccessResult(directory)); directDiskAccessCallbacks.put(directory, directDiskAccessCallback); @@ -335,7 +475,7 @@ public class HighLevelClient { * Starts a download. Files can either be download to disk or streamed from * the node. When downloading to disk you have to perform a direct disk * access check for the directory you want to put the downloaded file in! - * + * * @see #checkDirectDiskAccess(String, boolean, boolean) * @param uri * The URI to get @@ -348,8 +488,11 @@ public class HighLevelClient { * @return A download result * @throws IOException * if an I/O error occurs communicating with the node + * @throws HighLevelException + * if the client is not connected */ - public HighLevelProgressCallback download(String uri, String filename, boolean global) throws IOException { + public HighLevelProgressCallback download(String uri, String filename, boolean global) throws IOException, HighLevelException { + checkConnection(); String identifier = generateIdentifier("download"); ClientGet clientGet = new ClientGet(uri, identifier, (filename == null) ? ReturnType.direct : ReturnType.disk); clientGet.setGlobal(global); @@ -359,13 +502,51 @@ public class HighLevelClient { return downloadCallback; } + /** + * Requests a list of all running requests from the node. + * + * @return The request list result + * @throws IOException + * if an I/O errors communicating with the node + * @throws HighLevelException + * if the client is not connected + */ + public HighLevelCallback getRequests() throws IOException, HighLevelException { + checkConnection(); + String identifier = generateIdentifier("list-persistent-requests"); + ListPersistentRequests listPersistentRequests = new ListPersistentRequests(); + synchronized (syncObject) { + if (requestListCallback != null) { + logger.log(Level.SEVERE, "getRequests() called with request still running!"); + } + requestListCallback = new HighLevelCallback(new RequestListResult(identifier)); + } + fcpConnection.sendMessage(listPersistentRequests); + return requestListCallback; + } + // // PRIVATE METHODS // /** + * Checks whether the client is already connected and throws an exception if + * it is not. + * + * @throws HighLevelException + * if the client is not connected + */ + private void checkConnection() throws HighLevelException { + synchronized (this) { + if (fcpConnection == null) { + throw new HighLevelException("client is not connected"); + } + } + } + + /** * Generates an identifier for the given function. - * + * * @param function * The name of the function * @return An identifier @@ -375,8 +556,23 @@ public class HighLevelClient { } /** + * Disconnects the client from the node, handing the given Throwable to + * {@link #fireClientDisconnected(Throwable)}. + * + * @param throwable + * The exception that caused the disconnect, or null + * if there was no exception + */ + private void disconnect(Throwable throwable) { + if (fcpConnection != null) { + fcpConnection.close(); + } + fcpConnection = null; + } + + /** * FCP listener for {@link HighLevelClient}. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> * @version $Id$ */ @@ -399,7 +595,7 @@ public class HighLevelClient { /** * Searches all callback collections for a callback with the given * identifier and cancels it. - * + * * @param identifier * The identifier to search for, or null to * cancel all pending requests @@ -412,34 +608,39 @@ public class HighLevelClient { connectCallback.setDone(); connectCallback = null; } + if (requestListCallback != null) { + requestListCallback.getIntermediaryResult().setFailed(true); + requestListCallback.setDone(); + requestListCallback = null; + } } if (identifier == null) { /* key generation callbacks */ - for (Entry> keyGenerationEntry: keyGenerationCallbacks.entrySet()) { + for (Entry> keyGenerationEntry : keyGenerationCallbacks.entrySet()) { keyGenerationEntry.getValue().getIntermediaryResult().setFailed(true); keyGenerationEntry.getValue().setDone(); } keyGenerationCallbacks.clear(); /* peer list callbacks. */ - for (Entry> peerListEntry: peerListCallbacks.entrySet()) { + for (Entry> peerListEntry : peerListCallbacks.entrySet()) { peerListEntry.getValue().getIntermediaryResult().setFailed(true); peerListEntry.getValue().setDone(); } peerListCallbacks.clear(); /* peer callbacks. */ - for (Entry> peerEntry: peerCallbacks.entrySet()) { + for (Entry> peerEntry : peerCallbacks.entrySet()) { peerEntry.getValue().getIntermediaryResult().setFailed(true); peerEntry.getValue().setDone(); } peerCallbacks.clear(); /* direct disk access callbacks. */ - for (Entry> directDiskAccessEntry: directDiskAccessCallbacks.entrySet()) { + for (Entry> directDiskAccessEntry : directDiskAccessCallbacks.entrySet()) { directDiskAccessEntry.getValue().getIntermediaryResult().setFailed(true); directDiskAccessEntry.getValue().setDone(); } directDiskAccessCallbacks.clear(); /* download callbacks. */ - for (Entry> downloadEntry: downloadCallbacks.entrySet()) { + for (Entry> downloadEntry : downloadCallbacks.entrySet()) { downloadEntry.getValue().getIntermediaryResult().setFailed(true); downloadEntry.getValue().setDone(); } @@ -480,7 +681,7 @@ public class HighLevelClient { /** * Reads the given file and returns the first line of the file. - * + * * @param readFilename * The name of the file to read * @return The content of the file @@ -504,7 +705,7 @@ public class HighLevelClient { /** * Writes the given content to the given file. - * + * * @param directDiskAccessResult * The DDA result * @param writeFilename @@ -530,7 +731,7 @@ public class HighLevelClient { /** * Cleans up any files that written for the given result. - * + * * @param directDiskAccessResult * The direct disk access result */ @@ -549,14 +750,17 @@ public class HighLevelClient { // /** - * @see net.pterodactylus.fcp.FcpListener#connectionClosed(net.pterodactylus.fcp.FcpConnection) + * @see net.pterodactylus.fcp.FcpListener#connectionClosed(net.pterodactylus.fcp.FcpConnection, + * Throwable) */ @SuppressWarnings("synthetic-access") - public void connectionClosed(FcpConnection fcpConnection) { + public void connectionClosed(FcpConnection fcpConnection, Throwable throwable) { if (fcpConnection != HighLevelClient.this.fcpConnection) { return; } cancelIdentifier(null); + disconnect(throwable); + fireClientDisconnected(throwable); } /** @@ -620,8 +824,19 @@ public class HighLevelClient { * @see net.pterodactylus.fcp.FcpListener#receivedEndListPersistentRequests(net.pterodactylus.fcp.FcpConnection, * net.pterodactylus.fcp.EndListPersistentRequests) */ + @SuppressWarnings("synthetic-access") public void receivedEndListPersistentRequests(FcpConnection fcpConnection, EndListPersistentRequests endListPersistentRequests) { - /* TODO */ + if (fcpConnection != HighLevelClient.this.fcpConnection) { + return; + } + synchronized (syncObject) { + if (HighLevelClient.this.requestListCallback == null) { + logger.log(Level.WARNING, "got EndListPersistentRequests without running request!"); + return; + } + requestListCallback.setDone(); + requestListCallback = null; + } } /** @@ -690,6 +905,7 @@ public class HighLevelClient { connectCallback.setDone(); connectCallback = null; } + fireClientConnected(); } /** @@ -744,9 +960,16 @@ public class HighLevelClient { if (fcpConnection != HighLevelClient.this.fcpConnection) { return; } + synchronized (syncObject) { + if (requestListCallback != null) { + RequestListResult requestListResult = requestListCallback.getIntermediaryResult(); + requestListResult.addRequestResult(new GetRequestResult(persistentGet)); + return; + } + } String identifier = persistentGet.getIdentifier(); if (downloadCallbacks.containsKey(identifier)) { - /* ignore, because a download does not care about this. */ + /* TODO */ return; } } @@ -755,16 +978,36 @@ public class HighLevelClient { * @see net.pterodactylus.fcp.FcpListener#receivedPersistentPut(net.pterodactylus.fcp.FcpConnection, * net.pterodactylus.fcp.PersistentPut) */ + @SuppressWarnings("synthetic-access") public void receivedPersistentPut(FcpConnection fcpConnection, PersistentPut persistentPut) { - /* TODO */ + if (fcpConnection != HighLevelClient.this.fcpConnection) { + return; + } + synchronized (syncObject) { + if (requestListCallback != null) { + RequestListResult requestListResult = requestListCallback.getIntermediaryResult(); + requestListResult.addRequestResult(new PutRequestResult(persistentPut)); + return; + } + } } /** * @see net.pterodactylus.fcp.FcpListener#receivedPersistentPutDir(net.pterodactylus.fcp.FcpConnection, * net.pterodactylus.fcp.PersistentPutDir) */ + @SuppressWarnings("synthetic-access") public void receivedPersistentPutDir(FcpConnection fcpConnection, PersistentPutDir persistentPutDir) { - /* TODO */ + if (fcpConnection != HighLevelClient.this.fcpConnection) { + return; + } + synchronized (syncObject) { + if (requestListCallback != null) { + RequestListResult requestListResult = requestListCallback.getIntermediaryResult(); + requestListResult.addRequestResult(new PutDirRequestResult(persistentPutDir)); + return; + } + } } /** @@ -870,10 +1113,9 @@ public class HighLevelClient { downloadResult.setFatallyFailedBlocks(simpleProgress.getFatallyFailed()); downloadResult.setTotalFinalized(simpleProgress.isFinalizedTotal()); downloadCallback.progressUpdated(); - return; } - /* unknown identifier? */ - logger.warning("unknown identifier for SimpleProgress: " + identifier); + HighLevelProgress highLevelProgress = new HighLevelProgress(identifier, simpleProgress.getTotal(), simpleProgress.getRequired(), simpleProgress.getSucceeded(), simpleProgress.getFailed(), simpleProgress.getFatallyFailed(), simpleProgress.isFinalizedTotal()); + fireProgressReceived(identifier, highLevelProgress); } /**