Update license to GPLv3, fix header comments
[jFCPlib.git] / src / main / java / net / pterodactylus / fcp / highlevel / FcpClient.java
index e389f23..6413dc2 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 java.io.Closeable;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.InetAddress;
@@ -31,6 +33,7 @@ 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;
@@ -67,10 +70,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
@@ -78,7 +79,7 @@ import net.pterodactylus.util.thread.ObjectWrapper;
  *
  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  */
-public class FcpClient {
+public class FcpClient implements Closeable {
 
        /** Object used for synchronization. */
        private final Object syncObject = new Object();
@@ -306,7 +307,8 @@ public class FcpClient {
        }
 
        /**
-        * Returns the file with the given URI.
+        * Returns the file with the given URI. The retrieved data will be run
+        * through Freenet’s content filter.
         *
         * @param uri
         *            The URI to get
@@ -317,6 +319,24 @@ public class FcpClient {
         *             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() {
@@ -328,6 +348,7 @@ public class FcpClient {
                        @SuppressWarnings("synthetic-access")
                        public void run() throws IOException {
                                ClientGet clientGet = new ClientGet(uri, identifier);
+                               clientGet.setFilterData(filterData);
                                fcpConnection.sendMessage(clientGet);
                        }
 
@@ -341,7 +362,9 @@ public class FcpClient {
                                        String newUri = getFailed.getRedirectURI();
                                        getResult.realUri(newUri);
                                        try {
-                                               fcpConnection.sendMessage(new ClientGet(newUri, identifier));
+                                               ClientGet clientGet = new ClientGet(newUri, identifier);
+                                               clientGet.setFilterData(filterData);
+                                               fcpConnection.sendMessage(clientGet);
                                        } catch (IOException ioe1) {
                                                getResult.success(false).exception(ioe1);
                                                completionLatch.countDown();
@@ -357,13 +380,7 @@ public class FcpClient {
                                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);
-                               }
+                               getResult.success(true).contentType(allData.getContentType()).contentLength(allData.getDataLength()).inputStream(allData.getPayloadInputStream());
                                completionLatch.countDown();
                        }
 
@@ -382,6 +399,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}
@@ -571,8 +596,8 @@ public class FcpClient {
 
        /**
         * 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
@@ -711,7 +736,7 @@ public class FcpClient {
         *             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() {
 
                        /**
@@ -797,7 +822,7 @@ public class FcpClient {
         *             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() {
 
                        /**
@@ -839,16 +864,12 @@ public class FcpClient {
         *             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();
        }
 
        /**
@@ -865,16 +886,12 @@ public class FcpClient {
         *             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();
        }
 
        /**
@@ -882,8 +899,8 @@ public class FcpClient {
         *
         * @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
@@ -1088,7 +1105,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<NodeData> nodeDataWrapper = new ObjectWrapper<NodeData>();
+               final AtomicReference<NodeData> nodeDataWrapper = new AtomicReference<NodeData>();
                new ExtendedFcpAdapter() {
 
                        @Override