rebaseline_server: add "deep linking" to allow bookmarking of particular views

gm/rebaseline_server/static/loader.js

 /*
  * Loader:
  * Reads GM result reports written out by results.py, and imports
  * them into $scope.categories and $scope.testData .
  */
 var Loader = angular.module(
     'Loader',
     []
 );
 
@@ skipping 24 matching lines @@
       return filteredItems;
     };
   }
 );
 
 
 Loader.controller(
   'Loader.Controller',
     function($scope, $http, $filter, $location, $timeout) {
     $scope.windowTitle = "Loading GM Results...";
-    var resultsToLoad = $location.search().resultsToLoad;
-    $scope.loadingMessage = "Loading results of type '" + resultsToLoad +
+    $scope.resultsToLoad = $location.search().resultsToLoad;
+    $scope.loadingMessage = "Loading results of type '" + $scope.resultsToLoad +
         "', please wait...";
 
     /**
      * On initial page load, load a full dictionary of results.
      * Once the dictionary is loaded, unhide the page elements so they can
      * render the data.
      */
-    $http.get("/results/" + resultsToLoad).success(
+    $http.get("/results/" + $scope.resultsToLoad).success(
       function(data, status, header, config) {
         if (data.header.resultsStillLoading) {
           $scope.loadingMessage =
               "Server is still loading initial results; will retry at " +
               $scope.localTimeString(data.header.timeNextUpdateAvailable);
           $timeout(
               function(){location.reload();},
               (data.header.timeNextUpdateAvailable * 1000) - new Date().getTime());
         } else {
           $scope.loadingMessage = "Processing data, please wait...";
@@ skipping 46 matching lines @@
           };
           $scope.allResultTypes = Object.keys(data.categories['resultType']);
           $scope.hiddenConfigs = {};
           $scope.allConfigs = Object.keys(data.categories['config']);
 
           // Associative array of partial string matches per category.
           $scope.categoryValueMatch = {};
           $scope.categoryValueMatch.builder = "";
           $scope.categoryValueMatch.test = "";
 
+          // If any defaults were overridden in the URL, get them now.
+          $scope.queryParameters.load();
+
           $scope.updateResults();
           $scope.loadingMessage = "";
           $scope.windowTitle = "Current GM Results";
         }
       }
     ).error(
       function(data, status, header, config) {
         $scope.loadingMessage = "Failed to load results of type '"
-            + resultsToLoad + "'";
+            + $scope.resultsToLoad + "'";
         $scope.windowTitle = "Failed to Load GM Results";
       }
     );
 
 
     //
     // Select/Clear/Toggle all tests.
     //
 
     /**
@@ skipping 73 matching lines @@
       for (var i = 0; i < numItems; i++) {
         itemIndex = itemIndices[i];
         $scope.numResultsPerTab[$scope.testData[itemIndex].tab]--;
         $scope.testData[itemIndex].tab = newTab;
       }
       $scope.numResultsPerTab[newTab] += numItems;
     }
 
 
     //
+    // $scope.queryParameters:
+    // Transfer parameter values between $scope and the URL query string.
+    //
+    $scope.queryParameters = {};
+
+    // load and save functions for parameters of each type
+    // (load a parameter value into $scope from nameValuePairs,
+    //  save a parameter value from $scope into nameValuePairs)
+    $scope.queryParameters.copiers = {
+      'simple': {
+        'load': function(nameValuePairs, name) {
+          var value = nameValuePairs[name];
+          if (value) {
+            $scope[name] = value;
+          }
+        },
+        'save': function(nameValuePairs, name) {
+          nameValuePairs[name] = $scope[name];
+        }
+      },
+
+      'categoryValueMatch': {
+        'load': function(nameValuePairs, name) {
+          var value = nameValuePairs[name];
+          if (value) {
+            $scope.categoryValueMatch[name] = value;
+          }
+        },
+        'save': function(nameValuePairs, name) {
+          nameValuePairs[name] = $scope.categoryValueMatch[name];
+        }
+      },
+
+      'set': {
+        'load': function(nameValuePairs, name) {
+          var value = nameValuePairs[name];
+          if (value) {
+            var valueArray = value.split(',');
+            $scope[name] = {};
+            $scope.toggleValuesInSet(valueArray, $scope[name]);
+          }
+        },
+        'save': function(nameValuePairs, name) {
+          nameValuePairs[name] = Object.keys($scope[name]).join(',');
+        }
+      },
+
+    };
+
+    // parameter name -> copier objects to load/save parameter value
+    $scope.queryParameters.map = {
+      'resultsToLoad':       $scope.queryParameters.copiers.simple,
+      'displayLimitPending': $scope.queryParameters.copiers.simple,
+      'imageSizePending':    $scope.queryParameters.copiers.simple,
+      'sortColumn':          $scope.queryParameters.copiers.simple,
+
+      'builder': $scope.queryParameters.copiers.categoryValueMatch,
+      'test':    $scope.queryParameters.copiers.categoryValueMatch,
+
+      'hiddenResultTypes': $scope.queryParameters.copiers.set,
+      'hiddenConfigs':     $scope.queryParameters.copiers.set,
+    };
+
+    // Loads all parameters into $scope from the URL query string;
+    // any which are not found within the URL will keep their current value.
+    $scope.queryParameters.load = function() {
+      var nameValuePairs = $location.search();
+      angular.forEach($scope.queryParameters.map,
+                      function(copier, paramName) {
+                        copier.load(nameValuePairs, paramName);
+                      }
+                     );
+    };
+
+    // Saves all parameters from $scope into the URL query string.
+    $scope.queryParameters.save = function() {
+      var nameValuePairs = {};
+      angular.forEach($scope.queryParameters.map,
+                      function(copier, paramName) {
+                        copier.save(nameValuePairs, paramName);
+                      }
+                     );
+      $location.search(nameValuePairs);
+    };
+
+
+    //
     // updateResults() and friends.
     //
 
     /**
      * Set $scope.areUpdatesPending (to enable/disable the Update Results
      * button).
      *
      * TODO(epoger): We could reduce the amount of code by just setting the
      * variable directly (from, e.g., a button's ng-click handler).  But when
      * I tried that, the HTML elements depending on the variable did not get
      * updated.
      * It turns out that this is due to variable scoping within an ng-repeat
      * element; see http://stackoverflow.com/questions/15388344/behavior-of-assignment-expression-invoked-by-ng-click-within-ng-repeat
      *
      * @param val boolean value to set $scope.areUpdatesPending to
      */
     $scope.setUpdatesPending = function(val) {
       $scope.areUpdatesPending = val;
     }
 
     /**
-     * Update the displayed results, based on filters/settings.
+     * Update the displayed results, based on filters/settings,
+     * and call $scope.queryParameters.save() so that the new filter results
+     * can be bookmarked.
      */
     $scope.updateResults = function() {
       $scope.displayLimit = $scope.displayLimitPending;
       // TODO(epoger): Every time we apply a filter, AngularJS creates
       // another copy of the array.  Is there a way we can filter out
       // the items as they are displayed, rather than storing multiple
       // array copies?  (For better performance.)
 
       if ($scope.viewingTab == $scope.defaultTab) {
 
@@ skipping 22 matching lines @@
                 $filter("filter")(
                     $scope.testData,
                     {tab: $scope.viewingTab},
                     true
                 ),
                 $scope.sortColumn);
         $scope.limitedTestData = $scope.filteredTestData;
       }
       $scope.imageSize = $scope.imageSizePending;
       $scope.setUpdatesPending(false);
+      $scope.queryParameters.save();
     }
 
     /**
      * Re-sort the displayed results.
      *
      * @param sortColumn (string): name of the column to sort on
      */
     $scope.sortResultsBy = function(sortColumn) {
       $scope.sortColumn = sortColumn;
       $scope.updateResults();
@@ skipping 220 matching lines @@
      *
      * @param secondsPastEpoch (numeric): seconds past epoch in UTC
      */
     $scope.localTimeString = function(secondsPastEpoch) {
       var d = new Date(secondsPastEpoch * 1000);
       return d.toString();
     }
 
   }
 );