//-----------------------------------------------------------------------
// <copyright file="Plugin.cs" company="Craig Sutherland">
//     Copyright (c) 2009 Craig Sutherland. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
/* 
 * Copyright (c) 2009 Craig Sutherland
 * 
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */

namespace FastForward.WinCore
{
    using System;
    using System.Collections.Generic;
    using System.ComponentModel;
    using System.Reflection;
    using FastForward.WinCore.Configuration;

    /// <summary>
    /// The base class for all plug-ins to inherit from.
    /// </summary>
    public abstract class Plugin
    {
        #region Constructors
        /// <summary>
        /// Initializes a new instance of the <see cref="Plugin"/> class.
        /// </summary>
        /// <param name="configuration">The configuration for the plugin.</param>
        protected Plugin(PluginConfig configuration)
        {
            this.Configuration = configuration;
            this.CloseAction = HostCloseAction.Close;
        }
        #endregion

        #region Public properties
        #region Configuration
        /// <summary>
        /// Gets the configuration for this plugin.
        /// </summary>
        public PluginConfig Configuration { get; private set; }
        #endregion

        #region Host
        /// <summary>
        /// Gets the host for the plugin.
        /// </summary>
        public PluginHost Host { get; private set; }
        #endregion

        #region CloseAction
        /// <summary>
        /// Gets or sets the close action to perform when the user tries to close the host.
        /// </summary>
        public HostCloseAction CloseAction { get; protected set; }
        #endregion
        #endregion

        #region Protected properties
        #region Servers
        /// <summary>
        /// Gets the associated servers.
        /// </summary>
        protected ServerList Servers { get; private set; }
        #endregion
        #endregion

        #region Public methods
        #region RetrieveName()
        /// <summary>
        /// Retrieve the name of a plugin.
        /// </summary>
        /// <param name="pluginType">The type to get the name from.</param>
        /// <returns>The name of the plugin.</returns>
        public static string RetrieveName(Type pluginType)
        {
            var name = pluginType.Name;
            var nameAttribute = Attribute.GetCustomAttribute(pluginType, typeof(DisplayNameAttribute)) as DisplayNameAttribute;
            if (nameAttribute != null)
            {
                name = nameAttribute.DisplayName;
            }

            return name;
        }
        #endregion

        #region RetrieveDescription()
        /// <summary>
        /// Retrieve the description of a plugin.
        /// </summary>
        /// <param name="pluginType">The type to get the description from.</param>
        /// <returns>The description of the plugin.</returns>
        public static string RetrieveDescription(Type pluginType)
        {
            var description = string.Empty;
            var descAttribute = Attribute.GetCustomAttribute(pluginType, typeof(DescriptionAttribute)) as DescriptionAttribute;
            if (descAttribute != null)
            {
                description = descAttribute.Description;
            }

            return description;
        }
        #endregion

        #region RetrieveType()
        /// <summary>
        /// Retrieve the type for the plugin.
        /// </summary>
        /// <param name="configuration">The configuration to get the type from.</param>
        /// <returns>The type of the plugin.</returns>
        public static Type RetrieveType(PluginConfig configuration)
        {
            var type = Type.GetType(configuration.Type);
            if ((type == null) && !string.IsNullOrEmpty(configuration.Assembly))
            {
                var pluginAssembly = Assembly.LoadFrom(configuration.Assembly);
                type = pluginAssembly.GetType(configuration.Type);
            }

            return type;
        }
        #endregion

        #region StartNew()
        /// <summary>
        /// Start a new instance of a plugin.
        /// </summary>
        /// <param name="configuration">The configuration to start the plugin from.</param>
        /// <returns>The new plugin instance/</returns>
        public static Plugin StartNew(PluginConfig configuration)
        {
            var type = RetrieveType(configuration);
            var plugin = Activator.CreateInstance(type, configuration) as Plugin;
            return plugin;
        }
        #endregion

        #region Initialise()
        /// <summary>
        /// Initialises the plugin.
        /// </summary>
        /// <param name="host">The host that will contain the plugin.</param>
        /// <param name="servers">The loaded servers.</param>
        public void Initialise(PluginHost host, ServerList servers)
        {
            this.Host = host;
            this.Servers = servers;
            this.OnInitialise();
        }
        #endregion

        #region Terminate()
        /// <summary>
        /// Terminate the plugin.
        /// </summary>
        public abstract void Terminate();
        #endregion

        #region Configure()
        /// <summary>
        /// Configure the plugin.
        /// </summary>
        public void Configure()
        {
            var newConfig = this.OnConfigure();
            if (newConfig != null)
            {
                this.Configuration = newConfig;
            }
        }
        #endregion

        #region UpdateConfiguration()
        /// <summary>
        /// Update the configuration for the plugin.
        /// </summary>
        /// <param name="configuration">The new configuration.</param>
        public void UpdateConfiguration(PluginConfig configuration)
        {
            this.Configuration = configuration;
            this.OnConfigurationUpdated();
        }
        #endregion

        #region ListTabs()
        /// <summary>
        /// Lists the available tabs for this plug-in.
        /// </summary>
        /// <returns></returns>
        public virtual IEnumerable<string> ListTabs()
        {
            return new List<string>();
        }
        #endregion
        #endregion

        #region Protected methods
        #region OnInitialise()
        /// <summary>
        /// Initialise the actual plugin instance.
        /// </summary>
        protected abstract void OnInitialise();
        #endregion

        #region OnConfigure()
        /// <summary>
        /// Configure the actual plugin instance.
        /// </summary>
        /// <returns>Returns the updated configuration.</returns>
        protected abstract PluginConfig OnConfigure();
        #endregion

        #region OnConfigurationUpdated()
        /// <summary>
        /// The configuration has been updated.
        /// </summary>
        protected abstract void OnConfigurationUpdated();
        #endregion
        #endregion
    }
}