Changeset 2364

Timestamp:

07/04/09 19:40:26 (4 years ago)

Author:

lmajano

Message:

made logbox case-insensitive for all appenders and categories

Location:

coldbox/trunk

Files:

• system/interceptors/Autowire.cfc (modified) (1 diff)
• system/logging/AbstractAppender.cfc (modified) (1 diff)
• system/logging/LogBox.cfc (modified) (11 diffs)
• system/logging/config/LogBoxConfig.cfc (modified) (2 diffs)
• testing/cases/logging/LogBoxVariousTest.cfc (modified) (2 diffs)

coldbox/trunk/system/interceptors/Autowire.cfc

@@ -133 +133 @@
                         /* Exclude the core plugins from autowires */
                         if( not findnocase("coldbox.system.plugins",targetPath) ){
-                                /* Process Autowire */
-                                instance.beanFactory.autowire(target=targetObject,
-                                                                                          useSetterInjection=getProperty('enableSetterInjection'),
-                                                                                          annotationCheck=true,
-                                                                                          onDICompleteUDF=getProperty('completeDIMethodName'),
-                                                                                          debugMode=getProperty('debugMode'));
+                                try{
+                                        /* Process Autowire */
+                                        instance.beanFactory.autowire(target=targetObject,
+                                                                                                  useSetterInjection=getProperty('enableSetterInjection'),
+                                                                                                  annotationCheck=true,
+                                                                                                  onDICompleteUDF=getProperty('completeDIMethodName'),
+                                                                                                  debugMode=getProperty('debugMode'));
+                                }
+                                catch(Any e){
+                                        getPlugin("logger").error("Error autowiring handler #getmetadata(targetObject).name#. #e.message# #e.detail#");
+                                        throw(message="Error autowiring handler #getmetadata(targetObject).name#",detail="#e.stacktrace#",type="Autowire.AutowireException");
+                                }
                         }       
                 </cfscript>

coldbox/trunk/system/logging/AbstractAppender.cfc

@@ -79 +79 @@
         <!--- Get the name --->
         <cffunction name="getName" access="public" returntype="string" output="false" hint="Get this appender's name">
-                <cfreturn instance.name>
+                <cfreturn ucase(instance.name)>
         </cffunction>
         

coldbox/trunk/system/logging/LogBox.cfc

@@ -51 +51 @@
                         
                         // Configure LogBox
-                        configure();
+                        configure(instance.config);
                         
                         // Return LogBox
                         return this;
                 </cfscript>
+        </cffunction>
+        
+        <!--- configure --->
+        <cffunction name="configure" output="false" access="public." returntype="void" hint="Configure logbox for operation. You can also re-configure LogBox programmatically. Basically we register all appenders here and all categories">
+                <cfargument name="logBoxConfig" type="coldbox.system.logging.config.LogBoxConfig" required="true" hint="The LogBoxConfig object to use to configure this instance of LogBox"/>
+                <cfscript>
+                        var config = arguments.logBoxConfig;
+                        var appenders = config.getAppenders();
+                        var key = "";
+                        var categories = config.getCategories();
+                </cfscript>
+                
+                <cflock name="#instance._hash#.logbox.config" type="exclusive" timeout="30" throwontimeout="true">
+                <cfscript>
+                        // Register All Appenders configured
+                        for( key in appenders ){
+                                registerNew(argumentCollection=appenders[key]);
+                        }
+                        // Clean just in case
+                        key = "";
+                        // Register All Category Appenders defined in the configuration object.
+                        for( key in categories ){
+                                instance.categoryAppenders[key] = getAppendersMap(categories[key].appenders);
+                        }
+                </cfscript>
+                </cflock>
         </cffunction>
         
@@ -74 +100 @@
                 <cfset structClear(getAppenders())>
         </cffunction>
+        
+        <!--- removeAppender --->
+        <cffunction name="removeAppender" output="false" access="public" returntype="boolean" hint="Remove an appender if it exists. Else returns false.">
+                <cfargument name="name" type="string" required="true" hint="The appender's name"/>
+                <cfscript>
+                        if( appenderExists(arguments.name) ){
+                                getAppenders().remove(ucase(arguments.name));
+                                return true;
+                        }
+                        return false;
+                </cfscript>
+        </cffunction>
                 
         <!--- hasAppenders --->
@@ -95 +133 @@
                 <cfscript>
                         if( appenderExists(arguments.name) ){
-                                return structFind(getAppenders(),arguments.name);
+                                return structFind(getAppenders(),ucase(arguments.name));
                         }
                         else{
-                                getutil().throwit(message="Appender #arguments.name# does not exist.",type="LogBox.AppenderNotFound");
+                                getutil().throwit(message="Appender #arguments.name# does not exist.",detail="The appenders registered are #structKeyList(getAppenders())#",type="LogBox.AppenderNotFound");
                         }
                 </cfscript>
@@ -106 +144 @@
         <cffunction name="appenderExists" output="false" access="public" returntype="boolean" hint="Checks to see if a specified appender exists by name.">
                 <cfargument name="name" type="string" required="true" hint="The name of the appender to check if it is registered"/>
-                <cfreturn structKeyExists(getAppenders(), arguments.name)>
+                <cfreturn structKeyExists(getAppenders(), ucase(arguments.name))>
         </cffunction>
         
@@ -115 +153 @@
                 <!--- ************************************************************* --->
                 <cfset var name = "">
-                <!--- Verify Name --->
+                
+                <!--- Verify the appender's Name --->
                 <cfif NOT len(arguments.appender.getName())>
                         <cfthrow message="Appender does not have a name, please instantiate the appender with a unique name."
@@ -122 +161 @@
                         <cfset name = arguments.appender.getName()>
                 </cfif>
+                
                 <!--- Verify Registration --->
                 <cfif NOT appenderExists(name)>
-                        <cflock name="#instance._hash#.#name#" type="exclusive" throwontimeout="true" timeout="30">
+                        <cflock name="#instance._hash#.registerappender.#name#" type="exclusive" throwontimeout="true" timeout="30">
                                 <cfscript>
                                         if( NOT appenderExists(name) ){
@@ -151 +191 @@
                 <!--- ************************************************************* --->
                 <cfscript>
-                        // Create Logger?
-                        var target = createObject("component",arguments.class).init(argumentCollection=arguments);
+                        // Create new appender object
+                        var appender = createObject("component",arguments.class).init(argumentCollection=arguments);
                         
                         // Register it
-                        register(target);
-                        
-                        return target;
+                        register(appender);
+                        
+                        return appender;
                 </cfscript>             
         </cffunction>
@@ -169 +209 @@
                 <cfif appenderExists(arguments.name)>
                         <cfscript>
-                                // Get logger
-                                appender = structFind(allAppenders, arguments.name);                    
+                                // Get Appender
+                                appender = getAppender(arguments.name);                 
                                 // Run un-registration event
                                 appender.onUnRegistration();
                                 // Unregister it
-                                allAppenders.remove(arguments.name);    
+                                removeAppender(arguments.name); 
                                                         
                                 return true;
@@ -191 +231 @@
                         var args = structnew();
                         var config = getConfig();
-                        var appenders = getCategoryAppenders();
+                        var categoryAppenders = getCategoryAppenders();
                         var categoryConfig = "";        
                                         
@@ -202 +242 @@
                                 args.levelMin = categoryConfig.levelMin;
                                 args.levelMax = categoryConfig.levelMax;
-                                // Get Appenders from storage map
-                                args.appenders = appenders[arguments.category];
+                                // Get Appenders from category storage map
+                                args.appenders = categoryAppenders[arguments.category];
                         }
                         
@@ -285 +325 @@
 <!------------------------------------------- PRIVATE ------------------------------------------>
         
-        <!--- configure --->
-        <cffunction name="configure" output="false" access="private" returntype="void" hint="Configure logbox for operation">
-                <cfscript>
-                        var config = getConfig();
-                        var appenders = config.getAppenders();
-                        var key = "";
-                        var categories = config.getCategories();
-                        
-                        // Register All Appenders configured
-                        for( key in appenders ){
-                                registerNew(argumentCollection=appenders[key]);
-                        }
-                        // Clean just in case
-                        key = "";
-                        // Register All Category Appenders defined in the configuration object.
-                        for( key in categories ){
-                                instance.categoryAppenders[key] = getAppendersMap(categories[key].appenders);
-                        }
-                </cfscript>
-        </cffunction>
-        
         <!--- getAppendersMap --->
-        <cffunction name="getAppendersMap" output="false" access="private" returntype="struct" hint="Get a map of appenders by list">
+        <cffunction name="getAppendersMap" output="false" access="private" returntype="struct" hint="Get a map of appenders by list. Usually called to get a category of appenders.">
                 <cfargument name="appenders" type="string" required="true" hint="The list of appenders to get"/>
                 <cfscript>
                         var x =1;
-                        var appenders = getAppenders();
                         var Collections = createObject("java", "java.util.Collections");
-                        var map = Collections.synchronizedMap(CreateObject("java","java.util.LinkedHashMap").init(listlen(arguments.appenders)));
-                        
+                        var appendersMap = Collections.synchronizedMap(CreateObject("java","java.util.LinkedHashMap").init(listlen(arguments.appenders)));
+                        
+                        // Go over appender's list and configure it
                         for(x=1; x lte listlen(arguments.appenders); x=x+1){
-                                thisAppender = listGetAt(arguments.appenders,x);
-                                map[thisAppender] = appenders[thisAppender];    
-                        }
-                        
-                        return map;
+                                thisAppender = ucase(listGetAt(arguments.appenders,x));
+                                appendersMap[thisAppender] = getAppender(thisAppender); 
+                        }
+                        
+                        return appendersMap;
                 </cfscript>
         </cffunction>

coldbox/trunk/system/logging/config/LogBoxConfig.cfc

@@ -35 +35 @@
                 <cfargument name="levelMax"     type="numeric" required="false" default="5" hint="The default log level for this appender, by default it is 5. Optional. ex: LogBox.logLevels.WARNING"/>
                 <cfargument name="properties"   type="struct"  required="false" default="#structnew()#" hint="The structure of properties to configure this appender with."/>
-                <cfset instance.appenders[arguments.name] = arguments>
+                <cfset instance.appenders[ucase(arguments.name)] = arguments>
         </cffunction>
         
@@ -47 +47 @@
                         var x = 1;
                         
+                        //Verify appender list
+                        if( NOT listLen(arguments.appenders) ){
+                                $throw("Invalid Appenders","Please send in at least one appender for a category","LogBoxConfig.InvalidAppenders");
+                        }
+                        
                         // Verify Appenders first
                         for(x=1; x lte listlen(arguments.appenders); x=x+1){
-                                if( NOT structKeyExists(instance.appenders, listGetAt(arguments.appenders,x)) ){
+                                if( NOT structKeyExists(instance.appenders, ucase(listGetAt(arguments.appenders,x))) ){
                                         $throw(message="Invalid appender",
                                                    detail="The appender #listGetAt(arguments.appenders,x)# has not been defined yet. Please define it first.",

coldbox/trunk/testing/cases/logging/LogBoxVariousTest.cfc

@@ -2 +2 @@
 <cfscript>
         function setup(){
+                // Create logbox config
                 config = createObject("component","coldbox.system.logging.config.LogBoxConfig").init();
+                // Configure two appenders
                 config.addAppender(name="CFConsole",class="coldbox.system.logging.appenders.ConsoleAppender");
-                config.addAppender(name="DBConsole",class="coldbox.system.logging.appenders.DBAppender",
-                                                   levelMin="0",levelMax="1",
-                                                   properties={dsn="test",table="logs",autocreate="true",defaultCategory=""});
+                config.addAppender(name="MyCF",class="coldbox.system.logging.appenders.CFAppender");
                 
+                //Create some nice categories
+                config.addCategory(name="coldbox.testing.VariousTests",levelMin=3,appenders="CFConsole");
+                config.addCategory(name="MyCat",levelMin=3,appenders="cfconsole");
+                
+                //create logbox
                 logbox = getMockBox().createMock(className="coldbox.system.logging.LogBox").init(config);
                 
@@ -13 +18 @@
         
         function test1(){
-                logBox.info(message="Hola Henrik");
+                //Log to all appenders
+                logBox.info(message="Hola from various testing.");
+                
+                logger = logBox.getLogger("Mycat");
+                logger.trace("just an error message");
+                
+                
         }
 </cfscript>