1 package OpenILS::Application::Circ;
2 use base qw/OpenSRF::Application/;
3 use strict; use warnings;
5 use OpenILS::Application::Circ::Circulate;
6 use OpenILS::Application::Circ::Survey;
7 use OpenILS::Application::Circ::StatCat;
8 use OpenILS::Application::Circ::Holds;
9 use OpenILS::Application::Circ::HoldNotify;
10 use OpenILS::Application::Circ::Money;
11 use OpenILS::Application::Circ::NonCat;
12 use OpenILS::Application::Circ::CopyLocations;
15 use DateTime::Format::ISO8601;
17 use OpenILS::Application::AppUtils;
19 use OpenSRF::Utils qw/:datetime/;
20 use OpenILS::Utils::ModsParser;
22 use OpenSRF::EX qw(:try);
23 use OpenSRF::Utils::Logger qw(:logger);
24 use OpenILS::Utils::Fieldmapper;
25 use OpenILS::Utils::Editor q/:funcs/;
26 use OpenILS::Utils::CStoreEditor q/:funcs/;
27 use OpenILS::Const qw/:const/;
28 use OpenSRF::Utils::SettingsClient;
30 my $apputils = "OpenILS::Application::AppUtils";
34 # ------------------------------------------------------------------------
35 # Top level Circ package;
36 # ------------------------------------------------------------------------
40 OpenILS::Application::Circ::Circulate->initialize();
44 __PACKAGE__->register_method(
45 method => 'retrieve_circ',
46 api_name => 'open-ils.circ.retrieve',
48 Retrieve a circ object by id
49 @param authtoken Login session key
50 @pararm circid The id of the circ object
54 my( $s, $c, $a, $i ) = @_;
55 my $e = new_editor(authtoken => $a);
56 return $e->event unless $e->checkauth;
57 my $circ = $e->retrieve_action_circulation($i) or return $e->event;
58 if( $e->requestor->id ne $circ->usr ) {
59 return $e->event unless $e->allowed('VIEW_CIRCULATIONS');
65 __PACKAGE__->register_method(
66 method => 'fetch_circ_mods',
67 api_name => 'open-ils.circ.circ_modifier.retrieve.all');
69 my $conf = OpenSRF::Utils::SettingsClient->new;
70 return $conf->config_value(
71 'apps', 'open-ils.circ', 'app_settings', 'circ_modifiers', 'mod' );
74 __PACKAGE__->register_method(
75 method => 'fetch_bill_types',
76 api_name => 'open-ils.circ.billing_type.retrieve.all');
77 sub fetch_bill_types {
78 my $conf = OpenSRF::Utils::SettingsClient->new;
79 return $conf->config_value(
80 'apps', 'open-ils.circ', 'app_settings', 'billing_types', 'type' );
84 # ------------------------------------------------------------------------
85 # Returns an array of {circ, record} hashes checked out by the user.
86 # ------------------------------------------------------------------------
87 __PACKAGE__->register_method(
88 method => "checkouts_by_user",
89 api_name => "open-ils.circ.actor.user.checked_out",
91 Returns a list of open circulations as a pile of objects. each object
92 contains the relevant copy, circ, and record
95 sub checkouts_by_user {
96 my( $self, $client, $user_session, $user_id ) = @_;
98 my( $requestor, $target, $copy, $record, $evt );
100 ( $requestor, $target, $evt ) =
101 $apputils->checkses_requestor( $user_session, $user_id, 'VIEW_CIRCULATIONS');
104 my $circs = $apputils->simplereq(
106 "open-ils.cstore.direct.action.open_circulation.search.atomic",
107 { usr => $target->id, checkin_time => undef } );
108 # { usr => $target->id } );
111 for my $circ (@$circs) {
113 ( $copy, $evt ) = $apputils->fetch_copy($circ->target_copy);
116 $logger->debug("Retrieving record for copy " . $circ->target_copy);
118 ($record, $evt) = $apputils->fetch_record_by_copy( $circ->target_copy );
121 my $mods = $apputils->record_to_mvr($record);
123 push( @results, { copy => $copy, circ => $circ, record => $mods } );
132 __PACKAGE__->register_method(
133 method => "checkouts_by_user_slim",
134 api_name => "open-ils.circ.actor.user.checked_out.slim",
135 NOTES => <<" NOTES");
136 Returns a list of open circulation objects
140 sub checkouts_by_user_slim {
141 my( $self, $client, $user_session, $user_id ) = @_;
143 my( $requestor, $target, $copy, $record, $evt );
145 ( $requestor, $target, $evt ) =
146 $apputils->checkses_requestor( $user_session, $user_id, 'VIEW_CIRCULATIONS');
149 $logger->debug( 'User ' . $requestor->id .
150 " retrieving checked out items for user " . $target->id );
152 # XXX Make the call correct..
153 return $apputils->simplereq(
155 "open-ils.cstore.direct.action.open_circulation.search.atomic",
156 { usr => $target->id, checkin_time => undef } );
157 # { usr => $target->id } );
161 __PACKAGE__->register_method(
162 method => "checkouts_by_user_opac",
163 api_name => "open-ils.circ.actor.user.checked_out.opac",);
166 sub checkouts_by_user_opac {
167 my( $self, $client, $auth, $user_id ) = @_;
169 my $e = OpenILS::Utils::Editor->new( authtoken => $auth );
170 return $e->event unless $e->checkauth;
171 $user_id ||= $e->requestor->id;
172 return $e->event unless
173 my $patron = $e->retrieve_actor_user($user_id);
176 my $search = {usr => $user_id, stop_fines => undef};
178 if( $user_id ne $e->requestor->id ) {
179 $data = $e->search_action_circulation(
180 $search, {checkperm=>1, permorg=>$patron->home_ou})
184 $data = $e->search_action_circulation($search);
191 __PACKAGE__->register_method(
192 method => "title_from_transaction",
193 api_name => "open-ils.circ.circ_transaction.find_title",
194 NOTES => <<" NOTES");
195 Returns a mods object for the title that is linked to from the
196 copy from the hold that created the given transaction
199 sub title_from_transaction {
200 my( $self, $client, $login_session, $transactionid ) = @_;
202 my( $user, $circ, $title, $evt );
204 ( $user, $evt ) = $apputils->checkses( $login_session );
207 ( $circ, $evt ) = $apputils->fetch_circulation($transactionid);
210 ($title, $evt) = $apputils->fetch_record_by_copy($circ->target_copy);
213 return $apputils->record_to_mvr($title);
217 __PACKAGE__->register_method(
218 method => "set_circ_lost",
219 api_name => "open-ils.circ.circulation.set_lost",
220 NOTES => <<" NOTES");
221 Params are login, barcode
222 login must have SET_CIRC_LOST perms
223 Sets a circulation to lost
226 __PACKAGE__->register_method(
227 method => "set_circ_lost",
228 api_name => "open-ils.circ.circulation.set_claims_returned",
229 NOTES => <<" NOTES");
230 Params are login, barcode
231 login must have SET_CIRC_MISSING perms
232 Sets a circulation to lost
236 my( $self, $client, $login, $args ) = @_;
237 my( $user, $circ, $copy, $evt );
239 my $barcode = $$args{barcode};
240 my $backdate = $$args{backdate};
242 ( $user, $evt ) = $U->checkses($login);
245 # Grab the related copy
246 ($copy, $evt) = $U->fetch_copy_by_barcode($barcode);
249 my $isclaims = $self->api_name =~ /claims_returned/;
250 my $islost = $self->api_name =~ /lost/;
251 my $session = $U->start_db_session();
253 # grab the circulation
254 ( $circ ) = $U->fetch_open_circulation( $copy->id );
255 return 1 unless $circ;
258 $evt = _set_circ_lost($copy, $circ, $user, $session) if $islost;
263 $evt = _set_circ_claims_returned(
264 $user, $circ, $session, $backdate );
269 $circ->stop_fines_time('now') unless $circ->stop_fines_time;
270 my $s = $session->request(
271 "open-ils.storage.direct.action.circulation.update", $circ )->gather(1);
273 return $U->DB_UPDATE_FAILED($circ) unless defined($s);
274 $U->commit_db_session($session);
280 my( $copy, $circ, $reqr, $session ) = @_;
282 my $evt = $U->check_perms($reqr->id, $circ->circ_lib, 'SET_CIRC_LOST');
285 $logger->activity("user ".$reqr->id." marking copy ".$copy->id.
286 " lost for circ ". $circ->id. " and checking for necessary charges");
288 if( $copy->status ne OILS_COPY_STATUS_LOST ) {
289 $copy->status(OILS_COPY_STATUS_LOST);
293 session => $session);
296 # if the copy has a price defined and/or a processing fee, bill the patron
298 # if the location that owns the copy has a processing fee, charge the user
299 my $owner = $U->fetch_copy_owner($copy->id);
300 $logger->info("circ fetching org settings for $owner ".
301 "to determine processing fee and default copy price");
303 my $settings = $U->simplereq(
304 'open-ils.actor', 'open-ils.actor.org_unit.settings.retrieve', $owner );
305 my $fee = $settings->{'circ.lost_materials_processing_fee'} || 0;
307 # If the copy has a price configured, charge said price to the user
308 my $s = OILS_SETTING_DEF_ITEM_PRICE;
309 my $copy_price = $copy->price || 0;
310 $copy_price = $settings->{$s} unless $copy_price and $copy_price > 0;
311 if($copy_price and $copy_price > 0) {
312 $logger->debug("lost copy has a price of $copy_price");
313 $evt = _make_bill($session, $copy_price, 'Lost Materials', $circ->id);
319 $evt = _make_bill($session, $fee, 'Lost Materials Processing Fee', $circ->id);
323 $circ->stop_fines(OILS_STOP_FINES_LOST);
328 my( $session, $amount, $type, $xactid ) = @_;
330 $logger->activity("The system is charging $amount ".
331 " [$type] for lost materials on circulation $xactid");
333 my $bill = Fieldmapper::money::billing->new;
335 $bill->xact($xactid);
336 $bill->amount($amount);
337 $bill->billing_type($type); # - XXX these strings should be configurable some day
338 $bill->note('SYSTEM GENERATED');
340 my $id = $session->request(
341 'open-ils.storage.direct.money.billing.create', $bill )->gather(1);
343 return $U->DB_UPDATE_FAILED($bill) unless defined $id;
347 sub _set_circ_claims_returned {
348 my( $reqr, $circ, $session, $backdate ) = @_;
350 my $evt = $U->check_perms($reqr->id, $circ->circ_lib, 'SET_CIRC_CLAIMS_RETURNED');
352 $circ->stop_fines("CLAIMSRETURNED");
354 $logger->activity("user ".$reqr->id.
355 " marking circ". $circ->id. " as claims returned");
357 # allow the caller to backdate the circulation and void any fines
358 # that occurred after the backdate
360 OpenILS::Application::Circ::Circulate::_checkin_handle_backdate(
361 $backdate, $circ, $reqr, $session );
369 __PACKAGE__->register_method (
370 method => 'set_circ_due_date',
371 api_name => 'open-ils.circ.circulation.due_date.update',
373 Updates the due_date on the given circ
375 @param circid The id of the circ to update
376 @param date The timestamp of the new due date
380 sub set_circ_due_date {
381 my( $s, $c, $authtoken, $circid, $date ) = @_;
382 my ($circ, $evt) = $U->fetch_circulation($circid);
386 ($reqr, $evt) = $U->checkses($authtoken);
389 $evt = $U->check_perms($reqr->id, $circ->circ_lib, 'CIRC_OVERRIDE_DUE_DATE');
392 $date = clense_ISO8601($date);
393 $logger->activity("user ".$reqr->id.
394 " updating due_date on circ $circid: $date");
396 $circ->due_date($date);
397 my $stat = $U->storagereq(
398 'open-ils.storage.direct.action.circulation.update', $circ);
399 return $U->DB_UPDATE_FAILED unless defined $stat;
404 __PACKAGE__->register_method(
405 method => "create_in_house_use",
406 api_name => 'open-ils.circ.in_house_use.create',
408 Creates an in-house use action.
409 @param $authtoken The login session key
410 @param params A hash of params including
411 'location' The org unit id where the in-house use occurs
412 'copyid' The copy in question
413 'count' The number of in-house uses to apply to this copy
414 @return An array of id's representing the id's of the newly created
415 in-house use objects or an event on an error
418 sub create_in_house_use {
419 my( $self, $client, $authtoken, $params ) = @_;
421 my( $staff, $evt, $copy );
422 my $org = $params->{location};
423 my $copyid = $params->{copyid};
424 my $count = $params->{count} || 1;
425 my $use_time = $params->{use_time} || 'now';
428 my $barcode = $params->{barcode};
429 ($copy, $evt) = $U->fetch_copy_by_barcode($barcode);
434 ($staff, $evt) = $U->checkses($authtoken);
437 ($copy, $evt) = $U->fetch_copy($copyid) unless $copy;
440 $evt = $U->check_perms($staff->id, $org, 'CREATE_IN_HOUSE_USE');
443 $logger->activity("User " . $staff->id .
444 " creating $count in-house use(s) for copy $copyid at location $org");
446 if( $use_time ne 'now' ) {
447 $use_time = clense_ISO8601($use_time);
448 $logger->debug("in_house_use setting use time to $use_time");
453 my $ihu = Fieldmapper::action::in_house_use->new;
456 $ihu->staff($staff->id);
457 $ihu->org_unit($org);
458 $ihu->use_time($use_time);
460 my $id = $U->simplereq(
462 'open-ils.storage.direct.action.in_house_use.create', $ihu );
464 return $U->DB_UPDATE_FAILED($ihu) unless $id;
473 __PACKAGE__->register_method(
474 method => "view_circs",
475 api_name => "open-ils.circ.copy_checkout_history.retrieve",
477 Retrieves the last X circs for a given copy
478 @param authtoken The login session key
479 @param copyid The copy to check
480 @param count How far to go back in the item history
481 @return An array of circ ids
487 my( $self, $client, $authtoken, $copyid, $count ) = @_;
489 my( $requestor, $evt ) = $U->checksesperm(
490 $authtoken, 'VIEW_COPY_CHECKOUT_HISTORY' );
493 return [] unless $count;
495 my $circs = $U->cstorereq(
496 'open-ils.cstore.direct.action.circulation.search.atomic',
498 target_copy => $copyid,
502 order_by => { circ => "xact_start DESC" }
510 __PACKAGE__->register_method(
511 method => "circ_count",
512 api_name => "open-ils.circ.circulation.count",
514 Returns the number of times the item has circulated
515 @param copyid The copy to check
519 my( $self, $client, $copyid, $range ) = @_;
520 my $e = OpenILS::Utils::Editor->new;
521 return $e->request('open-ils.storage.asset.copy.circ_count', $copyid, $range);
526 __PACKAGE__->register_method(
527 method => 'fetch_notes',
528 api_name => 'open-ils.circ.copy_note.retrieve.all',
530 Returns an array of copy note objects.
531 @param args A named hash of parameters including:
532 authtoken : Required if viewing non-public notes
533 itemid : The id of the item whose notes we want to retrieve
534 pub : True if all the caller wants are public notes
535 @return An array of note objects
538 __PACKAGE__->register_method(
539 method => 'fetch_notes',
540 api_name => 'open-ils.circ.call_number_note.retrieve.all',
541 signature => q/@see open-ils.circ.copy_note.retrieve.all/);
543 __PACKAGE__->register_method(
544 method => 'fetch_notes',
545 api_name => 'open-ils.circ.title_note.retrieve.all',
546 signature => q/@see open-ils.circ.copy_note.retrieve.all/);
549 # NOTE: VIEW_COPY/VOLUME/TITLE_NOTES perms should always be global
551 my( $self, $connection, $args ) = @_;
553 my $id = $$args{itemid};
554 my $authtoken = $$args{authtoken};
557 if( $self->api_name =~ /copy/ ) {
559 return $U->cstorereq(
560 'open-ils.cstore.direct.asset.copy_note.search.atomic',
561 { owning_copy => $id, pub => 't' } );
563 ( $r, $evt ) = $U->checksesperm($authtoken, 'VIEW_COPY_NOTES');
565 return $U->cstorereq(
566 'open-ils.cstore.direct.asset.copy_note.search.atomic', {owning_copy => $id} );
569 } elsif( $self->api_name =~ /call_number/ ) {
571 return $U->cstorereq(
572 'open-ils.cstore.direct.asset.call_number_note.search.atomic',
573 { call_number => $id, pub => 't' } );
575 ( $r, $evt ) = $U->checksesperm($authtoken, 'VIEW_VOLUME_NOTES');
577 return $U->cstorereq(
578 'open-ils.cstore.direct.asset.call_number_note.search.atomic', { call_number => $id } );
581 } elsif( $self->api_name =~ /title/ ) {
583 return $U->cstorereq(
584 'open-ils.cstore.direct.bilbio.record_note.search.atomic',
585 { record => $id, pub => 't' } );
587 ( $r, $evt ) = $U->checksesperm($authtoken, 'VIEW_TITLE_NOTES');
589 return $U->cstorereq(
590 'open-ils.cstore.direct.biblio.record_note.search.atomic', { record => $id } );
597 __PACKAGE__->register_method(
598 method => 'has_notes',
599 api_name => 'open-ils.circ.copy.has_notes');
600 __PACKAGE__->register_method(
601 method => 'has_notes',
602 api_name => 'open-ils.circ.call_number.has_notes');
603 __PACKAGE__->register_method(
604 method => 'has_notes',
605 api_name => 'open-ils.circ.title.has_notes');
609 my( $self, $conn, $authtoken, $id ) = @_;
610 my $editor = OpenILS::Utils::Editor->new(authtoken => $authtoken);
611 return $editor->event unless $editor->checkauth;
613 my $n = $editor->search_asset_copy_note(
614 {owning_copy=>$id}, {idlist=>1}) if $self->api_name =~ /copy/;
616 $n = $editor->search_asset_call_number_note(
617 {call_number=>$id}, {idlist=>1}) if $self->api_name =~ /call_number/;
619 $n = $editor->search_biblio_record_note(
620 {record=>$id}, {idlist=>1}) if $self->api_name =~ /title/;
625 __PACKAGE__->register_method(
626 method => 'create_copy_note',
627 api_name => 'open-ils.circ.copy_note.create',
629 Creates a new copy note
630 @param authtoken The login session key
631 @param note The note object to create
632 @return The id of the new note object
635 sub create_copy_note {
636 my( $self, $connection, $authtoken, $note ) = @_;
637 my( $cnowner, $requestor, $evt );
639 ($cnowner, $evt) = $U->fetch_copy_owner($note->owning_copy);
641 ($requestor, $evt) = $U->checkses($authtoken);
643 $evt = $U->check_perms($requestor->id, $cnowner, 'CREATE_COPY_NOTE');
646 $note->create_date('now');
647 $note->creator($requestor->id);
648 $note->pub( ($U->is_true($note->pub)) ? 1 : 0 );
650 my $id = $U->storagereq(
651 'open-ils.storage.direct.asset.copy_note.create', $note );
652 return $U->DB_UPDATE_FAILED($note) unless $id;
654 $logger->activity("User ".$requestor->id." created a new copy ".
655 "note [$id] for copy ".$note->owning_copy." with text ".$note->value);
660 __PACKAGE__->register_method(
661 method => 'delete_copy_note',
662 api_name => 'open-ils.circ.copy_note.delete',
664 Deletes an existing copy note
665 @param authtoken The login session key
666 @param noteid The id of the note to delete
667 @return 1 on success - Event otherwise.
670 sub delete_copy_note {
671 my( $self, $conn, $authtoken, $noteid ) = @_;
672 my( $requestor, $note, $owner, $evt );
674 ($requestor, $evt) = $U->checkses($authtoken);
677 ($note, $evt) = $U->fetch_copy_note($noteid);
680 if( $note->creator ne $requestor->id ) {
681 ($owner, $evt) = $U->fetch_copy_onwer($note->owning_copy);
683 $evt = $U->check_perms($requestor->id, $owner, 'DELETE_COPY_NOTE');
687 my $stat = $U->storagereq(
688 'open-ils.storage.direct.asset.copy_note.delete', $noteid );
689 return $U->DB_UPDATE_FAILED($noteid) unless $stat;
691 $logger->activity("User ".$requestor->id." deleted copy note $noteid");
696 __PACKAGE__->register_method(
697 method => 'age_hold_rules',
698 api_name => 'open-ils.circ.config.rules.age_hold_protect.retrieve.all',
702 my( $self, $conn ) = @_;
703 return new_editor()->retrieve_all_config_rules_age_hold_protect();
709 __PACKAGE__->register_method(
710 method => 'copy_details',
711 api_name => 'open-ils.circ.copy_details.retrieve',
717 my( $self, $conn, $auth, $copy_id ) = @_;
718 my $e = new_editor(authtoken=>$auth);
719 return $e->event unless $e->checkauth;
721 my $copy = $e->retrieve_asset_copy($copy_id)
724 my $hold = $e->search_action_hold_request(
726 current_copy => $copy_id,
727 capture_time => { "!=" => undef },
728 fulfillment_time => undef,
732 OpenILS::Application::Circ::Holds::flesh_hold_transits([$hold]) if $hold;
734 my $transit = $e->search_action_transit_copy(
735 { target_copy => $copy_id, dest_recv_time => undef } )->[0];
737 # find the latest circ, open or closed
738 my $circ = $e->search_action_circulation(
740 { target_copy => $copy_id },
741 { order_by => { circ => 'xact_start desc' }, limit => 1 }
756 __PACKAGE__->register_method(
757 method => 'mark_item',
758 api_name => 'open-ils.circ.mark_item_damaged',
760 __PACKAGE__->register_method(
761 method => 'mark_item',
762 api_name => 'open-ils.circ.mark_item_missing',
766 my( $self, $conn, $auth, $copy_id ) = @_;
767 my $e = new_editor(authtoken=>$auth, xact =>1);
768 return $e->event unless $e->checkauth;
770 my $perm = 'MARK_ITEM_MISSING';
771 my $stat = OILS_COPY_STATUS_MISSING;
773 if( $self->api_name =~ /damaged/ ) {
774 $perm = 'MARK_ITEM_DAMAGED';
775 $stat = OILS_COPY_STATUS_DAMAGED;
778 my $copy = $e->retrieve_asset_copy($copy_id)
780 $copy->status($stat);
782 $e->update_asset_copy($copy) or return $e->event;
785 my $holds = $e->search_action_hold_request(
787 current_copy => $copy->id,
788 fulfillment_time => undef,
789 cancel_time => undef,
795 $logger->debug("reseting holds that target the marked copy");
796 OpenILS::Application::Circ::Holds->_reset_hold($e->requestor, $_) for @$holds;
806 # ----------------------------------------------------------------------
807 __PACKAGE__->register_method(
808 method => 'magic_fetch',
809 api_name => 'open-ils.agent.fetch'
812 my @FETCH_ALLOWED = qw/ aou aout acp acn bre /;
815 my( $self, $conn, $auth, $args ) = @_;
816 my $e = new_editor( authtoken => $auth );
817 return $e->event unless $e->checkauth;
819 my $hint = $$args{hint};
822 # Is the call allowed to fetch this type of object?
823 return undef unless grep { $_ eq $hint } @FETCH_ALLOWED;
825 # Find the class the iplements the given hint
827 $Fieldmapper::fieldmap->{$_}{hint} eq $hint } Fieldmapper->classes;
829 $class =~ s/Fieldmapper:://og;
831 my $method = "retrieve_$class";
833 my $obj = $e->$method($id) or return $e->event;
836 # ----------------------------------------------------------------------