//-----------------------------------------------------------------------
// <copyright file="PreferencesFileAccess.cs" company="bedug.com">
//     Copyright © 2012 Nils Hammar. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
/*
 * Software to access vehicle information via the OBD-II connector.
 * 
 * Copyright © 2012 Nils Hammar
 * 
 * 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
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program 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.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 * 
 * Alternative licensing is possible, see the licensing document.
 * 
 * The above text may not be removed or modified.
 */

namespace DataSource.FileAccess
{
    using System;
    using System.Collections.Generic;
    using System.IO;
    using System.Windows.Forms;
    using System.Xml.Serialization;
    using global::SharedObjects;
    using global::SharedObjects.Misc;

    /// <summary>
    /// Access class for preferences file.
    /// </summary>
    public class PreferencesFileAccess : XmlParserHelper
    {
        /// <summary>
        /// Preference label for UNITS.
        /// </summary>
        public const string UNITS = "units";

        /// <summary>
        /// Preference label for UNITS.
        /// </summary>
        public const string DEFAULT_TIMEOUT = "default_timeout";

        /// <summary>
        /// Preference label for Message Queue Size.
        /// </summary>
        public const string MSG_QUEUE_SIZE = "msg_queue_size";

        /// <summary>
        /// Preference label for Secondary Y axis threshold.
        /// </summary>
        public const string SECONDARY_Y_THRESHOLD = "secondary_y_threshold";

        /// <summary>
        /// Preference label for VEHICLE.
        /// </summary>
        public const string VEHICLE = "vehicle";

        /// <summary>
        /// Preference label for OBDINFOSITE.
        /// </summary>
        public const string OBDINFOSITE = "obdinfosite";

        /// <summary>
        /// Preference label for LAST_DATA_DIRECTORY.
        /// </summary>
        public const string LAST_DATA_DIRECTORY = "lastDataDirectory";

        /// <summary>
        /// Preference label for ADVANCED_MODE.
        /// </summary>
        public const string ADVANCED_MODE = "advancedMode";

        /// <summary>
        /// Preference label for DEVELOPER_MODE.
        /// </summary>
        public const string DEVELOPER_MODE = "developerMode";

        /// <summary>
        /// Preference label for WINDOW_SIZE.
        /// </summary>
        public const string WINDOW_SIZE = "windowSize";

        /// <summary>
        /// Preference label for SEND_DELAY.
        /// </summary>
        public const string SEND_DELAY = "sendDelay";

        /// <summary>
        /// Preference label for BLOCK_SIZE.
        /// </summary>
        public const string BLOCK_SIZE = "blockSize";

        /// <summary>
        /// Preference label for FRAME_SPACING.
        /// </summary>
        public const string FRAME_SPACING = "frameSpacing";

        /// <summary>
        /// Name of file.
        /// </summary>
        private string fileName;

        /// <summary>
        /// Gets List of preferences.
        /// </summary>
        public IDictionary<string, XmlClass.preference> preferences { get; private set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="PreferencesFileAccess" /> class.
        /// </summary>
        /// <param name="iLogging">Logging interface.</param>
        /// <param name="fileName">Name of file.</param>
        /// <param name="dataFileDir">Data file directory path.</param>
        public PreferencesFileAccess(ILogging iLogging, string fileName, string dataFileDir)
            : base(iLogging, dataFileDir)
        {
            this.fileName = fileName;
            this.preferences = new SortedDictionary<string, XmlClass.preference>();
        }

        /// <summary>
        /// Save the current list to file.
        /// </summary>
        /// <returns>'true' when successful.</returns>
        public bool save()
        {
            bool success = false;
            List<XmlClass.preference> prefList = new List<XmlClass.preference>(this.preferences.Values);

            XmlSerializer xms = new XmlSerializer(prefList.GetType());

            xms.UnknownNode += new XmlNodeEventHandler(xms_UnknownNode);
            xms.UnknownAttribute += new XmlAttributeEventHandler(xms_UnknownAttribute);
            xms.UnknownElement += new XmlElementEventHandler(xms_UnknownElement);
            xms.UnreferencedObject += new UnreferencedObjectEventHandler(xms_UnreferencedObject);

            TextWriter writer = null;
            try
            {
                writer = new StreamWriter(this.dataFileDir + this.fileName);
                xms.Serialize(writer, prefList);
                success = true;
            }
            catch (Exception ex)
            {
                MessageBox.Show(
                    ex.Message,
                    "Save failed",
                    MessageBoxButtons.OK,
                    MessageBoxIcon.Hand);
            }
            finally
            {
                if (writer != null)
                {
                    writer.Close();
                }
            }

            return success;
        }

        /// <summary>
        /// Load data from file into the current list.
        /// </summary>
        public void load()
        {
            this.iLogging.appendText("Loading Preferences." + "\r\n");

            List<XmlClass.preference> prefList = new List<XmlClass.preference>();
            XmlSerializer xms = new XmlSerializer(prefList.GetType());

            xms.UnknownNode += new XmlNodeEventHandler(xms_UnknownNode);
            xms.UnknownAttribute += new XmlAttributeEventHandler(xms_UnknownAttribute);
            xms.UnknownElement += new XmlElementEventHandler(xms_UnknownElement);
            xms.UnreferencedObject += new UnreferencedObjectEventHandler(xms_UnreferencedObject);

            StreamReader sr = null;
            try
            {
                sr = new StreamReader(this.dataFileDir + this.fileName);
                prefList = (List<XmlClass.preference>)xms.Deserialize(sr);
            }
            catch (Exception ex)
            {
                // Just log the exception, it's usually because the file doesn't exist yet.
                this.iLogging.appendText(ex.Message + "\r\n");
            }
            finally
            {
                if (sr != null)
                {
                    sr.Close();
                }
            }

            this.preferences.Clear();
            foreach (XmlClass.preference pref in prefList)
            {
                this.preferences.Add(pref.name, pref);
            }

            this.iLogging.appendText(prefList.Count + " Preferences Loaded from XML file." + "\r\n");
        }
    }
}