//===============================================================================
// Microsoft patterns & practices Enterprise Library
// Logging Application Block
//===============================================================================
// Copyright © Microsoft Corporation.  All rights reserved.
// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY
// OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT
// LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
// FITNESS FOR A PARTICULAR PURPOSE.
//===============================================================================

using System;
using Microsoft.Practices.EnterpriseLibrary.Common.Configuration;
using Microsoft.Practices.EnterpriseLibrary.Common.Configuration.Manageability;
using Microsoft.Practices.EnterpriseLibrary.Common.Configuration.Manageability.Adm;
using Microsoft.Practices.EnterpriseLibrary.Logging.Configuration.Manageability.Properties;

namespace Microsoft.Practices.EnterpriseLibrary.Logging.Configuration.Manageability.Formatters
{
    /// <summary>
    /// Provides an implementation for <see cref="TextFormatterData"/> that
    /// processes policy overrides, performing appropriate logging of 
    /// policy processing errors.
    /// </summary>
    public class TextFormatterDataManageabilityProvider
        : ConfigurationElementManageabilityProviderBase<TextFormatterData>
    {
        /// <summary>
        /// The name of the template property.
        /// </summary>
        public const String TemplatePropertyName = "template";


        /// <summary>
        /// Initialize an instance of the <see cref="TextFormatterDataManageabilityProvider"/> class.
        /// </summary>
        public TextFormatterDataManageabilityProvider()
        { }

        /// <summary>
        /// Adds the ADM parts that represent the properties of
        /// a specific instance of the configuration element type managed by the receiver.
        /// </summary>
        /// <param name="contentBuilder">The <see cref="AdmContentBuilder"/> to which the Adm instructions are to be appended.</param>
        /// <param name="configurationObject">The configuration object instance.</param>
        /// <param name="configurationSource">The configuration source from where to get additional configuration
        /// information, if necessary.</param>
        /// <param name="elementPolicyKeyName">The key for the element's policies.</param>
        /// <remarks>
        /// Subclasses managing objects that must not create a policy will likely need to include the elements' keys when creating the parts.
        /// </remarks>
        protected override void AddElementAdministrativeTemplateParts(AdmContentBuilder contentBuilder,
            TextFormatterData configurationObject,
            IConfigurationSource configurationSource,
            String elementPolicyKeyName)
        {
            contentBuilder.AddEditTextPart(Resources.TextFormatterTemplatePartName,
                TemplatePropertyName,
                "",
                1024,
                true);
            contentBuilder.AddTextPart(Resources.TextFormatterEscapeInstructions_1);
            contentBuilder.AddTextPart(Resources.TextFormatterEscapeInstructions_2);
        }

        /// <summary>
        /// Gets the template for the name of the policy associated to the object.
        /// </summary>
        /// <remarks>
        /// Elements that override 
        /// <see cref="ConfigurationElementManageabilityProviderBase{T}.AddAdministrativeTemplateDirectives(AdmContentBuilder, T, IConfigurationSource, String)"/>
        /// to avoid creating a policy must still override this property.
        /// </remarks>
        protected override string ElementPolicyNameTemplate
        {
            get
            {
                return Resources.FormatterPolicyNameTemplate;
            }
        }

        /// <summary>
        /// Overrides the <paramref name="configurationObject"/>'s properties with the Group Policy values from the 
        /// registry.
        /// </summary>
        /// <param name="configurationObject">The configuration object for instances that must be managed.</param>
        /// <param name="policyKey">The <see cref="IRegistryKey"/> which holds the Group Policy overrides for the 
        /// configuration element.</param>
        /// <remarks>Subclasses implementing this method must retrieve all the override values from the registry
        /// before making modifications to the <paramref name="configurationObject"/> so any error retrieving
        /// the override values will cancel policy processing.</remarks>
        protected override void OverrideWithGroupPolicies(TextFormatterData configurationObject, IRegistryKey policyKey)
        {
            String templateOverride = UnescapeString(policyKey.GetStringValue(TemplatePropertyName));

            configurationObject.Template = templateOverride;
        }

        ///<summary>
        /// Escape the text.
        ///</summary>
        ///<param name="text">The text to escape.</param>
        ///<returns>The escaped string.</returns>
        public static string EscapeString(string text)
        {
            if(text == null) throw new ArgumentNullException("text");
            string result = text.Replace("\\", @"\\");
            result = result.Replace("\n", @"\n");
            result = result.Replace("\r", @"\r");

            return result;
        }

        ///<summary>
        /// Un escape the string.
        ///</summary>
        ///<param name="text">The text to un escape.</param>
        ///<returns>The un escaped string.</returns>
        public static string UnescapeString(string text)
        {
            if(text == null) throw new ArgumentNullException("text");

            string result = text.Replace(@"\r", "\r");
            result = result.Replace(@"\n", "\n");
            result = result.Replace(@"\\", "\\");

            return result;
        }
    }
}
