MonoRail/Castle.MonoRail.Framework/Services/DefaultControllerFactory.cs

   1 // Copyright 2004-2007 Castle Project - http://www.castleproject.org/
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 namespace Castle.MonoRail.Framework.Services
  16 {
  17         using System;
  18         using System.Reflection;
  19
  20         using Castle.Core;
  21         using Castle.Core.Logging;
  22         using Castle.MonoRail.Framework.Configuration;
  23         using Castle.MonoRail.Framework.Internal;
  24         using Castle.MonoRail.Framework.Services.Utils;
  25
  26         /// <summary>
  27         /// Standard implementation of <see cref="IControllerFactory"/>.
  28         /// It inspects assemblies looking for concrete classes
  29         /// that extend <see cref="Controller"/>.
  30         /// </summary>
  31         public class DefaultControllerFactory : AbstractControllerFactory, IInitializable
  32         {
  33                 /// <summary>
  34                 /// The logger instance
  35                 /// </summary>
  36                 private ILogger logger = NullLogger.Instance;
  37
  38                 private string[] assemblies;
  39
  40                 /// <summary>
  41                 /// Initializes a new instance of the <see cref="DefaultControllerFactory"/> class.
  42                 /// </summary>
  43                 public DefaultControllerFactory()
  44                 {
  45                 }
  46
  47                 #region IInitializable implementation
  48
  49                 /// <summary>
  50                 /// Invoked by the framework in order to initialize the state
  51                 /// </summary>
  52                 public override void Initialize()
  53                 {
  54                         base.Initialize();
  55
  56                         if (assemblies != null)
  57                         {
  58                                 foreach(String assembly in assemblies)
  59                                 {
  60                                         Inspect(assembly);
  61                                 }
  62                         }
  63
  64                         assemblies = null;
  65                 }
  66
  67                 #endregion
  68
  69                 /// <summary>
  70                 /// Invoked by the framework in order to give a chance to
  71                 /// obtain other services
  72                 /// </summary>
  73                 /// <param name="provider">The service proviver</param>
  74                 public override void Service(IServiceProvider provider)
  75                 {
  76                         base.Service(provider);
  77
  78                         ILoggerFactory loggerFactory = (ILoggerFactory) provider.GetService(typeof(ILoggerFactory));
  79
  80                         if (loggerFactory != null)
  81                         {
  82                                 logger = loggerFactory.Create(typeof(AbstractControllerFactory));
  83                         }
  84
  85                         MonoRailConfiguration config = (MonoRailConfiguration) provider.GetService(typeof(MonoRailConfiguration));
  86
  87                         if (config != null)
  88                         {
  89                                 assemblies = config.ControllersConfig.Assemblies;
  90
  91                                 if (assemblies == null || assemblies.Length == 0)
  92                                 {
  93                                         throw new System.Configuration.ConfigurationErrorsException("No assembly was informed on the configuration file. " +
  94                                                 "Unfortunatelly this cannot be inferred (we tried)");
  95                                 }
  96                         }
  97                 }
  98
  99                 /// <summary>
 100                 /// Loads the assembly and inspect its public types.
 101                 /// </summary>
 102                 /// <param name="assemblyFileName"></param>
 103                 public void Inspect(String assemblyFileName)
 104                 {
 105                         if (logger.IsDebugEnabled)
 106                         {
 107                                 logger.DebugFormat("Inspecting assembly '{0}'", assemblyFileName);
 108                         }
 109
 110                         Assembly assembly = Assembly.Load( assemblyFileName );
 111
 112                         Inspect(assembly);
 113                 }
 114
 115                 /// <summary>
 116                 /// Inspect the assembly's public types.
 117                 /// </summary>
 118                 public void Inspect(Assembly assembly)
 119                 {
 120                         Type[] types = assembly.GetExportedTypes();
 121
 122                         foreach(Type type in types)
 123                         {
 124                                 if (!type.IsPublic || type.IsAbstract || type.IsInterface || type.IsValueType)
 125                                 {
 126                                         continue;
 127                                 }
 128
 129                                 if (typeof(Controller).IsAssignableFrom(type))
 130                                 {
 131                                         ControllerDescriptor contrDesc = ControllerInspectionUtil.Inspect(type);
 132
 133                                         RegisterController(contrDesc);
 134                                 }
 135                         }
 136                 }
 137
 138                 /// <summary>
 139                 /// Registers the controller.
 140                 /// </summary>
 141                 /// <param name="descriptor">The descriptor.</param>
 142                 private void RegisterController(ControllerDescriptor descriptor)
 143                 {
 144                         if (logger.IsDebugEnabled)
 145                         {
 146                                 logger.DebugFormat("Registering controller descriptor for Area: '{0}' Name: '{1}'",
 147                                                    descriptor.Area, descriptor.Name);
 148                         }
 149
 150                         Tree.AddController(descriptor.Area, descriptor.Name, descriptor.ControllerType);
 151                 }
 152         }
 153 }