1 dojo.require('dojo.date.locale');
2 dojo.require('dojo.date.stamp');
3 dojo.require('openils.CGI');
4 dojo.require('openils.Util');
5 dojo.require('openils.User');
6 dojo.require('openils.Event');
7 dojo.require('openils.widget.ProgressDialog');
9 dojo.requireLocalization('openils.circ', 'selfcheck');
10 var localeStrings = dojo.i18n.getLocalization('openils.circ', 'selfcheck');
13 const SET_BARCODE_REGEX = 'opac.barcode_regex';
14 const SET_PATRON_TIMEOUT = 'circ.selfcheck.patron_login_timeout';
15 const SET_ALERT_ON_CHECKOUT_EVENT = 'circ.selfcheck.alert_on_checkout_event';
16 const SET_AUTO_OVERRIDE_EVENTS = 'circ.selfcheck.auto_override_checkout_events';
17 const SET_PATRON_PASSWORD_REQUIRED = 'circ.selfcheck.patron_password_required';
18 const SET_AUTO_RENEW_INTERVAL = 'circ.checkout_auto_renew_age';
20 //openils.Util.playAudioUrl('/xul/server/skin/media/audio/bonus.wav');
22 function SelfCheckManager() {
24 this.cgi = new openils.CGI();
26 this.workstation = null;
27 this.authtoken = null;
30 this.patronBarcodeRegex = null;
32 // current item barcode
33 this.itemBarcode = null;
35 // are we currently performing a renewal?
36 this.isRenewal = false;
38 // dict of org unit settings for "here"
39 this.orgSettings = {};
41 // Construct a mock checkout for debugging purposes
42 if(this.mockCheckouts = this.cgi.param('mock-circ')) {
46 record : new fieldmapper.mvr(),
47 copy : new fieldmapper.acp(),
48 circ : new fieldmapper.circ()
52 this.mockCheckout.payload.record.title('Jazz improvisation for guitar');
53 this.mockCheckout.payload.record.author('Wise, Les');
54 this.mockCheckout.payload.record.isbn('0634033565');
55 this.mockCheckout.payload.copy.barcode('123456789');
56 this.mockCheckout.payload.circ.renewal_remaining(1);
57 this.mockCheckout.payload.circ.parent_circ(1);
58 this.mockCheckout.payload.circ.due_date('2012-12-21');
65 * Fetch the org-unit settings, initialize the display, etc.
67 SelfCheckManager.prototype.init = function() {
69 this.staff = openils.User.user;
70 this.workstation = openils.User.workstation;
71 this.authtoken = openils.User.authtoken;
72 this.loadOrgSettings();
76 // connect onclick handlers to the various navigation links
78 'oils-selfck-hold-details-link' : function() { self.drawHoldsPage(); },
79 'oils-selfck-nav-holds' : function() { self.drawHoldsPage(); },
80 'oils-selfck-pay-fines-link' : function() { self.drawFinesPage(); },
81 'oils-selfck-nav-fines' : function() { self.drawFinesPage(); },
82 'oils-selfck-nav-home' : function() { self.drawCircPage(); },
83 'oils-selfck-nav-logout' : function() { self.logoutPatron(); }
86 for(var id in linkHandlers)
87 dojo.connect(dojo.byId(id), 'onclick', linkHandlers[id]);
90 if(this.cgi.param('patron')) {
92 // Patron barcode via cgi param. Mainly used for debugging and
93 // only works if password is not required by policy
94 this.loginPatron(this.cgi.param('patron'));
102 * Loads the org unit settings
104 SelfCheckManager.prototype.loadOrgSettings = function() {
106 var settings = fieldmapper.aou.fetchOrgSettingBatch(
107 this.staff.ws_ou(), [
110 SET_ALERT_ON_CHECKOUT_EVENT,
111 SET_AUTO_OVERRIDE_EVENTS,
112 SET_PATRON_PASSWORD_REQUIRED,
113 SET_AUTO_RENEW_INTERVAL,
119 this.orgSettings[k] = settings[k].value;
122 if(settings[SET_BARCODE_REGEX])
123 this.patronBarcodeRegex = new RegExp(settings[SET_BARCODE_REGEX].value);
126 SelfCheckManager.prototype.drawLoginPage = function() {
129 var bcHandler = function(barcode) {
130 // handle patron barcode entry
132 if(self.orgSettings[SET_PATRON_PASSWORD_REQUIRED]) {
134 // password is required. wire up the scan box to read it
136 msg : 'Please enter your password', // TODO i18n
137 handler : function(pw) { self.loginPatron(barcode, pw); }
141 // password is not required, go ahead and login
142 self.loginPatron(barcode);
147 msg : 'Please log in with your library barcode.', // TODO
155 SelfCheckManager.prototype.loginPatron = function(barcode, passwd) {
157 if(this.orgSettings[SET_PATRON_PASSWORD_REQUIRED]) {
159 // patron password is required. Verify it.
161 var res = fieldmapper.standardRequest(
162 ['open-ils.actor', 'open-ils.actor.verify_user_password'],
163 {params : [this.authtoken, barcode, null, hex_md5(passwd)]}
167 // user-not-found results in login failure
168 this.handleXactResult('login', barcode, {textcode : 'ACTOR_USER_NOT_FOUND'});
172 // retrieve the fleshed user by barcode
173 this.patron = fieldmapper.standardRequest(
174 ['open-ils.actor', 'open-ils.actor.user.fleshed.retrieve_by_barcode'],
175 {params : [this.authtoken, barcode]}
178 var evt = openils.Event.parse(this.patron);
180 this.handleXactResult('login', barcode, evt);
184 dojo.byId('oils-selfck-status-div').innerHTML = '';
185 dojo.byId('oils-selfck-user-banner').innerHTML = 'Welcome, ' + this.patron.usrname(); // TODO i18n
192 * Manages the main input box
193 * @param msg The context message to display with the box
194 * @param clearOnly Don't update the context message, just clear the value and re-focus
195 * @param handler Optional "on-enter" handler.
197 SelfCheckManager.prototype.updateScanBox = function(args) {
201 selfckScanBox.domNode.select();
203 selfckScanBox.attr('value', '');
207 selfckScanBox.attr('value', args.value);
210 dojo.byId('oils-selfck-scan-text').innerHTML = args.msg;
212 if(selfckScanBox._lastHandler && (args.handler || args.clearHandler)) {
213 dojo.disconnect(selfckScanBox._lastHandler);
217 selfckScanBox._lastHandler = dojo.connect(
221 if(e.keyCode != dojo.keys.ENTER)
223 args.handler(selfckScanBox.attr('value'));
228 selfckScanBox.focus();
232 * Sets up the checkout/renewal interface
234 SelfCheckManager.prototype.drawCircPage = function() {
238 msg : 'Please enter an item barcode', // TODO i18n
239 handler : function(barcode) { self.checkout(barcode); }
242 openils.Util.hide('oils-selfck-payment-page');
243 openils.Util.hide('oils-selfck-holds-page');
244 openils.Util.show('oils-selfck-circ-page');
246 this.circTbody = dojo.byId('oils-selfck-circ-tbody');
247 if(!this.circTemplate)
248 this.circTemplate = this.circTbody.removeChild(dojo.byId('oils-selfck-circ-row'));
250 // items out, holds, and fines summaries
253 fieldmapper.standardRequest(
254 ['open-ils.actor', 'open-ils.actor.user.fines.summary'],
256 params : [this.authtoken, this.patron.id()],
257 oncomplete : function(r) {
258 var summary = openils.Util.readResponse(r);
259 dojo.byId('oils-selfck-fines-total').innerHTML =
260 dojo.string.substitute(
261 localeStrings.TOTAL_FINES_ACCOUNT,
262 [summary.balance_owed()]
269 this.updateHoldsSummary();
272 this.updateCircSummary();
274 // render mock checkouts for debugging?
275 if(this.mockCheckouts) {
276 for(var i in [1,2,3])
277 this.displayCheckout(this.mockCheckout, 'checkout');
281 SelfCheckManager.prototype.updateHoldsSummary = function(decrement) {
283 if(!this.holdsSummary) {
284 var summary = fieldmapper.standardRequest(
285 ['open-ils.circ', 'open-ils.circ.holds.user_summary'],
286 {params : [this.authtoken, this.patron.id()]}
289 this.holdsSummary = {};
290 this.holdsSummary.ready = Number(summary['4']);
291 this.holdsSummary.total = 0;
293 for(var i in summary)
294 this.holdsSummary.total += Number(summary[i]);
298 this.holdsSummary.ready -= 1;
300 dojo.byId('oils-selfck-holds-total').innerHTML =
301 dojo.string.substitute(
302 localeStrings.TOTAL_HOLDS,
303 [this.holdsSummary.total]
306 dojo.byId('oils-selfck-holds-ready').innerHTML =
307 dojo.string.substitute(
308 localeStrings.HOLDS_READY_FOR_PICKUP,
309 [this.holdsSummary.ready]
314 SelfCheckManager.prototype.updateCircSummary = function(increment) {
316 if(!this.circSummary) {
318 var summary = fieldmapper.standardRequest(
319 ['open-ils.actor', 'open-ils.actor.user.checked_out.count'],
320 {params : [this.authtoken, this.patron.id()]}
324 total : Number(summary.out) + Number(summary.overdue),
325 overdue : Number(summary.overdue),
331 // local checkout occurred. Add to the total and the session.
332 this.circSummary.total += 1;
333 this.circSummary.session += 1;
336 dojo.byId('oils-selfck-circ-account-total').innerHTML =
337 dojo.string.substitute(
338 localeStrings.TOTAL_ITEMS_ACCOUNT,
339 [this.circSummary.total]
342 dojo.byId('oils-selfck-circ-session-total').innerHTML =
343 dojo.string.substitute(
344 localeStrings.TOTAL_ITEMS_SESSION,
345 [this.circSummary.session]
350 SelfCheckManager.prototype.drawHoldsPage = function() {
352 // TODO add option to hid scanBox
353 // this.updateScanBox(...)
355 openils.Util.hide('oils-selfck-circ-page');
356 openils.Util.hide('oils-selfck-payment-page');
357 openils.Util.show('oils-selfck-holds-page');
359 this.holdTbody = dojo.byId('oils-selfck-hold-tbody');
360 if(!this.holdTemplate)
361 this.holdTemplate = this.holdTbody.removeChild(dojo.byId('oils-selfck-hold-row'));
362 while(this.holdTbody.childNodes[0])
363 this.holdTbody.removeChild(this.holdTbody.childNodes[0]);
365 progressDialog.show(true);
368 fieldmapper.standardRequest( // fetch the hold IDs
370 ['open-ils.circ', 'open-ils.circ.holds.id_list.retrieve'],
372 params : [this.authtoken, this.patron.id()],
374 oncomplete : function(r) {
375 var ids = openils.Util.readResponse(r);
376 if(!ids || ids.length == 0) {
377 progressDialog.hide();
381 fieldmapper.standardRequest( // fetch the hold objects with fleshed details
382 ['open-ils.circ', 'open-ils.circ.hold.details.batch.retrieve.atomic'],
384 params : [self.authtoken, ids],
386 oncomplete : function(rr) {
387 self.drawHolds(openils.Util.readResponse(rr));
397 * Fetch and add a single hold to the list of holds
399 SelfCheckManager.prototype.drawHolds = function(holds) {
402 // sort available holds to the top of the list
403 // followed by queue position order
405 if(a.status == 4) return -1;
406 if(a.queue_position < b.queue_position) return -1;
411 progressDialog.hide();
413 for(var i in holds) {
416 var row = this.holdTemplate.cloneNode(true);
418 if(data.mvr.isbn()) {
419 this.byName(row, 'jacket').setAttribute('src', '/opac/extras/ac/jacket/small/' + data.mvr.isbn());
422 this.byName(row, 'title').innerHTML = data.mvr.title();
423 this.byName(row, 'author').innerHTML = data.mvr.author();
425 if(data.status == 4) {
427 // hold is ready for pickup
428 this.byName(row, 'status').innerHTML = localeStrings.HOLD_STATUS_READY;
432 // hold is still pending
433 this.byName(row, 'status').innerHTML =
434 dojo.string.substitute(
435 localeStrings.HOLD_STATUS_WAITING,
436 [data.queue_position, data.potential_copies]
440 this.holdTbody.appendChild(row);
447 * Check out a single item. If the item is already checked
448 * out to the patron, redirect to renew()
450 SelfCheckManager.prototype.checkout = function(barcode, override) {
453 this.updateScanbox(null, true);
457 if(this.mockCheckouts) {
458 // if we're in mock-checkout mode, just insert another
459 // fake circ into the table and get out of here.
460 this.displayCheckout(this.mockCheckout, 'checkout');
464 // TODO see if it's a patron barcode
465 // TODO see if this item has already been checked out in this session
467 var method = 'open-ils.circ.checkout.full';
468 if(override) method += '.override';
470 console.log("Checkout out item " + barcode + " with method " + method);
472 var result = fieldmapper.standardRequest(
473 ['open-ils.circ', 'open-ils.circ.checkout.full'],
476 patron_id : this.patron.id(),
477 copy_barcode : barcode
482 console.log(js2JSON(result));
484 var stat = this.handleXactResult('checkout', barcode, result);
487 this.checkout(barcode, true);
488 } else if(stat.renew) {
494 SelfCheckManager.prototype.handleXactResult = function(action, item, result) {
496 var displayText = '';
498 // If true, the display message is important enough to pop up. Whether or not
499 // an alert() actually occurs, depends on org unit settings
502 // TODO handle lost/missing/etc checkin+checkout override steps
504 if(result.textcode == 'NO_SESSION') {
506 return this.logoutStaff();
508 } else if(result.textcode == 'SUCCESS') {
510 if(action == 'checkout') {
512 displayText = dojo.string.substitute(
513 localeStrings.CHECKOUT_SUCCESS, [item]);
514 this.displayCheckout(result, 'checkout');
516 } else if(action == 'renew') {
518 displayText = dojo.string.substitute(
519 localeStrings.RENEW_SUCCESS, [item]);
520 this.displayCheckout(result, 'renew');
523 this.updateScanBox();
525 } else if(result.textcode == 'OPEN_CIRCULATION_EXISTS' && action == 'checkout') {
527 // Server says the item is already checked out. If it's checked out to the
528 // current user, we may need to renew it.
530 var payload = result.payload || {};
532 if(payload.old_circ) {
535 old_circ refers to the previous checkout IFF it's for the same user.
536 If no auto-renew interval is not defined, assume we should renew it
537 If an auto-renew interval is defined and the payload comes back with
538 auto_renew set to true, do the renewal. Otherwise, let the patron know
539 the item is already checked out to them. */
541 if( !this.orgSettings[SET_AUTO_RENEW_INTERVAL] ||
542 (this.orgSettings[SET_AUTO_RENEW_INTERVAL] && payload.auto_renew) ) {
543 return { renew : true };
547 displayText = dojo.string.substitute(localeStrings.ALREADY_OUT, [item]);
551 // item is checked out to some other user
553 displayText = dojo.string.substitute(localeStrings.OPEN_CIRCULATION_EXISTS, [item]);
556 this.updateScanBox({select:true});
560 var overrideEvents = this.orgSettings[SET_AUTO_OVERRIDE_EVENTS];
562 if(overrideEvents && overrideEvents.length) {
564 // see if the events we received are all in the list of
565 // events to override
567 if(!result.length) result = [result];
570 for(var i = 0; i < result.length; i++) {
571 var match = overrideEvents.filter(
572 function(e) { return (e == result[i].textcode); })[0];
580 return { override : true };
583 this.updateScanBox({select : true});
589 switch(result.textcode) {
591 case 'ACTOR_USER_NOT_FOUND' :
592 displayText = dojo.string.substitute(
593 localeStrings.LOGIN_FAILED, [item]);
596 case 'MAX_RENEWALS_REACHED' :
597 displayText = dojo.string.substitute(
598 localeStrings.MAX_RENEWALS, [item]);
601 case 'ITEM_NOT_CATALOGED' :
602 displayText = dojo.string.substitute(
603 localeStrings.ITEM_NOT_CATALOGED, [item]);
606 case 'OPEN_CIRCULATION_EXISTS' :
607 displayText = dojo.string.substitute(
608 localeStrings.OPEN_CIRCULATION_EXISTS, [item]);
612 console.error('Unhandled event ' + result.textcode);
614 if(action == 'checkout' || action == 'renew') {
615 displayText = dojo.string.substitute(
616 localeStrings.GENERIC_CIRC_FAILURE, [item]);
618 displayText = dojo.string.substitute(
619 localeStrings.UNKNOWN_ERROR, [result.textcode]);
624 console.log("Updating status with " + displayText);
626 dojo.byId('oils-selfck-status-div').innerHTML = displayText;
628 if(popup && this.orgSettings[SET_ALERT_ON_CHECKOUT_EVENT])
638 SelfCheckManager.prototype.renew = function(barcode, override) {
640 var method = 'open-ils.circ.renew';
641 if(override) method += '.override';
643 console.log("Renewing item " + barcode + " with method " + method);
645 var result = fieldmapper.standardRequest(
646 ['open-ils.circ', method],
649 patron_id : this.patron.id(),
650 copy_barcode : barcode
655 console.log(js2JSON(result));
657 var stat = this.handleXactResult('renew', barcode, result);
660 this.renew(barcode, true);
664 * Display the result of a checkout or renewal in the items out table
666 SelfCheckManager.prototype.displayCheckout = function(evt, type) {
668 var copy = evt.payload.copy;
669 var record = evt.payload.record;
670 var circ = evt.payload.circ;
671 var row = this.circTemplate.cloneNode(true);
674 this.byName(row, 'jacket').setAttribute('src', '/opac/extras/ac/jacket/small/' + record.isbn());
677 this.byName(row, 'barcode').innerHTML = copy.barcode();
678 this.byName(row, 'title').innerHTML = record.title();
679 this.byName(row, 'author').innerHTML = record.author();
680 this.byName(row, 'remaining').innerHTML = circ.renewal_remaining();
681 openils.Util.show(this.byName(row, type));
683 var date = dojo.date.stamp.fromISOString(circ.due_date());
684 this.byName(row, 'due_date').innerHTML =
685 dojo.date.locale.format(date, {selector : 'date'});
687 // put new circs at the top of the list
688 this.circTbody.insertBefore(row, this.circTbody.getElementsByTagName('tr')[0]);
692 SelfCheckManager.prototype.byName = function(node, name) {
693 return dojo.query('[name=' + name+']', node)[0];
697 SelfCheckManager.prototype.drawFinesPage = function() {
699 openils.Util.hide('oils-selfck-circ-page');
700 openils.Util.hide('oils-selfck-holds-page');
701 openils.Util.show('oils-selfck-payment-page');
708 SelfCheckManager.prototype.printReceipt = function() {
713 * Logout the patron and return to the login page
715 SelfCheckManager.prototype.logoutPatron = function() {
718 this.holdsSummary = null;
719 this.circSummary = null;
721 this.drawLoginPage();
726 * Fire up the manager on page load
728 openils.Util.addOnLoad(
730 new SelfCheckManager().init();