/wheels/view/assets.cfm

http://cfwheels.googlecode.com/ · ColdFusion · 269 lines · 255 code · 14 blank · 0 comment · 45 complexity · ee7ab90d22e913f0be7868b15b9c9f86 MD5 · raw file 

    

  1. <cffunction name="styleSheetLinkTag" returntype="string" access="public" output="false" hint="Returns a `link` tag for a stylesheet (or several) based on the supplied arguments."
    2. 

  2. 	examples=
    3. 

  3. 	'
    4. 

  4. 		<!--- view code --->
    5. 

  5. 		<head>
    6. 

  6. 			<!--- Includes `stylesheets/styles.css` --->
    7. 

  7. 		    ##styleSheetLinkTag("styles")##
    8. 

  8. 			<!--- Includes `stylesheets/blog.css` and `stylesheets/comments.css` --->
    9. 

  9. 			##styleSheetLinkTag("blog,comments")##
    10. 

  10. 			<!--- Includes printer style sheet --->
    11. 

  11. 			##styleSheetLinkTag(source="print", media="print")##
    12. 

  12. 			<!--- Includes external style sheet --->
    13. 

  13. 			##styleSheetLinkTag("http://ajax.googleapis.com/ajax/libs/jqueryui/1.7.0/themes/cupertino/jquery-ui.css")##
    14. 

  14. 		</head>
    15. 

  15. 		
    16. 

  16. 		<body>
    17. 

  17. 			<!--- This will still appear in the `head` --->
    18. 

  18. 			##styleSheetLinkTag(source="tabs", head=true)##
    19. 

  19. 		</body>
    20. 

  20. 	'
    21. 

  21. 	categories="view-helper,assets" chapters="miscellaneous-helpers" functions="javaScriptIncludeTag,imageTag">
    22. 

  22. 	<cfargument name="sources" type="string" required="false" default="" hint="The name of one or many CSS files in the `stylesheets` folder, minus the `.css` extension. (Can also be called with the `source` argument.) Pass a full URL to generate a tag for an external style sheet.">

    23. 

  23. 	<cfargument name="type" type="string" required="false" hint="The `type` attribute for the `link` tag.">

    24. 

  24. 	<cfargument name="media" type="string" required="false" hint="The `media` attribute for the `link` tag.">

    25. 

  25. 	<cfargument name="head" type="string" required="false" hint="Set to `true` to place the output in the `head` area of the HTML page instead of the default behavior, which is to place the output where the function is called from.">

    26. 

  26. 	<cfscript>

    27. 

  27. 		var loc = {};

    28. 

  28. 		$args(name="styleSheetLinkTag", args=arguments, combine="sources/source/!", reserved="href,rel");

    29. 

  29. 		arguments.rel = "stylesheet";

    30. 

  30. 		loc.returnValue = "";

    31. 

  31. 		arguments.sources = $listClean(list=arguments.sources, returnAs="array");

    32. 

  32. 		loc.iEnd = ArrayLen(arguments.sources);

    33. 

  33. 		for (loc.i=1; loc.i <= loc.iEnd; loc.i++)

    34. 

  34. 		{

    35. 

  35. 			loc.item = arguments.sources[loc.i];

    36. 

  36. 			if (ReFindNoCase("^https?:\/\/", loc.item))

    37. 

  37. 			{

    38. 

  38. 				arguments.href = arguments.sources[loc.i];

    39. 

  39. 			}

    40. 

  40. 			else

    41. 

  41. 			{

    42. 

  42. 				arguments.href = application.wheels.webPath & application.wheels.stylesheetPath & "/" & loc.item;

    43. 

  43. 				if (!ListFindNoCase("css,cfm", ListLast(loc.item, ".")))

    44. 

  44. 					arguments.href = arguments.href & ".css";

    45. 

  45. 				arguments.href = $assetDomain(arguments.href) & $appendQueryString();

    46. 

  46. 			}

    47. 

  47. 			loc.returnValue = loc.returnValue & $tag(name="link", skip="sources,head", close=true, attributes=arguments) & chr(10);

    48. 

  48. 		}

    49. 

  49. 		if (arguments.head)

    50. 

  50. 		{

    51. 

  51. 			$htmlhead(text=loc.returnValue);

    52. 

  52. 			loc.returnValue = "";

    53. 

  53. 		}

    54. 

  54. 	</cfscript>

    55. 

  55. 	<cfreturn loc.returnValue>

    56. 

  56. </cffunction>

    57. 

  57. 

    58. 

  58. <cffunction name="javaScriptIncludeTag" returntype="string" access="public" output="false" hint="Returns a `script` tag for a JavaScript file (or several) based on the supplied arguments."
    59. 

  59. 	examples=
    60. 

  60. 	'
    61. 

  61. 		<!--- view code --->
    62. 

  62. 		<head>
    63. 

  63. 			<!--- Includes `javascripts/main.js` --->
    64. 

  64. 		    ##javaScriptIncludeTag("main")##
    65. 

  65. 			<!--- Includes `javascripts/blog.js` and `javascripts/accordion.js` --->
    66. 

  66. 			##javaScriptIncludeTag("blog,accordion")##
    67. 

  67. 			<!--- Includes external JavaScript file --->
    68. 

  68. 			##javaScriptIncludeTag("https://ajax.googleapis.com/ajax/libs/jquery/1.4.4/jquery.min.js")##
    69. 

  69. 		</head>
    70. 

  70. 		
    71. 

  71. 		<body>
    72. 

  72. 			<!--- Will still appear in the `head` --->
    73. 

  73. 			##javaScriptIncludeTag(source="tabs", head=true)##
    74. 

  74. 		</body>
    75. 

  75. 	'
    76. 

  76. 	categories="view-helper,assets" chapters="miscellaneous-helpers" functions="styleSheetLinkTag,imageTag">
    77. 

  77. 	<cfargument name="sources" type="string" required="false" default="" hint="The name of one or many JavaScript files in the `javascripts` folder, minus the `.js` extension. (Can also be called with the `source` argument.) Pass a full URL to access an external JavaScript file.">

    78. 

  78. 	<cfargument name="type" type="string" required="false" hint="The `type` attribute for the `script` tag.">

    79. 

  79. 	<cfargument name="head" type="string" required="false" hint="See documentation for @styleSheetLinkTag.">

    80. 

  80. 	<cfscript>

    81. 

  81. 		var loc = {};

    82. 

  82. 		$args(name="javaScriptIncludeTag", args=arguments, combine="sources/source/!", reserved="src");

    83. 

  83. 		loc.returnValue = "";

    84. 

  84. 		arguments.sources = $listClean(list=arguments.sources, returnAs="array");

    85. 

  85. 		loc.iEnd = ArrayLen(arguments.sources);

    86. 

  86. 		for (loc.i=1; loc.i <= loc.iEnd; loc.i++)

    87. 

  87. 		{

    88. 

  88. 			loc.item = arguments.sources[loc.i];

    89. 

  89. 			if (ReFindNoCase("^https?:\/\/", loc.item))

    90. 

  90. 			{

    91. 

  91. 				arguments.src = arguments.sources[loc.i];

    92. 

  92. 			}

    93. 

  93. 			else

    94. 

  94. 			{

    95. 

  95. 				arguments.src = application.wheels.webPath & application.wheels.javascriptPath & "/" & loc.item;

    96. 

  96. 				if (!ListFindNoCase("js,cfm", ListLast(loc.item, ".")))

    97. 

  97. 					arguments.src = arguments.src & ".js";

    98. 

  98. 				arguments.src = $assetDomain(arguments.src) & $appendQueryString();

    99. 

  99. 			}

    100. 

  100. 			loc.returnValue = loc.returnValue & $element(name="script", skip="sources,head", attributes=arguments) & chr(10);

    101. 

  101. 		}

    102. 

  102. 		if (arguments.head)

    103. 

  103. 		{

    104. 

  104. 			$htmlhead(text=loc.returnValue);

    105. 

  105. 			loc.returnValue = "";

    106. 

  106. 		}

    107. 

  107. 	</cfscript>

    108. 

  108. 	<cfreturn loc.returnValue>

    109. 

  109. </cffunction>

    110. 

  110. 

    111. 

  111. <cffunction name="imageTag" returntype="string" access="public" output="false" hint="Returns an `img` tag. If the image is stored in the local `images` folder, the tag will also set the `width`, `height`, and `alt` attributes for you. Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes."

    112. 

  112. 	examples=

    113. 

  113. 	'

    114. 

  114. 		<!--- Outputs an `img` tag for `images/logo.png` --->

    115. 

  115. 		##imageTag("logo.png")##

    116. 

  116. 		

    117. 

  117. 		<!--- Outputs an `img` tag for `http://cfwheels.org/images/logo.png` --->

    118. 

  118. 		##imageTag("http://cfwheels.org/images/logo.png", alt="ColdFusion on Wheels")##

    119. 

  119. 		

    120. 

  120. 		<!--- Outputs an `img` tag with the `class` attribute set --->

    121. 

  121. 		##imageTag(source="logo.png", class="logo")##

    122. 

  122. 	'

    123. 

  123. 	categories="view-helper,assets" chapters="miscellaneous-helpers" functions="javaScriptIncludeTag,styleSheetLinkTag">

    124. 

  124. 	<cfargument name="source" type="string" required="true" hint="The file name of the image if it's availabe in the local file system (i.e. ColdFusion will be able to access it). Provide the full URL if the image is on a remote server.">

    125. 

  125. 	<cfscript>

    126. 

  126. 		var loc = {};

    127. 

  127. 		$args(name="imageTag", reserved="src", args=arguments);

    128. 

  128. 		// ugly fix due to the fact that id can't be passed along to cfinvoke

    129. 

  129. 		if (StructKeyExists(arguments, "id"))

    130. 

  130. 		{

    131. 

  131. 			arguments.wheelsId = arguments.id;

    132. 

  132. 			StructDelete(arguments, "id");

    133. 

  133. 		}

    134. 

  134. 		if (application.wheels.cacheImages)

    135. 

  135. 		{

    136. 

  136. 			loc.category = "images";

    137. 

  137. 			loc.key = $hashedKey(arguments);

    138. 

  138. 			loc.lockName = loc.category & loc.key;

    139. 

  139. 			loc.conditionArgs = {};

    140. 

  140. 			loc.conditionArgs.category = loc.category;

    141. 

  141. 			loc.conditionArgs.key = loc.key;

    142. 

  142. 			loc.executeArgs = arguments;

    143. 

  143. 			loc.executeArgs.category = loc.category;

    144. 

  144. 			loc.executeArgs.key = loc.key;

    145. 

  145. 			loc.returnValue = $doubleCheckedLock(name=loc.lockName, condition="$getFromCache", execute="$addImageTagToCache", conditionArgs=loc.conditionArgs, executeArgs=loc.executeArgs);

    146. 

  146. 		}

    147. 

  147. 		else

    148. 

  148. 		{

    149. 

  149. 			loc.returnValue = $imageTag(argumentCollection=arguments);

    150. 

  150. 		}

    151. 

  151. 		// ugly fix continued

    152. 

  152. 		if (StructKeyExists(arguments, "wheelsId"))

    153. 

  153. 			loc.returnValue = ReplaceNoCase(loc.returnValue, "wheelsId", "id");

    154. 

  154. 	</cfscript>

    155. 

  155. 	<cfreturn loc.returnValue>

    156. 

  156. </cffunction>

    157. 

  157. 

    158. 

  158. <cffunction name="$addImageTagToCache" returntype="string" access="public" output="false">

    159. 

  159. 	<cfscript>

    160. 

  160. 		var returnValue = "";

    161. 

  161. 		returnValue = $imageTag(argumentCollection=arguments);

    162. 

  162. 		$addToCache(key=arguments.key, value=returnValue, category=arguments.category);

    163. 

  163. 	</cfscript>

    164. 

  164. 	<cfreturn returnValue>

    165. 

  165. </cffunction>

    166. 

  166. 

    167. 

  167. <cffunction name="$imageTag" returntype="string" access="public" output="false">

    168. 

  168. 	<cfscript>

    169. 

  169. 		var loc = {};

    170. 

  170. 		loc.localFile = true;

    171. 

  171. 

    172. 

  172. 		if(Left(arguments.source, 7) == "http://" || Left(arguments.source, 8) == "https://")

    173. 

  173. 			loc.localFile = false;

    174. 

  174. 

    175. 

  175. 		if (!loc.localFile)

    176. 

  176. 		{

    177. 

  177. 			arguments.src = arguments.source;

    178. 

  178. 		}

    179. 

  179. 		else

    180. 

  180. 		{

    181. 

  181. 			arguments.src = application.wheels.webPath & application.wheels.imagePath & "/" & arguments.source;

    182. 

  182. 			if (application.wheels.showErrorInformation)

    183. 

  183. 			{

    184. 

  184. 				if (loc.localFile && !FileExists(ExpandPath(arguments.src)))

    185. 

  185. 					$throw(type="Wheels.ImageFileNotFound", message="Wheels could not find `#expandPath('#arguments.src#')#` on the local file system.", extendedInfo="Pass in a correct relative path from the `images` folder to an image.");

    186. 

  186. 				else if (!IsImageFile(ExpandPath(arguments.src)))

    187. 

  187. 					$throw(type="Wheels.ImageFormatNotSupported", message="Wheels can't read image files with that format.", extendedInfo="Use one of these image types instead: #GetReadableImageFormats()#.");

    188. 

  188. 			}

    189. 

  189. 			// height and/or width arguments are missing so use cfimage to get them

    190. 

  190. 			if (!StructKeyExists(arguments, "width") or !StructKeyExists(arguments, "height"))

    191. 

  191. 			{

    192. 

  192. 				loc.image = $image(action="info", source=ExpandPath(arguments.src));

    193. 

  193. 				if (!StructKeyExists(arguments, "width") and loc.image.width gt 0)

    194. 

  194. 					arguments.width = loc.image.width;

    195. 

  195. 				if (!StructKeyExists(arguments, "height") and loc.image.height gt 0)

    196. 

  196. 					arguments.height = loc.image.height;

    197. 

  197. 			}

    198. 

  198. 			// only append a query string if the file is local

    199. 

  199. 			arguments.src = $assetDomain(arguments.src) & $appendQueryString();

    200. 

  200. 		}

    201. 

  201. 		if (!StructKeyExists(arguments, "alt"))

    202. 

  202. 			arguments.alt = capitalize(ReplaceList(SpanExcluding(Reverse(SpanExcluding(Reverse(arguments.src), "/")), "."), "-,_", " , "));

    203. 

  203. 		loc.returnValue = $tag(name="img", skip="source,key,category", close=true, attributes=arguments);

    204. 

  204. 	</cfscript>

    205. 

  205. 	<cfreturn loc.returnValue>

    206. 

  206. </cffunction>

    207. 

  207. 

    208. 

  208. <cffunction name="$appendQueryString" returntype="string" access="public" output="false">

    209. 

  209. 	<cfscript>

    210. 

  210. 		var returnValue = "";

    211. 

  211. 		// if assetQueryString is a boolean value, it means we just reloaded, so create a new query string based off of now

    212. 

  212. 		// the only problem with this is if the app doesn't get used a lot and the application is left alone for a period longer than the application scope is allowed to exist

    213. 

  213. 		if (IsBoolean(application.wheels.assetQueryString) and YesNoFormat(application.wheels.assetQueryString) == "no")

    214. 

  214. 			return returnValue;

    215. 

  215. 

    216. 

  216. 		if (!IsNumeric(application.wheels.assetQueryString) and IsBoolean(application.wheels.assetQueryString))

    217. 

  217. 			application.wheels.assetQueryString = Hash(DateFormat(Now(), "yyyymmdd") & TimeFormat(Now(), "HHmmss"));

    218. 

  218. 		returnValue = returnValue & "?" & application.wheels.assetQueryString;

    219. 

  219. 	</cfscript>

    220. 

  220. 	<cfreturn returnValue />

    221. 

  221. </cffunction>

    222. 

  222. 

    223. 

  223. <cffunction name="$assetDomain" returntype="string" access="public" output="false">

    224. 

  224. 	<cfargument name="pathToAsset" type="string" required="true">

    225. 

  225. 	<cfscript>

    226. 

  226. 		var loc = {};

    227. 

  227. 		loc.returnValue = arguments.pathToAsset;

    228. 

  228. 		if (application.wheels.showErrorInformation)

    229. 

  229. 		{

    230. 

  230. 			if (!IsStruct(application.wheels.assetPaths) && !IsBoolean(application.wheels.assetPaths))

    231. 

  231. 				$throw(type="Wheels.IncorrectConfiguration", message="The setting `assetsPaths` must be false or a struct.");

    232. 

  232. 			if (IsStruct(application.wheels.assetPaths) && !ListFindNoCase(StructKeyList(application.wheels.assetPaths), "http"))

    233. 

  233. 				$throw(type="Wheels.IncorrectConfiguration", message="The `assetPaths` setting struct must contain the key `http`");

    234. 

  234. 		}

    235. 

  235. 

    236. 

  236. 		// return nothing if assetPaths is not a struct

    237. 

  237. 		if (!IsStruct(application.wheels.assetPaths))

    238. 

  238. 			return loc.returnValue;

    239. 

  239. 

    240. 

  240. 		loc.protocol = "http://";

    241. 

  241. 		loc.domainList = application.wheels.assetPaths.http;

    242. 

  242. 

    243. 

  243. 		if (isSecure())

    244. 

  244. 		{

    245. 

  245. 			loc.protocol = "https://";

    246. 

  246. 			if (StructKeyExists(application.wheels.assetPaths, "https"))

    247. 

  247. 				loc.domainList = application.wheels.assetPaths.https;

    248. 

  248. 		}

    249. 

  249. 

    250. 

  250. 		loc.domainLen = ListLen(loc.domainList);

    251. 

  251. 

    252. 

  252. 		if (loc.domainLen gt 1)

    253. 

  253. 		{

    254. 

  254. 			// now comes the interesting part, lets take the pathToAsset argument, hash it and create a number from it

    255. 

  255. 			// so that we can do mod based off the length of the domain list

    256. 

  256. 			// this is an easy way to apply the same sub-domain to each asset, so we do not create more work for the server

    257. 

  257. 			// at the same time we are getting a very random hash value to rotate the domains over the assets evenly

    258. 

  258. 			loc.pathNumber = Right(REReplace(Hash(arguments.pathToAsset), "[A-Za-z]", "", "all"), 5);

    259. 

  259. 

    260. 

  260. 			loc.position = (loc.pathNumber mod (loc.domainLen)) + 1;

    261. 

  261. 		}

    262. 

  262. 		else

    263. 

  263. 		{

    264. 

  264. 			loc.position = loc.domainLen;

    265. 

  265. 		}

    266. 

  266. 		loc.returnValue = loc.protocol & Trim(ListGetAt(loc.domainList, loc.position)) & arguments.pathToAsset;

    267. 

  267. 	</cfscript>

    268. 

  268. 	<cfreturn loc.returnValue />

    269. 

  269. </cffunction>
    270.