//-----------------------------------------------------------------------
// <copyright file="FirstPagePanel.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 UserInterface.GUI
{
    using System.Collections.Generic;
    using System.Drawing;
    using System.IO;
    using System.Windows.Forms;
    using global::UserInterface.GUI.Dialogs;

    /// <summary>
    /// Empty control for where there is no need for user interaction.
    /// </summary>
    public partial class FirstPagePanel : UserControl
    {
        /// <summary>
        /// Error text in RTF format, part 1.
        /// </summary>
        private const string ERRTXT_PART1 = "{\\rtf1\\ansi\\ansicpg1252\\deff0\\deflang1053{\\fonttbl{\\f0\\fnil\\fcharset0 Calibri;}}\r\n"
            + "{\\colortbl ;\\red255\\green0\\blue0;}\r\n"
            + "{\\*\\generator Msftedit 5.41.21.2510;}\\viewkind4\\uc1\\pard\\sa200\\sl276\\slmult1\\cf1\\lang29\\b\\f0\\fs22 File \\cf0\\b0 \"";

        /// <summary>
        /// Error text in RTF format, part 2.
        /// </summary>
        private const string ERRTXT_PART2 = "\"\\cf1\\b  was not found!\\par\r\n"
            + "}\r\n";

        /// <summary>
        /// File containing info text to display on first page.
        /// </summary>
        private static string INFO_FILE = "Texts\\FirstPageInfo.rtf";

        /// <summary>
        /// Application tree instance.
        /// </summary>
        private ApplicationTree applicationTree;

        /// <summary>
        /// Dictionary of interface nodes in the tree.
        /// </summary>
        private Dictionary<string, TreeNode> interfaceNodes = new Dictionary<string, TreeNode>();

        /// <summary>
        /// Information text form.
        /// </summary>
        private InfoForm infoForm;

        /// <summary>
        /// Data file directory path.
        /// </summary>
        private string dataFileDir;

        /// <summary>
        /// Initializes a new instance of the <see cref="FirstPagePanel" /> class.
        /// </summary>
        /// <param name="applicationTree">Application tree instance.</param>
        /// <param name="dataFileDir">Data file directory path.</param>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA1806:DoNotIgnoreMethodResults", MessageId = "CanApp.CustomToolTip", Justification = "Reviewed, intentional.")]
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope", Justification = "Reviewed, intentional.")]
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1800:DoNotCastUnnecessarily", Justification = "Reviewed.")]
        public FirstPagePanel(ApplicationTree applicationTree, string dataFileDir)
        {
            this.applicationTree = applicationTree;
            this.dataFileDir = dataFileDir;

            this.InitializeComponent();

            this.Anchor = ((System.Windows.Forms.AnchorStyles)((((System.Windows.Forms.AnchorStyles.Top
                | System.Windows.Forms.AnchorStyles.Bottom)
                | System.Windows.Forms.AnchorStyles.Left)
                | System.Windows.Forms.AnchorStyles.Right)));

            foreach (Control control in this.flowLayoutPanel1.Controls)
            {
                if (control is Button)
                {
                    Button button = (Button)control;
                    button.Click += new System.EventHandler(this.button_Click);
                }
            }

            this.toolTip1.SetToolTip(this.helpButton, "Help");
        }

        /// <summary>
        /// Register a selectable node in the tree.
        /// </summary>
        /// <param name="key">Key for node.</param>
        /// <param name="node">Actual node.</param>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1800:DoNotCastUnnecessarily", Justification = "Reviewed.")]
        public void registerNode(string key, TreeNode node)
        {
            this.interfaceNodes.Add(key, node);

            foreach (Control control in this.flowLayoutPanel1.Controls)
            {
                if (control is Button)
                {
                    Button button = (Button)control;
                    if (!string.IsNullOrEmpty(button.AccessibleName))
                    {
                        string[] sa = button.AccessibleName.Split(new char[] { ',' });
                        foreach (string buttonKey in sa)
                        {
                            if (buttonKey == key)
                            {
                                button.BackColor = Color.Green;
                                break;
                            }
                        }
                    }
                }
            }
        }

        /// <summary>
        /// Create an error message as a RTF text to show to the user when a file isn't found.
        /// </summary>
        /// <param name="fileName">File name to refer to.</param>
        /// <returns>Composed RTF text.</returns>
        private static string getErrorMessage(string fileName)
        {
            return ERRTXT_PART1 + fileName.Replace("\\", "\\\\") + ERRTXT_PART2;
        }

        /// <summary>
        /// Load text from file.
        /// <para>
        /// Throws an exception if file not found.
        /// </para>
        /// </summary>
        /// <param name="fileName">Name of file to load from.</param>
        /// <returns>Loaded text.</returns>
        private static string loadTextFromFile(string fileName)
        {
            string buf = string.Empty;
            StreamReader sr = new StreamReader(fileName);
            try
            {
                string line;
                while ((line = sr.ReadLine()) != null)
                {
                    buf += line + "\r\n";
                }
            }
            finally
            {
                sr.Close();
            }

            return buf;
        }

        /// <summary>
        /// Adds info text to the panel from an external RTF file.
        /// </summary>
        private void addInfoText()
        {
            string rtf = string.Empty;

            string fileName = this.dataFileDir + INFO_FILE;

            try
            {
                string buf = loadTextFromFile(fileName);
                rtf = buf;
            }
            catch
            {
                rtf = getErrorMessage(fileName);
            }

            this.infoForm.setText(rtf);
        }

        /// <summary>
        /// Button clicked event handler.
        /// </summary>
        /// <param name="sender">Sending object.</param>
        /// <param name="e">Event data.</param>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1800:DoNotCastUnnecessarily", Justification = "Reviewed.")]
        private void button_Click(object sender, System.EventArgs e)
        {
            if (sender is Button)
            {
                Button button = (Button)sender;
                string txt;
                string fileName = this.dataFileDir + "Texts\\" + button.Name + ".rtf";
                try
                {
                    txt = loadTextFromFile(fileName);
                }
                catch
                {
                    txt = getErrorMessage(fileName);
                }

                MyInfoBox mib = new MyInfoBox();
                try
                {
                    bool enableOk = false;
                    string matchKey = null;
                    if (!string.IsNullOrEmpty(button.AccessibleName))
                    {
                        string[] sa = button.AccessibleName.Split(new char[] { ',' });
                        foreach (string buttonKey in sa)
                        {
                            if (this.interfaceNodes.ContainsKey(buttonKey))
                            {
                                enableOk = true;
                                matchKey = buttonKey;
                                break;
                            }
                        }
                    }

                    if (mib.Show("Information", "About " + button.Text, txt, enableOk) == DialogResult.OK)
                    {
                        TreeNode node = this.interfaceNodes[matchKey];
                        this.applicationTree.selectNode(node);
                    }
                }
                finally
                {
                    mib.Dispose();
                }
            }
        }

        /// <summary>
        /// Handle click on Help button.
        /// </summary>
        /// <param name="sender">Sending object.</param>
        /// <param name="e">Event data.</param>
        private void helpButton_Click(object sender, System.EventArgs e)
        {
            if (this.infoForm == null || !this.infoForm.CanFocus)
            {
                this.infoForm = new InfoForm();
                this.addInfoText();
            }

            this.infoForm.WindowState = FormWindowState.Normal;
            this.infoForm.Show();
            this.infoForm.Focus();
        }
    }
}