Open-ILS/web/js/ui/default/opac/ebook_api/loggedin.js

   1 /*
   2  * variables defined in base_js.tt2:
   3  *
   4  * ou
   5  * vendor_list = [ 'ebook_test' ]
   6  * authtoken
   7  * patron_id (barcode)
   8  * myopac_page
   9  * progress_icon (probably not done right)
  10  *
  11  * base_js.tt2 also "imports" dojo.cookie and a bunch of ebook_api JS
  12  */
  13
  14 // Array of objects representing this patron's relationship with a specific vendor.
  15 var relations = [];
  16
  17 // Transaction cache.
  18 var xacts = {
  19     checkouts: [],
  20     holds_pending: [],
  21     holds_ready: []
  22 };
  23 var ebooks = [];
  24
  25 // Ebook to perform actions on.
  26 var active_ebook;
  27 if (typeof ebook_action.title_id !== 'undefined') {
  28     active_ebook = new Ebook(ebook_action.vendor, ebook_action.title_id);
  29 }
  30
  31 dojo.addOnLoad(function() {
  32
  33     dojo.forEach(vendor_list, function(v) {
  34         var rel = new Relation(v, patron_id);
  35         relations.push(rel);
  36     });
  37
  38     // Pull patron transaction info from cache (cookie), if available.
  39     // Otherwise, do a live lookup against all enabled vendors.
  40     if (dojo.cookie('ebook_xact_cache')) {
  41         getCachedTransactions();
  42         addTotalsToPage();
  43         addTransactionsToPage();
  44     } else {
  45         console.log('retrieving patron transaction info for all vendors');
  46         dojo.forEach(relations, function(rel) {
  47             checkSession(rel.vendor, function(ses) {
  48                 rel.getTransactions( function(r) {
  49                     addTransactionsToCache(r);
  50                 });
  51             });
  52         });
  53     }
  54
  55 });
  56
  57 // Update current page with cross-vendor transaction totals.
  58 function addTotalsToPage() {
  59     console.log('updating page with transaction totals');
  60     updateDashboard();
  61     updateMyAccountSummary();
  62 }
  63
  64 // Update current page with detailed transaction info, where appropriate.
  65 function addTransactionsToPage() {
  66     // ensure active ebook has access to session ID to avoid scoping issues during transactions
  67     if (active_ebook && typeof active_ebook.vendor !== 'undefined') {
  68         active_ebook.ses = active_ebook.ses || dojo.cookie(active_ebook.vendor);
  69     }
  70     dojo.addClass('ebook_spinner', "hidden");
  71     if (myopac_page) {
  72         console.log('updating page with cached transaction details, if applicable');
  73         if (myopac_page === 'ebook_circs')
  74             updateCheckoutView();
  75         if (myopac_page === 'ebook_holds')
  76             updateHoldView();
  77         if (myopac_page === 'ebook_holds_ready')
  78             updateHoldView();
  79         if (myopac_page === 'ebook_checkout')
  80             getReadyForCheckout();
  81         if (myopac_page === 'ebook_place_hold')
  82             getReadyForHold();
  83     }
  84 }
  85
  86 function updateDashboard() {
  87     console.log('updating dashboard');
  88     var total_checkouts = (typeof xacts.checkouts === 'undefined') ? '-' : xacts.checkouts.length;
  89     var total_holds_pending = (typeof xacts.holds_pending === 'undefined') ? '-' : xacts.holds_pending.length;
  90     var total_holds_ready = (typeof xacts.holds_ready === 'undefined') ? '-' : xacts.holds_ready.length;
  91     // update totals
  92     dojo.byId('dash_e_checked').innerHTML = total_checkouts;
  93     dojo.byId('dash_e_holds').innerHTML = total_holds_pending;
  94     dojo.byId('dash_e_pickup').innerHTML = total_holds_ready;
  95     // unhide ebook dashboard
  96     dojo.removeClass('dashboard_e', "hidden");
  97 }
  98
  99 function updateMyAccountSummary() {
 100     if (myopac_page === 'main') {
 101         console.log('updating account summary');
 102         var total_checkouts = (typeof xacts.checkouts === 'undefined') ? '-' : xacts.checkouts.length;
 103         var total_holds_pending = (typeof xacts.holds_pending === 'undefined') ? '-' : xacts.holds_pending.length;
 104         var total_holds_ready = (typeof xacts.holds_ready === 'undefined') ? '-' : xacts.holds_ready.length;
 105         // update totals
 106         dojo.byId('acct_sum_ebook_circ_total').innerHTML = total_checkouts;
 107         dojo.byId('acct_sum_ebook_hold_total').innerHTML = total_holds_pending;
 108         dojo.byId('acct_sum_ebook_hold_ready_total').innerHTML = total_holds_ready;
 109         // unhide display elements
 110         dojo.removeClass('acct_sum_ebook_circs', "hidden");
 111         dojo.removeClass('acct_sum_ebook_holds', "hidden");
 112         dojo.removeClass('acct_sum_ebook_holds_ready', "hidden");
 113     }
 114 }
 115
 116 function updateCheckoutView() {
 117     if (xacts.checkouts.length < 1) {
 118         dojo.removeClass('no_ebook_circs', "hidden");
 119     } else {
 120         dojo.empty('ebook_circs_main_table_body');
 121         dojo.forEach(xacts.checkouts, function(x) {
 122             var ebook = new Ebook(x.vendor, x.title_id);
 123             var tr = dojo.create("tr", null, dojo.byId('ebook_circs_main_table_body'));
 124             dojo.create("td", { innerHTML: x.title }, tr);
 125             dojo.create("td", { innerHTML: x.author }, tr);
 126             dojo.create("td", { innerHTML: x.due_date }, tr);
 127             var dl_td = dojo.create("td", null, tr);
 128             if (x.download_url) {
 129                 dl_td.innerHTML = '<a href="' + x.download_url + '">' + l_strings.download + '</a>';
 130             }
 131             if (x.formats) {
 132                 var select = dojo.create("select", { id: "download-format" }, dl_td);
 133                 for (f in x.formats) {
 134                     dojo.create("option", { value: x.formats[f], innerHTML: f }, select);
 135                 }
 136                 var button = dojo.create("input", { id: "download-button", type: "button", value: l_strings.download }, dl_td);
 137                 ebook.conns.download = dojo.connect(button, 'onclick', ebook, "download");
 138             }
 139             // TODO: more actions (renew, checkin)
 140             ebooks.push(ebook);
 141         });
 142         dojo.addClass('no_ebook_circs', "hidden");
 143         dojo.removeClass('ebook_circs_main', "hidden");
 144     }
 145 }
 146
 147 function updateHoldView() {
 148     if (myopac_page === 'ebook_holds_ready') {
 149         // only show holds that are ready for checkout
 150         var holds = xacts.holds_ready;
 151     } else {
 152         var holds_pending = xacts.holds_pending;
 153         var holds_ready = xacts.holds_ready;
 154
 155         // combine all holds into a single list, ready-for-checkout holds first
 156         var holds = holds_ready.concat(holds_pending);
 157     }
 158
 159     if (holds.length < 1) {
 160         dojo.removeClass('no_ebook_holds', "hidden");
 161     } else {
 162         dojo.empty('ebook_holds_main_table_body');
 163         dojo.forEach(holds, function(h) {
 164             var hold_status;
 165             if (h.is_ready) {
 166                 hold_status = l_strings.ready_for_checkout;
 167             } else if (h.is_frozen) {
 168                 hold_status = l_strings.suspended;
 169             } else {
 170                 hold_status = h.queue_position + ' / ' + h.queue_size;
 171             }
 172             h.doCancelHold = function() {
 173                 var ebook = new Ebook(this.vendor, this.title_id);
 174                 ebook.cancelHold(authtoken, patron_id, function(resp) {
 175                     if (resp.error_msg) {
 176                         console.log('Cancel hold failed: ' . resp.error_msg);
 177                         dojo.removeClass('ebook_cancel_hold_failed', "hidden");
 178                     } else {
 179                         console.log('Cancel hold succeeded!');
 180                         dojo.destroy("hold-" + ebook.id);
 181                         dojo.removeClass('ebook_cancel_hold_succeeded', "hidden");
 182                         // Updating the transaction cache to remove the canceled hold
 183                         // is inconvenient, so we skip cleanupAfterAction() and merely
 184                         // clear transaction cache to force a refresh on next page load.
 185                         dojo.cookie('ebook_xact_cache', '', {path: '/', expires: '-1h'});
 186                     }
 187                 });
 188             };
 189             var tr = dojo.create("tr", { id: "hold-" + h.title_id }, dojo.byId('ebook_holds_main_table_body'));
 190             dojo.create("td", { innerHTML: h.title }, tr);
 191             dojo.create("td", { innerHTML: h.author }, tr);
 192             dojo.create("td", { innerHTML: h.expire_date }, tr);
 193             dojo.create("td", { innerHTML: hold_status }, tr);
 194             var actions_td = dojo.create("td", null, tr);
 195             var button = dojo.create("input", { id: "cancel-hold-" + h.title_id, type: "button", value: l_strings.cancel_hold }, actions_td);
 196             dojo.connect(button, 'onclick', h, "doCancelHold");
 197         });
 198         dojo.addClass('no_ebook_holds', "hidden");
 199         dojo.removeClass('ebook_holds_main', "hidden");
 200     }
 201 }
 202
 203 // set up page for user to perform a checkout
 204 function getReadyForCheckout() {
 205     if (typeof ebook_action.type === 'undefined')
 206         return;
 207     if (typeof active_ebook === 'undefined') {
 208         console.log('No active ebook specified, cannot prepare for checkout');
 209         dojo.removeClass('ebook_checkout_failed', "hidden");
 210     } else {
 211         active_ebook.getDetails( function(ebook) {
 212             dojo.empty('ebook_circs_main_table_body');
 213             var tr = dojo.create("tr", null, dojo.byId('ebook_circs_main_table_body'));
 214             dojo.create("td", { innerHTML: ebook.title }, tr);
 215             dojo.create("td", { innerHTML: ebook.author }, tr);
 216             dojo.create("td", null, tr);
 217             dojo.create("td", { id: "checkout-button-td" }, tr);
 218             if (typeof active_ebook.formats !== 'undefined') {
 219                 var select = dojo.create("select", { id: "checkout-format" }, dojo.byId('checkout-button-td'));
 220                 dojo.forEach(active_ebook.formats, function(f) {
 221                     dojo.create("option", { value: f.id, innerHTML: f.name }, select);
 222                 });
 223             }
 224             var button = dojo.create("input", { id: "checkout-button", type: "button", value: l_strings.checkout }, dojo.byId('checkout-button-td'));
 225             ebook.conns.checkout = dojo.connect(button, 'onclick', "doCheckout");
 226             dojo.removeClass('ebook_circs_main', "hidden");
 227         });
 228     }
 229 }
 230
 231 // set up page for user to place a hold
 232 function getReadyForHold() {
 233     if (typeof ebook_action.type === 'undefined')
 234         return;
 235     if (typeof active_ebook === 'undefined') {
 236         console.log('No active ebook specified, cannot prepare for hold');
 237         dojo.removeClass('ebook_hold_failed', "hidden");
 238     } else {
 239         active_ebook.getDetails( function(ebook) {
 240             dojo.empty('ebook_holds_main_table_body');
 241             var tr = dojo.create("tr", null, dojo.byId('ebook_holds_main_table_body'));
 242             dojo.create("td", { innerHTML: ebook.title }, tr);
 243             dojo.create("td", { innerHTML: ebook.author }, tr);
 244             dojo.create("td", null, tr); // Expire Date
 245             dojo.create("td", null, tr); // Status
 246             dojo.create("td", { id: "hold-button-td" }, tr);
 247             if (ebook_action.type == 'place_hold') {
 248                 var button = dojo.create("input", { id: "hold-button", type: "button", value: l_strings.place_hold }, dojo.byId('hold-button-td'));
 249                 ebook.conns.checkout = dojo.connect(button, 'onclick', "doPlaceHold");
 250             }
 251             dojo.removeClass('ebook_holds_main', "hidden");
 252         });
 253     }
 254 }
 255
 256 function cleanupAfterAction() {
 257     // unset variables related to the transaction we have performed,
 258     // to avoid any weirdness on page reload
 259     ebook_action = {};
 260     // update page to account for successful checkout
 261     addTotalsToPage();
 262     addTransactionsToPage();
 263     // clear transaction cache to force a refresh on next page load
 264     dojo.cookie('ebook_xact_cache', '', {path: '/', expires: '-1h'});
 265 }
 266
 267 // check out our active ebook
 268 function doCheckout() {
 269     var ses = dojo.cookie(active_ebook.vendor); // required when inspecting checkouts for download_url
 270     active_ebook.checkout(authtoken, patron_id, function(resp) {
 271         if (resp.error_msg) {
 272             console.log('Checkout failed: ' + resp.error_msg);
 273             dojo.removeClass('ebook_checkout_failed', "hidden");
 274             return;
 275         }
 276         console.log('Checkout succeeded!');
 277         dojo.destroy('checkout-button');
 278         dojo.destroy('checkout-format'); // remove optional format selector
 279         dojo.removeClass('ebook_checkout_succeeded', "hidden");
 280         // add our successful checkout to top of transaction cache
 281         var new_xact = {
 282             title_id: active_ebook.id,
 283             title: active_ebook.title,
 284             author: active_ebook.author,
 285             due_date: resp.due_date,
 286             finish: function() {
 287                 console.log('new_xact.finish()');
 288                 xacts.checkouts.unshift(this);
 289                 cleanupAfterAction();
 290                 // When we switch to jQuery, we can use .one() instead of .on(),
 291                 // obviating the need for an explicit disconnect here.
 292                 dojo.disconnect(active_ebook.conns.checkout);
 293             }
 294         };
 295         if (resp.download_url) {
 296             // Use download URL from checkout response, if available.
 297             new_xact.download_url = resp.download_url;
 298             dojo.create("a", { href: new_xact.download_url, innerHTML: l_strings.download }, dojo.byId('checkout-button-td'));
 299             new_xact.finish();
 300         } else if (typeof resp.formats !== 'undefined') {
 301             // User must select download format from list of options.
 302             var select = dojo.create("select", { id: "download-format" }, dojo.byId('checkout-button-td'));
 303             for (f in resp.formats) {
 304                 dojo.create("option", { value: resp.formats[f], innerHTML: f }, select);
 305             }
 306             var button = dojo.create("input", { id: "download-button", type: "button", value: l_strings.download }, dojo.byId('checkout-button-td'));
 307             active_ebook.conns.download = dojo.connect(button, 'onclick', active_ebook, "download");
 308             new_xact.finish();
 309         } else if (typeof resp.xact_id !== 'undefined') {
 310             // No download URL provided by API checkout response.  Grab fresh
 311             // list of user checkouts from API, find the just-completed
 312             // checkout by transaction ID, and get the download URL from that.
 313             // We call the OpenSRF method directly because Relation.getCheckouts()
 314             // results in scoping issues when retrieving the vendor session cookie.
 315             new_xact.xact_id = resp.xact_id;
 316             new OpenSRF.ClientSession('open-ils.ebook_api').request({
 317                 method: 'open-ils.ebook_api.patron.get_checkouts',
 318                 params: [ authtoken, ses, patron_id ],
 319                 async: false,
 320                 oncomplete: function(r) {
 321                     var resp = r.recv();
 322                     if (resp) {
 323                         dojo.forEach(resp.content(), function(x) {
 324                             if (x.xact_id === new_xact.xact_id) {
 325                                 new_xact.download_url = x.download_url;
 326                                 dojo.create("a", { href: new_xact.download_url, innerHTML: l_strings.download }, dojo.byId('checkout-button-td'));
 327                                 return;
 328                             }
 329                         });
 330                         new_xact.finish();
 331                     }
 332                 }
 333             }).send();
 334         }
 335     });
 336 }
 337
 338 // place hold on our active ebook
 339 function doPlaceHold() {
 340     active_ebook.placeHold(authtoken, patron_id, function(resp) {
 341         if (resp.error_msg) {
 342             console.log('Place hold failed: ' . resp.error_msg);
 343             dojo.removeClass('ebook_place_hold_failed', "hidden");
 344         } else {
 345             console.log('Place hold succeeded!');
 346             dojo.destroy('hold-button');
 347             dojo.removeClass('ebook_place_hold_succeeded', "hidden");
 348             var new_hold = {
 349                 title_id: active_ebook.id,
 350                 title: active_ebook.title,
 351                 author: active_ebook.author,
 352                 queue_position: resp.queue_position,
 353                 queue_size: resp.queue_size,
 354                 expire_date: resp.expire_date
 355             };
 356             if ( resp.is_ready || (resp.queue_position === 1 && resp.queue_size === 1) ) {
 357                 xacts.holds_ready.unshift(new_hold);
 358             } else {
 359                 xacts.holds_pending.unshift(new_hold);
 360             }
 361             cleanupAfterAction();
 362         }
 363     });
 364 }
 365
 366 // deserialize transactions from cache, returning them as a JS object
 367 function getCachedTransactions() {
 368     console.log('retrieving cached transaction details');
 369     var cache_obj;
 370     var current_cache = dojo.cookie('ebook_xact_cache');
 371     if (current_cache) {
 372         cache_obj = JSON.parse(current_cache);
 373         xacts.checkouts = cache_obj.checkouts;
 374         xacts.holds_pending = cache_obj.holds_pending;
 375         xacts.holds_ready = cache_obj.holds_ready;
 376     }
 377     return cache_obj;
 378 }
 379
 380 // add a single vendor's transactions to transaction cache
 381 function addTransactionsToCache(rel) {
 382     console.log('updating transaction cache');
 383     var v = rel.vendor;
 384     var updated_xacts = {
 385         checkouts: [],
 386         holds_pending: [],
 387         holds_ready: []
 388     };
 389     // preserve any transactions with other vendors
 390     dojo.forEach(xacts.checkouts, function(xact) {
 391         if (xact.vendor !== v)
 392             updated_xacts.checkouts.push(xact);
 393     });
 394     dojo.forEach(xacts.holds_pending, function(xact) {
 395         if (xact.vendor !== v)
 396             updated_xacts.holds_pending.push(xact);
 397     });
 398     dojo.forEach(xacts.holds_ready, function(xact) {
 399         if (xact.vendor !== v)
 400             updated_xacts.holds_ready.push(xact);
 401     });
 402     // add transactions from current vendor
 403     dojo.forEach(rel.checkouts, function(xact) {
 404         updated_xacts.checkouts.push(xact);
 405     });
 406     dojo.forEach(rel.holds_pending, function(xact) {
 407         updated_xacts.holds_pending.push(xact);
 408     });
 409     dojo.forEach(rel.holds_ready, function(xact) {
 410         updated_xacts.holds_ready.push(xact);
 411     });
 412     // TODO sort transactions by date
 413     // save transactions to cache
 414     xacts = updated_xacts;
 415     var new_cache = JSON.stringify(xacts);
 416     dojo.cookie('ebook_xact_cache', new_cache, {path: '/'});
 417     // update current page
 418     addTotalsToPage();
 419     addTransactionsToPage();
 420 }
 421