private array arrayConcat( array array1, array array2 )

Concats two arrays together.

Parameters:

array array1

array array2

Code:

	<cffunction name="arrayConcat" access="private" returntype="array" output="false"
		hint="Concats two arrays together.">
		<cfargument name="array1" type="array" required="true" />
		<cfargument name="array2" type="array" required="true" />
		
		<cfset var result = arguments.array1 />
		<cfset var i = 0 />
		
		<cfloop from="1" to="#ArrayLen(arguments.array2)#" index="i">
			<cfset ArrayAppend(result, arguments.array2[i]) />
		</cfloop>
		
		<cfreturn result />
	</cffunction> 

public void configure( )

Configures the logger.

Parameters:

Code:

	<cffunction name="configure" access="public" returntype="void" output="false"
		hint="Configures the logger.">
		
		<cfset var filter = CreateObject("component", "MachII.logging.filters.GenericChannelFilter").init(getParameter("filter", "")) />
		<cfset var adapter = CreateObject("component", "MachII.logging.adapters.ScopeAdapter").init(getParameters()) />
		
		
		<cfset adapter.setFilter(filter) />
		
		
		<cfset adapter.configure() />
		<cfset setLogAdapter(adapter) />
		
		
		<cfif isParameterDefined("displayOutputTemplateFile")>
			<cfset setDisplayOutputTemplateFile(getParameter("displayOutputTemplateFile")) />
		</cfif>
		
		<cfif isParameterDefined("debugModeOnly")>
			<cfif NOT IsBoolean(getParameter("debugModeOnly"))>
				<cfthrow type="MachII.logging.loggers.MachIILog.Logger"
					message="The value of 'debugModeOnly' must be boolean."
					detail="Current value '#getParameter('debugModeOnly')#'" />
			<cfelse>
				<cfset setDebugModeOnly(getParameter("debugModeOnly")) />
			</cfif>
		</cfif>
		
		<cfif isParameterDefined("suppressDebugArg")>
			<cfset setSuppressDebugArg(getParameter("suppressDebugArg")) />
		</cfif>
	</cffunction> 

public struct getConfigurationData( )

Gets the configuration data for this logger including adapter and filter.

Parameters:

Code:

	<cffunction name="getConfigurationData" access="public" returntype="struct" output="false"
		hint="Gets the configuration data for this logger including adapter and filter.">
		
		<cfset var data = StructNew() />
		
		<cfset data["Debug Mode Only"] = getDebugModeOnly() />
		<cfset data["Supress Debug Arg"] = getSuppressDebugArg() />
		<cfset data["Display Output Template"] = getDisplayOutputTemplateFile() />
		<cfset data["Logging Enabled"] = YesNoFormat(isLoggingEnabled()) />
		
		<cfreturn data />
	</cffunction> 

public boolean getDebugModeOnly( )

Gets if the output is shown only if CF's debug mode is enabled.

Parameters:

Code:

	<cffunction name="getDebugModeOnly" access="public" returntype="boolean" output="false"
		hint="Gets if the output is shown only if CF's debug mode is enabled.">
		<cfreturn variables.instance.debugModeOnly />
	</cffunction> 

public string getDisplayOutputTemplateFile( )

Gets the output template location which is used for display output.

Parameters:

Code:

	<cffunction name="getDisplayOutputTemplateFile" access="public" returntype="string" output="false"
		hint="Gets the output template location which is used for display output.">
		<cfreturn variables.instance.displayOutputTemplateFile />
	</cffunction> 

private string getMachIIVersion( string version )

Gets a nice version number istead of just numbers.

Parameters:

string version

Code:

	<cffunction name="getMachIIVersion" access="private" returntype="string" output="false"
		hint="Gets a nice version number istead of just numbers.">
		<cfargument name="version" type="string" required="true" />

		<cfset var release = "" />
		
		<cfswitch expression="#ListLast(arguments.version, ".")#">
			<cfcase value="0">
				<cfset release = "BER - Unknown build" />
			</cfcase>
			<cfcase value="1">
				<cfset release = "Alpha" />
			</cfcase>
			<cfcase value="2">
				<cfset release = "Beta" />
			</cfcase>
			<cfcase value="3">
				<cfset release = "RC1" />
			</cfcase>
			<cfcase value="4">
				<cfset release = "RC2" />
			</cfcase>
			<cfcase value="5">
				<cfset release = "RC3" />
			</cfcase>
			<cfcase value="6">
				<cfset release = "RC4" />
			</cfcase>
			<cfcase value="7">
				<cfset release = "RC5" />
			</cfcase>
			<cfcase value="8">
				<cfset release = "Production Stable" />
			</cfcase>
			<cfcase value="9">
				<cfset release = "Production-Only Stable (duck-typed)" />
			</cfcase>
			<cfdefaultcase>
				<cfset release = "BER - Build " & ListLast(arguments.version, ".") />
			</cfdefaultcase>
		</cfswitch>
		
		<cfreturn Left(arguments.version, Len(arguments.version) - Len(ListLast(arguments.version, ".")) - 1) & " " & release />
	</cffunction> 

public string getSuppressDebugArg( )

Gets the event-arg the suppresses debug output if it is present.

Parameters:

Code:

	<cffunction name="getSuppressDebugArg" access="public" returntype="string" output="false"
		hint="Gets the event-arg the suppresses debug output if it is present.">
		<cfreturn variables.instance.suppressDebugArg />
	</cffunction> 

public void onRequestEnd( )

Displays output for this logger.

Parameters:

Code:

	<cffunction name="onRequestEnd" access="public" returntype="void"
		hint="Displays output for this logger.">
		
		
		
		<cfset var data = ArrayNew(1) />
		<cfset var local = StructNew() />
		<cfset var out = getPageContext().getOut() />
		<cfset var buffer = "" />
		<cfset var count = 0 />
		<cfset var output = "" />
		
		
		<cfif getLogAdapter().getLoggingEnabled()
			AND getLogAdapter().isLoggingDataDefined()
			AND ((getDebugModeOnly() AND IsDebugMode()) OR NOT getDebugModeOnly())
			AND NOT arguments.event.isArgDefined(getSuppressDebugArg())>

			<cfset data = getLogAdapter().getLoggingData().data />
			
			<cfsavecontent variable="output">
				<cfinclude template="#getDisplayOutputTemplateFile()#" />
			</cfsavecontent>
			
			
			<cftry>
				<cfset buffer = out.getBuffer().toString() />
				<cfcatch type="any">
					
				</cfcatch>
			</cftry>

			
			<cfif StructKeyExists(local, "headElement")>
				<cfhtmlhead text="#local.headElement#" />
			</cfif>
				
			
			<cfset count = FindNoCase("</body>", buffer) />
			<cfif count>
				<cfset output = Insert(output, buffer, count - 1) />
				<cfset out.clearBuffer() />
			</cfif>
			
			<cfoutput>#output#</cfoutput>
		</cfif>
	</cffunction> 

public void postRedirect( struct data )

Post-redirect logic for this logger.

Parameters:

struct data

Code:

	<cffunction name="postRedirect" access="public" returntype="void" output="false"
		hint="Post-redirect logic for this logger.">
		<cfargument name="data" type="struct" required="true"
			hint="Redirect persist data struct." />

		<cfset var loggingData = StructNew() />
		
		<cfif getLogAdapter().getLoggingEnabled() AND getLogAdapter().isLoggingDataDefined()>
			<cftry>
				<cfset loggingData = getLogAdapter().getLoggingData() />
				<cfset loggingData.data = arrayConcat(arguments.data[getLoggerId()].data, loggingData.data) />
				<cfcatch type="any">
					
				</cfcatch>
			</cftry>
		</cfif>
	</cffunction> 

public void preRedirect( struct data )

Pre-redirect logic for this logger.

Parameters:

struct data

Code:

	<cffunction name="preRedirect" access="public" returntype="void" output="false"
		hint="Pre-redirect logic for this logger.">
		<cfargument name="data" type="struct" required="true"
			hint="Redirect persist data struct." />
		
		<cfif getLogAdapter().getLoggingEnabled() AND getLogAdapter().isLoggingDataDefined()>
			<cfset arguments.data[getLoggerId()] = getLogAdapter().getLoggingData() />
		</cfif>
	</cffunction> 

private struct processCfdump( any dataToDump )

Processes a cfdump and returns a struct with data and head elements. Also, cleans up invalid HTML syntax so debugging output will not mess up HTML validators.

Parameters:

any dataToDump

Code:

	<cffunction name="processCfdump" access="private" returntype="struct" output="false"
		hint="Processes a cfdump and returns a struct with data and head elements. 
		Also, cleans up invalid HTML syntax so debugging output will not mess up HTML validators.">
		<cfargument name="dataToDump" type="any" required="true" />
		
		<cfset var data = CreateObject("java", "java.lang.StringBuffer") />
		<cfset var results = StructNew() />
		<cfset var reFindResults = "" />
		<cfset var temp = "" />
		
		
		<cfsavecontent variable="temp"><cfdump var="#arguments.dataToDump#" expand="false" /></cfsavecontent>
		<cfset data.init(temp) />
		
		
		<cfset results.data = "" />
		<cfset results.headElement = "" />
		
		
		<cfset reFindResults = REFindNoCase("(<style.*</style>)", data.toString(), 1, true) />
		
		<cfif reFindResults.pos[1] NEQ 0>
			
			<cfset temp = data.substring(reFindResults.pos[1] - 1, reFindResults.len[1] + reFindResults.pos[1] - 1) />

			
			<cfset temp = REReplace(temp, "<style.*?>", '<style type="text/css">', "one") />
			
			<cfset data.delete(reFindResults.pos[1] - 1, reFindResults.len[1] + reFindResults.pos[1] - 1) />
			<cfset results.headElement = results.headElement & temp />
		</cfif>
		
		
		<cfset reFindResults = REFindNoCase("(<script.*</script>)", data.toString(), 1, true) />
		
		<cfif reFindResults.pos[1] NEQ 0>
			<cfset temp = data.substring(reFindResults.pos[1] - 1, reFindResults.len[1] + reFindResults.pos[1] - 1) />
			
			
			<cfset temp = REReplace(temp, "<script.*?>", '<script type="text/javascript">', "one") />
			
			<cfset data.delete(reFindResults.pos[1] - 1, reFindResults.len[1] + reFindResults.pos[1] - 1) />
			<cfset results.headElement = results.headElement & temp />
		</cfif>
		
		
		<cfset results.data = data.toString() />

		<cfreturn results />
	</cffunction> 

private void setDebugModeOnly( boolean debugModeOnly )

Sets if the output is shown only if CF's debug mode is enabled.

Parameters:

boolean debugModeOnly

Code:

	<cffunction name="setDebugModeOnly" access="private" returntype="void" output="false"
		hint="Sets if the output is shown only if CF's debug mode is enabled.">
		<cfargument name="debugModeOnly" type="boolean" required="true" />
		<cfset variables.instance.debugModeOnly = arguments.debugModeOnly />
	</cffunction> 

private void setDisplayOutputTemplateFile( string displayOutputTemplateFile )

Sets the output template location which is used for display output.

Parameters:

string displayOutputTemplateFile

Code:

	<cffunction name="setDisplayOutputTemplateFile" access="private" returntype="void" output="false"
		hint="Sets the output template location which is used for display output.">
		<cfargument name="displayOutputTemplateFile" type="string" required="true" />
		<cfset variables.instance.displayOutputTemplateFile = arguments.displayOutputTemplateFile />
	</cffunction> 

private void setSuppressDebugArg( string suppressDebugArg )

Sets the event-arg the suppresses debug output if it is present.

Parameters:

string suppressDebugArg

Code:

	<cffunction name="setSuppressDebugArg" access="private" returntype="void" output="false"
		hint="Sets the event-arg the suppresses debug output if it is present.">
		<cfargument name="suppressDebugArg" type="string" required="true" />
		<cfset variables.instance.suppressDebugArg = arguments.suppressDebugArg />
	</cffunction>