Merge pull request #22 from greboid/tidying

Tidy downloader.

src/com/dmdirc/util/collections/CollectionFunctions.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.util.collections;
+
+import java.io.UnsupportedEncodingException;
+import java.net.URLEncoder;
+import java.util.Map;
+import java.util.stream.Stream;
+
+/**
+ * Collection related functions.
+ */
+public final class CollectionFunctions {
+
+    private CollectionFunctions() {
+    }
+
+    public static Stream<String> flattenAndEncodeKeyPair(final Map.Entry<String, String> entry) {
+        String key;
+        String value;
+        try {
+            key = URLEncoder.encode(entry.getKey(), "UTF-8");
+            value = URLEncoder.encode(entry.getValue(), "UTF-8");
+        } catch (UnsupportedEncodingException ex){
+            key = entry.getKey();
+            value = entry.getValue();
+        }
+        return Stream.of(key + '=' + value);
+    }
+}

src/com/dmdirc/util/io/Downloader.java

@@ -22,20 +22,19 @@
 
 package com.dmdirc.util.io;
 
+import com.dmdirc.util.collections.CollectionFunctions;
+
 import java.io.BufferedReader;
 import java.io.DataOutputStream;
 import java.io.IOException;
-import java.io.InputStream;
 import java.io.InputStreamReader;
-import java.io.OutputStream;
 import java.net.URL;
 import java.net.URLConnection;
-import java.net.URLEncoder;
 import java.nio.file.Files;
 import java.nio.file.Path;
-import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
 
 /**
  * Allows easy downloading of files from HTTP sites.
@@ -50,7 +49,6 @@ public class Downloader {
      * @throws IOException If there's an I/O error while downloading
      */
     public List<String> getPage(final String url) throws IOException {
-
         return getPage(url, "");
     }
 
@@ -64,23 +62,12 @@ public class Downloader {
      */
     public List<String> getPage(final String url, final String postData)
             throws IOException {
-
-        final List<String> res = new ArrayList<>();
-
         final URLConnection urlConn = getConnection(url, postData);
-
+        final List<String> res;
         try (BufferedReader in = new BufferedReader(new InputStreamReader(
                 urlConn.getInputStream()))) {
-            String line;
-            do {
-                line = in.readLine();
-
-                if (line != null) {
-                    res.add(line);
-                }
-            } while (line != null);
+            res = in.lines().collect(Collectors.toList());
         }
-
         return res;
     }
 
@@ -94,16 +81,9 @@ public class Downloader {
      */
     public List<String> getPage(final String url,
             final Map<String, String> postData) throws IOException {
-        final StringBuilder data = new StringBuilder();
-
-        for (Map.Entry<String, String> entry : postData.entrySet()) {
-            data.append('&');
-            data.append(URLEncoder.encode(entry.getKey(), "UTF-8"));
-            data.append('=');
-            data.append(URLEncoder.encode(entry.getValue(), "UTF-8"));
-        }
-
-        return getPage(url, data.length() == 0 ? "" : data.substring(1));
+        return getPage(url, postData.entrySet().stream()
+                .flatMap(CollectionFunctions::flattenAndEncodeKeyPair)
+                .collect(Collectors.joining("&")));
     }
 
     /**
@@ -126,37 +106,11 @@ public class Downloader {
      * @param listener The progress listener for this download
      * @throws IOException If there's an I/O error while downloading
      */
-    public void downloadPage(final String url, final Path file,
-            final DownloadListener listener) throws IOException {
-
-        final URLConnection urlConn = getConnection(url, "");
-
-        try (OutputStream output = Files.newOutputStream(file);
-                InputStream input = urlConn.getInputStream()) {
-            final int length = urlConn.getContentLength();
-
-            if (listener != null) {
-                listener.setIndeterminate(length == -1);
-            }
-
-            final byte[] buffer = new byte[512];
-            int count;
-
-            int current = 0;
-            do {
-                count = input.read(buffer);
-
-                if (count > 0) {
-                    current += count;
-                    output.write(buffer, 0, count);
-
-                    if (listener != null && length != -1) {
-                        listener.downloadProgress(100 * (float) current
-                                / length);
-                    }
-                }
-            } while (count > 0);
-        }
+    public void downloadPage(final String url, final Path file, final DownloadListener listener)
+            throws IOException {
+        final URLConnection connection = getConnection(url, "");
+        Files.copy(new ListenerInputStream(connection.getInputStream(), listener,
+                        connection.getContentLength()), file);
     }
 
     /**
@@ -167,8 +121,7 @@ public class Downloader {
      * @return An URLConnection for the specified URL/data
      * @throws IOException If an I/O exception occurs while connecting
      */
-    private URLConnection getConnection(final String url,
-            final String postData)
+    private URLConnection getConnection(final String url, final String postData)
             throws IOException {
         final URLConnection urlConn = getURLConnection(url);
 
@@ -178,8 +131,7 @@ public class Downloader {
         urlConn.setConnectTimeout(10000);
 
         if (!postData.isEmpty()) {
-            urlConn.setRequestProperty("Content-Type",
-                    "application/x-www-form-urlencoded");
+            urlConn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
 
             try (DataOutputStream out = new DataOutputStream(urlConn.getOutputStream())) {
                 out.writeBytes(postData);

src/com/dmdirc/util/io/ListenerInputStream.java

@@ -0,0 +1,128 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.util.io;
+
+import java.io.FilterInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+
+import javax.annotation.Nonnull;
+
+/**
+ * Wrapped {@link InputStream} that provides updates to a {@link DownloadListener} as it reads a
+ * stream.
+ */
+public class ListenerInputStream extends FilterInputStream {
+
+    private final DownloadListener listener;
+    private final int length;
+    private int count;
+    private int mark;
+
+    /**
+     * Creates a new stream.
+     *
+     * @param in        Stream to wrap
+     * @param listener  Listener to gives up dates to
+     * @param length    Length of the stream, if -1 the listener will be indeterminate
+     */
+    public ListenerInputStream(@Nonnull final InputStream in, final DownloadListener listener,
+            final int length) {
+        super(in);
+        this.listener = listener;
+        this.length = length;
+        count = 0;
+        mark = count;
+        if (listener != null) {
+            listener.setIndeterminate(length == -1);
+        }
+    }
+
+    @Override
+    public int read() throws IOException {
+        final int read = super.read();
+        return update(read);
+    }
+
+    @Override
+    public int read(@Nonnull final byte[] b) throws IOException {
+        final int read = super.read(b);
+        return update(read);
+    }
+
+    @Override
+    public int read(@Nonnull final byte[] b, final int off, final int len) throws IOException {
+        final int read = super.read(b, off, len);
+        return update(read);
+    }
+
+    @Override
+    public long skip(final long n) throws IOException {
+        final long read = super.skip(n);
+        return update((int) read);
+    }
+
+    @Override
+    public int available() throws IOException {
+        return super.available();
+    }
+
+    @Override
+    public void close() throws IOException {
+        super.close();
+    }
+
+    @Override
+    public synchronized void mark(final int readlimit) {
+        mark = count;
+        super.mark(readlimit);
+    }
+
+    @Override
+    public synchronized void reset() throws IOException {
+        update(mark - count);
+        super.reset();
+    }
+
+    @Override
+    public boolean markSupported() {
+        return super.markSupported();
+    }
+
+    /**
+     * Updates the listener and total read count.
+     *
+     * @param read Number of bytes further into stream.
+     *
+     * @return Returns the number of bytes read.
+     */
+    private int update(final int read) {
+        if (read > 0) {
+            count += read;
+            if (listener != null && length != -1) {
+                listener.downloadProgress(100 * (float) count / length);
+            }
+        }
+        return read;
+    }
+}

test/com/dmdirc/util/collections/CollectionFunctionsTest.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.util.collections;
+
+import com.google.common.collect.ImmutableMap;
+
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+import org.junit.Test;
+
+import static junit.framework.TestCase.assertEquals;
+
+public class CollectionFunctionsTest {
+
+    @Test
+    public void testflattenAndEncodeKeyPair() throws Exception {
+        final Map<String, String> map = ImmutableMap.<String, String>builder()
+                .put("key", "value")
+                .put("key&", "value&")
+                .build();
+        final List<String> result = map.entrySet().stream()
+                .flatMap(CollectionFunctions::flattenAndEncodeKeyPair)
+                .collect(Collectors.toList());
+        assertEquals(2, result.size());
+        assertEquals("key=value", result.get(0));
+        assertEquals("key%26=value%26", result.get(1));
+    }
+}

test/com/dmdirc/util/io/DownloaderTest.java

@@ -104,6 +104,20 @@ public class DownloaderTest {
         assertTrue(postDataString1.equals(os.toString()) || postDataString2.equals(os.toString()));
     }
 
+    @Test
+    public void testGetPageMapEncoding() throws IOException {
+        final Map<String, String> postData = Maps.newHashMap();
+        postData.put("ke&y1", "value1");
+        postData.put("key2", "val&ue2");
+        new TestableDownloader().getPage("rar", postData);
+        verify(mockedConnection).setRequestProperty("Content-Type",
+                "application/x-www-form-urlencoded");
+
+        final String postDataString1 = "ke%26y1=value1&key2=val%26ue2";
+        final String postDataString2 = "key2=val%26ue2&ke%26y1=value1";
+        assertTrue(postDataString1.equals(os.toString()) || postDataString2.equals(os.toString()));
+    }
+
     @Test
     public void testDownloadPage() throws IOException {
         final Path file = fakeFS.getPath("test.txt");