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 Data::Dumper;
  11 $Data::Dumper::Indent = 0;
  12 use DateTime;
  13 my $U = 'OpenILS::Application::AppUtils';
  14
  15 sub prepare_extended_user_info {
  16     my $self = shift;
  17     my @extra_flesh = @_;
  18
  19     $self->ctx->{user} = $self->editor->retrieve_actor_user([
  20         $self->ctx->{user}->id,
  21         {
  22             flesh => 1,
  23             flesh_fields => {
  24                 au => [qw/card home_ou addresses ident_type billing_address/, @extra_flesh]
  25                 # ...
  26             }
  27         }
  28     ]) or return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
  29
  30     return;
  31 }
  32
  33 # Given an event returned by a failed attempt to create a hold, do we have
  34 # permission to override?  XXX Should the permission check be scoped to a
  35 # given org_unit context?
  36 sub test_could_override {
  37     my ($self) = @_;
  38     my $event = $self->ctx->{"hold_failed_event"};
  39
  40     return 0 unless $event;
  41     return 1 if $self->editor->allowed($event . ".override");
  42     return 1 if $event->{"fail_part"} and
  43         $self->editor->allowed($event->{"fail_part"} . ".override");
  44     return 0;
  45 }
  46
  47 # Find out whether we care that local copies are available
  48 sub local_avail_concern {
  49     my ($self, $allowed, $hold_target, $hold_type, $pickup_lib) = @_;
  50
  51     my $would_block = $self->ctx->{get_org_setting}->
  52         ($pickup_lib, "circ.holds.hold_has_copy_at.block");
  53     my $would_alert = (
  54         $self->ctx->{get_org_setting}->
  55             ($pickup_lib, "circ.holds.hold_has_copy_at.alert") and
  56                 not $self->cgi->param("override")
  57     ) unless $would_block;
  58
  59     if ($allowed->{"success"} and ($would_block or $would_alert)) {
  60         my $args = {
  61             "hold_target" => $hold_target,
  62             "hold_type" => $hold_type,
  63             "org_unit" => $pickup_lib
  64         };
  65         my $local_avail = $U->simplereq(
  66             "open-ils.circ",
  67             "open-ils.circ.hold.has_copy_at", $self->editor->authtoken, $args
  68         );
  69         $logger->info(
  70             "copy availability information for " . Dumper($args) .
  71             " is " . Dumper($local_avail)
  72         );
  73         if (%$local_avail) { # if hash not empty
  74             $self->ctx->{hold_copy_available} = $local_avail;
  75             return ($would_block, $would_alert);
  76         }
  77     }
  78
  79     return (0, 0);
  80 }
  81
  82 # context additions:
  83 #   user : au object, fleshed
  84 sub load_myopac_prefs {
  85     my $self = shift;
  86     return $self->prepare_extended_user_info || Apache2::Const::OK;
  87 }
  88
  89 sub load_myopac_prefs_notify {
  90     my $self = shift;
  91     my $e = $self->editor;
  92
  93     my $user_prefs = $self->fetch_optin_prefs;
  94     $user_prefs = $self->update_optin_prefs($user_prefs)
  95         if $self->cgi->request_method eq 'POST';
  96
  97     $self->ctx->{opt_in_settings} = $user_prefs;
  98
  99     return Apache2::Const::OK;
 100 }
 101
 102 sub fetch_optin_prefs {
 103     my $self = shift;
 104     my $e = $self->editor;
 105
 106     # fetch all of the opt-in settings the user has access to
 107     # XXX: user's should in theory have options to opt-in to notices
 108     # for remote locations, but that opens the door for a large
 109     # set of generally un-used opt-ins.. needs discussion
 110     my $opt_ins =  $U->simplereq(
 111         'open-ils.actor',
 112         'open-ils.actor.event_def.opt_in.settings.atomic',
 113         $e->authtoken, $e->requestor->home_ou);
 114
 115     # fetch user setting values for each of the opt-in settings
 116     my $user_set = $U->simplereq(
 117         'open-ils.actor',
 118         'open-ils.actor.patron.settings.retrieve',
 119         $e->authtoken,
 120         $e->requestor->id,
 121         [map {$_->name} @$opt_ins]
 122     );
 123
 124     return [map { {cust => $_, value => $user_set->{$_->name} } } @$opt_ins];
 125 }
 126
 127 sub update_optin_prefs {
 128     my $self = shift;
 129     my $user_prefs = shift;
 130     my $e = $self->editor;
 131     my @settings = $self->cgi->param('setting');
 132     my %newsets;
 133
 134     # apply now-true settings
 135     for my $applied (@settings) {
 136         # see if setting is already applied to this user
 137         next if grep { $_->{cust}->name eq $applied and $_->{value} } @$user_prefs;
 138         $newsets{$applied} = OpenSRF::Utils::JSON->true;
 139     }
 140
 141     # remove now-false settings
 142     for my $pref (grep { $_->{value} } @$user_prefs) {
 143         $newsets{$pref->{cust}->name} = undef
 144             unless grep { $_ eq $pref->{cust}->name } @settings;
 145     }
 146
 147     $U->simplereq(
 148         'open-ils.actor',
 149         'open-ils.actor.patron.settings.update',
 150         $e->authtoken, $e->requestor->id, \%newsets);
 151
 152     # update the local prefs to match reality
 153     for my $pref (@$user_prefs) {
 154         $pref->{value} = $newsets{$pref->{cust}->name}
 155             if exists $newsets{$pref->{cust}->name};
 156     }
 157
 158     return $user_prefs;
 159 }
 160
 161 sub _load_user_with_prefs {
 162     my $self = shift;
 163     my $stat = $self->prepare_extended_user_info('settings');
 164     return $stat if $stat; # not-OK
 165
 166     $self->ctx->{user_setting_map} = {
 167         map { $_->name => OpenSRF::Utils::JSON->JSON2perl($_->value) }
 168             @{$self->ctx->{user}->settings}
 169     };
 170
 171     return undef;
 172 }
 173
 174 sub load_myopac_prefs_settings {
 175     my $self = shift;
 176
 177     my $stat = $self->_load_user_with_prefs;
 178     return $stat if $stat;
 179
 180     return Apache2::Const::OK
 181         unless $self->cgi->request_method eq 'POST';
 182
 183     # some setting values from the form don't match the
 184     # required value/format for the db, so they have to be
 185     # individually translated.
 186
 187     my %settings;
 188     my $set_map = $self->ctx->{user_setting_map};
 189
 190     my $key = 'opac.hits_per_page';
 191     my $val = $self->cgi->param($key);
 192     $settings{$key}= $val unless $$set_map{$key} eq $val;
 193
 194     my $now = DateTime->now->strftime('%F');
 195     for $key (qw/history.circ.retention_start history.hold.retention_start/) {
 196         $val = $self->cgi->param($key);
 197         if($val and $val eq 'on') {
 198             # Set the start time to 'now' unless a start time already exists for the user
 199             $settings{$key} = $now unless $$set_map{$key};
 200         } else {
 201             # clear the start time if one previously existed for the user
 202             $settings{$key} = undef if $$set_map{$key};
 203         }
 204     }
 205
 206     # Send the modified settings off to be saved
 207     $U->simplereq(
 208         'open-ils.actor',
 209         'open-ils.actor.patron.settings.update',
 210         $self->editor->authtoken, undef, \%settings);
 211
 212     # re-fetch user prefs
 213     $self->ctx->{updated_user_settings} = \%settings;
 214     return $self->_load_user_with_prefs || Apache2::Const::OK;
 215 }
 216
 217 sub fetch_user_holds {
 218     my $self = shift;
 219     my $hold_ids = shift;
 220     my $ids_only = shift;
 221     my $flesh = shift;
 222     my $available = shift;
 223     my $limit = shift;
 224     my $offset = shift;
 225
 226     my $e = $self->editor;
 227
 228     my $circ = OpenSRF::AppSession->create('open-ils.circ');
 229
 230     if(!$hold_ids) {
 231
 232         $hold_ids = $circ->request(
 233             'open-ils.circ.holds.id_list.retrieve.authoritative',
 234             $e->authtoken,
 235             $e->requestor->id
 236         )->gather(1);
 237
 238         $hold_ids = [ grep { defined $_ } @$hold_ids[$offset..($offset + $limit - 1)] ] if $limit or $offset;
 239     }
 240
 241
 242     return $hold_ids if $ids_only or @$hold_ids == 0;
 243
 244     my $args = {
 245         suppress_notices => 1,
 246         suppress_transits => 1,
 247         suppress_mvr => 1,
 248         suppress_patron_details => 1,
 249         include_bre => $flesh ? 1 : 0
 250     };
 251
 252     # ----------------------------------------------------------------
 253     # Collect holds in batches of $batch_size for faster retrieval
 254
 255     my $batch_size = 8;
 256     my $batch_idx = 0;
 257     my $mk_req_batch = sub {
 258         my @ses;
 259         my $top_idx = $batch_idx + $batch_size;
 260         while($batch_idx < $top_idx) {
 261             my $hold_id = $hold_ids->[$batch_idx++];
 262             last unless $hold_id;
 263             my $ses = OpenSRF::AppSession->create('open-ils.circ');
 264             my $req = $ses->request(
 265                 'open-ils.circ.hold.details.retrieve',
 266                 $e->authtoken, $hold_id, $args);
 267             push(@ses, {ses => $ses, req => $req});
 268         }
 269         return @ses;
 270     };
 271
 272     my $first = 1;
 273     my(@collected, @holds, @ses);
 274
 275     while(1) {
 276         @ses = $mk_req_batch->() if $first;
 277         last if $first and not @ses;
 278
 279         if(@collected) {
 280             # If desired by the caller, filter any holds that are not available.
 281             if ($available) {
 282                 @collected = grep { $_->{hold}->{status} == 4 } @collected;
 283             }
 284             while(my $blob = pop(@collected)) {
 285                 $blob->{marc_xml} = XML::LibXML->new->parse_string($blob->{hold}->{bre}->marc) if $flesh;
 286                 push(@holds, $blob);
 287             }
 288         }
 289
 290         for my $req_data (@ses) {
 291             push(@collected, {hold => $req_data->{req}->gather(1)});
 292             $req_data->{ses}->kill_me;
 293         }
 294
 295         @ses = $mk_req_batch->();
 296         last unless @collected or @ses;
 297         $first = 0;
 298     }
 299
 300     # put the holds back into the original server sort order
 301     my @sorted;
 302     for my $id (@$hold_ids) {
 303         push @sorted, grep { $_->{hold}->{hold}->id == $id } @holds;
 304     }
 305
 306     return \@sorted;
 307 }
 308
 309 sub handle_hold_update {
 310     my $self = shift;
 311     my $action = shift;
 312     my $e = $self->editor;
 313     my $url;
 314
 315     my @hold_ids = $self->cgi->param('hold_id'); # for non-_all actions
 316     @hold_ids = @{$self->fetch_user_holds(undef, 1)} if $action =~ /_all/;
 317
 318     my $circ = OpenSRF::AppSession->create('open-ils.circ');
 319
 320     if($action =~ /cancel/) {
 321
 322         for my $hold_id (@hold_ids) {
 323             my $resp = $circ->request(
 324                 'open-ils.circ.hold.cancel', $e->authtoken, $hold_id, 6 )->gather(1); # 6 == patron-cancelled-via-opac
 325         }
 326
 327     } elsif ($action =~ /activate|suspend/) {
 328
 329         my $vlist = [];
 330         for my $hold_id (@hold_ids) {
 331             my $vals = {id => $hold_id};
 332
 333             if($action =~ /activate/) {
 334                 $vals->{frozen} = 'f';
 335                 $vals->{thaw_date} = undef;
 336
 337             } elsif($action =~ /suspend/) {
 338                 $vals->{frozen} = 't';
 339                 # $vals->{thaw_date} = TODO;
 340             }
 341             push(@$vlist, $vals);
 342         }
 343
 344         $circ->request('open-ils.circ.hold.update.batch.atomic', $e->authtoken, undef, $vlist)->gather(1);
 345     } elsif ($action eq 'edit') {
 346
 347         my @vals = map {
 348             my $val = {"id" => $_};
 349             $val->{"frozen"} = $self->cgi->param("frozen");
 350             $val->{"pickup_lib"} = $self->cgi->param("pickup_lib");
 351
 352             for my $field (qw/expire_time thaw_date/) {
 353                 # XXX TODO make this support other date formats, not just
 354                 # MM/DD/YYYY.
 355                 next unless $self->cgi->param($field) =~
 356                     m:^(\d{2})/(\d{2})/(\d{4})$:;
 357                 $val->{$field} = "$3-$1-$2";
 358             }
 359             $val;
 360         } @hold_ids;
 361
 362         $circ->request(
 363             'open-ils.circ.hold.update.batch.atomic',
 364             $e->authtoken, undef, \@vals
 365         )->gather(1);   # LFW XXX test for failure
 366         $url = 'https://' . $self->apache->hostname . $self->ctx->{opac_root} . '/myopac/holds';
 367     }
 368
 369     $circ->kill_me;
 370     return defined($url) ? $self->generic_redirect($url) : undef;
 371 }
 372
 373 sub load_myopac_holds {
 374     my $self = shift;
 375     my $e = $self->editor;
 376     my $ctx = $self->ctx;
 377
 378
 379     my $limit = $self->cgi->param('limit') || 0;
 380     my $offset = $self->cgi->param('offset') || 0;
 381     my $action = $self->cgi->param('action') || '';
 382     my $available = int($self->cgi->param('available') || 0);
 383
 384     my $hold_handle_result;
 385     $hold_handle_result = $self->handle_hold_update($action) if $action;
 386
 387     $ctx->{holds} = $self->fetch_user_holds(undef, 0, 1, $available, $limit, $offset);
 388
 389     return defined($hold_handle_result) ? $hold_handle_result : Apache2::Const::OK;
 390 }
 391
 392 sub load_place_hold {
 393     my $self = shift;
 394     my $ctx = $self->ctx;
 395     my $gos = $ctx->{get_org_setting};
 396     my $e = $self->editor;
 397     my $cgi = $self->cgi;
 398     $self->ctx->{page} = 'place_hold';
 399
 400     $ctx->{hold_target} = $cgi->param('hold_target');
 401     $ctx->{hold_type} = $cgi->param('hold_type');
 402
 403     # Although in the context of staff placing holds for other users, this
 404     # does not yield the appropriate pickup lib, that situation is addressed
 405     # in the client with javascript when possible.
 406     $ctx->{default_pickup_lib} = $e->requestor->home_ou;
 407
 408     my $request_lib = $e->requestor->ws_ou || $e->requestor->home_ou;
 409
 410     # XXX check for failure of the retrieve_* methods called below, and
 411     # possibly replace all the if,elsif with a dispatch table (meh, elegance)
 412
 413     my $target_field;
 414     if ($ctx->{hold_type} eq 'T') {
 415         $target_field = "titleid";
 416         $ctx->{record} = $e->retrieve_biblio_record_entry($ctx->{hold_target});
 417     } elsif ($ctx->{hold_type} eq 'V') {
 418         $target_field = "volume_id";
 419         my $vol = $e->retrieve_asset_call_number([
 420             $ctx->{hold_target}, {
 421                 "flesh" => 1,
 422                 "flesh_fields" => {"acn" => ["record"]}
 423             }
 424         ]);
 425         $ctx->{record} = $vol->record;
 426     } elsif ($ctx->{hold_type} eq 'C') {
 427         $target_field = "copy_id";
 428         my $copy = $e->retrieve_asset_copy([
 429             $ctx->{hold_target}, {
 430                 "flesh" => 2,
 431                 "flesh_fields" => {
 432                     "acn" => ["record"],
 433                     "acp" => ["call_number"]
 434                 }
 435             }
 436         ]);
 437         $ctx->{record} = $copy->call_number->record;
 438     } elsif ($ctx->{hold_type} eq 'I') {
 439         $target_field = "issuanceid";
 440         my $iss = $e->retrieve_serial_issuance([
 441             $ctx->{hold_target}, {
 442                 "flesh" => 2,
 443                 "flesh_fields" => {
 444                     "siss" => ["subscription"], "ssub" => ["record_entry"]
 445                 }
 446             }
 447         ]);
 448         $ctx->{record} = $iss->subscription->record_entry;
 449     }
 450     # ...
 451
 452     $ctx->{marc_xml} = XML::LibXML->new->parse_string($ctx->{record}->marc);
 453
 454     if (my $pickup_lib = $cgi->param('pickup_lib')) {
 455         my $requestor = $e->requestor->id;
 456         my $usr;
 457
 458         if ((not $ctx->{"is_staff"}) or
 459             ($cgi->param("hold_usr_is_requestor"))) {
 460             $usr = $requestor;
 461         } else {
 462             my $actor = create OpenSRF::AppSession("open-ils.actor");
 463             $usr = $actor->request(
 464                 "open-ils.actor.user.retrieve_id_by_barcode_or_username",
 465                 $e->authtoken, $cgi->param("hold_usr")
 466             )->gather(1);
 467
 468             if (defined $U->event_code($usr)) {
 469                 $ctx->{hold_failed} = 1;
 470                 $ctx->{hold_failed_event} = $usr;
 471             }
 472             # XXX Does $actor need to be explicity disconnected/destroyed?
 473         }
 474
 475         my $args = {
 476             patronid => $usr,
 477             $target_field => $ctx->{"hold_target"},
 478             pickup_lib => $pickup_lib,
 479             hold_type => $ctx->{"hold_type"},
 480             depth => 0, # XXX
 481         };
 482
 483         my $allowed = $U->simplereq(
 484             'open-ils.circ',
 485             'open-ils.circ.title_hold.is_possible',
 486             $e->authtoken, $args
 487         );
 488
 489         $logger->info('hold permit result ' . OpenSRF::Utils::JSON->perl2JSON($allowed));
 490
 491         my ($local_block, $local_alert) = $self->local_avail_concern(
 492             $allowed, $args->{$target_field}, $args->{hold_type}, $pickup_lib
 493         );
 494
 495         # Give the original CGI params back to the user in case they
 496         # want to try to override something.
 497         $ctx->{orig_params} = $cgi->Vars;
 498
 499         if ($local_block) {
 500             $ctx->{hold_failed} = 1;
 501             $ctx->{hold_local_block} = 1;
 502         } elsif ($local_alert) {
 503             $ctx->{hold_failed} = 1;
 504             $ctx->{hold_local_alert} = 1;
 505         } elsif ($allowed->{success}) {
 506             my $hold = Fieldmapper::action::hold_request->new;
 507
 508             $hold->pickup_lib($pickup_lib);
 509             $hold->requestor($requestor);
 510             $hold->usr($usr);
 511             $hold->target($ctx->{hold_target});
 512             $hold->hold_type($ctx->{hold_type});
 513             # frozen, expired, etc..
 514
 515             my $method =  "open-ils.circ.holds.create";
 516             $method .= ".override" if $cgi->param("override");
 517
 518             my $stat = $U->simplereq(
 519                 "open-ils.circ", $method, $e->authtoken, $hold
 520             );
 521
 522             # The following did not cover all the possible return values of
 523             # open-ils.circ.holds.create
 524             #if($stat and $stat > 0) {
 525             if ($stat and (not ref $stat) and $stat > 0) {
 526                 # if successful, return the user to the requesting page
 527                 $self->apache->log->info(
 528                     "Redirecting back to " . $cgi->param('redirect_to')
 529                 );
 530                 return $self->generic_redirect;
 531
 532             } else {
 533                 $ctx->{hold_failed} = 1;
 534
 535                 delete $ctx->{orig_params}{submit};
 536
 537                 if (ref $stat eq 'ARRAY') {
 538                     $ctx->{hold_failed_event} = shift @$stat;
 539                 } elsif (defined $U->event_code($stat)) {
 540                     $ctx->{hold_failed_event} = $stat;
 541                 } else {
 542                     $self->apache->log->info(
 543                         "attempt to create hold returned $stat"
 544                     );
 545                 }
 546
 547                 $ctx->{could_override} = $self->test_could_override;
 548             }
 549         } else { # hold *check* failed
 550             $ctx->{hold_failed} = 1; # XXX process the events, etc
 551             $ctx->{hold_failed_event} = $allowed->{last_event};
 552         }
 553
 554         # hold permit failed
 555     }
 556
 557     return Apache2::Const::OK;
 558 }
 559
 560
 561 sub fetch_user_circs {
 562     my $self = shift;
 563     my $flesh = shift; # flesh bib data, etc.
 564     my $circ_ids = shift;
 565     my $limit = shift;
 566     my $offset = shift;
 567
 568     my $e = $self->editor;
 569
 570     my @circ_ids;
 571
 572     if($circ_ids) {
 573         @circ_ids = @$circ_ids;
 574
 575     } else {
 576
 577         my $circ_data = $U->simplereq(
 578             'open-ils.actor',
 579             'open-ils.actor.user.checked_out',
 580             $e->authtoken,
 581             $e->requestor->id
 582         );
 583
 584         @circ_ids =  ( @{$circ_data->{overdue}}, @{$circ_data->{out}} );
 585
 586         if($limit or $offset) {
 587             @circ_ids = grep { defined $_ } @circ_ids[0..($offset + $limit - 1)];
 588         }
 589     }
 590
 591     return [] unless @circ_ids;
 592
 593     my $cstore = OpenSRF::AppSession->create('open-ils.cstore');
 594
 595     my $qflesh = {
 596         flesh => 3,
 597         flesh_fields => {
 598             circ => ['target_copy'],
 599             acp => ['call_number'],
 600             acn => ['record']
 601         }
 602     };
 603
 604     $e->xact_begin;
 605     my $circs = $e->search_action_circulation(
 606         [{id => \@circ_ids}, ($flesh) ? $qflesh : {}], {substream => 1});
 607
 608     my @circs;
 609     for my $circ (@$circs) {
 610         push(@circs, {
 611             circ => $circ,
 612             marc_xml => ($flesh and $circ->target_copy->call_number->id != -1) ?
 613                 XML::LibXML->new->parse_string($circ->target_copy->call_number->record->marc) :
 614                 undef  # pre-cat copy, use the dummy title/author instead
 615         });
 616     }
 617     $e->xact_rollback;
 618
 619     # make sure the final list is in the correct order
 620     my @sorted_circs;
 621     for my $id (@circ_ids) {
 622         push(
 623             @sorted_circs,
 624             (grep { $_->{circ}->id == $id } @circs)
 625         );
 626     }
 627
 628     return \@sorted_circs;
 629 }
 630
 631
 632 sub handle_circ_renew {
 633     my $self = shift;
 634     my $action = shift;
 635     my $ctx = $self->ctx;
 636
 637     my @renew_ids = $self->cgi->param('circ');
 638
 639     my $circs = $self->fetch_user_circs(0, ($action eq 'renew') ? [@renew_ids] : undef);
 640
 641     # TODO: fire off renewal calls in batches to speed things up
 642     my @responses;
 643     for my $circ (@$circs) {
 644
 645         my $evt = $U->simplereq(
 646             'open-ils.circ',
 647             'open-ils.circ.renew',
 648             $self->editor->authtoken,
 649             {
 650                 patron_id => $self->editor->requestor->id,
 651                 copy_id => $circ->{circ}->target_copy,
 652                 opac_renewal => 1
 653             }
 654         );
 655
 656         # TODO return these, then insert them into the circ data
 657         # blob that is shoved into the template for each circ
 658         # so the template won't have to match them
 659         push(@responses, {copy => $circ->{circ}->target_copy, evt => $evt});
 660     }
 661
 662     return @responses;
 663 }
 664
 665
 666 sub load_myopac_circs {
 667     my $self = shift;
 668     my $e = $self->editor;
 669     my $ctx = $self->ctx;
 670
 671     $ctx->{circs} = [];
 672     my $limit = $self->cgi->param('limit') || 0; # 0 == unlimited
 673     my $offset = $self->cgi->param('offset') || 0;
 674     my $action = $self->cgi->param('action') || '';
 675
 676     # perform the renewal first if necessary
 677     my @results = $self->handle_circ_renew($action) if $action =~ /renew/;
 678
 679     $ctx->{circs} = $self->fetch_user_circs(1, undef, $limit, $offset);
 680
 681     my $success_renewals = 0;
 682     my $failed_renewals = 0;
 683     for my $data (@{$ctx->{circs}}) {
 684         my ($resp) = grep { $_->{copy} == $data->{circ}->target_copy->id } @results;
 685
 686         if($resp) {
 687             my $evt = ref($resp->{evt}) eq 'ARRAY' ? $resp->{evt}->[0] : $resp->{evt};
 688             $data->{renewal_response} = $evt;
 689             $success_renewals++ if $evt->{textcode} eq 'SUCCESS';
 690             $failed_renewals++ if $evt->{textcode} ne 'SUCCESS';
 691         }
 692     }
 693
 694     $ctx->{success_renewals} = $success_renewals;
 695     $ctx->{failed_renewals} = $failed_renewals;
 696
 697     return Apache2::Const::OK;
 698 }
 699
 700 sub load_myopac_circ_history {
 701     my $self = shift;
 702     my $e = $self->editor;
 703     my $ctx = $self->ctx;
 704     my $limit = $self->cgi->param('limit') || 15;
 705     my $offset = $self->cgi->param('offset') || 0;
 706
 707     $ctx->{circ_history_limit} = $limit;
 708     $ctx->{circ_history_offset} = $offset;
 709
 710     my $circs = $e->json_query({
 711         from => ['action.usr_visible_circs', $e->requestor->id],
 712         #limit => $limit || 25,
 713         #offset => $offset || 0,
 714     });
 715
 716     # XXX: order-by in the json_query above appears to do nothing, so in-query
 717     # paging is not reallly an option.  do the sorting/paging here
 718
 719     # sort newest to oldest
 720     $circs = [ sort { $b->{xact_start} cmp $a->{xact_start} } @$circs ];
 721     my @ids = map { $_->{id} } @$circs;
 722
 723     # find the selected page and trim cruft
 724     @ids = @ids[$offset..($offset + $limit - 1)] if $limit;
 725     @ids = grep { defined $_ } @ids;
 726
 727     $ctx->{circs} = $self->fetch_user_circs(1, \@ids);
 728     #$ctx->{circs} = $self->fetch_user_circs(1, [map { $_->{id} } @$circs], $limit, $offset);
 729
 730     return Apache2::Const::OK;
 731 }
 732
 733 # TODO: action.usr_visible_holds does not return cancelled holds.  Should it?
 734 sub load_myopac_hold_history {
 735     my $self = shift;
 736     my $e = $self->editor;
 737     my $ctx = $self->ctx;
 738     my $limit = $self->cgi->param('limit') || 15;
 739     my $offset = $self->cgi->param('offset') || 0;
 740     $ctx->{hold_history_limit} = $limit;
 741     $ctx->{hold_history_offset} = $offset;
 742
 743
 744     my $holds = $e->json_query({
 745         from => ['action.usr_visible_holds', $e->requestor->id],
 746         limit => $limit || 25,
 747         offset => $offset || 0
 748     });
 749
 750     $ctx->{holds} = $self->fetch_user_holds([map { $_->{id} } @$holds], 0, 1, 0, $limit, $offset);
 751
 752     return Apache2::Const::OK;
 753 }
 754
 755 sub load_myopac_payment_form {
 756     my $self = shift;
 757     my $r;
 758
 759     $r = $self->prepare_fines(undef, undef, [$self->cgi->param('xact')]) and return $r;
 760     $r = $self->prepare_extended_user_info and return $r;
 761
 762     return Apache2::Const::OK;
 763 }
 764
 765 # TODO: add other filter options as params/configs/etc.
 766 sub load_myopac_payments {
 767     my $self = shift;
 768     my $limit = $self->cgi->param('limit') || 20;
 769     my $offset = $self->cgi->param('offset') || 0;
 770     my $e = $self->editor;
 771
 772     $self->ctx->{payment_history_limit} = $limit;
 773     $self->ctx->{payment_history_offset} = $offset;
 774
 775     my $args = {};
 776     $args->{limit} = $limit if $limit;
 777     $args->{offset} = $offset if $offset;
 778
 779     $self->ctx->{payments} = $U->simplereq(
 780         'open-ils.actor',
 781         'open-ils.actor.user.payments.retrieve.atomic',
 782         $e->authtoken, $e->requestor->id, $args);
 783
 784     return Apache2::Const::OK;
 785 }
 786
 787 sub load_myopac_pay {
 788     my $self = shift;
 789     my $r;
 790
 791     $r = $self->prepare_fines(undef, undef, [$self->cgi->param('xact')]) and
 792         return $r;
 793
 794     # balance_owed is computed specifically from the fines we're trying
 795     # to pay in this case.
 796     if ($self->ctx->{fines}->{balance_owed} <= 0) {
 797         $self->apache->log->info(
 798             sprintf("Can't pay non-positive balance. xacts selected: (%s)",
 799                 join(", ", map(int, $self->cgi->param("xact"))))
 800         );
 801         return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
 802     }
 803
 804     my $cc_args = {"where_process" => 1};
 805
 806     $cc_args->{$_} = $self->cgi->param($_) for (qw/
 807         number cvv2 expire_year expire_month billing_first
 808         billing_last billing_address billing_city billing_state
 809         billing_zip
 810     /);
 811
 812     my $args = {
 813         "cc_args" => $cc_args,
 814         "userid" => $self->ctx->{user}->id,
 815         "payment_type" => "credit_card_payment",
 816         "payments" => $self->prepare_fines_for_payment   # should be safe after self->prepare_fines
 817     };
 818
 819     my $resp = $U->simplereq("open-ils.circ", "open-ils.circ.money.payment",
 820         $self->editor->authtoken, $args, $self->ctx->{user}->last_xact_id
 821     );
 822
 823     $self->ctx->{"payment_response"} = $resp;
 824
 825     unless ($resp->{"textcode"}) {
 826         $self->ctx->{printable_receipt} = $U->simplereq(
 827            "open-ils.circ", "open-ils.circ.money.payment_receipt.print",
 828            $self->editor->authtoken, $resp->{payments}
 829         );
 830     }
 831
 832     return Apache2::Const::OK;
 833 }
 834
 835 sub load_myopac_receipt_print {
 836     my $self = shift;
 837
 838     $self->ctx->{printable_receipt} = $U->simplereq(
 839        "open-ils.circ", "open-ils.circ.money.payment_receipt.print",
 840        $self->editor->authtoken, [$self->cgi->param("payment")]
 841     );
 842
 843     return Apache2::Const::OK;
 844 }
 845
 846 sub load_myopac_receipt_email {
 847     my $self = shift;
 848
 849     # The following ML method doesn't actually check whether the user in
 850     # question has an email address, so we do.
 851     if ($self->ctx->{user}->email) {
 852         $self->ctx->{email_receipt_result} = $U->simplereq(
 853            "open-ils.circ", "open-ils.circ.money.payment_receipt.email",
 854            $self->editor->authtoken, [$self->cgi->param("payment")]
 855         );
 856     } else {
 857         $self->ctx->{email_receipt_result} =
 858             new OpenILS::Event("PATRON_NO_EMAIL_ADDRESS");
 859     }
 860
 861     return Apache2::Const::OK;
 862 }
 863
 864 sub prepare_fines {
 865     my ($self, $limit, $offset, $id_list) = @_;
 866
 867     # XXX TODO: check for failure after various network calls
 868
 869     # It may be unclear, but this result structure lumps circulation and
 870     # reservation fines together, and keeps grocery fines separate.
 871     $self->ctx->{"fines"} = {
 872         "circulation" => [],
 873         "grocery" => [],
 874         "total_paid" => 0,
 875         "total_owed" => 0,
 876         "balance_owed" => 0
 877     };
 878
 879     my $cstore = OpenSRF::AppSession->create('open-ils.cstore');
 880
 881     # TODO: This should really be a ML call, but the existing calls
 882     # return an excessive amount of data and don't offer streaming
 883
 884     my %paging = ($limit or $offset) ? (limit => $limit, offset => $offset) : ();
 885
 886     my $req = $cstore->request(
 887         'open-ils.cstore.direct.money.open_billable_transaction_summary.search',
 888         {
 889             usr => $self->editor->requestor->id,
 890             balance_owed => {'!=' => 0},
 891             ($id_list && @$id_list ? ("id" => $id_list) : ()),
 892         },
 893         {
 894             flesh => 4,
 895             flesh_fields => {
 896                 mobts => [qw/grocery circulation reservation/],
 897                 bresv => ['target_resource_type'],
 898                 brt => ['record'],
 899                 mg => ['billings'],
 900                 mb => ['btype'],
 901                 circ => ['target_copy'],
 902                 acp => ['call_number'],
 903                 acn => ['record']
 904             },
 905             order_by => { mobts => 'xact_start' },
 906             %paging
 907         }
 908     );
 909
 910     my @total_keys = qw/total_paid total_owed balance_owed/;
 911     $self->ctx->{"fines"}->{@total_keys} = (0, 0, 0);
 912
 913     while(my $resp = $req->recv) {
 914         my $mobts = $resp->content;
 915         my $circ = $mobts->circulation;
 916
 917         my $last_billing;
 918         if($mobts->grocery) {
 919             my @billings = sort { $a->billing_ts cmp $b->billing_ts } @{$mobts->grocery->billings};
 920             $last_billing = pop(@billings);
 921         }
 922
 923         # XXX TODO confirm that the following, and the later division by 100.0
 924         # to get a floating point representation once again, is sufficiently
 925         # "money-safe" math.
 926         $self->ctx->{"fines"}->{$_} += int($mobts->$_ * 100) for (@total_keys);
 927
 928         my $marc_xml = undef;
 929         if ($mobts->xact_type eq 'reservation' and
 930             $mobts->reservation->target_resource_type->record) {
 931             $marc_xml = XML::LibXML->new->parse_string(
 932                 $mobts->reservation->target_resource_type->record->marc
 933             );
 934         } elsif ($mobts->xact_type eq 'circulation' and
 935             $circ->target_copy->call_number->id != -1) {
 936             $marc_xml = XML::LibXML->new->parse_string(
 937                 $circ->target_copy->call_number->record->marc
 938             );
 939         }
 940
 941         push(
 942             @{$self->ctx->{"fines"}->{$mobts->grocery ? "grocery" : "circulation"}},
 943             {
 944                 xact => $mobts,
 945                 last_grocery_billing => $last_billing,
 946                 marc_xml => $marc_xml
 947             }
 948         );
 949     }
 950
 951     $self->ctx->{"fines"}->{$_} /= 100.0 for (@total_keys);
 952     return;
 953 }
 954
 955 sub prepare_fines_for_payment {
 956     # This assumes $self->prepare_fines has already been run
 957     my ($self) = @_;
 958
 959     my @results = ();
 960     if ($self->ctx->{fines}) {
 961         push @results, [$_->{xact}->id, $_->{xact}->balance_owed] foreach (
 962             @{$self->ctx->{fines}->{circulation}},
 963             @{$self->ctx->{fines}->{grocery}}
 964         );
 965     }
 966
 967     return \@results;
 968 }
 969
 970 sub load_myopac_main {
 971     my $self = shift;
 972     my $limit = $self->cgi->param('limit') || 0;
 973     my $offset = $self->cgi->param('offset') || 0;
 974
 975     return $self->prepare_fines($limit, $offset) || Apache2::Const::OK;
 976 }
 977
 978 sub load_myopac_update_email {
 979     my $self = shift;
 980     my $e = $self->editor;
 981     my $ctx = $self->ctx;
 982     my $email = $self->cgi->param('email') || '';
 983
 984     return Apache2::Const::OK
 985         unless $self->cgi->request_method eq 'POST';
 986
 987     unless($email =~ /.+\@.+\..+/) { # TODO better regex?
 988         $ctx->{invalid_email} = $email;
 989         return Apache2::Const::OK;
 990     }
 991
 992     my $stat = $U->simplereq(
 993         'open-ils.actor',
 994         'open-ils.actor.user.email.update',
 995         $e->authtoken, $email);
 996
 997     my $url = $self->apache->unparsed_uri;
 998     $url =~ s/update_email/prefs/;
 999
1000     return $self->generic_redirect($url);
1001 }
1002
1003 sub load_myopac_update_username {
1004     my $self = shift;
1005     my $e = $self->editor;
1006     my $ctx = $self->ctx;
1007     my $username = $self->cgi->param('username') || '';
1008
1009     return Apache2::Const::OK
1010         unless $self->cgi->request_method eq 'POST';
1011
1012     unless($username and $username !~ /\s/) { # any other username restrictions?
1013         $ctx->{invalid_username} = $username;
1014         return Apache2::Const::OK;
1015     }
1016
1017     if($username ne $e->requestor->usrname) {
1018
1019         my $evt = $U->simplereq(
1020             'open-ils.actor',
1021             'open-ils.actor.user.username.update',
1022             $e->authtoken, $username);
1023
1024         if($U->event_equals($evt, 'USERNAME_EXISTS')) {
1025             $ctx->{username_exists} = $username;
1026             return Apache2::Const::OK;
1027         }
1028     }
1029
1030     my $url = $self->apache->unparsed_uri;
1031     $url =~ s/update_username/prefs/;
1032
1033     return $self->generic_redirect($url);
1034 }
1035
1036 sub load_myopac_update_password {
1037     my $self = shift;
1038     my $e = $self->editor;
1039     my $ctx = $self->ctx;
1040
1041     return Apache2::Const::OK
1042         unless $self->cgi->request_method eq 'POST';
1043
1044     my $current_pw = $self->cgi->param('current_pw') || '';
1045     my $new_pw = $self->cgi->param('new_pw') || '';
1046     my $new_pw2 = $self->cgi->param('new_pw2') || '';
1047
1048     unless($new_pw eq $new_pw2) {
1049         $ctx->{password_nomatch} = 1;
1050         return Apache2::Const::OK;
1051     }
1052
1053     my $pw_regex = $ctx->{get_org_setting}->($e->requestor->home_ou, 'global.password_regex');
1054
1055     if($pw_regex and $new_pw !~ /$pw_regex/) {
1056         $ctx->{password_invalid} = 1;
1057         return Apache2::Const::OK;
1058     }
1059
1060     my $evt = $U->simplereq(
1061         'open-ils.actor',
1062         'open-ils.actor.user.password.update',
1063         $e->authtoken, $new_pw, $current_pw);
1064
1065
1066     if($U->event_equals($evt, 'INCORRECT_PASSWORD')) {
1067         $ctx->{password_incorrect} = 1;
1068         return Apache2::Const::OK;
1069     }
1070
1071     my $url = $self->apache->unparsed_uri;
1072     $url =~ s/update_password/prefs/;
1073
1074     return $self->generic_redirect($url);
1075 }
1076
1077 sub load_myopac_bookbags {
1078     my $self = shift;
1079     my $e = $self->editor;
1080     my $ctx = $self->ctx;
1081
1082     $e->xact_begin; # replication...
1083
1084     my $rv = $self->load_mylist;
1085     unless($rv eq Apache2::Const::OK) {
1086         $e->rollback;
1087         return $rv;
1088     }
1089
1090     my $args = {
1091         order_by => {cbreb => 'name'},
1092         limit => $self->cgi->param('limit') || 10,
1093         offset => $self->cgi->param('offset') || 0
1094     };
1095
1096     $ctx->{bookbags} = $e->search_container_biblio_record_entry_bucket([
1097         {owner => $self->editor->requestor->id, btype => 'bookbag'},
1098         # XXX what to do about the possibility of really large bookbags here?
1099         {"flesh" => 1, "flesh_fields" => {"cbreb" => ["items"]}, %$args}
1100     ]);
1101
1102     if(!$ctx->{bookbags}) {
1103         $e->rollback;
1104         return Apache2::Const::HTTP_INTERNAL_SERVER_ERROR;
1105     }
1106
1107     # get unique record IDs
1108     my %rec_ids = ();
1109     foreach my $bbag (@{$ctx->{bookbags}}) {
1110         foreach my $rec_id (
1111             map { $_->target_biblio_record_entry } @{$bbag->items}
1112         ) {
1113             $rec_ids{$rec_id} = 1;
1114         }
1115     }
1116
1117     $ctx->{bookbags_marc_xml} = $self->fetch_marc_xml_by_id([keys %rec_ids]);
1118
1119     $e->rollback;
1120     return Apache2::Const::OK;
1121 }
1122
1123
1124 # actions are create, delete, show, hide, rename, add_rec, delete_item
1125 # CGI is action, list=list_id, add_rec/record=bre_id, del_item=bucket_item_id, name=new_bucket_name
1126 sub load_myopac_bookbag_update {
1127     my ($self, $action, $list_id) = @_;
1128     my $e = $self->editor;
1129     my $cgi = $self->cgi;
1130
1131     $action ||= $cgi->param('action');
1132     $list_id ||= $cgi->param('list');
1133
1134     my @add_rec = $cgi->param('add_rec') || $cgi->param('record');
1135     my @del_item = $cgi->param('del_item');
1136     my $shared = $cgi->param('shared');
1137     my $name = $cgi->param('name');
1138     my $success = 0;
1139     my $list;
1140
1141     if($action eq 'create') {
1142         $list = Fieldmapper::container::biblio_record_entry_bucket->new;
1143         $list->name($name);
1144         $list->owner($e->requestor->id);
1145         $list->btype('bookbag');
1146         $list->pub($shared ? 't' : 'f');
1147         $success = $U->simplereq('open-ils.actor',
1148             'open-ils.actor.container.create', $e->authtoken, 'biblio', $list)
1149
1150     } else {
1151
1152         $list = $e->retrieve_container_biblio_record_entry_bucket($list_id);
1153
1154         return Apache2::Const::HTTP_BAD_REQUEST unless
1155             $list and $list->owner == $e->requestor->id;
1156     }
1157
1158     if($action eq 'delete') {
1159         $success = $U->simplereq('open-ils.actor',
1160             'open-ils.actor.container.full_delete', $e->authtoken, 'biblio', $list_id);
1161
1162     } elsif($action eq 'show') {
1163         unless($U->is_true($list->pub)) {
1164             $list->pub('t');
1165             $success = $U->simplereq('open-ils.actor',
1166                 'open-ils.actor.container.update', $e->authtoken, 'biblio', $list);
1167         }
1168
1169     } elsif($action eq 'hide') {
1170         if($U->is_true($list->pub)) {
1171             $list->pub('f');
1172             $success = $U->simplereq('open-ils.actor',
1173                 'open-ils.actor.container.update', $e->authtoken, 'biblio', $list);
1174         }
1175
1176     } elsif($action eq 'rename') {
1177         if($name) {
1178             $list->name($name);
1179             $success = $U->simplereq('open-ils.actor',
1180                 'open-ils.actor.container.update', $e->authtoken, 'biblio', $list);
1181         }
1182
1183     } elsif($action eq 'add_rec') {
1184         foreach my $add_rec (@add_rec) {
1185             my $item = Fieldmapper::container::biblio_record_entry_bucket_item->new;
1186             $item->bucket($list_id);
1187             $item->target_biblio_record_entry($add_rec);
1188             $success = $U->simplereq('open-ils.actor',
1189                 'open-ils.actor.container.item.create', $e->authtoken, 'biblio', $item);
1190             last unless $success;
1191         }
1192
1193     } elsif($action eq 'del_item') {
1194         foreach (@del_item) {
1195             $success = $U->simplereq(
1196                 'open-ils.actor',
1197                 'open-ils.actor.container.item.delete', $e->authtoken, 'biblio', $_
1198             );
1199             last unless $success;
1200         }
1201     }
1202
1203     return $self->generic_redirect if $success;
1204
1205     $self->ctx->{bucket_action} = $action;
1206     $self->ctx->{bucket_action_failed} = 1;
1207     return Apache2::Const::OK;
1208 }
1209
1210 1