X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;ds=inline;f=src%2Fnet%2Fpterodactylus%2Ffcp%2Fhighlevel%2FHighLevelClient.java;h=1b52e728368d2078c72805b98488306bc792cea7;hb=667d508c8e782ea52151fc83d8020d3babdac731;hp=089c205899befee64538f670132e3ae56cd5a871;hpb=7e564a4ec294adc5d42209834d609556c6011883;p=jFCPlib.git diff --git a/src/net/pterodactylus/fcp/highlevel/HighLevelClient.java b/src/net/pterodactylus/fcp/highlevel/HighLevelClient.java index 089c205..1b52e72 100644 --- a/src/net/pterodactylus/fcp/highlevel/HighLevelClient.java +++ b/src/net/pterodactylus/fcp/highlevel/HighLevelClient.java @@ -35,6 +35,7 @@ import java.util.logging.Logger; import net.pterodactylus.fcp.AddPeer; import net.pterodactylus.fcp.AllData; +import net.pterodactylus.fcp.ClientGet; import net.pterodactylus.fcp.ClientHello; import net.pterodactylus.fcp.CloseConnectionDuplicateClientName; import net.pterodactylus.fcp.ConfigData; @@ -68,6 +69,7 @@ import net.pterodactylus.fcp.ProtocolError; import net.pterodactylus.fcp.PutFailed; import net.pterodactylus.fcp.PutFetchable; import net.pterodactylus.fcp.PutSuccessful; +import net.pterodactylus.fcp.ReturnType; import net.pterodactylus.fcp.SSKKeypair; import net.pterodactylus.fcp.SimpleProgress; import net.pterodactylus.fcp.StartedCompression; @@ -83,7 +85,7 @@ import net.pterodactylus.fcp.UnknownPeerNoteType; /** * A high-level client that allows simple yet full-featured access to a Freenet * node. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> * @version $Id$ */ @@ -125,10 +127,13 @@ public class HighLevelClient { /** Mapping from directories to DDA callbacks. */ private Map> directDiskAccessCallbacks = Collections.synchronizedMap(new HashMap>()); + /** Mapping from request identifiers to download callbacks. */ + private Map> downloadCallbacks = Collections.synchronizedMap(new HashMap>()); + /** * Creates a new high-level client that connects to a node on * localhost. - * + * * @param clientName * The name of the client * @throws UnknownHostException @@ -141,7 +146,7 @@ public class HighLevelClient { /** * Creates a new high-level client that connects to a node on the given * host. - * + * * @param clientName * The name of the client * @param host @@ -156,7 +161,7 @@ public class HighLevelClient { /** * Creates a new high-level client that connects to a node on the given * host. - * + * * @param clientName * The name of the client * @param host @@ -173,7 +178,7 @@ public class HighLevelClient { /** * Creates a new high-level client that connects to a node at the given * address. - * + * * @param clientName * The name of the client * @param address @@ -191,13 +196,24 @@ public class HighLevelClient { // 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; + } + // // ACTIONS // /** * Connects the client. - * + * * @return A callback with a connection result * @throws IOException * if an I/O error occurs communicating with the node @@ -215,11 +231,12 @@ public class HighLevelClient { * Disconnects the client from the node. */ public void disconnect() { + fcpConnection.disconnect(); } /** * Generates a new SSK keypair. - * + * * @return A callback with the keypair * @throws IOException * if an I/O error occurs communicating with the node @@ -227,7 +244,7 @@ public class HighLevelClient { public HighLevelCallback generateKey() throws IOException { String identifier = generateIdentifier("generateSSK"); GenerateSSK generateSSK = new GenerateSSK(identifier); - HighLevelCallback keyGenerationCallback = new HighLevelCallback(new KeyGenerationResult()); + HighLevelCallback keyGenerationCallback = new HighLevelCallback(new KeyGenerationResult(identifier)); keyGenerationCallbacks.put(identifier, keyGenerationCallback); fcpConnection.sendMessage(generateSSK); return keyGenerationCallback; @@ -235,7 +252,7 @@ public class HighLevelClient { /** * 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 @@ -243,7 +260,7 @@ public class HighLevelClient { public HighLevelCallback getPeers() throws IOException { String identifier = generateIdentifier("listPeers"); ListPeers listPeers = new ListPeers(identifier, true, true); - HighLevelCallback peerListCallback = new HighLevelCallback(new PeerListResult()); + HighLevelCallback peerListCallback = new HighLevelCallback(new PeerListResult(identifier)); peerListCallbacks.put(identifier, peerListCallback); fcpConnection.sendMessage(listPeers); return peerListCallback; @@ -251,7 +268,7 @@ 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 @@ -261,7 +278,7 @@ public class HighLevelClient { public HighLevelCallback addPeer(String nodeRefFile) throws IOException { String identifier = generateIdentifier("addPeer"); AddPeer addPeer = new AddPeer(nodeRefFile); - HighLevelCallback peerCallback = new HighLevelCallback(new PeerResult()); + HighLevelCallback peerCallback = new HighLevelCallback(new PeerResult(identifier)); peerCallbacks.put(identifier, peerCallback); fcpConnection.sendMessage(addPeer); return peerCallback; @@ -269,7 +286,7 @@ 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 @@ -279,7 +296,7 @@ public class HighLevelClient { public HighLevelCallback addPeer(URL nodeRefURL) throws IOException { String identifier = generateIdentifier("addPeer"); AddPeer addPeer = new AddPeer(nodeRefURL); - HighLevelCallback peerCallback = new HighLevelCallback(new PeerResult()); + HighLevelCallback peerCallback = new HighLevelCallback(new PeerResult(identifier)); peerCallbacks.put(identifier, peerCallback); fcpConnection.sendMessage(addPeer); return peerCallback; @@ -287,7 +304,7 @@ public class HighLevelClient { /** * Adds the peer whose noderef is stored in the given file. - * + * * @param nodeRef * The peer’s noderef * @return A peer callback @@ -297,7 +314,7 @@ public class HighLevelClient { public HighLevelCallback addPeer(NodeRef nodeRef) throws IOException { String identifier = generateIdentifier("addPeer"); AddPeer addPeer = new AddPeer(nodeRef); - HighLevelCallback peerCallback = new HighLevelCallback(new PeerResult()); + HighLevelCallback peerCallback = new HighLevelCallback(new PeerResult(identifier)); peerCallbacks.put(identifier, peerCallback); fcpConnection.sendMessage(addPeer); return peerCallback; @@ -307,7 +324,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 @@ -319,19 +336,47 @@ public class HighLevelClient { */ public HighLevelCallback checkDirectDiskAccess(String directory, boolean wantRead, boolean wantWrite) throws IOException { TestDDARequest testDDARequest = new TestDDARequest(directory, wantRead, wantWrite); - HighLevelCallback directDiskAccessCallback = new HighLevelCallback(new DirectDiskAccessResult()); + HighLevelCallback directDiskAccessCallback = new HighLevelCallback(new DirectDiskAccessResult(directory)); directDiskAccessCallbacks.put(directory, directDiskAccessCallback); fcpConnection.sendMessage(testDDARequest); return directDiskAccessCallback; } + /** + * 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 + * @param filename + * The filename to save the data to, or null to + * retrieve the data as InputStream from the + * {@link DownloadResult} + * @param global + * Whether to put the download on the global queue + * @return A download result + * @throws IOException + * if an I/O error occurs communicating with the node + */ + public HighLevelProgressCallback download(String uri, String filename, boolean global) throws IOException { + String identifier = generateIdentifier("download"); + ClientGet clientGet = new ClientGet(uri, identifier, (filename == null) ? ReturnType.direct : ReturnType.disk); + clientGet.setGlobal(global); + HighLevelProgressCallback downloadCallback = new HighLevelProgressCallback(new DownloadResult(identifier)); + downloadCallbacks.put(identifier, downloadCallback); + fcpConnection.sendMessage(clientGet); + return downloadCallback; + } + // // PRIVATE METHODS // /** * Generates an identifier for the given function. - * + * * @param function * The name of the function * @return An identifier @@ -342,7 +387,7 @@ public class HighLevelClient { /** * FCP listener for {@link HighLevelClient}. - * + * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> * @version $Id$ */ @@ -355,6 +400,7 @@ public class HighLevelClient { * Creates a new FCP listener for {@link HighLevelClient}. */ HighLevelClientFcpListener() { + /* do nothing. */ } // @@ -364,7 +410,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 @@ -403,6 +449,12 @@ public class HighLevelClient { directDiskAccessEntry.getValue().setDone(); } directDiskAccessCallbacks.clear(); + /* download callbacks. */ + for (Entry> downloadEntry: downloadCallbacks.entrySet()) { + downloadEntry.getValue().getIntermediaryResult().setFailed(true); + downloadEntry.getValue().setDone(); + } + downloadCallbacks.clear(); } else { HighLevelCallback keyGenerationCallback = keyGenerationCallbacks.remove(identifier); if (keyGenerationCallback != null) { @@ -428,12 +480,18 @@ public class HighLevelClient { directDiskAccessCallback.setDone(); return; } + HighLevelProgressCallback downloadCallback = downloadCallbacks.remove(identifier); + if (downloadCallback != null) { + downloadCallback.getIntermediaryResult().setFailed(true); + downloadCallback.setDone(); + return; + } } } /** * 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 @@ -457,7 +515,7 @@ public class HighLevelClient { /** * Writes the given content to the given file. - * + * * @param directDiskAccessResult * The DDA result * @param writeFilename @@ -483,7 +541,7 @@ public class HighLevelClient { /** * Cleans up any files that written for the given result. - * + * * @param directDiskAccessResult * The direct disk access result */ @@ -517,6 +575,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.AllData) */ public void receivedAllData(FcpConnection fcpConnection, AllData allData) { + /* TODO */ } /** @@ -524,6 +583,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.CloseConnectionDuplicateClientName) */ public void receivedCloseConnectionDuplicateClientName(FcpConnection fcpConnection, CloseConnectionDuplicateClientName closeConnectionDuplicateClientName) { + /* TODO */ } /** @@ -531,6 +591,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.ConfigData) */ public void receivedConfigData(FcpConnection fcpConnection, ConfigData configData) { + /* TODO */ } /** @@ -538,6 +599,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.DataFound) */ public void receivedDataFound(FcpConnection fcpConnection, DataFound dataFound) { + /* TODO */ } /** @@ -545,6 +607,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.EndListPeerNotes) */ public void receivedEndListPeerNotes(FcpConnection fcpConnection, EndListPeerNotes endListPeerNotes) { + /* TODO */ } /** @@ -569,6 +632,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.EndListPersistentRequests) */ public void receivedEndListPersistentRequests(FcpConnection fcpConnection, EndListPersistentRequests endListPersistentRequests) { + /* TODO */ } /** @@ -576,13 +640,27 @@ public class HighLevelClient { * net.pterodactylus.fcp.FCPPluginReply) */ public void receivedFCPPluginReply(FcpConnection fcpConnection, FCPPluginReply fcpPluginReply) { + /* TODO */ } /** * @see net.pterodactylus.fcp.FcpListener#receivedGetFailed(net.pterodactylus.fcp.FcpConnection, * net.pterodactylus.fcp.GetFailed) */ + @SuppressWarnings("synthetic-access") public void receivedGetFailed(FcpConnection fcpConnection, GetFailed getFailed) { + if (fcpConnection != HighLevelClient.this.fcpConnection) { + return; + } + String identifier = getFailed.getIdentifier(); + HighLevelProgressCallback downloadCallback = downloadCallbacks.remove(identifier); + if (downloadCallback != null) { + downloadCallback.getIntermediaryResult().setFailed(true); + downloadCallback.setDone(); + return; + } + /* unknown identifier? */ + logger.warning("unknown identifier for GetFailed: " + identifier); } /** @@ -590,6 +668,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.IdentifierCollision) */ public void receivedIdentifierCollision(FcpConnection fcpConnection, IdentifierCollision identifierCollision) { + /* TODO */ } /** @@ -597,6 +676,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.FcpMessage) */ public void receivedMessage(FcpConnection fcpConnection, FcpMessage fcpMessage) { + /* TODO */ } /** @@ -604,6 +684,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.NodeData) */ public void receivedNodeData(FcpConnection fcpConnection, NodeData nodeData) { + /* TODO */ } /** @@ -644,7 +725,9 @@ public class HighLevelClient { if (peerResult != null) { peerResult.getIntermediaryResult().setPeer(peer); peerResult.setDone(); + return; } + logger.warning("got Peer message with unknown identifier: " + identifier); } /** @@ -652,6 +735,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.PeerNote) */ public void receivedPeerNote(FcpConnection fcpConnection, PeerNote peerNote) { + /* TODO */ } /** @@ -659,13 +743,23 @@ public class HighLevelClient { * net.pterodactylus.fcp.PeerRemoved) */ public void receivedPeerRemoved(FcpConnection fcpConnection, PeerRemoved peerRemoved) { + /* TODO */ } /** * @see net.pterodactylus.fcp.FcpListener#receivedPersistentGet(net.pterodactylus.fcp.FcpConnection, * net.pterodactylus.fcp.PersistentGet) */ + @SuppressWarnings("synthetic-access") public void receivedPersistentGet(FcpConnection fcpConnection, PersistentGet persistentGet) { + if (fcpConnection != HighLevelClient.this.fcpConnection) { + return; + } + String identifier = persistentGet.getIdentifier(); + if (downloadCallbacks.containsKey(identifier)) { + /* ignore, because a download does not care about this. */ + return; + } } /** @@ -673,6 +767,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.PersistentPut) */ public void receivedPersistentPut(FcpConnection fcpConnection, PersistentPut persistentPut) { + /* TODO */ } /** @@ -680,6 +775,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.PersistentPutDir) */ public void receivedPersistentPutDir(FcpConnection fcpConnection, PersistentPutDir persistentPutDir) { + /* TODO */ } /** @@ -687,6 +783,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.PersistentRequestModified) */ public void receivedPersistentRequestModified(FcpConnection fcpConnection, PersistentRequestModified persistentRequestModified) { + /* TODO */ } /** @@ -694,6 +791,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.PersistentRequestRemoved) */ public void receivedPersistentRequestRemoved(FcpConnection fcpConnection, PersistentRequestRemoved persistentRequestRemoved) { + /* TODO */ } /** @@ -701,6 +799,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.PluginInfo) */ public void receivedPluginInfo(FcpConnection fcpConnection, PluginInfo pluginInfo) { + /* TODO */ } /** @@ -724,6 +823,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.PutFailed) */ public void receivedPutFailed(FcpConnection fcpConnection, PutFailed putFailed) { + /* TODO */ } /** @@ -731,6 +831,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.PutFetchable) */ public void receivedPutFetchable(FcpConnection fcpConnection, PutFetchable putFetchable) { + /* TODO */ } /** @@ -738,6 +839,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.PutSuccessful) */ public void receivedPutSuccessful(FcpConnection fcpConnection, PutSuccessful putSuccessful) { + /* TODO */ } /** @@ -763,7 +865,26 @@ public class HighLevelClient { * @see net.pterodactylus.fcp.FcpListener#receivedSimpleProgress(net.pterodactylus.fcp.FcpConnection, * net.pterodactylus.fcp.SimpleProgress) */ + @SuppressWarnings("synthetic-access") public void receivedSimpleProgress(FcpConnection fcpConnection, SimpleProgress simpleProgress) { + if (fcpConnection != HighLevelClient.this.fcpConnection) { + return; + } + String identifier = simpleProgress.getIdentifier(); + HighLevelProgressCallback downloadCallback = downloadCallbacks.get(identifier); + if (downloadCallback != null) { + DownloadResult downloadResult = downloadCallback.getIntermediaryResult(); + downloadResult.setTotalBlocks(simpleProgress.getTotal()); + downloadResult.setRequiredBlocks(simpleProgress.getRequired()); + downloadResult.setSuccessfulBlocks(simpleProgress.getSucceeded()); + downloadResult.setFailedBlocks(simpleProgress.getFailed()); + downloadResult.setFatallyFailedBlocks(simpleProgress.getFatallyFailed()); + downloadResult.setTotalFinalized(simpleProgress.isFinalizedTotal()); + downloadCallback.progressUpdated(); + return; + } + /* unknown identifier? */ + logger.warning("unknown identifier for SimpleProgress: " + identifier); } /** @@ -771,6 +892,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.StartedCompression) */ public void receivedStartedCompression(FcpConnection fcpConnection, StartedCompression startedCompression) { + /* TODO */ } /** @@ -778,6 +900,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.SubscribedUSKUpdate) */ public void receivedSubscribedUSKUpdate(FcpConnection fcpConnection, SubscribedUSKUpdate subscribedUSKUpdate) { + /* TODO */ } /** @@ -833,6 +956,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.URIGenerated) */ public void receivedURIGenerated(FcpConnection fcpConnection, URIGenerated uriGenerated) { + /* TODO */ } /** @@ -840,6 +964,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.UnknownNodeIdentifier) */ public void receivedUnknownNodeIdentifier(FcpConnection fcpConnection, UnknownNodeIdentifier unknownNodeIdentifier) { + /* TODO */ } /** @@ -847,6 +972,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.UnknownPeerNoteType) */ public void receivedUnknownPeerNoteType(FcpConnection fcpConnection, UnknownPeerNoteType unknownPeerNoteType) { + /* TODO */ } /** @@ -854,6 +980,7 @@ public class HighLevelClient { * net.pterodactylus.fcp.FinishedCompression) */ public void receviedFinishedCompression(FcpConnection fcpConnection, FinishedCompression finishedCompression) { + /* TODO */ } }