CKFinder 2.x/Developers Guide/ColdFusion/Plugins/Writing ColdFusion - Revision history

Wiktor at 13:31, 25 May 2010

2010-05-25T13:31:04Z

Wiktor at 13:30, 25 May 2010

2010-05-25T13:30:49Z

Wiktor: /* FileSize.cfc */

2010-05-25T09:17:17Z

‎FileSize.cfc

Wiktor: /* FileSize.cfc */

2010-05-25T09:15:47Z

‎FileSize.cfc

Wiktor at 09:15, 25 May 2010

2010-05-25T09:15:14Z

Wiktor at 09:14, 25 May 2010

2010-05-25T09:14:11Z

Wiktor at 09:12, 25 May 2010

2010-05-25T09:12:10Z

Wiktor at 09:10, 25 May 2010

2010-05-25T09:10:15Z

Wiktor at 09:07, 25 May 2010

2010-05-25T09:07:22Z

Wiktor at 08:56, 25 May 2010

2010-05-25T08:56:54Z

Show changes

@@ Line 1: / Line 1: @@
-__TOC__<div style="border:1px solid #000; padding:6px; margin-bottom:10px">'''Note: the instruction below is valid only for ColdFusion 8 and later.'''</div>
+<div style="border:1px solid #000; padding:6px; margin-bottom:10px">'''Note: the instruction below is valid only for ColdFusion 8 and later.'''</div>
+__TOC__{{CKFinder 2.x Writing Plugins Introduction}}
 == Creating a plugin ==

← Older revision		Revision as of 13:30, 25 May 2010
Line 1:		Line 1:
−	<div style="border:1px solid #000; padding:6px; margin-bottom:10px">'''Note: the instruction below is valid only for ColdFusion 8 and later.'''</div>	+	__TOC__<div style="border:1px solid #000; padding:6px; margin-bottom:10px">'''Note: the instruction below is valid only for ColdFusion 8 and later.'''</div>

	{{CKFinder 2.x Writing Plugins Introduction}}		{{CKFinder 2.x Writing Plugins Introduction}}

@@ Line 225: / Line 225: @@
    <cfdirectory name="myDir" action="list" directory="#currentFolderServerPath#" filter="#fileName#">
-   <cfscript>
+   <!--- (Step 6) Adding a <FileSize> element to the XML response. --->
-    // (Step 6) Adding a <FileSize> element to the XML response.
+  <cfset nodeFileSize = XMLElemNew(THIS.xmlObject, "FileSize") >
-    nodeFileSize = XMLElemNew(THIS.xmlObject, "FileSize");
+  <cfset nodeFileSize.xmlAttributes["size"] = myDir.Size >
-    nodeFileSize.xmlAttributes["size"] = myDir.Size;
+  <cfset ArrayAppend(THIS.xmlObject["Connector"].xmlChildren, nodeFileSize) >
    <cfreturn true>

@@ Line 190: / Line 190: @@
 ===== FileSize.cfc =====
-<source lang="xml">
+<source lang="cfm">
 <!--- Since we will send a XML response, we'll extend the XmlCommandHandlerBase --->
 <!--- (Step 4) Extend base XML command handler --->

@@ Line 190: / Line 190: @@
 ===== FileSize.cfc =====
-<source>
+<source lang="xml">
 <!--- Since we will send a XML response, we'll extend the XmlCommandHandlerBase --->
 <!--- (Step 4) Extend base XML command handler --->
@@ Line 196: / Line 196: @@
 <!--- (Step 5) The buildXml method is used to construct an XML response --->
-<cffunction access="public" name="buildXml" hint="send XML response" returntype="boolean" description="send response" output="false">
+<cffunction access="public" name="buildXml" hint="send XML response" returntype="boolean" output="false">
    <cfset var fileName = URL.FileName>
    <cfset var fileSystem = APPLICATION.CreateCFC("Utils.FileSystem") />

@@ Line 197: / Line 197: @@
 <!--- (Step 5) The buildXml method is used to construct an XML response --->
 <cffunction access="public" name="buildXml" hint="send XML response" returntype="boolean" description="send response" output="false">
-	<cfset var fileName = URL.FileName>
+  <cfset var fileName = URL.FileName>
-	<cfset var fileSystem = APPLICATION.CreateCFC("Utils.FileSystem") />
+  <cfset var fileSystem = APPLICATION.CreateCFC("Utils.FileSystem") />
-	<cfset var coreConfig = APPLICATION.CreateCFC("Core.Config")>
+  <cfset var coreConfig = APPLICATION.CreateCFC("Core.Config")>
-	<cfset var currentFolderServerPath = THIS.currentFolder.getServerPath()>
+  <cfset var currentFolderServerPath = THIS.currentFolder.getServerPath()>
-	<cfset var filePath = fileSystem.CombinePaths(currentFolderServerPath, fileName)>
+  <cfset var filePath = fileSystem.CombinePaths(currentFolderServerPath, fileName)>
-	<cfif not REQUEST.CheckAuthentication()>
+  <cfif not REQUEST.CheckAuthentication()>
-		<cfthrow errorCode="#REQUEST.constants.CKFINDER_CONNECTOR_ERROR_CONNECTOR_DISABLED#" type="ckfinder" />
+    <cfthrow errorCode="#REQUEST.constants.CKFINDER_CONNECTOR_ERROR_CONNECTOR_DISABLED#" type="ckfinder" />
-	</cfif>
+  </cfif>
-	<cfif not THIS.currentFolder.checkAcl(REQUEST.constants.CKFINDER_CONNECTOR_ACL_FILE_VIEW) >
+  <cfif not THIS.currentFolder.checkAcl(REQUEST.constants.CKFINDER_CONNECTOR_ACL_FILE_VIEW) >
-		<cfthrow errorcode="#REQUEST.constants.CKFINDER_CONNECTOR_ERROR_UNAUTHORIZED#" type="ckfinder" />
+    <cfthrow errorcode="#REQUEST.constants.CKFINDER_CONNECTOR_ERROR_UNAUTHORIZED#" type="ckfinder" />
-	</cfif>
+  </cfif>
-	<cfif not fileSystem.checkFileName(fileName) or coreConfig.checkIsHiddenFile(fileName)>
+  <cfif not fileSystem.checkFileName(fileName) or coreConfig.checkIsHiddenFile(fileName)>
-		<cfthrow errorcode="#REQUEST.constants.CKFINDER_CONNECTOR_ERROR_INVALID_REQUEST#" type="ckfinder">
+    <cfthrow errorcode="#REQUEST.constants.CKFINDER_CONNECTOR_ERROR_INVALID_REQUEST#" type="ckfinder">
-	</cfif>
+  </cfif>
-	<cfset result = THIS.currentFolder.checkExtension(fileName)>
+  <cfset result = THIS.currentFolder.checkExtension(fileName)>
-	<cfif not result[1]>
+  <cfif not result[1]>
-		<cfthrow errorcode="#REQUEST.constants.CKFINDER_CONNECTOR_ERROR_INVALID_REQUEST#" type="ckfinder">
+    <cfthrow errorcode="#REQUEST.constants.CKFINDER_CONNECTOR_ERROR_INVALID_REQUEST#" type="ckfinder">
-	</cfif>
+  </cfif>
-	<cfif not fileexists(filePath)>
+  <cfif not fileexists(filePath)>
-		<cfthrow errorcode="#REQUEST.constants.CKFINDER_CONNECTOR_ERROR_FILE_NOT_FOUND#">
+    <cfthrow errorcode="#REQUEST.constants.CKFINDER_CONNECTOR_ERROR_FILE_NOT_FOUND#">
-	</cfif>
+  </cfif>
-	<cfdirectory name="myDir" action="list" directory="#currentFolderServerPath#" filter="#fileName#">
+  <cfdirectory name="myDir" action="list" directory="#currentFolderServerPath#" filter="#fileName#">
-	<cfscript>
+  <cfscript>
-		// (Step 6) Adding a <FileSize> element to the XML response.
+    // (Step 6) Adding a <FileSize> element to the XML response.
-		nodeFileSize = XMLElemNew(THIS.xmlObject, "FileSize");
+    nodeFileSize = XMLElemNew(THIS.xmlObject, "FileSize");
-		nodeFileSize.xmlAttributes["size"] = myDir.Size;
+    nodeFileSize.xmlAttributes["size"] = myDir.Size;
-		ArrayAppend(THIS.xmlObject["Connector"].xmlChildren, nodeFileSize);
+    ArrayAppend(THIS.xmlObject["Connector"].xmlChildren, nodeFileSize);
-	</cfscript>
+  </cfscript>
-	<cfreturn true>
+  <cfreturn true>
 </cffunction>

@@ Line 76: / Line 76: @@
        --->
        <cfset oObject.sendResponse()>
      </cftry>
      <!--- false = stop further execution --->
@@ Line 94: / Line 86: @@
 <!--- (Step 3) The function assigned to a hook must be available in the REQUEST scope --->
 <cfset REQUEST.CKFinderPluginFileSize = CKFinderPluginFileSize>
 <!--- (Step 1) Register the CKFinderPluginFileSize function to be called by the BeforeExecuteCommand hook. --->

@@ Line 69: / Line 69: @@
    <cfif command eq "FileSize">
      <cftry>
-       <!--- (Step 3) Our custom component that will do the rest --->
+       <!--- (Step 4) Our custom component that will do the rest --->
        <cfset oObject = CreateObject("component", "FileSize")>
        <!---
@@ Line 92: / Line 92: @@
 </cffunction>
 <cfset REQUEST.CKFinderPluginFileSize = CKFinderPluginFileSize>
@@ Line 101: / Line 102: @@
    <cfset config.hooks = arrayNew(1)>
 </cfif>
 <!--- (Step 1) Register the CKFinderPluginFileSize function to be called by the BeforeExecuteCommand hook. --->
 <cfset hook = arrayNew(1)>
@@ Line 124: / Line 126: @@
 </source>
-==== Step3: Create a class ====
+==== Step3: Add function to REQUEST scope ====
-Instead of writing everything in plugin.cfm, we'll create another file, called '''FileSize.cfc''', where we'll add the rest of the code.
+Our event handler must be available in the REQUEST scope.
 If your plugin returns an XML response, you'll usually just extend the XmlCommandHandlerBase component to reduce the amount of code to write, however it is not a requirement.
@@ Line 132: / Line 137: @@
 </source>
-==== Step4: Create the buildXml method ====
+==== Step5: Create the buildXml method ====
 In the <code>CKFinderPluginFileSize</code> function we have called <code>sendResponse</code>. The <code>sendResponse method is defined</code> in XmlCommandHandlerBase class, it creates a basic XML response and calls the <code>buildXml</code> method, which we need to define in FileSize.cfc.
 <source>
@@ Line 139: / Line 144: @@
 </source>
-==== Step5: Construct the XML response ====
+==== Step6: Construct the XML response ====
 The main task of the buildXml method is to construct an XML response, so we're doing it below:
 <source>
@@ Line 152: / Line 157: @@
 ===== plugin.cfm =====
 <source>
 <cffunction name="CKFinderPluginFileSize" returntype="Boolean" output="true">
    <cfargument name="command" required="true" type="String">
-   <!--- (3) Register the "FileSize" command --->
+   <!--- Register the "FileSize" command --->
    <cfif command eq "FileSize">
      <cftry>
        <cfset oObject = CreateObject("component", "FileSize")>
        <!---
@@ Line 167: / Line 174: @@
          <cfscript>
            oCommandHandler_XmlCommandHandler =
-            APPLICATION.CreateCFC("CKFinder_Connector.CommandHandler.XmlCommandHandlerBase").Init();
+                APPLICATION.CreateCFC("CKFinder_Connector.CommandHandler.XmlCommandHandlerBase").Init();
            oCommandHandler_XmlCommandHandler.sendError(#CFCATCH.ErrorCode#);
          </cfscript>
@@ Line 179: / Line 186: @@
 </cffunction>
 <cfset REQUEST.CKFinderPluginFileSize = CKFinderPluginFileSize>
@@ Line 188: / Line 196: @@
    <cfset config.hooks = arrayNew(1)>
 </cfif>
 <!--- (1) Register the CKFinderPluginFileSize function to be called by the BeforeExecuteCommand hook. --->
 <cfset hook = arrayNew(1)>
 <cfset hook[1] = "BeforeExecuteCommand">