X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Ffcp%2Fhighlevel%2FFcpClient.java;h=6d51c92432ff7c4b09c5235c3d019c1e87831271;hb=72420249ffac25cab4c5c9e4ff737f6930a9d14b;hp=b738e262ca8431c69246d4188e4a38d2ca4b9096;hpb=ccd328332da86e58a98e991c3d4e31e56e906547;p=jFCPlib.git diff --git a/src/main/java/net/pterodactylus/fcp/highlevel/FcpClient.java b/src/main/java/net/pterodactylus/fcp/highlevel/FcpClient.java index b738e26..6d51c92 100644 --- a/src/main/java/net/pterodactylus/fcp/highlevel/FcpClient.java +++ b/src/main/java/net/pterodactylus/fcp/highlevel/FcpClient.java @@ -1,9 +1,9 @@ /* - * jFCPlib - FcpClient.java - Copyright © 2009 David Roden + * jFCPlib - FcpClient.java - Copyright © 2009–2016 David Roden * - * This program is free software; you can redistribute it and/or modify + * 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 2 of the License, or + * 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, @@ -12,12 +12,15 @@ * 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, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * along with this program. If not, see . */ package net.pterodactylus.fcp.highlevel; +import static com.google.common.collect.FluentIterable.from; +import static java.util.stream.Collectors.toMap; + +import java.io.Closeable; import java.io.IOException; import java.io.InputStream; import java.net.InetAddress; @@ -28,13 +31,17 @@ import java.util.Collections; import java.util.HashMap; import java.util.HashSet; import java.util.Map; -import java.util.Set; import java.util.Map.Entry; +import java.util.Set; import java.util.concurrent.CountDownLatch; +import java.util.concurrent.atomic.AtomicReference; 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; import net.pterodactylus.fcp.DataFound; import net.pterodactylus.fcp.EndListPeerNotes; import net.pterodactylus.fcp.EndListPeers; @@ -45,6 +52,7 @@ import net.pterodactylus.fcp.FcpAdapter; import net.pterodactylus.fcp.FcpConnection; import net.pterodactylus.fcp.FcpListener; import net.pterodactylus.fcp.GenerateSSK; +import net.pterodactylus.fcp.GetConfig; import net.pterodactylus.fcp.GetFailed; import net.pterodactylus.fcp.GetNode; import net.pterodactylus.fcp.ListPeerNotes; @@ -65,9 +73,8 @@ import net.pterodactylus.fcp.RemovePeer; import net.pterodactylus.fcp.SSKKeypair; import net.pterodactylus.fcp.SimpleProgress; import net.pterodactylus.fcp.WatchGlobal; -import net.pterodactylus.util.filter.Filter; -import net.pterodactylus.util.filter.Filters; -import net.pterodactylus.util.thread.ObjectWrapper; + +import com.google.common.base.Predicate; /** * High-level FCP client that hides the details of the underlying FCP @@ -75,7 +82,7 @@ import net.pterodactylus.util.thread.ObjectWrapper; * * @author David ‘Bombe’ Roden <bombe@freenetproject.org> */ -public class FcpClient { +public class FcpClient implements Closeable { /** Object used for synchronization. */ private final Object syncObject = new Object(); @@ -92,6 +99,9 @@ public class FcpClient { /** Whether the client is currently connected. */ private volatile boolean connected; + /** The listener for “connection closed” events. */ + private FcpListener connectionClosedListener; + /** * Creates an FCP client with the given name. * @@ -147,7 +157,7 @@ public class FcpClient { * The Freenet node’s FCP port */ public FcpClient(InetAddress host, int port) { - this(new FcpConnection(host, port)); + this(new FcpConnection(host, port), false); } /** @@ -173,7 +183,7 @@ public class FcpClient { public FcpClient(FcpConnection fcpConnection, boolean connected) { this.fcpConnection = fcpConnection; this.connected = connected; - fcpConnection.addFcpListener(new FcpAdapter() { + connectionClosedListener = new FcpAdapter() { /** * {@inheritDoc} @@ -184,7 +194,8 @@ public class FcpClient { FcpClient.this.connected = false; fcpClientListenerManager.fireFcpClientDisconnected(); } - }); + }; + fcpConnection.addFcpListener(connectionClosedListener); } // @@ -293,9 +304,91 @@ public class FcpClient { @SuppressWarnings("synthetic-access") public void receivedNodeHello(FcpConnection fcpConnection, NodeHello nodeHello) { FcpClient.this.nodeHello = nodeHello; - completionLatch.countDown(); + complete(); + } + }.execute(); + } + + /** + * Returns the file with the given URI. The retrieved data will be run + * through Freenet’s content filter. + * + * @param uri + * The URI to get + * @return The result of the get request + * @throws IOException + * if an I/O error occurs + * @throws FcpException + * if an FCP error occurs + */ + public GetResult getURI(final String uri) throws IOException, FcpException { + return getURI(uri, true); + } + + /** + * Returns the file with the given URI. + * + * @param uri + * The URI to get + * @param filterData + * {@code true} to filter the retrieved data, {@code false} + * otherwise + * @return The result of the get request + * @throws IOException + * if an I/O error occurs + * @throws FcpException + * if an FCP error occurs + */ + public GetResult getURI(final String uri, final boolean filterData) throws IOException, FcpException { + checkConnected(true); + final GetResult getResult = new GetResult(); + new ExtendedFcpAdapter() { + + @SuppressWarnings("synthetic-access") + private final String identifier = createIdentifier("client-get"); + + @Override + @SuppressWarnings("synthetic-access") + public void run() throws IOException { + ClientGet clientGet = new ClientGet(uri, identifier); + clientGet.setFilterData(filterData); + fcpConnection.sendMessage(clientGet); + } + + @Override + public void receivedGetFailed(FcpConnection fcpConnection, GetFailed getFailed) { + if (!getFailed.getIdentifier().equals(identifier)) { + return; + } + if ((getFailed.getCode() == 27) || (getFailed.getCode() == 24)) { + /* redirect! */ + String newUri = getFailed.getRedirectURI(); + getResult.realUri(newUri); + try { + ClientGet clientGet = new ClientGet(newUri, identifier); + clientGet.setFilterData(filterData); + fcpConnection.sendMessage(clientGet); + } catch (IOException ioe1) { + getResult.success(false).exception(ioe1); + complete(); + } + } else { + getResult.success(false).errorCode(getFailed.getCode()); + complete(); + } + } + + @Override + public void receivedAllData(FcpConnection fcpConnection, AllData allData) { + if (!allData.getIdentifier().equals(identifier)) { + return; + } + getResult.success(true).contentType(allData.getContentType()).contentLength(allData.getDataLength()).inputStream(allData.getPayloadInputStream()); + complete(); } + }.execute(); + return getResult; } /** @@ -309,6 +402,14 @@ public class FcpClient { } /** + * {@inheritDoc} + */ + @Override + public void close() { + disconnect(); + } + + /** * Returns whether this client is currently connected. * * @return {@code true} if the client is currently connected, {@code false} @@ -318,6 +419,13 @@ public class FcpClient { return connected; } + /** + * Detaches this client from its underlying FCP connection. + */ + public void detach() { + fcpConnection.removeFcpListener(connectionClosedListener); + } + // // PEER MANAGEMENT // @@ -368,7 +476,7 @@ public class FcpClient { @Override public void receivedEndListPeers(FcpConnection fcpConnection, EndListPeers endListPeers) { if (endListPeers.getIdentifier().equals(identifier)) { - completionLatch.countDown(); + complete(); } } }.execute(); @@ -491,8 +599,8 @@ public class FcpClient { /** * Adds a peer, reading the noderef of the peer from the given file. - * Note: the file to read the noderef from has to reside on - * the same machine as the node! + * Note: the file to read the noderef from has to reside + * on the same machine as the node! * * @param file * The name of the file containing the peer’s noderef @@ -535,7 +643,7 @@ public class FcpClient { */ @Override public void receivedPeer(FcpConnection fcpConnection, Peer peer) { - completionLatch.countDown(); + complete(); } }.execute(); } @@ -578,7 +686,7 @@ public class FcpClient { */ @Override public void receivedPeer(FcpConnection fcpConnection, Peer peer) { - completionLatch.countDown(); + complete(); } }.execute(); } @@ -610,7 +718,7 @@ public class FcpClient { */ @Override public void receivedPeerRemoved(FcpConnection fcpConnection, PeerRemoved peerRemoved) { - completionLatch.countDown(); + complete(); } }.execute(); } @@ -631,7 +739,7 @@ public class FcpClient { * if an FCP error occurs */ public PeerNote getPeerNote(final Peer peer) throws IOException, FcpException { - final ObjectWrapper objectWrapper = new ObjectWrapper(); + final AtomicReference objectWrapper = new AtomicReference(); new ExtendedFcpAdapter() { /** @@ -658,7 +766,7 @@ public class FcpClient { */ @Override public void receivedEndListPeerNotes(FcpConnection fcpConnection, EndListPeerNotes endListPeerNotes) { - completionLatch.countDown(); + complete(); } }.execute(); return objectWrapper.get(); @@ -697,7 +805,7 @@ public class FcpClient { @Override public void receivedPeer(FcpConnection fcpConnection, Peer receivedPeer) { if (receivedPeer.getIdentity().equals(peer.getIdentity())) { - completionLatch.countDown(); + complete(); } } }.execute(); @@ -717,7 +825,7 @@ public class FcpClient { * if an FCP error occurs */ public SSKKeypair generateKeyPair() throws IOException, FcpException { - final ObjectWrapper sskKeypairWrapper = new ObjectWrapper(); + final AtomicReference sskKeypairWrapper = new AtomicReference(); new ExtendedFcpAdapter() { /** @@ -735,7 +843,7 @@ public class FcpClient { @Override public void receivedSSKKeypair(FcpConnection fcpConnection, SSKKeypair sskKeypair) { sskKeypairWrapper.set(sskKeypair); - completionLatch.countDown(); + complete(); } }.execute(); return sskKeypairWrapper.get(); @@ -759,15 +867,12 @@ public class FcpClient { * if an FCP error occurs */ public Collection getGetRequests(final boolean global) throws IOException, FcpException { - return Filters.filteredCollection(getRequests(global), new Filter() { - - /** - * {@inheritDoc} - */ - public boolean filterObject(Request request) { + return from(getRequests(global)).filter(new Predicate() { + @Override + public boolean apply(Request request) { return request instanceof GetRequest; } - }); + }).toList(); } /** @@ -784,15 +889,12 @@ public class FcpClient { * if an FCP error occurs */ public Collection getPutRequests(final boolean global) throws IOException, FcpException { - return Filters.filteredCollection(getRequests(global), new Filter() { - - /** - * {@inheritDoc} - */ - public boolean filterObject(Request request) { + return from(getRequests(global)).filter(new Predicate() { + @Override + public boolean apply(Request request) { return request instanceof PutRequest; } - }); + }).toList(); } /** @@ -800,8 +902,8 @@ public class FcpClient { * * @param global * true to return requests from the global queue, - * false to only show requests from the client-local - * queue + * false to only show requests from the + * client-local queue * @return All requests * @throws IOException * if an I/O error occurs @@ -906,7 +1008,7 @@ public class FcpClient { */ @Override public void receivedEndListPersistentRequests(FcpConnection fcpConnection, EndListPersistentRequests endListPersistentRequests) { - completionLatch.countDown(); + complete(); } }.execute(); return requests.values(); @@ -979,7 +1081,7 @@ public class FcpClient { return; } pluginReplies.putAll(fcpPluginReply.getReplies()); - completionLatch.countDown(); + complete(); } }.execute(); @@ -1006,7 +1108,7 @@ public class FcpClient { * if an I/O error occurs */ public NodeData getNodeInformation(final Boolean giveOpennetRef, final Boolean withPrivate, final Boolean withVolatile) throws IOException, FcpException { - final ObjectWrapper nodeDataWrapper = new ObjectWrapper(); + final AtomicReference nodeDataWrapper = new AtomicReference(); new ExtendedFcpAdapter() { @Override @@ -1022,13 +1124,56 @@ public class FcpClient { @Override public void receivedNodeData(FcpConnection fcpConnection, NodeData nodeData) { nodeDataWrapper.set(nodeData); - completionLatch.countDown(); + complete(); } }.execute(); return nodeDataWrapper.get(); } // + // CONFIG MANAGEMENT + // + + public Map getConfig() throws IOException, FcpException { + Map results = new HashMap<>(); + new ExtendedFcpAdapter() { + @Override + public void run() throws IOException { + GetConfig getConfig = new GetConfig(createIdentifier("get-config")); + getConfig.setWithCurrent(true); + getConfig.setWithDefaults(true); + getConfig.setWithShortDescription(true); + getConfig.setWithLongDescription(true); + getConfig.setWithDataTypes(true); + getConfig.setWithExpertFlag(true); + getConfig.setWithForceWriteFlag(true); + getConfig.setWithSortOrder(true); + fcpConnection.sendMessage(getConfig); + } + + @Override + public void receivedConfigData(FcpConnection fcpConnection, ConfigData configData) { + results.putAll(filterByResponseType(configData, "current")); + results.putAll(filterByResponseType(configData, "default")); + results.putAll(filterByResponseType(configData, "shortDescription")); + results.putAll(filterByResponseType(configData, "longDescription")); + results.putAll(filterByResponseType(configData, "expertFlag")); + results.putAll(filterByResponseType(configData, "dataType")); + results.putAll(filterByResponseType(configData, "sortOrder")); + results.putAll(filterByResponseType(configData, "forceWriteFlag")); + complete(); + } + + private Map filterByResponseType(ConfigData configData, String responseType) { + return configData.getFields().entrySet().stream() + .filter(e -> e.getKey().startsWith(responseType + ".")) + .collect(toMap(Entry::getKey, Entry::getValue)); + } + }.execute(); + return results; + } + + // // PRIVATE METHODS // @@ -1074,7 +1219,7 @@ public class FcpClient { private abstract class ExtendedFcpAdapter extends FcpAdapter { /** The count down latch used to wait for completion. */ - protected final CountDownLatch completionLatch = new CountDownLatch(1); + private final CountDownLatch completionLatch = new CountDownLatch(1); /** The FCP exception, if any. */ protected FcpException fcpException; @@ -1130,6 +1275,13 @@ public class FcpClient { public abstract void run() throws IOException; /** + * Signals completion of the command processing. + */ + protected void complete() { + completionLatch.countDown(); + } + + /** * {@inheritDoc} */ @Override @@ -1152,7 +1304,7 @@ public class FcpClient { */ @Override public void receivedProtocolError(FcpConnection fcpConnection, ProtocolError protocolError) { - fcpException = new FcpException("Protocol error (" + protocolError.getCode() + ", " + protocolError.getCodeDescription()); + fcpException = FcpProtocolException.from(protocolError); completionLatch.countDown(); }