Open-ILS/src/perlmods/OpenILS/Application/Circ.pm

   1 package OpenILS::Application::Circ;
   2 use base qw/OpenSRF::Application/;
   3 use strict; use warnings;
   4
   5 use OpenILS::Application::Circ::Circulate;
   6 use OpenILS::Application::Circ::Rules;
   7 use OpenILS::Application::Circ::Survey;
   8 use OpenILS::Application::Circ::StatCat;
   9 use OpenILS::Application::Circ::Holds;
  10 use OpenILS::Application::Circ::Money;
  11 use OpenILS::Application::Circ::NonCat;
  12 use OpenILS::Application::Circ::CopyLocations;
  13
  14 use DateTime;
  15 use DateTime::Format::ISO8601;
  16
  17 use OpenILS::Application::AppUtils;
  18 my $apputils = "OpenILS::Application::AppUtils";
  19 my $U = $apputils;
  20 use OpenSRF::Utils qw/:datetime/;
  21 use OpenILS::Utils::ModsParser;
  22 use OpenILS::Event;
  23 use OpenSRF::EX qw(:try);
  24 use OpenSRF::Utils::Logger qw(:logger);
  25 #my $logger = "OpenSRF::Utils::Logger";
  26
  27
  28 # ------------------------------------------------------------------------
  29 # Top level Circ package;
  30 # ------------------------------------------------------------------------
  31
  32 sub initialize {
  33         my $self = shift;
  34         OpenILS::Application::Circ::Rules->initialize();
  35         OpenILS::Application::Circ::Circulate->initialize();
  36 }
  37
  38
  39 # ------------------------------------------------------------------------
  40 # Returns an array of {circ, record} hashes checked out by the user.
  41 # ------------------------------------------------------------------------
  42 __PACKAGE__->register_method(
  43         method  => "checkouts_by_user",
  44         api_name        => "open-ils.circ.actor.user.checked_out",
  45         NOTES           => <<"  NOTES");
  46         Returns a list of open circulations as a pile of objects.  each object
  47         contains the relevant copy, circ, and record
  48         NOTES
  49
  50 sub checkouts_by_user {
  51         my( $self, $client, $user_session, $user_id ) = @_;
  52
  53         my( $requestor, $target, $copy, $record, $evt );
  54
  55         ( $requestor, $target, $evt ) =
  56                 $apputils->checkses_requestor( $user_session, $user_id, 'VIEW_CIRCULATIONS');
  57         return $evt if $evt;
  58
  59         my $circs = $apputils->simplereq(
  60                 'open-ils.storage',
  61                 "open-ils.storage.direct.action.open_circulation.search.atomic",
  62                 { usr => $target->id, checkin_time => undef } );
  63 #               { usr => $target->id } );
  64
  65         my @results;
  66         for my $circ (@$circs) {
  67
  68                 ( $copy, $evt )  = $apputils->fetch_copy($circ->target_copy);
  69                 return $evt if $evt;
  70
  71                 $logger->debug("Retrieving record for copy " . $circ->target_copy);
  72
  73                 ($record, $evt) = $apputils->fetch_record_by_copy( $circ->target_copy );
  74                 return $evt if $evt;
  75
  76                 my $mods = $apputils->record_to_mvr($record);
  77
  78                 push( @results, { copy => $copy, circ => $circ, record => $mods } );
  79         }
  80
  81         return \@results;
  82
  83 }
  84
  85
  86
  87 __PACKAGE__->register_method(
  88         method  => "checkouts_by_user_slim",
  89         api_name        => "open-ils.circ.actor.user.checked_out.slim",
  90         NOTES           => <<"  NOTES");
  91         Returns a list of open circulation objects
  92         NOTES
  93
  94 sub checkouts_by_user_slim {
  95         my( $self, $client, $user_session, $user_id ) = @_;
  96
  97         my( $requestor, $target, $copy, $record, $evt );
  98
  99         ( $requestor, $target, $evt ) =
 100                 $apputils->checkses_requestor( $user_session, $user_id, 'VIEW_CIRCULATIONS');
 101         return $evt if $evt;
 102
 103         $logger->debug( 'User ' . $requestor->id .
 104                 " retrieving checked out items for user " . $target->id );
 105
 106         # XXX Make the call correct..
 107         return $apputils->simplereq(
 108                 'open-ils.storage',
 109                 "open-ils.storage.direct.action.open_circulation.search.atomic",
 110                 { usr => $target->id, checkin_time => undef } );
 111 #               { usr => $target->id } );
 112 }
 113
 114
 115
 116
 117 __PACKAGE__->register_method(
 118         method  => "title_from_transaction",
 119         api_name        => "open-ils.circ.circ_transaction.find_title",
 120         NOTES           => <<"  NOTES");
 121         Returns a mods object for the title that is linked to from the
 122         copy from the hold that created the given transaction
 123         NOTES
 124
 125 sub title_from_transaction {
 126         my( $self, $client, $login_session, $transactionid ) = @_;
 127
 128         my( $user, $circ, $title, $evt );
 129
 130         ( $user, $evt ) = $apputils->checkses( $login_session );
 131         return $evt if $evt;
 132
 133         ( $circ, $evt ) = $apputils->fetch_circulation($transactionid);
 134         return $evt if $evt;
 135
 136         ($title, $evt) = $apputils->fetch_record_by_copy($circ->target_copy);
 137         return $evt if $evt;
 138
 139         return $apputils->record_to_mvr($title);
 140 }
 141
 142
 143 __PACKAGE__->register_method(
 144         method  => "set_circ_lost",
 145         api_name        => "open-ils.circ.circulation.set_lost",
 146         NOTES           => <<"  NOTES");
 147         Params are login, circid
 148         login must have SET_CIRC_LOST perms
 149         Sets a circulation to lost
 150         NOTES
 151
 152 __PACKAGE__->register_method(
 153         method  => "set_circ_lost",
 154         api_name        => "open-ils.circ.circulation.set_claims_returned",
 155         NOTES           => <<"  NOTES");
 156         Params are login, circid
 157         login must have SET_CIRC_MISSING perms
 158         Sets a circulation to lost
 159         NOTES
 160
 161 sub set_circ_lost {
 162         my( $self, $client, $login, $circid ) = @_;
 163         my( $user, $circ, $evt );
 164
 165         ( $user, $evt ) = $apputils->checkses($login);
 166         return $evt if $evt;
 167
 168         ( $circ, $evt ) = $apputils->fetch_circulation( $circid );
 169         return $evt if $evt;
 170
 171         if($self->api_name =~ /lost/) {
 172                 if($evt = $apputils->checkperms(
 173                         $user->id, $circ->circ_lib, "SET_CIRC_LOST")) {
 174                         return $evt;
 175                 }
 176                 $circ->stop_fines("LOST");
 177         }
 178
 179         # XXX Back date the checkin time so the patron has no fines
 180         if($self->api_name =~ /claims_returned/) {
 181                 if($evt = $apputils->checkperms(
 182                         $user->id, $circ->circ_lib, "SET_CIRC_CLAIMS_RETURNED")) {
 183                         return $evt;
 184                 }
 185                 $circ->stop_fines("CLAIMSRETURNED");
 186         }
 187
 188         my $s = $apputils->simplereq(
 189                 'open-ils.storage',
 190                 "open-ils.storage.direct.action.circulation.update", $circ );
 191
 192         if(!$s) { throw OpenSRF::EX::ERROR ("Error updating circulation with id $circid"); }
 193 }
 194
 195 __PACKAGE__->register_method(
 196         method          => "create_in_house_use",
 197         api_name                => 'open-ils.circ.in_house_use.create',
 198         signature       =>      q/
 199                 Creates an in-house use action.
 200                 @param $authtoken The login session key
 201                 @param params A hash of params including
 202                         'location' The org unit id where the in-house use occurs
 203                         'copyid' The copy in question
 204                         'count' The number of in-house uses to apply to this copy
 205                 @return An array of id's representing the id's of the newly created
 206                 in-house use objects or an event on an error
 207         /);
 208
 209 sub create_in_house_use {
 210         my( $self, $client, $authtoken, $params ) = @_;
 211
 212         my( $staff, $evt, $copy );
 213         my $org                 = $params->{location};
 214         my $copyid              = $params->{copyid};
 215         my $count               = $params->{count} || 1;
 216         my $use_time    = $params->{use_time} || 'now';
 217
 218         if(!$copyid) {
 219                 my $barcode = $params->{barcode};
 220                 ($copy, $evt) = $U->fetch_copy_by_barcode($barcode);
 221                 $copyid = $copy->id;
 222                 return $evt if $evt;
 223         }
 224
 225         ($staff, $evt) = $U->checkses($authtoken);
 226         return $evt if $evt;
 227
 228         ($copy, $evt) = $U->fetch_copy($copyid) unless $copy;
 229         return $evt if $evt;
 230
 231         $evt = $U->check_perms($staff->id, $org, 'CREATE_IN_HOUSE_USE');
 232         return $evt if $evt;
 233
 234         $logger->activity("User " . $staff->id .
 235                 " creating $count in-house use(s) for copy $copyid at location $org");
 236
 237         if( $use_time ne 'now' ) {
 238                 $use_time = clense_ISO8601($use_time);
 239                 $logger->debug("in_house_use setting use time to $use_time");
 240         }
 241
 242         my @ids;
 243         for(1..$count) {
 244                 my $ihu = Fieldmapper::action::in_house_use->new;
 245
 246                 $ihu->item($copyid);
 247                 $ihu->staff($staff->id);
 248                 $ihu->org_unit($org);
 249                 $ihu->use_time($use_time);
 250
 251                 my $id = $U->simplereq(
 252                         'open-ils.storage',
 253                         'open-ils.storage.direct.action.in_house_use.create', $ihu );
 254
 255                 return $U->DB_UPDATE_FAILED($ihu) unless $id;
 256                 push @ids, $id;
 257         }
 258
 259         return \@ids;
 260 }
 261
 262
 263
 264 __PACKAGE__->register_method(
 265         method  => "view_circ_patrons",
 266         api_name        => "open-ils.circ.copy_checkout_history.retrieve",
 267         notes           => q/
 268                 Retrieves the last X users who checked out a given copy
 269                 @param authtoken The login session key
 270                 @param copyid The copy to check
 271                 @param count How far to go back in the item history
 272                 @return An array of patron ids
 273         /);
 274
 275 sub view_circ_patrons {
 276         my( $self, $client, $authtoken, $copyid, $count ) = @_;
 277
 278         my( $requestor, $evt ) = $U->checksesperm(
 279                         $authtoken, 'VIEW_COPY_CHECKOUT_HISTORY' );
 280         return $evt if $evt;
 281
 282         return [] unless $count;
 283
 284         my $circs = $U->storagereq(
 285                 'open-ils.storage.direct.action.circulation.search_where.atomic',
 286                         {
 287                                 target_copy => $copyid,
 288                                 opac_renewal => 'f',
 289                                 desk_renewal => 'f',
 290                                 phone_renewal => 'f',
 291                         },
 292                         {
 293                                 limit => $count,
 294                                 order_by => "xact_start DESC"
 295                         } );
 296
 297
 298         my @users;
 299         push(@users, $_->usr) for @$circs;
 300         return \@users;
 301 }
 302
 303
 304
 305 __PACKAGE__->register_method(
 306         method          => 'fetch_notes',
 307         api_name                => 'open-ils.circ.copy_note.retrieve.all',
 308         signature       => q/
 309                 Returns an array of copy note objects.
 310                 @param args A named hash of parameters including:
 311                         authtoken       : Required if viewing non-public notes
 312                         itemid          : The id of the item whose notes we want to retrieve
 313                         pub                     : True if all the caller wants are public notes
 314                 @return An array of note objects
 315         /);
 316
 317 __PACKAGE__->register_method(
 318         method          => 'fetch_notes',
 319         api_name                => 'open-ils.circ.call_number_note.retrieve.all',
 320         signature       => q/@see open-ils.circ.copy_note.retrieve.all/);
 321
 322 __PACKAGE__->register_method(
 323         method          => 'fetch_notes',
 324         api_name                => 'open-ils.circ.title_note.retrieve.all',
 325         signature       => q/@see open-ils.circ.copy_note.retrieve.all/);
 326
 327 # NOTE: VIEW_COPY/VOLUME/TITLE_NOTES perms should always be global
 328 sub fetch_notes {
 329         my( $self, $connection, $args ) = @_;
 330
 331         my $id = $$args{itemid};
 332         my $authtoken = $$args{authtoken};
 333         my( $r, $evt);
 334
 335         if( $self->api_name =~ /copy/ ) {
 336                 if( $$args{pub} ) {
 337                         return $U->storagereq(
 338                                 'open-ils.storage.direct.asset.copy_note.search_where.atomic',
 339                                 { owning_copy => $id, pub => 't' } );
 340                 } else {
 341                         ( $r, $evt ) = $U->checksesperms($authtoken, 'VIEW_COPY_NOTES');
 342                         return $evt if $evt;
 343                         return $U->storagereq(
 344                                 'open-ils.storage.direct.asset.copy_note.search.owning_copy.atomic', $id );
 345                 }
 346
 347         } elsif( $self->api_name =~ /call_number/ ) {
 348                 if( $$args{pub} ) {
 349                         return $U->storagereq(
 350                                 'open-ils.storage.direct.asset.call_number_note.search_where.atomic',
 351                                 { call_number => $id, pub => 't' } );
 352                 } else {
 353                         ( $r, $evt ) = $U->checksesperms($authtoken, 'VIEW_VOLUME_NOTES');
 354                         return $evt if $evt;
 355                         return $U->storagereq(
 356                                 'open-ils.storage.direct.asset.call_number_note.search.call_number.atomic', $id );
 357                 }
 358
 359         } elsif( $self->api_name =~ /title/ ) {
 360                 if( $$args{pub} ) {
 361                         return $U->storagereq(
 362                                 'open-ils.storage.direct.bilbio.record_note.search_where.atomic',
 363                                 { record => $id, pub => 't' } );
 364                 } else {
 365                         ( $r, $evt ) = $U->checksesperms($authtoken, 'VIEW_TITLE_NOTES');
 366                         return $evt if $evt;
 367                         return $U->storagereq(
 368                                 'open-ils.storage.direct.asset.call_number_note.search.call_number.atomic', $id );
 369                 }
 370         }
 371
 372         return undef;
 373 }
 374
 375 __PACKAGE__->register_method(
 376         method          => 'create_copy_note',
 377         api_name                => 'open-ils.circ.copy_note.create',
 378         signature       => q/
 379                 Creates a new copy note
 380                 @param authtoken The login session key
 381                 @param note     The note object to create
 382                 @return The id of the new note object
 383         /);
 384
 385 sub create_copy_note {
 386         my( $self, $connection, $authtoken, $note ) = @_;
 387         my( $cnowner, $requestor, $evt );
 388
 389         ($cnowner, $evt) = $U->fetch_copy_owner($note->owning_copy);
 390         return $evt if $evt;
 391         ($requestor, $evt) = $U->checkses($authtoken);
 392         return $evt if $evt;
 393         $evt = $U->check_perms($requestor->id, $cnowner, 'CREATE_COPY_NOTE');
 394         return $evt if $evt;
 395
 396         $note->create_date('now');
 397         $note->pub( ($note->pub) ? 't' : 'f' );
 398
 399         my $id = $U->storagereq(
 400                 'open-ils.storage.direct.asset.copy_note.create', $note );
 401         return $U->DB_UPDATE_FAILED($note) unless $id;
 402
 403         $logger->activity("User ".$requestor->id." created a new copy ".
 404                 "note [$id] for copy ".$note->owning_copy." with text ".$note->value);
 405
 406         return $id;
 407 }
 408
 409 __PACKAGE__->register_method(
 410         method          => 'delete_copy_note',
 411         api_name                =>      'open-ils.circ.copy_note.delete',
 412         signature       => q/
 413                 Deletes an existing copy note
 414                 @param authtoken The login session key
 415                 @param noteid The id of the note to delete
 416                 @return 1 on success - Event otherwise.
 417                 /);
 418
 419 sub delete_copy_note {
 420         my( $self, $conn, $authtoken, $noteid ) = @_;
 421         my( $requestor, $note, $owner, $evt );
 422
 423         ($requestor, $evt) = $U->checkses($authtoken);
 424         return $evt if $evt;
 425
 426         ($note, $evt) = $U->fetch_copy_note($noteid);
 427         return $evt if $evt;
 428
 429         if( $note->creator ne $requestor->id ) {
 430                 ($owner, $evt) = $U->fetch_copy_onwer($note->owning_copy);
 431                 return $evt if $evt;
 432                 $evt = $U->check_perms($requestor->id, $owner, 'DELETE_COPY_NOTE');
 433                 return $evt if $evt;
 434         }
 435
 436         my $stat = $U->storagereq(
 437                 'open-ils.storage.direct.asset.copy_note.delete', $noteid );
 438         return $U->DB_UPDATE_FAILED($noteid) unless $stat;
 439
 440         $logger->activity("User ".$requestor->id." deleted copy note $noteid");
 441         return 1;
 442 }
 443
 444
 445 __PACKAGE__->register_method(
 446         method          => 'note_batch',
 447         api_name                => 'open-ils.circ.biblio_notes.public.batch.retrieve',
 448         signature       => q/
 449                 Returns a set of notes for a given set of titles, volumes, and copies.
 450                 @param titleid The id of the title who's notes are retrieving
 451                 @return A list like so:
 452                         {
 453                                 "titles"                : [ { id : $id, notes : [ n1, n2 ] },... ]
 454                                 "volumes"       : [ { id : $id, notes : [ n1, n2 ] },... ]
 455                                 "copies"                : [ { id : $id, notes : [ n1, n2 ] },... ]
 456                         }
 457         /
 458 );
 459
 460 sub note_batch {
 461         my( $self, $conn, $titleid ) = @_;
 462
 463         my @copies;
 464         my $cns = $U->storagereq(
 465                 'open-ils.storage.id_list.asset.call_number.search_where.atomic',
 466                 { record => $titleid, deleted => 'f' } );
 467                 #'open-ils.storage.id_list.asset.call_number.search.record.atomic', $titleid );
 468
 469         for my $c (@$cns) {
 470                 my $copyids = $U->storagereq(
 471                         #'open-ils.storage.id_list.asset.copy.search.call_number.atomic', $c);
 472                         'open-ils.storage.id_list.asset.copy.search_where.atomic', { call_number => $c, deleted => 'f' });
 473                 push(@copies, @$copyids);
 474         }
 475
 476         return _note_batch( { titles => [$titleid], volumes => $cns, copies => \@copies} );
 477 }
 478
 479
 480 sub _note_batch {
 481         my $args = shift;
 482
 483         my %resp;
 484         $resp{titles}   = [];
 485         $resp{volumes} = [];
 486         $resp{copies}   = [];
 487
 488         my $titles      = (ref($$args{titles})) ? $$args{titles} : [];
 489         my $volumes = (ref($$args{volumes})) ? $$args{volumes} : [];
 490         my $copies      = (ref($$args{copies})) ? $$args{copies} : [];
 491
 492         for my $title (@$titles) {
 493                 my $notes = $U->storagereq(
 494                         'open-ils.storage.direct.biblio.record_note.search_where.atomic',
 495                         { record => $title, pub => 't' });
 496                 push(@{$resp{titles}}, {id => $title, notes => $notes}) if @$notes;
 497         }
 498
 499         for my $volume (@$volumes) {
 500                 my $notes = $U->storagereq(
 501                         'open-ils.storage.direct.asset.call_number_note.search_where.atomic',
 502                         { call_number => $volume, pub => 't' });
 503                 push( @{$resp{volumes}}, {id => $volume, notes => $notes} ) if @$notes;
 504         }
 505
 506
 507         for my $copy (@$copies) {
 508                 $logger->debug("Fetching copy notes for copy $copy");
 509                 my $notes = $U->storagereq(
 510                         'open-ils.storage.direct.asset.copy_note.search_where.atomic',
 511                         { owning_copy => $copy, pub => 't' });
 512                 push( @{$resp{copies}}, { id => $copy, notes => $notes }) if @$notes;
 513         }
 514
 515         return \%resp;
 516 }
 517
 518
 519
 520
 521
 522
 523
 524 1;