Add missing @Override annotations.
[jSite.git] / src / de / todesbaum / jsite / gui / FileScanner.java
index b699ebb..1ce8d6c 100644 (file)
@@ -1,6 +1,5 @@
 /*
- * jSite - a tool for uploading websites into Freenet
- * Copyright (C) 2006 David Roden
+ * jSite - FileScanner.java - Copyright © 2006–2012 David Roden
  *
  * 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
@@ -21,24 +20,37 @@ package de.todesbaum.jsite.gui;
 
 import java.io.File;
 import java.io.FileFilter;
+import java.io.FileInputStream;
 import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.security.DigestOutputStream;
+import java.security.MessageDigest;
+import java.security.NoSuchAlgorithmException;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
 import de.todesbaum.jsite.application.Project;
 import de.todesbaum.jsite.i18n.I18n;
+import de.todesbaum.util.io.Closer;
+import de.todesbaum.util.io.StreamCopier;
 
 /**
  * Scans the local path of a project anychronously and returns the list of found
  * files as an event.
- * 
+ *
  * @see Project#getLocalPath()
  * @see FileScannerListener#fileScannerFinished(FileScanner)
  * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
  */
 public class FileScanner implements Runnable {
 
+       /** The logger. */
+       private final static Logger logger = Logger.getLogger(FileScanner.class.getName());
+
        /** The list of listeners. */
        private final List<FileScannerListener> fileScannerListeners = new ArrayList<FileScannerListener>();
 
@@ -46,14 +58,14 @@ public class FileScanner implements Runnable {
        private final Project project;
 
        /** The list of found files. */
-       private List<String> files;
+       private List<ScannedFile> files;
 
        /** Wether there was an error. */
        private boolean error = false;
 
        /**
         * Creates a new file scanner for the given project.
-        * 
+        *
         * @param project
         *            The project whose files to scan
         */
@@ -63,7 +75,7 @@ public class FileScanner implements Runnable {
 
        /**
         * Adds the given listener to the list of listeners.
-        * 
+        *
         * @param fileScannerListener
         *            The listener to add
         */
@@ -73,7 +85,7 @@ public class FileScanner implements Runnable {
 
        /**
         * Removes the given listener from the list of listeners.
-        * 
+        *
         * @param fileScannerListener
         *            The listener to remove
         */
@@ -95,11 +107,12 @@ public class FileScanner implements Runnable {
         * <p>
         * Scans all available files in the project’s local path and emits an event
         * when finished.
-        * 
+        *
         * @see FileScannerListener#fileScannerFinished(FileScanner)
         */
+       @Override
        public void run() {
-               files = new ArrayList<String>();
+               files = new ArrayList<ScannedFile>();
                error = false;
                try {
                        scanFiles(new File(project.getLocalPath()), files);
@@ -112,7 +125,7 @@ public class FileScanner implements Runnable {
 
        /**
         * Returns whether there was an error scanning for files.
-        * 
+        *
         * @return <code>true</code> if there was an error, <code>false</code>
         *         otherwise
         */
@@ -122,16 +135,16 @@ public class FileScanner implements Runnable {
 
        /**
         * Returns the list of found files.
-        * 
+        *
         * @return The list of found files
         */
-       public List<String> getFiles() {
+       public List<ScannedFile> getFiles() {
                return files;
        }
 
        /**
         * Recursively scans a directory and adds all found files to the given list.
-        * 
+        *
         * @param rootDir
         *            The directory to scan
         * @param fileList
@@ -139,11 +152,13 @@ public class FileScanner implements Runnable {
         * @throws IOException
         *             if an I/O error occurs
         */
-       private void scanFiles(File rootDir, List<String> fileList) throws IOException {
+       private void scanFiles(File rootDir, List<ScannedFile> fileList) throws IOException {
                File[] files = rootDir.listFiles(new FileFilter() {
 
+                       @Override
+                       @SuppressWarnings("synthetic-access")
                        public boolean accept(File file) {
-                               return !file.isHidden();
+                               return !project.isIgnoreHiddenFiles() || !file.isHidden();
                        }
                });
                if (files == null) {
@@ -154,10 +169,179 @@ public class FileScanner implements Runnable {
                                scanFiles(file, fileList);
                                continue;
                        }
-                       String filename = project.shortenFilename(file);
-                       filename = filename.replace('\\', '/');
-                       fileList.add(filename);
+                       String filename = project.shortenFilename(file).replace('\\', '/');
+                       String hash = hashFile(project.getLocalPath(), filename);
+                       fileList.add(new ScannedFile(filename, hash));
                }
        }
 
-}
\ No newline at end of file
+       /**
+        * Hashes the given file.
+        *
+        * @param path
+        *            The path of the project
+        * @param filename
+        *            The name of the file, relative to the project path
+        * @return The hash of the file
+        */
+       @SuppressWarnings("synthetic-access")
+       private static String hashFile(String path, String filename) {
+               InputStream fileInputStream = null;
+               DigestOutputStream digestOutputStream = null;
+               File file = new File(path, filename);
+               try {
+                       fileInputStream = new FileInputStream(file);
+                       digestOutputStream = new DigestOutputStream(new NullOutputStream(), MessageDigest.getInstance("SHA-256"));
+                       StreamCopier.copy(fileInputStream, digestOutputStream, file.length());
+                       return toHex(digestOutputStream.getMessageDigest().digest());
+               } catch (NoSuchAlgorithmException nsae1) {
+                       logger.log(Level.WARNING, "Could not get SHA-256 digest!", nsae1);
+               } catch (IOException ioe1) {
+                       logger.log(Level.WARNING, "Could not read file!", ioe1);
+               } finally {
+                       Closer.close(digestOutputStream);
+                       Closer.close(fileInputStream);
+               }
+               return toHex(new byte[32]);
+       }
+
+       /**
+        * Converts the given byte array into a hexadecimal string.
+        *
+        * @param array
+        *            The array to convert
+        * @return The hexadecimal string
+        */
+       private static String toHex(byte[] array) {
+               StringBuilder hexString = new StringBuilder(array.length * 2);
+               for (byte b : array) {
+                       hexString.append("0123456789abcdef".charAt((b >>> 4) & 0x0f)).append("0123456789abcdef".charAt(b & 0xf));
+               }
+               return hexString.toString();
+       }
+
+       /**
+        * {@link OutputStream} that discards all written bytes.
+        *
+        * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
+        */
+       private static class NullOutputStream extends OutputStream {
+
+               /**
+                * {@inheritDoc}
+                */
+               @Override
+               public void write(int b) {
+                       /* do nothing. */
+               }
+
+               /**
+                * {@inheritDoc}
+                */
+               @Override
+               public void write(byte[] b) {
+                       /* do nothing. */
+               }
+
+               /**
+                * {@inheritDoc}
+                */
+               @Override
+               public void write(byte[] b, int off, int len) {
+                       /* do nothing. */
+               }
+
+       }
+
+       /**
+        * Container for a scanned file, consisting of the name of the file and its
+        * hash.
+        *
+        * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
+        */
+       public static class ScannedFile implements Comparable<ScannedFile> {
+
+               /** The name of the file. */
+               private final String filename;
+
+               /** The hash of the file. */
+               private final String hash;
+
+               /**
+                * Creates a new scanned file.
+                *
+                * @param filename
+                *            The name of the file
+                * @param hash
+                *            The hash of the file
+                */
+               public ScannedFile(String filename, String hash) {
+                       this.filename = filename;
+                       this.hash = hash;
+               }
+
+               //
+               // ACCESSORS
+               //
+
+               /**
+                * Returns the name of the file.
+                *
+                * @return The name of the file
+                */
+               public String getFilename() {
+                       return filename;
+               }
+
+               /**
+                * Returns the hash of the file.
+                *
+                * @return The hash of the file
+                */
+               public String getHash() {
+                       return hash;
+               }
+
+               //
+               // OBJECT METHODS
+               //
+
+               /**
+                * {@inheritDoc}
+                */
+               @Override
+               public int hashCode() {
+                       return filename.hashCode();
+               }
+
+               /**
+                * {@inheritDoc}
+                */
+               @Override
+               public boolean equals(Object obj) {
+                       return filename.equals(obj);
+               }
+
+               /**
+                * {@inheritDoc}
+                */
+               @Override
+               public String toString() {
+                       return filename;
+               }
+
+               //
+               // COMPARABLE METHODS
+               //
+
+               /**
+                * {@inheritDoc}
+                */
+               @Override
+               public int compareTo(ScannedFile scannedFile) {
+                       return filename.compareTo(scannedFile.filename);
+               }
+
+       }
+
+}