Open-ILS/web/js/ui/default/staff/services/hatch.js

   1 /**
   2  * Core Service - egHatch
   3  *
   4  * Dispatches print and data storage requests to the appropriate handler.
   5  *
   6  * If Hatch is configured to honor the request -- current request types
   7  * are 'settings', 'offline', and 'printing' -- the request will be
   8  * relayed to the Hatch service.  Otherwise, the request is handled
   9  * locally.
  10  *
  11  * Most handlers also provide direct remote and local variants to the
  12  * application can decide to which to use as needed.
  13  *
  14  * Local storage requests are handled by $window.localStorage.
  15  *
  16  * Note that all top-level and remote requests return promises.  All
  17  * local requests return immediate values, since local requests are
  18  * never asynchronous.
  19  *
  20  * BEWARE: never store "fieldmapper" objects, since their structure
  21  * may change over time as the IDL changes.  Always flatten objects
  22  * into key/value pairs before calling set*Item()
  23  *
  24  */
  25 angular.module('egCoreMod')
  26
  27 .factory('egHatch',
  28            ['$q','$window','$timeout','$interpolate','$cookies','egNet','$injector',
  29     function($q , $window , $timeout , $interpolate , $cookies , egNet , $injector ) {
  30
  31     var service = {};
  32     service.msgId = 1;
  33     service.messages = {};
  34     service.hatchAvailable = false;
  35     service.auth = null;  // ref to egAuth loaded on-demand to avoid circular ref.
  36     service.disableServerSettings = false;
  37
  38     // key/value cache -- avoid unnecessary Hatch extension requests.
  39     // Only affects *RemoteItem calls.
  40     service.keyCache = {};
  41
  42     // Keep a local copy of all retrieved setting summaries, which indicate
  43     // which setting types exist for each setting.
  44     service.serverSettingSummaries = {};
  45
  46     /**
  47      * List string prefixes for On-Call storage keys. On-Call keys
  48      * are those that can be set/get/remove'd from localStorage when
  49      * Hatch is not avaialable, even though Hatch is configured as the
  50      * primary storage location for the key in question.  On-Call keys
  51      * are those that allow the user to login and perform basic admin
  52      * tasks (like disabling Hatch) even when Hatch is down.
  53      * AKA Browser Staff Run Level 3.
  54      * Note that no attempt is made to synchronize data between Hatch
  55      * and localStorage for On-Call keys.  Only one destation is active
  56      * at a time and each maintains its own data separately.
  57      */
  58     service.onCallPrefixes = ['eg.workstation'];
  59
  60     // Returns true if the key can be set/get in localStorage even when
  61     // Hatch is not available.
  62     service.keyIsOnCall = function(key) {
  63         var oncall = false;
  64         angular.forEach(service.onCallPrefixes, function(pfx) {
  65             if (key.match(new RegExp('^' + pfx)))
  66                 oncall = true;
  67         });
  68         return oncall;
  69     }
  70
  71     /**
  72      * Settings with these prefixes will always live in the browser.
  73      */
  74     service.browserOnlyPrefixes = [
  75         'eg.workstation',
  76         'eg.hatch',
  77         'eg.cache',
  78         'current_tag_table_marc21_biblio',
  79         'FFPosTable_REC',
  80         'FFValueTable_REC'
  81     ];
  82
  83     service.keyStoredInBrowser = function(key) {
  84
  85         if (service.disableServerSettings) {
  86             // When server-side storage is disabled, treat every
  87             // setting like it's stored locally.
  88             return true;
  89         }
  90
  91         var browserOnly = false;
  92         service.browserOnlyPrefixes.forEach(function(pfx) {
  93             if (key.match(new RegExp('^' + pfx)))
  94                 browserOnly = true;
  95         });
  96
  97         return browserOnly;
  98     }
  99
 100     // write a message to the Hatch port
 101     service.sendToHatch = function(msg) {
 102         var msg2 = {};
 103
 104         // shallow copy and scrub msg before sending
 105         angular.forEach(msg, function(val, key) {
 106             if (key.match(/deferred/)) return;
 107             msg2[key] = val;
 108         });
 109
 110         console.debug("sending to Hatch: " + JSON.stringify(msg2));
 111
 112         msg2.from = 'page';
 113         $window.postMessage(msg2, $window.location.origin);
 114     }
 115
 116     // Send request to Hatch or reject if Hatch is unavailable
 117     service.attemptHatchDelivery = function(msg) {
 118         msg.msgid = service.msgId++;
 119         msg.deferred = $q.defer();
 120
 121         if (service.hatchAvailable) {
 122             service.messages[msg.msgid] = msg;
 123             service.sendToHatch(msg);
 124
 125         } else {
 126             console.error(
 127                 'Hatch request attempted but Hatch is not available');
 128             msg.deferred.reject(msg);
 129         }
 130
 131         return msg.deferred.promise;
 132     }
 133
 134
 135     // resolve the promise on the given request and remove
 136     // it from our tracked requests.
 137     service.resolveRequest = function(msg) {
 138
 139         if (!service.messages[msg.msgid]) {
 140             console.error('no cached message for id = ' + msg.msgid);
 141             return;
 142         }
 143
 144         // for requests sent through Hatch, only the cached
 145         // request will have the original promise attached
 146         msg.deferred = service.messages[msg.msgid].deferred;
 147         delete service.messages[msg.msgid]; // un-cache
 148
 149         if (msg.status == 200) {
 150             msg.deferred.resolve(msg.content);
 151         } else {
 152             console.warn("Hatch command failed with status="
 153                 + msg.status + " and message=" + msg.message);
 154             msg.deferred.reject();
 155         }
 156     }
 157
 158     service.openHatch = function() {
 159
 160         // When the Hatch extension loads, it tacks an attribute onto
 161         // the top-level documentElement to indicate it's available.
 162         if (!$window.document.documentElement.getAttribute('hatch-is-open')) {
 163             //console.debug("Hatch is not available");
 164             return;
 165         }
 166
 167         $window.addEventListener("message", function(event) {
 168             // We only accept messages from our own content script.
 169             if (event.source != window) return;
 170
 171             // We only care about messages from the Hatch extension.
 172             if (event.data && event.data.from == 'extension') {
 173
 174                 // Avoid logging full Hatch responses. they can get large.
 175                 console.debug(
 176                     'Hatch responded to message ID ' + event.data.msgid);
 177
 178                 service.resolveRequest(event.data);
 179             }
 180         });
 181
 182         service.hatchAvailable = true; // public flag
 183     }
 184
 185     service.remotePrint = function(
 186         context, contentType, content, withDialog) {
 187
 188         return service.getPrintConfig(context).then(
 189             function(config) {
 190                 // print configuration retrieved; print
 191                 return service.attemptHatchDelivery({
 192                     action : 'print',
 193                     settings : config,
 194                     content : content,
 195                     contentType : contentType,
 196                     showDialog : withDialog,
 197                 });
 198             }
 199         );
 200     }
 201
 202     service.getPrintConfig = function(context) {
 203         return service.getRemoteItem('eg.print.config.' + context);
 204     }
 205
 206     service.setPrintConfig = function(context, config) {
 207         return service.setRemoteItem('eg.print.config.' + context, config);
 208     }
 209
 210     service.getPrinterOptions = function(name) {
 211         return service.attemptHatchDelivery({
 212             action : 'printer-options',
 213             printer : name
 214         });
 215     }
 216
 217     service.getPrinters = function() {
 218         if (service.printers) // cached printers
 219             return $q.when(service.printers);
 220
 221         return service.attemptHatchDelivery({action : 'printers'}).then(
 222
 223             // we have remote printers; sort by name and return
 224             function(printers) {
 225                 service.printers = printers.sort(
 226                     function(a,b) {return a.name < b.name ? -1 : 1});
 227                 return service.printers;
 228             },
 229
 230             // remote call failed and there is no such thing as local
 231             // printers; return empty set.
 232             function() { return [] }
 233         );
 234     }
 235
 236     service.usePrinting = function() {
 237         return service.getLocalItem('eg.hatch.enable.printing');
 238     }
 239
 240     service.useSettings = function() {
 241         return service.getLocalItem('eg.hatch.enable.settings');
 242     }
 243
 244     service.useOffline = function() {
 245         return service.getLocalItem('eg.hatch.enable.offline');
 246     }
 247
 248     // get the value for a stored item
 249     service.getItem = function(key) {
 250
 251         if (!service.keyStoredInBrowser(key)) {
 252             return service.getServerItem(key);
 253         }
 254
 255         var deferred = $q.defer();
 256
 257         service.getBrowserItem(key).then(
 258             function(val) { deferred.resolve(val); },
 259
 260             function() { // Hatch error
 261                 if (service.keyIsOnCall(key)) {
 262                     console.warn("Unable to getItem from Hatch: " + key +
 263                         ". Retrieving item from local storage instead");
 264                     deferred.resolve(service.getLocalItem(key));
 265                 }
 266
 267                 deferred.reject("Unable to getItem from Hatch: " + key);
 268             }
 269         );
 270
 271         return deferred.promise;
 272     }
 273
 274     service.getBrowserItem = function(key) {
 275         if (service.useSettings()) {
 276             if (service.hatchAvailable) {
 277                 return service.getRemoteItem(key);
 278             }
 279         } else {
 280             return $q.when(service.getLocalItem(key));
 281         }
 282         return $q.reject();
 283     }
 284
 285     service.getRemoteItem = function(key) {
 286
 287         if (service.keyCache[key] != undefined)
 288             return $q.when(service.keyCache[key])
 289
 290         return service.attemptHatchDelivery({
 291             key : key,
 292             action : 'get'
 293         }).then(function(content) {
 294             return service.keyCache[key] = content;
 295         });
 296     }
 297
 298     service.getLocalItem = function(key) {
 299         var val = $window.localStorage.getItem(key);
 300         if (val === null || val === undefined) return;
 301         try {
 302             return JSON.parse(val);
 303         } catch(E) {
 304             console.error(
 305                 "Deleting invalid JSON for localItem: " + key + " => " + val);
 306             service.removeLocalItem(key);
 307             return null;
 308         }
 309     }
 310
 311     service.getLoginSessionItem = function(key) {
 312         var val = $cookies.get(key);
 313         if (val == null) return;
 314         return JSON.parse(val);
 315     }
 316
 317     service.getSessionItem = function(key) {
 318         var val = $window.sessionStorage.getItem(key);
 319         if (val == null) return;
 320         return JSON.parse(val);
 321     }
 322
 323     /**
 324      * @param tmp bool Store the value as a session cookie only.
 325      * tmp values are removed during logout or browser close.
 326      */
 327     service.setItem = function(key, value) {
 328
 329         if (!service.keyStoredInBrowser(key)) {
 330             return service.setServerItem(key, value);
 331         }
 332
 333         var deferred = $q.defer();
 334         service.setBrowserItem(key, value).then(
 335             function(val) {deferred.resolve(val);},
 336
 337             function() { // Hatch error
 338
 339                 if (service.keyIsOnCall(key)) {
 340                     console.warn("Unable to setItem in Hatch: " +
 341                         key + ". Setting in local storage instead");
 342
 343                     deferred.resolve(service.setLocalItem(key, value));
 344                 }
 345                 deferred.reject("Unable to setItem in Hatch: " + key);
 346             }
 347         );
 348     }
 349
 350     service.setBrowserItem = function(key, value) {
 351         if (service.useSettings()) {
 352             if (service.hatchAvailable) {
 353                 return service.setRemoteItem(key, value);
 354             } else {
 355                 return $q.reject('Unable to get item from hatch');
 356             }
 357         } else {
 358             return $q.when(service.setLocalItem(key, value));
 359         }
 360     }
 361
 362     service.setServerItem = function(key, value) {
 363         if (!service.auth) service.auth = $injector.get('egAuth');
 364         if (!service.auth.token()) return $q.when();
 365
 366         // If we have already attempted to retrieve a value for this
 367         // setting, then we can tell up front whether applying a value
 368         // at the server will be an option.  If not, store locally.
 369         var summary = service.serverSettingSummaries[key];
 370         if (summary && !summary.has_staff_setting) {
 371
 372             if (summary.has_org_setting === 't') {
 373                 // When no user/ws setting types exist but an org unit
 374                 // setting type does, it means the value cannot be
 375                 // applied by an individual user.  Nothing left to do.
 376                 return $q.when();
 377             }
 378
 379             // No setting types of any flavor exist.
 380             // Fall back to local storage.
 381
 382             if (value === null) {
 383                 // a null value means clear the server setting.
 384                 return service.removeBrowserItem(key);
 385             } else {
 386                 console.warn('No server setting type exists for ' + key);
 387                 return service.setBrowserItem(key, value);
 388             }
 389         }
 390
 391         var settings = {};
 392         settings[key] = value;
 393
 394         return egNet.request(
 395             'open-ils.actor',
 396             'open-ils.actor.settings.apply.user_or_ws',
 397             service.auth.token(), settings
 398         ).then(function(appliedCount) {
 399
 400             if (appliedCount == 0) {
 401                 console.warn('No server setting type exists for ' + key);
 402                 // We were unable to store the setting on the server,
 403                 // presumably becuase no server-side setting type exists.
 404                 // Add to local storage instead.
 405                 service.setLocalItem(key, value);
 406             }
 407
 408             service.keyCache[key] = value;
 409             return appliedCount;
 410         });
 411     }
 412
 413     service.getServerItem = function(key) {
 414         if (key in service.keyCache) {
 415             return $q.when(service.keyCache[key])
 416         }
 417
 418         if (!service.auth) service.auth = $injector.get('egAuth');
 419         if (!service.auth.token()) return $q.when(null);
 420
 421         return egNet.request(
 422             'open-ils.actor',
 423             'open-ils.actor.settings.retrieve.atomic',
 424             [key], service.auth.token()
 425         ).then(function(settings) {
 426             return service.handleServerItemResponse(settings[0]);
 427         });
 428     }
 429
 430     service.handleServerItemResponse = function(summary) {
 431         var key = summary.name;
 432         var val = summary.value;
 433
 434         // For our purposes, we only care if a setting can be stored
 435         // as an org setting or a user-or-workstation setting.
 436         summary.has_staff_setting = (
 437             summary.has_user_setting === 't' ||
 438             summary.has_workstation_setting === 't'
 439         );
 440
 441         summary.value = null; // avoid duplicate value caches
 442         service.serverSettingSummaries[key] = summary;
 443
 444         if (val !== null) {
 445             // We have a server setting.  Nothing left to do.
 446             return $q.when(service.keyCache[key] = val);
 447         }
 448
 449         if (!summary.has_staff_setting) {
 450
 451             if (summary.has_org_setting === 't') {
 452                 // An org unit setting type exists but no value is applied
 453                 // that this workstation has access to.  The existence of
 454                 // an org unit setting type and no user/ws setting type
 455                 // means applying a value locally is not allowed.
 456                 return $q.when(service.keyCache[key] = undefined);
 457             }
 458
 459             console.warn('No server setting type exists for '
 460                 + key + ', using local value.');
 461
 462             return service.getBrowserItem(key);
 463         }
 464
 465         // A user/ws setting type exists, but no server value exists.
 466         // Migrate the local setting to the server.
 467
 468         var deferred = $q.defer();
 469         service.getBrowserItem(key).then(function(browserVal) {
 470
 471             if (browserVal === null || browserVal === undefined) {
 472                 // No local value to migrate.
 473                 return deferred.resolve(service.keyCache[key] = undefined);
 474             }
 475
 476             // Migrate the local value to the server.
 477
 478             service.setServerItem(key, browserVal).then(
 479                 function(appliedCount) {
 480                     if (appliedCount == 1) {
 481                         console.info('setting ' + key + ' successfully ' +
 482                             'migrated to a server setting');
 483                         service.removeBrowserItem(key); // fire & forget
 484                     } else {
 485                         console.error('error migrating setting to server,'
 486                             + ' falling back to local value');
 487                     }
 488                     deferred.resolve(service.keyCache[key] = browserVal);
 489                 }
 490             );
 491         });
 492
 493         return deferred.promise;
 494     }
 495
 496     service.getServerItemBatch = function(keys) {
 497         // no cache checking for now.  assumes batch mode is only
 498         // called once on page load.  maybe add cache checking later.
 499         if (!service.auth) service.auth = $injector.get('egAuth');
 500         if (!service.auth.token()) return $q.when({});
 501
 502         var foundValues = {};
 503         return egNet.request(
 504             'open-ils.actor',
 505             'open-ils.actor.settings.retrieve',
 506             keys, service.auth.token()
 507         ).then(
 508             function() { return foundValues; },
 509             function() {},
 510             function(setting) {
 511                 var val = setting.value();
 512                 // The server returns null for undefined settings.
 513                 // Treat as undefined locally for backwards compat.
 514                 service.keyCache[setting.name()] =
 515                     foundValues[setting.name()] =
 516                     (val === null) ? undefined : val;
 517             }
 518         );
 519     }
 520
 521
 522     // set the value for a stored or new item
 523     service.setRemoteItem = function(key, value) {
 524         service.keyCache[key] = value;
 525         return service.attemptHatchDelivery({
 526             key : key,
 527             content : value,
 528             action : 'set',
 529         });
 530     }
 531
 532     // Set the value for the given key.
 533     // "Local" items persist indefinitely.
 534     // If the value is raw, pass it as 'value'.  If it was
 535     // externally JSONified, pass it via jsonified.
 536     service.setLocalItem = function(key, value, jsonified) {
 537         if (jsonified === undefined ) {
 538             jsonified = JSON.stringify(value);
 539         } else if (value === undefined) {
 540             return;
 541         }
 542         $window.localStorage.setItem(key, jsonified);
 543     }
 544
 545     service.appendItem = function(key, value) {
 546         if (!service.useSettings())
 547             return $q.when(service.appendLocalItem(key, value));
 548
 549         if (service.hatchAvailable)
 550             return service.appendRemoteItem(key, value);
 551
 552         if (service.keyIsOnCall(key)) {
 553             console.warn("Unable to appendItem in Hatch: " +
 554                 key + ". Setting in local storage instead");
 555
 556             return $q.when(service.appendLocalItem(key, value));
 557         }
 558
 559         console.error("Unable to appendItem in Hatch: " + key);
 560         return $q.reject();
 561     }
 562
 563     // append the value to a stored or new item
 564     service.appendRemoteItem = function(key, value) {
 565         service.keyCache[key] = value;
 566         return service.attemptHatchDelivery({
 567             key : key,
 568             content : value,
 569             action : 'append',
 570         });
 571     }
 572
 573     service.appendLocalItem = function(key, value, jsonified) {
 574         if (jsonified === undefined )
 575             jsonified = JSON.stringify(value);
 576
 577         var old_value = $window.localStorage.getItem(key) || '';
 578         $window.localStorage.setItem( key, old_value + jsonified );
 579     }
 580
 581     // Set the value for the given key.
 582     // "LoginSession" items are removed when the user logs out or the
 583     // browser is closed.
 584     // If the value is raw, pass it as 'value'.  If it was
 585     // externally JSONified, pass it via jsonified.
 586     service.setLoginSessionItem = function(key, value, jsonified) {
 587         service.addLoginSessionKey(key);
 588         if (jsonified === undefined )
 589             jsonified = JSON.stringify(value);
 590         $cookies.put(key, jsonified);
 591     }
 592
 593     // Set the value for the given key.
 594     // "Session" items are browser tab-specific and are removed when the
 595     // tab is closed.
 596     // If the value is raw, pass it as 'value'.  If it was
 597     // externally JSONified, pass it via jsonified.
 598     service.setSessionItem = function(key, value, jsonified) {
 599         if (jsonified === undefined )
 600             jsonified = JSON.stringify(value);
 601         $window.sessionStorage.setItem(key, jsonified);
 602     }
 603
 604     // remove a stored item
 605     service.removeItem = function(key) {
 606
 607         if (!service.keyStoredInBrowser(key)) {
 608             return service.removeServerItem(key);
 609         }
 610
 611         var deferred = $q.defer();
 612         service.removeBrowserItem(key).then(
 613             function(response) {deferred.resolve(response);},
 614             function() { // Hatch error
 615
 616                 if (service.keyIsOnCall(key)) {
 617                     console.warn("Unable to removeItem from Hatch: " + key +
 618                         ". Removing item from local storage instead");
 619
 620                     deferred.resolve(service.removeLocalItem(key));
 621                 }
 622
 623                 deferred.reject("Unable to removeItem from Hatch: " + key);
 624             }
 625         );
 626
 627         return deferred.promise;
 628     }
 629
 630     service.removeBrowserItem = function(key) {
 631         if (service.useSettings()) {
 632             if (service.hatchAvailable) {
 633                 return service.removeRemoteItem(key);
 634             } else {
 635                 return $q.reject('error talking to Hatch');
 636             }
 637         } else {
 638             return $q.when(service.removeLocalItem(key));
 639         }
 640     }
 641
 642     service.removeServerItem = function(key) {
 643         return service.setServerItem(key, null);
 644     }
 645
 646     service.removeRemoteItem = function(key) {
 647         delete service.keyCache[key];
 648         return service.attemptHatchDelivery({
 649             key : key,
 650             action : 'remove'
 651         });
 652     }
 653
 654     service.removeLocalItem = function(key) {
 655         $window.localStorage.removeItem(key);
 656     }
 657
 658     service.removeLoginSessionItem = function(key) {
 659         service.removeLoginSessionKey(key);
 660         $cookies.remove(key);
 661     }
 662
 663     service.removeSessionItem = function(key) {
 664         $window.sessionStorage.removeItem(key);
 665     }
 666
 667     /**
 668      * Remove all "LoginSession" items.
 669      */
 670     service.clearLoginSessionItems = function() {
 671         angular.forEach(service.getLoginSessionKeys(), function(key) {
 672             service.removeLoginSessionItem(key);
 673         });
 674
 675         // remove the keys cache.
 676         service.removeLocalItem('eg.hatch.login_keys');
 677     }
 678
 679     // if set, prefix limits the return set to keys starting with 'prefix'
 680     service.getKeys = function(prefix) {
 681         if (service.useSettings())
 682             return service.getRemoteKeys(prefix);
 683         return $q.when(service.getLocalKeys(prefix));
 684     }
 685
 686     service.getRemoteKeys = function(prefix) {
 687         return service.attemptHatchDelivery({
 688             key : prefix,
 689             action : 'keys'
 690         });
 691     }
 692
 693     service.getServerKeys = function(prefix) {
 694         var keys = [];
 695         var idx = 0;
 696         service.serverSettings.forEach(function(k) {
 697             // key prefix match test
 698             if (prefix && k.substr(0, prefix.length) != prefix) {
 699                 return;
 700             }
 701             keys.push(k);
 702         });
 703         // these may eventually come from the server, so return a promise.
 704         return $q.when(keys);
 705     }
 706
 707     service.getLocalKeys = function(prefix) {
 708         var keys = [];
 709         var idx = 0;
 710         while ( (k = $window.localStorage.key(idx++)) !== null) {
 711             // key prefix match test
 712             if (prefix && k.substr(0, prefix.length) != prefix) continue;
 713             keys.push(k);
 714         }
 715         return keys;
 716     }
 717
 718
 719     /**
 720      * Array of "LoginSession" keys.
 721      * Note we have to store these as "Local" items so browser tabs can
 722      * share them.  We could store them as cookies, but it's more data
 723      * that has to go back/forth to the server.  A "LoginSession" key name is
 724      * not private, though, so it's OK if they are left in localStorage
 725      * until the next login.
 726      */
 727     service.getLoginSessionKeys = function(prefix) {
 728         var keys = [];
 729         var idx = 0;
 730         var login_keys = service.getLocalItem('eg.hatch.login_keys') || [];
 731         angular.forEach(login_keys, function(k) {
 732             // key prefix match test
 733             if (prefix && k.substr(0, prefix.length) != prefix) return;
 734             keys.push(k);
 735         });
 736         return keys;
 737     }
 738
 739     service.addLoginSessionKey = function(key) {
 740         var keys = service.getLoginSessionKeys();
 741         if (keys.indexOf(key) < 0) {
 742             keys.push(key);
 743             service.setLocalItem('eg.hatch.login_keys', keys);
 744         }
 745     }
 746
 747     service.removeLoginSessionKey = function(key) {
 748         var keys = service.getLoginSessionKeys().filter(function(k) {
 749             return k != key;
 750         });
 751         service.setLocalItem('eg.hatch.login_keys', keys);
 752     }
 753
 754     // Copy all stored settings from localStorage to Hatch.
 755     // If 'move' is true, delete the local settings once cloned.
 756     service.copySettingsToHatch = function(move) {
 757         var deferred = $q.defer();
 758         var keys = service.getLocalKeys();
 759
 760         angular.forEach(keys, function(key) {
 761
 762             // Hatch keys are local-only
 763             if (key.match(/^eg.hatch/)) return;
 764
 765             console.debug("Copying to Hatch Storage: " + key);
 766             service.setRemoteItem(key, service.getLocalItem(key))
 767             .then(function() { // key successfully cloned.
 768
 769                 // delete the local copy if requested.
 770                 if (move) service.removeLocalItem(key);
 771
 772                 // resolve the promise after processing the last key.
 773                 if (key == keys[keys.length-1])
 774                     deferred.resolve();
 775             });
 776         });
 777
 778         return deferred.promise;
 779     }
 780
 781     // Copy all stored settings from Hatch to localStorage.
 782     // If 'move' is true, delete the Hatch settings once cloned.
 783     service.copySettingsToLocal = function(move) {
 784         var deferred = $q.defer();
 785
 786         service.getRemoteKeys().then(function(keys) {
 787             angular.forEach(keys, function(key) {
 788                 service.getRemoteItem(key).then(function(val) {
 789
 790                     console.debug("Copying to Local Storage: " + key);
 791                     service.setLocalItem(key, val);
 792
 793                     // delete the remote copy if requested.
 794                     if (move) service.removeRemoteItem(key);
 795
 796                     // resolve the promise after processing the last key.
 797                     if (key == keys[keys.length-1])
 798                         deferred.resolve();
 799                 });
 800             });
 801         });
 802
 803         return deferred.promise;
 804     }
 805
 806     // The only requirement for opening Hatch is that the DOM be loaded.
 807     // Open the connection now so its state will be immediately available.
 808     service.openHatch();
 809
 810     return service;
 811 }])
 812