b03dcb6f1e0d745331e86c6a6702b64112a77528
[working/Evergreen.git] / 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
24 // Ebook to perform actions on.
25 var active_ebook;
26 if (typeof ebook_action.title_id !== 'undefined') {
27     active_ebook = new Ebook(ebook_action.vendor, ebook_action.title_id);
28 }
29
30 dojo.addOnLoad(function() {
31
32     dojo.forEach(vendor_list, function(v) {
33         var rel = new Relation(v, patron_id);
34         relations.push(rel);
35     });
36
37     // Pull patron transaction info from cache (cookie), if available.
38     // Otherwise, do a live lookup against all enabled vendors.
39     if (dojo.cookie('ebook_xact_cache')) {
40         getCachedTransactions();
41         addTotalsToPage();
42         addTransactionsToPage();
43     } else {
44         console.log('retrieving patron transaction info for all vendors');
45         dojo.forEach(relations, function(rel) {
46             checkSession(rel.vendor, function(ses) {
47                 rel.getTransactions( function(r) {
48                     addTransactionsToCache(r);
49                 });
50             });
51         });
52     }
53
54 });
55
56 // Update current page with cross-vendor transaction totals.
57 function addTotalsToPage() {
58     console.log('updating page with transaction totals');
59     updateDashboard();
60     updateMyAccountSummary();
61 }
62
63 // Update current page with detailed transaction info, where appropriate.
64 function addTransactionsToPage() {
65     if (myopac_page) {
66         console.log('updating page with cached transaction details, if applicable');
67         if (myopac_page === 'ebook_circs')
68             updateCheckoutView();
69         if (myopac_page === 'ebook_holds')
70             updateHoldView();
71         if (myopac_page === 'ebook_holds_ready')
72             updateHoldReadyView();
73     }
74 }
75         
76 function updateDashboard() {
77     console.log('updating dashboard');
78     var total_checkouts = (typeof xacts.checkouts === 'undefined') ? '-' : xacts.checkouts.length;
79     var total_holds_pending = (typeof xacts.holds_pending === 'undefined') ? '-' : xacts.holds_pending.length;
80     var total_holds_ready = (typeof xacts.holds_ready === 'undefined') ? '-' : xacts.holds_ready.length;
81     // update totals
82     dojo.byId('dash_e_checked').innerHTML = total_checkouts;
83     dojo.byId('dash_e_holds').innerHTML = total_holds_pending;
84     dojo.byId('dash_e_pickup').innerHTML = total_holds_ready;
85     // unhide ebook dashboard
86     dojo.removeClass('dashboard_e', "hidden");
87 }
88
89 function updateMyAccountSummary() {
90     if (myopac_page === 'main') {
91         console.log('updating account summary');
92         var total_checkouts = (typeof xacts.checkouts === 'undefined') ? '-' : xacts.checkouts.length;
93         var total_holds_pending = (typeof xacts.holds_pending === 'undefined') ? '-' : xacts.holds_pending.length;
94         var total_holds_ready = (typeof xacts.holds_ready === 'undefined') ? '-' : xacts.holds_ready.length;
95         // update totals
96         dojo.byId('acct_sum_ebook_circ_total').innerHTML = total_checkouts;
97         dojo.byId('acct_sum_ebook_hold_total').innerHTML = total_holds_pending;
98         dojo.byId('acct_sum_ebook_hold_ready_total').innerHTML = total_holds_ready;
99         // unhide display elements
100         dojo.removeClass('acct_sum_ebook_circs', "hidden");
101         dojo.removeClass('acct_sum_ebook_holds', "hidden");
102         dojo.removeClass('acct_sum_ebook_holds_ready', "hidden");
103     }
104 }
105
106 function updateCheckoutView() {
107     if (typeof ebook_action.type !== 'undefined') {
108         if (ebook_action.type == 'checkout') {
109             getReadyForCheckout();
110         }
111     } else if (xacts.checkouts.length < 1) {
112         dojo.removeClass('no_ebook_circs', "hidden");
113     } else {
114         dojo.forEach(xacts.checkouts, function(x) {
115             dojo.empty('ebook_circs_main_table_body');
116             var dl_link = '<a href="' + x.download_url + '">' + l_strings.download + '</a>';
117             var tr = dojo.create("tr", null, dojo.byId('ebook_circs_main_table_body'));
118             dojo.create("td", { innerHTML: x.title }, tr);
119             dojo.create("td", { innerHTML: x.author }, tr);
120             dojo.create("td", { innerHTML: x.due_date }, tr);
121             dojo.create("td", { innerHTML: dl_link}, tr);
122             // TODO: more actions (renew, checkin)
123         });
124         dojo.addClass('no_ebook_circs', "hidden");
125         dojo.removeClass('ebook_circs_main', "hidden");
126     }
127 }
128
129 function updateHoldView() {
130     // handle hold actions
131     if (typeof ebook_action.type !== 'undefined') {
132         getReadyForHold();
133         return;
134     }
135
136     // no hold action, just displaying holds
137     var holds_pending = xacts.holds_pending;
138     var holds_ready = xacts.holds_ready;
139
140     // combine all holds into a single list, ready-for-checkout holds first
141     var holds = holds_ready.concat(holds_pending);
142
143     if (holds.length < 1) {
144         dojo.removeClass('no_ebook_holds', "hidden");
145     } else {
146         dojo.forEach(holds, function(h) {
147             var hold_status;
148             if (h.is_ready) {
149                 hold_status = l_strings.ready_for_checkout;
150             } else if (h.is_frozen) {
151                 hold_status = l_strings.suspended;
152             } else {
153                 hold_status = h.queue_position + ' / ' + h.queue_size;
154             }
155             dojo.empty('ebook_holds_main_table_body');
156             var tr = dojo.create("tr", null, dojo.byId('ebook_holds_main_table_body'));
157             dojo.create("td", { innerHTML: h.title }, tr);
158             dojo.create("td", { innerHTML: h.author }, tr);
159             dojo.create("td", { innerHTML: h.expire_date }, tr);
160             dojo.create("td", { innerHTML: hold_status }, tr);
161             dojo.create("td", null, tr); // TODO actions
162         });
163         dojo.addClass('no_ebook_holds', "hidden");
164         dojo.removeClass('ebook_holds_main', "hidden");
165     }
166 }
167
168 function updateHoldReadyView() {
169     var holds = xacts.holds_ready;
170     if (holds.length < 1) {
171         dojo.removeClass('no_ebook_holds', "hidden");
172     } else {
173         dojo.forEach(holds, function(h) {
174             dojo.empty('ebook_holds_main_table_body');
175             var tr = dojo.create("tr", null, dojo.byId('ebook_holds_main_table_body'));
176             dojo.create("td", { innerHTML: h.title }, tr);
177             dojo.create("td", { innerHTML: h.author }, tr);
178             dojo.create("td", { innerHTML: h.expire_date }, tr);
179             dojo.create("td", null, tr); // TODO actions
180         });
181         dojo.addClass('no_ebook_holds', "hidden");
182         dojo.removeClass('ebook_holds_main', "hidden");
183     }
184 }
185
186 // set up page for user to perform a checkout
187 function getReadyForCheckout() {
188     if (typeof active_ebook === 'undefined') {
189         console.log('No active ebook specified, cannot prepare for checkout');
190         dojo.removeClass('ebook_checkout_failed', "hidden");
191     } else {
192         active_ebook.getDetails( function(ebook) {
193             dojo.empty('ebook_circs_main_table_body');
194             var tr = dojo.create("tr", null, dojo.byId('ebook_circs_main_table_body'));
195             dojo.create("td", { innerHTML: ebook.title }, tr);
196             dojo.create("td", { innerHTML: ebook.author }, tr);
197             dojo.create("td", null, tr);
198             dojo.create("td", { id: "checkout-button-td" }, tr);
199             var button = dojo.create("input", { id: "checkout-button", type: "button", value: l_strings.checkout }, dojo.byId('checkout-button-td'));
200             ebook.conns.checkout = dojo.connect(button, 'onclick', "doCheckout");
201             dojo.removeClass('ebook_circs_main', "hidden");
202         });
203     }
204 }
205
206 // set up page for user to place a hold
207 function getReadyForHold() {
208     if (typeof active_ebook === 'undefined') {
209         console.log('No active ebook specified, cannot prepare for hold');
210         dojo.removeClass('ebook_hold_failed', "hidden");
211     } else {
212         active_ebook.getDetails( function(ebook) {
213             dojo.empty('ebook_holds_main_table_body');
214             var tr = dojo.create("tr", null, dojo.byId('ebook_holds_main_table_body'));
215             dojo.create("td", { innerHTML: ebook.title }, tr);
216             dojo.create("td", { innerHTML: ebook.author }, tr);
217             dojo.create("td", null, tr); // Expire Date
218             dojo.create("td", null, tr); // Status
219             dojo.create("td", { id: "hold-button-td" }, tr);
220             if (ebook_action.type == 'place_hold') {
221                 var button = dojo.create("input", { id: "hold-button", type: "button", value: l_strings.place_hold }, dojo.byId('hold-button-td'));
222                 ebook.conns.checkout = dojo.connect(button, 'onclick', "doPlaceHold");
223             } else if (ebook_action.type == 'cancel_hold') {
224                 var button = dojo.create("input", { id: "hold-button", type: "button", value: l_strings.cancel_hold }, dojo.byId('hold-button-td'));
225                 ebook.conns.checkout = dojo.connect(button, 'onclick', "doCancelHold");
226             }
227             dojo.removeClass('ebook_holds_main', "hidden");
228         });
229     }
230 }
231
232 function cleanupAfterAction() {
233     // unset variables related to the transaction we have performed,
234     // to avoid any weirdness on page reload
235     ebook_action = {};
236     // update page to account for successful checkout
237     addTotalsToPage();
238     addTransactionsToPage();
239     // clear transaction cache to force a refresh on next page load
240     dojo.cookie('ebook_xact_cache', '', {path: '/', expires: '-1h'});
241 }
242
243 // check out our active ebook
244 function doCheckout() {
245     active_ebook.checkout(authtoken, patron_id, function(resp) {
246         if (resp.due_date) {
247             console.log('Checkout succeeded!');
248             dojo.destroy('checkout-button');
249             dojo.removeClass('ebook_checkout_succeeded', "hidden");
250             // add our successful checkout to top of transaction cache
251             var new_xact = {
252                 title_id: active_ebook.id,
253                 title: active_ebook.title,
254                 author: active_ebook.author,
255                 due_date: resp.due_date,
256                 download_url: '' // TODO - for OverDrive, user must "lock in" a format first!
257             };
258             xacts.checkouts.unshift(new_xact);
259             cleanupAfterAction();
260         } else {
261             console.log('Checkout failed: ' + resp.error_msg);
262             dojo.removeClass('ebook_checkout_failed', "hidden");
263         }
264         // When we switch to jQuery, we can use .one() instead of .on(),
265         // obviating the need for an explicit disconnect here.
266         dojo.disconnect(active_ebook.conns.checkout);
267     });
268 }
269
270 // place hold on our active ebook
271 function doPlaceHold() {
272     active_ebook.placeHold(authtoken, patron_id, function(resp) {
273         if (resp.error_msg) {
274             console.log('Place hold failed: ' . resp.error_msg);
275             dojo.removeClass('ebook_place_hold_failed', "hidden");
276         } else {
277             console.log('Place hold succeeded!');
278             dojo.destroy('hold-button');
279             dojo.removeClass('ebook_place_hold_succeeded', "hidden");
280             var new_hold = {
281                 title_id: active_ebook.id,
282                 title: active_ebook.title,
283                 author: active_ebook.author,
284                 queue_position: resp.queue_position,
285                 queue_size: resp.queue_size,
286                 expire_date: resp.expire_date
287             };
288             if ( resp.is_ready || (resp.queue_position === 1 && resp.queue_size === 1) ) {
289                 xacts.holds_ready.unshift(new_hold);
290             } else {
291                 xacts.holds_pending.unshift(new_hold);
292             }
293             cleanupAfterAction();
294         }
295     });
296 }
297
298 // deserialize transactions from cache, returning them as a JS object
299 function getCachedTransactions() {
300     console.log('retrieving cached transaction details');
301     var cache_obj;
302     var current_cache = dojo.cookie('ebook_xact_cache');
303     if (current_cache) {
304         cache_obj = JSON.parse(current_cache);
305         xacts.checkouts = cache_obj.checkouts;
306         xacts.holds_pending = cache_obj.holds_pending;
307         xacts.holds_ready = cache_obj.holds_ready;
308     }
309     return cache_obj;
310 }
311
312 // add a single vendor's transactions to transaction cache
313 function addTransactionsToCache(rel) {
314     console.log('updating transaction cache');
315     var v = rel.vendor;
316     var updated_xacts = {
317         checkouts: [],
318         holds_pending: [],
319         holds_ready: []
320     };
321     // preserve any transactions with other vendors
322     dojo.forEach(xacts.checkouts, function(xact) {
323         if (xact.vendor !== v)
324             updated_xacts.checkouts.push(xact);
325     });
326     dojo.forEach(xacts.holds_pending, function(xact) {
327         if (xact.vendor !== v)
328             updated_xacts.holds_pending.push(xact);
329     });
330     dojo.forEach(xacts.holds_ready, function(xact) {
331         if (xact.vendor !== v)
332             updated_xacts.holds_ready.push(xact);
333     });
334     // add transactions from current vendor
335     dojo.forEach(rel.checkouts, function(xact) {
336         updated_xacts.checkouts.push(xact);
337     });
338     dojo.forEach(rel.holds_pending, function(xact) {
339         updated_xacts.holds_pending.push(xact);
340     });
341     dojo.forEach(rel.holds_ready, function(xact) {
342         updated_xacts.holds_ready.push(xact);
343     });
344     // TODO sort transactions by date
345     // save transactions to cache
346     xacts = updated_xacts;
347     var new_cache = JSON.stringify(xacts);
348     dojo.cookie('ebook_xact_cache', new_cache, {path: '/'});
349     // update current page
350     addTotalsToPage();
351     addTransactionsToPage();
352 }
353