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::Money;
10 use OpenILS::Application::Circ::NonCat;
11 use OpenILS::Application::Circ::CopyLocations;
14 use DateTime::Format::ISO8601;
16 use OpenILS::Application::AppUtils;
17 my $apputils = "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/;
29 # ------------------------------------------------------------------------
30 # Top level Circ package;
31 # ------------------------------------------------------------------------
35 OpenILS::Application::Circ::Circulate->initialize();
39 __PACKAGE__->register_method(
40 method => 'retrieve_circ',
41 api_name => 'open-ils.circ.retrieve',
43 Retrieve a circ object by id
44 @param authtoken Login session key
45 @pararm circid The id of the circ object
49 my( $s, $c, $a, $i ) = @_;
50 my $e = new_editor(authtoken => $a);
51 return $e->event unless $e->checkauth;
52 my $circ = $e->retrieve_action_circulation($i) or return $e->event;
53 if( $e->requestor->id ne $circ->usr ) {
54 return $e->event unless $e->allowed('VIEW_CIRCULATIONS');
60 # ------------------------------------------------------------------------
61 # Returns an array of {circ, record} hashes checked out by the user.
62 # ------------------------------------------------------------------------
63 __PACKAGE__->register_method(
64 method => "checkouts_by_user",
65 api_name => "open-ils.circ.actor.user.checked_out",
67 Returns a list of open circulations as a pile of objects. each object
68 contains the relevant copy, circ, and record
71 sub checkouts_by_user {
72 my( $self, $client, $user_session, $user_id ) = @_;
74 my( $requestor, $target, $copy, $record, $evt );
76 ( $requestor, $target, $evt ) =
77 $apputils->checkses_requestor( $user_session, $user_id, 'VIEW_CIRCULATIONS');
80 my $circs = $apputils->simplereq(
82 "open-ils.cstore.direct.action.open_circulation.search.atomic",
83 { usr => $target->id, checkin_time => undef } );
84 # { usr => $target->id } );
87 for my $circ (@$circs) {
89 ( $copy, $evt ) = $apputils->fetch_copy($circ->target_copy);
92 $logger->debug("Retrieving record for copy " . $circ->target_copy);
94 ($record, $evt) = $apputils->fetch_record_by_copy( $circ->target_copy );
97 my $mods = $apputils->record_to_mvr($record);
99 push( @results, { copy => $copy, circ => $circ, record => $mods } );
108 __PACKAGE__->register_method(
109 method => "checkouts_by_user_slim",
110 api_name => "open-ils.circ.actor.user.checked_out.slim",
111 NOTES => <<" NOTES");
112 Returns a list of open circulation objects
116 sub checkouts_by_user_slim {
117 my( $self, $client, $user_session, $user_id ) = @_;
119 my( $requestor, $target, $copy, $record, $evt );
121 ( $requestor, $target, $evt ) =
122 $apputils->checkses_requestor( $user_session, $user_id, 'VIEW_CIRCULATIONS');
125 $logger->debug( 'User ' . $requestor->id .
126 " retrieving checked out items for user " . $target->id );
128 # XXX Make the call correct..
129 return $apputils->simplereq(
131 "open-ils.cstore.direct.action.open_circulation.search.atomic",
132 { usr => $target->id, checkin_time => undef } );
133 # { usr => $target->id } );
137 __PACKAGE__->register_method(
138 method => "checkouts_by_user_opac",
139 api_name => "open-ils.circ.actor.user.checked_out.opac",);
142 sub checkouts_by_user_opac {
143 my( $self, $client, $auth, $user_id ) = @_;
145 my $e = OpenILS::Utils::Editor->new( authtoken => $auth );
146 return $e->event unless $e->checkauth;
147 $user_id ||= $e->requestor->id;
148 return $e->event unless
149 my $patron = $e->retrieve_actor_user($user_id);
152 my $search = {usr => $user_id, stop_fines => undef};
154 if( $user_id ne $e->requestor->id ) {
155 $data = $e->search_action_circulation(
156 $search, {checkperm=>1, permorg=>$patron->home_ou})
160 $data = $e->search_action_circulation($search);
167 __PACKAGE__->register_method(
168 method => "title_from_transaction",
169 api_name => "open-ils.circ.circ_transaction.find_title",
170 NOTES => <<" NOTES");
171 Returns a mods object for the title that is linked to from the
172 copy from the hold that created the given transaction
175 sub title_from_transaction {
176 my( $self, $client, $login_session, $transactionid ) = @_;
178 my( $user, $circ, $title, $evt );
180 ( $user, $evt ) = $apputils->checkses( $login_session );
183 ( $circ, $evt ) = $apputils->fetch_circulation($transactionid);
186 ($title, $evt) = $apputils->fetch_record_by_copy($circ->target_copy);
189 return $apputils->record_to_mvr($title);
193 __PACKAGE__->register_method(
194 method => "set_circ_lost",
195 api_name => "open-ils.circ.circulation.set_lost",
196 NOTES => <<" NOTES");
197 Params are login, barcode
198 login must have SET_CIRC_LOST perms
199 Sets a circulation to lost
202 __PACKAGE__->register_method(
203 method => "set_circ_lost",
204 api_name => "open-ils.circ.circulation.set_claims_returned",
205 NOTES => <<" NOTES");
206 Params are login, barcode
207 login must have SET_CIRC_MISSING perms
208 Sets a circulation to lost
212 my( $self, $client, $login, $args ) = @_;
213 my( $user, $circ, $copy, $evt );
215 my $barcode = $$args{barcode};
216 my $backdate = $$args{backdate};
218 ( $user, $evt ) = $U->checkses($login);
221 # Grab the related copy
222 ($copy, $evt) = $U->fetch_copy_by_barcode($barcode);
225 my $isclaims = $self->api_name =~ /claims_returned/;
226 my $islost = $self->api_name =~ /lost/;
227 my $session = $U->start_db_session();
229 # grab the circulation
230 ( $circ ) = $U->fetch_open_circulation( $copy->id );
231 return 1 unless $circ;
234 $evt = _set_circ_lost($copy, $circ, $user, $session) if $islost;
239 $evt = _set_circ_claims_returned(
240 $user, $circ, $session, $backdate );
245 $circ->stop_fines_time('now') unless $circ->stop_fines_time;
246 my $s = $session->request(
247 "open-ils.storage.direct.action.circulation.update", $circ )->gather(1);
249 return $U->DB_UPDATE_FAILED($circ) unless defined($s);
250 $U->commit_db_session($session);
256 my( $copy, $circ, $reqr, $session ) = @_;
258 my $evt = $U->check_perms($reqr->id, $circ->circ_lib, 'SET_CIRC_LOST');
261 $logger->activity("user ".$reqr->id." marking copy ".$copy->id.
262 " lost for circ ". $circ->id. " and checking for necessary charges");
264 my $newstat = $U->copy_status_from_name('lost');
265 if( $copy->status ne $newstat->id ) {
267 $copy->status($newstat->id);
271 session => $session);
274 # if the copy has a price defined and/or a processing fee, bill the patron
276 my $copy_price = $copy->price || 0;
278 $logger->debug("lost copy has a price of $copy_price");
280 # If the copy has a price configured, charge said price to the user
281 if($copy_price and $copy_price > 0) {
282 $evt = _make_bill($session, $copy_price, 'Lost Materials', $circ->id);
286 # if the location that owns the copy has a processing fee, charge the user
287 my $owner = $U->fetch_copy_owner($copy->id);
288 $logger->info("circ fetching org settings for $owner to determine processing fee");
290 my $settings = $U->simplereq(
291 'open-ils.actor', 'open-ils.actor.org_unit.settings.retrieve', $owner );
292 my $fee = $settings->{'circ.lost_materials_processing_fee'} || 0;
295 $evt = _make_bill($session, $fee, 'Lost Materials Processing Fee', $circ->id);
299 $circ->stop_fines("LOST");
304 my( $session, $amount, $type, $xactid ) = @_;
306 $logger->activity("The system is charging $amount ".
307 " [$type] for lost materials on circulation $xactid");
309 my $bill = Fieldmapper::money::billing->new;
311 $bill->xact($xactid);
312 $bill->amount($amount);
313 $bill->billing_type($type); # - XXX these strings should be configurable some day
314 $bill->note('SYSTEM GENERATED');
316 my $id = $session->request(
317 'open-ils.storage.direct.money.billing.create', $bill )->gather(1);
319 return $U->DB_UPDATE_FAILED($bill) unless defined $id;
323 sub _set_circ_claims_returned {
324 my( $reqr, $circ, $session, $backdate ) = @_;
326 my $evt = $U->check_perms($reqr->id, $circ->circ_lib, 'SET_CIRC_CLAIMS_RETURNED');
328 $circ->stop_fines("CLAIMSRETURNED");
330 $logger->activity("user ".$reqr->id.
331 " marking circ". $circ->id. " as claims returned");
333 # allow the caller to backdate the circulation and void any fines
334 # that occurred after the backdate
336 OpenILS::Application::Circ::Circulate::_checkin_handle_backdate(
337 $backdate, $circ, $reqr, $session );
345 __PACKAGE__->register_method (
346 method => 'set_circ_due_date',
347 api_name => 'open-ils.circ.circulation.due_date.update',
349 Updates the due_date on the given circ
351 @param circid The id of the circ to update
352 @param date The timestamp of the new due date
356 sub set_circ_due_date {
357 my( $s, $c, $authtoken, $circid, $date ) = @_;
358 my ($circ, $evt) = $U->fetch_circulation($circid);
362 ($reqr, $evt) = $U->checkses($authtoken);
365 $evt = $U->check_perms($reqr->id, $circ->circ_lib, 'CIRC_OVERRIDE_DUE_DATE');
368 $date = clense_ISO8601($date);
369 $logger->activity("user ".$reqr->id.
370 " updating due_date on circ $circid: $date");
372 $circ->due_date($date);
373 my $stat = $U->storagereq(
374 'open-ils.storage.direct.action.circulation.update', $circ);
375 return $U->DB_UPDATE_FAILED unless defined $stat;
380 __PACKAGE__->register_method(
381 method => "create_in_house_use",
382 api_name => 'open-ils.circ.in_house_use.create',
384 Creates an in-house use action.
385 @param $authtoken The login session key
386 @param params A hash of params including
387 'location' The org unit id where the in-house use occurs
388 'copyid' The copy in question
389 'count' The number of in-house uses to apply to this copy
390 @return An array of id's representing the id's of the newly created
391 in-house use objects or an event on an error
394 sub create_in_house_use {
395 my( $self, $client, $authtoken, $params ) = @_;
397 my( $staff, $evt, $copy );
398 my $org = $params->{location};
399 my $copyid = $params->{copyid};
400 my $count = $params->{count} || 1;
401 my $use_time = $params->{use_time} || 'now';
404 my $barcode = $params->{barcode};
405 ($copy, $evt) = $U->fetch_copy_by_barcode($barcode);
410 ($staff, $evt) = $U->checkses($authtoken);
413 ($copy, $evt) = $U->fetch_copy($copyid) unless $copy;
416 $evt = $U->check_perms($staff->id, $org, 'CREATE_IN_HOUSE_USE');
419 $logger->activity("User " . $staff->id .
420 " creating $count in-house use(s) for copy $copyid at location $org");
422 if( $use_time ne 'now' ) {
423 $use_time = clense_ISO8601($use_time);
424 $logger->debug("in_house_use setting use time to $use_time");
429 my $ihu = Fieldmapper::action::in_house_use->new;
432 $ihu->staff($staff->id);
433 $ihu->org_unit($org);
434 $ihu->use_time($use_time);
436 my $id = $U->simplereq(
438 'open-ils.storage.direct.action.in_house_use.create', $ihu );
440 return $U->DB_UPDATE_FAILED($ihu) unless $id;
449 __PACKAGE__->register_method(
450 method => "view_circs",
451 api_name => "open-ils.circ.copy_checkout_history.retrieve",
453 Retrieves the last X circs for a given copy
454 @param authtoken The login session key
455 @param copyid The copy to check
456 @param count How far to go back in the item history
457 @return An array of circ ids
463 my( $self, $client, $authtoken, $copyid, $count ) = @_;
465 my( $requestor, $evt ) = $U->checksesperm(
466 $authtoken, 'VIEW_COPY_CHECKOUT_HISTORY' );
469 return [] unless $count;
471 my $circs = $U->cstorereq(
472 'open-ils.cstore.direct.action.circulation.search.atomic',
474 target_copy => $copyid,
478 order_by => { ac => "xact_start DESC" }
486 __PACKAGE__->register_method(
487 method => "circ_count",
488 api_name => "open-ils.circ.circulation.count",
490 Returns the number of times the item has circulated
491 @param copyid The copy to check
495 my( $self, $client, $copyid, $range ) = @_;
496 my $e = OpenILS::Utils::Editor->new;
497 return $e->request('open-ils.storage.asset.copy.circ_count', $copyid, $range);
502 __PACKAGE__->register_method(
503 method => 'fetch_notes',
504 api_name => 'open-ils.circ.copy_note.retrieve.all',
506 Returns an array of copy note objects.
507 @param args A named hash of parameters including:
508 authtoken : Required if viewing non-public notes
509 itemid : The id of the item whose notes we want to retrieve
510 pub : True if all the caller wants are public notes
511 @return An array of note objects
514 __PACKAGE__->register_method(
515 method => 'fetch_notes',
516 api_name => 'open-ils.circ.call_number_note.retrieve.all',
517 signature => q/@see open-ils.circ.copy_note.retrieve.all/);
519 __PACKAGE__->register_method(
520 method => 'fetch_notes',
521 api_name => 'open-ils.circ.title_note.retrieve.all',
522 signature => q/@see open-ils.circ.copy_note.retrieve.all/);
525 # NOTE: VIEW_COPY/VOLUME/TITLE_NOTES perms should always be global
527 my( $self, $connection, $args ) = @_;
529 my $id = $$args{itemid};
530 my $authtoken = $$args{authtoken};
533 if( $self->api_name =~ /copy/ ) {
535 return $U->cstorereq(
536 'open-ils.cstore.direct.asset.copy_note.search.atomic',
537 { owning_copy => $id, pub => 't' } );
539 ( $r, $evt ) = $U->checksesperm($authtoken, 'VIEW_COPY_NOTES');
541 return $U->cstorereq(
542 'open-ils.cstore.direct.asset.copy_note.search.atomic', {owning_copy => $id} );
545 } elsif( $self->api_name =~ /call_number/ ) {
547 return $U->cstorereq(
548 'open-ils.cstore.direct.asset.call_number_note.search.atomic',
549 { call_number => $id, pub => 't' } );
551 ( $r, $evt ) = $U->checksesperm($authtoken, 'VIEW_VOLUME_NOTES');
553 return $U->cstorereq(
554 'open-ils.cstore.direct.asset.call_number_note.search.atomic', { call_number => $id } );
557 } elsif( $self->api_name =~ /title/ ) {
559 return $U->cstorereq(
560 'open-ils.cstore.direct.bilbio.record_note.search.atomic',
561 { record => $id, pub => 't' } );
563 ( $r, $evt ) = $U->checksesperm($authtoken, 'VIEW_TITLE_NOTES');
565 return $U->cstorereq(
566 'open-ils.cstore.direct.biblio.record_note.search.atomic', { record => $id } );
573 __PACKAGE__->register_method(
574 method => 'has_notes',
575 api_name => 'open-ils.circ.copy.has_notes');
576 __PACKAGE__->register_method(
577 method => 'has_notes',
578 api_name => 'open-ils.circ.call_number.has_notes');
579 __PACKAGE__->register_method(
580 method => 'has_notes',
581 api_name => 'open-ils.circ.title.has_notes');
585 my( $self, $conn, $authtoken, $id ) = @_;
586 my $editor = OpenILS::Utils::Editor->new(authtoken => $authtoken);
587 return $editor->event unless $editor->checkauth;
589 my $n = $editor->search_asset_copy_note(
590 {owning_copy=>$id}, {idlist=>1}) if $self->api_name =~ /copy/;
592 $n = $editor->search_asset_call_number_note(
593 {call_number=>$id}, {idlist=>1}) if $self->api_name =~ /call_number/;
595 $n = $editor->search_biblio_record_note(
596 {record=>$id}, {idlist=>1}) if $self->api_name =~ /title/;
601 __PACKAGE__->register_method(
602 method => 'create_copy_note',
603 api_name => 'open-ils.circ.copy_note.create',
605 Creates a new copy note
606 @param authtoken The login session key
607 @param note The note object to create
608 @return The id of the new note object
611 sub create_copy_note {
612 my( $self, $connection, $authtoken, $note ) = @_;
613 my( $cnowner, $requestor, $evt );
615 ($cnowner, $evt) = $U->fetch_copy_owner($note->owning_copy);
617 ($requestor, $evt) = $U->checkses($authtoken);
619 $evt = $U->check_perms($requestor->id, $cnowner, 'CREATE_COPY_NOTE');
622 $note->create_date('now');
623 $note->creator($requestor->id);
624 $note->pub( ($note->pub) ? 't' : 'f' );
626 my $id = $U->storagereq(
627 'open-ils.storage.direct.asset.copy_note.create', $note );
628 return $U->DB_UPDATE_FAILED($note) unless $id;
630 $logger->activity("User ".$requestor->id." created a new copy ".
631 "note [$id] for copy ".$note->owning_copy." with text ".$note->value);
636 __PACKAGE__->register_method(
637 method => 'delete_copy_note',
638 api_name => 'open-ils.circ.copy_note.delete',
640 Deletes an existing copy note
641 @param authtoken The login session key
642 @param noteid The id of the note to delete
643 @return 1 on success - Event otherwise.
646 sub delete_copy_note {
647 my( $self, $conn, $authtoken, $noteid ) = @_;
648 my( $requestor, $note, $owner, $evt );
650 ($requestor, $evt) = $U->checkses($authtoken);
653 ($note, $evt) = $U->fetch_copy_note($noteid);
656 if( $note->creator ne $requestor->id ) {
657 ($owner, $evt) = $U->fetch_copy_onwer($note->owning_copy);
659 $evt = $U->check_perms($requestor->id, $owner, 'DELETE_COPY_NOTE');
663 my $stat = $U->storagereq(
664 'open-ils.storage.direct.asset.copy_note.delete', $noteid );
665 return $U->DB_UPDATE_FAILED($noteid) unless $stat;
667 $logger->activity("User ".$requestor->id." deleted copy note $noteid");
672 __PACKAGE__->register_method(
673 method => 'age_hold_rules',
674 api_name => 'open-ils.circ.config.rules.age_hold_protect.retrieve.all',
678 my( $self, $conn ) = @_;
679 return new_editor()->retrieve_all_config_rules_age_hold_protect();