//-----------------------------------------------------------------------
// <copyright file="DataSourceImplementation.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
{
    using System;
    using System.Collections.Generic;
    using System.IO;
    using System.Windows.Forms;
    using global::DataSource.FileAccess;
    using global::SharedObjects;
    using global::SharedObjects.DataMgmt;
    using global::SharedObjects.Misc;

    /// <summary>
    /// Implementation of data source interface.
    /// </summary>
    public class DataSourceImplementation : IDataSource
    {
        /// <summary>
        /// Communication speeds file.
        /// </summary>
        public const string COMMSPEED_FILE = "commspeeds.xml";

        /// <summary>
        /// Preferences file.
        /// </summary>
        public const string PREFERENCES_FILE = "preferences.xml";

        /// <summary>
        /// Parameters file.
        /// </summary>
        public const string PARAMETERS_FILE = "parameters.xml";

        /// <summary>
        /// Modes file.
        /// </summary>
        public const string MODES_FILE = "modes.xml";

        /// <summary>
        /// Pidgroups file.
        /// </summary>
        public const string PIDGROUP_FILE = "pidgroups.xml";

        /// <summary>
        /// Units file.
        /// </summary>
        public const string UNITS_FILE = "units.xml";

        /// <summary>
        /// Vehicles file.
        /// </summary>
        public const string VEHICLES_FILE = "vehicles.xml";

        /// <summary>
        /// Icons file.
        /// </summary>
        public const string ICONS_FILE = "icons.xml";

        /// <summary>
        /// Filters file.
        /// </summary>
        public const string FILTER_FILE = "filters.xml";

        /// <summary>
        /// Gauges config file.
        /// </summary>
        public const string GAUGES_FILE = "gauges.xml";

        /// <summary>
        /// Gauges config file.
        /// </summary>
        public const string TELLTALES_FILE = "telltales.xml";

        /// <summary>
        /// General OBD codes file.
        /// </summary>
        public const string OBDCODES_FILE = "obdcodes.txt";

        /// <summary>
        /// Event logging instance.
        /// </summary>
        private ILogging iLogging;

        /// <summary>
        /// Current preferences implementation instance.
        /// </summary>
        private IPreferences iPreferences;

        /// <summary>
        /// Communication speeds file access instance.
        /// </summary>
        private CommspeedFileAccess commspeedFileAccess;

        /// <summary>
        /// Vehicles file access instance.
        /// </summary>
        private VehiclesFileAccess vehiclesFileAccess;

        /// <summary>
        /// Access instance for mode file.
        /// </summary>
        private ModeFileAccess modeFileAccess;

        /// <summary>
        /// Access instance for pidgroup file.
        /// </summary>
        private PidGroupFileAccess pidGroupFileAccess;

        /// <summary>
        /// Access instance for units file.
        /// </summary>
        private UnitsFileAccess unitsFileAccess;

        /// <summary>
        /// Parameters file access instance.
        /// </summary>
        private ParametersFileAccess parametersFileAccess;

        /// <summary>
        /// Icon registry file access.
        /// </summary>
        private IconFileAccess iconFileAccess;

        /// <summary>
        /// Filter file access.
        /// </summary>
        private FilterFileAccess filterFileAccess;

        /// <summary>
        /// Access class for gauges file.
        /// </summary>
        private GaugeFileAccess gaugeFileAccess;

        /// <summary>
        /// Access class for telltales file.
        /// </summary>
        private TelltaleFileAccess telltaleFileAccess;

        /// <summary>
        /// Gets commspeed list instance.
        /// </summary>
        public IList<XmlClass.commspeed> commspeeds
        {
            get
            {
                return this.commspeedFileAccess.commspeeds;
            }
        }

        /// <summary>
        /// Gets vehicles list instance.
        /// </summary>
        public IList<XmlClass.vehicle> vehicles
        {
            get
            {
                return this.vehiclesFileAccess.vehicles;
            }
        }

        /// <summary>
        /// Gets pidgroups list instance.
        /// </summary>
        public IList<XmlClass.modeitem> modes
        {
            get
            {
                return this.modeFileAccess.modegroups;
            }
        }

        /// <summary>
        /// Gets pidgroups list instance.
        /// </summary>
        public IList<XmlClass.pidgroup> pidgroups
        {
            get
            {
                return this.pidGroupFileAccess.pidgrouplist;
            }
        }

        /// <summary>
        /// Gets pidgroups list instance.
        /// </summary>
        public IList<XmlClass.pidgroup> restrictedPidgroups
        {
            get
            {
                return this.pidGroupFileAccess.restrictedPidgrouplist;
            }
        }

        /// <summary>
        /// Gets units list instance.
        /// </summary>
        public IList<XmlClass.unititem> units
        {
            get
            {
                return this.unitsFileAccess.unitslist;
            }
        }

        /// <summary>
        /// Gets parameter list instance.
        /// </summary>
        public IList<XmlClass.parameteritem> parameters
        {
            get
            {
                return this.parametersFileAccess.paramlist;
            }
        }

        /// <summary>
        /// Gets List of supported icons.
        /// </summary>
        public IList<XmlClass.icon> icons
        {
            get
            {
                return this.iconFileAccess.icons;
            }
        }

        /// <summary>
        /// Gets List of supported filters.
        /// </summary>
        public IList<XmlClass.filter> filters
        {
            get
            {
                return this.filterFileAccess.filters;
            }
        }

        /// <summary>
        /// Gets List of supported gauges.
        /// </summary>
        public IList<XmlClass.gaugeitem> gauges
        {
            get
            {
                return this.gaugeFileAccess.gaugeitems;
            }
        }

        /// <summary>
        /// Gets List of supported telltales.
        /// </summary>
        public IList<XmlClass.telltaleitem> telltales
        {
            get
            {
                return this.telltaleFileAccess.telltaleitems;
            }
        }

        /// <summary>
        /// Gets data file directory.
        /// </summary>
        public string dataFileDir { get; private set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="DataSourceImplementation" /> class.
        /// </summary>
        /// <param name="iLogging">Event logging instance.</param>
        /// <param name="iPreferences">Preferences interface instance.</param>
        /// <param name="dataFileDir">Data file directory path.</param>
        public DataSourceImplementation(ILogging iLogging, IPreferences iPreferences, string dataFileDir)
        {
            this.iLogging = iLogging;
            this.iPreferences = iPreferences;
            this.dataFileDir = dataFileDir;

            this.commspeedFileAccess = new CommspeedFileAccess(this.iLogging, DataSourceImplementation.COMMSPEED_FILE, this.dataFileDir);

            this.vehiclesFileAccess = new VehiclesFileAccess(this.iLogging, DataSourceImplementation.VEHICLES_FILE, this.dataFileDir);

            this.unitsFileAccess = new UnitsFileAccess(this.iLogging, DataSourceImplementation.UNITS_FILE, this.dataFileDir);

            this.parametersFileAccess = new ParametersFileAccess(iLogging, DataSourceImplementation.PARAMETERS_FILE, this.dataFileDir);

            this.modeFileAccess = new ModeFileAccess(this.iLogging, DataSourceImplementation.MODES_FILE, this.dataFileDir);

            this.pidGroupFileAccess = new PidGroupFileAccess(this.iPreferences, this.iLogging, this, DataSourceImplementation.PIDGROUP_FILE, this.dataFileDir);

            this.iconFileAccess = new IconFileAccess(this.iLogging, DataSourceImplementation.ICONS_FILE, this.dataFileDir);

            this.filterFileAccess = new FilterFileAccess(iLogging, DataSourceImplementation.FILTER_FILE, this.dataFileDir);

            this.gaugeFileAccess = new GaugeFileAccess(iLogging, DataSourceImplementation.GAUGES_FILE, this.dataFileDir);

            this.telltaleFileAccess = new TelltaleFileAccess(iLogging, DataSourceImplementation.TELLTALES_FILE, this.dataFileDir);
        }

        /// <summary>
        /// Locate data files directory.
        /// </summary>
        /// <returns>Path to data files.</returns>
        public static string locateDataFiles()
        {
            string dataFileDir = null;

            foreach (string pathStr in Utils.DEFAULT_DATA_FILE_DIR)
            {
                string expPath = Environment.ExpandEnvironmentVariables(pathStr);
                if (File.Exists(expPath + DataSourceImplementation.PARAMETERS_FILE))
                {
                    dataFileDir = expPath;
                    break;
                }
            }

            if (dataFileDir == null)
            {
                string currDir = Directory.GetCurrentDirectory();
                MessageBox.Show(
                    "Data files not found in expected location '" + dataFileDir + "',\r\n"
                     + "trying current directory '" + currDir + "' instead.",
                    "Info",
                    MessageBoxButtons.OK,
                    MessageBoxIcon.Information);

                dataFileDir = currDir + "\\";
            }

            return dataFileDir;
        }

        /// <summary>
        /// Load data from files.
        /// </summary>
        public void load()
        {
            //// Notice that the order below is important.
            this.commspeedFileAccess.load();
            this.unitsFileAccess.load();
            this.parametersFileAccess.load();
            this.vehiclesFileAccess.load();
            this.modeFileAccess.load();
            this.pidGroupFileAccess.load();
            this.iconFileAccess.load();
            this.filterFileAccess.load();
            this.gaugeFileAccess.load();
            this.telltaleFileAccess.load();
        }

        /// <summary>
        /// Reload the pid group data.
        /// </summary>
        public void loadPidgroups()
        {
            this.pidGroupFileAccess.load();
        }

        /// <summary>
        /// Save the vehicle data to file.
        /// </summary>
        public void saveCommspeeds()
        {
            this.commspeedFileAccess.save();
        }

        /// <summary>
        /// Save the vehicle data to file.
        /// </summary>
        public void saveVehicles()
        {
            this.vehiclesFileAccess.save();
        }

        /// <summary>
        /// Save the unit data to file.
        /// </summary>
        public void saveUnits()
        {
            this.unitsFileAccess.save();
        }

        /// <summary>
        /// Save parameter data.
        /// </summary>
        public void saveParameters()
        {
            this.parametersFileAccess.save();
        }

        /// <summary>
        /// Save the Modes data to file.
        /// </summary>
        public void saveModes()
        {
            this.modeFileAccess.save();
        }

        /// <summary>
        /// Save the PID group data to file.
        /// </summary>
        public void savePidgroups()
        {
            this.pidGroupFileAccess.save();
        }

        /// <summary>
        /// Save the PID group data to file.
        /// </summary>
        public void saveIcons()
        {
            this.iconFileAccess.save();
        }

        /// <summary>
        /// Save the Filters data to file.
        /// </summary>
        public void saveFilters()
        {
            this.filterFileAccess.save();
        }

        /// <summary>
        /// Save the gauge data to file.
        /// </summary>
        public void saveGauges()
        {
            this.gaugeFileAccess.save();
        }

        /// <summary>
        /// Save the telltale data to file.
        /// </summary>
        public void saveTelltales()
        {
            this.telltaleFileAccess.save();
        }
    }
}