XmlLogPublisher.cs :  » Build-Systems » CruiseControl.NET » ThoughtWorks » CruiseControl » Core » Publishers » C# / CSharp Open Source

namespace ThoughtWorks.CruiseControl.Core.Publishers{
    using System.IO;
    using System.Xml;
    using Exortech.NetReflector;
    using ThoughtWorks.CruiseControl.Core.Util;
    using ThoughtWorks.CruiseControl.Remote;
    using ThoughtWorks.CruiseControl.Core.Tasks;

    /// <summary>
    /// <para>
    /// The Xml Log Publisher is used to create the log files used by the CruiseControl.NET Web Dashboard, so if you don't define an 
    /// &lt;xmllogger /&gt; section the Dashboard will not function correctly.
    /// </para>
    /// <para type="warning">
    /// You should place the &lt;xmllogger /&gt; in the &lt;publishers /&gt; section, after any <link>File Merge Task</link>s, in your 
    /// <link>Project Configuration Block</link>.
    /// </para>
    /// </summary>
    /// <title>XML Log Publisher</title>
    /// <version>1.0</version>
    /// <remarks>
    /// <para type="info">
    /// XML Log Publisher used to support the 'mergeFiles' option. This functionality is now removed and you should use <link>File Merge
    /// Task</link> instead.
    /// </para>
    /// </remarks>
    /// <example>
    /// <code title="Minimalist example">
    /// &lt;xmllogger /&gt;
    /// </code>
    /// <code title="Full example">
    /// &lt;xmllogger logDir="c:\myproject\buildlogs" /&gt;
    /// </code>
    /// </example>
    [ReflectorType("xmllogger")]
    public class XmlLogPublisher
        : TaskBase, IMergeTask
    {
    public static readonly string DEFAULT_LOG_SUBDIRECTORY = "buildlogs";

        /// <summary>
        /// The directory to save log files to. If relative, then relative to the Project Artifact Directory.
        /// </summary>
        /// <version>1.0</version>
        /// <default>buildlogs</default>
        [ReflectorProperty("logDir", Required = false)] 
    public string ConfiguredLogDirectory;

    // This is only public because of a nasty hack which I (MR) put in the code. To be made private later...
    public string LogDirectory(string artifactDirectory)
    {
            if (string.IsNullOrEmpty(ConfiguredLogDirectory))
      {
        return Path.Combine(artifactDirectory, DEFAULT_LOG_SUBDIRECTORY);
      }
      else if (Path.IsPathRooted(ConfiguredLogDirectory))
      {
        return ConfiguredLogDirectory;
      }
      else
      {
        return Path.Combine(artifactDirectory, ConfiguredLogDirectory);
      }
    }

        protected override bool Execute(IIntegrationResult result)
        {         
            // only deal with known integration status
            if (result.Status == IntegrationStatus.Unknown)
                return true;

            using (XmlIntegrationResultWriter integrationWriter = new XmlIntegrationResultWriter(CreateWriter(LogDirectory(result.ArtifactDirectory), GetFilename(result))))
            {
        integrationWriter.Formatting = Formatting.Indented;
        integrationWriter.Write(result);
            }

            result.BuildLogDirectory = LogDirectory(result.ArtifactDirectory);

            return true;
        }

        private TextWriter CreateWriter(string dirname, string filename)
        {
            // create directory if necessary
            if (!Directory.Exists(dirname))
                Directory.CreateDirectory(dirname);

            string path = Path.Combine(dirname, filename);

      // create XmlWriter using UTF8 encoding
      return new StreamWriter(path);
        }

        private string GetFilename(IIntegrationResult result)
        {
            return Util.StringUtil.RemoveInvalidCharactersFromFileName(new LogFile(result).Filename);
        }
    }
}