From 05eb8da0ec2b4fcebfd249c9f71b320a768604ca Mon Sep 17 00:00:00 2001
From: Michael Jumper <mike.jumper@guac-dev.org>
Date: Sun, 5 Jul 2015 13:42:56 -0700
Subject: [PATCH] GUAC-1172: Use template for files within the file browser.

---
 .../app/client/directives/guacFileBrowser.js  | 51 ++++++++++++-------
 .../webapp/app/client/templates/file.html     | 30 +++++++++++
 2 files changed, 62 insertions(+), 19 deletions(-)
 create mode 100644 guacamole/src/main/webapp/app/client/templates/file.html

diff --git a/guacamole/src/main/webapp/app/client/directives/guacFileBrowser.js b/guacamole/src/main/webapp/app/client/directives/guacFileBrowser.js
index 55323f690..d612dfdfc 100644
--- a/guacamole/src/main/webapp/app/client/directives/guacFileBrowser.js
+++ b/guacamole/src/main/webapp/app/client/directives/guacFileBrowser.js
@@ -53,7 +53,8 @@ angular.module('client').directive('guacFileBrowser', [function guacFileBrowser(
             var ManagedFilesystem = $injector.get('ManagedFilesystem');
 
             // Required services
-            var $interpolate = $injector.get('$interpolate');
+            var $interpolate     = $injector.get('$interpolate');
+            var $templateRequest = $injector.get('$templateRequest');
 
             /**
              * The jQuery-wrapped element representing the contents of the
@@ -63,6 +64,16 @@ angular.module('client').directive('guacFileBrowser', [function guacFileBrowser(
              */
             var currentDirectoryContents = $element.find('.current-directory-contents');
 
+            /**
+             * Statically-cached template HTML used to render each file within
+             * a directory. Once available, this will be used through
+             * createFileElement() to generate the DOM elements which make up
+             * a directory listing.
+             *
+             * @type String
+             */
+            var fileTemplate = null;
+
             /**
              * Returns whether the given file is a normal file.
              *
@@ -116,6 +127,9 @@ angular.module('client').directive('guacFileBrowser', [function guacFileBrowser(
              * handling user events, bypassing the overhead incurred through
              * use of ngRepeat and related techniques.
              *
+             * Note that this function depends on the availability of the
+             * statically-cached fileTemplate.
+             *
              * @param {ManagedFilesystem.File} file
              *     The file to generate an element for.
              *
@@ -126,16 +140,7 @@ angular.module('client').directive('guacFileBrowser', [function guacFileBrowser(
             var createFileElement = function createFileElement(file) {
 
                 // Create from internal template
-                var element = angular.element($interpolate(
-
-                      '<div class="list-item">'
-                    +     '<div class="caption">'
-                    +         '<div class="icon"></div>'
-                    +         '{{::name}}'
-                    +     '</div>'
-                    + '</div>'
-
-                )(file));
+                var element = angular.element($interpolate(fileTemplate)(file));
 
                 // Change current directory when directories are clicked
                 if ($scope.isDirectory(file)) {
@@ -196,18 +201,26 @@ angular.module('client').directive('guacFileBrowser', [function guacFileBrowser(
 
             };
 
-            // Update the contents of the file browser whenever the current directory (or its contents) changes
-            $scope.$watch('filesystem.currentDirectory.files', function currentDirectoryChanged(files) {
+            // Watch directory contents once file template is available
+            $templateRequest('app/client/templates/file.html').then(function fileTemplateRetrieved(html) {
 
-                // Clear current content
-                currentDirectoryContents.html('');
+                // Store file template statically
+                fileTemplate = html;
+
+                // Update the contents of the file browser whenever the current directory (or its contents) changes
+                $scope.$watch('filesystem.currentDirectory.files', function currentDirectoryChanged(files) {
+
+                    // Clear current content
+                    currentDirectoryContents.html('');
+
+                    // Display all files within current directory, sorted
+                    angular.forEach(sortFiles(files), function displayFile(file) {
+                        currentDirectoryContents.append(createFileElement(file));
+                    });
 
-                // Display all files within current directory, sorted
-                angular.forEach(sortFiles(files), function displayFile(file) {
-                    currentDirectoryContents.append(createFileElement(file));
                 });
 
-            });
+            }); // end retrieve file template
 
         }]
 
diff --git a/guacamole/src/main/webapp/app/client/templates/file.html b/guacamole/src/main/webapp/app/client/templates/file.html
new file mode 100644
index 000000000..2bd86ea34
--- /dev/null
+++ b/guacamole/src/main/webapp/app/client/templates/file.html
@@ -0,0 +1,30 @@
+<div class="list-item">
+    <!--
+       Copyright (C) 2015 Glyptodon LLC
+
+       Permission is hereby granted, free of charge, to any person obtaining a copy
+       of this software and associated documentation files (the "Software"), to deal
+       in the Software without restriction, including without limitation the rights
+       to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+       copies of the Software, and to permit persons to whom the Software is
+       furnished to do so, subject to the following conditions:
+
+       The above copyright notice and this permission notice shall be included in
+       all copies or substantial portions of the Software.
+
+       THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+       IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+       FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+       AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+       LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+       OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+       THE SOFTWARE.
+    -->
+
+    <!-- Filename and icon -->
+    <div class="caption">
+        <div class="icon"></div>
+        {{::name}}
+    </div>
+
+</div>