Open-ILS/src/perlmods/lib/OpenILS/WWW/EGCatLoader/Account.pm

   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;
   8 use OpenILS::Event;
   9 use OpenSRF::Utils::JSON;
  10 use OpenSRF::Utils::Cache;
  11 use Digest::MD5 qw(md5_hex);
  12 use Data::Dumper;
  13 $Data::Dumper::Indent = 0;
  14 use DateTime;
  15 my $U = 'OpenILS::Application::AppUtils';
  16
  17 sub prepare_extended_user_info {
  18     my $self = shift;
  19     my @extra_flesh = @_;
  20     my $e = $self->editor;
  21
  22     # are we already in a transaction?
  23     my $local_xact = !$e->{xact_id};
  24     $e->xact_begin if $local_xact;
  25
  26     # keep the original user object so we can restore
  27     # login-specific data (e.g. workstation)
  28     my $usr = $self->ctx->{user};
  29
  30     $self->ctx->{user} = $self->editor->retrieve_actor_user([
  31         $self->ctx->{user}->id,
  32         {
  33             flesh => 1,
  34             flesh_fields => {
  35                 au => [qw/card home_ou addresses ident_type billing_address/, @extra_flesh]
  36                 # ...
  37             }
  38         }
  39     ]);
  40
  41     $e->rollback if $local_xact;
  42
  43     $self->ctx->{user}->wsid($usr->wsid);
  44     $self->ctx->{user}->ws_ou($usr->ws_ou);
  45
  46     # discard replaced (negative-id) addresses.
  47     $self->ctx->{user}->addresses([
  48         grep {$_->id > 0} @{$self->ctx->{user}->addresses} ]);
  49
  50     return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR
  51         unless $self->ctx->{user};
  52
  53     return;
  54 }
  55
  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) = @_;
  61
  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");
  66     return 0;
  67 }
  68
  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) = @_;
  72
  73     my $would_block = $self->ctx->{get_org_setting}->
  74         ($pickup_lib, "circ.holds.hold_has_copy_at.block");
  75     my $would_alert = (
  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;
  80
  81     if ($would_block or $would_alert) {
  82         my $args = {
  83             "hold_target" => $hold_target,
  84             "hold_type" => $hold_type,
  85             "org_unit" => $pickup_lib
  86         };
  87         my $local_avail = $U->simplereq(
  88             "open-ils.circ",
  89             "open-ils.circ.hold.has_copy_at", $self->editor->authtoken, $args
  90         );
  91         $logger->info(
  92             "copy availability information for " . Dumper($args) .
  93             " is " . Dumper($local_avail)
  94         );
  95         if (%$local_avail) { # if hash not empty
  96             $self->ctx->{hold_copy_available} = $local_avail;
  97             return ($would_block, $would_alert);
  98         }
  99     }
 100
 101     return (0, 0);
 102 }
 103
 104 # context additions:
 105 #   user : au object, fleshed
 106 sub load_myopac_prefs {
 107     my $self = shift;
 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');
 113
 114     $self->prepare_extended_user_info;
 115     my $user = $self->ctx->{user};
 116
 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;
 121     } else {
 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');
 125             if(!$regex_check) {
 126                 # Default is "starts with a number"
 127                 $regex_check = '^\d+';
 128             }
 129             # You already have a username?
 130             if($regex_check and $self->ctx->{user}->usrname !~ /$regex_check/) {
 131                 $self->ctx->{username_change_disallowed} = 1;
 132             }
 133         }
 134     }
 135
 136     return Apache2::Const::OK unless
 137         $pending_addr or $replace_addr or $delete_pending;
 138
 139     my @form_fields = qw/address_type street1 street2 city county state country post_code/;
 140
 141     my $paddr;
 142     if( $pending_addr ) { # update an existing pending address
 143
 144         ($paddr) = grep { $_->id == $pending_addr } @{$user->addresses};
 145         return Apache2::Const::HTTP_BAD_REQUEST unless $paddr;
 146         $paddr->$_( $cgi->param($_) ) for @form_fields;
 147
 148     } elsif( $replace_addr ) { # create a new pending address for 'replace_addr'
 149
 150         $paddr = Fieldmapper::actor::user_address->new;
 151         $paddr->isnew(1);
 152         $paddr->usr($user->id);
 153         $paddr->pending('t');
 154         $paddr->replaces($replace_addr);
 155         $paddr->$_( $cgi->param($_) ) for @form_fields;
 156
 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);
 162     }
 163
 164     my $resp = $U->simplereq(
 165         'open-ils.actor',
 166         'open-ils.actor.user.address.pending.cud',
 167         $e->authtoken, $paddr);
 168
 169     if( $U->event_code($resp) ) {
 170         $logger->error("Error updating pending address: $resp");
 171         return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
 172     }
 173
 174     # in light of these changes, re-fetch latest data
 175     $e->xact_begin;
 176     $self->prepare_extended_user_info;
 177     $e->rollback;
 178
 179     return Apache2::Const::OK;
 180 }
 181
 182 sub load_myopac_prefs_notify {
 183     my $self = shift;
 184     my $e = $self->editor;
 185
 186
 187     my $stat = $self->_load_user_with_prefs;
 188     return $stat if $stat;
 189
 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';
 193
 194     $self->ctx->{opt_in_settings} = $user_prefs;
 195
 196     return Apache2::Const::OK
 197         unless $self->cgi->request_method eq 'POST';
 198
 199     my %settings;
 200     my $set_map = $self->ctx->{user_setting_map};
 201
 202     foreach my $key (qw/
 203         opac.default_phone
 204         opac.default_sms_notify
 205     /) {
 206         my $val = $self->cgi->param($key);
 207         $settings{$key}= $val unless $$set_map{$key} eq $val;
 208     }
 209
 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;
 213
 214     $key = 'opac.hold_notify';
 215     my @notify_methods = ();
 216     if ($self->cgi->param($key . ".email") eq 'on') {
 217         push @notify_methods, "email";
 218     }
 219     if ($self->cgi->param($key . ".phone") eq 'on') {
 220         push @notify_methods, "phone";
 221     }
 222     if ($self->cgi->param($key . ".sms") eq 'on') {
 223         push @notify_methods, "sms";
 224     }
 225     $val = join("|",@notify_methods);
 226     $settings{$key}= $val unless $$set_map{$key} eq $val;
 227
 228     # Send the modified settings off to be saved
 229     $U->simplereq(
 230         'open-ils.actor',
 231         'open-ils.actor.patron.settings.update',
 232         $self->editor->authtoken, undef, \%settings);
 233
 234     # re-fetch user prefs
 235     $self->ctx->{updated_user_settings} = \%settings;
 236     return $self->_load_user_with_prefs || Apache2::Const::OK;
 237 }
 238
 239 sub fetch_optin_prefs {
 240     my $self = shift;
 241     my $e = $self->editor;
 242
 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(
 248         'open-ils.actor',
 249         'open-ils.actor.event_def.opt_in.settings.atomic',
 250         $e->authtoken, $e->requestor->home_ou);
 251
 252     # some opt-ins are staff-only
 253     $opt_ins = [ grep { $U->is_true($_->opac_visible) } @$opt_ins ];
 254
 255     # fetch user setting values for each of the opt-in settings
 256     my $user_set = $U->simplereq(
 257         'open-ils.actor',
 258         'open-ils.actor.patron.settings.retrieve',
 259         $e->authtoken,
 260         $e->requestor->id,
 261         [map {$_->name} @$opt_ins]
 262     );
 263
 264     return [map { {cust => $_, value => $user_set->{$_->name} } } @$opt_ins];
 265 }
 266
 267 sub _load_lists_and_settings {
 268     my $self = shift;
 269     my $e = $self->editor;
 270     my $stat = $self->_load_user_with_prefs;
 271     unless ($stat) {
 272         my $exclude = 0;
 273         my $setting_map = $self->ctx->{user_setting_map};
 274         $exclude = $$setting_map{'opac.default_list'} if ($$setting_map{'opac.default_list'});
 275         $self->ctx->{bookbags} = $e->search_container_biblio_record_entry_bucket(
 276             [
 277                 {owner => $self->ctx->{user}->id, btype => 'bookbag', id => {'<>' => $exclude}}, {
 278                     order_by => {cbreb => 'name'},
 279                     limit => $self->cgi->param('limit') || 10,
 280                     offset => $self->cgi->param('offset') || 0
 281                 }
 282             ]
 283         );
 284         # We also want a total count of the user's bookbags.
 285         my $q = {
 286             'select' => { 'cbreb' => [ { 'column' => 'id', 'transform' => 'count', 'aggregate' => 'true', 'alias' => 'count' } ] },
 287             'from' => 'cbreb',
 288             'where' => { 'btype' => 'bookbag', 'owner' => $self->ctx->{user}->id }
 289         };
 290         my $r = $e->json_query($q);
 291         $self->ctx->{bookbag_count} = $r->[0]->{'count'};
 292         # Someone has requested that we use the default list's name
 293         # rather than "Default List."
 294         if ($exclude) {
 295             $q = {
 296                 'select' => {'cbreb' => ['name']},
 297                 'from' => 'cbreb',
 298                 'where' => {'id' => $exclude}
 299             };
 300             $r = $e->json_query($q);
 301             $self->ctx->{default_bookbag} = $r->[0]->{'name'};
 302         }
 303     } else {
 304         return $stat;
 305     }
 306     return undef;
 307 }
 308
 309 sub update_optin_prefs {
 310     my $self = shift;
 311     my $user_prefs = shift;
 312     my $e = $self->editor;
 313     my @settings = $self->cgi->param('setting');
 314     my %newsets;
 315
 316     # apply now-true settings
 317     for my $applied (@settings) {
 318         # see if setting is already applied to this user
 319         next if grep { $_->{cust}->name eq $applied and $_->{value} } @$user_prefs;
 320         $newsets{$applied} = OpenSRF::Utils::JSON->true;
 321     }
 322
 323     # remove now-false settings
 324     for my $pref (grep { $_->{value} } @$user_prefs) {
 325         $newsets{$pref->{cust}->name} = undef
 326             unless grep { $_ eq $pref->{cust}->name } @settings;
 327     }
 328
 329     $U->simplereq(
 330         'open-ils.actor',
 331         'open-ils.actor.patron.settings.update',
 332         $e->authtoken, $e->requestor->id, \%newsets);
 333
 334     # update the local prefs to match reality
 335     for my $pref (@$user_prefs) {
 336         $pref->{value} = $newsets{$pref->{cust}->name}
 337             if exists $newsets{$pref->{cust}->name};
 338     }
 339
 340     return $user_prefs;
 341 }
 342
 343 sub _load_user_with_prefs {
 344     my $self = shift;
 345     my $stat = $self->prepare_extended_user_info('settings');
 346     return $stat if $stat; # not-OK
 347
 348     $self->ctx->{user_setting_map} = {
 349         map { $_->name => OpenSRF::Utils::JSON->JSON2perl($_->value) }
 350             @{$self->ctx->{user}->settings}
 351     };
 352
 353     return undef;
 354 }
 355
 356 sub _get_bookbag_sort_params {
 357     my ($self, $param_name) = @_;
 358
 359     # The interface that feeds this cgi parameter will provide a single
 360     # argument for a QP sort filter, and potentially a modifier after a period.
 361     # In practice this means the "sort" parameter will be something like
 362     # "titlesort" or "authorsort.descending".
 363     my $sorter = $self->cgi->param($param_name) || "";
 364     my $modifier;
 365     if ($sorter) {
 366         $sorter =~ s/^(.*?)\.(.*)/$1/;
 367         $modifier = $2 || undef;
 368     }
 369
 370     return ($sorter, $modifier);
 371 }
 372
 373 sub _prepare_bookbag_container_query {
 374     my ($self, $container_id, $sorter, $modifier) = @_;
 375
 376     return sprintf(
 377         "container(bre,bookbag,%d,%s)%s%s",
 378         $container_id, $self->editor->authtoken,
 379         ($sorter ? " sort($sorter)" : ""),
 380         ($modifier ? "#$modifier" : "")
 381     );
 382 }
 383
 384 sub _prepare_anonlist_sorting_query {
 385     my ($self, $list, $sorter, $modifier) = @_;
 386
 387     return sprintf(
 388         "record_list(%s)%s%s",
 389         join(",", @$list),
 390         ($sorter ? " sort($sorter)" : ""),
 391         ($modifier ? "#$modifier" : "")
 392     );
 393 }
 394
 395
 396 sub load_myopac_prefs_settings {
 397     my $self = shift;
 398
 399     my @user_prefs = qw/
 400         opac.hits_per_page
 401         opac.default_search_location
 402         opac.default_pickup_location
 403         opac.temporary_list_no_warn
 404     /;
 405
 406     my $stat = $self->_load_user_with_prefs;
 407     return $stat if $stat;
 408
 409     # if behind-desk holds are supported and the user
 410     # setting which controls the value is opac-visible,
 411     # add the setting to the list of settings to manage.
 412     # note: this logic may need to be changed later to
 413     # check whether behind-the-desk holds are supported
 414     # anywhere the patron may select as a pickup lib.
 415     my $e = $self->editor;
 416     my $bdous = $self->ctx->{get_org_setting}->(
 417         $e->requestor->home_ou,
 418         'circ.holds.behind_desk_pickup_supported');
 419
 420     if ($bdous) {
 421         my $setting =
 422             $e->retrieve_config_usr_setting_type(
 423                 'circ.holds_behind_desk');
 424
 425         if ($U->is_true($setting->opac_visible)) {
 426             push(@user_prefs, 'circ.holds_behind_desk');
 427             $self->ctx->{behind_desk_supported} = 1;
 428         }
 429     }
 430
 431     return Apache2::Const::OK
 432         unless $self->cgi->request_method eq 'POST';
 433
 434     # some setting values from the form don't match the
 435     # required value/format for the db, so they have to be
 436     # individually translated.
 437
 438     my %settings;
 439     my $set_map = $self->ctx->{user_setting_map};
 440
 441     foreach my $key (@user_prefs) {
 442         my $val = $self->cgi->param($key);
 443         $settings{$key}= $val unless $$set_map{$key} eq $val;
 444     }
 445
 446     my $now = DateTime->now->strftime('%F');
 447     foreach my $key (qw/history.circ.retention_start history.hold.retention_start/) {
 448         my $val = $self->cgi->param($key);
 449         if($val and $val eq 'on') {
 450             # Set the start time to 'now' unless a start time already exists for the user
 451             $settings{$key} = $now unless $$set_map{$key};
 452         } else {
 453             # clear the start time if one previously existed for the user
 454             $settings{$key} = undef if $$set_map{$key};
 455         }
 456     }
 457
 458     # Send the modified settings off to be saved
 459     $U->simplereq(
 460         'open-ils.actor',
 461         'open-ils.actor.patron.settings.update',
 462         $self->editor->authtoken, undef, \%settings);
 463
 464     # re-fetch user prefs
 465     $self->ctx->{updated_user_settings} = \%settings;
 466     return $self->_load_user_with_prefs || Apache2::Const::OK;
 467 }
 468
 469 sub load_myopac_prefs_my_lists {
 470     my $self = shift;
 471
 472     my @user_prefs = qw/
 473         opac.lists_per_page
 474         opac.list_items_per_page
 475     /;
 476
 477     my $stat = $self->_load_user_with_prefs;
 478     return $stat if $stat;
 479
 480     return Apache2::Const::OK
 481         unless $self->cgi->request_method eq 'POST';
 482
 483     my %settings;
 484     my $set_map = $self->ctx->{user_setting_map};
 485
 486     foreach my $key (@user_prefs) {
 487         my $val = $self->cgi->param($key);
 488         $settings{$key}= $val unless $$set_map{$key} eq $val;
 489     }
 490
 491     if (keys %settings) { # we found a different setting value
 492         # Send the modified settings off to be saved
 493         $U->simplereq(
 494             'open-ils.actor',
 495             'open-ils.actor.patron.settings.update',
 496             $self->editor->authtoken, undef, \%settings);
 497
 498         # re-fetch user prefs
 499         $self->ctx->{updated_user_settings} = \%settings;
 500         $stat = $self->_load_user_with_prefs;
 501     }
 502
 503     return $stat || Apache2::Const::OK;
 504 }
 505
 506 sub fetch_user_holds {
 507     my $self = shift;
 508     my $hold_ids = shift;
 509     my $ids_only = shift;
 510     my $flesh = shift;
 511     my $available = shift;
 512     my $limit = shift;
 513     my $offset = shift;
 514
 515     my $e = $self->editor;
 516     my $all_ids; # to be used below.
 517
 518     if(!$hold_ids) {
 519         my $circ = OpenSRF::AppSession->create('open-ils.circ');
 520
 521         $hold_ids = $circ->request(
 522             'open-ils.circ.holds.id_list.retrieve.authoritative',
 523             $e->authtoken,
 524             $e->requestor->id,
 525             $available
 526         )->gather(1);
 527         $circ->kill_me;
 528
 529         $all_ids = $hold_ids;
 530         $hold_ids = [ grep { defined $_ } @$hold_ids[$offset..($offset + $limit - 1)] ] if $limit or $offset;
 531
 532     } else {
 533         $all_ids = $hold_ids;
 534     }
 535
 536     return { ids => $hold_ids, all_ids => $all_ids } if $ids_only or @$hold_ids == 0;
 537
 538     my $args = {
 539         suppress_notices => 1,
 540         suppress_transits => 1,
 541         suppress_mvr => 1,
 542         suppress_patron_details => 1
 543     };
 544
 545     # ----------------------------------------------------------------
 546     # Collect holds in batches of $batch_size for faster retrieval
 547
 548     my $batch_size = 8;
 549     my $batch_idx = 0;
 550     my $mk_req_batch = sub {
 551         my @ses;
 552         my $top_idx = $batch_idx + $batch_size;
 553         while($batch_idx < $top_idx) {
 554             my $hold_id = $hold_ids->[$batch_idx++];
 555             last unless $hold_id;
 556             my $ses = OpenSRF::AppSession->create('open-ils.circ');
 557             my $req = $ses->request(
 558                 'open-ils.circ.hold.details.retrieve',
 559                 $e->authtoken, $hold_id, $args);
 560             push(@ses, {ses => $ses, req => $req});
 561         }
 562         return @ses;
 563     };
 564
 565     my $first = 1;
 566     my(@collected, @holds, @ses);
 567
 568     while(1) {
 569         @ses = $mk_req_batch->() if $first;
 570         last if $first and not @ses;
 571
 572         if(@collected) {
 573             while(my $blob = pop(@collected)) {
 574                 my @data;
 575
 576                 # in the holds edit UI, we need to know what formats and
 577                 # languages the user selected for this hold, plus what
 578                 # formats/langs are available on the MR as a whole.
 579                 if ($blob->{hold}{hold}->hold_type eq 'M') {
 580                     my $hold = $blob->{hold}->{hold};
 581
 582                     # for MR, fetch the combined MR unapi blob
 583                     (undef, @data) = $self->get_records_and_facets(
 584                         [$hold->target], undef, {flesh => '{mra}', metarecord => 1});
 585
 586                     my $filter_data = $U->simplereq(
 587                         'open-ils.circ',
 588                         'open-ils.circ.mmr.holds.filters.authoritative.atomic',
 589                         $hold->target, [$hold->id]
 590                     );
 591
 592                     $blob->{metarecord_filters} =
 593                         $filter_data->[0]->{metarecord};
 594                     $blob->{metarecord_selected_filters} =
 595                         $filter_data->[1]->{hold};
 596                 } else {
 597
 598                     (undef, @data) = $self->get_records_and_facets(
 599                         [$blob->{hold}->{bre_id}], undef, {flesh => '{mra}'}
 600                     );
 601                 }
 602
 603                 $blob->{marc_xml} = $data[0]->{marc_xml};
 604                 push(@holds, $blob);
 605             }
 606         }
 607
 608         for my $req_data (@ses) {
 609             push(@collected, {hold => $req_data->{req}->gather(1)});
 610             $req_data->{ses}->kill_me;
 611         }
 612
 613         @ses = $mk_req_batch->();
 614         last unless @collected or @ses;
 615         $first = 0;
 616     }
 617
 618     # put the holds back into the original server sort order
 619     my @sorted;
 620     for my $id (@$hold_ids) {
 621         push @sorted, grep { $_->{hold}->{hold}->id == $id } @holds;
 622     }
 623
 624     return { holds => \@sorted, ids => $hold_ids, all_ids => $all_ids };
 625 }
 626
 627 sub handle_hold_update {
 628     my $self = shift;
 629     my $action = shift;
 630     my $hold_ids = shift;
 631     my $e = $self->editor;
 632     my $url;
 633
 634     my @hold_ids = ($hold_ids) ? @$hold_ids : $self->cgi->param('hold_id'); # for non-_all actions
 635     @hold_ids = @{$self->fetch_user_holds(undef, 1)->{ids}} if $action =~ /_all/;
 636
 637     my $circ = OpenSRF::AppSession->create('open-ils.circ');
 638
 639     if($action =~ /cancel/) {
 640
 641         for my $hold_id (@hold_ids) {
 642             my $resp = $circ->request(
 643                 'open-ils.circ.hold.cancel', $e->authtoken, $hold_id, 6 )->gather(1); # 6 == patron-cancelled-via-opac
 644         }
 645
 646     } elsif ($action =~ /activate|suspend/) {
 647
 648         my $vlist = [];
 649         for my $hold_id (@hold_ids) {
 650             my $vals = {id => $hold_id};
 651
 652             if($action =~ /activate/) {
 653                 $vals->{frozen} = 'f';
 654                 $vals->{thaw_date} = undef;
 655
 656             } elsif($action =~ /suspend/) {
 657                 $vals->{frozen} = 't';
 658                 # $vals->{thaw_date} = TODO;
 659             }
 660             push(@$vlist, $vals);
 661         }
 662
 663         my $resp = $circ->request('open-ils.circ.hold.update.batch.atomic', $e->authtoken, undef, $vlist)->gather(1);
 664         $self->ctx->{hold_suspend_post_capture} = 1 if
 665             grep {$U->event_equals($_, 'HOLD_SUSPEND_AFTER_CAPTURE')} @$resp;
 666
 667     } elsif ($action eq 'edit') {
 668
 669         my @vals = map {
 670             my $val = {"id" => $_};
 671             $val->{"frozen"} = $self->cgi->param("frozen");
 672             $val->{"pickup_lib"} = $self->cgi->param("pickup_lib");
 673
 674             for my $field (qw/expire_time thaw_date/) {
 675                 # XXX TODO make this support other date formats, not just
 676                 # MM/DD/YYYY.
 677                 next unless $self->cgi->param($field) =~
 678                     m:^(\d{2})/(\d{2})/(\d{4})$:;
 679                 $val->{$field} = "$3-$1-$2";
 680             }
 681
 682             $val->{holdable_formats} = # no-op for non-MR holds
 683                 $self->compile_holdable_formats(undef, $_);
 684
 685             $val;
 686         } @hold_ids;
 687
 688         $circ->request(
 689             'open-ils.circ.hold.update.batch.atomic',
 690             $e->authtoken, undef, \@vals
 691         )->gather(1);   # LFW XXX test for failure
 692         $url = $self->ctx->{proto} . '://' . $self->ctx->{hostname} . $self->ctx->{opac_root} . '/myopac/holds';
 693         foreach my $param (('loc', 'qtype', 'query')) {
 694             if ($self->cgi->param($param)) {
 695                 $url .= ";$param=" . uri_escape_utf8($self->cgi->param($param));
 696             }
 697         }
 698     }
 699
 700     $circ->kill_me;
 701     return defined($url) ? $self->generic_redirect($url) : undef;
 702 }
 703
 704 sub load_myopac_holds {
 705     my $self = shift;
 706     my $e = $self->editor;
 707     my $ctx = $self->ctx;
 708
 709     my $limit = $self->cgi->param('limit') || 15;
 710     my $offset = $self->cgi->param('offset') || 0;
 711     my $action = $self->cgi->param('action') || '';
 712     my $hold_id = $self->cgi->param('id');
 713     my $available = int($self->cgi->param('available') || 0);
 714
 715     my $hold_handle_result;
 716     $hold_handle_result = $self->handle_hold_update($action) if $action;
 717
 718     my $holds_object = $self->fetch_user_holds($hold_id ? [$hold_id] : undef, 0, 1, $available, $limit, $offset);
 719     if($holds_object->{holds}) {
 720         $ctx->{holds} = $holds_object->{holds};
 721     }
 722     $ctx->{holds_ids} = $holds_object->{all_ids};
 723     $ctx->{holds_limit} = $limit;
 724     $ctx->{holds_offset} = $offset;
 725
 726     return defined($hold_handle_result) ? $hold_handle_result : Apache2::Const::OK;
 727 }
 728
 729 my $data_filler;
 730
 731 sub load_place_hold {
 732     my $self = shift;
 733     my $ctx = $self->ctx;
 734     my $gos = $ctx->{get_org_setting};
 735     my $e = $self->editor;
 736     my $cgi = $self->cgi;
 737
 738     $self->ctx->{page} = 'place_hold';
 739     my @targets = $cgi->param('hold_target');
 740     my @parts = $cgi->param('part');
 741
 742     $ctx->{hold_type} = $cgi->param('hold_type');
 743     $ctx->{default_pickup_lib} = $e->requestor->home_ou; # unless changed below
 744     $ctx->{email_notify} = $cgi->param('email_notify');
 745     if ($cgi->param('phone_notify_checkbox')) {
 746         $ctx->{phone_notify} = $cgi->param('phone_notify');
 747     }
 748     if ($cgi->param('sms_notify_checkbox')) {
 749         $ctx->{sms_notify} = $cgi->param('sms_notify');
 750         $ctx->{sms_carrier} = $cgi->param('sms_carrier');
 751     }
 752
 753     return $self->generic_redirect unless @targets;
 754
 755     $logger->info("Looking at hold_type: " . $ctx->{hold_type} . " and targets: @targets");
 756
 757     $ctx->{staff_recipient} = $self->editor->retrieve_actor_user([
 758         $e->requestor->id,
 759         {
 760             flesh => 1,
 761             flesh_fields => {
 762                 au => ['settings', 'card']
 763             }
 764         }
 765     ]) or return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
 766     my $user_setting_map = {
 767         map { $_->name => OpenSRF::Utils::JSON->JSON2perl($_->value) }
 768             @{
 769                 $ctx->{staff_recipient}->settings
 770             }
 771     };
 772     $ctx->{user_setting_map} = $user_setting_map;
 773
 774     my $default_notify = (defined $$user_setting_map{'opac.hold_notify'} ? $$user_setting_map{'opac.hold_notify'} : 'email:phone');
 775     if ($default_notify =~ /email/) {
 776         $ctx->{default_email_notify} = 'checked';
 777     } else {
 778         $ctx->{default_email_notify} = '';
 779     }
 780     if ($default_notify =~ /phone/) {
 781         $ctx->{default_phone_notify} = 'checked';
 782     } else {
 783         $ctx->{default_phone_notify} = '';
 784     }
 785     if ($default_notify =~ /sms/) {
 786         $ctx->{default_sms_notify} = 'checked';
 787     } else {
 788         $ctx->{default_sms_notify} = '';
 789     }
 790
 791     # If we have a default pickup location, grab it
 792     if ($$user_setting_map{'opac.default_pickup_location'}) {
 793         $ctx->{default_pickup_lib} = $$user_setting_map{'opac.default_pickup_location'};
 794     }
 795
 796     my $request_lib = $e->requestor->ws_ou;
 797     my @hold_data;
 798     $ctx->{hold_data} = \@hold_data;
 799
 800     $data_filler = sub {
 801         my $hdata = shift;
 802         if ($ctx->{email_notify}) { $hdata->{email_notify} = $ctx->{email_notify}; }
 803         if ($ctx->{phone_notify}) { $hdata->{phone_notify} = $ctx->{phone_notify}; }
 804         if ($ctx->{sms_notify}) { $hdata->{sms_notify} = $ctx->{sms_notify}; }
 805         if ($ctx->{sms_carrier}) { $hdata->{sms_carrier} = $ctx->{sms_carrier}; }
 806         return $hdata;
 807     };
 808
 809     my $type_dispatch = {
 810         M => sub {
 811             # target metarecords
 812             my $mrecs = $e->batch_retrieve_metabib_metarecord([
 813                 \@targets,
 814                 {flesh => 1, flesh_fields => {mmr => ['master_record']}}],
 815                 {substream => 1}
 816             );
 817
 818             for my $id (@targets) {
 819                 my ($mr) = grep {$_->id eq $id} @$mrecs;
 820
 821                 my $filter_data = $U->simplereq(
 822                     'open-ils.circ',
 823                     'open-ils.circ.mmr.holds.filters.authoritative', $mr->id);
 824
 825                 my $holdable_formats =
 826                     $self->compile_holdable_formats($mr->id);
 827
 828                 push(@hold_data, $data_filler->({
 829                     target => $mr,
 830                     record => $mr->master_record,
 831                     holdable_formats => $holdable_formats,
 832                     metarecord_filters => $filter_data->{metarecord}
 833                 }));
 834             }
 835         },
 836         T => sub {
 837             my $recs = $e->batch_retrieve_biblio_record_entry(
 838                 [\@targets,  {flesh => 1, flesh_fields => {bre => ['metarecord']}}],
 839                 {substream => 1}
 840             );
 841
 842             for my $id (@targets) { # force back into the correct order
 843                 my ($rec) = grep {$_->id eq $id} @$recs;
 844
 845                 # NOTE: if tpac ever supports locked-down pickup libs,
 846                 # we'll need to pass a pickup_lib param along with the
 847                 # record to filter the set of monographic parts.
 848                 my $parts = $U->simplereq(
 849                     'open-ils.search',
 850                     'open-ils.search.biblio.record_hold_parts',
 851                     {record => $rec->id}
 852                 );
 853
 854                 # T holds on records that have parts are OK, but if the record has
 855                 # no non-part copies, the hold will ultimately fail.  When that
 856                 # happens, require the user to select a part.
 857                 my $part_required = 0;
 858                 if (@$parts) {
 859                     my $np_copies = $e->json_query({
 860                         select => { acp => [{column => 'id', transform => 'count', alias => 'count'}]},
 861                         from => {acp => {acn => {}, acpm => {type => 'left'}}},
 862                         where => {
 863                             '+acp' => {deleted => 'f'},
 864                             '+acn' => {deleted => 'f', record => $rec->id},
 865                             '+acpm' => {id => undef}
 866                         }
 867                     });
 868                     $part_required = 1 if $np_copies->[0]->{count} == 0;
 869                 }
 870
 871                 push(@hold_data, $data_filler->({
 872                     target => $rec,
 873                     record => $rec,
 874                     parts => $parts,
 875                     part_required => $part_required
 876                 }));
 877             }
 878         },
 879         V => sub {
 880             my $vols = $e->batch_retrieve_asset_call_number([
 881                 \@targets, {
 882                     "flesh" => 1,
 883                     "flesh_fields" => {"acn" => ["record"]}
 884                 }
 885             ], {substream => 1});
 886
 887             for my $id (@targets) {
 888                 my ($vol) = grep {$_->id eq $id} @$vols;
 889                 push(@hold_data, $data_filler->({target => $vol, record => $vol->record}));
 890             }
 891         },
 892         C => sub {
 893             my $copies = $e->batch_retrieve_asset_copy([
 894                 \@targets, {
 895                     "flesh" => 2,
 896                     "flesh_fields" => {
 897                         "acn" => ["record"],
 898                         "acp" => ["call_number"]
 899                     }
 900                 }
 901             ], {substream => 1});
 902
 903             for my $id (@targets) {
 904                 my ($copy) = grep {$_->id eq $id} @$copies;
 905                 push(@hold_data, $data_filler->({target => $copy, record => $copy->call_number->record}));
 906             }
 907         },
 908         I => sub {
 909             my $isses = $e->batch_retrieve_serial_issuance([
 910                 \@targets, {
 911                     "flesh" => 2,
 912                     "flesh_fields" => {
 913                         "siss" => ["subscription"], "ssub" => ["record_entry"]
 914                     }
 915                 }
 916             ], {substream => 1});
 917
 918             for my $id (@targets) {
 919                 my ($iss) = grep {$_->id eq $id} @$isses;
 920                 push(@hold_data, $data_filler->({target => $iss, record => $iss->subscription->record_entry}));
 921             }
 922         }
 923         # ...
 924
 925     }->{$ctx->{hold_type}}->();
 926
 927     # caller sent bad target IDs or the wrong hold type
 928     return Apache2::Const::HTTP_BAD_REQUEST unless @hold_data;
 929
 930     # generate the MARC xml for each record
 931     $_->{marc_xml} = XML::LibXML->new->parse_string($_->{record}->marc) for @hold_data;
 932
 933     my $pickup_lib = $cgi->param('pickup_lib');
 934     # no pickup lib means no holds placement
 935     return Apache2::Const::OK unless $pickup_lib;
 936
 937     $ctx->{hold_attempt_made} = 1;
 938
 939     # Give the original CGI params back to the user in case they
 940     # want to try to override something.
 941     $ctx->{orig_params} = $cgi->Vars;
 942     delete $ctx->{orig_params}{submit};
 943     delete $ctx->{orig_params}{hold_target};
 944     delete $ctx->{orig_params}{part};
 945
 946     my $usr = $e->requestor->id;
 947
 948     if ($ctx->{is_staff} and !$cgi->param("hold_usr_is_requestor")) {
 949         # find the real hold target
 950
 951         $usr = $U->simplereq(
 952             'open-ils.actor',
 953             "open-ils.actor.user.retrieve_id_by_barcode_or_username",
 954             $e->authtoken, $cgi->param("hold_usr"));
 955
 956         if (defined $U->event_code($usr)) {
 957             $ctx->{hold_failed} = 1;
 958             $ctx->{hold_failed_event} = $usr;
 959         }
 960     }
 961
 962     # target_id is the true target_id for holds placement.
 963     # needed for attempt_hold_placement()
 964     # With the exception of P-type holds, target_id == target->id.
 965     $_->{target_id} = $_->{target}->id for @hold_data;
 966
 967     if ($ctx->{hold_type} eq 'T') {
 968
 969         # Much like quantum wave-particles, P-type holds pop into
 970         # and out of existence at the user's whim.  For our purposes,
 971         # we treat such holds as T(itle) holds with a selected_part
 972         # designation.  When the time comes to pass the hold information
 973         # off for holds possibility testing and placement, make it look
 974         # like a real P-type hold.
 975         my (@p_holds, @t_holds);
 976
 977         for my $idx (0..$#parts) {
 978             my $hdata = $hold_data[$idx];
 979             if (my $part = $parts[$idx]) {
 980                 $hdata->{target_id} = $part;
 981                 $hdata->{selected_part} = $part;
 982                 push(@p_holds, $hdata);
 983             } else {
 984                 push(@t_holds, $hdata);
 985             }
 986         }
 987
 988         $self->apache->log->warn("$#parts : @t_holds");
 989
 990         $self->attempt_hold_placement($usr, $pickup_lib, 'P', @p_holds) if @p_holds;
 991         $self->attempt_hold_placement($usr, $pickup_lib, 'T', @t_holds) if @t_holds;
 992
 993     } else {
 994         $self->attempt_hold_placement($usr, $pickup_lib, $ctx->{hold_type}, @hold_data);
 995     }
 996
 997     # NOTE: we are leaving the staff-placed patron barcode cookie
 998     # in place.  Otherwise, it's not possible to place more than
 999     # one hold for the patron within a staff/patron session.  This
1000     # does leave the barcode to linger longer than is ideal, but
1001     # normal staff work flow will cause the cookie to be replaced
1002     # with each new patron anyway.
1003     # TODO: See about getting the staff client to clear the cookie
1004
1005     # return to the place_hold page so the results of the hold
1006     # placement attempt can be reported to the user
1007     return Apache2::Const::OK;
1008 }
1009
1010 sub attempt_hold_placement {
1011     my ($self, $usr, $pickup_lib, $hold_type, @hold_data) = @_;
1012     my $cgi = $self->cgi;
1013     my $ctx = $self->ctx;
1014     my $e = $self->editor;
1015
1016     # First see if we should warn/block for any holds that
1017     # might have locally available items.
1018     for my $hdata (@hold_data) {
1019         my ($local_block, $local_alert) = $self->local_avail_concern(
1020             $hdata->{target_id}, $hold_type, $pickup_lib);
1021
1022         if ($local_block) {
1023             $hdata->{hold_failed} = 1;
1024             $hdata->{hold_local_block} = 1;
1025         } elsif ($local_alert) {
1026             $hdata->{hold_failed} = 1;
1027             $hdata->{hold_local_alert} = 1;
1028         }
1029     }
1030
1031     my $method = 'open-ils.circ.holds.test_and_create.batch';
1032
1033     if ($cgi->param('override')) {
1034         $method .= '.override';
1035
1036     } elsif (!$ctx->{is_staff})  {
1037
1038         $method .= '.override' if $self->ctx->{get_org_setting}->(
1039             $e->requestor->home_ou, "opac.patron.auto_overide_hold_events");
1040     }
1041
1042     my @create_targets = map {$_->{target_id}} (grep { !$_->{hold_failed} } @hold_data);
1043
1044     if(@create_targets) {
1045
1046         # holdable formats may be different for each MR hold.
1047         # map each set to the ID of the target.
1048         my $holdable_formats = {};
1049         if ($hold_type eq 'M') {
1050             $holdable_formats->{$_->{target_id}} =
1051                 $_->{holdable_formats} for @hold_data;
1052         }
1053
1054         my $bses = OpenSRF::AppSession->create('open-ils.circ');
1055         my $breq = $bses->request(
1056             $method,
1057             $e->authtoken,
1058             $data_filler->({
1059                 patronid => $usr,
1060                 pickup_lib => $pickup_lib,
1061                 hold_type => $hold_type,
1062                 holdable_formats_map => $holdable_formats
1063             }),
1064             \@create_targets
1065         );
1066
1067         while (my $resp = $breq->recv) {
1068
1069             $resp = $resp->content;
1070             $logger->info('batch hold placement result: ' . OpenSRF::Utils::JSON->perl2JSON($resp));
1071
1072             if ($U->event_code($resp)) {
1073                 $ctx->{general_hold_error} = $resp;
1074                 last;
1075             }
1076
1077             my ($hdata) = grep {$_->{target_id} eq $resp->{target}} @hold_data;
1078             my $result = $resp->{result};
1079
1080             if ($U->event_code($result)) {
1081                 # e.g. permission denied
1082                 $hdata->{hold_failed} = 1;
1083                 $hdata->{hold_failed_event} = $result;
1084
1085             } else {
1086
1087                 if(not ref $result and $result > 0) {
1088                     # successul hold returns the hold ID
1089
1090                     $hdata->{hold_success} = $result;
1091
1092                 } else {
1093                     # hold-specific failure event
1094                     $hdata->{hold_failed} = 1;
1095
1096                     if (ref $result eq 'HASH') {
1097                         $hdata->{hold_failed_event} = $result->{last_event};
1098
1099                         if ($result->{age_protected_copy}) {
1100                             $hdata->{could_override} = 1;
1101                             $hdata->{age_protect} = 1;
1102                         } else {
1103                             $hdata->{could_override} = $result->{place_unfillable} ||
1104                                 $self->test_could_override($hdata->{hold_failed_event});
1105                         }
1106                     } elsif (ref $result eq 'ARRAY') {
1107                         $hdata->{hold_failed_event} = $result->[0];
1108
1109                         if ($result->[3]) { # age_protect_only
1110                             $hdata->{could_override} = 1;
1111                             $hdata->{age_protect} = 1;
1112                         } else {
1113                             $hdata->{could_override} = $result->[4] || # place_unfillable
1114                                 $self->test_could_override($hdata->{hold_failed_event});
1115                         }
1116                     }
1117                 }
1118             }
1119         }
1120
1121         $bses->kill_me;
1122     }
1123 }
1124
1125 # pull the selected formats and languages for metarecord holds
1126 # from the CGI params and map them into the JSON holdable
1127 # formats...er, format.
1128 # if no metarecord is provided, we'll pull it from the target
1129 # of the provided hold.
1130 sub compile_holdable_formats {
1131     my ($self, $mr_id, $hold_id) = @_;
1132     my $e = $self->editor;
1133     my $cgi = $self->cgi;
1134
1135     # exit early if not needed
1136     return "" unless
1137         grep /metarecord_formats_|metarecord_langs_/,
1138         $cgi->param;
1139
1140     # CGI params are based on the MR id, since during hold placement
1141     # we have no old ID.  During hold edit, map the hold ID back to
1142     # the metarecod target.
1143     $mr_id =
1144         $e->retrieve_action_hold_request($hold_id)->target
1145         unless $mr_id;
1146
1147     my $format_attr = $self->ctx->{get_cgf}->(
1148         'opac.metarecord.holds.format_attr');
1149
1150     if (!$format_attr) {
1151         $logger->error("Missing config.global_flag: ".
1152             "opac.metarecord.holds.format_attr!");
1153         return "";
1154     }
1155
1156     $format_attr = $format_attr->value;
1157
1158     # during hold placement or edit submission, the user selects
1159     # which of the available formats/langs are acceptable.
1160     # Capture those here as the holdable_formats for the MR hold.
1161     my @selected_formats = $cgi->param("metarecord_formats_$mr_id");
1162     my @selected_langs = $cgi->param("metarecord_langs_$mr_id");
1163
1164     # map the selected attrs into the JSON holdable_formats structure
1165     my $blob = {};
1166     if (@selected_formats) {
1167         $blob->{0} = [
1168             map { {_attr => $format_attr, _val => $_} }
1169             @selected_formats
1170         ];
1171     }
1172     if (@selected_langs) {
1173         $blob->{1} = [
1174             map { {_attr => 'item_lang', _val => $_} }
1175             @selected_langs
1176         ];
1177     }
1178
1179     return OpenSRF::Utils::JSON->perl2JSON($blob);
1180 }
1181
1182 sub fetch_user_circs {
1183     my $self = shift;
1184     my $flesh = shift; # flesh bib data, etc.
1185     my $circ_ids = shift;
1186     my $limit = shift;
1187     my $offset = shift;
1188
1189     my $e = $self->editor;
1190
1191     my @circ_ids;
1192
1193     if($circ_ids) {
1194         @circ_ids = @$circ_ids;
1195
1196     } else {
1197
1198         my $query = {
1199             select => {circ => ['id']},
1200             from => 'circ',
1201             where => {
1202                 '+circ' => {
1203                     usr => $e->requestor->id,
1204                     checkin_time => undef,
1205                     '-or' => [
1206                         {stop_fines => undef},
1207                         {stop_fines => {'not in' => ['LOST','CLAIMSRETURNED','LONGOVERDUE']}}
1208                     ],
1209                 }
1210             },
1211             order_by => {circ => ['due_date']}
1212         };
1213
1214         $query->{limit} = $limit if $limit;
1215         $query->{offset} = $offset if $offset;
1216
1217         my $ids = $e->json_query($query);
1218         @circ_ids = map {$_->{id}} @$ids;
1219     }
1220
1221     return [] unless @circ_ids;
1222
1223     my $qflesh = {
1224         flesh => 3,
1225         flesh_fields => {
1226             circ => ['target_copy'],
1227             acp => ['call_number'],
1228             acn => ['record']
1229         }
1230     };
1231
1232     $e->xact_begin;
1233     my $circs = $e->search_action_circulation(
1234         [{id => \@circ_ids}, ($flesh) ? $qflesh : {}], {substream => 1});
1235
1236     my @circs;
1237     for my $circ (@$circs) {
1238         push(@circs, {
1239             circ => $circ,
1240             marc_xml => ($flesh and $circ->target_copy->call_number->id != -1) ?
1241                 XML::LibXML->new->parse_string($circ->target_copy->call_number->record->marc) :
1242                 undef  # pre-cat copy, use the dummy title/author instead
1243         });
1244     }
1245     $e->xact_rollback;
1246
1247     # make sure the final list is in the correct order
1248     my @sorted_circs;
1249     for my $id (@circ_ids) {
1250         push(
1251             @sorted_circs,
1252             (grep { $_->{circ}->id == $id } @circs)
1253         );
1254     }
1255
1256     return \@sorted_circs;
1257 }
1258
1259
1260 sub handle_circ_renew {
1261     my $self = shift;
1262     my $action = shift;
1263     my $ctx = $self->ctx;
1264
1265     my @renew_ids = $self->cgi->param('circ');
1266
1267     my $circs = $self->fetch_user_circs(0, ($action eq 'renew') ? [@renew_ids] : undef);
1268
1269     # TODO: fire off renewal calls in batches to speed things up
1270     my @responses;
1271     for my $circ (@$circs) {
1272
1273         my $evt = $U->simplereq(
1274             'open-ils.circ',
1275             'open-ils.circ.renew',
1276             $self->editor->authtoken,
1277             {
1278                 patron_id => $self->editor->requestor->id,
1279                 copy_id => $circ->{circ}->target_copy,
1280                 opac_renewal => 1
1281             }
1282         );
1283
1284         # TODO return these, then insert them into the circ data
1285         # blob that is shoved into the template for each circ
1286         # so the template won't have to match them
1287         push(@responses, {copy => $circ->{circ}->target_copy, evt => $evt});
1288     }
1289
1290     return @responses;
1291 }
1292
1293
1294 sub load_myopac_circs {
1295     my $self = shift;
1296     my $e = $self->editor;
1297     my $ctx = $self->ctx;
1298
1299     $ctx->{circs} = [];
1300     my $limit = $self->cgi->param('limit') || 0; # 0 == unlimited
1301     my $offset = $self->cgi->param('offset') || 0;
1302     my $action = $self->cgi->param('action') || '';
1303
1304     # perform the renewal first if necessary
1305     my @results = $self->handle_circ_renew($action) if $action =~ /renew/;
1306
1307     $ctx->{circs} = $self->fetch_user_circs(1, undef, $limit, $offset);
1308
1309     my $success_renewals = 0;
1310     my $failed_renewals = 0;
1311     for my $data (@{$ctx->{circs}}) {
1312         my ($resp) = grep { $_->{copy} == $data->{circ}->target_copy->id } @results;
1313
1314         if($resp) {
1315             my $evt = ref($resp->{evt}) eq 'ARRAY' ? $resp->{evt}->[0] : $resp->{evt};
1316             $data->{renewal_response} = $evt;
1317             $success_renewals++ if $evt->{textcode} eq 'SUCCESS';
1318             $failed_renewals++ if $evt->{textcode} ne 'SUCCESS';
1319         }
1320     }
1321
1322     $ctx->{success_renewals} = $success_renewals;
1323     $ctx->{failed_renewals} = $failed_renewals;
1324
1325     return Apache2::Const::OK;
1326 }
1327
1328 sub load_myopac_circ_history {
1329     my $self = shift;
1330     my $e = $self->editor;
1331     my $ctx = $self->ctx;
1332     my $limit = $self->cgi->param('limit') || 15;
1333     my $offset = $self->cgi->param('offset') || 0;
1334
1335     $ctx->{circ_history_limit} = $limit;
1336     $ctx->{circ_history_offset} = $offset;
1337
1338     my $circ_ids = $e->json_query({
1339         select => {
1340             au => [{
1341                 column => 'id',
1342                 transform => 'action.usr_visible_circs',
1343                 result_field => 'id'
1344             }]
1345         },
1346         from => 'au',
1347         where => {id => $e->requestor->id},
1348         limit => $limit,
1349         offset => $offset
1350     });
1351
1352     $ctx->{circs} = $self->fetch_user_circs(1, [map { $_->{id} } @$circ_ids]);
1353     return Apache2::Const::OK;
1354 }
1355
1356 # TODO: action.usr_visible_holds does not return cancelled holds.  Should it?
1357 sub load_myopac_hold_history {
1358     my $self = shift;
1359     my $e = $self->editor;
1360     my $ctx = $self->ctx;
1361     my $limit = $self->cgi->param('limit') || 15;
1362     my $offset = $self->cgi->param('offset') || 0;
1363     $ctx->{hold_history_limit} = $limit;
1364     $ctx->{hold_history_offset} = $offset;
1365
1366     my $hold_ids = $e->json_query({
1367         select => {
1368             au => [{
1369                 column => 'id',
1370                 transform => 'action.usr_visible_holds',
1371                 result_field => 'id'
1372             }]
1373         },
1374         from => 'au',
1375         where => {id => $e->requestor->id}
1376     });
1377
1378     my $holds_object = $self->fetch_user_holds([map { $_->{id} } @$hold_ids], 0, 1, 0, $limit, $offset);
1379     if($holds_object->{holds}) {
1380         $ctx->{holds} = $holds_object->{holds};
1381     }
1382     $ctx->{hold_history_ids} = $holds_object->{all_ids};
1383
1384     return Apache2::Const::OK;
1385 }
1386
1387 sub load_myopac_payment_form {
1388     my $self = shift;
1389     my $r;
1390
1391     $r = $self->prepare_fines(undef, undef, [$self->cgi->param('xact'), $self->cgi->param('xact_misc')]) and return $r;
1392     $r = $self->prepare_extended_user_info and return $r;
1393
1394     return Apache2::Const::OK;
1395 }
1396
1397 # TODO: add other filter options as params/configs/etc.
1398 sub load_myopac_payments {
1399     my $self = shift;
1400     my $limit = $self->cgi->param('limit') || 20;
1401     my $offset = $self->cgi->param('offset') || 0;
1402     my $e = $self->editor;
1403
1404     $self->ctx->{payment_history_limit} = $limit;
1405     $self->ctx->{payment_history_offset} = $offset;
1406
1407     my $args = {};
1408     $args->{limit} = $limit if $limit;
1409     $args->{offset} = $offset if $offset;
1410
1411     if (my $max_age = $self->ctx->{get_org_setting}->(
1412         $e->requestor->home_ou, "opac.payment_history_age_limit"
1413     )) {
1414         my $min_ts = DateTime->now(
1415             "time_zone" => DateTime::TimeZone->new("name" => "local"),
1416         )->subtract("seconds" => interval_to_seconds($max_age))->iso8601();
1417
1418         $logger->info("XXX min_ts: $min_ts");
1419         $args->{"where"} = {"payment_ts" => {">=" => $min_ts}};
1420     }
1421
1422     $self->ctx->{payments} = $U->simplereq(
1423         'open-ils.actor',
1424         'open-ils.actor.user.payments.retrieve.atomic',
1425         $e->authtoken, $e->requestor->id, $args);
1426
1427     return Apache2::Const::OK;
1428 }
1429
1430 # 1. caches the form parameters
1431 # 2. loads the credit card payment "Processing..." page
1432 sub load_myopac_pay_init {
1433     my $self = shift;
1434     my $cache = OpenSRF::Utils::Cache->new('global');
1435
1436     my @payment_xacts = ($self->cgi->param('xact'), $self->cgi->param('xact_misc'));
1437
1438     if (!@payment_xacts) {
1439         # for consistency with load_myopac_payment_form() and
1440         # to preserve backwards compatibility, if no xacts are
1441         # selected, assume all (applicable) transactions are wanted.
1442         my $stat = $self->prepare_fines(undef, undef, [$self->cgi->param('xact'), $self->cgi->param('xact_misc')]);
1443         return $stat if $stat;
1444         @payment_xacts =
1445             map { $_->{xact}->id } (
1446                 @{$self->ctx->{fines}->{circulation}},
1447                 @{$self->ctx->{fines}->{grocery}}
1448         );
1449     }
1450
1451     return $self->generic_redirect unless @payment_xacts;
1452
1453     my $cc_args = {"where_process" => 1};
1454
1455     $cc_args->{$_} = $self->cgi->param($_) for (qw/
1456         number cvv2 expire_year expire_month billing_first
1457         billing_last billing_address billing_city billing_state
1458         billing_zip stripe_token
1459     /);
1460
1461     my $cache_args = {
1462         cc_args => $cc_args,
1463         user => $self->ctx->{user}->id,
1464         xacts => \@payment_xacts
1465     };
1466
1467     # generate a temporary cache token and cache the form data
1468     my $token = md5_hex($$ . time() . rand());
1469     $cache->put_cache($token, $cache_args, 30);
1470
1471     $logger->info("tpac caching payment info with token $token and xacts [@payment_xacts]");
1472
1473     # after we render the processing page, we quickly redirect to submit
1474     # the actual payment.  The refresh url contains the payment token.
1475     # It also contains the list of xact IDs, which allows us to clear the
1476     # cache at the earliest possible time while leaving a trace of which
1477     # transactions we were processing, so the UI can bring the user back
1478     # to the payment form w/ the same xacts if the payment fails.
1479
1480     my $refresh = "1; url=main_pay/$token?xact=" . pop(@payment_xacts);
1481     $refresh .= ";xact=$_" for @payment_xacts;
1482     $self->ctx->{refresh} = $refresh;
1483
1484     return Apache2::Const::OK;
1485 }
1486
1487 # retrieve the cached CC payment info and send off for processing
1488 sub load_myopac_pay {
1489     my $self = shift;
1490     my $token = $self->ctx->{page_args}->[0];
1491     return Apache2::Const::HTTP_BAD_REQUEST unless $token;
1492
1493     my $cache = OpenSRF::Utils::Cache->new('global');
1494     my $cache_args = $cache->get_cache($token);
1495     $cache->delete_cache($token);
1496
1497     # this page is loaded immediately after the token is created.
1498     # if the cached data is not there, it's because of an invalid
1499     # token (or cache failure) and not because of a timeout.
1500     return Apache2::Const::HTTP_BAD_REQUEST unless $cache_args;
1501
1502     my @payment_xacts = @{$cache_args->{xacts}};
1503     my $cc_args = $cache_args->{cc_args};
1504
1505     # as an added security check, verify the user submitting
1506     # the form is the same as the user whose data was cached
1507     return Apache2::Const::HTTP_BAD_REQUEST unless
1508         $cache_args->{user} == $self->ctx->{user}->id;
1509
1510     $logger->info("tpac paying fines with token $token and xacts [@payment_xacts]");
1511
1512     my $r;
1513     $r = $self->prepare_fines(undef, undef, \@payment_xacts) and return $r;
1514
1515     # balance_owed is computed specifically from the fines we're paying
1516     if ($self->ctx->{fines}->{balance_owed} <= 0) {
1517         $logger->info("tpac can't pay non-positive balance. xacts selected: [@payment_xacts]");
1518         return Apache2::Const::HTTP_BAD_REQUEST;
1519     }
1520
1521     my $args = {
1522         "cc_args" => $cc_args,
1523         "userid" => $self->ctx->{user}->id,
1524         "payment_type" => "credit_card_payment",
1525         "payments" => $self->prepare_fines_for_payment  # should be safe after self->prepare_fines
1526     };
1527
1528     my $resp = $U->simplereq("open-ils.circ", "open-ils.circ.money.payment",
1529         $self->editor->authtoken, $args, $self->ctx->{user}->last_xact_id
1530     );
1531
1532     $self->ctx->{"payment_response"} = $resp;
1533
1534     unless ($resp->{"textcode"}) {
1535         $self->ctx->{printable_receipt} = $U->simplereq(
1536            "open-ils.circ", "open-ils.circ.money.payment_receipt.print",
1537            $self->editor->authtoken, $resp->{payments}
1538         );
1539     }
1540
1541     return Apache2::Const::OK;
1542 }
1543
1544 sub load_myopac_receipt_print {
1545     my $self = shift;
1546
1547     $self->ctx->{printable_receipt} = $U->simplereq(
1548        "open-ils.circ", "open-ils.circ.money.payment_receipt.print",
1549        $self->editor->authtoken, [$self->cgi->param("payment")]
1550     );
1551
1552     return Apache2::Const::OK;
1553 }
1554
1555 sub load_myopac_receipt_email {
1556     my $self = shift;
1557
1558     # The following ML method doesn't actually check whether the user in
1559     # question has an email address, so we do.
1560     if ($self->ctx->{user}->email) {
1561         $self->ctx->{email_receipt_result} = $U->simplereq(
1562            "open-ils.circ", "open-ils.circ.money.payment_receipt.email",
1563            $self->editor->authtoken, [$self->cgi->param("payment")]
1564         );
1565     } else {
1566         $self->ctx->{email_receipt_result} =
1567             new OpenILS::Event("PATRON_NO_EMAIL_ADDRESS");
1568     }
1569
1570     return Apache2::Const::OK;
1571 }
1572
1573 sub prepare_fines {
1574     my ($self, $limit, $offset, $id_list) = @_;
1575
1576     # XXX TODO: check for failure after various network calls
1577
1578     # It may be unclear, but this result structure lumps circulation and
1579     # reservation fines together, and keeps grocery fines separate.
1580     $self->ctx->{"fines"} = {
1581         "circulation" => [],
1582         "grocery" => [],
1583         "total_paid" => 0,
1584         "total_owed" => 0,
1585         "balance_owed" => 0
1586     };
1587
1588     my $cstore = OpenSRF::AppSession->create('open-ils.cstore');
1589
1590     # TODO: This should really be a ML call, but the existing calls
1591     # return an excessive amount of data and don't offer streaming
1592
1593     my %paging = ($limit or $offset) ? (limit => $limit, offset => $offset) : ();
1594
1595     my $req = $cstore->request(
1596         'open-ils.cstore.direct.money.open_billable_transaction_summary.search',
1597         {
1598             usr => $self->editor->requestor->id,
1599             balance_owed => {'!=' => 0},
1600             ($id_list && @$id_list ? ("id" => $id_list) : ()),
1601         },
1602         {
1603             flesh => 4,
1604             flesh_fields => {
1605                 mobts => [qw/grocery circulation reservation/],
1606                 bresv => ['target_resource_type'],
1607                 brt => ['record'],
1608                 mg => ['billings'],
1609                 mb => ['btype'],
1610                 circ => ['target_copy'],
1611                 acp => ['call_number'],
1612                 acn => ['record']
1613             },
1614             order_by => { mobts => 'xact_start' },
1615             %paging
1616         }
1617     );
1618
1619     my @total_keys = qw/total_paid total_owed balance_owed/;
1620     $self->ctx->{"fines"}->{@total_keys} = (0, 0, 0);
1621
1622     while(my $resp = $req->recv) {
1623         my $mobts = $resp->content;
1624         my $circ = $mobts->circulation;
1625
1626         my $last_billing;
1627         if($mobts->grocery) {
1628             my @billings = sort { $a->billing_ts cmp $b->billing_ts } @{$mobts->grocery->billings};
1629             $last_billing = pop(@billings);
1630         }
1631
1632         # XXX TODO confirm that the following, and the later division by 100.0
1633         # to get a floating point representation once again, is sufficiently
1634         # "money-safe" math.
1635         $self->ctx->{"fines"}->{$_} += int($mobts->$_ * 100) for (@total_keys);
1636
1637         my $marc_xml = undef;
1638         if ($mobts->xact_type eq 'reservation' and
1639             $mobts->reservation->target_resource_type->record) {
1640             $marc_xml = XML::LibXML->new->parse_string(
1641                 $mobts->reservation->target_resource_type->record->marc
1642             );
1643         } elsif ($mobts->xact_type eq 'circulation' and
1644             $circ->target_copy->call_number->id != -1) {
1645             $marc_xml = XML::LibXML->new->parse_string(
1646                 $circ->target_copy->call_number->record->marc
1647             );
1648         }
1649
1650         push(
1651             @{$self->ctx->{"fines"}->{$mobts->grocery ? "grocery" : "circulation"}},
1652             {
1653                 xact => $mobts,
1654                 last_grocery_billing => $last_billing,
1655                 marc_xml => $marc_xml
1656             }
1657         );
1658     }
1659
1660     $cstore->kill_me;
1661
1662     $self->ctx->{"fines"}->{$_} /= 100.0 for (@total_keys);
1663     return;
1664 }
1665
1666 sub prepare_fines_for_payment {
1667     # This assumes $self->prepare_fines has already been run
1668     my ($self) = @_;
1669
1670     my @results = ();
1671     if ($self->ctx->{fines}) {
1672         push @results, [$_->{xact}->id, $_->{xact}->balance_owed] foreach (
1673             @{$self->ctx->{fines}->{circulation}},
1674             @{$self->ctx->{fines}->{grocery}}
1675         );
1676     }
1677
1678     return \@results;
1679 }
1680
1681 sub load_myopac_main {
1682     my $self = shift;
1683     my $limit = $self->cgi->param('limit') || 0;
1684     my $offset = $self->cgi->param('offset') || 0;
1685     $self->ctx->{search_ou} = $self->_get_search_lib();
1686     $self->ctx->{user}->notes(
1687         $self->editor->search_actor_usr_note({
1688             usr => $self->ctx->{user}->id,
1689             pub => 't'
1690         })
1691     );
1692     return $self->prepare_fines($limit, $offset) || Apache2::Const::OK;
1693 }
1694
1695 sub load_myopac_update_email {
1696     my $self = shift;
1697     my $e = $self->editor;
1698     my $ctx = $self->ctx;
1699     my $email = $self->cgi->param('email') || '';
1700     my $current_pw = $self->cgi->param('current_pw') || '';
1701
1702     # needed for most up-to-date email address
1703     if (my $r = $self->prepare_extended_user_info) { return $r };
1704
1705     return Apache2::Const::OK
1706         unless $self->cgi->request_method eq 'POST';
1707
1708     unless($email =~ /.+\@.+\..+/) { # TODO better regex?
1709         $ctx->{invalid_email} = $email;
1710         return Apache2::Const::OK;
1711     }
1712
1713     my $stat = $U->simplereq(
1714         'open-ils.actor',
1715         'open-ils.actor.user.email.update',
1716         $e->authtoken, $email, $current_pw);
1717
1718     if($U->event_equals($stat, 'INCORRECT_PASSWORD')) {
1719         $ctx->{password_incorrect} = 1;
1720         return Apache2::Const::OK;
1721     }
1722
1723     unless ($self->cgi->param("redirect_to")) {
1724         my $url = $self->apache->unparsed_uri;
1725         $url =~ s/update_email/prefs/;
1726
1727         return $self->generic_redirect($url);
1728     }
1729
1730     return $self->generic_redirect;
1731 }
1732
1733 sub load_myopac_update_username {
1734     my $self = shift;
1735     my $e = $self->editor;
1736     my $ctx = $self->ctx;
1737     my $username = $self->cgi->param('username') || '';
1738     my $current_pw = $self->cgi->param('current_pw') || '';
1739
1740     $self->prepare_extended_user_info;
1741
1742     my $allow_change = 1;
1743     my $regex_check;
1744     my $lock_usernames = $self->ctx->{get_org_setting}->($e->requestor->home_ou, 'opac.lock_usernames');
1745     if(defined($lock_usernames) and $lock_usernames == 1) {
1746         # Policy says no username changes
1747         $allow_change = 0;
1748     } else {
1749         # We want this further down.
1750         $regex_check = $self->ctx->{get_org_setting}->($e->requestor->home_ou, 'opac.barcode_regex');
1751         my $username_unlimit = $self->ctx->{get_org_setting}->($e->requestor->home_ou, 'opac.unlimit_usernames');
1752         if(!$username_unlimit) {
1753             if(!$regex_check) {
1754                 # Default is "starts with a number"
1755                 $regex_check = '^\d+';
1756             }
1757             # You already have a username?
1758             if($regex_check and $self->ctx->{user}->usrname !~ /$regex_check/) {
1759                 $allow_change = 0;
1760             }
1761         }
1762     }
1763     if(!$allow_change) {
1764         my $url = $self->apache->unparsed_uri;
1765         $url =~ s/update_username/prefs/;
1766
1767         return $self->generic_redirect($url);
1768     }
1769
1770     return Apache2::Const::OK
1771         unless $self->cgi->request_method eq 'POST';
1772
1773     unless($username and $username !~ /\s/) { # any other username restrictions?
1774         $ctx->{invalid_username} = $username;
1775         return Apache2::Const::OK;
1776     }
1777
1778     # New username can't look like a barcode if we have a barcode regex
1779     if($regex_check and $username =~ /$regex_check/) {
1780         $ctx->{invalid_username} = $username;
1781         return Apache2::Const::OK;
1782     }
1783
1784     # New username has to look like a username if we have a username regex
1785     $regex_check = $ctx->{get_org_setting}->($e->requestor->home_ou, 'opac.username_regex');
1786     if($regex_check and $username !~ /$regex_check/) {
1787         $ctx->{invalid_username} = $username;
1788         return Apache2::Const::OK;
1789     }
1790
1791     if($username ne $e->requestor->usrname) {
1792
1793         my $evt = $U->simplereq(
1794             'open-ils.actor',
1795             'open-ils.actor.user.username.update',
1796             $e->authtoken, $username, $current_pw);
1797
1798         if($U->event_equals($evt, 'INCORRECT_PASSWORD')) {
1799             $ctx->{password_incorrect} = 1;
1800             return Apache2::Const::OK;
1801         }
1802
1803         if($U->event_equals($evt, 'USERNAME_EXISTS')) {
1804             $ctx->{username_exists} = $username;
1805             return Apache2::Const::OK;
1806         }
1807     }
1808
1809     my $url = $self->apache->unparsed_uri;
1810     $url =~ s/update_username/prefs/;
1811
1812     return $self->generic_redirect($url);
1813 }
1814
1815 sub load_myopac_update_password {
1816     my $self = shift;
1817     my $e = $self->editor;
1818     my $ctx = $self->ctx;
1819
1820     return Apache2::Const::OK
1821         unless $self->cgi->request_method eq 'POST';
1822
1823     my $current_pw = $self->cgi->param('current_pw') || '';
1824     my $new_pw = $self->cgi->param('new_pw') || '';
1825     my $new_pw2 = $self->cgi->param('new_pw2') || '';
1826
1827     unless($new_pw eq $new_pw2) {
1828         $ctx->{password_nomatch} = 1;
1829         return Apache2::Const::OK;
1830     }
1831
1832     my $pw_regex = $ctx->{get_org_setting}->($e->requestor->home_ou, 'global.password_regex');
1833
1834     if(!$pw_regex) {
1835         # This regex duplicates the JSPac's default "digit, letter, and 7 characters" rule
1836         $pw_regex = '(?=.*\d+.*)(?=.*[A-Za-z]+.*).{7,}';
1837     }
1838
1839     if($pw_regex and $new_pw !~ /$pw_regex/) {
1840         $ctx->{password_invalid} = 1;
1841         return Apache2::Const::OK;
1842     }
1843
1844     my $evt = $U->simplereq(
1845         'open-ils.actor',
1846         'open-ils.actor.user.password.update',
1847         $e->authtoken, $new_pw, $current_pw);
1848
1849
1850     if($U->event_equals($evt, 'INCORRECT_PASSWORD')) {
1851         $ctx->{password_incorrect} = 1;
1852         return Apache2::Const::OK;
1853     }
1854
1855     my $url = $self->apache->unparsed_uri;
1856     $url =~ s/update_password/prefs/;
1857
1858     return $self->generic_redirect($url);
1859 }
1860
1861 sub _update_bookbag_metadata {
1862     my ($self, $bookbag) = @_;
1863
1864     $bookbag->name($self->cgi->param("name"));
1865     $bookbag->description($self->cgi->param("description"));
1866
1867     return 1 if $self->editor->update_container_biblio_record_entry_bucket($bookbag);
1868     return 0;
1869 }
1870
1871 sub _get_lists_per_page {
1872     my $self = shift;
1873
1874     if($self->editor->requestor) {
1875         $self->timelog("Checking for opac.lists_per_page preference");
1876         # See if the user has a lists per page preference
1877         my $ipp = $self->editor->search_actor_user_setting({
1878             usr => $self->editor->requestor->id,
1879             name => 'opac.lists_per_page'
1880         })->[0];
1881         $self->timelog("Got opac.lists_per_page preference");
1882         return OpenSRF::Utils::JSON->JSON2perl($ipp->value) if $ipp;
1883     }
1884     return 10; # default
1885 }
1886
1887 sub _get_items_per_page {
1888     my $self = shift;
1889
1890     if($self->editor->requestor) {
1891         $self->timelog("Checking for opac.list_items_per_page preference");
1892         # See if the user has a list items per page preference
1893         my $ipp = $self->editor->search_actor_user_setting({
1894             usr => $self->editor->requestor->id,
1895             name => 'opac.list_items_per_page'
1896         })->[0];
1897         $self->timelog("Got opac.list_items_per_page preference");
1898         return OpenSRF::Utils::JSON->JSON2perl($ipp->value) if $ipp;
1899     }
1900     return 10; # default
1901 }
1902
1903 sub load_myopac_bookbags {
1904     my $self = shift;
1905     my $e = $self->editor;
1906     my $ctx = $self->ctx;
1907     my $limit = $self->_get_lists_per_page || 10;
1908     my $offset = $self->cgi->param('offset') || 0;
1909
1910     $ctx->{bookbags_limit} = $limit;
1911     $ctx->{bookbags_offset} = $offset;
1912
1913     # for list item pagination
1914     my $item_limit = $self->_get_items_per_page;
1915     my $item_page = $self->cgi->param('item_page') || 1;
1916     my $item_offset = ($item_page - 1) * $item_limit;
1917     $ctx->{bookbags_item_page} = $item_page;
1918
1919     my ($sorter, $modifier) = $self->_get_bookbag_sort_params("sort");
1920     $e->xact_begin; # replication...
1921
1922     my $rv = $self->load_mylist;
1923     unless($rv eq Apache2::Const::OK) {
1924         $e->rollback;
1925         return $rv;
1926     }
1927
1928     $ctx->{bookbags} = $e->search_container_biblio_record_entry_bucket(
1929         [
1930             {owner => $e->requestor->id, btype => 'bookbag'}, {
1931                 order_by => {cbreb => 'name'},
1932                 limit => $limit,
1933                 offset => $offset
1934             }
1935         ],
1936         {substream => 1}
1937     );
1938
1939     if(!$ctx->{bookbags}) {
1940         $e->rollback;
1941         return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
1942     }
1943
1944     # We load the user prefs to get their default bookbag.
1945     $self->_load_user_with_prefs;
1946
1947     # We also want a total count of the user's bookbags.
1948     my $q = {
1949         'select' => { 'cbreb' => [ { 'column' => 'id', 'transform' => 'count', 'aggregate' => 'true', 'alias' => 'count' } ] },
1950         'from' => 'cbreb',
1951         'where' => { 'btype' => 'bookbag', 'owner' => $self->ctx->{user}->id }
1952     };
1953     my $r = $e->json_query($q);
1954     $ctx->{bookbag_count} = $r->[0]->{'count'};
1955
1956     # If the user wants a specific bookbag's items, load them.
1957
1958     if ($self->cgi->param("bbid")) {
1959         my ($bookbag) =
1960             grep { $_->id eq $self->cgi->param("bbid") } @{$ctx->{bookbags}};
1961
1962         if ($bookbag) {
1963             my $query = $self->_prepare_bookbag_container_query(
1964                 $bookbag->id, $sorter, $modifier
1965             );
1966
1967             # Calculate total count of the items in selected bookbag.
1968             # This total includes record entries that have no assets available.
1969             my $bb_search_results = $U->simplereq(
1970                 "open-ils.search", "open-ils.search.biblio.multiclass.query",
1971                 {"limit" => 1, "offset" => 0}, $query
1972             ); # we only need the count, so do the actual search with limit=1
1973
1974             if ($bb_search_results) {
1975                 $ctx->{bb_item_count} = $bb_search_results->{count};
1976             } else {
1977                 $logger->warn("search failed in load_myopac_bookbags()");
1978                 $ctx->{bb_item_count} = 0; # fallback value
1979             }
1980
1981             #calculate page count
1982             $ctx->{bb_page_count} = int ((($ctx->{bb_item_count} - 1) / $item_limit) + 1);
1983
1984             if ( ($self->cgi->param("action") || '') eq "editmeta") {
1985                 if (!$self->_update_bookbag_metadata($bookbag))  {
1986                     $e->rollback;
1987                     return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
1988                 } else {
1989                     $e->commit;
1990                     my $url = $self->ctx->{opac_root} . '/myopac/lists?bbid=' .
1991                         $bookbag->id;
1992
1993                     foreach my $param (('loc', 'qtype', 'query', 'sort', 'offset', 'limit')) {
1994                         if ($self->cgi->param($param)) {
1995                             $url .= ";$param=" . uri_escape_utf8($self->cgi->param($param));
1996                         }
1997                     }
1998
1999                     return $self->generic_redirect($url);
2000                 }
2001             }
2002
2003             # we're done with our CStoreEditor.  Rollback here so
2004             # later calls don't cause a timeout, resulting in a
2005             # transaction rollback under the covers.
2006             $e->rollback;
2007
2008
2009             # For list items pagination
2010             my $args = {
2011                 "limit" => $item_limit,
2012                 "offset" => $item_offset
2013             };
2014
2015             my $items = $U->bib_container_items_via_search($bookbag->id, $query, $args)
2016                 or return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
2017
2018             # capture pref_ou for callnumber filter/display
2019             $ctx->{pref_ou} = $self->_get_pref_lib() || $ctx->{search_ou};
2020
2021             # search for local callnumbers for display
2022             my $focus_ou = $ctx->{physical_loc} || $ctx->{pref_ou};
2023
2024             my (undef, @recs) = $self->get_records_and_facets(
2025                 [ map {$_->target_biblio_record_entry->id} @$items ],
2026                 undef,
2027                 {
2028                     flesh => '{mra,holdings_xml,acp,exclude_invisible_acn}',
2029                     flesh_depth => 1,
2030                     site => $ctx->{get_aou}->($focus_ou)->shortname,
2031                     pref_lib => $ctx->{pref_ou}
2032                 }
2033             );
2034
2035             $ctx->{bookbags_marc_xml}{$_->{id}} = $_->{marc_xml} for @recs;
2036
2037             $bookbag->items($items);
2038         }
2039     }
2040
2041     # If we have add_rec, we got here from the "Add to new list"
2042     # or "See all" popmenu items.
2043     if (my $add_rec = $self->cgi->param('add_rec')) {
2044         $self->ctx->{add_rec} = $add_rec;
2045         # But not in the staff client, 'cause that breaks things.
2046         unless ($self->ctx->{is_staff}) {
2047             # allow caller to provide the where_from in cases where
2048             # the referer is an intermediate error page
2049             if ($self->cgi->param('where_from')) {
2050                 $self->ctx->{where_from} = $self->cgi->param('where_from');
2051             } else {
2052                 $self->ctx->{where_from} = $self->ctx->{referer};
2053                 if ( my $anchor = $self->cgi->param('anchor') ) {
2054                     $self->ctx->{where_from} =~ s/#.*|$/#$anchor/;
2055                 }
2056             }
2057         }
2058     }
2059
2060     # this rollback may be a dupe, but that's OK because
2061     # cstoreditor ignores dupe rollbacks
2062     $e->rollback;
2063
2064     return Apache2::Const::OK;
2065 }
2066
2067
2068 # actions are create, delete, show, hide, rename, add_rec, delete_item, place_hold
2069 # CGI is action, list=list_id, add_rec/record=bre_id, del_item=bucket_item_id, name=new_bucket_name
2070 sub load_myopac_bookbag_update {
2071     my ($self, $action, $list_id, @hold_recs) = @_;
2072     my $e = $self->editor;
2073     my $cgi = $self->cgi;
2074
2075     # save_notes is effectively another action, but is passed in a separate
2076     # CGI parameter for what are really just layout reasons.
2077     $action = 'save_notes' if $cgi->param('save_notes');
2078     $action ||= $cgi->param('action');
2079
2080     $list_id ||= $cgi->param('list') || $cgi->param('bbid');
2081
2082     my @add_rec = $cgi->param('add_rec') || $cgi->param('record');
2083     my @selected_item = $cgi->param('selected_item');
2084     my $shared = $cgi->param('shared');
2085     my $name = $cgi->param('name');
2086     my $description = $cgi->param('description');
2087     my $success = 0;
2088     my $list;
2089
2090     # This url intentionally leaves off the edit_notes parameter, but
2091     # may need to add some back in for paging.
2092
2093     my $url = $self->ctx->{proto} . "://" . $self->ctx->{hostname} .
2094         $self->ctx->{opac_root} . "/myopac/lists?";
2095
2096     foreach my $param (('loc', 'qtype', 'query', 'sort')) {
2097         if ($cgi->param($param)) {
2098             $url .= "$param=" . uri_escape_utf8($cgi->param($param)) . ";";
2099         }
2100     }
2101
2102     if ($action eq 'create') {
2103
2104         if ($name) {
2105             $list = Fieldmapper::container::biblio_record_entry_bucket->new;
2106             $list->name($name);
2107             $list->description($description);
2108             $list->owner($e->requestor->id);
2109             $list->btype('bookbag');
2110             $list->pub($shared ? 't' : 'f');
2111             $success = $U->simplereq('open-ils.actor',
2112                 'open-ils.actor.container.create', $e->authtoken, 'biblio', $list);
2113             if (ref($success) ne 'HASH' && scalar @add_rec) {
2114                 $list_id = (ref($success)) ? $success->id : $success;
2115                 foreach my $add_rec (@add_rec) {
2116                     my $item = Fieldmapper::container::biblio_record_entry_bucket_item->new;
2117                     $item->bucket($list_id);
2118                     $item->target_biblio_record_entry($add_rec);
2119                     $success = $U->simplereq('open-ils.actor',
2120                                              'open-ils.actor.container.item.create', $e->authtoken, 'biblio', $item);
2121                     last unless $success;
2122                 }
2123             }
2124             $url = $cgi->param('where_from') if ($success && $cgi->param('where_from'));
2125
2126         } else { # no name
2127             $self->ctx->{bucket_failure_noname} = 1;
2128         }
2129
2130     } elsif($action eq 'place_hold') {
2131
2132         # @hold_recs comes from anon lists redirect; selected_itesm comes from existing buckets
2133         unless (@hold_recs) {
2134             if (@selected_item) {
2135                 my $items = $e->search_container_biblio_record_entry_bucket_item({id => \@selected_item});
2136                 @hold_recs = map { $_->target_biblio_record_entry } @$items;
2137             }
2138         }
2139
2140         return Apache2::Const::OK unless @hold_recs;
2141         $logger->info("placing holds from list page on: @hold_recs");
2142
2143         my $url = $self->ctx->{opac_root} . '/place_hold?hold_type=T';
2144         $url .= ';hold_target=' . $_ for @hold_recs;
2145         foreach my $param (('loc', 'qtype', 'query')) {
2146             if ($cgi->param($param)) {
2147                 $url .= ";$param=" . uri_escape_utf8($cgi->param($param));
2148             }
2149         }
2150         return $self->generic_redirect($url);
2151
2152     } else {
2153
2154         $list = $e->retrieve_container_biblio_record_entry_bucket($list_id);
2155
2156         return Apache2::Const::HTTP_BAD_REQUEST unless
2157             $list and $list->owner == $e->requestor->id;
2158     }
2159
2160     if($action eq 'delete') {
2161         $success = $U->simplereq('open-ils.actor',
2162             'open-ils.actor.container.full_delete', $e->authtoken, 'biblio', $list_id);
2163         if ($success) {
2164             # We check to see if we're deleting the user's default list.
2165             $self->_load_user_with_prefs;
2166             my $settings_map = $self->ctx->{user_setting_map};
2167             if ($$settings_map{'opac.default_list'} == $list_id) {
2168                 # We unset the user's opac.default_list setting.
2169                 $success = $U->simplereq(
2170                     'open-ils.actor',
2171                     'open-ils.actor.patron.settings.update',
2172                     $e->authtoken,
2173                     $e->requestor->id,
2174                     { 'opac.default_list' => 0 }
2175                 );
2176             }
2177         }
2178     } elsif($action eq 'show') {
2179         unless($U->is_true($list->pub)) {
2180             $list->pub('t');
2181             $success = $U->simplereq('open-ils.actor',
2182                 'open-ils.actor.container.update', $e->authtoken, 'biblio', $list);
2183         }
2184
2185     } elsif($action eq 'hide') {
2186         if($U->is_true($list->pub)) {
2187             $list->pub('f');
2188             $success = $U->simplereq('open-ils.actor',
2189                 'open-ils.actor.container.update', $e->authtoken, 'biblio', $list);
2190         }
2191
2192     } elsif($action eq 'rename') {
2193         if($name) {
2194             $list->name($name);
2195             $success = $U->simplereq('open-ils.actor',
2196                 'open-ils.actor.container.update', $e->authtoken, 'biblio', $list);
2197         }
2198
2199     } elsif($action eq 'add_rec') {
2200         foreach my $add_rec (@add_rec) {
2201             my $item = Fieldmapper::container::biblio_record_entry_bucket_item->new;
2202             $item->bucket($list_id);
2203             $item->target_biblio_record_entry($add_rec);
2204             $success = $U->simplereq('open-ils.actor',
2205                 'open-ils.actor.container.item.create', $e->authtoken, 'biblio', $item);
2206             last unless $success;
2207         }
2208         # Redirect back where we came from if we have an anchor parameter:
2209         if ( my $anchor = $cgi->param('anchor') && !$self->ctx->{is_staff}) {
2210             $url = $self->ctx->{referer};
2211             $url =~ s/#.*|$/#$anchor/;
2212         } elsif ($cgi->param('where_from')) {
2213             # Or, if we have a "where_from" parameter.
2214             $url = $cgi->param('where_from');
2215         }
2216     } elsif ($action eq 'del_item') {
2217         foreach (@selected_item) {
2218             $success = $U->simplereq(
2219                 'open-ils.actor',
2220                 'open-ils.actor.container.item.delete', $e->authtoken, 'biblio', $_
2221             );
2222             last unless $success;
2223         }
2224     } elsif ($action eq 'save_notes') {
2225         $success = $self->update_bookbag_item_notes;
2226         $url .= "&bbid=" . uri_escape_utf8($cgi->param("bbid")) if $cgi->param("bbid");
2227     } elsif ($action eq 'make_default') {
2228         $success = $U->simplereq(
2229             'open-ils.actor',
2230             'open-ils.actor.patron.settings.update',
2231             $e->authtoken,
2232             $list->owner,
2233             { 'opac.default_list' => $list_id }
2234         );
2235     } elsif ($action eq 'remove_default') {
2236         $success = $U->simplereq(
2237             'open-ils.actor',
2238             'open-ils.actor.patron.settings.update',
2239             $e->authtoken,
2240             $list->owner,
2241             { 'opac.default_list' => 0 }
2242         );
2243     }
2244
2245     return $self->generic_redirect($url) if $success;
2246
2247     $self->ctx->{where_from} = $cgi->param('where_from');
2248     $self->ctx->{bucket_action} = $action;
2249     $self->ctx->{bucket_action_failed} = 1;
2250     return Apache2::Const::OK;
2251 }
2252
2253 sub update_bookbag_item_notes {
2254     my ($self) = @_;
2255     my $e = $self->editor;
2256
2257     my @note_keys = grep /^note-\d+/, keys(%{$self->cgi->Vars});
2258     my @item_keys = grep /^item-\d+/, keys(%{$self->cgi->Vars});
2259
2260     # We're going to leverage an API call that's already been written to check
2261     # permissions appropriately.
2262
2263     my $a = create OpenSRF::AppSession("open-ils.actor");
2264     my $method = "open-ils.actor.container.item_note.cud";
2265
2266     for my $note_key (@note_keys) {
2267         my $note;
2268
2269         my $id = ($note_key =~ /(\d+)/)[0];
2270
2271         if (!($note =
2272             $e->retrieve_container_biblio_record_entry_bucket_item_note($id))) {
2273             my $event = $e->die_event;
2274             $self->apache->log->warn(
2275                 "error retrieving cbrebin id $id, got event " .
2276                 $event->{textcode}
2277             );
2278             $a->kill_me;
2279             $self->ctx->{bucket_action_event} = $event;
2280             return;
2281         }
2282
2283         if (length($self->cgi->param($note_key))) {
2284             $note->ischanged(1);
2285             $note->note($self->cgi->param($note_key));
2286         } else {
2287             $note->isdeleted(1);
2288         }
2289
2290         my $r = $a->request($method, $e->authtoken, "biblio", $note)->gather(1);
2291
2292         if (defined $U->event_code($r)) {
2293             $self->apache->log->warn(
2294                 "attempt to modify cbrebin " . $note->id .
2295                 " returned event " .  $r->{textcode}
2296             );
2297             $e->rollback;
2298             $a->kill_me;
2299             $self->ctx->{bucket_action_event} = $r;
2300             return;
2301         }
2302     }
2303
2304     for my $item_key (@item_keys) {
2305         my $id = int(($item_key =~ /(\d+)/)[0]);
2306         my $text = $self->cgi->param($item_key);
2307
2308         chomp $text;
2309         next unless length $text;
2310
2311         my $note = new Fieldmapper::container::biblio_record_entry_bucket_item_note;
2312         $note->isnew(1);
2313         $note->item($id);
2314         $note->note($text);
2315
2316         my $r = $a->request($method, $e->authtoken, "biblio", $note)->gather(1);
2317
2318         if (defined $U->event_code($r)) {
2319             $self->apache->log->warn(
2320                 "attempt to create cbrebin for item " . $note->item .
2321                 " returned event " .  $r->{textcode}
2322             );
2323             $e->rollback;
2324             $a->kill_me;
2325             $self->ctx->{bucket_action_event} = $r;
2326             return;
2327         }
2328     }
2329
2330     $a->kill_me;
2331     return 1;   # success
2332 }
2333
2334 sub load_myopac_bookbag_print {
2335     my ($self) = @_;
2336
2337     my $id = int($self->cgi->param("list"));
2338
2339     my ($sorter, $modifier) = $self->_get_bookbag_sort_params("sort");
2340
2341     my $item_search =
2342         $self->_prepare_bookbag_container_query($id, $sorter, $modifier);
2343
2344     my $bbag;
2345
2346     # Get the bookbag object itself, assuming we're allowed to.
2347     if ($self->editor->allowed("VIEW_CONTAINER")) {
2348
2349         $bbag = $self->editor->retrieve_container_biblio_record_entry_bucket($id) or return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
2350     } else {
2351         my $bookbags = $self->editor->search_container_biblio_record_entry_bucket(
2352             {
2353                 "id" => $id,
2354                 "-or" => {
2355                     "owner" => $self->editor->requestor->id,
2356                     "pub" => "t"
2357                 }
2358             }
2359         ) or return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
2360
2361         $bbag = pop @$bookbags;
2362     }
2363
2364     # If we have a bookbag we're allowed to look at, issue the A/T event
2365     # to get CSV, passing as a user param that search query we built before.
2366     if ($bbag) {
2367         $self->ctx->{csv} = $U->fire_object_event(
2368             undef, "container.biblio_record_entry_bucket.csv",
2369             $bbag, $self->editor->requestor->home_ou,
2370             undef, {"item_search" => $item_search}
2371         );
2372     }
2373
2374     # Create a reasonable filename and set the content disposition to
2375     # provoke browser download dialogs.
2376     (my $filename = $bbag->id . $bbag->name) =~ s/[^a-z0-9_ -]//gi;
2377
2378     return $self->set_file_download_headers("$filename.csv");
2379 }
2380
2381 sub load_myopac_circ_history_export {
2382     my $self = shift;
2383     my $e = $self->editor;
2384     my $filename = $self->cgi->param('filename') || 'circ_history.csv';
2385
2386     my $ids = $e->json_query({
2387         select => {
2388             au => [{
2389                 column => 'id',
2390                 transform => 'action.usr_visible_circs',
2391                 result_field => 'id'
2392             }]
2393         },
2394         from => 'au',
2395         where => {id => $e->requestor->id}
2396     });
2397
2398     $self->ctx->{csv} = $U->fire_object_event(
2399         undef,
2400         'circ.format.history.csv',
2401         $e->search_action_circulation({id => [map {$_->{id}} @$ids]}, {substream =>1}),
2402         $self->editor->requestor->home_ou
2403     );
2404
2405     return $self->set_file_download_headers($filename);
2406 }
2407
2408 sub load_password_reset {
2409     my $self = shift;
2410     my $cgi = $self->cgi;
2411     my $ctx = $self->ctx;
2412     my $barcode = $cgi->param('barcode');
2413     my $username = $cgi->param('username');
2414     my $email = $cgi->param('email');
2415     my $pwd1 = $cgi->param('pwd1');
2416     my $pwd2 = $cgi->param('pwd2');
2417     my $uuid = $ctx->{page_args}->[0];
2418
2419     if ($uuid) {
2420
2421         $logger->info("patron password reset with uuid $uuid");
2422
2423         if ($pwd1 and $pwd2) {
2424
2425             if ($pwd1 eq $pwd2) {
2426
2427                 my $response = $U->simplereq(
2428                     'open-ils.actor',
2429                     'open-ils.actor.patron.password_reset.commit',
2430                     $uuid, $pwd1);
2431
2432                 $logger->info("patron password reset response " . Dumper($response));
2433
2434                 if ($U->event_code($response)) { # non-success event
2435
2436                     my $code = $response->{textcode};
2437
2438                     if ($code eq 'PATRON_NOT_AN_ACTIVE_PASSWORD_RESET_REQUEST') {
2439                         $ctx->{pwreset} = {style => 'error', status => 'NOT_ACTIVE'};
2440                     }
2441
2442                     if ($code eq 'PATRON_PASSWORD_WAS_NOT_STRONG') {
2443                         $ctx->{pwreset} = {style => 'error', status => 'NOT_STRONG'};
2444                     }
2445
2446                 } else { # success
2447
2448                     $ctx->{pwreset} = {style => 'success', status => 'SUCCESS'};
2449                 }
2450
2451             } else { # passwords not equal
2452
2453                 $ctx->{pwreset} = {style => 'error', status => 'NO_MATCH'};
2454             }
2455
2456         } else { # 2 password values needed
2457
2458             $ctx->{pwreset} = {status => 'TWO_PASSWORDS'};
2459         }
2460
2461     } elsif ($barcode or $username) {
2462
2463         my @params = $barcode ? ('barcode', $barcode) : ('username', $username);
2464         push(@params, $email) if $email;
2465
2466         $U->simplereq(
2467             'open-ils.actor',
2468             'open-ils.actor.patron.password_reset.request', @params);
2469
2470         $ctx->{pwreset} = {status => 'REQUEST_SUCCESS'};
2471     }
2472
2473     $logger->info("patron password reset resulted in " . Dumper($ctx->{pwreset}));
2474     return Apache2::Const::OK;
2475 }
2476
2477 1;