Application.cfc

<!---
*
* This file is part of Nikiru - the web framework that gets out of your way.
*
* Nikiru is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* Nikiru 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 Affero Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Nikiru. If not, see <http://www.gnu.org/licenses/>.
*
* You may restribute this Program with a special exception to the terms
* and conditions of version 3.0 of the GPL. 
* You should have received a copy of the FLOSS exception
* along with Nikiru. If not, see <http://www.Nikiru.com/licenses/>.
*
--->
<cfcomponent output="false">
	
	<!--- Application name, should be unique --->
	<cfset this.name = "framework">
	<!--- How long application vars persist --->
	<cfset this.applicationTimeout = createTimeSpan(0,2,0,0)>
	<!--- Should client vars be enabled? --->
	<cfset this.clientManagement = false>
	<!--- Where should we store them, if enable? --->
	<cfset this.clientStorage = "cookie">
	<!--- Where should cflogin stuff persist --->
	<cfset this.loginStorage = "session">
	<!--- Should we even use sessions? --->
	<cfset this.sessionManagement = true>
	<!--- How long do session vars persist? --->
	<cfset this.sessionTimeout = createTimeSpan(0,0,20,0)>
	<!--- Should we set cookies on the browser? --->
	<cfset this.setClientCookies = true>
	<!--- should cookies be domain specific, ie, *.foo.com or www.foo.com --->
	<cfset this.setDomainCookies = false>
	<!--- should we try to block 'bad' input from users --->
	<cfset this.scriptProtect = "none">
	<!--- should we secure our JSON calls? --->
	<cfset this.secureJSON = false>
	<!--- Should we use a prefix in front of JSON strings? --->
	<cfset this.secureJSONPrefix = "">
	<!--- Used to help CF work with missing files and dir indexes --->
	<cfset this.welcomeFileList = "">
	<!--- The current directory --->
	<cfset this.currentDir = expandpath(".")>
	
	<!--- define custom coldfusion mappings. Keys are mapping names, values are full paths  --->
	<cfset this.mappings = structNew()>
	<!--- define a list of custom tag paths. --->
	<cfset this.customtagpaths = "">
	
	<!--- NIKIRU CONFIGURATION	 --->
	
	
	<!---  --->
	<!--- Define your database parameters here --->
	<!--- If you are changing any of these setting during runtime you need to restart the server --->
	<!---  --->
	
	<!--- Database you are using --->
	<cfset this.db.type = "mysql">
	<!--- DSN you are using (the name you set up in the CFML administration for your database connection) --->
	<cfset this.db.dsn = "nikiru">
	<!--- Schema --->
	<cfset this.db.schema = "nikiru">
	<!--- If set to true the model and database setup will be loaded on each request. This should be set to false in production --->
	<cfset this.db.reload = false>
	
	
	<!---  --->
	<!--- That's it. Nothing else to do here. --->
	<!--- Don't forget to restart your application if you are changing these values during runtime! --->
	<!---  --->
	
	<!--- Are we in debug mode? --->
	<cfset this.debug = false>
	
	<!--- NIKIRU CONFIGURATION DONE!!! --->
	
	
	
	
	<!--- Run when application starts up --->
	<cffunction name="onApplicationStart" returnType="boolean" output="false">
		<!--- We check the connection to the DB here --->
		<cfinvoke component="nikiru.cfc.dal" method="connect" thestruct="#this.db#" />
		<!--- Load model --->
		<cfinvoke component="nikiru.cfc.setup" method="load_models" currentDir="#this.currentDir#" />
		<!--- Load modules --->
		<cfinvoke component="nikiru.cfc.setup" method="load_modules" currentDir="#this.currentDir#" />
		<!--- Init the translations --->
		<cfset application.nikiru.resourcemanager = createObject('component', 'nikiru.cfc.ResourceManager').init('translations')>
		<cfreturn true>
	</cffunction>

	<!--- Run when application stops --->
	<cffunction name="onApplicationEnd" returnType="void" output="false">
		<cfargument name="applicationScope" required="true">
	</cffunction>

	<!--- Fired when user requests a CFM that doesn't exist. --->
	<cffunction name="onMissingTemplate" returnType="boolean" output="false">
		<cfreturn true>
	</cffunction>
	
	<!--- Run before the request is processed --->
	<cffunction name="onRequestStart" returnType="boolean" output="true">
		<!--- If in debug mode we load the model every time --->
		<cfif this.db.reload>
			<!--- We check the connection to the DB here --->
			<cfinvoke component="nikiru.cfc.dal" method="connect" thestruct="#this.db#" />
			<!--- Load model --->
			<cfinvoke component="nikiru.cfc.setup" method="load_models" currentDir="#this.currentDir#" />
			<!--- Load modules --->
			<cfinvoke component="nikiru.cfc.setup" method="load_modules" currentDir="#this.currentDir#" />
			<!--- Init the translations --->
			<cfset application.nikiru.resourcemanager = createObject('component', 'nikiru.cfc.ResourceManager').init('translations')>
		</cfif>
		<!--- Call the fw default controller --->
		<cfinvoke component="nikiru.cfc.global" method="load" thecgi="#cgi#" />
		<cfreturn true>
	</cffunction>

	<!--- Runs before request as well, after onRequestStart --->
	<!--- 
	WARNING!!!!! THE USE OF THIS METHOD WILL BREAK FLASH REMOTING, WEB SERVICES, AND AJAX CALLS. 
	DO NOT USE THIS METHOD UNLESS YOU KNOW THIS AND KNOW HOW TO WORK AROUND IT!
	--->
	<cffunction name="onRequest" returnType="void">
		<cfargument name="thePage" type="string" required="true">	
		<cfinclude template="#arguments.thePage#">
	</cffunction>

	<!--- Runs at end of request --->
	<cffunction name="onRequestEnd" returnType="void" output="false">
		<cfargument name="thePage" type="string" required="true">
	</cffunction>

	<!--- Runs on error --->
	<cffunction name="onError" output="true">
		<cfargument name="exception" required="true">
		<cfargument name="eventname" type="string" required="true">
		<cfdump var="#arguments#"><cfabort>
	</cffunction>

	<!--- Runs when your session starts --->
	<cffunction name="onSessionStart" returnType="void" output="false">
	</cffunction>

	<!--- Runs when session ends --->
	<cffunction name="onSessionEnd" returnType="void" output="false">
		<cfargument name="sessionScope" type="struct" required="true">
		<cfargument name="appScope" type="struct" required="false">
	</cffunction>
</cfcomponent>