1 package OpenILS::WWW::EGCatLoader;
2 use strict; use warnings;
3 use Apache2::Const -compile => qw(OK DECLINED FORBIDDEN HTTP_INTERNAL_SERVER_ERROR REDIRECT HTTP_BAD_REQUEST);
4 use OpenSRF::Utils::Logger qw/$logger/;
5 use OpenILS::Utils::CStoreEditor qw/:funcs/;
6 use OpenILS::Utils::Fieldmapper;
7 use OpenILS::Application::AppUtils;
9 use OpenSRF::Utils::JSON;
10 use OpenSRF::Utils::Cache;
11 use Digest::MD5 qw(md5_hex);
13 $Data::Dumper::Indent = 0;
15 my $U = 'OpenILS::Application::AppUtils';
17 sub prepare_extended_user_info {
20 my $e = $self->editor;
22 # are we already in a transaction?
23 my $local_xact = !$e->{xact_id};
24 $e->xact_begin if $local_xact;
26 # keep the original user object so we can restore
27 # login-specific data (e.g. workstation)
28 my $usr = $self->ctx->{user};
30 $self->ctx->{user} = $self->editor->retrieve_actor_user([
31 $self->ctx->{user}->id,
35 au => [qw/card home_ou addresses ident_type billing_address/, @extra_flesh]
41 $e->rollback if $local_xact;
43 $self->ctx->{user}->wsid($usr->wsid);
44 $self->ctx->{user}->ws_ou($usr->ws_ou);
46 # discard replaced (negative-id) addresses.
47 $self->ctx->{user}->addresses([
48 grep {$_->id > 0} @{$self->ctx->{user}->addresses} ]);
50 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR
51 unless $self->ctx->{user};
56 # Given an event returned by a failed attempt to create a hold, do we have
57 # permission to override? XXX Should the permission check be scoped to a
58 # given org_unit context?
59 sub test_could_override {
60 my ($self, $event) = @_;
62 return 0 unless $event;
63 return 1 if $self->editor->allowed($event->{textcode} . ".override");
64 return 1 if $event->{"fail_part"} and
65 $self->editor->allowed($event->{"fail_part"} . ".override");
69 # Find out whether we care that local copies are available
70 sub local_avail_concern {
71 my ($self, $hold_target, $hold_type, $pickup_lib) = @_;
73 my $would_block = $self->ctx->{get_org_setting}->
74 ($pickup_lib, "circ.holds.hold_has_copy_at.block");
76 $self->ctx->{get_org_setting}->
77 ($pickup_lib, "circ.holds.hold_has_copy_at.alert") and
78 not $self->cgi->param("override")
79 ) unless $would_block;
81 if ($would_block or $would_alert) {
83 "hold_target" => $hold_target,
84 "hold_type" => $hold_type,
85 "org_unit" => $pickup_lib
87 my $local_avail = $U->simplereq(
89 "open-ils.circ.hold.has_copy_at", $self->editor->authtoken, $args
92 "copy availability information for " . Dumper($args) .
93 " is " . Dumper($local_avail)
95 if (%$local_avail) { # if hash not empty
96 $self->ctx->{hold_copy_available} = $local_avail;
97 return ($would_block, $would_alert);
105 # user : au object, fleshed
106 sub load_myopac_prefs {
108 my $cgi = $self->cgi;
109 my $e = $self->editor;
110 my $pending_addr = $cgi->param('pending_addr');
111 my $replace_addr = $cgi->param('replace_addr');
112 my $delete_pending = $cgi->param('delete_pending');
114 $self->prepare_extended_user_info;
115 my $user = $self->ctx->{user};
117 my $lock_usernames = $self->ctx->{get_org_setting}->($e->requestor->home_ou, 'opac.lock_usernames');
118 if(defined($lock_usernames) and $lock_usernames == 1) {
119 # Policy says no username changes
120 $self->ctx->{username_change_disallowed} = 1;
122 my $username_unlimit = $self->ctx->{get_org_setting}->($e->requestor->home_ou, 'opac.unlimit_usernames');
123 if(!$username_unlimit) {
124 my $regex_check = $self->ctx->{get_org_setting}->($e->requestor->home_ou, 'opac.barcode_regex');
126 # Default is "starts with a number"
127 $regex_check = '^\d+';
129 # You already have a username?
130 if($regex_check and $self->ctx->{user}->usrname !~ /$regex_check/) {
131 $self->ctx->{username_change_disallowed} = 1;
136 return Apache2::Const::OK unless
137 $pending_addr or $replace_addr or $delete_pending;
139 my @form_fields = qw/address_type street1 street2 city county state country post_code/;
142 if( $pending_addr ) { # update an existing pending address
144 ($paddr) = grep { $_->id == $pending_addr } @{$user->addresses};
145 return Apache2::Const::HTTP_BAD_REQUEST unless $paddr;
146 $paddr->$_( $cgi->param($_) ) for @form_fields;
148 } elsif( $replace_addr ) { # create a new pending address for 'replace_addr'
150 $paddr = Fieldmapper::actor::user_address->new;
152 $paddr->usr($user->id);
153 $paddr->pending('t');
154 $paddr->replaces($replace_addr);
155 $paddr->$_( $cgi->param($_) ) for @form_fields;
157 } elsif( $delete_pending ) {
158 $paddr = $e->retrieve_actor_user_address($delete_pending);
159 return Apache2::Const::HTTP_BAD_REQUEST unless
160 $paddr and $paddr->usr == $user->id and $U->is_true($paddr->pending);
161 $paddr->isdeleted(1);
164 my $resp = $U->simplereq(
166 'open-ils.actor.user.address.pending.cud',
167 $e->authtoken, $paddr);
169 if( $U->event_code($resp) ) {
170 $logger->error("Error updating pending address: $resp");
171 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
174 # in light of these changes, re-fetch latest data
176 $self->prepare_extended_user_info;
179 return Apache2::Const::OK;
182 sub load_myopac_prefs_notify {
184 my $e = $self->editor;
187 my $stat = $self->_load_user_with_prefs;
188 return $stat if $stat;
190 my $user_prefs = $self->fetch_optin_prefs;
191 $user_prefs = $self->update_optin_prefs($user_prefs)
192 if $self->cgi->request_method eq 'POST';
194 $self->ctx->{opt_in_settings} = $user_prefs;
196 return Apache2::Const::OK
197 unless $self->cgi->request_method eq 'POST';
200 my $set_map = $self->ctx->{user_setting_map};
204 opac.default_sms_notify
206 my $val = $self->cgi->param($key);
207 $settings{$key}= $val unless $$set_map{$key} eq $val;
210 my $key = 'opac.default_sms_carrier';
211 my $val = $self->cgi->param('sms_carrier');
212 $settings{$key}= $val unless $$set_map{$key} eq $val;
214 $key = 'opac.hold_notify';
215 my @notify_methods = ();
216 if ($self->cgi->param($key . ".email") eq 'on') {
217 push @notify_methods, "email";
219 if ($self->cgi->param($key . ".phone") eq 'on') {
220 push @notify_methods, "phone";
222 if ($self->cgi->param($key . ".sms") eq 'on') {
223 push @notify_methods, "sms";
225 $val = join("|",@notify_methods);
226 $settings{$key}= $val unless $$set_map{$key} eq $val;
228 # Send the modified settings off to be saved
231 'open-ils.actor.patron.settings.update',
232 $self->editor->authtoken, undef, \%settings);
234 # re-fetch user prefs
235 $self->ctx->{updated_user_settings} = \%settings;
236 return $self->_load_user_with_prefs || Apache2::Const::OK;
239 sub fetch_optin_prefs {
241 my $e = $self->editor;
243 # fetch all of the opt-in settings the user has access to
244 # XXX: user's should in theory have options to opt-in to notices
245 # for remote locations, but that opens the door for a large
246 # set of generally un-used opt-ins.. needs discussion
247 my $opt_ins = $U->simplereq(
249 'open-ils.actor.event_def.opt_in.settings.atomic',
250 $e->authtoken, $e->requestor->home_ou);
252 # some opt-ins are staff-only
253 $opt_ins = [ grep { $U->is_true($_->opac_visible) } @$opt_ins ];
255 # fetch user setting values for each of the opt-in settings
256 my $user_set = $U->simplereq(
258 'open-ils.actor.patron.settings.retrieve',
261 [map {$_->name} @$opt_ins]
264 return [map { {cust => $_, value => $user_set->{$_->name} } } @$opt_ins];
267 sub load_myopac_messages {
269 my $e = $self->editor;
270 my $ctx = $self->ctx;
271 my $cgi = $self->cgi;
273 my $limit = $cgi->param('limit') || 20;
274 my $offset = $cgi->param('offset') || 0;
276 my $pcrud = OpenSRF::AppSession->create('open-ils.pcrud');
279 my $action = $cgi->param('action') || '';
281 my ($changed, $failed) = $self->_handle_message_action($pcrud, $action);
282 if ($changed > 0 || $failed > 0) {
283 $ctx->{message_update_action} = $action;
284 $ctx->{message_update_changed} = $changed;
285 $ctx->{message_update_failed} = $failed;
286 $self->update_dashboard_stats();
290 my $single = $cgi->param('single') || 0;
291 my $id = $cgi->param('message_id');
295 if (!$action && $single && $id) {
296 $messages = $self->_fetch_and_mark_read_single_message($pcrud, $id);
297 if (scalar(@$messages) == 1) {
298 $ctx->{display_single_message} = 1;
299 $ctx->{patron_message_id} = $id;
305 # fetch all the messages
306 ($ctx->{patron_messages_count}, $messages) =
307 $self->_fetch_user_messages($pcrud, $offset, $limit);
312 foreach my $aum (@$messages) {
314 push @{ $ctx->{patron_messages} }, {
316 title => $aum->title,
317 message => $aum->message,
318 create_date => $aum->create_date,
319 is_read => defined($aum->read_date) ? 1 : 0,
320 library => $aum->sending_lib->name,
324 $ctx->{patron_messages_limit} = $limit;
325 $ctx->{patron_messages_offset} = $offset;
327 return Apache2::Const::OK;
330 sub _fetch_and_mark_read_single_message {
335 $pcrud->request('open-ils.pcrud.transaction.begin', $self->editor->authtoken)->gather(1);
336 my $messages = $pcrud->request(
337 'open-ils.pcrud.search.auml.atomic',
338 $self->editor->authtoken,
340 usr => $self->editor->requestor->id,
346 flesh_fields => { auml => ['sending_lib'] },
350 $messages->[0]->read_date('now');
352 'open-ils.pcrud.update.auml',
353 $self->editor->authtoken,
357 $pcrud->request('open-ils.pcrud.transaction.commit', $self->editor->authtoken)->gather(1);
359 $self->update_dashboard_stats();
364 sub _fetch_user_messages {
370 my %paging = ($limit or $offset) ? (limit => $limit, offset => $offset) : ();
372 my $all_messages = $pcrud->request(
373 'open-ils.pcrud.id_list.auml.atomic',
374 $self->editor->authtoken,
376 usr => $self->editor->requestor->id,
382 my $messages = $pcrud->request(
383 'open-ils.pcrud.search.auml.atomic',
384 $self->editor->authtoken,
386 usr => $self->editor->requestor->id,
391 flesh_fields => { auml => ['sending_lib'] },
392 order_by => { auml => 'create_date DESC' },
397 return scalar(@$all_messages), $messages;
400 sub _handle_message_action {
404 my $cgi = $self->cgi;
406 my @ids = $cgi->param('message_id');
407 return (0, 0) unless @ids;
411 $pcrud->request('open-ils.pcrud.transaction.begin', $self->editor->authtoken)->gather(1);
413 my $aum = $pcrud->request(
414 'open-ils.pcrud.retrieve.auml',
415 $self->editor->authtoken,
419 if ($action eq 'mark_read') {
420 $aum->read_date('now');
421 } elsif ($action eq 'mark_unread') {
422 $aum->clear_read_date();
423 } elsif ($action eq 'mark_deleted') {
426 $pcrud->request('open-ils.pcrud.update.auml', $self->editor->authtoken, $aum)->gather(1) ?
431 $pcrud->request('open-ils.pcrud.transaction.rollback', $self->editor->authtoken)->gather(1);
433 $failed = scalar(@ids);
435 $pcrud->request('open-ils.pcrud.transaction.commit', $self->editor->authtoken)->gather(1);
437 return ($changed, $failed);
440 sub _load_lists_and_settings {
442 my $e = $self->editor;
443 my $stat = $self->_load_user_with_prefs;
446 my $setting_map = $self->ctx->{user_setting_map};
447 $exclude = $$setting_map{'opac.default_list'} if ($$setting_map{'opac.default_list'});
448 $self->ctx->{bookbags} = $e->search_container_biblio_record_entry_bucket(
450 {owner => $self->ctx->{user}->id, btype => 'bookbag', id => {'<>' => $exclude}}, {
451 order_by => {cbreb => 'name'},
452 limit => $self->cgi->param('limit') || 10,
453 offset => $self->cgi->param('offset') || 0
457 # We also want a total count of the user's bookbags.
459 'select' => { 'cbreb' => [ { 'column' => 'id', 'transform' => 'count', 'aggregate' => 'true', 'alias' => 'count' } ] },
461 'where' => { 'btype' => 'bookbag', 'owner' => $self->ctx->{user}->id }
463 my $r = $e->json_query($q);
464 $self->ctx->{bookbag_count} = $r->[0]->{'count'};
465 # Someone has requested that we use the default list's name
466 # rather than "Default List."
469 'select' => {'cbreb' => ['name']},
471 'where' => {'id' => $exclude}
473 $r = $e->json_query($q);
474 $self->ctx->{default_bookbag} = $r->[0]->{'name'};
482 sub update_optin_prefs {
484 my $user_prefs = shift;
485 my $e = $self->editor;
486 my @settings = $self->cgi->param('setting');
489 # apply now-true settings
490 for my $applied (@settings) {
491 # see if setting is already applied to this user
492 next if grep { $_->{cust}->name eq $applied and $_->{value} } @$user_prefs;
493 $newsets{$applied} = OpenSRF::Utils::JSON->true;
496 # remove now-false settings
497 for my $pref (grep { $_->{value} } @$user_prefs) {
498 $newsets{$pref->{cust}->name} = undef
499 unless grep { $_ eq $pref->{cust}->name } @settings;
504 'open-ils.actor.patron.settings.update',
505 $e->authtoken, $e->requestor->id, \%newsets);
507 # update the local prefs to match reality
508 for my $pref (@$user_prefs) {
509 $pref->{value} = $newsets{$pref->{cust}->name}
510 if exists $newsets{$pref->{cust}->name};
516 sub _load_user_with_prefs {
518 my $stat = $self->prepare_extended_user_info('settings');
519 return $stat if $stat; # not-OK
521 $self->ctx->{user_setting_map} = {
522 map { $_->name => OpenSRF::Utils::JSON->JSON2perl($_->value) }
523 @{$self->ctx->{user}->settings}
529 sub _get_bookbag_sort_params {
530 my ($self, $param_name) = @_;
532 # The interface that feeds this cgi parameter will provide a single
533 # argument for a QP sort filter, and potentially a modifier after a period.
534 # In practice this means the "sort" parameter will be something like
535 # "titlesort" or "authorsort.descending".
536 my $sorter = $self->cgi->param($param_name) || "";
539 $sorter =~ s/^(.*?)\.(.*)/$1/;
540 $modifier = $2 || undef;
543 return ($sorter, $modifier);
546 sub _prepare_bookbag_container_query {
547 my ($self, $container_id, $sorter, $modifier) = @_;
550 "container(bre,bookbag,%d,%s)%s%s",
551 $container_id, $self->editor->authtoken,
552 ($sorter ? " sort($sorter)" : ""),
553 ($modifier ? "#$modifier" : "")
557 sub _prepare_anonlist_sorting_query {
558 my ($self, $list, $sorter, $modifier) = @_;
561 "record_list(%s)%s%s",
563 ($sorter ? " sort($sorter)" : ""),
564 ($modifier ? "#$modifier" : "")
569 sub load_myopac_prefs_settings {
574 opac.default_search_location
575 opac.default_pickup_location
576 opac.temporary_list_no_warn
579 my $stat = $self->_load_user_with_prefs;
580 return $stat if $stat;
582 # if behind-desk holds are supported and the user
583 # setting which controls the value is opac-visible,
584 # add the setting to the list of settings to manage.
585 # note: this logic may need to be changed later to
586 # check whether behind-the-desk holds are supported
587 # anywhere the patron may select as a pickup lib.
588 my $e = $self->editor;
589 my $bdous = $self->ctx->{get_org_setting}->(
590 $e->requestor->home_ou,
591 'circ.holds.behind_desk_pickup_supported');
595 $e->retrieve_config_usr_setting_type(
596 'circ.holds_behind_desk');
598 if ($U->is_true($setting->opac_visible)) {
599 push(@user_prefs, 'circ.holds_behind_desk');
600 $self->ctx->{behind_desk_supported} = 1;
604 return Apache2::Const::OK
605 unless $self->cgi->request_method eq 'POST';
607 # some setting values from the form don't match the
608 # required value/format for the db, so they have to be
609 # individually translated.
612 my $set_map = $self->ctx->{user_setting_map};
614 foreach my $key (@user_prefs) {
615 my $val = $self->cgi->param($key);
616 $settings{$key}= $val unless $$set_map{$key} eq $val;
619 # Used by the settings update form when warning on history delete.
620 my $clear_circ_history = 0;
621 my $clear_hold_history = 0;
623 # true if we need to show the warning on next page load.
624 my $hist_warning_needed = 0;
625 my $hist_clear_confirmed = $self->cgi->param('history_delete_confirmed');
627 my $now = DateTime->now->strftime('%F');
629 qw/history.circ.retention_start history.hold.retention_start/) {
631 my $val = $self->cgi->param($key);
632 if($val and $val eq 'on') {
633 # Set the start time to 'now' unless a start time already exists for the user
634 $settings{$key} = $now unless $$set_map{$key};
638 next unless $$set_map{$key}; # nothing to do
640 $clear_circ_history = 1 if $key =~ /circ/;
641 $clear_hold_history = 1 if $key =~ /hold/;
643 if (!$hist_clear_confirmed) {
644 # when clearing circ history, only warn if history data exists.
646 if ($clear_circ_history) {
648 if ($self->fetch_user_circ_history(0, 1)->[0]) {
649 $hist_warning_needed = 1;
650 next; # no history updates while confirmation pending
655 my $one_hold = $e->json_query({
659 transform => 'action.usr_visible_holds',
664 where => {id => $e->requestor->id},
669 $hist_warning_needed = 1;
670 next; # no history updates while confirmation pending
675 $settings{$key} = undef;
677 if ($key eq 'history.circ.retention_start') {
678 # delete existing circulation history data.
681 'open-ils.actor.history.circ.clear',
682 $self->editor->authtoken);
687 # Warn patrons before clearing circ/hold history
688 if ($hist_warning_needed) {
689 $self->ctx->{clear_circ_history} = $clear_circ_history;
690 $self->ctx->{clear_hold_history} = $clear_hold_history;
691 $self->ctx->{confirm_history_delete} = 1;
694 # Send the modified settings off to be saved
697 'open-ils.actor.patron.settings.update',
698 $self->editor->authtoken, undef, \%settings);
700 # re-fetch user prefs
701 $self->ctx->{updated_user_settings} = \%settings;
702 return $self->_load_user_with_prefs || Apache2::Const::OK;
705 sub load_myopac_prefs_my_lists {
710 opac.list_items_per_page
713 my $stat = $self->_load_user_with_prefs;
714 return $stat if $stat;
716 return Apache2::Const::OK
717 unless $self->cgi->request_method eq 'POST';
720 my $set_map = $self->ctx->{user_setting_map};
722 foreach my $key (@user_prefs) {
723 my $val = $self->cgi->param($key);
724 $settings{$key}= $val unless $$set_map{$key} eq $val;
727 if (keys %settings) { # we found a different setting value
728 # Send the modified settings off to be saved
731 'open-ils.actor.patron.settings.update',
732 $self->editor->authtoken, undef, \%settings);
734 # re-fetch user prefs
735 $self->ctx->{updated_user_settings} = \%settings;
736 $stat = $self->_load_user_with_prefs;
739 return $stat || Apache2::Const::OK;
742 sub fetch_user_holds {
744 my $hold_ids = shift;
745 my $ids_only = shift;
747 my $available = shift;
751 my $e = $self->editor;
752 my $all_ids; # to be used below.
755 my $circ = OpenSRF::AppSession->create('open-ils.circ');
757 $hold_ids = $circ->request(
758 'open-ils.circ.holds.id_list.retrieve.authoritative',
765 $all_ids = $hold_ids;
766 $hold_ids = [ grep { defined $_ } @$hold_ids[$offset..($offset + $limit - 1)] ] if $limit or $offset;
769 $all_ids = $hold_ids;
772 return { ids => $hold_ids, all_ids => $all_ids } if $ids_only or @$hold_ids == 0;
775 suppress_notices => 1,
776 suppress_transits => 1,
778 suppress_patron_details => 1
781 # ----------------------------------------------------------------
782 # Collect holds in batches of $batch_size for faster retrieval
786 my $mk_req_batch = sub {
788 my $top_idx = $batch_idx + $batch_size;
789 while($batch_idx < $top_idx) {
790 my $hold_id = $hold_ids->[$batch_idx++];
791 last unless $hold_id;
792 my $ses = OpenSRF::AppSession->create('open-ils.circ');
793 my $req = $ses->request(
794 'open-ils.circ.hold.details.retrieve',
795 $e->authtoken, $hold_id, $args);
796 push(@ses, {ses => $ses, req => $req});
802 my(@collected, @holds, @ses);
805 @ses = $mk_req_batch->() if $first;
806 last if $first and not @ses;
809 while(my $blob = pop(@collected)) {
812 # in the holds edit UI, we need to know what formats and
813 # languages the user selected for this hold, plus what
814 # formats/langs are available on the MR as a whole.
815 if ($blob->{hold}{hold}->hold_type eq 'M') {
816 my $hold = $blob->{hold}->{hold};
818 # for MR, fetch the combined MR unapi blob
819 (undef, @data) = $self->get_records_and_facets(
820 [$hold->target], undef, {flesh => '{mra}', metarecord => 1});
822 my $filter_org = $U->org_unit_ancestor_at_depth(
824 $hold->selection_depth);
826 my $filter_data = $U->simplereq(
828 'open-ils.circ.mmr.holds.filters.authoritative.atomic',
829 $hold->target, $filter_org, [$hold->id]
832 $blob->{metarecord_filters} =
833 $filter_data->[0]->{metarecord};
834 $blob->{metarecord_selected_filters} =
835 $filter_data->[1]->{hold};
838 (undef, @data) = $self->get_records_and_facets(
839 [$blob->{hold}->{bre_id}], undef, {flesh => '{mra}'}
843 $blob->{marc_xml} = $data[0]->{marc_xml};
848 for my $req_data (@ses) {
849 push(@collected, {hold => $req_data->{req}->gather(1)});
850 $req_data->{ses}->kill_me;
853 @ses = $mk_req_batch->();
854 last unless @collected or @ses;
858 # put the holds back into the original server sort order
860 for my $id (@$hold_ids) {
861 push @sorted, grep { $_->{hold}->{hold}->id == $id } @holds;
864 return { holds => \@sorted, ids => $hold_ids, all_ids => $all_ids };
867 sub handle_hold_update {
870 my $hold_ids = shift;
871 my $e = $self->editor;
874 my @hold_ids = ($hold_ids) ? @$hold_ids : $self->cgi->param('hold_id'); # for non-_all actions
875 @hold_ids = @{$self->fetch_user_holds(undef, 1)->{ids}} if $action =~ /_all/;
877 my $circ = OpenSRF::AppSession->create('open-ils.circ');
879 if($action =~ /cancel/) {
881 for my $hold_id (@hold_ids) {
882 my $resp = $circ->request(
883 'open-ils.circ.hold.cancel', $e->authtoken, $hold_id, 6 )->gather(1); # 6 == patron-cancelled-via-opac
886 } elsif ($action =~ /activate|suspend/) {
889 for my $hold_id (@hold_ids) {
890 my $vals = {id => $hold_id};
892 if($action =~ /activate/) {
893 $vals->{frozen} = 'f';
894 $vals->{thaw_date} = undef;
896 } elsif($action =~ /suspend/) {
897 $vals->{frozen} = 't';
898 # $vals->{thaw_date} = TODO;
900 push(@$vlist, $vals);
903 my $resp = $circ->request('open-ils.circ.hold.update.batch.atomic', $e->authtoken, undef, $vlist)->gather(1);
904 $self->ctx->{hold_suspend_post_capture} = 1 if
905 grep {$U->event_equals($_, 'HOLD_SUSPEND_AFTER_CAPTURE')} @$resp;
907 } elsif ($action eq 'edit') {
910 my $val = {"id" => $_};
911 $val->{"frozen"} = $self->cgi->param("frozen");
912 $val->{"pickup_lib"} = $self->cgi->param("pickup_lib");
914 for my $field (qw/expire_time thaw_date/) {
915 # XXX TODO make this support other date formats, not just
917 next unless $self->cgi->param($field) =~
918 m:^(\d{2})/(\d{2})/(\d{4})$:;
919 $val->{$field} = "$3-$1-$2";
922 $val->{holdable_formats} = # no-op for non-MR holds
923 $self->compile_holdable_formats(undef, $_);
929 'open-ils.circ.hold.update.batch.atomic',
930 $e->authtoken, undef, \@vals
931 )->gather(1); # LFW XXX test for failure
932 $url = $self->ctx->{proto} . '://' . $self->ctx->{hostname} . $self->ctx->{opac_root} . '/myopac/holds';
933 foreach my $param (('loc', 'qtype', 'query')) {
934 if ($self->cgi->param($param)) {
935 $url .= ";$param=" . uri_escape_utf8($self->cgi->param($param));
941 return defined($url) ? $self->generic_redirect($url) : undef;
944 sub load_myopac_holds {
946 my $e = $self->editor;
947 my $ctx = $self->ctx;
949 my $limit = $self->cgi->param('limit') || 15;
950 my $offset = $self->cgi->param('offset') || 0;
951 my $action = $self->cgi->param('action') || '';
952 my $hold_id = $self->cgi->param('id');
953 my $available = int($self->cgi->param('available') || 0);
955 my $hold_handle_result;
956 $hold_handle_result = $self->handle_hold_update($action) if $action;
959 if ($self->cgi->param('sort') ne "") {
960 $holds_object = $self->fetch_user_holds($hold_id ? [$hold_id] : undef, 0, 1, $available);
963 $holds_object = $self->fetch_user_holds($hold_id ? [$hold_id] : undef, 0, 1, $available, $limit, $offset);
966 if($holds_object->{holds}) {
967 $ctx->{holds} = $holds_object->{holds};
969 $ctx->{holds_ids} = $holds_object->{all_ids};
970 $ctx->{holds_limit} = $limit;
971 $ctx->{holds_offset} = $offset;
973 return defined($hold_handle_result) ? $hold_handle_result : Apache2::Const::OK;
978 sub load_place_hold {
980 my $ctx = $self->ctx;
981 my $gos = $ctx->{get_org_setting};
982 my $e = $self->editor;
983 my $cgi = $self->cgi;
985 $self->ctx->{page} = 'place_hold';
986 my @targets = $cgi->param('hold_target');
987 my @parts = $cgi->param('part');
989 $ctx->{hold_type} = $cgi->param('hold_type');
990 $ctx->{default_pickup_lib} = $e->requestor->home_ou; # unless changed below
991 $ctx->{email_notify} = $cgi->param('email_notify');
992 if ($cgi->param('phone_notify_checkbox')) {
993 $ctx->{phone_notify} = $cgi->param('phone_notify');
995 if ($cgi->param('sms_notify_checkbox')) {
996 $ctx->{sms_notify} = $cgi->param('sms_notify');
997 $ctx->{sms_carrier} = $cgi->param('sms_carrier');
1000 return $self->generic_redirect unless @targets;
1002 $logger->info("Looking at hold_type: " . $ctx->{hold_type} . " and targets: @targets");
1004 $ctx->{staff_recipient} = $self->editor->retrieve_actor_user([
1009 au => ['settings', 'card']
1012 ]) or return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
1013 my $user_setting_map = {
1014 map { $_->name => OpenSRF::Utils::JSON->JSON2perl($_->value) }
1016 $ctx->{staff_recipient}->settings
1019 $ctx->{user_setting_map} = $user_setting_map;
1021 my $default_notify = (defined $$user_setting_map{'opac.hold_notify'} ? $$user_setting_map{'opac.hold_notify'} : 'email:phone');
1022 if ($default_notify =~ /email/) {
1023 $ctx->{default_email_notify} = 'checked';
1025 $ctx->{default_email_notify} = '';
1027 if ($default_notify =~ /phone/) {
1028 $ctx->{default_phone_notify} = 'checked';
1030 $ctx->{default_phone_notify} = '';
1032 if ($default_notify =~ /sms/) {
1033 $ctx->{default_sms_notify} = 'checked';
1035 $ctx->{default_sms_notify} = '';
1038 # If we have a default pickup location, grab it
1039 if ($$user_setting_map{'opac.default_pickup_location'}) {
1040 $ctx->{default_pickup_lib} = $$user_setting_map{'opac.default_pickup_location'};
1043 my $request_lib = $e->requestor->ws_ou;
1045 $ctx->{hold_data} = \@hold_data;
1047 $data_filler = sub {
1049 if ($ctx->{email_notify}) { $hdata->{email_notify} = $ctx->{email_notify}; }
1050 if ($ctx->{phone_notify}) { $hdata->{phone_notify} = $ctx->{phone_notify}; }
1051 if ($ctx->{sms_notify}) { $hdata->{sms_notify} = $ctx->{sms_notify}; }
1052 if ($ctx->{sms_carrier}) { $hdata->{sms_carrier} = $ctx->{sms_carrier}; }
1056 my $type_dispatch = {
1058 # target metarecords
1059 my $mrecs = $e->batch_retrieve_metabib_metarecord([
1061 {flesh => 1, flesh_fields => {mmr => ['master_record']}}],
1065 for my $id (@targets) {
1066 my ($mr) = grep {$_->id eq $id} @$mrecs;
1068 my $ou_id = $cgi->param('pickup_lib') || $self->ctx->{search_ou};
1069 my $filter_data = $U->simplereq(
1071 'open-ils.circ.mmr.holds.filters.authoritative', $mr->id, $ou_id);
1073 my $holdable_formats =
1074 $self->compile_holdable_formats($mr->id);
1076 push(@hold_data, $data_filler->({
1078 record => $mr->master_record,
1079 holdable_formats => $holdable_formats,
1080 metarecord_filters => $filter_data->{metarecord}
1085 my $recs = $e->batch_retrieve_biblio_record_entry(
1086 [\@targets, {flesh => 1, flesh_fields => {bre => ['metarecord']}}],
1090 for my $id (@targets) { # force back into the correct order
1091 my ($rec) = grep {$_->id eq $id} @$recs;
1093 # NOTE: if tpac ever supports locked-down pickup libs,
1094 # we'll need to pass a pickup_lib param along with the
1095 # record to filter the set of monographic parts.
1096 my $parts = $U->simplereq(
1098 'open-ils.search.biblio.record_hold_parts',
1099 {record => $rec->id}
1102 # T holds on records that have parts are OK, but if the record has
1103 # no non-part copies, the hold will ultimately fail. When that
1104 # happens, require the user to select a part.
1105 my $part_required = 0;
1107 my $np_copies = $e->json_query({
1108 select => { acp => [{column => 'id', transform => 'count', alias => 'count'}]},
1109 from => {acp => {acn => {}, acpm => {type => 'left'}}},
1111 '+acp' => {deleted => 'f'},
1112 '+acn' => {deleted => 'f', record => $rec->id},
1113 '+acpm' => {id => undef}
1116 $part_required = 1 if $np_copies->[0]->{count} == 0;
1119 push(@hold_data, $data_filler->({
1123 part_required => $part_required
1128 my $vols = $e->batch_retrieve_asset_call_number([
1131 "flesh_fields" => {"acn" => ["record"]}
1133 ], {substream => 1});
1135 for my $id (@targets) {
1136 my ($vol) = grep {$_->id eq $id} @$vols;
1137 push(@hold_data, $data_filler->({target => $vol, record => $vol->record}));
1141 my $copies = $e->batch_retrieve_asset_copy([
1145 "acn" => ["record"],
1146 "acp" => ["call_number"]
1149 ], {substream => 1});
1151 for my $id (@targets) {
1152 my ($copy) = grep {$_->id eq $id} @$copies;
1153 push(@hold_data, $data_filler->({target => $copy, record => $copy->call_number->record}));
1157 my $isses = $e->batch_retrieve_serial_issuance([
1161 "siss" => ["subscription"], "ssub" => ["record_entry"]
1164 ], {substream => 1});
1166 for my $id (@targets) {
1167 my ($iss) = grep {$_->id eq $id} @$isses;
1168 push(@hold_data, $data_filler->({target => $iss, record => $iss->subscription->record_entry}));
1173 }->{$ctx->{hold_type}}->();
1175 # caller sent bad target IDs or the wrong hold type
1176 return Apache2::Const::HTTP_BAD_REQUEST unless @hold_data;
1178 # generate the MARC xml for each record
1179 $_->{marc_xml} = XML::LibXML->new->parse_string($_->{record}->marc) for @hold_data;
1181 my $pickup_lib = $cgi->param('pickup_lib');
1182 # no pickup lib means no holds placement
1183 return Apache2::Const::OK unless $pickup_lib;
1185 $ctx->{hold_attempt_made} = 1;
1187 # Give the original CGI params back to the user in case they
1188 # want to try to override something.
1189 $ctx->{orig_params} = $cgi->Vars;
1190 delete $ctx->{orig_params}{submit};
1191 delete $ctx->{orig_params}{hold_target};
1192 delete $ctx->{orig_params}{part};
1194 my $usr = $e->requestor->id;
1196 if ($ctx->{is_staff} and !$cgi->param("hold_usr_is_requestor")) {
1197 # find the real hold target
1199 $usr = $U->simplereq(
1201 "open-ils.actor.user.retrieve_id_by_barcode_or_username",
1202 $e->authtoken, $cgi->param("hold_usr"));
1204 if (defined $U->event_code($usr)) {
1205 $ctx->{hold_failed} = 1;
1206 $ctx->{hold_failed_event} = $usr;
1210 # target_id is the true target_id for holds placement.
1211 # needed for attempt_hold_placement()
1212 # With the exception of P-type holds, target_id == target->id.
1213 $_->{target_id} = $_->{target}->id for @hold_data;
1215 if ($ctx->{hold_type} eq 'T') {
1217 # Much like quantum wave-particles, P-type holds pop into
1218 # and out of existence at the user's whim. For our purposes,
1219 # we treat such holds as T(itle) holds with a selected_part
1220 # designation. When the time comes to pass the hold information
1221 # off for holds possibility testing and placement, make it look
1222 # like a real P-type hold.
1223 my (@p_holds, @t_holds);
1225 for my $idx (0..$#parts) {
1226 my $hdata = $hold_data[$idx];
1227 if (my $part = $parts[$idx]) {
1228 $hdata->{target_id} = $part;
1229 $hdata->{selected_part} = $part;
1230 push(@p_holds, $hdata);
1232 push(@t_holds, $hdata);
1236 $self->apache->log->warn("$#parts : @t_holds");
1238 $self->attempt_hold_placement($usr, $pickup_lib, 'P', @p_holds) if @p_holds;
1239 $self->attempt_hold_placement($usr, $pickup_lib, 'T', @t_holds) if @t_holds;
1242 $self->attempt_hold_placement($usr, $pickup_lib, $ctx->{hold_type}, @hold_data);
1245 # NOTE: we are leaving the staff-placed patron barcode cookie
1246 # in place. Otherwise, it's not possible to place more than
1247 # one hold for the patron within a staff/patron session. This
1248 # does leave the barcode to linger longer than is ideal, but
1249 # normal staff work flow will cause the cookie to be replaced
1250 # with each new patron anyway.
1251 # TODO: See about getting the staff client to clear the cookie
1253 # return to the place_hold page so the results of the hold
1254 # placement attempt can be reported to the user
1255 return Apache2::Const::OK;
1258 sub attempt_hold_placement {
1259 my ($self, $usr, $pickup_lib, $hold_type, @hold_data) = @_;
1260 my $cgi = $self->cgi;
1261 my $ctx = $self->ctx;
1262 my $e = $self->editor;
1264 # First see if we should warn/block for any holds that
1265 # might have locally available items.
1266 for my $hdata (@hold_data) {
1267 my ($local_block, $local_alert) = $self->local_avail_concern(
1268 $hdata->{target_id}, $hold_type, $pickup_lib);
1271 $hdata->{hold_failed} = 1;
1272 $hdata->{hold_local_block} = 1;
1273 } elsif ($local_alert) {
1274 $hdata->{hold_failed} = 1;
1275 $hdata->{hold_local_alert} = 1;
1279 my $method = 'open-ils.circ.holds.test_and_create.batch';
1281 if ($cgi->param('override')) {
1282 $method .= '.override';
1284 } elsif (!$ctx->{is_staff}) {
1286 $method .= '.override' if $self->ctx->{get_org_setting}->(
1287 $e->requestor->home_ou, "opac.patron.auto_overide_hold_events");
1290 my @create_targets = map {$_->{target_id}} (grep { !$_->{hold_failed} } @hold_data);
1292 if(@create_targets) {
1294 # holdable formats may be different for each MR hold.
1295 # map each set to the ID of the target.
1296 my $holdable_formats = {};
1297 if ($hold_type eq 'M') {
1298 $holdable_formats->{$_->{target_id}} =
1299 $_->{holdable_formats} for @hold_data;
1302 my $bses = OpenSRF::AppSession->create('open-ils.circ');
1303 my $breq = $bses->request(
1308 pickup_lib => $pickup_lib,
1309 hold_type => $hold_type,
1310 holdable_formats_map => $holdable_formats
1315 while (my $resp = $breq->recv) {
1317 $resp = $resp->content;
1318 $logger->info('batch hold placement result: ' . OpenSRF::Utils::JSON->perl2JSON($resp));
1320 if ($U->event_code($resp)) {
1321 $ctx->{general_hold_error} = $resp;
1325 my ($hdata) = grep {$_->{target_id} eq $resp->{target}} @hold_data;
1326 my $result = $resp->{result};
1328 if ($U->event_code($result)) {
1329 # e.g. permission denied
1330 $hdata->{hold_failed} = 1;
1331 $hdata->{hold_failed_event} = $result;
1335 if(not ref $result and $result > 0) {
1336 # successul hold returns the hold ID
1338 $hdata->{hold_success} = $result;
1341 # hold-specific failure event
1342 $hdata->{hold_failed} = 1;
1344 if (ref $result eq 'HASH') {
1345 $hdata->{hold_failed_event} = $result->{last_event};
1347 if ($result->{age_protected_copy}) {
1348 my %temp = %{$hdata->{hold_failed_event}};
1349 my $theTextcode = $temp{"textcode"};
1350 $theTextcode.=".override";
1351 $hdata->{could_override} = $self->editor->allowed( $theTextcode );
1352 $hdata->{age_protect} = 1;
1354 $hdata->{could_override} = $result->{place_unfillable} ||
1355 $self->test_could_override($hdata->{hold_failed_event});
1357 } elsif (ref $result eq 'ARRAY') {
1358 $hdata->{hold_failed_event} = $result->[0];
1360 if ($result->[3]) { # age_protect_only
1361 my %temp = %{$hdata->{hold_failed_event}};
1362 my $theTextcode = $temp{"textcode"};
1363 $theTextcode.=".override";
1364 $hdata->{could_override} = $self->editor->allowed( $theTextcode );
1365 $hdata->{age_protect} = 1;
1367 $hdata->{could_override} = $result->[4] || # place_unfillable
1368 $self->test_could_override($hdata->{hold_failed_event});
1379 # pull the selected formats and languages for metarecord holds
1380 # from the CGI params and map them into the JSON holdable
1381 # formats...er, format.
1382 # if no metarecord is provided, we'll pull it from the target
1383 # of the provided hold.
1384 sub compile_holdable_formats {
1385 my ($self, $mr_id, $hold_id) = @_;
1386 my $e = $self->editor;
1387 my $cgi = $self->cgi;
1389 # exit early if not needed
1391 grep /metarecord_formats_|metarecord_langs_/,
1394 # CGI params are based on the MR id, since during hold placement
1395 # we have no old ID. During hold edit, map the hold ID back to
1396 # the metarecod target.
1398 $e->retrieve_action_hold_request($hold_id)->target
1401 my $format_attr = $self->ctx->{get_cgf}->(
1402 'opac.metarecord.holds.format_attr');
1404 if (!$format_attr) {
1405 $logger->error("Missing config.global_flag: ".
1406 "opac.metarecord.holds.format_attr!");
1410 $format_attr = $format_attr->value;
1412 # during hold placement or edit submission, the user selects
1413 # which of the available formats/langs are acceptable.
1414 # Capture those here as the holdable_formats for the MR hold.
1415 my @selected_formats = $cgi->param("metarecord_formats_$mr_id");
1416 my @selected_langs = $cgi->param("metarecord_langs_$mr_id");
1418 # map the selected attrs into the JSON holdable_formats structure
1420 if (@selected_formats) {
1422 map { {_attr => $format_attr, _val => $_} }
1426 if (@selected_langs) {
1428 map { {_attr => 'item_lang', _val => $_} }
1433 return OpenSRF::Utils::JSON->perl2JSON($blob);
1436 sub fetch_user_circs {
1438 my $flesh = shift; # flesh bib data, etc.
1439 my $circ_ids = shift;
1443 my $e = $self->editor;
1448 @circ_ids = @$circ_ids;
1453 select => {circ => ['id']},
1457 usr => $e->requestor->id,
1458 checkin_time => undef,
1460 {stop_fines => undef},
1461 {stop_fines => {'not in' => ['LOST','CLAIMSRETURNED','LONGOVERDUE']}}
1465 order_by => {circ => ['due_date']}
1468 $query->{limit} = $limit if $limit;
1469 $query->{offset} = $offset if $offset;
1471 my $ids = $e->json_query($query);
1472 @circ_ids = map {$_->{id}} @$ids;
1475 return [] unless @circ_ids;
1480 circ => ['target_copy'],
1481 acp => ['call_number'],
1487 my $circs = $e->search_action_circulation(
1488 [{id => \@circ_ids}, ($flesh) ? $qflesh : {}], {substream => 1});
1491 for my $circ (@$circs) {
1494 marc_xml => ($flesh and $circ->target_copy->call_number->id != -1) ?
1495 XML::LibXML->new->parse_string($circ->target_copy->call_number->record->marc) :
1496 undef # pre-cat copy, use the dummy title/author instead
1501 # make sure the final list is in the correct order
1503 for my $id (@circ_ids) {
1506 (grep { $_->{circ}->id == $id } @circs)
1510 return \@sorted_circs;
1514 sub handle_circ_renew {
1517 my $ctx = $self->ctx;
1519 my @renew_ids = $self->cgi->param('circ');
1521 my $circs = $self->fetch_user_circs(0, ($action eq 'renew') ? [@renew_ids] : undef);
1523 # TODO: fire off renewal calls in batches to speed things up
1525 for my $circ (@$circs) {
1527 my $evt = $U->simplereq(
1529 'open-ils.circ.renew',
1530 $self->editor->authtoken,
1532 patron_id => $self->editor->requestor->id,
1533 copy_id => $circ->{circ}->target_copy,
1538 # TODO return these, then insert them into the circ data
1539 # blob that is shoved into the template for each circ
1540 # so the template won't have to match them
1541 push(@responses, {copy => $circ->{circ}->target_copy, evt => $evt});
1547 sub load_myopac_circs {
1549 my $e = $self->editor;
1550 my $ctx = $self->ctx;
1553 my $limit = $self->cgi->param('limit') || 0; # 0 == unlimited
1554 my $offset = $self->cgi->param('offset') || 0;
1555 my $action = $self->cgi->param('action') || '';
1557 # perform the renewal first if necessary
1558 my @results = $self->handle_circ_renew($action) if $action =~ /renew/;
1560 $ctx->{circs} = $self->fetch_user_circs(1, undef, $limit, $offset);
1562 my $success_renewals = 0;
1563 my $failed_renewals = 0;
1564 for my $data (@{$ctx->{circs}}) {
1565 my ($resp) = grep { $_->{copy} == $data->{circ}->target_copy->id } @results;
1568 my $evt = ref($resp->{evt}) eq 'ARRAY' ? $resp->{evt}->[0] : $resp->{evt};
1570 # extract the fail_part, if present, from the event payload;
1571 # since # the payload is an acp object in some cases,
1572 # blindly looking for a # 'fail_part' key in the template can
1574 $evt->{fail_part} = (ref($evt->{payload}) eq 'HASH' && exists $evt->{payload}->{fail_part}) ?
1575 $evt->{payload}->{fail_part} :
1578 $data->{renewal_response} = $evt;
1579 $success_renewals++ if $evt->{textcode} eq 'SUCCESS';
1580 $failed_renewals++ if $evt->{textcode} ne 'SUCCESS';
1584 $ctx->{success_renewals} = $success_renewals;
1585 $ctx->{failed_renewals} = $failed_renewals;
1587 return Apache2::Const::OK;
1590 sub load_myopac_circ_history {
1592 my $e = $self->editor;
1593 my $ctx = $self->ctx;
1594 my $limit = $self->cgi->param('limit') || 15;
1595 my $offset = $self->cgi->param('offset') || 0;
1596 my $action = $self->cgi->param('action') || '';
1598 my $circ_handle_result;
1599 $circ_handle_result = $self->handle_circ_update($action) if $action;
1601 $ctx->{circ_history_limit} = $limit;
1602 $ctx->{circ_history_offset} = $offset;
1604 # Defer limitation to circ_history.tt2 when sorting
1605 if ($self->cgi->param('sort')) {
1610 $ctx->{circs} = $self->fetch_user_circ_history(1, $limit, $offset);
1611 return Apache2::Const::OK;
1614 # if 'flesh' is set, copy data etc. is loaded and the return value is
1615 # a hash of 'circ' and 'marc_xml'. Othwerwise, it's just a list of
1617 sub fetch_user_circ_history {
1618 my ($self, $flesh, $limit, $offset) = @_;
1619 my $e = $self->editor;
1622 $limits{offset} = $offset if defined $offset;
1623 $limits{limit} = $limit if defined $limit;
1628 auch => ['target_copy'],
1629 acp => ['call_number'],
1635 my $circs = $e->search_action_user_circ_history(
1637 {usr => $e->requestor->id},
1638 { # order newest to oldest by default
1639 order_by => {auch => 'xact_start DESC'},
1640 $flesh ? %flesh_ops : (),
1648 return $circs unless $flesh;
1651 for my $circ (@$circs) {
1654 marc_xml => ($circ->target_copy->call_number->id != -1) ?
1655 XML::LibXML->new->parse_string(
1656 $circ->target_copy->call_number->record->marc) :
1657 undef # pre-cat copy, use the dummy title/author instead
1664 sub handle_circ_update {
1667 my $circ_ids = shift;
1669 my $circ_ids //= [$self->cgi->param('circ_id')];
1671 if ($action =~ /delete/) {
1673 circ_ids => $circ_ids,
1678 'open-ils.actor.history.circ.clear',
1679 $self->editor->authtoken,
1687 # TODO: action.usr_visible_holds does not return cancelled holds. Should it?
1688 sub load_myopac_hold_history {
1690 my $e = $self->editor;
1691 my $ctx = $self->ctx;
1692 my $limit = $self->cgi->param('limit') || 15;
1693 my $offset = $self->cgi->param('offset') || 0;
1694 $ctx->{hold_history_limit} = $limit;
1695 $ctx->{hold_history_offset} = $offset;
1697 my $hold_ids = $e->json_query({
1701 transform => 'action.usr_visible_holds',
1702 result_field => 'id'
1706 where => {id => $e->requestor->id}
1709 my $holds_object = $self->fetch_user_holds([map { $_->{id} } @$hold_ids], 0, 1, 0, $limit, $offset);
1710 if($holds_object->{holds}) {
1711 $ctx->{holds} = $holds_object->{holds};
1713 $ctx->{hold_history_ids} = $holds_object->{all_ids};
1715 return Apache2::Const::OK;
1718 sub load_myopac_payment_form {
1722 $r = $self->prepare_fines(undef, undef, [$self->cgi->param('xact'), $self->cgi->param('xact_misc')]) and return $r;
1723 $r = $self->prepare_extended_user_info and return $r;
1725 return Apache2::Const::OK;
1728 # TODO: add other filter options as params/configs/etc.
1729 sub load_myopac_payments {
1731 my $limit = $self->cgi->param('limit') || 20;
1732 my $offset = $self->cgi->param('offset') || 0;
1733 my $e = $self->editor;
1735 $self->ctx->{payment_history_limit} = $limit;
1736 $self->ctx->{payment_history_offset} = $offset;
1739 $args->{limit} = $limit if $limit;
1740 $args->{offset} = $offset if $offset;
1742 if (my $max_age = $self->ctx->{get_org_setting}->(
1743 $e->requestor->home_ou, "opac.payment_history_age_limit"
1745 my $min_ts = DateTime->now(
1746 "time_zone" => DateTime::TimeZone->new("name" => "local"),
1747 )->subtract("seconds" => interval_to_seconds($max_age))->iso8601();
1749 $logger->info("XXX min_ts: $min_ts");
1750 $args->{"where"} = {"payment_ts" => {">=" => $min_ts}};
1753 $self->ctx->{payments} = $U->simplereq(
1755 'open-ils.actor.user.payments.retrieve.atomic',
1756 $e->authtoken, $e->requestor->id, $args);
1758 return Apache2::Const::OK;
1761 # 1. caches the form parameters
1762 # 2. loads the credit card payment "Processing..." page
1763 sub load_myopac_pay_init {
1765 my $cache = OpenSRF::Utils::Cache->new('global');
1767 my @payment_xacts = ($self->cgi->param('xact'), $self->cgi->param('xact_misc'));
1769 if (!@payment_xacts) {
1770 # for consistency with load_myopac_payment_form() and
1771 # to preserve backwards compatibility, if no xacts are
1772 # selected, assume all (applicable) transactions are wanted.
1773 my $stat = $self->prepare_fines(undef, undef, [$self->cgi->param('xact'), $self->cgi->param('xact_misc')]);
1774 return $stat if $stat;
1776 map { $_->{xact}->id } (
1777 @{$self->ctx->{fines}->{circulation}},
1778 @{$self->ctx->{fines}->{grocery}}
1782 return $self->generic_redirect unless @payment_xacts;
1784 my $cc_args = {"where_process" => 1};
1786 $cc_args->{$_} = $self->cgi->param($_) for (qw/
1787 number cvv2 expire_year expire_month billing_first
1788 billing_last billing_address billing_city billing_state
1789 billing_zip stripe_token
1793 cc_args => $cc_args,
1794 user => $self->ctx->{user}->id,
1795 xacts => \@payment_xacts
1798 # generate a temporary cache token and cache the form data
1799 my $token = md5_hex($$ . time() . rand());
1800 $cache->put_cache($token, $cache_args, 30);
1802 $logger->info("tpac caching payment info with token $token and xacts [@payment_xacts]");
1804 # after we render the processing page, we quickly redirect to submit
1805 # the actual payment. The refresh url contains the payment token.
1806 # It also contains the list of xact IDs, which allows us to clear the
1807 # cache at the earliest possible time while leaving a trace of which
1808 # transactions we were processing, so the UI can bring the user back
1809 # to the payment form w/ the same xacts if the payment fails.
1811 my $refresh = "1; url=main_pay/$token?xact=" . pop(@payment_xacts);
1812 $refresh .= ";xact=$_" for @payment_xacts;
1813 $self->ctx->{refresh} = $refresh;
1815 return Apache2::Const::OK;
1818 # retrieve the cached CC payment info and send off for processing
1819 sub load_myopac_pay {
1821 my $token = $self->ctx->{page_args}->[0];
1822 return Apache2::Const::HTTP_BAD_REQUEST unless $token;
1824 my $cache = OpenSRF::Utils::Cache->new('global');
1825 my $cache_args = $cache->get_cache($token);
1826 $cache->delete_cache($token);
1828 # this page is loaded immediately after the token is created.
1829 # if the cached data is not there, it's because of an invalid
1830 # token (or cache failure) and not because of a timeout.
1831 return Apache2::Const::HTTP_BAD_REQUEST unless $cache_args;
1833 my @payment_xacts = @{$cache_args->{xacts}};
1834 my $cc_args = $cache_args->{cc_args};
1836 # as an added security check, verify the user submitting
1837 # the form is the same as the user whose data was cached
1838 return Apache2::Const::HTTP_BAD_REQUEST unless
1839 $cache_args->{user} == $self->ctx->{user}->id;
1841 $logger->info("tpac paying fines with token $token and xacts [@payment_xacts]");
1844 $r = $self->prepare_fines(undef, undef, \@payment_xacts) and return $r;
1846 # balance_owed is computed specifically from the fines we're paying
1847 if ($self->ctx->{fines}->{balance_owed} <= 0) {
1848 $logger->info("tpac can't pay non-positive balance. xacts selected: [@payment_xacts]");
1849 return Apache2::Const::HTTP_BAD_REQUEST;
1853 "cc_args" => $cc_args,
1854 "userid" => $self->ctx->{user}->id,
1855 "payment_type" => "credit_card_payment",
1856 "payments" => $self->prepare_fines_for_payment # should be safe after self->prepare_fines
1859 my $resp = $U->simplereq("open-ils.circ", "open-ils.circ.money.payment",
1860 $self->editor->authtoken, $args, $self->ctx->{user}->last_xact_id
1863 $self->ctx->{"payment_response"} = $resp;
1865 unless ($resp->{"textcode"}) {
1866 $self->ctx->{printable_receipt} = $U->simplereq(
1867 "open-ils.circ", "open-ils.circ.money.payment_receipt.print",
1868 $self->editor->authtoken, $resp->{payments}
1872 return Apache2::Const::OK;
1875 sub load_myopac_receipt_print {
1878 $self->ctx->{printable_receipt} = $U->simplereq(
1879 "open-ils.circ", "open-ils.circ.money.payment_receipt.print",
1880 $self->editor->authtoken, [$self->cgi->param("payment")]
1883 return Apache2::Const::OK;
1886 sub load_myopac_receipt_email {
1889 # The following ML method doesn't actually check whether the user in
1890 # question has an email address, so we do.
1891 if ($self->ctx->{user}->email) {
1892 $self->ctx->{email_receipt_result} = $U->simplereq(
1893 "open-ils.circ", "open-ils.circ.money.payment_receipt.email",
1894 $self->editor->authtoken, [$self->cgi->param("payment")]
1897 $self->ctx->{email_receipt_result} =
1898 new OpenILS::Event("PATRON_NO_EMAIL_ADDRESS");
1901 return Apache2::Const::OK;
1905 my ($self, $limit, $offset, $id_list) = @_;
1907 # XXX TODO: check for failure after various network calls
1909 # It may be unclear, but this result structure lumps circulation and
1910 # reservation fines together, and keeps grocery fines separate.
1911 $self->ctx->{"fines"} = {
1912 "circulation" => [],
1919 my $cstore = OpenSRF::AppSession->create('open-ils.cstore');
1921 # TODO: This should really be a ML call, but the existing calls
1922 # return an excessive amount of data and don't offer streaming
1924 my %paging = ($limit or $offset) ? (limit => $limit, offset => $offset) : ();
1926 my $req = $cstore->request(
1927 'open-ils.cstore.direct.money.open_billable_transaction_summary.search',
1929 usr => $self->editor->requestor->id,
1930 balance_owed => {'!=' => 0},
1931 ($id_list && @$id_list ? ("id" => $id_list) : ()),
1936 mobts => [qw/grocery circulation reservation/],
1937 bresv => ['target_resource_type'],
1941 circ => ['target_copy'],
1942 acp => ['call_number'],
1945 order_by => { mobts => 'xact_start' },
1950 # Collect $$ amounts from each transaction for summing below.
1951 my (@paid_amounts, @owed_amounts, @balance_amounts);
1953 while(my $resp = $req->recv) {
1954 my $mobts = $resp->content;
1955 my $circ = $mobts->circulation;
1958 if($mobts->grocery) {
1959 my @billings = sort { $a->billing_ts cmp $b->billing_ts } @{$mobts->grocery->billings};
1960 $last_billing = pop(@billings);
1963 push(@paid_amounts, $mobts->total_paid);
1964 push(@owed_amounts, $mobts->total_owed);
1965 push(@balance_amounts, $mobts->balance_owed);
1967 my $marc_xml = undef;
1968 if ($mobts->xact_type eq 'reservation' and
1969 $mobts->reservation->target_resource_type->record) {
1970 $marc_xml = XML::LibXML->new->parse_string(
1971 $mobts->reservation->target_resource_type->record->marc
1973 } elsif ($mobts->xact_type eq 'circulation' and
1974 $circ->target_copy->call_number->id != -1) {
1975 $marc_xml = XML::LibXML->new->parse_string(
1976 $circ->target_copy->call_number->record->marc
1981 @{$self->ctx->{"fines"}->{$mobts->grocery ? "grocery" : "circulation"}},
1984 last_grocery_billing => $last_billing,
1985 marc_xml => $marc_xml
1992 $self->ctx->{"fines"}->{total_paid} = $U->fpsum(@paid_amounts);
1993 $self->ctx->{"fines"}->{total_owed} = $U->fpsum(@owed_amounts);
1994 $self->ctx->{"fines"}->{balance_owed} = $U->fpsum(@balance_amounts);
1999 sub prepare_fines_for_payment {
2000 # This assumes $self->prepare_fines has already been run
2004 if ($self->ctx->{fines}) {
2005 push @results, [$_->{xact}->id, $_->{xact}->balance_owed] foreach (
2006 @{$self->ctx->{fines}->{circulation}},
2007 @{$self->ctx->{fines}->{grocery}}
2014 sub load_myopac_main {
2016 my $limit = $self->cgi->param('limit') || 0;
2017 my $offset = $self->cgi->param('offset') || 0;
2018 $self->ctx->{search_ou} = $self->_get_search_lib();
2019 $self->ctx->{user}->notes(
2020 $self->editor->search_actor_usr_note({
2021 usr => $self->ctx->{user}->id,
2025 return $self->prepare_fines($limit, $offset) || Apache2::Const::OK;
2028 sub load_myopac_update_email {
2030 my $e = $self->editor;
2031 my $ctx = $self->ctx;
2032 my $email = $self->cgi->param('email') || '';
2033 my $current_pw = $self->cgi->param('current_pw') || '';
2035 # needed for most up-to-date email address
2036 if (my $r = $self->prepare_extended_user_info) { return $r };
2038 return Apache2::Const::OK
2039 unless $self->cgi->request_method eq 'POST';
2041 unless($email =~ /.+\@.+\..+/) { # TODO better regex?
2042 $ctx->{invalid_email} = $email;
2043 return Apache2::Const::OK;
2046 my $stat = $U->simplereq(
2048 'open-ils.actor.user.email.update',
2049 $e->authtoken, $email, $current_pw);
2051 if($U->event_equals($stat, 'INCORRECT_PASSWORD')) {
2052 $ctx->{password_incorrect} = 1;
2053 return Apache2::Const::OK;
2056 unless ($self->cgi->param("redirect_to")) {
2057 my $url = $self->apache->unparsed_uri;
2058 $url =~ s/update_email/prefs/;
2060 return $self->generic_redirect($url);
2063 return $self->generic_redirect;
2066 sub load_myopac_update_username {
2068 my $e = $self->editor;
2069 my $ctx = $self->ctx;
2070 my $username = $self->cgi->param('username') || '';
2071 my $current_pw = $self->cgi->param('current_pw') || '';
2073 $self->prepare_extended_user_info;
2075 my $allow_change = 1;
2077 my $lock_usernames = $self->ctx->{get_org_setting}->($e->requestor->home_ou, 'opac.lock_usernames');
2078 if(defined($lock_usernames) and $lock_usernames == 1) {
2079 # Policy says no username changes
2082 # We want this further down.
2083 $regex_check = $self->ctx->{get_org_setting}->($e->requestor->home_ou, 'opac.barcode_regex');
2084 my $username_unlimit = $self->ctx->{get_org_setting}->($e->requestor->home_ou, 'opac.unlimit_usernames');
2085 if(!$username_unlimit) {
2087 # Default is "starts with a number"
2088 $regex_check = '^\d+';
2090 # You already have a username?
2091 if($regex_check and $self->ctx->{user}->usrname !~ /$regex_check/) {
2096 if(!$allow_change) {
2097 my $url = $self->apache->unparsed_uri;
2098 $url =~ s/update_username/prefs/;
2100 return $self->generic_redirect($url);
2103 return Apache2::Const::OK
2104 unless $self->cgi->request_method eq 'POST';
2106 unless($username and $username !~ /\s/) { # any other username restrictions?
2107 $ctx->{invalid_username} = $username;
2108 return Apache2::Const::OK;
2111 # New username can't look like a barcode if we have a barcode regex
2112 if($regex_check and $username =~ /$regex_check/) {
2113 $ctx->{invalid_username} = $username;
2114 return Apache2::Const::OK;
2117 # New username has to look like a username if we have a username regex
2118 $regex_check = $ctx->{get_org_setting}->($e->requestor->home_ou, 'opac.username_regex');
2119 if($regex_check and $username !~ /$regex_check/) {
2120 $ctx->{invalid_username} = $username;
2121 return Apache2::Const::OK;
2124 if($username ne $e->requestor->usrname) {
2126 my $evt = $U->simplereq(
2128 'open-ils.actor.user.username.update',
2129 $e->authtoken, $username, $current_pw);
2131 if($U->event_equals($evt, 'INCORRECT_PASSWORD')) {
2132 $ctx->{password_incorrect} = 1;
2133 return Apache2::Const::OK;
2136 if($U->event_equals($evt, 'USERNAME_EXISTS')) {
2137 $ctx->{username_exists} = $username;
2138 return Apache2::Const::OK;
2142 my $url = $self->apache->unparsed_uri;
2143 $url =~ s/update_username/prefs/;
2145 return $self->generic_redirect($url);
2148 sub load_myopac_update_password {
2150 my $e = $self->editor;
2151 my $ctx = $self->ctx;
2153 return Apache2::Const::OK
2154 unless $self->cgi->request_method eq 'POST';
2156 my $current_pw = $self->cgi->param('current_pw') || '';
2157 my $new_pw = $self->cgi->param('new_pw') || '';
2158 my $new_pw2 = $self->cgi->param('new_pw2') || '';
2160 unless($new_pw eq $new_pw2) {
2161 $ctx->{password_nomatch} = 1;
2162 return Apache2::Const::OK;
2165 my $pw_regex = $ctx->{get_org_setting}->($e->requestor->home_ou, 'global.password_regex');
2168 # This regex duplicates the JSPac's default "digit, letter, and 7 characters" rule
2169 $pw_regex = '(?=.*\d+.*)(?=.*[A-Za-z]+.*).{7,}';
2172 if($pw_regex and $new_pw !~ /$pw_regex/) {
2173 $ctx->{password_invalid} = 1;
2174 return Apache2::Const::OK;
2177 my $evt = $U->simplereq(
2179 'open-ils.actor.user.password.update',
2180 $e->authtoken, $new_pw, $current_pw);
2183 if($U->event_equals($evt, 'INCORRECT_PASSWORD')) {
2184 $ctx->{password_incorrect} = 1;
2185 return Apache2::Const::OK;
2188 my $url = $self->apache->unparsed_uri;
2189 $url =~ s/update_password/prefs/;
2191 return $self->generic_redirect($url);
2194 sub _update_bookbag_metadata {
2195 my ($self, $bookbag) = @_;
2197 $bookbag->name($self->cgi->param("name"));
2198 $bookbag->description($self->cgi->param("description"));
2200 return 1 if $self->editor->update_container_biblio_record_entry_bucket($bookbag);
2204 sub _get_lists_per_page {
2207 if($self->editor->requestor) {
2208 $self->timelog("Checking for opac.lists_per_page preference");
2209 # See if the user has a lists per page preference
2210 my $ipp = $self->editor->search_actor_user_setting({
2211 usr => $self->editor->requestor->id,
2212 name => 'opac.lists_per_page'
2214 $self->timelog("Got opac.lists_per_page preference");
2215 return OpenSRF::Utils::JSON->JSON2perl($ipp->value) if $ipp;
2217 return 10; # default
2220 sub _get_items_per_page {
2223 if($self->editor->requestor) {
2224 $self->timelog("Checking for opac.list_items_per_page preference");
2225 # See if the user has a list items per page preference
2226 my $ipp = $self->editor->search_actor_user_setting({
2227 usr => $self->editor->requestor->id,
2228 name => 'opac.list_items_per_page'
2230 $self->timelog("Got opac.list_items_per_page preference");
2231 return OpenSRF::Utils::JSON->JSON2perl($ipp->value) if $ipp;
2233 return 10; # default
2236 sub load_myopac_bookbags {
2238 my $e = $self->editor;
2239 my $ctx = $self->ctx;
2240 my $limit = $self->_get_lists_per_page || 10;
2241 my $offset = $self->cgi->param('offset') || 0;
2243 $ctx->{bookbags_limit} = $limit;
2244 $ctx->{bookbags_offset} = $offset;
2246 # for list item pagination
2247 my $item_limit = $self->_get_items_per_page;
2248 my $item_page = $self->cgi->param('item_page') || 1;
2249 my $item_offset = ($item_page - 1) * $item_limit;
2250 $ctx->{bookbags_item_page} = $item_page;
2252 my ($sorter, $modifier) = $self->_get_bookbag_sort_params("sort");
2253 $e->xact_begin; # replication...
2255 my $rv = $self->load_mylist;
2256 unless($rv eq Apache2::Const::OK) {
2261 $ctx->{bookbags} = $e->search_container_biblio_record_entry_bucket(
2263 {owner => $e->requestor->id, btype => 'bookbag'}, {
2264 order_by => {cbreb => 'name'},
2272 if(!$ctx->{bookbags}) {
2274 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
2277 # We load the user prefs to get their default bookbag.
2278 $self->_load_user_with_prefs;
2280 # We also want a total count of the user's bookbags.
2282 'select' => { 'cbreb' => [ { 'column' => 'id', 'transform' => 'count', 'aggregate' => 'true', 'alias' => 'count' } ] },
2284 'where' => { 'btype' => 'bookbag', 'owner' => $self->ctx->{user}->id }
2286 my $r = $e->json_query($q);
2287 $ctx->{bookbag_count} = $r->[0]->{'count'};
2289 # If the user wants a specific bookbag's items, load them.
2291 if ($self->cgi->param("bbid")) {
2293 grep { $_->id eq $self->cgi->param("bbid") } @{$ctx->{bookbags}};
2296 my $query = $self->_prepare_bookbag_container_query(
2297 $bookbag->id, $sorter, $modifier
2300 # Calculate total count of the items in selected bookbag.
2301 # This total includes record entries that have no assets available.
2302 my $bb_search_results = $U->simplereq(
2303 "open-ils.search", "open-ils.search.biblio.multiclass.query",
2304 {"limit" => 1, "offset" => 0}, $query
2305 ); # we only need the count, so do the actual search with limit=1
2307 if ($bb_search_results) {
2308 $ctx->{bb_item_count} = $bb_search_results->{count};
2310 $logger->warn("search failed in load_myopac_bookbags()");
2311 $ctx->{bb_item_count} = 0; # fallback value
2314 #calculate page count
2315 $ctx->{bb_page_count} = int ((($ctx->{bb_item_count} - 1) / $item_limit) + 1);
2317 if ( ($self->cgi->param("action") || '') eq "editmeta") {
2318 if (!$self->_update_bookbag_metadata($bookbag)) {
2320 return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
2323 my $url = $self->ctx->{opac_root} . '/myopac/lists?bbid=' .
2326 foreach my $param (('loc', 'qtype', 'query', 'sort', 'offset', 'limit')) {
2327 if ($self->cgi->param($param)) {
2328 $url .= ";$param=" . uri_escape_utf8($self->cgi->param($param));
2332 return $self->generic_redirect($url);
2336 # we're done with our CStoreEditor. Rollback here so
2337 # later calls don't cause a timeout, resulting in a
2338 # transaction rollback under the covers.
2342 # For list items pagination
2344 "limit" => $item_limit,
2345 "offset" => $item_offset
2348 my $items = $U->bib_container_items_via_search($bookbag->id, $query, $args)
2349 or return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
2351 # capture pref_ou for callnumber filter/display
2352 $ctx->{pref_ou} = $self->_get_pref_lib() || $ctx->{search_ou};
2354 # search for local callnumbers for display
2355 my $focus_ou = $ctx->{physical_loc} || $ctx->{pref_ou};
2357 my (undef, @recs) = $self->get_records_and_facets(
2358 [ map {$_->target_biblio_record_entry->id} @$items ],
2361 flesh => '{mra,holdings_xml,acp,exclude_invisible_acn}',
2363 site => $ctx->{get_aou}->($focus_ou)->shortname,
2364 pref_lib => $ctx->{pref_ou}
2368 $ctx->{bookbags_marc_xml}{$_->{id}} = $_->{marc_xml} for @recs;
2370 $bookbag->items($items);
2374 # If we have add_rec, we got here from the "Add to new list"
2375 # or "See all" popmenu items.
2376 if (my $add_rec = $self->cgi->param('add_rec')) {
2377 $self->ctx->{add_rec} = $add_rec;
2378 # But not in the staff client, 'cause that breaks things.
2379 unless ($self->ctx->{is_staff}) {
2380 # allow caller to provide the where_from in cases where
2381 # the referer is an intermediate error page
2382 if ($self->cgi->param('where_from')) {
2383 $self->ctx->{where_from} = $self->cgi->param('where_from');
2385 $self->ctx->{where_from} = $self->ctx->{referer};
2386 if ( my $anchor = $self->cgi->param('anchor') ) {
2387 $self->ctx->{where_from} =~ s/#.*|$/#$anchor/;
2393 # this rollback may be a dupe, but that's OK because
2394 # cstoreditor ignores dupe rollbacks
2397 return Apache2::Const::OK;
2401 # actions are create, delete, show, hide, rename, add_rec, delete_item, place_hold
2402 # CGI is action, list=list_id, add_rec/record=bre_id, del_item=bucket_item_id, name=new_bucket_name
2403 sub load_myopac_bookbag_update {
2404 my ($self, $action, $list_id, @hold_recs) = @_;
2405 my $e = $self->editor;
2406 my $cgi = $self->cgi;
2408 # save_notes is effectively another action, but is passed in a separate
2409 # CGI parameter for what are really just layout reasons.
2410 $action = 'save_notes' if $cgi->param('save_notes');
2411 $action ||= $cgi->param('action');
2413 $list_id ||= $cgi->param('list') || $cgi->param('bbid');
2415 my @add_rec = $cgi->param('add_rec') || $cgi->param('record');
2416 my @selected_item = $cgi->param('selected_item');
2417 my $shared = $cgi->param('shared');
2418 my $name = $cgi->param('name');
2419 my $description = $cgi->param('description');
2423 # This url intentionally leaves off the edit_notes parameter, but
2424 # may need to add some back in for paging.
2426 my $url = $self->ctx->{proto} . "://" . $self->ctx->{hostname} .
2427 $self->ctx->{opac_root} . "/myopac/lists?";
2429 foreach my $param (('loc', 'qtype', 'query', 'sort')) {
2430 if ($cgi->param($param)) {
2431 $url .= "$param=" . uri_escape_utf8($cgi->param($param)) . ";";
2435 if ($action eq 'create') {
2438 $list = Fieldmapper::container::biblio_record_entry_bucket->new;
2440 $list->description($description);
2441 $list->owner($e->requestor->id);
2442 $list->btype('bookbag');
2443 $list->pub($shared ? 't' : 'f');
2444 $success = $U->simplereq('open-ils.actor',
2445 'open-ils.actor.container.create', $e->authtoken, 'biblio', $list);
2446 if (ref($success) ne 'HASH' && scalar @add_rec) {
2447 $list_id = (ref($success)) ? $success->id : $success;
2448 foreach my $add_rec (@add_rec) {
2449 my $item = Fieldmapper::container::biblio_record_entry_bucket_item->new;
2450 $item->bucket($list_id);
2451 $item->target_biblio_record_entry($add_rec);
2452 $success = $U->simplereq('open-ils.actor',
2453 'open-ils.actor.container.item.create', $e->authtoken, 'biblio', $item);
2454 last unless $success;
2457 $url = $cgi->param('where_from') if ($success && $cgi->param('where_from'));
2460 $self->ctx->{bucket_failure_noname} = 1;
2463 } elsif($action eq 'place_hold') {
2465 # @hold_recs comes from anon lists redirect; selected_itesm comes from existing buckets
2466 unless (@hold_recs) {
2467 if (@selected_item) {
2468 my $items = $e->search_container_biblio_record_entry_bucket_item({id => \@selected_item});
2469 @hold_recs = map { $_->target_biblio_record_entry } @$items;
2473 return Apache2::Const::OK unless @hold_recs;
2474 $logger->info("placing holds from list page on: @hold_recs");
2476 my $url = $self->ctx->{opac_root} . '/place_hold?hold_type=T';
2477 $url .= ';hold_target=' . $_ for @hold_recs;
2478 foreach my $param (('loc', 'qtype', 'query')) {
2479 if ($cgi->param($param)) {
2480 $url .= ";$param=" . uri_escape_utf8($cgi->param($param));
2483 return $self->generic_redirect($url);
2487 $list = $e->retrieve_container_biblio_record_entry_bucket($list_id);
2489 return Apache2::Const::HTTP_BAD_REQUEST unless
2490 $list and $list->owner == $e->requestor->id;
2493 if($action eq 'delete') {
2494 $success = $U->simplereq('open-ils.actor',
2495 'open-ils.actor.container.full_delete', $e->authtoken, 'biblio', $list_id);
2497 # We check to see if we're deleting the user's default list.
2498 $self->_load_user_with_prefs;
2499 my $settings_map = $self->ctx->{user_setting_map};
2500 if ($$settings_map{'opac.default_list'} == $list_id) {
2501 # We unset the user's opac.default_list setting.
2502 $success = $U->simplereq(
2504 'open-ils.actor.patron.settings.update',
2507 { 'opac.default_list' => 0 }
2511 } elsif($action eq 'show') {
2512 unless($U->is_true($list->pub)) {
2514 $success = $U->simplereq('open-ils.actor',
2515 'open-ils.actor.container.update', $e->authtoken, 'biblio', $list);
2518 } elsif($action eq 'hide') {
2519 if($U->is_true($list->pub)) {
2521 $success = $U->simplereq('open-ils.actor',
2522 'open-ils.actor.container.update', $e->authtoken, 'biblio', $list);
2525 } elsif($action eq 'rename') {
2528 $success = $U->simplereq('open-ils.actor',
2529 'open-ils.actor.container.update', $e->authtoken, 'biblio', $list);
2532 } elsif($action eq 'add_rec') {
2533 foreach my $add_rec (@add_rec) {
2534 my $item = Fieldmapper::container::biblio_record_entry_bucket_item->new;
2535 $item->bucket($list_id);
2536 $item->target_biblio_record_entry($add_rec);
2537 $success = $U->simplereq('open-ils.actor',
2538 'open-ils.actor.container.item.create', $e->authtoken, 'biblio', $item);
2539 last unless $success;
2541 # Redirect back where we came from if we have an anchor parameter:
2542 if ( my $anchor = $cgi->param('anchor') && !$self->ctx->{is_staff}) {
2543 $url = $self->ctx->{referer};
2544 $url =~ s/#.*|$/#$anchor/;
2545 } elsif ($cgi->param('where_from')) {
2546 # Or, if we have a "where_from" parameter.
2547 $url = $cgi->param('where_from');
2549 } elsif ($action eq 'del_item') {
2550 foreach (@selected_item) {
2551 $success = $U->simplereq(
2553 'open-ils.actor.container.item.delete', $e->authtoken, 'biblio', $_
2555 last unless $success;
2557 } elsif ($action eq 'save_notes') {
2558 $success = $self->update_bookbag_item_notes;
2559 $url .= "&bbid=" . uri_escape_utf8($cgi->param("bbid")) if $cgi->param("bbid");
2560 } elsif ($action eq 'make_default') {
2561 $success = $U->simplereq(
2563 'open-ils.actor.patron.settings.update',
2566 { 'opac.default_list' => $list_id }
2568 } elsif ($action eq 'remove_default') {
2569 $success = $U->simplereq(
2571 'open-ils.actor.patron.settings.update',
2574 { 'opac.default_list' => 0 }
2578 return $self->generic_redirect($url) if $success;
2580 $self->ctx->{where_from} = $cgi->param('where_from');
2581 $self->ctx->{bucket_action} = $action;
2582 $self->ctx->{bucket_action_failed} = 1;
2583 return Apache2::Const::OK;
2586 sub update_bookbag_item_notes {
2588 my $e = $self->editor;
2590 my @note_keys = grep /^note-\d+/, keys(%{$self->cgi->Vars});
2591 my @item_keys = grep /^item-\d+/, keys(%{$self->cgi->Vars});
2593 # We're going to leverage an API call that's already been written to check
2594 # permissions appropriately.
2596 my $a = create OpenSRF::AppSession("open-ils.actor");
2597 my $method = "open-ils.actor.container.item_note.cud";
2599 for my $note_key (@note_keys) {
2602 my $id = ($note_key =~ /(\d+)/)[0];
2605 $e->retrieve_container_biblio_record_entry_bucket_item_note($id))) {
2606 my $event = $e->die_event;
2607 $self->apache->log->warn(
2608 "error retrieving cbrebin id $id, got event " .
2612 $self->ctx->{bucket_action_event} = $event;
2616 if (length($self->cgi->param($note_key))) {
2617 $note->ischanged(1);
2618 $note->note($self->cgi->param($note_key));
2620 $note->isdeleted(1);
2623 my $r = $a->request($method, $e->authtoken, "biblio", $note)->gather(1);
2625 if (defined $U->event_code($r)) {
2626 $self->apache->log->warn(
2627 "attempt to modify cbrebin " . $note->id .
2628 " returned event " . $r->{textcode}
2632 $self->ctx->{bucket_action_event} = $r;
2637 for my $item_key (@item_keys) {
2638 my $id = int(($item_key =~ /(\d+)/)[0]);
2639 my $text = $self->cgi->param($item_key);
2642 next unless length $text;
2644 my $note = new Fieldmapper::container::biblio_record_entry_bucket_item_note;
2649 my $r = $a->request($method, $e->authtoken, "biblio", $note)->gather(1);
2651 if (defined $U->event_code($r)) {
2652 $self->apache->log->warn(
2653 "attempt to create cbrebin for item " . $note->item .
2654 " returned event " . $r->{textcode}
2658 $self->ctx->{bucket_action_event} = $r;
2667 sub load_myopac_bookbag_print {
2670 my $id = int($self->cgi->param("list"));
2672 my ($sorter, $modifier) = $self->_get_bookbag_sort_params("sort");
2675 $self->_prepare_bookbag_container_query($id, $sorter, $modifier);
2679 # Get the bookbag object itself, assuming we're allowed to.
2680 if ($self->editor->allowed("VIEW_CONTAINER")) {
2682 $bbag = $self->editor->retrieve_container_biblio_record_entry_bucket($id) or return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
2684 my $bookbags = $self->editor->search_container_biblio_record_entry_bucket(
2688 "owner" => $self->editor->requestor->id,
2692 ) or return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
2694 $bbag = pop @$bookbags;
2697 # If we have a bookbag we're allowed to look at, issue the A/T event
2698 # to get CSV, passing as a user param that search query we built before.
2700 $self->ctx->{csv} = $U->fire_object_event(
2701 undef, "container.biblio_record_entry_bucket.csv",
2702 $bbag, $self->editor->requestor->home_ou,
2703 undef, {"item_search" => $item_search}
2707 # Create a reasonable filename and set the content disposition to
2708 # provoke browser download dialogs.
2709 (my $filename = $bbag->id . $bbag->name) =~ s/[^a-z0-9_ -]//gi;
2711 return $self->set_file_download_headers("$filename.csv");
2714 sub load_myopac_circ_history_export {
2716 my $e = $self->editor;
2717 my $filename = $self->cgi->param('filename') || 'circ_history.csv';
2719 my $circs = $self->fetch_user_circ_history;
2721 $self->ctx->{csv}->{rows} = $self->_get_circ_history_csv(
2722 [map {$_->{id}} @$ids]
2725 return $self->set_file_download_headers($filename);
2728 sub load_password_reset {
2730 my $cgi = $self->cgi;
2731 my $ctx = $self->ctx;
2732 my $barcode = $cgi->param('barcode');
2733 my $username = $cgi->param('username');
2734 my $email = $cgi->param('email');
2735 my $pwd1 = $cgi->param('pwd1');
2736 my $pwd2 = $cgi->param('pwd2');
2737 my $uuid = $ctx->{page_args}->[0];
2741 $logger->info("patron password reset with uuid $uuid");
2743 if ($pwd1 and $pwd2) {
2745 if ($pwd1 eq $pwd2) {
2747 my $response = $U->simplereq(
2749 'open-ils.actor.patron.password_reset.commit',
2752 $logger->info("patron password reset response " . Dumper($response));
2754 if ($U->event_code($response)) { # non-success event
2756 my $code = $response->{textcode};
2758 if ($code eq 'PATRON_NOT_AN_ACTIVE_PASSWORD_RESET_REQUEST') {
2759 $ctx->{pwreset} = {style => 'error', status => 'NOT_ACTIVE'};
2762 if ($code eq 'PATRON_PASSWORD_WAS_NOT_STRONG') {
2763 $ctx->{pwreset} = {style => 'error', status => 'NOT_STRONG'};
2768 $ctx->{pwreset} = {style => 'success', status => 'SUCCESS'};
2771 } else { # passwords not equal
2773 $ctx->{pwreset} = {style => 'error', status => 'NO_MATCH'};
2776 } else { # 2 password values needed
2778 $ctx->{pwreset} = {status => 'TWO_PASSWORDS'};
2781 } elsif ($barcode or $username) {
2783 my @params = $barcode ? ('barcode', $barcode) : ('username', $username);
2784 push(@params, $email) if $email;
2788 'open-ils.actor.patron.password_reset.request', @params);
2790 $ctx->{pwreset} = {status => 'REQUEST_SUCCESS'};
2793 $logger->info("patron password reset resulted in " . Dumper($ctx->{pwreset}));
2794 return Apache2::Const::OK;
2797 # fetch_user_circs is too slow for our purposes. (Yes, I tested it.)
2798 # It also does a lot more than we need in order to produce our CSV
2799 # output of a patron's circ history. So, _get_circ_history_csv was
2800 # concocted to get only the information that we need in a more timely
2801 # manner, though it is still not as speedy as one would like.
2803 # Given an array ref of circulation ids, the function returns an array
2804 # ref of hash ref objects with fields, xact_start, due_date,
2805 # checkin_time, title, author, call_number, barcode, and format.
2806 # There is one array entry for each circulation. This is the
2807 # information presently required for the circ_history.csv file.
2808 sub _get_circ_history_csv {
2812 my $e = $self->editor;
2814 if ($ids && @$ids) {
2815 my $results = $e->json_query(
2818 'circ' => ['xact_start','due_date','checkin_time'],
2819 'acp' => ['barcode'],
2820 'acn' => ['label','record']
2822 'from' => {'circ' => {'acp' => {'join' => 'acn'}}},
2823 'where' => {'+circ' => {'id' => $ids}},
2824 'order_by' => {'circ' => ['xact_start']}
2827 foreach my $r (@$results) {
2829 my $record = $self->_get_record_data($r->{record});
2830 $row->{title} = $record->{title};
2831 $row->{author} = $record->{author};
2832 $row->{format} = join('+', @{$record->{formats}});
2833 $row->{xact_start} = $r->{xact_start};
2834 $row->{due_date} = $r->{due_date};
2835 $row->{checkin_time} = $r->{checkin_time};
2836 $row->{barcode} = $r->{barcode};
2837 $row->{call_number} = $r->{label};
2845 # Utility functions used by _get_circ_history_csv:
2847 # This funtion retrieves the information that we need from a bre for
2848 # our circ_history.csv output. It gathers, the title, author, and
2849 # icon formats into a hashref using the _get_title_proper,
2850 # _get_author, and _get_icon_formats functions defined below. Once
2851 # the data are retrieved, it is cached for 90 seconds in the
2852 # global cache. Testing has shown that it takes about 82 seconds to
2853 # retrieve the information for a patron with 4,196 retained
2854 # circulations on a slow development system. Using the cache with a
2855 # timeout of 90 seconds, dropped 4 seconds from the retrieval time,
2856 # and led to 371 cache hits. The cached information is, of course,
2857 # used if available rather than doing a database lookup.
2858 sub _get_record_data {
2861 my $e = $self->editor;
2863 my $key = 'TPAC_csv_info_' . $record;
2865 # First, we try the global cache.
2866 my $cache = OpenSRF::Utils::Cache->new('global');
2867 $obj = $cache->get_cache($key);
2872 $obj->{author} = $self->_get_author($record);
2873 $obj->{formats} = $self->_get_icon_formats($record);
2874 $obj->{title} = $self->_get_title_proper($record);
2876 $cache->put_cache($key, $obj, 90);
2882 # This function looks up the text for the icon formats of a given
2883 # bre.id. It does so using a JSON query and a cached hash map of
2884 # coded value map code => value. The hash map is cached for 24 hours
2885 # because we have no idea how often people ask for their circ history
2886 # in a csv, nor how often they might want to retrieve their lists/book
2888 sub _get_icon_formats {
2891 my $e = $self->editor;
2894 # First, let's try using a cache:
2895 my $cache = OpenSRF::Utils::Cache->new('global');
2896 my $icon_formats = $cache->get_cache('CCVM_icon_format_code_map');
2897 unless ($icon_formats) {
2898 # Build a map of item_type coded value map:
2899 my $ccvms = $e->search_config_coded_value_map({ctype => 'icon_format'});
2900 if ($ccvms && @$ccvms) {
2901 foreach my $ccvm (@$ccvms) {
2902 $icon_formats->{$ccvm->code} = $ccvm->value;
2905 $cache->put_cache('CCVM_icon_format_code_map', $icon_formats);
2910 'select' => {'mraf' => ['value']},
2912 'where' => {'id' => $record, 'attr' => 'icon_format'},
2913 'distinct' => 'true'
2916 my $result = $e->json_query($query);
2917 foreach (@$result) {
2918 push(@$formats, $$icon_formats{$_->{value}});
2924 # This function retrieves the "first" author for a bre using a JSON
2925 # query on metabib.author_field_entry. It deterimines "first" by
2926 # ordering by "field" and then "id" and using a limit of 1 on the
2931 my $e = $self->editor;
2935 'select' => {'mafe' => ['value']},
2937 'where' => {'source' => $record},
2938 'order_by' => {'mafe' => ['field','id']},
2942 my $result = $e->json_query($query);
2943 if ($result && @$result) {
2944 $author = $result->[0]->{value};
2950 # This function looks up a "title proper" for a bre using a JSON query
2951 # on metabib.author_field_entry where the "field" is equal to 6, the
2952 # code for "title proper."
2953 sub _get_title_proper {
2956 my $e = $self->editor;
2960 'select' => {'mtfe' => ['value']},
2962 'where' => {'source' => $record, 'field' => 6},
2966 my $result = $e->json_query($query);
2967 if ($result && @$result) {
2968 $title = $result->[0]->{value};