Changeset 280

Timestamp:

12/20/06 13:12:58 (2 years ago)

Author:

scorfield

Message:

Fixes #135 by adding a check in strict mode that (a) only one of *.xml / *.xml.cfm exists
(for fusebox and circuit files) and (b) the file extensions are consistent (i.e., you can't
have fusebox.xml and then circuit.xml.cfm). The last may prove controversial.

Location:

framework/trunk

Files:

• .settings/org.eclipse.core.resources.prefs (modified) (1 diff)
• fuseboxApplication.cfc (modified) (7 diffs)
• fuseboxCircuit.cfc (modified) (4 diffs)
• myFusebox.cfc (modified) (1 diff)

framework/trunk/.settings/org.eclipse.core.resources.prefs

@@ -1 @@
-#Sun May 07 21:19:08 PDT 2006
+#Wed Dec 20 12:07:13 PST 2006
 eclipse.preferences.version=1
-encoding//skeleton/controller/circuit.xml.cfm=UTF-8
 encoding//skeleton/fusebox.xml.cfm=UTF-8
 encoding//skeleton/model/circuit.xml.cfm=UTF-8

framework/trunk/fuseboxApplication.cfc

@@ -93 +93 @@
                                         hint="I am the myFusebox data structure." />
                 
-                <!--- fix ticket 138 --->
+                <!--- fix ticket 135 --->
                 <cfset var myVersion = "5.0.1.#REReplace('$LastChangedRevision$','[^0-9]','','all')#" />
 
@@ -99 +99 @@
                 <cfset variables.fuseboxLexicon = variables.factory.getBuiltinLexicon() />
                 <cfset variables.customAttributes = structNew() />
+                
+                <cfset variables.fuseboxFileExtension = "" />
 
                 <cfset variables.fuseboxVersion = myVersion />
@@ -153 +155 @@
                 
                 <cfset var fbFile = "fusebox.xml.cfm" />
+                <cfset var fbFileAlt = "fusebox.xml" />
                 <cfset var fbXML = "" />
                 <cfset var fbCode = "" />
@@ -161 +164 @@
                 <cfset var jFuseboxFile = "" />
                 <cfset var dtLastModified = "" />
+                
+                <!---
+                        since we need to check the file, regardless of whether we load it,
+                        we might as well do the test up front and perform the strict check
+                        that just one version exists (ticket 135)
+                --->
+                <cfif fileExists(this.approotdirectory & fbFile)>
+                        <cfif this.strictMode and fileExists(this.approotdirectory & fbFileAlt)>
+                                <cfthrow type="fusebox.multipleFuseboxXML" 
+                                                message="Both 'fusebox.xml' and 'fusebox.xml.cfm' exist" 
+                                                detail="'fusebox.xml.cfm' will be used but 'fusebox.xml' also exists in '#this.approotdirectory#." />
+                        </cfif>
+                <cfelse>
+                        <cfset fbFile = fbFileAlt />
+                </cfif>
 
                 <cfif structKeyExists(this,"timestamp")>
-                        <cfif not fileExists(this.approotdirectory & fbFile)>
-                                <cfset fbFile = "fusebox.xml" />
-                        </cfif>
                         <!--- Java timestamp solution provided by Daniel Schmid --->
                         <cfset myFuseboxFilePath = this.approotdirectory & fbFile />
@@ -178 +193 @@
                         </cfif>
                         <!--- attempt to load fusebox.xml(.cfm): --->
-                        <cfif not fileExists(this.approotdirectory & fbFile)>
-                                <cfset fbFile = "fusebox.xml" />
-                        </cfif>
                         <cftry>
                                 
@@ -186 +198 @@
                                                 variable="fbXML"
                                                 charset="#this.characterEncoding#" />
+                                                
+                                <cfset variables.fuseboxFileExtension = listLast(fbFile,".") />
                                 
                                 <cfcatch type="any">
@@ -605 +619 @@
         </cffunction>
         
+        <cffunction name="getFuseboxFileExtension" returntype="string" access="public" output="false" 
+                                hint="I return the fusebox.xml file extension: either xml or cfm.">
+                                        
+                <cfreturn variables.fuseboxFileExtension />
+                
+        </cffunction>
+        
         <cffunction name="deleteParsedFiles" returntype="void" access="private" output="false" 
                                 hint="I delete all the script files in the parsed/ directory.">

framework/trunk/fuseboxCircuit.cfc

@@ -130 +130 @@
 
                 <cfset var circuitFile = "circuit.xml.cfm" />
+                <cfset var circuitFileAlt = "circuit.xml" />
                 <cfset var circuitXML = "" />
                 <cfset var circuitCode = "" />
@@ -138 +139 @@
                 <cfset var dtLastModified = "" />
 
+                <!---
+                        since we need to check the file, regardless of whether we load it,
+                        we might as well do the test up front and perform the strict check
+                        that just one version exists (ticket 135)
+                --->
+                <cfif fileExists(variables.fullPath & circuitFile)>
+                        <cfif variables.fuseboxApplication.strictMode and fileExists(variables.fullPath & circuitFileAlt)>
+                                <cfthrow type="fusebox.multipleCircuitXML" 
+                                                message="Both 'circuit.xml' and 'circuit.xml.cfm' exist" 
+                                                detail="'circuit.xml.cfm' will be used but 'circuit.xml' also exists in '#variables.fullPath#." />
+                        </cfif>
+                <cfelse>
+                        <cfset circuitFile = circuitFileAlt />
+                </cfif>
+
                 <cfif structKeyExists(this,"timestamp")>
-                        <cfif not fileExists(variables.fullPath & circuitFile)>
-                                <cfset circuitFile = "circuit.xml" />
-                        </cfif>
                         <!--- Java timestamp solution provided by Daniel Schmid --->
                         <cfset myCircuitFilePath = variables.fullPath & circuitFile />
@@ -153 +166 @@
                                 <cfset arguments.myFusebox.trace("Compiler","Loading #getAlias()# circuit.xml file") />
                         </cfif>
+
                         <!--- attempt to load circuit.xml(.cfm): --->
-                        <cfif not fileExists(variables.fullPath & circuitFile)>
-                                <cfset circuitFile = "circuit.xml" />
-                        </cfif>
                         <cftry>
                                 
@@ -176 +187 @@
                                 
                         </cftry>
+                        
+                        <cfif variables.fuseboxApplication.strictMode and
+                                        variables.fuseboxApplication.getFuseboxFileExtension() is not listLast(circuitFile,".")>
+                                <cfthrow type="fusebox.inconsistentFuseboxCircuit"
+                                                message="Inconsistent Fusebox / Circuit file extensions" 
+                                                detail="The circuit xml file, #circuitFile#, in #variables.fullPath#, uses a different file extension to the application's fusebox xml file. Strict requires consistency." />
+                        </cfif>
                         
                         <cftry>

framework/trunk/myFusebox.cfc

@@ -51 +51 @@
 <cfcomponent hint="I provide the per-request myFusebox data structure and some convenience methods.">
         <cfscript>
-        // fix ticket 138
+        // fix ticket 135
         this.version.runtime     = "5.0.1.#REReplace('$LastChangedRevision$','[^0-9]','','all')#";