source: trunk/eraser/Eraser/Settings.cs @ 1985

/* 
 * $Id$
 * Copyright 2008-2010 The Eraser Project
 * Original Author: Joel Low <lowjoel@users.sourceforge.net>
 * Modified By:
 * 
 * This file is part of Eraser.
 * 
 * Eraser 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 3 of the License, or (at your option) any later
 * version.
 * 
 * Eraser is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 * 
 * A copy of the GNU General Public License can be found at
 * <http://www.gnu.org/licenses/>.
 */

using System;
using System.Collections.Generic;
using System.Windows.Forms;
using System.Text;

using System.IO;
using System.Globalization;
using System.Runtime.Serialization;
using System.Runtime.Serialization.Formatters.Binary;
using Microsoft.Win32;

using Eraser.Util;

namespace Eraser
{
    internal class Settings : Manager.SettingsManager
    {
        /// <summary>
        /// Registry-based storage backing for the Settings class.
        /// </summary>
        private sealed class RegistrySettings : Manager.Settings, IDisposable
        {
            /// <summary>
            /// Constructor.
            /// </summary>
            /// <param name="pluginId">The GUID of the plugin for which settings are stored.</param>
            /// <param name="key">The registry key to look for the settings in.</param>
            public RegistrySettings(Guid pluginId, RegistryKey key)
            {
                if (key == null)
                    throw new ArgumentNullException("key");

                PluginID = pluginId;
                Key = key;
            }

            #region IDisposable Members

            ~RegistrySettings()
            {
                Dispose(false);
            }

            public void Dispose()
            {
                Dispose(true);
                GC.SuppressFinalize(this);
            }

            private void Dispose(bool disposing)
            {
                if (Key == null)
                    return;

                if (disposing)
                    Key.Close();
                Key = null;
            }

            #endregion

            public override T GetValue<T>(string name, T defaultValue)
            {
                //Get the raw registry value
                object rawResult = Key.GetValue(name, null);

                //Check if it is a serialised object
                byte[] resultArray = rawResult as byte[];
                if (resultArray != null)
                {
                    using (MemoryStream stream = new MemoryStream(resultArray))
                        try
                        {
                            BinaryFormatter formatter = new BinaryFormatter();
                            if (typeof(T) != typeof(object))
                                formatter.Binder = new TypeNameSerializationBinder(typeof(T));
                            return (T)formatter.Deserialize(stream);
                        }
                        catch (SerializationException)
                        {
                            Key.DeleteValue(name);
                            MessageBox.Show(S._("Could not load the setting {0}\\{1} for " +
                                    "plugin {2}. The setting has been lost.", Key, name,
                                    PluginID.ToString()),
                                S._("Eraser"), MessageBoxButtons.OK, MessageBoxIcon.Error,
                                MessageBoxDefaultButton.Button1,
                                Localisation.IsRightToLeft(null) ? MessageBoxOptions.RtlReading : 0);
                        }
                }
                else if (typeof(T) == typeof(Guid))
                {
                    return (T)(object)new Guid((string)rawResult);
                }
                else
                {
                    return (T)rawResult;
                }

                return defaultValue;
            }

            public override void SetValue(string name, object value)
            {
                if (value == null)
                {
                    Key.DeleteValue(name);
                }
                else
                {
                    if (value is bool)
                        Key.SetValue(name, value, RegistryValueKind.DWord);
                    else if ((value is int) || (value is uint))
                        Key.SetValue(name, value, RegistryValueKind.DWord);
                    else if ((value is long) || (value is ulong))
                        Key.SetValue(name, value, RegistryValueKind.QWord);
                    else if ((value is string) || (value is Guid))
                        Key.SetValue(name, value, RegistryValueKind.String);
                    else if (value is ICollection<string>)
                    {
                        ICollection<string> collection = (ICollection<string>)value;
                        string[] temp = new string[collection.Count];
                        collection.CopyTo(temp, 0);
                        Key.SetValue(name, temp, RegistryValueKind.MultiString);
                    }
                    else
                        using (MemoryStream stream = new MemoryStream())
                        {
                            new BinaryFormatter().Serialize(stream, value);
                            Key.SetValue(name, stream.ToArray(), RegistryValueKind.Binary);
                        }
                }
            }

            /// <summary>
            /// The GUID of the plugin whose settings this object is storing.
            /// </summary>
            private Guid PluginID;

            /// <summary>
            /// The registry key where the data is stored.
            /// </summary>
            private RegistryKey Key;
        }

        public override void Save()
        {
        }

        protected override Manager.Settings GetSettings(Guid guid)
        {
            RegistryKey eraserKey = null;

            try
            {
                //Open the registry key containing the settings
                eraserKey = Registry.CurrentUser.OpenSubKey(Program.SettingsPath, true);
                if (eraserKey == null)
                    eraserKey = Registry.CurrentUser.CreateSubKey(Program.SettingsPath);

                RegistryKey pluginsKey = eraserKey.OpenSubKey(guid.ToString(), true);
                if (pluginsKey == null)
                    pluginsKey = eraserKey.CreateSubKey(guid.ToString());

                //Return the Settings object.
                return new RegistrySettings(guid, pluginsKey);
            }
            finally
            {
                if (eraserKey != null)
                    eraserKey.Close();
            }
        }
    }

    internal class EraserSettings
    {
        /// <summary>
        /// Constructor.
        /// </summary>
        private EraserSettings()
        {
            settings = Manager.ManagerLibrary.Instance.SettingsManager.ModuleSettings;
        }

        /// <summary>
        /// Gets the singleton instance of the Eraser UI Settings.
        /// </summary>
        /// <returns>The global instance of the Eraser UI settings.</returns>
        public static EraserSettings Get()
        {
            if (instance == null)
                instance = new EraserSettings();
            return instance;
        }

        /// <summary>
        /// Gets or sets the LCID of the language which the UI should be displayed in.
        /// </summary>
        public string Language
        {
            get
            {
                return settings.GetValue("Language", GetCurrentCulture().Name);
            }
            set
            {
                settings.SetValue("Language", value);
            }
        }

        /// <summary>
        /// Gets or sets whether the Shell Extension should be loaded into Explorer.
        /// </summary>
        public bool IntegrateWithShell
        {
            get
            {
                return settings.GetValue("IntegrateWithShell", true);
            }
            set
            {
                settings.SetValue("IntegrateWithShell", value);
            }
        }

        /// <summary>
        /// Gets or sets a value on whether the main frame should be minimised to the
        /// system notification area.
        /// </summary>
        public bool HideWhenMinimised
        {
            get
            {
                return settings.GetValue("HideWhenMinimised", true);
            }
            set
            {
                settings.SetValue("HideWhenMinimised", value);
            }
        }

        /// <summary>
        /// Gets ot setts a value whether tasks which were completed successfully
        /// should be removed by the Eraser client.
        /// </summary>
        public bool ClearCompletedTasks
        {
            get
            {
                return settings.GetValue("ClearCompletedTasks", true);
            }
            set
            {
                settings.SetValue("ClearCompletedTasks", value);
            }
        }

        /// <summary>
        /// Gets the most specific UI culture with a localisation available, defaulting to English
        /// if none exist.
        /// </summary>
        /// <returns>The CultureInfo of the current UI culture, correct to the top level.</returns>
        private static CultureInfo GetCurrentCulture()
        {
            System.Reflection.Assembly entryAssembly = System.Reflection.Assembly.GetEntryAssembly();
            CultureInfo culture = CultureInfo.CurrentUICulture;
            while (culture.Parent != CultureInfo.InvariantCulture &&
                !Localisation.LocalisationExists(culture, entryAssembly))
            {
                culture = culture.Parent;
            }

            //Default to English if any of our cultures don't exist.
            if (!Localisation.LocalisationExists(culture, entryAssembly))
                culture = new CultureInfo("en");

            return culture;
        }

        /// <summary>
        /// The data store behind the object.
        /// </summary>
        private Manager.Settings settings;

        /// <summary>
        /// The global instance of the settings class.
        /// </summary>
        private static EraserSettings instance;
    }
}