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.Collections.Generic;
  19         using System.Reflection;
  20
  21         using Castle.Core;
  22         using Castle.Core.Logging;
  23         using Castle.MonoRail.Framework.Configuration;
  24         using Castle.MonoRail.Framework.Descriptors;
  25         using Castle.MonoRail.Framework.Services.Utils;
  26
  27         /// <summary>
  28         /// Standard implementation of <see cref="IControllerFactory"/>.
  29         /// It inspects assemblies looking for concrete classes
  30         /// that extend <see cref="IController"/>.
  31         /// </summary>
  32         public class DefaultControllerFactory : AbstractControllerFactory, IInitializable
  33         {
  34                 /// <summary>
  35                 /// The logger instance
  36                 /// </summary>
  37                 private ILogger logger = NullLogger.Instance;
  38
  39                 private List<string> assemblies;
  40
  41                 /// <summary>
  42                 /// Initializes a new instance of the <see cref="DefaultControllerFactory"/> class.
  43                 /// </summary>
  44                 public DefaultControllerFactory()
  45                 {
  46                 }
  47
  48                 /// <summary>
  49                 /// Initializes a new instance of the <see cref="DefaultControllerFactory"/> class.
  50                 /// </summary>
  51                 /// <param name="tree">The tree.</param>
  52                 public DefaultControllerFactory(IControllerTree tree) : base(tree)
  53                 {
  54                 }
  55
  56                 #region IInitializable implementation
  57
  58                 /// <summary>
  59                 /// Invoked by the framework in order to initialize the state
  60                 /// </summary>
  61                 public override void Initialize()
  62                 {
  63                         base.Initialize();
  64
  65                         if (assemblies != null)
  66                         {
  67                                 foreach(String assembly in assemblies)
  68                                 {
  69                                         Inspect(assembly);
  70                                 }
  71                         }
  72
  73                         assemblies = null;
  74                 }
  75
  76                 #endregion
  77
  78                 /// <summary>
  79                 /// Invoked by the framework in order to give a chance to
  80                 /// obtain other services
  81                 /// </summary>
  82                 /// <param name="provider">The service proviver</param>
  83                 public override void Service(IServiceProvider provider)
  84                 {
  85                         base.Service(provider);
  86
  87                         ILoggerFactory loggerFactory = (ILoggerFactory) provider.GetService(typeof(ILoggerFactory));
  88
  89                         if (loggerFactory != null)
  90                         {
  91                                 logger = loggerFactory.Create(typeof(AbstractControllerFactory));
  92                         }
  93
  94                         IMonoRailConfiguration config = (IMonoRailConfiguration) provider.GetService(typeof(IMonoRailConfiguration));
  95
  96                         if (config != null)
  97                         {
  98                                 assemblies = config.ControllersConfig.Assemblies;
  99
 100                                 if (assemblies.Count == 0)
 101                                 {
 102                                         throw new System.Configuration.ConfigurationErrorsException("No assembly was informed on the configuration file. " +
 103                                                 "Unfortunatelly this cannot be inferred (we tried)");
 104                                 }
 105                         }
 106                 }
 107
 108                 /// <summary>
 109                 /// Loads the assembly and inspect its public types.
 110                 /// </summary>
 111                 /// <param name="assemblyFileName"></param>
 112                 public void Inspect(String assemblyFileName)
 113                 {
 114                         if (logger.IsDebugEnabled)
 115                         {
 116                                 logger.DebugFormat("Inspecting assembly '{0}'", assemblyFileName);
 117                         }
 118
 119                         Assembly assembly = Assembly.Load( assemblyFileName );
 120
 121                         Inspect(assembly);
 122                 }
 123
 124                 /// <summary>
 125                 /// Inspect the assembly's public types.
 126                 /// </summary>
 127                 public void Inspect(Assembly assembly)
 128                 {
 129                         Type[] types = assembly.GetExportedTypes();
 130
 131                         foreach(Type type in types)
 132                         {
 133                                 if (!type.IsPublic || type.IsAbstract || type.IsInterface || type.IsValueType)
 134                                 {
 135                                         continue;
 136                                 }
 137
 138                                 if (typeof(IController).IsAssignableFrom(type))
 139                                 {
 140                                         ControllerDescriptor contrDesc = ControllerInspectionUtil.Inspect(type);
 141
 142                                         RegisterController(contrDesc);
 143                                 }
 144                         }
 145                 }
 146
 147                 /// <summary>
 148                 /// Registers the controller.
 149                 /// </summary>
 150                 /// <param name="descriptor">The descriptor.</param>
 151                 private void RegisterController(ControllerDescriptor descriptor)
 152                 {
 153                         if (logger.IsDebugEnabled)
 154                         {
 155                                 logger.DebugFormat("Registering controller descriptor for Area: '{0}' Name: '{1}'",
 156                                                    descriptor.Area, descriptor.Name);
 157                         }
 158
 159                         Tree.AddController(descriptor.Area, descriptor.Name, descriptor.ControllerType);
 160                 }
 161         }
 162 }