2 * Core Service - egHatch
4 * Dispatches print and data storage requests to the appropriate handler.
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
11 * Most handlers also provide direct remote and local variants to the
12 * application can decide to which to use as needed.
14 * Local storage requests are handled by $window.localStorage.
16 * Note that all top-level and remote requests return promises. All
17 * local requests return immediate values, since local requests are
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()
25 angular.module('egCoreMod')
28 ['$q','$window','$timeout','$interpolate','$cookies','egNet','$injector',
29 function($q , $window , $timeout , $interpolate , $cookies , egNet , $injector ) {
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;
38 // key/value cache -- avoid unnecessary Hatch extension requests.
39 // Only affects *RemoteItem calls.
40 service.keyCache = {};
42 // Keep a local copy of all retrieved setting summaries, which indicate
43 // which setting types exist for each setting.
44 service.serverSettingSummaries = {};
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.
58 service.onCallPrefixes = ['eg.workstation'];
60 // Returns true if the key can be set/get in localStorage even when
61 // Hatch is not available.
62 service.keyIsOnCall = function(key) {
64 angular.forEach(service.onCallPrefixes, function(pfx) {
65 if (key.match(new RegExp('^' + pfx)))
72 * Settings with these prefixes will always live in the browser.
74 service.browserOnlyPrefixes = [
78 'current_tag_table_marc21_biblio',
83 service.keyStoredInBrowser = function(key) {
85 if (service.disableServerSettings) {
86 // When server-side storage is disabled, treat every
87 // setting like it's stored locally.
91 var browserOnly = false;
92 service.browserOnlyPrefixes.forEach(function(pfx) {
93 if (key.match(new RegExp('^' + pfx)))
100 // write a message to the Hatch port
101 service.sendToHatch = function(msg) {
104 // shallow copy and scrub msg before sending
105 angular.forEach(msg, function(val, key) {
106 if (key.match(/deferred/)) return;
110 console.debug("sending to Hatch: " + JSON.stringify(msg2));
113 $window.postMessage(msg2, $window.location.origin);
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();
121 if (service.hatchAvailable) {
122 service.messages[msg.msgid] = msg;
123 service.sendToHatch(msg);
127 'Hatch request attempted but Hatch is not available');
128 msg.deferred.reject(msg);
131 return msg.deferred.promise;
135 // resolve the promise on the given request and remove
136 // it from our tracked requests.
137 service.resolveRequest = function(msg) {
139 if (!service.messages[msg.msgid]) {
140 console.error('no cached message for id = ' + msg.msgid);
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
149 if (msg.status == 200) {
150 msg.deferred.resolve(msg.content);
152 console.warn("Hatch command failed with status="
153 + msg.status + " and message=" + msg.message);
154 msg.deferred.reject();
158 service.openHatch = function() {
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");
167 $window.addEventListener("message", function(event) {
168 // We only accept messages from our own content script.
169 if (event.source != window) return;
171 // We only care about messages from the Hatch extension.
172 if (event.data && event.data.from == 'extension') {
174 // Avoid logging full Hatch responses. they can get large.
176 'Hatch responded to message ID ' + event.data.msgid);
178 service.resolveRequest(event.data);
182 service.hatchAvailable = true; // public flag
185 service.remotePrint = function(
186 context, contentType, content, withDialog) {
188 return service.getPrintConfig(context).then(
190 // print configuration retrieved; print
191 return service.attemptHatchDelivery({
195 contentType : contentType,
196 showDialog : withDialog,
202 service.getPrintConfig = function(context) {
203 return service.getRemoteItem('eg.print.config.' + context);
206 service.setPrintConfig = function(context, config) {
207 return service.setRemoteItem('eg.print.config.' + context, config);
210 service.getPrinterOptions = function(name) {
211 return service.attemptHatchDelivery({
212 action : 'printer-options',
217 service.getPrinters = function() {
218 if (service.printers) // cached printers
219 return $q.when(service.printers);
221 return service.attemptHatchDelivery({action : 'printers'}).then(
223 // we have remote printers; sort by name and return
225 service.printers = printers.sort(
226 function(a,b) {return a.name < b.name ? -1 : 1});
227 return service.printers;
230 // remote call failed and there is no such thing as local
231 // printers; return empty set.
232 function() { return [] }
236 // TODO: once Hatch is printing-only, should probably store
237 // this preference on the server.
238 service.usePrinting = function() {
239 return service.getLocalItem('eg.hatch.enable.printing');
242 service.useSettings = function() {
243 return service.getLocalItem('eg.hatch.enable.settings');
246 service.useOffline = function() {
247 return service.getLocalItem('eg.hatch.enable.offline');
250 // get the value for a stored item
251 service.getItem = function(key) {
253 if (!service.keyStoredInBrowser(key)) {
254 return service.getServerItem(key);
257 var deferred = $q.defer();
259 service.getBrowserItem(key).then(
260 function(val) { deferred.resolve(val); },
262 function() { // Hatch error
263 if (service.keyIsOnCall(key)) {
264 console.warn("Unable to getItem from Hatch: " + key +
265 ". Retrieving item from local storage instead");
266 deferred.resolve(service.getLocalItem(key));
269 deferred.reject("Unable to getItem from Hatch: " + key);
273 return deferred.promise;
276 // Collect values in batch.
277 // For server-stored values espeically, this is more efficient
278 // than a series of one-off calls.
279 service.getItemBatch = function(keys) {
280 var browserKeys = [];
283 // To take full advantage of the getServerItemBatch call,
284 // we have to know in advance which keys to send to the server
285 // vs those to handle in the browser.
286 keys.forEach(function(key) {
287 if (service.keyStoredInBrowser(key)) {
288 browserKeys.push(key);
290 serverKeys.push(key);
296 var serverPromise = serverKeys.length === 0 ? $q.when() :
297 service.getServerItemBatch(serverKeys).then(function(values) {
298 angular.forEach(values, function(val, key) {
303 var browserPromises = [];
304 browserKeys.forEach(function(key) {
305 browserPromises.push(
306 service.getBrowserItem(key).then(function(val) {
312 return $q.all(browserPromises.concat(serverPromise))
313 .then(function() {return settings});
316 service.getBrowserItem = function(key) {
317 if (service.useSettings()) {
318 if (service.hatchAvailable) {
319 return service.getRemoteItem(key);
322 return $q.when(service.getLocalItem(key));
327 service.getRemoteItem = function(key) {
329 if (service.keyCache[key] != undefined)
330 return $q.when(service.keyCache[key])
332 return service.attemptHatchDelivery({
335 }).then(function(content) {
336 return service.keyCache[key] = content;
340 service.getLocalItem = function(key) {
341 var val = $window.localStorage.getItem(key);
342 if (val === null || val === undefined) return;
344 return JSON.parse(val);
347 "Deleting invalid JSON for localItem: " + key + " => " + val);
348 service.removeLocalItem(key);
353 service.getLoginSessionItem = function(key) {
354 var val = $cookies.get(key);
355 if (val == null) return;
356 return JSON.parse(val);
359 service.getSessionItem = function(key) {
360 var val = $window.sessionStorage.getItem(key);
361 if (val == null) return;
362 return JSON.parse(val);
366 * @param tmp bool Store the value as a session cookie only.
367 * tmp values are removed during logout or browser close.
369 service.setItem = function(key, value) {
371 if (!service.keyStoredInBrowser(key)) {
372 return service.setServerItem(key, value);
375 var deferred = $q.defer();
376 service.setBrowserItem(key, value).then(
377 function(val) {deferred.resolve(val);},
379 function() { // Hatch error
381 if (service.keyIsOnCall(key)) {
382 console.warn("Unable to setItem in Hatch: " +
383 key + ". Setting in local storage instead");
385 deferred.resolve(service.setLocalItem(key, value));
387 deferred.reject("Unable to setItem in Hatch: " + key);
392 service.setBrowserItem = function(key, value) {
393 if (service.useSettings()) {
394 if (service.hatchAvailable) {
395 return service.setRemoteItem(key, value);
397 return $q.reject('Unable to get item from hatch');
400 return $q.when(service.setLocalItem(key, value));
404 service.setServerItem = function(key, value) {
405 if (!service.auth) service.auth = $injector.get('egAuth');
406 if (!service.auth.token()) return $q.when();
408 // If we have already attempted to retrieve a value for this
409 // setting, then we can tell up front whether applying a value
410 // at the server will be an option. If not, store locally.
411 var summary = service.serverSettingSummaries[key];
412 if (summary && !summary.has_staff_setting) {
414 if (summary.has_org_setting === 't') {
415 // When no user/ws setting types exist but an org unit
416 // setting type does, it means the value cannot be
417 // applied by an individual user. Nothing left to do.
421 // No setting types of any flavor exist.
422 // Fall back to local storage.
424 if (value === null) {
425 // a null value means clear the server setting.
426 return service.removeBrowserItem(key);
428 console.warn('No server setting type exists for ' + key);
429 return service.setBrowserItem(key, value);
434 settings[key] = value;
436 return egNet.request(
438 'open-ils.actor.settings.apply.user_or_ws',
439 service.auth.token(), settings
440 ).then(function(appliedCount) {
442 if (appliedCount == 0) {
443 console.warn('No server setting type exists for ' + key);
444 // We were unable to store the setting on the server,
445 // presumably becuase no server-side setting type exists.
446 // Add to local storage instead.
447 service.setLocalItem(key, value);
450 service.keyCache[key] = value;
455 service.getServerItem = function(key) {
456 if (key in service.keyCache) {
457 return $q.when(service.keyCache[key])
460 if (!service.auth) service.auth = $injector.get('egAuth');
461 if (!service.auth.token()) return $q.when(null);
463 return egNet.request(
465 'open-ils.actor.settings.retrieve.atomic',
466 [key], service.auth.token()
467 ).then(function(settings) {
468 return service.handleServerItemResponse(settings[0]);
472 service.handleServerItemResponse = function(summary) {
473 var key = summary.name;
474 var val = summary.value;
476 // For our purposes, we only care if a setting can be stored
477 // as an org setting or a user-or-workstation setting.
478 summary.has_staff_setting = (
479 summary.has_user_setting === 't' ||
480 summary.has_workstation_setting === 't'
483 summary.value = null; // avoid duplicate value caches
484 service.serverSettingSummaries[key] = summary;
487 // We have a server setting. Nothing left to do.
488 return $q.when(service.keyCache[key] = val);
491 if (!summary.has_staff_setting) {
493 if (summary.has_org_setting === 't') {
494 // An org unit setting type exists but no value is applied
495 // that this workstation has access to. The existence of
496 // an org unit setting type and no user/ws setting type
497 // means applying a value locally is not allowed.
498 return $q.when(service.keyCache[key] = undefined);
501 console.warn('No server setting type exists for '
502 + key + ', using local value.');
504 return service.getBrowserItem(key);
507 // A user/ws setting type exists, but no server value exists.
508 // Migrate the local setting to the server.
510 var deferred = $q.defer();
511 service.getBrowserItem(key).then(function(browserVal) {
513 if (browserVal === null || browserVal === undefined) {
514 // No local value to migrate.
515 return deferred.resolve(service.keyCache[key] = undefined);
518 // Migrate the local value to the server.
520 service.setServerItem(key, browserVal).then(
521 function(appliedCount) {
522 if (appliedCount == 1) {
523 console.info('setting ' + key + ' successfully ' +
524 'migrated to a server setting');
525 service.removeBrowserItem(key); // fire & forget
527 console.error('error migrating setting to server,'
528 + ' falling back to local value');
530 deferred.resolve(service.keyCache[key] = browserVal);
535 return deferred.promise;
538 service.getServerItemBatch = function(keys) {
539 // no cache checking for now. assumes batch mode is only
540 // called once on page load. maybe add cache checking later.
541 if (!service.auth) service.auth = $injector.get('egAuth');
542 if (!service.auth.token()) return $q.when({});
544 var foundValues = {};
545 return egNet.request(
547 'open-ils.actor.settings.retrieve',
548 keys, service.auth.token()
550 function() { return foundValues; },
553 var val = setting.value;
554 // The server returns null for undefined settings.
555 // Treat as undefined locally for backwards compat.
556 service.keyCache[setting.name] =
557 foundValues[setting.name] =
558 (val === null) ? undefined : val;
564 // set the value for a stored or new item
565 service.setRemoteItem = function(key, value) {
566 service.keyCache[key] = value;
567 return service.attemptHatchDelivery({
574 // Set the value for the given key.
575 // "Local" items persist indefinitely.
576 // If the value is raw, pass it as 'value'. If it was
577 // externally JSONified, pass it via jsonified.
578 service.setLocalItem = function(key, value, jsonified) {
579 if (jsonified === undefined ) {
580 jsonified = JSON.stringify(value);
581 } else if (value === undefined) {
584 $window.localStorage.setItem(key, jsonified);
587 service.appendItem = function(key, value) {
588 if (!service.useSettings())
589 return $q.when(service.appendLocalItem(key, value));
591 if (service.hatchAvailable)
592 return service.appendRemoteItem(key, value);
594 if (service.keyIsOnCall(key)) {
595 console.warn("Unable to appendItem in Hatch: " +
596 key + ". Setting in local storage instead");
598 return $q.when(service.appendLocalItem(key, value));
601 console.error("Unable to appendItem in Hatch: " + key);
605 // append the value to a stored or new item
606 service.appendRemoteItem = function(key, value) {
607 service.keyCache[key] = value;
608 return service.attemptHatchDelivery({
615 service.appendLocalItem = function(key, value, jsonified) {
616 if (jsonified === undefined )
617 jsonified = JSON.stringify(value);
619 var old_value = $window.localStorage.getItem(key) || '';
620 $window.localStorage.setItem( key, old_value + jsonified );
623 // Set the value for the given key.
624 // "LoginSession" items are removed when the user logs out or the
625 // browser is closed.
626 // If the value is raw, pass it as 'value'. If it was
627 // externally JSONified, pass it via jsonified.
628 service.setLoginSessionItem = function(key, value, jsonified) {
629 service.addLoginSessionKey(key);
630 if (jsonified === undefined )
631 jsonified = JSON.stringify(value);
632 $cookies.put(key, jsonified);
635 // Set the value for the given key.
636 // "Session" items are browser tab-specific and are removed when the
638 // If the value is raw, pass it as 'value'. If it was
639 // externally JSONified, pass it via jsonified.
640 service.setSessionItem = function(key, value, jsonified) {
641 if (jsonified === undefined )
642 jsonified = JSON.stringify(value);
643 $window.sessionStorage.setItem(key, jsonified);
646 // remove a stored item
647 service.removeItem = function(key) {
649 if (!service.keyStoredInBrowser(key)) {
650 return service.removeServerItem(key);
653 var deferred = $q.defer();
654 service.removeBrowserItem(key).then(
655 function(response) {deferred.resolve(response);},
656 function() { // Hatch error
658 if (service.keyIsOnCall(key)) {
659 console.warn("Unable to removeItem from Hatch: " + key +
660 ". Removing item from local storage instead");
662 deferred.resolve(service.removeLocalItem(key));
665 deferred.reject("Unable to removeItem from Hatch: " + key);
669 return deferred.promise;
672 service.removeBrowserItem = function(key) {
673 if (service.useSettings()) {
674 if (service.hatchAvailable) {
675 return service.removeRemoteItem(key);
677 return $q.reject('error talking to Hatch');
680 return $q.when(service.removeLocalItem(key));
684 service.removeServerItem = function(key) {
685 return service.setServerItem(key, null);
688 service.removeRemoteItem = function(key) {
689 delete service.keyCache[key];
690 return service.attemptHatchDelivery({
696 service.removeLocalItem = function(key) {
697 $window.localStorage.removeItem(key);
700 service.removeLoginSessionItem = function(key) {
701 service.removeLoginSessionKey(key);
702 $cookies.remove(key);
705 service.removeSessionItem = function(key) {
706 $window.sessionStorage.removeItem(key);
710 * Remove all "LoginSession" items.
712 service.clearLoginSessionItems = function() {
713 angular.forEach(service.getLoginSessionKeys(), function(key) {
714 service.removeLoginSessionItem(key);
717 // remove the keys cache.
718 service.removeLocalItem('eg.hatch.login_keys');
721 // if set, prefix limits the return set to keys starting with 'prefix'
722 service.getKeys = function(prefix) {
723 var promise = service.getServerKeys(prefix);
724 return service.getBrowserKeys(prefix).then(function(browserKeys) {
725 return promise.then(function(serverKeys) {
726 return serverKeys.concat(browserKeys);
731 service.getRemoteKeys = function(prefix) {
732 return service.attemptHatchDelivery({
738 service.getBrowserKeys = function(prefix) {
739 if (service.useSettings())
740 return service.getRemoteKeys(prefix);
741 return $q.when(service.getLocalKeys(prefix));
744 service.getServerKeys = function(prefix, options) {
745 if (!service.auth) service.auth = $injector.get('egAuth');
746 if (!service.auth.token()) return $q.when({});
747 return egNet.request(
749 'open-ils.actor.settings.staff.applied.names.authoritative.atomic',
750 service.auth.token(), prefix, options
754 service.getLocalKeys = function(prefix) {
757 while ( (k = $window.localStorage.key(idx++)) !== null) {
758 // key prefix match test
759 if (prefix && k.substr(0, prefix.length) != prefix) continue;
767 * Array of "LoginSession" keys.
768 * Note we have to store these as "Local" items so browser tabs can
769 * share them. We could store them as cookies, but it's more data
770 * that has to go back/forth to the server. A "LoginSession" key name is
771 * not private, though, so it's OK if they are left in localStorage
772 * until the next login.
774 service.getLoginSessionKeys = function(prefix) {
777 var login_keys = service.getLocalItem('eg.hatch.login_keys') || [];
778 angular.forEach(login_keys, function(k) {
779 // key prefix match test
780 if (prefix && k.substr(0, prefix.length) != prefix) return;
786 service.addLoginSessionKey = function(key) {
787 var keys = service.getLoginSessionKeys();
788 if (keys.indexOf(key) < 0) {
790 service.setLocalItem('eg.hatch.login_keys', keys);
794 service.removeLoginSessionKey = function(key) {
795 var keys = service.getLoginSessionKeys().filter(function(k) {
798 service.setLocalItem('eg.hatch.login_keys', keys);
801 // Copy all stored settings from localStorage to Hatch.
802 // If 'move' is true, delete the local settings once cloned.
803 service.copySettingsToHatch = function(move) {
804 var deferred = $q.defer();
805 var keys = service.getLocalKeys();
807 angular.forEach(keys, function(key) {
809 // Hatch keys are local-only
810 if (key.match(/^eg.hatch/)) return;
812 console.debug("Copying to Hatch Storage: " + key);
813 service.setRemoteItem(key, service.getLocalItem(key))
814 .then(function() { // key successfully cloned.
816 // delete the local copy if requested.
817 if (move) service.removeLocalItem(key);
819 // resolve the promise after processing the last key.
820 if (key == keys[keys.length-1])
825 return deferred.promise;
828 // Copy all stored settings from Hatch to localStorage.
829 // If 'move' is true, delete the Hatch settings once cloned.
830 service.copySettingsToLocal = function(move) {
831 var deferred = $q.defer();
833 service.getRemoteKeys().then(function(keys) {
834 angular.forEach(keys, function(key) {
835 service.getRemoteItem(key).then(function(val) {
837 console.debug("Copying to Local Storage: " + key);
838 service.setLocalItem(key, val);
840 // delete the remote copy if requested.
841 if (move) service.removeRemoteItem(key);
843 // resolve the promise after processing the last key.
844 if (key == keys[keys.length-1])
850 return deferred.promise;
853 // The only requirement for opening Hatch is that the DOM be loaded.
854 // Open the connection now so its state will be immediately available.