/*********************************************************************/
/*                                                                   */
/*                     AgentService Framework                        */
/*                       www.agentservice.it                         */
/*                                                                   */
/* Copyright (C) 2007 l.i.d.o. - DIST, University of Genoa, Italy    */
/* GNU Lesser General Public License                                 */
/*                                                                   */
/* This library is free software; you can redistribute it and/or     */
/* modify it under the terms of the GNU Lesser General Public        */
/* License as published by the Free Software Foundation,             */
/* version 2.1 of the License.                                       */
/*                                                                   */
/* This library 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 */
/* Lesser General Public License for more details.                   */
/*                                                                   */
/* You should have received a copy of the GNU Lesser General Public  */
/* License along with this library; if not, write to the             */
/* Free Software Foundation, Inc., 59 Temple Place - Suite 330,      */
/* Boston, MA  02111-1307, USA.                                      */
/*                                                                   */
/*********************************************************************/
using System;
using System.IO;
using System.Reflection;

using AgentService.Interop;
using AgentService.Platform.AMS;
using AgentService.Platform.MTS;
using AgentService.Platform.Modules;

namespace AgentService.Platform
{

    
	/// <summary>
	/// Manage the operation with the modules exposed by the platform ocntroller 
	/// </summary>
	[Serializable]
	public class ModuleController : IModuleController
	{

		/// <summary>
		/// Reference to the bound platform
		/// </summary>
		private Platform platform;

		/// <summary>
		/// Constructs a module controller object with the boud platform
		/// </summary>
		/// <param name="platform">Reference to the platform object to be bound</param>
		public ModuleController(Platform platform)
		{
			this.platform = platform;
		}



		#region Storage
        /// <summary>
        /// Retrieves the information for all the installed modules
        /// in the platform.
        /// </summary>
        /// <param name="bAdditional">include additional modules</param>
        /// <returns>an array containing all the installed modules</returns>
		public IModuleInfo[] GetInstalledModules(bool bAdditional)
		{
			IModuleInfo[] infos;
			IModuleInfo[] additionals = this.platform.Configuration.AdditionalModules;
			int length = 4; 
			if(bAdditional == true)
			{
				length = length + additionals.Length;
			}
			infos = new ModuleInfo[length];
			infos[0] = this.platform.Configuration.MessagingModule;
			infos[1] = this.platform.Configuration.LoggingModule;
			infos[2] = this.platform.Configuration.PersistenceModule;
			infos[3] = this.platform.Configuration.StorageModule;

			/*
			for(int i=4;i<length;i++)
			{
				infos[i] = additionals[i-4];
			}
			*/

			additionals.CopyTo(infos, 4);

			return infos;
		}

		/// <summary>
		/// Gets all the Assembly contained in the repository
		/// </summary>
		/// <returns>List of assemblies</returns>
		public AssemblyName[] GetStoredAssemblies()
		{
            return this.platform.Storage.GetStoredAssemblies();
		}
        /// <summary>
        /// Gets the list of the stored AgentTemplate types
        /// used to instantiate agents.
        /// </summary>
        /// <returns>an array containing a AgentTemplateDescriptor object for each AgentTemplate</returns>
		public AgentTemplateDescriptor[] GetStoredAgentTemplates()
		{
            return this.platform.Storage.GetStoredAgentTemplates();
		}
        /// <summary>
        /// Gets the list of the stored Behaviour types
        /// used to instantiate agents.
        /// </summary>
        /// <returns>an array containing a BehaviourDescriptor object for each Behavoiur</returns>
		public BehaviourDescriptor[] GetStoredBehaviours()
		{
            return this.platform.Storage.GetStoredBehaviours();
		}
        /// <summary>
        /// Gets the list of the stored Knowledge types
        /// used to instantiate agents.
        /// </summary>
        /// <returns>an array containing a KnowledgeDescriptor object for each Knowledge</returns>
		public KnowledgeDescriptor[] GetStoredKnowledges()
		{
            return this.platform.Storage.GetStoredKnowledges();
		}

		#endregion

		#region Logging
		public string GetLogFile(AID aid)
		{
			//TODO: implement this inside the logging module (interface and default module)
			return null;
		}
		#endregion

		/// <summary>
		/// Uploads an assembly to the platform's storage
		/// </summary>
		/// <param name="asmPath">path to the assembly</param>
		/// <returns>null if successfull a description of the error otherwise</returns>
		public IModuleError UpLoadAssembly(string asmPath, bool bReplaceIfExists) 
		{
			if (this.platform.State == PlatformState.Ready)
			{
                if (this.platform.Storage.AddAssembly(asmPath, bReplaceIfExists) == false)
                {
                    return this.platform.Storage.GetLastError();
                }
                else
                {
                    return null;
                }
			}

			return new ModuleError((int) ModuleErrorCodes.InvalidState, null, "cannot Add assemblies while platform is not in the Ready state");
		}

		/// <summary>
		/// Removes an assembly from the platform's storage
		/// </summary>
		/// <param name="asmPath">path to the assembly</param>
		/// <returns>null if successfull a description of the error otherwise</returns>
		public IModuleError RemoveAssembly(string asmPath) 
		{
            if (this.platform.State == PlatformState.Ready)
            {
                if (this.platform.Storage.RemoveAssembly(asmPath) == false)
                {
                    return this.platform.Storage.GetLastError();
                }
                else
                {
                    return null;
                }
            }

            return new ModuleError((int) ModuleErrorCodes.InvalidState, null, "cannot Add assemblies while platform is not in the Ready state");
		}

        #region Messaging
        /// <summary>
        /// Gets a collection of filtered messages
        /// </summary>
        /// <param name="aid">aid of the agent</param>
        /// <param name="filter">filter criteria</param>
        /// <returns>list of filtered messages</returns>
        public AgentMessageCollection FilterMessage(AID aid, MessageFilter filter)
        {
            //TODO: to be implemented;
            return null;
        }
        /// <summary>
        /// Clears all the messages in the storage.
        /// </summary>		
        public void ClearAllMessages()
        {
            //TODO: to be implemented;
        }
        /// <summary>
        /// Clears all the messages in the storage for a given agent.
        /// </summary>
        /// <param name="aid">AID identifing the agent</param>
        /// <returns>true, if the process is successful</returns>
        public bool ClearAllMessages(AID aid)
        {
            //TODO: to be implemented;
            return false;
        }
        #endregion
	}
}