root / framework / tags / fusebox5A2 / myFusebox.cfc

<!---
Fusebox Software License
Version 1.0

Copyright (c) 2003, 2004, 2005, 2006 The Fusebox Corporation. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted 
provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions 
   and the following disclaimer.

2. Redistributions in binary form or otherwise encrypted form must reproduce the above copyright 
   notice, this list of conditions and the following disclaimer in the documentation and/or other 
   materials provided with the distribution.

3. The end-user documentation included with the redistribution, if any, must include the following 
   acknowledgment:

   "This product includes software developed by the Fusebox Corporation (http://www.fusebox.org/)."

   Alternately, this acknowledgment may appear in the software itself, if and wherever such 
   third-party acknowledgments normally appear.

4. The names "Fusebox" and "Fusebox Corporation" must not be used to endorse or promote products 
   derived from this software without prior written (non-electronic) permission. For written 
   permission, please contact fusebox@fusebox.org.

5. Products derived from this software may not be called "Fusebox", nor may "Fusebox" appear in 
   their name, without prior written (non-electronic) permission of the Fusebox Corporation. For 
   written permission, please contact fusebox@fusebox.org.

If one or more of the above conditions are violated, then this license is immediately revoked and 
can be re-instated only upon prior written authorization of the Fusebox Corporation.

THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
DISCLAIMED. IN NO EVENT SHALL THE FUSEBOX CORPORATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY 
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

-------------------------------------------------------------------------------

This software consists of voluntary contributions made by many individuals on behalf of the 
Fusebox Corporation. For more information on Fusebox, please see <http://www.fusebox.org/>.

--->
<!---
Fusebox Software License
Version 1.0

Copyright (c) 2005 The Fusebox Corporation. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form or otherwise encrypted form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. The end-user documentation included with the redistribution, if any, must include the following acknowledgment:

"This product includes software developed by the Fusebox Corporation (http://www.fusebox.org/)."

Alternately, this acknowledgment may appear in the software itself, if and wherever such third-party acknowledgments normally appear.

4. The names "Fusebox" and "Fusebox Corporation" must not be used to endorse or promote products derived from this software without prior written (non-electronic) permission. For written permission, please contact fusebox@fusebox.org.

5. Products derived from this software may not be called "Fusebox", nor may "Fusebox" appear in their name, without prior written (non-electronic) permission of the Fusebox Corporation. For written permission, please contact fusebox@fusebox.org.

If one or more of the above conditions are violated, then this license is immediately revoked and can be re-instated only upon prior written authorization of the Fusebox Corporation.

THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FUSEBOX CORPORATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

-------------------------------------------------------------------------------

This software consists of voluntary contributions made by many individuals on behalf of the Fusebox Corporation. For more information on Fusebox, please see <http://www.fusebox.org/>.

--->
<cfcomponent>
        <cfscript>
        this.version.runtime     = "unknown";
        this.version.loader      = "unknown";
        this.version.transformer = "unknown";
        this.version.parser      = "unknown";
          
        this.version.runtime     = "5.0.0.A.2";
          
        this.thisCircuit = "";
        this.thisFuseaction =  "";
        this.thisPlugin = "";
        this.thisPhase = "";
        this.plugins = structNew();
        this.parameters = structNew();
        
        // the basic default is development mode  
        this.parameters.load = true;
        this.parameters.clean = false;          // don't delete parsed files by default
        this.parameters.parse = true;
        this.parameters.parseall = false;       // don't compile all fuseactions by default
        this.parameters.execute = true;
          
        this.parameters.userProvidedLoadParameter = false;
        this.parameters.userProvidedCleanParameter = false;
        this.parameters.userProvidedParseParameter = false;
        this.parameters.userProvidedParseAllParameter = false;
        this.parameters.userProvidedExecuteParameter = false;
        </cfscript>
        
        <cffunction name="init" returntype="myFusebox" access="public" output="false">
                <cfargument name="appKey" type="string" required="true" />
                <cfargument name="attributes" type="struct" required="true" />
                
                <cfset var theFusebox = structNew() />
                
                <cfset variables.appKey = arguments.appKey />
                <cfset variables.attributes = arguments.attributes />
                
                <!--- we can't guarantee the fusebox exists in application scope yet... --->
                <cfif structKeyExists(application,variables.appKey)>
                        <cfset theFusebox = application[variables.appKey] />
                </cfif>
                
                <!--- default myFusebox.parameters depending on "mode" of the application set in fusebox.xml --->
                <cfif structKeyExists(theFusebox,"mode")>
                        <cfswitch expression="#theFusebox.mode#">
                        <cfcase value="development">
                                <cfset this.parameters.load = true />
                                <cfset this.parameters.parse = true />
                                <cfset this.parameters.execute = true />
                        </cfcase>
                        <!--- FB5: new option - loading is slower so it's worth not loading everything --->
                        <cfcase value="development-no-load">
                                <cfset this.parameters.load = false />
                                <cfset this.parameters.parse = true />
                                <cfset this.parameters.execute = true />
                        </cfcase>
                        <!--- FB5: new option - loading is slower so it's worth having a parse-only mode --->
                        <cfcase value="development-parse-only">
                                <cfset this.parameters.load = false />
                                <cfset this.parameters.parse = true />
                                <cfset this.parameters.execute = true />
                        </cfcase>
                        <cfcase value="production">
                                <cfset this.parameters.load = false />
                                <cfset this.parameters.parse = false />
                                <cfset this.parameters.execute = true />
                        </cfcase>
                        </cfswitch>
                </cfif>

                <!--- did the user pass in any special "fuseboxDOT" parameters for this request? --->
                <!--- If so, process them --->
                <!--- note: only if attributes.fusebox.password matches the application password --->
                <cfif structKeyExists(theFusebox,"password") and structKeyExists(variables.attributes,'fusebox.password') and
                                theFusebox.password is variables.attributes['fusebox.password']>
                        <!--- FB5: does a load and wipes the parsed files out --->
                        <cfif structKeyExists(variables.attributes,'fusebox.loadclean') and isBoolean(variables.attributes['fusebox.loadclean'])>
                                <cfset this.parameters.load = variables.attributes['fusebox.loadclean'] />
                                <cfset this.parameters.clean = variables.attributes['fusebox.loadclean'] />
                                <cfset this.parameters.userProvidedLoadParameter = true />
                                <cfset this.parameters.userProvidedCleanParameter = true />
                        </cfif>
                        <cfif structKeyExists(variables.attributes,'fusebox.load') and isBoolean(variables.attributes['fusebox.load'])>
                                <cfset this.parameters.load = variables.attributes['fusebox.load'] />
                                <cfset this.parameters.userProvidedLoadParameter = true />
                        </cfif>
                        <cfif structKeyExists(variables.attributes,'fusebox.parseall') and isBoolean(variables.attributes['fusebox.parseall'])>
                                <cfset this.parameters.parse = variables.attributes['fusebox.parseall'] />
                                <cfset this.parameters.parseall = variables.attributes['fusebox.parseall'] />
                                <cfif this.parameters.parseall>
                                        <cfset this.parameters.load = true />
                                </cfif>
                                <cfset this.parameters.userProvidedParseParameter = true />
                                <cfset this.parameters.userProvidedParseAllParameter = true />
                        </cfif>
                        <cfif structKeyExists(variables.attributes,'fusebox.parse') and isBoolean(variables.attributes['fusebox.parse'])>
                                <cfset this.parameters.parse = variables.attributes['fusebox.parse'] />
                                <cfset this.parameters.userProvidedParseParameter = true />
                        </cfif>
                        <cfif structKeyExists(variables.attributes,'fusebox.execute') and isBoolean(variables.attributes['fusebox.execute'])>
                                <cfset this.parameters.execute = variables.attributes['fusebox.execute'] />
                                <cfset this.parameters.userProvidedExecuteParameter = true />
                        </cfif>
                </cfif>
                
                <!---
                        force a load if the runtime and core versions differ: this allows a new
                        version to be dropped in and the framework will automatically reload!
                --->
                <cfif structKeyExists(theFusebox,"getVersion") and
                                isCustomFunction(theFusebox.getVersion)>
                        <cfif this.version.runtime is not theFusebox.getVersion()>
                                <cfset this.parameters.load = true />
                        </cfif>
                <cfelse>
                        <!--- hmm, doesn't look like the core is present (or it's not FB5 Alpha 2 or higher) --->
                        <cfset this.parameters.load = true />
                </cfif>

                <!--- if the fusebox doesn't already exist we definitely want to reload --->
                <cfif structKeyExists(theFusebox,"isFullyLoaded") and
                                theFusebox.isFullyLoaded>
                        <!--- if fully loaded, leave the load parameter alone --->
                <cfelse>
                        <cfset this.parameters.load = true />
                </cfif>
                
                <cfreturn this />
        </cffunction>
        
        <cffunction name="getApplication" returntype="fuseboxApplication" access="public" output="false">
        
                <!---
                        this is a bit of a hack since we're accessing application scope directly 
                        but it's probably cleaner than exposing a method to allow fuseboxApplication
                        to inject itself back into myFusebox during compileRequest()...
                --->
                <cfreturn application[variables.appKey] />
        
        </cffunction>
        
        <cffunction name="getCurrentCircuit" returntype="fuseboxBaseCircuit" access="public" output="false">
        
                <cfreturn getApplication().circuits[this.thisCurrent] />
        
        </cffunction>
        
        <cffunction name="getCurrentFuseaction" returntype="fuseboxBaseAction" access="public" output="false">
        
                <cfreturn getCurrentCircuit().fuseactions[this.thisFuseaction] />
        
        </cffunction>
        
        <cffunction name="overrideAttributes" returntype="void" access="public" output="false">
                <cfargument name="scope" type="struct" required="true" />
        
                <cfset structAppend(variables.attributes,arguments.scope,true) />
                
        </cffunction>
        
</cfcomponent>