Make the way identities are migrated much more sensible.

Issue 1122

git-svn-id: http://svn.dmdirc.com/trunk@4006 00569f92-eb28-0410-84fd-f71c24880f

src/com/dmdirc/config/Identity.java

@@ -132,7 +132,7 @@ public class Identity extends ConfigSource implements Serializable,
             InvalidIdentityFileException {
         this.file = new ConfigFile(file);
         this.file.setAutomake(true);
-        initFile(forceDefault, new FileInputStream(file), new FileInputStream(file));
+        initFile(forceDefault, new FileInputStream(file));
         myTarget = getTarget(forceDefault);
     }
 
@@ -140,18 +140,16 @@ public class Identity extends ConfigSource implements Serializable,
      * Creates a new read-only identity.
      *
      * @param stream The input stream to read the identity from
-     * @param stream2 A second input stream if the first doesn't support marking
      * @param forceDefault Whether to force this identity to be loaded as default
      * identity or not
      * @throws InvalidIdentityFileException Missing required properties
      * @throws IOException Input/output exception
      */
-    public Identity(final InputStream stream, final InputStream stream2,
-            final boolean forceDefault) throws IOException,
+    public Identity(final InputStream stream, final boolean forceDefault) throws IOException,
             InvalidIdentityFileException {
         this.file = new ConfigFile(stream);
         this.file.setAutomake(true);
-        initFile(forceDefault, stream, stream2);
+        initFile(forceDefault, stream);
         myTarget = getTarget(forceDefault);
     }
 
@@ -223,8 +221,8 @@ public class Identity extends ConfigSource implements Serializable,
      * @throws InvalidIdentityFileException if the identity file is invalid
      * @throws IOException On I/O exception when reading the identity
      */
-    private void initFile(final boolean forceDefault, final InputStream stream,
-            final InputStream newStream) throws InvalidIdentityFileException, IOException {
+    private void initFile(final boolean forceDefault, final InputStream stream)
+            throws InvalidIdentityFileException, IOException {
         
         if (stream.markSupported()) {
             stream.mark(Integer.MAX_VALUE);
@@ -233,21 +231,8 @@ public class Identity extends ConfigSource implements Serializable,
         try {
             this.file.read();
         } catch (InvalidConfigFileException ex) {            
-            InputStream myStream;
-            
-            if (stream != null && stream.markSupported()) {
-                // Not a config file
-                stream.reset();
-                myStream = stream;
-            } else {
-                myStream = newStream;
-            }
-                
             final Properties properties = new Properties();
-            properties.load(myStream);
-            
-            myStream.close();
-            
+            properties.load(new LineReader(this.file.getLines()));            
             migrateProperties(properties);
         }
 

src/com/dmdirc/config/LineReader.java

@@ -0,0 +1,99 @@
+/*
+ * Copyright (c) 2006-2008 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * 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.config;
+
+import java.io.Reader;
+import java.util.List;
+
+/**
+ * A reader implementation that "reads" from a List of Strings, as provided
+ * by a DMDirc text file. This is only used to migrate DMDirc config files.
+ * 
+ * @author chris
+ */
+public class LineReader extends Reader {
+    
+    /** The lines to read from. */
+    private final List<String> lines;
+    
+    /** Character list. */
+    char[] mybuf;
+
+    /** Current position. */
+    int cur = 0;
+    
+    /**
+     * Creates a new LineReader to read from the specified lines.
+     * 
+     * @param lines The lines to read from
+     */
+    public LineReader(final List<String> lines) {
+        super();
+        
+        this.lines = lines;
+        
+        int size = 0;
+        
+        for (String line : lines) {
+            size += 1 + line.length();
+        }
+        
+        mybuf = new char[size];
+        size = 0;
+        
+        for (String line : lines) {
+            System.arraycopy(line.toCharArray(), 0, mybuf, size, line.length());
+            mybuf[size + line.length()] = '\n';
+            
+            size += 1 + line.length();
+        }
+    }
+    
+    /**
+     * A version number for this class. It should be changed whenever the class
+     * structure is changed (or anything else that would prevent serialized
+     * objects being unserialized with the new class).
+     */
+    private static final long serialVersionUID = 1;
+    
+    /** {@inheritDoc} */
+    @Override
+    public int read(final char[] cbuf, final int off, final int len) {
+        int count = -1;
+        
+        if (cur < mybuf.length) {
+            count = Math.min(len, mybuf.length - cur);
+            System.arraycopy(mybuf, cur, cbuf, off, count);
+            cur += count;
+        }
+        
+        return count;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void close() {
+        // Do nothing
+    }
+
+}

src/com/dmdirc/ui/themes/Theme.java

@@ -112,8 +112,7 @@ public class Theme implements Comparable<Theme> {
 
         if (stream != null) {
             try {
-                identity = new ThemeIdentity(stream, rm.getResourceInputStream("config"),
-                        this);
+                identity = new ThemeIdentity(stream, this);
                 IdentityManager.addIdentity(identity);
             } catch (InvalidIdentityFileException ex) {
                 Logger.userError(ErrorLevel.MEDIUM, "Error loading theme identity file: "

src/com/dmdirc/ui/themes/ThemeIdentity.java

@@ -50,15 +50,13 @@ public class ThemeIdentity extends Identity {
      * Creates a new instance of ThemeIdentity.
      *
      * @param stream The input stream to read the identity from.
-     * @param stream2 A second input stream (for migration)
      * @param theme The theme that owns this identity
      * @throws InvalidIdentityFileException Missing required properties
      * @throws IOException Input/output exception
      */
-    public ThemeIdentity(final InputStream stream, final InputStream stream2,
-            final Theme theme) throws IOException,
+    public ThemeIdentity(final InputStream stream, final Theme theme) throws IOException,
             InvalidIdentityFileException {
-        super(stream, stream2, true);
+        super(stream, true);
         
         myTarget.setTheme();
         this.theme = theme;

src/com/dmdirc/util/ConfigFile.java

@@ -106,6 +106,8 @@ public class ConfigFile extends TextFile {
         keydomains.clear();
         flatdomains.clear();
         domains.clear();
+        
+        readLines();
 
         for (String line : getLines()) {
             String tline = line;

src/com/dmdirc/util/TextFile.java

@@ -46,6 +46,9 @@ public class TextFile {
     /** The input stream we're dealing with. */
     private InputStream is;
     
+    /** The lines we've read from the file. */
+    private List<String> lines;
+    
     /**
      * Creates a new instance of TextFile for the specified file.
      * 
@@ -74,25 +77,37 @@ public class TextFile {
     }
     
     /**
-     * Retrieves the contents of the file as a list of lines.
+     * Retrieves the contents of the file as a list of lines. If getLines() or
+     * readLines() has previously been called, a cached version is returned.
      * 
      * @return A list of lines in the file
      * @throws IOException if an I/O exception occurs
      */
     public List<String> getLines() throws IOException {
+        if (lines == null) {
+            readLines();
+        }
+        
+        return lines;
+    }
+    
+    /**
+     * Reads the contents of the file into this TextFile's line cache.
+     * 
+     * @throws IOException If an I/O exception occurs
+     */
+    public void readLines() throws IOException {
         final BufferedReader reader = new BufferedReader(
                 file == null ? new InputStreamReader(is) : new FileReader(file));
-        final List<String> res = new ArrayList<String>();
+        lines = new ArrayList<String>();
         
         String line;
         
         while ((line = reader.readLine()) != null) {
-            res.add(line);
+            lines.add(line);
         }
         
-        //reader.close();
-        
-        return res;
+        reader.close();
     }
     
     /**

test/com/dmdirc/config/IdentityTest.java

@@ -166,17 +166,17 @@ public class IdentityTest {
     
     @Test(expected=InvalidIdentityFileException.class)
     public void testNoName() throws IOException, InvalidIdentityFileException {
-        new Identity(getClass().getResourceAsStream("identity1"), null, false);
+        new Identity(getClass().getResourceAsStream("identity1"), false);
     }
     
     @Test(expected=InvalidIdentityFileException.class)
     public void testNoTarget() throws IOException, InvalidIdentityFileException {
-        new Identity(getClass().getResourceAsStream("identity2"), null, false);
+        new Identity(getClass().getResourceAsStream("identity2"), false);
     }
     
     @Test
     public void testMigrate() throws IOException, InvalidIdentityFileException {
-        final Identity id = new Identity(getClass().getResourceAsStream("identity3"), null, false);
+        final Identity id = new Identity(getClass().getResourceAsStream("identity3"), false);
         
         assertTrue(id.getFile().isKeyDomain("identity"));
         assertTrue(id.getFile().isKeyDomain("meep"));