1 package OpenILS::Application::Cat::AssetCommon;
2 use strict; use warnings;
3 use OpenILS::Application::Cat::BibCommon;
4 use OpenILS::Utils::CStoreEditor q/:funcs/;
5 use OpenSRF::Utils::Logger qw($logger);
6 use OpenILS::Application::Cat::Merge;
7 use OpenILS::Application::AppUtils;
8 use OpenILS::Utils::Fieldmapper;
9 use OpenILS::Const qw/:const/;
10 use OpenSRF::AppSession;
12 use OpenILS::Application::Circ::CircCommon;
13 my $U = 'OpenILS::Application::AppUtils';
16 # ---------------------------------------------------------------------------
17 # Shared copy mangling code. Do not publish methods from here.
18 # ---------------------------------------------------------------------------
20 sub org_cannot_have_vols {
21 my($class, $e, $org_id) = @_;
22 my $org = $e->retrieve_actor_org_unit([
25 flesh_fields => {aou => ['ou_type']}
26 }]) or return $e->event;
28 return OpenILS::Event->new('ORG_CANNOT_HAVE_VOLS')
29 unless $U->is_true($org->ou_type->can_have_vols);
38 if(defined $copy->price) {
39 my $p = $copy->price || 0;
44 my $d = $copy->deposit_amount || 0;
46 $copy->deposit_amount($d);
50 my($class, $editor, $vol, $copy) = @_;
52 my $existing = $editor->search_asset_copy(
53 { barcode => $copy->barcode, deleted => 'f' } );
55 return OpenILS::Event->new('ITEM_BARCODE_EXISTS') if @$existing;
57 # see if the volume this copy references is marked as deleted
58 return OpenILS::Event->new('VOLUME_DELETED', vol => $vol->id)
59 if $U->is_true($vol->deleted);
62 my $org = (ref $copy->circ_lib) ? $copy->circ_lib->id : $copy->circ_lib;
63 return $evt if ($evt = $class->org_cannot_have_vols($editor, $org));
66 $copy->editor($editor->requestor->id);
67 $copy->creator($editor->requestor->id);
68 $copy->create_date('now');
69 $copy->call_number($vol->id);
70 $class->fix_copy_price($copy);
72 $editor->create_asset_copy($copy) or return $editor->die_event;
77 # if 'delete_stats' is true, the copy->stat_cat_entries data is
78 # treated as the authoritative list for the copy. existing entries
79 # that are not in said list will be deleted from the DB
80 sub update_copy_stat_entries {
81 my($class, $editor, $copy, $delete_stats) = @_;
83 return undef if $copy->isdeleted;
84 return undef unless $copy->ischanged or $copy->isnew;
87 my $entries = $copy->stat_cat_entries;
90 $entries = ($entries and @$entries) ? $entries : [];
92 return undef unless ($entries and @$entries);
95 my $maps = $editor->search_asset_stat_cat_entry_copy_map({owning_copy=>$copy->id});
98 # if there is no stat cat entry on the copy who's id matches the
99 # current map's id, remove the map from the database
100 for my $map (@$maps) {
101 if(! grep { $_->id == $map->stat_cat_entry } @$entries ) {
103 $logger->info("copy update found stale ".
104 "stat cat entry map ".$map->id. " on copy ".$copy->id);
106 $editor->delete_asset_stat_cat_entry_copy_map($map)
107 or return $editor->event;
112 # go through the stat cat update/create process
113 for my $entry (@$entries) {
116 # if this link already exists in the DB, don't attempt to re-create it
117 next if( grep{$_->stat_cat_entry == $entry->id} @$maps );
119 my $new_map = Fieldmapper::asset::stat_cat_entry_copy_map->new();
121 my $sc = ref($entry->stat_cat) ? $entry->stat_cat->id : $entry->stat_cat;
123 $new_map->stat_cat( $sc );
124 $new_map->stat_cat_entry( $entry->id );
125 $new_map->owning_copy( $copy->id );
127 $editor->create_asset_stat_cat_entry_copy_map($new_map)
128 or return $editor->event;
130 $logger->info("copy update created new stat cat entry map ".$editor->data);
136 # if 'delete_maps' is true, the copy->parts data is treated as the
137 # authoritative list for the copy. existing part maps not targeting
138 # these parts will be deleted from the DB
139 sub update_copy_parts {
140 my($class, $editor, $copy, $delete_maps) = @_;
142 return undef if $copy->isdeleted;
143 return undef unless $copy->ischanged or $copy->isnew;
146 my $incoming_parts = $copy->parts;
149 $incoming_parts = ($incoming_parts and @$incoming_parts) ? $incoming_parts : [];
151 return undef unless ($incoming_parts and @$incoming_parts);
154 my $maps = $editor->search_asset_copy_part_map({target_copy=>$copy->id});
157 # if there is no part map on the copy who's id matches the
158 # current map's id, remove the map from the database
159 for my $map (@$maps) {
160 if(! grep { $_->id == $map->part } @$incoming_parts ) {
162 $logger->info("copy update found stale ".
163 "monographic part map ".$map->id. " on copy ".$copy->id);
165 $editor->delete_asset_copy_part_map($map)
166 or return $editor->event;
171 # go through the part map update/create process
172 for my $incoming_part (@$incoming_parts) {
173 next unless $incoming_part;
175 # if this link already exists in the DB, don't attempt to re-create it
176 next if( grep{$_->part == $incoming_part->id} @$maps );
178 my $new_map = Fieldmapper::asset::copy_part_map->new();
180 $new_map->part( $incoming_part->id );
181 $new_map->target_copy( $copy->id );
183 $editor->create_asset_copy_part_map($new_map)
184 or return $editor->event;
186 $logger->info("copy update created new monographic part copy map ".$editor->data);
195 my($class, $editor, $override, $vol, $copy, $retarget_holds, $force_delete_empty_bib) = @_;
198 my $org = (ref $copy->circ_lib) ? $copy->circ_lib->id : $copy->circ_lib;
199 return $evt if ( $evt = $class->org_cannot_have_vols($editor, $org) );
201 $logger->info("vol-update: updating copy ".$copy->id);
202 my $orig_copy = $editor->retrieve_asset_copy($copy->id);
204 # Call-number may have changed, find the original
205 my $orig_vol_id = $editor->json_query({select => {acp => ['call_number']}, from => 'acp', where => {id => $copy->id}});
206 my $orig_vol = $editor->retrieve_asset_call_number($orig_vol_id->[0]->{call_number});
208 $copy->editor($editor->requestor->id);
209 $copy->edit_date('now');
211 $copy->age_protect( $copy->age_protect->id )
212 if ref $copy->age_protect;
214 $class->fix_copy_price($copy);
215 $class->check_hold_retarget($editor, $copy, $orig_copy, $retarget_holds);
217 return $editor->event unless $editor->update_asset_copy($copy);
218 return $class->remove_empty_objects($editor, $override, $orig_vol, $force_delete_empty_bib);
221 sub check_hold_retarget {
222 my($class, $editor, $copy, $orig_copy, $retarget_holds) = @_;
223 return unless $retarget_holds;
225 if( !($copy->isdeleted or $U->is_true($copy->deleted)) ) {
226 # see if a status change warrants a retarget
228 $orig_copy = $editor->retrieve_asset_copy($copy->id) unless $orig_copy;
230 if($orig_copy->status == $copy->status) {
231 # no status change, no retarget
235 my $stat = $editor->retrieve_config_copy_status($copy->status);
237 # new status is holdable, no retarget. Later add logic to find potential
238 # holds and retarget those to pick up the newly available copy
239 return if $U->is_true($stat->holdable);
242 my $hold_ids = $editor->search_action_hold_request(
243 { current_copy => $copy->id,
244 cancel_time => undef,
245 fulfillment_time => undef
249 push(@$retarget_holds, @$hold_ids);
253 # this does the actual work
254 sub update_fleshed_copies {
255 my($class, $editor, $override, $vol, $copies, $delete_stats, $retarget_holds, $force_delete_empty_bib) = @_;
258 my $fetchvol = ($vol) ? 0 : 1;
261 $cache{$vol->id} = $vol if $vol;
263 for my $copy (@$copies) {
265 my $copyid = $copy->id;
266 $logger->info("vol-update: inspecting copy $copyid");
268 if( !($vol = $cache{$copy->call_number}) ) {
269 $vol = $cache{$copy->call_number} =
270 $editor->retrieve_asset_call_number($copy->call_number);
271 return $editor->event unless $vol;
274 return $editor->event unless
275 $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
277 $copy->editor($editor->requestor->id);
278 $copy->edit_date('now');
280 $copy->status( $copy->status->id ) if ref($copy->status);
281 $copy->location( $copy->location->id ) if ref($copy->location);
282 $copy->circ_lib( $copy->circ_lib->id ) if ref($copy->circ_lib);
284 my $sc_entries = $copy->stat_cat_entries;
285 $copy->clear_stat_cat_entries;
287 my $parts = $copy->parts;
290 if( $copy->isdeleted ) {
291 $evt = $class->delete_copy($editor, $override, $vol, $copy, $retarget_holds, $force_delete_empty_bib);
294 } elsif( $copy->isnew ) {
295 $evt = $class->create_copy( $editor, $vol, $copy );
298 } elsif( $copy->ischanged ) {
300 $evt = $class->update_copy( $editor, $override, $vol, $copy, $retarget_holds, $force_delete_empty_bib);
304 $copy->stat_cat_entries( $sc_entries );
305 $evt = $class->update_copy_stat_entries($editor, $copy, $delete_stats);
306 $copy->parts( $parts );
307 # probably okay to use $delete_stats here for simplicity
308 $evt = $class->update_copy_parts($editor, $copy, $delete_stats);
312 $logger->debug("vol-update: done updating copy batch");
319 my($class, $editor, $override, $vol, $copy, $retarget_holds, $force_delete_empty_bib, $skip_empty_cleanup) = @_;
321 return $editor->event unless
322 $editor->allowed('DELETE_COPY', $class->copy_perm_org($vol, $copy));
324 my $stat = $U->copy_status($copy->status)->id;
327 return OpenILS::Event->new('COPY_DELETE_WARNING', payload => $copy->id )
328 if $stat == OILS_COPY_STATUS_CHECKED_OUT or
329 $stat == OILS_COPY_STATUS_IN_TRANSIT or
330 $stat == OILS_COPY_STATUS_ON_HOLDS_SHELF or
331 $stat == OILS_COPY_STATUS_ILL;
334 $logger->info("vol-update: deleting copy ".$copy->id);
337 $copy->editor($editor->requestor->id);
338 $copy->edit_date('now');
339 $editor->update_asset_copy($copy) or return $editor->event;
341 # Delete any open transits for this copy
342 my $transits = $editor->search_action_transit_copy(
343 { target_copy=>$copy->id, dest_recv_time => undef } );
345 for my $t (@$transits) {
346 $editor->delete_action_transit_copy($t)
347 or return $editor->event;
350 my $evt = $class->cancel_copy_holds($editor, $copy);
353 $class->check_hold_retarget($editor, $copy, undef, $retarget_holds);
355 return undef if $skip_empty_cleanup;
357 return $class->remove_empty_objects($editor, $override, $vol, $force_delete_empty_bib);
361 # deletes all holds that specifically target the deleted copy
362 sub cancel_copy_holds {
363 my($class, $editor, $copy) = @_;
365 my $holds = $editor->search_action_hold_request({
367 hold_type => [qw/C R F/],
368 cancel_time => undef,
369 fulfillment_time => undef
372 return $class->cancel_hold_list($editor, $holds);
375 # deletes all holds that specifically target the deleted volume
376 sub cancel_volume_holds {
377 my($class, $editor, $volume) = @_;
379 my $holds = $editor->search_action_hold_request({
380 target => $volume->id,
382 cancel_time => undef,
383 fulfillment_time => undef
386 return $class->cancel_hold_list($editor, $holds);
389 sub cancel_hold_list {
390 my($class, $editor, $holds) = @_;
392 for my $hold (@$holds) {
394 $hold->cancel_time('now');
395 $hold->cancel_cause(1); # un-targeted expiration. Do we need an alternate "target deleted" cause?
396 $editor->update_action_hold_request($hold) or return $editor->die_event;
398 # delete the copy maps.
399 my $maps = $editor->search_action_hold_copy_map({hold => $hold->id});
401 $editor->delete_action_hold_copy_map($_)
402 or return $editor->die_event;
405 # tell A/T the hold was cancelled. Don't wait for a response..
406 my $at_ses = OpenSRF::AppSession->create('open-ils.trigger');
408 'open-ils.trigger.event.autocreate',
409 'hold_request.cancel.expire_no_target',
410 $hold, $hold->pickup_lib);
419 my($class, $override, $editor, $vol) = @_;
422 return $evt if ( $evt = $class->org_cannot_have_vols($editor, $vol->owning_lib) );
424 # see if the record this volume references is marked as deleted
425 my $rec = $editor->retrieve_biblio_record_entry($vol->record)
426 or return $editor->die_event;
427 return OpenILS::Event->new('BIB_RECORD_DELETED', rec => $rec->id)
428 if $U->is_true($rec->deleted);
430 # first lets see if there are any collisions
431 my $vols = $editor->search_asset_call_number( {
432 owning_lib => $vol->owning_lib,
433 record => $vol->record,
434 label => $vol->label,
435 prefix => $vol->prefix,
436 suffix => $vol->suffix,
443 # we've found an exising volume
445 $label = $vol->label;
447 return OpenILS::Event->new(
448 'VOLUME_LABEL_EXISTS', payload => $vol->id);
452 # create a temp label so we can create the new volume,
453 # then de-dup it with the existing volume
454 $vol->label( "__SYSTEM_TMP_$$".time) if $label;
456 $vol->creator($editor->requestor->id);
457 $vol->create_date('now');
458 $vol->editor($editor->requestor->id);
459 $vol->edit_date('now');
462 $editor->create_asset_call_number($vol) or return $editor->die_event;
465 # now restore the label and merge into the existing record
468 OpenILS::Application::Cat::Merge::merge_volumes($editor, [$vol], $$vols[0]);
475 # returns the volume if it exists
477 my($class, $e, $rec_id, $label, $owning_lib, $prefix, $suffix) = @_;
478 return $e->search_asset_call_number(
479 {label => $label, record => $rec_id, owning_lib => $owning_lib, deleted => 'f', prefix => $prefix, suffix => $suffix})->[0];
482 sub find_or_create_volume {
483 my($class, $e, $label, $record_id, $org_id, $prefix, $suffix, $label_class) = @_;
490 if($record_id == OILS_PRECAT_RECORD) {
491 $vol = $e->retrieve_asset_call_number(OILS_PRECAT_CALL_NUMBER)
492 or return (undef, $e->die_event);
495 $vol = $class->volume_exists($e, $record_id, $label, $org_id, $prefix, $suffix);
498 # If the volume exists, return the ID
499 return ($vol, undef, 1) if $vol;
501 # -----------------------------------------------------------------
502 # Otherwise, create a new volume with the given attributes
503 # -----------------------------------------------------------------
504 return (undef, $e->die_event) unless $e->allowed('UPDATE_VOLUME', $org_id);
506 $vol = Fieldmapper::asset::call_number->new;
507 $vol->owning_lib($org_id);
508 $vol->label_class($label_class) if ($label_class);
510 $vol->prefix($prefix);
511 $vol->suffix($suffix);
512 $vol->record($record_id);
514 my $evt = $class->create_volume(0, $e, $vol);
515 return (undef, $evt) if $evt;
521 sub create_copy_note {
522 my($class, $e, $copy, $title, $value, $pub) = @_;
523 my $note = Fieldmapper::asset::copy_note->new;
524 $note->owning_copy($copy->id);
525 $note->creator($e->requestor->id);
526 $note->pub($pub ? 't' : 'f');
527 $note->value($value);
528 $note->title($title);
529 $e->create_asset_copy_note($note) or return $e->die_event;
534 sub remove_empty_objects {
535 my($class, $editor, $override, $vol, $force_delete_empty_bib) = @_;
537 my $koe = $U->ou_ancestor_setting_value(
538 $editor->requestor->ws_ou, 'cat.bib.keep_on_empty', $editor);
539 my $aoe = $U->ou_ancestor_setting_value(
540 $editor->requestor->ws_ou, 'cat.bib.alert_on_empty', $editor);
542 if( OpenILS::Application::Cat::BibCommon->title_is_empty($editor, $vol->record, $vol->id) ) {
544 # delete this volume if it's not already marked as deleted
545 unless( $U->is_true($vol->deleted) || $vol->isdeleted ) {
546 my $evt = $class->delete_volume($editor, $vol, $override, 0, 1);
550 return OpenILS::Event->new('TITLE_LAST_COPY', payload => $vol->record )
551 if $aoe and not $override and not $force_delete_empty_bib;
553 unless($koe and not $force_delete_empty_bib) {
554 # delete the bib record if the keep-on-empty setting is not set (and we're not otherwise forcing things, say through acq settings)
555 my $evt = OpenILS::Application::Cat::BibCommon->delete_rec($editor, $vol->record);
561 # this may be the last copy attached to the volume.
563 if($U->ou_ancestor_setting_value(
564 $editor->requestor->ws_ou, 'cat.volume.delete_on_empty', $editor)) {
566 # if this volume is "empty" and not mid-delete, delete it.
567 unless($U->is_true($vol->deleted) || $vol->isdeleted) {
569 my $copies = $editor->search_asset_copy(
570 [{call_number => $vol->id, deleted => 'f'}, {limit => 1}], {idlist => 1});
573 my $evt = $class->delete_volume($editor, $vol, $override, 0, 1);
583 # Deletes a volume. Returns undef on success, event on error
584 # force : deletes all attached copies
585 # skip_copy_check : assumes caller has verified no copies need deleting first
587 my($class, $editor, $vol, $override, $delete_copies, $skip_copy_checks) = @_;
590 unless($skip_copy_checks) {
591 my $cs = $editor->search_asset_copy(
592 [{call_number => $vol->id, deleted => 'f'}, {limit => 1}], {idlist => 1});
594 return OpenILS::Event->new('VOLUME_NOT_EMPTY', payload => $vol->id)
595 if @$cs and !$delete_copies;
597 my $copies = $editor->search_asset_copy({call_number => $vol->id, deleted => 'f'});
599 for my $copy (@$copies) {
600 $evt = $class->delete_copy($editor, $override, $vol, $copy, 0, 0, 1);
606 $vol->edit_date('now');
607 $vol->editor($editor->requestor->id);
608 $editor->update_asset_call_number($vol) or return $editor->die_event;
610 $evt = $class->cancel_volume_holds($editor, $vol);
613 # handle the case where this is the last volume on the record
614 return $class->remove_empty_objects($editor, $override, $vol);
619 my($class, $vol, $copy) = @_;
620 my $org = $vol->owning_lib;
621 if( $vol->id == OILS_PRECAT_CALL_NUMBER ) {
622 $org = ref($copy->circ_lib) ? $copy->circ_lib->id : $copy->circ_lib;
624 $logger->debug("using copy perm org $org");
630 my($class, $e, $copy_id) = @_;
632 my $copy = $e->retrieve_asset_copy([
634 {flesh => 1, flesh_fields => {'acp' => ['call_number']}}])
635 or return $e->die_event;
638 ($copy->call_number->id == OILS_PRECAT_CALL_NUMBER) ?
639 $copy->circ_lib : $copy->call_number->owning_lib;
641 my $circ = $e->search_action_circulation(
642 {checkin_time => undef, target_copy => $copy->id} )->[0]
643 or return $e->die_event;
645 $e->allowed('SET_CIRC_LOST', $circ->circ_lib) or return $e->die_event;
647 return $e->die_event(OpenILS::Event->new('COPY_MARKED_LOST'))
648 if $copy->status == OILS_COPY_STATUS_LOST;
650 # ---------------------------------------------------------------------
651 # fetch the related org settings
652 my $proc_fee = $U->ou_ancestor_setting_value(
653 $owning_lib, OILS_SETTING_LOST_PROCESSING_FEE, $e) || 0;
654 my $void_overdue = $U->ou_ancestor_setting_value(
655 $owning_lib, OILS_SETTING_VOID_OVERDUE_ON_LOST, $e) || 0;
657 # ---------------------------------------------------------------------
658 # move the copy into LOST status
659 $copy->status(OILS_COPY_STATUS_LOST);
660 $copy->editor($e->requestor->id);
661 $copy->edit_date('now');
662 $e->update_asset_copy($copy) or return $e->die_event;
664 my $price = $U->get_copy_price($e, $copy, $copy->call_number);
667 my $evt = OpenILS::Application::Circ::CircCommon->create_bill(
668 $e, $price, 3, 'Lost Materials', $circ->id);
672 # ---------------------------------------------------------------------
673 # if there is a processing fee, charge that too
674 if( $proc_fee > 0 ) {
675 my $evt = OpenILS::Application::Circ::CircCommon->create_bill(
676 $e, $proc_fee, 4, 'Lost Materials Processing Fee', $circ->id);
680 # ---------------------------------------------------------------------
681 # mark the circ as lost and stop the fines
682 $circ->stop_fines(OILS_STOP_FINES_LOST);
683 $circ->stop_fines_time('now') unless $circ->stop_fines_time;
684 $e->update_action_circulation($circ) or return $e->die_event;
686 # ---------------------------------------------------------------------
687 # void all overdue fines on this circ if configured
688 if( $void_overdue ) {
689 my $evt = OpenILS::Application::Circ::CircCommon->void_overdues($e, $circ);
693 my $evt = OpenILS::Application::Circ::CircCommon->reopen_xact($e, $circ->id);
696 my $ses = OpenSRF::AppSession->create('open-ils.trigger');
697 $ses->request('open-ils.trigger.event.autocreate', 'lost', $circ, $circ->circ_lib);
699 my $evt2 = OpenILS::Utils::Penalty->calculate_penalties($e, $circ->usr, $U->xact_org($circ->id,$e));
700 return $evt2 if $evt2;