Add new Profile wrapper and basic store.

src/com/dmdirc/config/profiles/Profile.java

@@ -0,0 +1,100 @@
+/*
+ * 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.config.profiles;
+
+import com.google.common.base.MoreObjects;
+import com.google.common.collect.Lists;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.Objects;
+import java.util.Optional;
+
+/**
+ * Describes a profile, used to describe the settings associated with the local client on a
+ * connection.
+ */
+public class Profile {
+
+    /** Profile Name, must be a sanitised filename. */
+    private final String name;
+    /** Real name. */
+    private final String realname;
+    /** Ident. */
+    private final Optional<String> ident;
+    /** Nicknames. */
+    private final List<String> nicknames;
+
+    public Profile(final String name, final String realname, final Optional<String> ident,
+            final Iterable<String> nicknames) {
+        this.name = name;
+        this.realname = realname;
+        this.ident = ident;
+        this.nicknames = Lists.newArrayList(nicknames);
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public String getRealname() {
+        return realname;
+    }
+
+    public Optional<String> getIdent() {
+        return ident;
+    }
+
+    public List<String> getNicknames() {
+        return Collections.unmodifiableList(nicknames);
+    }
+
+    public String toString() {
+        return MoreObjects.toStringHelper(this)
+                .add("name", name)
+                .add("realname", realname)
+                .add("ident", ident)
+                .add("nicknames", nicknames)
+                .toString();
+    }
+
+    @Override
+    public boolean equals(final Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        final Profile profile = (Profile) o;
+        return Objects.equals(name, profile.getName())
+                && Objects.equals(realname, profile.getRealname())
+                && Objects.equals(nicknames, profile.getNicknames())
+                && Objects.equals(ident, profile.getIdent());
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(name, realname, ident, nicknames);
+    }
+}

src/com/dmdirc/config/profiles/ProfileManager.java

@@ -22,53 +22,34 @@
 
 package com.dmdirc.config.profiles;
 
-import com.dmdirc.actions.wrappers.Profile;
-import com.dmdirc.interfaces.config.ConfigProvider;
-import com.dmdirc.interfaces.config.ConfigProviderListener;
-import com.dmdirc.interfaces.config.IdentityController;
-import com.dmdirc.interfaces.config.IdentityFactory;
-
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
-import java.util.List;
-import java.util.stream.Collectors;
 
 import javax.inject.Inject;
 
 /**
  * Manager for {@link Profile}s.
  */
-public class ProfileManager implements ConfigProviderListener {
+public class ProfileManager {
 
-    private final IdentityFactory identityFactory;
-    private final IdentityController identityController;
     private final Collection<Profile> profiles;
 
     @Inject
-    public ProfileManager(final IdentityController identityController,
-            final IdentityFactory identityFactory) {
-        this.identityFactory = identityFactory;
-        this.identityController = identityController;
+    public ProfileManager() {
         profiles = new ArrayList<>();
-        final List<ConfigProvider> identities = identityController.getProvidersByType("profile");
-        profiles.addAll(identities.stream()
-                .map(identity -> new Profile(identityFactory, identity))
-                .collect(Collectors.toList()));
     }
 
     /**
      * Starts this manager, registering listeners.
      */
     public void start() {
-        identityController.registerIdentityListener(this);
     }
 
     /**
      * Stops this manager, unregistering listeners.
      */
     public void stop() {
-        identityController.unregisterIdentityListener(this);
     }
 
     /**
@@ -97,18 +78,4 @@ public class ProfileManager implements ConfigProviderListener {
     public Collection<Profile> getProfiles() {
         return Collections.unmodifiableCollection(profiles);
     }
-
-    @Override
-    public void configProviderAdded(final ConfigProvider configProvider) {
-        if (configProvider.isProfile()) {
-            profiles.removeIf(p-> p.equalsConfigProvider(configProvider));
-        }
-    }
-
-    @Override
-    public void configProviderRemoved(final ConfigProvider configProvider) {
-        if (configProvider.isProfile()) {
-            profiles.add(new Profile(identityFactory, configProvider));
-        }
-    }
 }

src/com/dmdirc/config/profiles/ProfileStore.java

@@ -0,0 +1,46 @@
+/*
+ * 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.config.profiles;
+
+import java.util.Set;
+
+/**
+ * A store of {@link Profile}s that can read and write them to some kind of persistent media.
+ */
+public interface ProfileStore {
+
+    /**
+     * Reads and returns all profiles from within the store.
+     *
+     * @return A set of known profiles, or an empty set if the store is uninitialised.
+     */
+    Set<Profile> readProfiles();
+
+    /**
+     * Writes all the given profiles to the store, replacing any existing commands.
+     *
+     * @param profiles The set of profiles to be written to the store.
+     */
+    void writeProfiles(Set<Profile> profiles);
+
+}

src/com/dmdirc/config/profiles/YamlProfileStore.java

@@ -0,0 +1,153 @@
+/*
+ * 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.config.profiles;
+
+import com.google.common.base.Splitter;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.io.OutputStream;
+import java.io.OutputStreamWriter;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Optional;
+import java.util.Set;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.esotericsoftware.yamlbeans.YamlReader;
+import com.esotericsoftware.yamlbeans.YamlWriter;
+
+import static com.dmdirc.util.YamlReaderUtils.asList;
+import static com.dmdirc.util.YamlReaderUtils.asMap;
+import static com.dmdirc.util.YamlReaderUtils.optionalString;
+import static com.dmdirc.util.YamlReaderUtils.requiredString;
+
+/**
+ * Store that reads and writes profiles from a YAML file on disk.
+ */
+public class YamlProfileStore implements ProfileStore {
+
+    private static final Logger LOG = LoggerFactory.getLogger(YamlProfileStore.class);
+    /** The charset to use when reading and writing files. */
+    private static final String CHARSET = "UTF-8";
+
+    /** The path to the file to read and write auto commands in. */
+    private final Path path;
+
+    /**
+     * Creates a new YAML profiles store.
+     *
+     * @param path The path to the YAML file to read and write profiles in.
+     */
+    public YamlProfileStore(final Path path) {
+        this.path = path;
+    }
+
+    @Override
+    public Set<Profile> readProfiles() {
+        final Set<Profile> commands = new HashSet<>();
+        if (Files.exists(path)) {
+            try (final InputStream stream = Files.newInputStream(path);
+                    final InputStreamReader reader = new InputStreamReader(stream, CHARSET)) {
+                final YamlReader yamlReader = new YamlReader(reader);
+                final Object root = yamlReader.read();
+                commands.addAll(readProfilesFromYaml(asList(root)));
+                yamlReader.close();
+            } catch (IOException | IllegalArgumentException ex) {
+                LOG.warn("Unable to read auto commands", ex);
+            }
+        }
+
+        return commands;
+    }
+
+    @Override
+    public void writeProfiles(final Set<Profile> profiles) {
+        final List<Object> list = getProfilesForYaml(profiles);
+        try (final OutputStream stream = Files.newOutputStream(path);
+                final OutputStreamWriter writer = new OutputStreamWriter(stream, CHARSET)) {
+            final YamlWriter yamlWriter = new YamlWriter(writer);
+            yamlWriter.write(list);
+            yamlWriter.close();
+        } catch (IOException ex) {
+            LOG.error("Unable to write auto commands", ex);
+        }
+    }
+
+    /**
+     * Builds a set of auto commands from the given YAML representations.
+     *
+     * @param objects The raw objects read from the YAML file.
+     *
+     * @return A list of corresponding auto commands.
+     */
+    private Collection<Profile> readProfilesFromYaml(final Collection<Object> objects) {
+        final Collection<Profile> res = new ArrayList<>(objects.size());
+        for (Object profile : objects) {
+            try {
+                final Map<Object, Object> map = asMap(profile);
+                final String name = requiredString(map, "name");
+                final String realname = requiredString(map, "realname");
+                final Optional<String> ident =
+                        Optional.ofNullable(optionalString(map, "ident"));
+                final List<String> nicknames =
+                        Splitter.on('\n').splitToList(requiredString(map, "nicknames"));
+                res.add(new Profile(name, realname, ident, nicknames));
+            } catch (IllegalArgumentException ex) {
+                LOG.info("Unable to read alias", ex);
+            }
+        }
+        return res;
+    }
+
+    /**
+     * Gets a set of maps that can be written to a YAML file.
+     *
+     * @param profiles The profiles to be stored.
+     *
+     * @return A list of corresponding maps.
+     */
+    private List<Object> getProfilesForYaml(final Collection<Profile> profiles) {
+        final List<Object> res = new ArrayList<>(profiles.size());
+        for (Profile profile : profiles) {
+            final Map<Object, Object> map = new HashMap<>();
+            map.put("name", profile.getName());
+            map.put("realname", profile.getRealname());
+            if (profile.getIdent().isPresent()) {
+                map.put("ident", profile.getIdent().get());
+            }
+            map.put("nicknames", profile.getNicknames());
+            res.add(map);
+        }
+        return res;
+    }
+}

test-res/com/dmdirc/config/profiles/profiles.yml

@@ -0,0 +1,10 @@
+- name: profile1
+  realname: realname1
+  nicknames: nickname1, nickname2
+- name: profile2
+  realname: realname2
+  nicknames: nickname1, nickname1
+  ident: ident2
+- name: profile3
+  realname: profile3
+  nicknames: nickname3

test/com/dmdirc/config/profiles/YamlProfileStoreTest.java

@@ -0,0 +1,68 @@
+/*
+ * 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.config.profiles;
+
+import com.google.common.collect.Lists;
+import com.google.common.collect.Sets;
+import com.google.common.jimfs.Configuration;
+import com.google.common.jimfs.Jimfs;
+
+import java.nio.file.FileSystem;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.Collection;
+import java.util.List;
+import java.util.Optional;
+import java.util.Set;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.runners.MockitoJUnitRunner;
+
+import static junit.framework.TestCase.assertEquals;
+
+@RunWith(MockitoJUnitRunner.class)
+public class YamlProfileStoreTest {
+
+    @Test
+    public void testReadProfiles() throws Exception {
+        final ProfileStore store = new YamlProfileStore(Paths.get(getClass()
+                .getResource("profiles.yml").toURI()));
+        final Collection<Profile> profiles = store.readProfiles();
+        assertEquals(3, profiles.size());
+    }
+
+    @Test
+    public void testWriteProfiles() throws Exception {
+        try (FileSystem fs = Jimfs.newFileSystem(Configuration.unix())) {
+            final ProfileStore store = new YamlProfileStore(fs.getPath("/")
+                    .resolve("profiles.yml"));
+            final Profile profile1 = new Profile("name", "realname", Optional.of("ident"),
+                    Lists.newArrayList("nickname"));
+            final Set<Profile> profiles = Sets.newHashSet(profile1);
+            store.writeProfiles(profiles);
+            final List<String> lines = Files.readAllLines(fs.getPath("/").resolve("profiles.yml"));
+            assertEquals(5, lines.size());
+        }
+    }
+}