//-----------------------------------------------------------------------
// <copyright file="VehiclesFileAccess.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.Collections.Generic;
    using System.IO;
    using System.Windows.Forms;
    using System.Xml.Serialization;
    using global::SharedObjects;
    using global::SharedObjects.Misc;

    /// <summary>
    /// Class for file access.
    /// </summary>
    public class VehiclesFileAccess : XmlParserHelper
    {
        /// <summary>
        /// Name of file used.
        /// </summary>
        private string fileName;

        /// <summary>
        /// Gets List of vehicles.
        /// </summary>
        private List<XmlClass.vehicle> vehiclesInt = new List<XmlClass.vehicle>();

        /// <summary>
        /// Gets List of vehicles.
        /// </summary>
        public IList<XmlClass.vehicle> vehicles
        {
            get { return this.vehiclesInt; }
        }

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

        /// <summary>
        /// Make a copy of an existing object.
        /// </summary>
        /// <param name="oldVehicle">Source object.</param>
        /// <returns>New object</returns>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2202:Do not dispose objects multiple times", Justification = "Reviewed.")]
        public static XmlClass.vehicle duplicate(XmlClass.vehicle oldVehicle)
        {
            XmlClass.vehicle newVehicle = null;
            if (oldVehicle != null)
            {
                XmlSerializer xms = new XmlSerializer(oldVehicle.GetType());

                using (Stream stream = new MemoryStream())
                {
                    try
                    {
                        xms.Serialize(stream, oldVehicle);
                        stream.Seek(0, SeekOrigin.Begin);
                        newVehicle = (XmlClass.vehicle)xms.Deserialize(stream);
                    }
                    finally
                    {
                        stream.Close();
                    }
                }
            }

            return newVehicle;
        }

        /// <summary>
        /// Get the highest vehicle ID.
        /// </summary>
        /// <param name="vehicles">List to search in.</param>
        /// <returns>Highest vehicle ID.</returns>
        public static int getHighestVehicleId(IList<XmlClass.vehicle> vehicles)
        {
            int n = 1;
            if (vehicles != null)
            {
                foreach (XmlClass.vehicle vehicle in vehicles)
                {
                    if (n < vehicle.id)
                    {
                        n = vehicle.id;
                    }
                }
            }

            return n;
        }

        /// <summary>
        /// Get message flags for vehicle.
        /// </summary>
        /// <param name="vehicle">Vehicle item to get flags from.</param>
        /// <returns>Message flags.</returns>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1062:Validate arguments of public methods", MessageId = "0", Justification = "Reviewed.")]
        public static uint getMsgFlags(XmlClass.vehicle vehicle)
        {
            uint flagbits = 0;
            string unsupportedFlags = string.Empty;
            foreach (XmlClass.vehicle.flags flag in vehicle.msgflags)
            {
                switch (flag.flag)
                {
                    case "START_OF_MESSAGE":
                        flagbits |= 0x00000002;
                        break;
                    case "ISO15765_FRAME_PAD":
                        flagbits |= 0x00000040;
                        break;
                    case "ISO15765_ADDR_TYPE":
                        flagbits |= 0x00000080;
                        break;
                    case "CAN_29BIT_ID":
                        flagbits |= 0x00000100;
                        break;
                    case "WAIT_P3_MIN_ONLY":
                        flagbits |= 0x00000200;
                        break;
                    case "SCI_MODE":
                        flagbits |= 0x00400000;
                        break;
                    case "SCI_TX_VOLTAGE":
                        flagbits |= 0x00800000;
                        break;
                    default:
                        unsupportedFlags += flag.flag + "\r\n";
                        break;
                }
            }

            if (unsupportedFlags.Length > 0)
            {
                MessageBox.Show(
                    vehicle.name + "\r\n\r\nUnsupported Msg Flags:\r\n" + unsupportedFlags,
                    "Warning",
                    MessageBoxButtons.OK,
                    MessageBoxIcon.Exclamation);
            }

            return flagbits;
        }

        /// <summary>
        /// Save the current list of vehicles.
        /// </summary>
        public void save()
        {
            this.save(this.vehiclesInt);
        }

        /// <summary>
        /// Load vehicle list from file.
        /// </summary>
        public void load()
        {
            this.iLogging.appendText("Loading vehicles." + "\r\n");

            this.vehiclesInt = new List<XmlClass.vehicle>();
            XmlSerializer xms = new XmlSerializer(this.vehiclesInt.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);
                this.vehiclesInt = (List<XmlClass.vehicle>)xms.Deserialize(sr);

                this.iLogging.appendText(this.vehiclesInt.Count + " vehicles Loaded from XML file." + "\r\n");
                for (int i = 0; i < this.vehiclesInt.Count; i++)
                {
                    string name = this.vehiclesInt[i].name;
                    int bits = this.vehiclesInt[i].addressbits;
                    int numEcus = 0;
                    if (this.vehiclesInt[i].ecus != null)
                    {
                        numEcus = this.vehiclesInt[i].ecus.Count;
                    }

                    this.iLogging.appendText("Vehicle " + i + ": " + name + ", bits=" + bits + ", numEcus=" + numEcus + "\r\n");
                }
            }
            finally
            {
                if (sr != null)
                {
                    sr.Close();
                }
            }

            this.vehiclesInt.Sort(Utils.vehicle_sorter);

            // Get highest ID of vehicle.
            int n = VehiclesFileAccess.getHighestVehicleId(this.vehiclesInt);

            // Set ID on all vehicles not having an ID.
            n++;
            foreach (XmlClass.vehicle vehicle in this.vehiclesInt)
            {
                if (vehicle.id == 0)
                {
                    vehicle.id = n++;
                }
            }
        }

        /// <summary>
        /// Save the vehicles.
        /// </summary>
        /// <param name="vehicles">List of vehicles to save.</param>
        private void save(List<XmlClass.vehicle> vehicles)
        {
            // Get highest ID of vehicle.
            int n = getHighestVehicleId(vehicles);

            // Set ID on all vehicles not having an ID.
            n++;
            foreach (XmlClass.vehicle vehicle in vehicles)
            {
                if (vehicle.id == 0)
                {
                    vehicle.id = n++;
                }
            }

            XmlSerializer xms = new XmlSerializer(vehicles.GetType());
            TextWriter writer = null;
            try
            {
                writer = new StreamWriter(this.dataFileDir + this.fileName);
                xms.Serialize(writer, vehicles);
            }
            finally
            {
                if (writer != null)
                {
                    writer.Close();
                }
            }
        }
    }
}