XmlResourceConfigurator.cs :  » Web-Frameworks » Ingenious-MVC » Ingenious » Mvc » Configuration » Configurators » C# / CSharp Open Source

#region License

/**
 * Ingenious MVC : An MVC framework for .NET 2.0
 * Copyright (C) 2006, JDP Group
 * 
 * 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; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 * 
 * Authors: - Kent Boogaart (kentcb@internode.on.net)
 *          - James Inge
 */

#endregion

using System;
using System.IO;
using System.Reflection;
using System.Xml;
using Ingenious.Mvc.Util;

namespace Ingenious.Mvc.Configuration.Configurators{
  /// <include file='XmlResourceConfigurator.doc.xml' path='/doc/member[@name="T:XmlResourceConfigurator"]/*'/>
  public static class XmlResourceConfigurator
  {
    private const string RootNode = "ingeniousMvc";
    private static readonly Log _log = Log.CreateForNamespace(typeof(XmlParser));

    /// <include file='XmlResourceConfigurator.doc.xml' path='/doc/member[@name="M:Configure(System.Reflection.Assembly,System.String)"]/*'/>
    public static void Configure(Assembly assembly, string resourceName)
    {
      Configure(TaskManager.Instance, assembly, resourceName);
    }

    /// <include file='XmlResourceConfigurator.doc.xml' path='/doc/member[@name="M:Configure(System.Reflection.Assembly,System.Type,System.String)"]/*'/>
    public static void Configure(Assembly assembly, Type type, string resourceName)
    {
      Configure(TaskManager.Instance, assembly, type, resourceName);
    }

    /// <include file='XmlResourceConfigurator.doc.xml' path='/doc/member[@name="M:Configure(Ingenious.Mvc.TaskManager,System.Reflection.Assembly,System.String)"]/*'/>
    public static void Configure(TaskManager taskManager, Assembly assembly, string resourceName)
    {
      ParseResource(taskManager, assembly, null, resourceName);
    }

    /// <include file='XmlResourceConfigurator.doc.xml' path='/doc/member[@name="M:Configure(Ingenious.Mvc.TaskManager,System.Reflection.Assembly,System.Type,System.String)"]/*'/>
    public static void Configure(TaskManager taskManager, Assembly assembly, Type type, string resourceName)
    {
      ArgumentHelper.AssertNotNull(type, "type");
      ParseResource(taskManager, assembly, type, resourceName);
    }

    private static void ParseResource(TaskManager taskManager, Assembly assembly, Type type, string resourceName)
    {
      ArgumentHelper.AssertNotNull(taskManager, "taskManager");
      ArgumentHelper.AssertNotNull(assembly, "assembly");
      ArgumentHelper.AssertNotNull(resourceName, "resourceName");
      _log.Verbose("Attempting to load resource '{0}' from assembly '{1}' for type '{2}'.", resourceName, assembly.FullName, (type == null) ? string.Empty : type.FullName);
      Stream xmlStream = null;

      try
      {
        if (type == null)
        {
          xmlStream = assembly.GetManifestResourceStream(resourceName);

          if (xmlStream == null)
          {
            _log.Error("Resource '{0}' not found in assembly '{1}'.", resourceName, assembly.FullName);
            ExceptionHelper.Throw("ParseResource.resourceNotFound", resourceName, assembly.FullName);
          }
        }
        else
        {
          xmlStream = assembly.GetManifestResourceStream(type, resourceName);

          if (xmlStream == null)
          {
            _log.Error("Resource '{0}' not found in assembly '{1}' for type '{2}'.", resourceName, assembly.FullName, type.FullName);
            ExceptionHelper.Throw("ParseResource.resourceNotFoundWithType", resourceName, assembly.FullName, type.FullName);
          }
        }

        XmlDocument document = new XmlDocument();
        document.PreserveWhitespace = true;
        document.Load(xmlStream);
        XmlNode ingeniousMvcNode = document.SelectSingleNode(RootNode);

        if (ingeniousMvcNode == null)
        {
          _log.Error("A root node called '{0}' was found in the XML document.", RootNode);
          ExceptionHelper.Throw("ParseResource.rootNodeNotFound", resourceName, RootNode);
        }

        //just use the XmlConfigurator to configure now that we have a stream
        XmlConfigurator.Configure(taskManager, ingeniousMvcNode);
      }
      finally
      {
        if (xmlStream != null)
        {
          xmlStream.Close();
        }
      }
    }
  }
}