🥅 Throw specialized exception for protocol errors
[jFCPlib.git] / src / main / java / net / pterodactylus / fcp / highlevel / FcpClient.java
index 7364aa8..6d51c92 100644 (file)
@@ -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,
  * 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 <http://www.gnu.org/licenses/>.
  */
 
 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;
@@ -32,12 +34,14 @@ import java.util.Map;
 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;
@@ -48,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;
@@ -68,10 +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.io.TemporaryInputStream;
-import net.pterodactylus.util.thread.ObjectWrapper;
+
+import com.google.common.base.Predicate;
 
 /**
  * High-level FCP client that hides the details of the underlying FCP
@@ -301,7 +304,7 @@ public class FcpClient implements Closeable {
                        @SuppressWarnings("synthetic-access")
                        public void receivedNodeHello(FcpConnection fcpConnection, NodeHello nodeHello) {
                                FcpClient.this.nodeHello = nodeHello;
-                               completionLatch.countDown();
+                               complete();
                        }
                }.execute();
        }
@@ -367,11 +370,11 @@ public class FcpClient implements Closeable {
                                                fcpConnection.sendMessage(clientGet);
                                        } catch (IOException ioe1) {
                                                getResult.success(false).exception(ioe1);
-                                               completionLatch.countDown();
+                                               complete();
                                        }
                                } else {
                                        getResult.success(false).errorCode(getFailed.getCode());
-                                       completionLatch.countDown();
+                                       complete();
                                }
                        }
 
@@ -380,14 +383,8 @@ public class FcpClient implements Closeable {
                                if (!allData.getIdentifier().equals(identifier)) {
                                        return;
                                }
-                               InputStream temporaryInputStream;
-                               try {
-                                       temporaryInputStream = new TemporaryInputStream(allData.getPayloadInputStream());
-                                       getResult.success(true).contentType(allData.getContentType()).contentLength(allData.getDataLength()).inputStream(temporaryInputStream);
-                               } catch (IOException ioe1) {
-                                       getResult.success(false).exception(ioe1);
-                               }
-                               completionLatch.countDown();
+                               getResult.success(true).contentType(allData.getContentType()).contentLength(allData.getDataLength()).inputStream(allData.getPayloadInputStream());
+                               complete();
                        }
 
                }.execute();
@@ -479,7 +476,7 @@ public class FcpClient implements Closeable {
                        @Override
                        public void receivedEndListPeers(FcpConnection fcpConnection, EndListPeers endListPeers) {
                                if (endListPeers.getIdentifier().equals(identifier)) {
-                                       completionLatch.countDown();
+                                       complete();
                                }
                        }
                }.execute();
@@ -602,8 +599,8 @@ public class FcpClient implements Closeable {
 
        /**
         * Adds a peer, reading the noderef of the peer from the given file.
-        * <strong>Note:</strong> the file to read the noderef from has to reside on
-        * the same machine as the node!
+        * <strong>Note:</strong> 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
@@ -646,7 +643,7 @@ public class FcpClient implements Closeable {
                         */
                        @Override
                        public void receivedPeer(FcpConnection fcpConnection, Peer peer) {
-                               completionLatch.countDown();
+                               complete();
                        }
                }.execute();
        }
@@ -689,7 +686,7 @@ public class FcpClient implements Closeable {
                         */
                        @Override
                        public void receivedPeer(FcpConnection fcpConnection, Peer peer) {
-                               completionLatch.countDown();
+                               complete();
                        }
                }.execute();
        }
@@ -721,7 +718,7 @@ public class FcpClient implements Closeable {
                         */
                        @Override
                        public void receivedPeerRemoved(FcpConnection fcpConnection, PeerRemoved peerRemoved) {
-                               completionLatch.countDown();
+                               complete();
                        }
                }.execute();
        }
@@ -742,7 +739,7 @@ public class FcpClient implements Closeable {
         *             if an FCP error occurs
         */
        public PeerNote getPeerNote(final Peer peer) throws IOException, FcpException {
-               final ObjectWrapper<PeerNote> objectWrapper = new ObjectWrapper<PeerNote>();
+               final AtomicReference<PeerNote> objectWrapper = new AtomicReference<PeerNote>();
                new ExtendedFcpAdapter() {
 
                        /**
@@ -769,7 +766,7 @@ public class FcpClient implements Closeable {
                         */
                        @Override
                        public void receivedEndListPeerNotes(FcpConnection fcpConnection, EndListPeerNotes endListPeerNotes) {
-                               completionLatch.countDown();
+                               complete();
                        }
                }.execute();
                return objectWrapper.get();
@@ -808,7 +805,7 @@ public class FcpClient implements Closeable {
                        @Override
                        public void receivedPeer(FcpConnection fcpConnection, Peer receivedPeer) {
                                if (receivedPeer.getIdentity().equals(peer.getIdentity())) {
-                                       completionLatch.countDown();
+                                       complete();
                                }
                        }
                }.execute();
@@ -828,7 +825,7 @@ public class FcpClient implements Closeable {
         *             if an FCP error occurs
         */
        public SSKKeypair generateKeyPair() throws IOException, FcpException {
-               final ObjectWrapper<SSKKeypair> sskKeypairWrapper = new ObjectWrapper<SSKKeypair>();
+               final AtomicReference<SSKKeypair> sskKeypairWrapper = new AtomicReference<SSKKeypair>();
                new ExtendedFcpAdapter() {
 
                        /**
@@ -846,7 +843,7 @@ public class FcpClient implements Closeable {
                        @Override
                        public void receivedSSKKeypair(FcpConnection fcpConnection, SSKKeypair sskKeypair) {
                                sskKeypairWrapper.set(sskKeypair);
-                               completionLatch.countDown();
+                               complete();
                        }
                }.execute();
                return sskKeypairWrapper.get();
@@ -870,16 +867,12 @@ public class FcpClient implements Closeable {
         *             if an FCP error occurs
         */
        public Collection<Request> getGetRequests(final boolean global) throws IOException, FcpException {
-               return Filters.filteredCollection(getRequests(global), new Filter<Request>() {
-
-                       /**
-                        * {@inheritDoc}
-                        */
+               return from(getRequests(global)).filter(new Predicate<Request>() {
                        @Override
-                       public boolean filterObject(Request request) {
+                       public boolean apply(Request request) {
                                return request instanceof GetRequest;
                        }
-               });
+               }).toList();
        }
 
        /**
@@ -896,16 +889,12 @@ public class FcpClient implements Closeable {
         *             if an FCP error occurs
         */
        public Collection<Request> getPutRequests(final boolean global) throws IOException, FcpException {
-               return Filters.filteredCollection(getRequests(global), new Filter<Request>() {
-
-                       /**
-                        * {@inheritDoc}
-                        */
+               return from(getRequests(global)).filter(new Predicate<Request>() {
                        @Override
-                       public boolean filterObject(Request request) {
+                       public boolean apply(Request request) {
                                return request instanceof PutRequest;
                        }
-               });
+               }).toList();
        }
 
        /**
@@ -913,8 +902,8 @@ public class FcpClient implements Closeable {
         *
         * @param global
         *            <code>true</code> to return requests from the global queue,
-        *            <code>false</code> to only show requests from the client-local
-        *            queue
+        *            <code>false</code> to only show requests from the
+        *            client-local queue
         * @return All requests
         * @throws IOException
         *             if an I/O error occurs
@@ -1019,7 +1008,7 @@ public class FcpClient implements Closeable {
                         */
                        @Override
                        public void receivedEndListPersistentRequests(FcpConnection fcpConnection, EndListPersistentRequests endListPersistentRequests) {
-                               completionLatch.countDown();
+                               complete();
                        }
                }.execute();
                return requests.values();
@@ -1092,7 +1081,7 @@ public class FcpClient implements Closeable {
                                        return;
                                }
                                pluginReplies.putAll(fcpPluginReply.getReplies());
-                               completionLatch.countDown();
+                               complete();
                        }
 
                }.execute();
@@ -1119,7 +1108,7 @@ public class FcpClient implements Closeable {
         *             if an I/O error occurs
         */
        public NodeData getNodeInformation(final Boolean giveOpennetRef, final Boolean withPrivate, final Boolean withVolatile) throws IOException, FcpException {
-               final ObjectWrapper<NodeData> nodeDataWrapper = new ObjectWrapper<NodeData>();
+               final AtomicReference<NodeData> nodeDataWrapper = new AtomicReference<NodeData>();
                new ExtendedFcpAdapter() {
 
                        @Override
@@ -1135,13 +1124,56 @@ public class FcpClient implements Closeable {
                        @Override
                        public void receivedNodeData(FcpConnection fcpConnection, NodeData nodeData) {
                                nodeDataWrapper.set(nodeData);
-                               completionLatch.countDown();
+                               complete();
                        }
                }.execute();
                return nodeDataWrapper.get();
        }
 
        //
+       // CONFIG MANAGEMENT
+       //
+
+       public Map<String, String> getConfig() throws IOException, FcpException {
+               Map<String, String> 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<String, String> 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
        //
 
@@ -1187,7 +1219,7 @@ public class FcpClient implements Closeable {
        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;
@@ -1243,6 +1275,13 @@ public class FcpClient implements Closeable {
                public abstract void run() throws IOException;
 
                /**
+                * Signals completion of the command processing.
+                */
+               protected void complete() {
+                       completionLatch.countDown();
+               }
+
+               /**
                 * {@inheritDoc}
                 */
                @Override
@@ -1265,7 +1304,7 @@ public class FcpClient implements Closeable {
                 */
                @Override
                public void receivedProtocolError(FcpConnection fcpConnection, ProtocolError protocolError) {
-                       fcpException = new FcpException("Protocol error (" + protocolError.getCode() + ", " + protocolError.getCodeDescription());
+                       fcpException = FcpProtocolException.from(protocolError);
                        completionLatch.countDown();
                }