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 = OpenILS::Application::Cat::AssetCommon->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 = OpenILS::Application::Cat::AssetCommon->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);
203 my $orig_vol = $editor->retrieve_asset_call_number($copy->call_number);
205 $copy->editor($editor->requestor->id);
206 $copy->edit_date('now');
208 $copy->age_protect( $copy->age_protect->id )
209 if ref $copy->age_protect;
211 $class->fix_copy_price($copy);
212 $class->check_hold_retarget($editor, $copy, $orig_copy, $retarget_holds);
214 return $editor->event unless $editor->update_asset_copy($copy);
215 return $class->remove_empty_objects($editor, $override, $orig_vol, $force_delete_empty_bib);
218 sub check_hold_retarget {
219 my($class, $editor, $copy, $orig_copy, $retarget_holds) = @_;
220 return unless $retarget_holds;
222 if( !($copy->isdeleted or $U->is_true($copy->deleted)) ) {
223 # see if a status change warrants a retarget
225 $orig_copy = $editor->retrieve_asset_copy($copy->id) unless $orig_copy;
227 if($orig_copy->status == $copy->status) {
228 # no status change, no retarget
232 my $stat = $editor->retrieve_config_copy_status($copy->status);
234 # new status is holdable, no retarget. Later add logic to find potential
235 # holds and retarget those to pick up the newly available copy
236 return if $U->is_true($stat->holdable);
239 my $hold_ids = $editor->search_action_hold_request(
240 { current_copy => $copy->id,
241 cancel_time => undef,
242 fulfillment_time => undef
246 push(@$retarget_holds, @$hold_ids);
250 # this does the actual work
251 sub update_fleshed_copies {
252 my($class, $editor, $override, $vol, $copies, $delete_stats, $retarget_holds, $force_delete_empty_bib) = @_;
255 my $fetchvol = ($vol) ? 0 : 1;
258 $cache{$vol->id} = $vol if $vol;
260 for my $copy (@$copies) {
262 my $copyid = $copy->id;
263 $logger->info("vol-update: inspecting copy $copyid");
265 if( !($vol = $cache{$copy->call_number}) ) {
266 $vol = $cache{$copy->call_number} =
267 $editor->retrieve_asset_call_number($copy->call_number);
268 return $editor->event unless $vol;
271 return $editor->event unless
272 $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
274 $copy->editor($editor->requestor->id);
275 $copy->edit_date('now');
277 $copy->status( $copy->status->id ) if ref($copy->status);
278 $copy->location( $copy->location->id ) if ref($copy->location);
279 $copy->circ_lib( $copy->circ_lib->id ) if ref($copy->circ_lib);
281 my $sc_entries = $copy->stat_cat_entries;
282 $copy->clear_stat_cat_entries;
284 my $parts = $copy->parts;
287 if( $copy->isdeleted ) {
288 $evt = $class->delete_copy($editor, $override, $vol, $copy, $retarget_holds, $force_delete_empty_bib);
291 } elsif( $copy->isnew ) {
292 $evt = $class->create_copy( $editor, $vol, $copy );
295 } elsif( $copy->ischanged ) {
297 $evt = $class->update_copy( $editor, $override, $vol, $copy, $retarget_holds, $force_delete_empty_bib);
301 $copy->stat_cat_entries( $sc_entries );
302 $evt = $class->update_copy_stat_entries($editor, $copy, $delete_stats);
303 $copy->parts( $parts );
304 # probably okay to use $delete_stats here for simplicity
305 $evt = $class->update_copy_parts($editor, $copy, $delete_stats);
309 $logger->debug("vol-update: done updating copy batch");
316 my($class, $editor, $override, $vol, $copy, $retarget_holds, $force_delete_empty_bib) = @_;
318 return $editor->event unless
319 $editor->allowed('DELETE_COPY', $class->copy_perm_org($vol, $copy));
321 my $stat = $U->copy_status($copy->status)->id;
324 return OpenILS::Event->new('COPY_DELETE_WARNING', payload => $copy->id )
325 if $stat == OILS_COPY_STATUS_CHECKED_OUT or
326 $stat == OILS_COPY_STATUS_IN_TRANSIT or
327 $stat == OILS_COPY_STATUS_ON_HOLDS_SHELF or
328 $stat == OILS_COPY_STATUS_ILL;
331 $logger->info("vol-update: deleting copy ".$copy->id);
334 $copy->editor($editor->requestor->id);
335 $copy->edit_date('now');
336 $editor->update_asset_copy($copy) or return $editor->event;
338 # Delete any open transits for this copy
339 my $transits = $editor->search_action_transit_copy(
340 { target_copy=>$copy->id, dest_recv_time => undef } );
342 for my $t (@$transits) {
343 $editor->delete_action_transit_copy($t)
344 or return $editor->event;
347 $class->check_hold_retarget($editor, $copy, undef, $retarget_holds);
349 return $class->remove_empty_objects($editor, $override, $vol, $force_delete_empty_bib);
355 my($class, $override, $editor, $vol) = @_;
358 return $evt if ( $evt = $class->org_cannot_have_vols($editor, $vol->owning_lib) );
360 # see if the record this volume references is marked as deleted
361 my $rec = $editor->retrieve_biblio_record_entry($vol->record)
362 or return $editor->die_event;
363 return OpenILS::Event->new('BIB_RECORD_DELETED', rec => $rec->id)
364 if $U->is_true($rec->deleted);
366 # first lets see if there are any collisions
367 my $vols = $editor->search_asset_call_number( {
368 owning_lib => $vol->owning_lib,
369 record => $vol->record,
370 label => $vol->label,
371 prefix => $vol->prefix,
372 suffix => $vol->suffix,
379 # we've found an exising volume
381 $label = $vol->label;
383 return OpenILS::Event->new(
384 'VOLUME_LABEL_EXISTS', payload => $vol->id);
388 # create a temp label so we can create the new volume,
389 # then de-dup it with the existing volume
390 $vol->label( "__SYSTEM_TMP_$$".time) if $label;
392 $vol->creator($editor->requestor->id);
393 $vol->create_date('now');
394 $vol->editor($editor->requestor->id);
395 $vol->edit_date('now');
398 $editor->create_asset_call_number($vol) or return $editor->die_event;
401 # now restore the label and merge into the existing record
404 OpenILS::Application::Cat::Merge::merge_volumes($editor, [$vol], $$vols[0]);
411 # returns the volume if it exists
413 my($class, $e, $rec_id, $label, $owning_lib, $prefix, $suffix) = @_;
414 return $e->search_asset_call_number(
415 {label => $label, record => $rec_id, owning_lib => $owning_lib, deleted => 'f', prefix => $prefix, suffix => $suffix})->[0];
418 sub find_or_create_volume {
419 my($class, $e, $label, $record_id, $org_id, $prefix, $suffix, $label_class) = @_;
426 if($record_id == OILS_PRECAT_RECORD) {
427 $vol = $e->retrieve_asset_call_number(OILS_PRECAT_CALL_NUMBER)
428 or return (undef, $e->die_event);
431 $vol = $class->volume_exists($e, $record_id, $label, $org_id, $prefix, $suffix);
434 # If the volume exists, return the ID
435 return ($vol, undef, 1) if $vol;
437 # -----------------------------------------------------------------
438 # Otherwise, create a new volume with the given attributes
439 # -----------------------------------------------------------------
440 return (undef, $e->die_event) unless $e->allowed('UPDATE_VOLUME', $org_id);
442 $vol = Fieldmapper::asset::call_number->new;
443 $vol->owning_lib($org_id);
444 $vol->label_class($label_class) if ($label_class);
446 $vol->prefix($prefix);
447 $vol->suffix($suffix);
448 $vol->record($record_id);
450 my $evt = OpenILS::Application::Cat::AssetCommon->create_volume(0, $e, $vol);
451 return (undef, $evt) if $evt;
457 sub create_copy_note {
458 my($class, $e, $copy, $title, $value, $pub) = @_;
459 my $note = Fieldmapper::asset::copy_note->new;
460 $note->owning_copy($copy->id);
461 $note->creator($e->requestor->id);
463 $note->value($value);
464 $note->title($title);
465 $e->create_asset_copy_note($note) or return $e->die_event;
470 sub remove_empty_objects {
471 my($class, $editor, $override, $vol, $force_delete_empty_bib) = @_;
473 my $koe = $U->ou_ancestor_setting_value(
474 $editor->requestor->ws_ou, 'cat.bib.keep_on_empty', $editor);
475 my $aoe = $U->ou_ancestor_setting_value(
476 $editor->requestor->ws_ou, 'cat.bib.alert_on_empty', $editor);
478 if( OpenILS::Application::Cat::BibCommon->title_is_empty($editor, $vol->record, $vol->id) ) {
480 # delete this volume if it's not already marked as deleted
481 unless( $U->is_true($vol->deleted) || $vol->isdeleted ) {
483 $vol->editor($editor->requestor->id);
484 $vol->edit_date('now');
485 $editor->update_asset_call_number($vol) or return $editor->event;
488 return OpenILS::Event->new('TITLE_LAST_COPY', payload => $vol->record )
489 if $aoe and not $override and not $force_delete_empty_bib;
491 unless($koe and not $force_delete_empty_bib) {
492 # delete the bib record if the keep-on-empty setting is not set (and we're not otherwise forcing things, say through acq settings)
493 my $evt = OpenILS::Application::Cat::BibCommon->delete_rec($editor, $vol->record);
503 my($class, $vol, $copy) = @_;
504 my $org = $vol->owning_lib;
505 if( $vol->id == OILS_PRECAT_CALL_NUMBER ) {
506 $org = ref($copy->circ_lib) ? $copy->circ_lib->id : $copy->circ_lib;
508 $logger->debug("using copy perm org $org");
514 my($class, $e, $copy_id) = @_;
516 my $copy = $e->retrieve_asset_copy([
518 {flesh => 1, flesh_fields => {'acp' => ['call_number']}}])
519 or return $e->die_event;
522 ($copy->call_number->id == OILS_PRECAT_CALL_NUMBER) ?
523 $copy->circ_lib : $copy->call_number->owning_lib;
525 my $circ = $e->search_action_circulation(
526 {checkin_time => undef, target_copy => $copy->id} )->[0]
527 or return $e->die_event;
529 $e->allowed('SET_CIRC_LOST', $circ->circ_lib) or return $e->die_event;
531 return $e->die_event(OpenILS::Event->new('COPY_MARKED_LOST'))
532 if $copy->status == OILS_COPY_STATUS_LOST;
534 # ---------------------------------------------------------------------
535 # fetch the related org settings
536 my $proc_fee = $U->ou_ancestor_setting_value(
537 $owning_lib, OILS_SETTING_LOST_PROCESSING_FEE, $e) || 0;
538 my $void_overdue = $U->ou_ancestor_setting_value(
539 $owning_lib, OILS_SETTING_VOID_OVERDUE_ON_LOST, $e) || 0;
541 # ---------------------------------------------------------------------
542 # move the copy into LOST status
543 $copy->status(OILS_COPY_STATUS_LOST);
544 $copy->editor($e->requestor->id);
545 $copy->edit_date('now');
546 $e->update_asset_copy($copy) or return $e->die_event;
548 my $price = $U->get_copy_price($e, $copy, $copy->call_number);
551 my $evt = OpenILS::Application::Circ::CircCommon->create_bill(
552 $e, $price, 3, 'Lost Materials', $circ->id);
556 # ---------------------------------------------------------------------
557 # if there is a processing fee, charge that too
558 if( $proc_fee > 0 ) {
559 my $evt = OpenILS::Application::Circ::CircCommon->create_bill(
560 $e, $proc_fee, 4, 'Lost Materials Processing Fee', $circ->id);
564 # ---------------------------------------------------------------------
565 # mark the circ as lost and stop the fines
566 $circ->stop_fines(OILS_STOP_FINES_LOST);
567 $circ->stop_fines_time('now') unless $circ->stop_fines_time;
568 $e->update_action_circulation($circ) or return $e->die_event;
570 # ---------------------------------------------------------------------
571 # void all overdue fines on this circ if configured
572 if( $void_overdue ) {
573 my $evt = OpenILS::Application::Circ::CircCommon->void_overdues($e, $circ);
577 my $evt = OpenILS::Application::Circ::CircCommon->reopen_xact($e, $circ->id);
580 my $ses = OpenSRF::AppSession->create('open-ils.trigger');
581 $ses->request('open-ils.trigger.event.autocreate', 'lost', $circ, $circ->circ_lib);