14a52d4b63b08cd5221c592c6760381f9686ce28
[working/Evergreen.git] / Open-ILS / src / perlmods / lib / OpenILS / Application / Cat / AssetCommon.pm
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;
11 use OpenILS::Event;
12 use OpenILS::Utils::Penalty;
13 use OpenILS::Application::Circ::CircCommon;
14 my $U = 'OpenILS::Application::AppUtils';
15
16
17 # ---------------------------------------------------------------------------
18 # Shared copy mangling code.  Do not publish methods from here.
19 # ---------------------------------------------------------------------------
20
21 sub org_cannot_have_vols {
22     my($class, $e, $org_id) = @_;
23     my $org = $e->retrieve_actor_org_unit([
24         $org_id,
25         {   flesh => 1,
26             flesh_fields => {aou => ['ou_type']}
27         }]) or return $e->event;
28
29     return OpenILS::Event->new('ORG_CANNOT_HAVE_VOLS')
30         unless $U->is_true($org->ou_type->can_have_vols);
31
32     return 0;
33 }
34
35 sub fix_copy_price {
36     my $class = shift;
37     my $copy = shift;
38
39     if(defined $copy->price) {
40         my $p = $copy->price || 0;
41         $p =~ s/\$//og;
42         $copy->price($p);
43     }
44
45     my $d = $copy->deposit_amount || 0;
46     $d =~ s/\$//og;
47     $copy->deposit_amount($d);
48 }
49
50 sub create_copy {
51     my($class, $editor, $vol, $copy) = @_;
52
53     my $existing = $editor->search_asset_copy(
54         { barcode => $copy->barcode, deleted => 'f' } );
55     
56     return OpenILS::Event->new('ITEM_BARCODE_EXISTS') if @$existing;
57
58     my $copy_loc = $editor->search_asset_copy_location(
59         { id => $copy->location, deleted => 'f' } );
60         
61     return OpenILS::Event->new('COPY_LOCATION_NOT_FOUND') unless @$copy_loc;
62     
63    # see if the volume this copy references is marked as deleted
64     return OpenILS::Event->new('VOLUME_DELETED', vol => $vol->id) 
65         if $U->is_true($vol->deleted);
66
67     my $evt;
68     my $org = (ref $copy->circ_lib) ? $copy->circ_lib->id : $copy->circ_lib;
69     return $evt if ($evt = $class->org_cannot_have_vols($editor, $org));
70
71     $copy->clear_id;
72     $copy->editor($editor->requestor->id);
73     $copy->creator($editor->requestor->id);
74     $copy->create_date('now');
75     $copy->call_number($vol->id);
76     $class->fix_copy_price($copy);
77
78     my $cp = $editor->create_asset_copy($copy) or return $editor->die_event;
79     $copy->id($cp->id);
80     return undef;
81 }
82
83
84 # 'delete_stats' is somewhat of a misnomer.  With no flags set, this method
85 # still deletes any existing maps not represented in $copy->stat_cat_entries,
86 # but aborts when $copy->stat_cat_entries is empty or undefined.  If
87 # 'delete_stats' is true, this method will delete all the maps when
88 # $copy->stat_cat_entries is empty or undefined.
89 #
90 # The 'add_or_update_only' flag is more straightforward.  It adds missing
91 # maps, updates present maps with any new values, and leaves the rest
92 # alone.
93 sub update_copy_stat_entries {
94     my($class, $editor, $copy, $delete_stats, $add_or_update_only) = @_;
95
96     return undef if $copy->isdeleted;
97     return undef unless $copy->ischanged or $copy->isnew;
98
99     my $evt;
100     my $entries = $copy->stat_cat_entries;
101
102     if( $delete_stats ) {
103         $entries = ($entries and @$entries) ? $entries : [];
104     } else {
105         return undef unless ($entries and @$entries);
106     }
107
108     my $maps = $editor->search_asset_stat_cat_entry_copy_map({owning_copy=>$copy->id});
109
110     if(!$copy->isnew) {
111         # if there is no stat cat entry on the copy who's id matches the
112         # current map's id, remove the map from the database
113         for my $map (@$maps) {
114             if (!$add_or_update_only) {
115                 if(! grep { $_->id == $map->stat_cat_entry } @$entries ) {
116
117                     $logger->info("copy update found stale ".
118                         "stat cat entry map ".$map->id. " on copy ".$copy->id);
119
120                     $editor->delete_asset_stat_cat_entry_copy_map($map)
121                         or return $editor->event;
122                 }
123             } else {
124                 if( grep { $_->stat_cat == $map->stat_cat and $_->id != $map->stat_cat_entry } @$entries ) {
125
126                     $logger->info("copy update found ".
127                         "stat cat entry map ".$map->id. " needing update on copy ".$copy->id);
128
129                     $editor->delete_asset_stat_cat_entry_copy_map($map)
130                         or return $editor->event;
131                 }
132             }
133         }
134     }
135
136     # go through the stat cat update/create process
137     for my $entry (@$entries) { 
138         next unless $entry;
139
140         # if this link already exists in the DB, don't attempt to re-create it
141         next if( grep{$_->stat_cat_entry == $entry->id} @$maps );
142     
143         my $new_map = Fieldmapper::asset::stat_cat_entry_copy_map->new();
144
145         my $sc = ref($entry->stat_cat) ? $entry->stat_cat->id : $entry->stat_cat;
146         
147         $new_map->stat_cat( $sc );
148         $new_map->stat_cat_entry( $entry->id );
149         $new_map->owning_copy( $copy->id );
150
151         $editor->create_asset_stat_cat_entry_copy_map($new_map)
152             or return $editor->event;
153
154         $logger->info("copy update created new stat cat entry map ".$editor->data);
155     }
156
157     return undef;
158 }
159
160 # if 'delete_maps' is true, the copy->parts data is  treated as the
161 # authoritative list for the copy. existing part maps not targeting
162 # these parts will be deleted from the DB
163 sub update_copy_parts {
164     my($class, $editor, $copy, $delete_maps, $create_parts) = @_;
165
166     return undef if $copy->isdeleted;
167     return undef unless $copy->ischanged or $copy->isnew;
168
169     my $evt;
170     my $incoming_parts = $copy->parts;
171
172     if( $delete_maps ) {
173         $incoming_parts = ($incoming_parts and @$incoming_parts) ? $incoming_parts : [];
174     } else {
175         return undef unless ($incoming_parts and @$incoming_parts);
176     }
177
178     my $maps = $editor->search_asset_copy_part_map({target_copy=>$copy->id});
179
180     if(!$copy->isnew) {
181         # if there is no part map on the copy who's id matches the
182         # current map's id, remove the map from the database
183         for my $map (@$maps) {
184             if(! grep { $_->id == $map->part } @$incoming_parts ) {
185
186                 $logger->info("copy update found stale ".
187                     "monographic part map ".$map->id. " on copy ".$copy->id);
188
189                 $editor->delete_asset_copy_part_map($map)
190                     or return $editor->event;
191             }
192         }
193     }
194
195     # go through the part map update/create process
196     for my $incoming_part (@$incoming_parts) { 
197         next unless $incoming_part;
198
199         # if this link already exists in the DB, don't attempt to re-create it
200         next if( grep{$_->part == $incoming_part->id} @$maps );
201
202         if ($incoming_part->isnew) {
203             next unless $create_parts;
204             my $new_part = Fieldmapper::biblio::monograph_part->new();
205             $new_part->record( $incoming_part->record );
206             $new_part->label( $incoming_part->label );
207             $incoming_part = $editor->create_biblio_monograph_part($new_part)
208                 or return $editor->event;
209         }
210     
211         my $new_map = Fieldmapper::asset::copy_part_map->new();
212
213         $new_map->part( $incoming_part->id );
214         $new_map->target_copy( $copy->id );
215
216         $editor->create_asset_copy_part_map($new_map)
217             or return $editor->event;
218
219         $logger->info("copy update created new monographic part copy map ".$editor->data);
220     }
221
222     return undef;
223 }
224
225
226
227 sub update_copy_notes {
228     my($class, $editor, $copy) = @_;
229
230     return undef if $copy->isdeleted;
231
232     my $evt;
233     my $incoming_notes = $copy->notes;
234
235     for my $incoming_note (@$incoming_notes) { 
236         next unless $incoming_note;
237
238         if ($incoming_note->isnew) {
239             next if ($incoming_note->isdeleted); # if it was added and deleted in the same session
240
241             my $new_note = Fieldmapper::asset::copy_note->new();
242             $new_note->owning_copy( $copy->id );
243             $new_note->pub( $incoming_note->pub );
244             $new_note->title( $incoming_note->title );
245             $new_note->value( $incoming_note->value );
246             $new_note->creator( $incoming_note->creator || $editor->requestor->id );
247             $incoming_note = $editor->create_asset_copy_note($new_note)
248                 or return $editor->event;
249
250         } elsif ($incoming_note->ischanged) {
251             $incoming_note = $editor->update_asset_copy_note($incoming_note)
252         } elsif ($incoming_note->isdeleted) {
253             $incoming_note = $editor->delete_asset_copy_note($incoming_note->id)
254         }
255     
256     }
257
258     return undef;
259 }
260
261
262 sub update_copy_tags {
263     my($class, $editor, $copy) = @_;
264
265     return undef if $copy->isdeleted;
266
267     my $evt;
268     my $incoming_maps = $copy->tags;
269
270     for my $incoming_map (@$incoming_maps) {
271         next unless $incoming_map;
272
273         if ($incoming_map->isnew) {
274             next if ($incoming_map->isdeleted); # if it was added and deleted in the same session
275
276             my $tag_id;
277             if ($incoming_map->tag->isnew) {
278                 my $new_tag = Fieldmapper::asset::copy_tag->new();
279                 $new_tag->owner( $incoming_map->tag->owner );
280                 $new_tag->label( $incoming_map->tag->label );
281                 $new_tag->tag_type( $incoming_map->tag->tag_type );
282                 $new_tag->pub( $incoming_map->tag->pub );
283                 my $tag = $editor->create_asset_copy_tag($new_tag)
284                     or return $editor->event;
285                 $tag_id = $tag->id;
286             } else {
287                 $tag_id = $incoming_map->tag->id;
288             }
289             my $new_map = Fieldmapper::asset::copy_tag_copy_map->new();
290             $new_map->copy( $copy->id );
291             $new_map->tag( $tag_id );
292             $incoming_map = $editor->create_asset_copy_tag_copy_map($new_map)
293                 or return $editor->event;
294
295         } elsif ($incoming_map->ischanged) {
296             $incoming_map = $editor->update_asset_copy_tag_copy_map($incoming_map)
297         } elsif ($incoming_map->isdeleted) {
298             $incoming_map = $editor->delete_asset_copy_tag_copy_map($incoming_map)
299         }
300     
301     }
302
303     return undef;
304 }
305
306
307
308 sub update_copy {
309     my($class, $editor, $override, $vol, $copy, $retarget_holds, $force_delete_empty_bib) = @_;
310
311     $override = { all => 1 } if($override && !ref $override);
312     $override = { all => 0 } if(!ref $override);
313
314     # Duplicated check from create_copy in case a copy template with a deleted location is applied later
315     my $copy_loc = $editor->search_asset_copy_location(
316         { id => $copy->location, deleted => 'f' } );
317         
318     return OpenILS::Event->new('COPY_LOCATION_NOT_FOUND') unless @$copy_loc;
319     
320     my $evt;
321     my $org = (ref $copy->circ_lib) ? $copy->circ_lib->id : $copy->circ_lib;
322     return $evt if ( $evt = $class->org_cannot_have_vols($editor, $org) );
323
324     $logger->info("vol-update: updating copy ".$copy->id);
325     my $orig_copy = $editor->retrieve_asset_copy($copy->id);
326
327     # Call-number may have changed, find the original
328     my $orig_vol_id = $editor->json_query({select => {acp => ['call_number']}, from => 'acp', where => {id => $copy->id}});
329     my $orig_vol  = $editor->retrieve_asset_call_number($orig_vol_id->[0]->{call_number});
330
331     $copy->editor($editor->requestor->id);
332     $copy->edit_date('now');
333
334     $copy->age_protect( $copy->age_protect->id )
335         if ref $copy->age_protect;
336
337     $class->fix_copy_price($copy);
338     $class->check_hold_retarget($editor, $copy, $orig_copy, $retarget_holds);
339
340     return $editor->event unless $editor->update_asset_copy($copy);
341     return $class->remove_empty_objects($editor, $override, $orig_vol, $force_delete_empty_bib);
342 }
343
344 sub check_hold_retarget {
345     my($class, $editor, $copy, $orig_copy, $retarget_holds) = @_;
346     return unless $retarget_holds;
347
348     if( !($copy->isdeleted or $U->is_true($copy->deleted)) ) {
349         # see if a status change warrants a retarget
350
351         $orig_copy = $editor->retrieve_asset_copy($copy->id) unless $orig_copy;
352
353         if($orig_copy->status == $copy->status) {
354             # no status change, no retarget
355             return;
356         }
357
358         my $stat = $editor->retrieve_config_copy_status($copy->status);
359
360         # new status is holdable, no retarget. Later add logic to find potential 
361         # holds and retarget those to pick up the newly available copy
362         return if $U->is_true($stat->holdable); 
363     }
364
365     my $hold_ids = $editor->search_action_hold_request(
366         {   current_copy        => $copy->id, 
367             cancel_time         => undef, 
368             fulfillment_time    => undef 
369         }, {idlist => 1}
370     );
371
372     push(@$retarget_holds, @$hold_ids);
373 }
374
375
376 # this does the actual work
377 sub update_fleshed_copies {
378     my($class, $editor, $override, $vol, $copies, $delete_stats, $retarget_holds, $force_delete_empty_bib, $create_parts) = @_;
379
380     $override = { all => 1 } if($override && !ref $override);
381     $override = { all => 0 } if(!ref $override);
382
383     my $evt;
384     my $fetchvol = ($vol) ? 0 : 1;
385
386     my %cache;
387     $cache{$vol->id} = $vol if $vol;
388
389     for my $copy (@$copies) {
390
391         my $copyid = $copy->id;
392         $logger->info("vol-update: inspecting copy $copyid");
393
394         if( !($vol = $cache{$copy->call_number}) ) {
395             $vol = $cache{$copy->call_number} = 
396                 $editor->retrieve_asset_call_number($copy->call_number);
397             return $editor->event unless $vol;
398         }
399
400         return $editor->event unless 
401             $editor->allowed('UPDATE_COPY', $class->copy_perm_org($vol, $copy));
402
403         $copy->editor($editor->requestor->id);
404         $copy->edit_date('now');
405
406         $copy->status( $copy->status->id ) if ref($copy->status);
407         $copy->location( $copy->location->id ) if ref($copy->location);
408         $copy->circ_lib( $copy->circ_lib->id ) if ref($copy->circ_lib);
409         
410         my $parts = $copy->parts;
411         $copy->clear_parts;
412
413         my $sc_entries = $copy->stat_cat_entries;
414         $copy->clear_stat_cat_entries;
415
416         my $notes = $copy->notes;
417         $copy->clear_notes;
418         my $tags = $copy->tags;
419         $copy->clear_tags;
420
421         if( $copy->isdeleted ) {
422             $evt = $class->delete_copy($editor, $override, $vol, $copy, $retarget_holds, $force_delete_empty_bib);
423             return $evt if $evt;
424
425         } elsif( $copy->isnew ) {
426             $evt = $class->create_copy( $editor, $vol, $copy );
427             return $evt if $evt;
428
429         } elsif( $copy->ischanged ) {
430
431             $evt = $class->update_copy( $editor, $override, $vol, $copy, $retarget_holds, $force_delete_empty_bib);
432             return $evt if $evt;
433         }
434
435         $copy->stat_cat_entries( $sc_entries );
436         $evt = $class->update_copy_stat_entries($editor, $copy, $delete_stats);
437
438         $copy->parts( $parts );
439         # probably okay to use $delete_stats here for simplicity
440         $evt = $class->update_copy_parts($editor, $copy, $delete_stats, $create_parts);
441
442         $copy->notes( $notes );
443         $evt = $class->update_copy_notes($editor, $copy);
444
445         $copy->tags( $tags );
446         $evt = $class->update_copy_tags($editor, $copy);
447
448         return $evt if $evt;
449     }
450
451     $logger->debug("vol-update: done updating copy batch");
452
453     return undef;
454 }
455
456
457 sub delete_copy {
458     my($class, $editor, $override, $vol, $copy, $retarget_holds, $force_delete_empty_bib, $skip_empty_cleanup) = @_;
459
460     return $editor->event unless
461         $editor->allowed('DELETE_COPY', $class->copy_perm_org($vol, $copy));
462
463     $override = { all => 1 } if($override && !ref $override);
464     $override = { all => 0 } if(!ref $override);
465
466     my $stat = $U->copy_status($copy->status);
467     if ($U->is_true($stat->restrict_copy_delete)) {
468         if ($override->{all} || grep { $_ eq 'COPY_DELETE_WARNING' } @{$override->{events}}) {
469             return $editor->event unless $editor->allowed('COPY_DELETE_WARNING.override', $class->copy_perm_org($vol, $copy))
470         } else {
471             return OpenILS::Event->new('COPY_DELETE_WARNING', payload => $copy->id )
472         }
473     }
474
475     $logger->info("vol-update: deleting copy ".$copy->id);
476     $copy->deleted('t');
477
478     $copy->editor($editor->requestor->id);
479     $copy->edit_date('now');
480     $editor->update_asset_copy($copy) or return $editor->event;
481
482     # Cancel any open transits for this copy
483     my $transits = $editor->search_action_transit_copy(
484         { target_copy=>$copy->id, dest_recv_time => undef, cancel_time => undef } );
485
486     for my $t (@$transits) {
487         $t->cancel_time('now');
488         $editor->update_action_transit_copy($t)
489             or return $editor->event;
490     }
491
492     my $evt = $class->cancel_copy_holds($editor, $copy);
493     return $evt if $evt;
494
495     $class->check_hold_retarget($editor, $copy, undef, $retarget_holds);
496
497     return undef if $skip_empty_cleanup;
498
499     return $class->remove_empty_objects($editor, $override, $vol, $force_delete_empty_bib);
500 }
501
502
503 # deletes all holds that specifically target the deleted copy
504 sub cancel_copy_holds {
505     my($class, $editor, $copy) = @_;
506
507     my $holds = $editor->search_action_hold_request({   
508         target              => $copy->id, 
509         hold_type           => [qw/C R F/],
510         cancel_time         => undef, 
511         fulfillment_time    => undef 
512     });
513
514     return $class->cancel_hold_list($editor, $holds);
515 }
516
517 # deletes all holds that specifically target the deleted volume
518 sub cancel_volume_holds {
519     my($class, $editor, $volume) = @_;
520
521     my $holds = $editor->search_action_hold_request({   
522         target              => $volume->id, 
523         hold_type           => 'V',
524         cancel_time         => undef, 
525         fulfillment_time    => undef 
526     });
527
528     return $class->cancel_hold_list($editor, $holds);
529 }
530
531 sub cancel_hold_list {
532     my($class, $editor, $holds) = @_;
533
534     for my $hold (@$holds) {
535
536         $hold->cancel_time('now');
537         $hold->cancel_cause(1); # un-targeted expiration.  Do we need an alternate "target deleted" cause?
538         $editor->update_action_hold_request($hold) or return $editor->die_event;
539
540         # tell A/T the hold was cancelled.  Don't wait for a response..
541         my $at_ses = OpenSRF::AppSession->create('open-ils.trigger');
542         $at_ses->request(
543             'open-ils.trigger.event.autocreate',
544             'hold_request.cancel.expire_no_target', 
545             $hold, $hold->pickup_lib);
546     }
547
548     return undef;
549 }
550
551
552
553 sub create_volume {
554     my($class, $override, $editor, $vol) = @_;
555     my $evt;
556
557     return $evt if ( $evt = $class->org_cannot_have_vols($editor, $vol->owning_lib) );
558
559     $override = { all => 1 } if($override && !ref $override);
560     $override = { all => 0 } if(!ref $override);
561
562    # see if the record this volume references is marked as deleted
563    my $rec = $editor->retrieve_biblio_record_entry($vol->record)
564       or return $editor->die_event;
565    return OpenILS::Event->new('BIB_RECORD_DELETED', rec => $rec->id) 
566       if $U->is_true($rec->deleted);
567
568     # first lets see if there are any collisions
569     my $vols = $editor->search_asset_call_number( { 
570             owning_lib  => $vol->owning_lib,
571             record      => $vol->record,
572             label           => $vol->label,
573             prefix          => $vol->prefix,
574             suffix          => $vol->suffix,
575             deleted     => 'f'
576         }
577     );
578
579     my $label = undef;
580     if(@$vols) {
581       # we've found an exising volume
582         if($override->{all} || grep { $_ eq 'VOLUME_LABEL_EXISTS' } @{$override->{events}}) {
583             $label = $vol->label;
584         } else {
585             return OpenILS::Event->new(
586                 'VOLUME_LABEL_EXISTS', payload => $vol->id);
587         }
588     }
589
590     # create a temp label so we can create the new volume, 
591     # then de-dup it with the existing volume
592     $vol->label( "__SYSTEM_TMP_$$".time) if $label;
593
594     $vol->creator($editor->requestor->id);
595     $vol->create_date('now');
596     $vol->editor($editor->requestor->id);
597     $vol->edit_date('now');
598     $vol->clear_id;
599
600     $editor->create_asset_call_number($vol) or return $editor->die_event;
601
602     if($label) {
603         # now restore the label and merge into the existing record
604         $vol->label($label);
605         return OpenILS::Application::Cat::Merge::merge_volumes($editor, [$vol], $$vols[0]);
606     }
607
608     return ($vol);
609 }
610
611 # returns the volume if it exists
612 sub volume_exists {
613     my($class, $e, $rec_id, $label, $owning_lib, $prefix, $suffix) = @_;
614     return $e->search_asset_call_number(
615         {label => $label, record => $rec_id, owning_lib => $owning_lib, deleted => 'f', prefix => $prefix, suffix => $suffix})->[0];
616 }
617
618 sub find_or_create_volume {
619     my($class, $e, $label, $record_id, $org_id, $prefix, $suffix, $label_class) = @_;
620
621     $prefix ||= '-1';
622     $suffix ||= '-1';
623
624     my $vol;
625
626     if($record_id == OILS_PRECAT_RECORD) {
627         $vol = $e->retrieve_asset_call_number(OILS_PRECAT_CALL_NUMBER)
628             or return (undef, $e->die_event);
629
630     } else {
631         $vol = $class->volume_exists($e, $record_id, $label, $org_id, $prefix, $suffix);
632     }
633
634     # If the volume exists, return the ID
635     return ($vol, undef, 1) if $vol;
636
637     # -----------------------------------------------------------------
638     # Otherwise, create a new volume with the given attributes
639     # -----------------------------------------------------------------
640     return (undef, $e->die_event) unless $e->allowed('UPDATE_VOLUME', $org_id);
641
642     $vol = Fieldmapper::asset::call_number->new;
643     $vol->owning_lib($org_id);
644     $vol->label_class($label_class) if ($label_class);
645     $vol->label($label);
646     $vol->prefix($prefix);
647     $vol->suffix($suffix);
648     $vol->record($record_id);
649
650     return $class->create_volume(0, $e, $vol);
651 }
652
653
654 sub create_copy_note {
655     my($class, $e, $copy, $title, $value, $pub) = @_;
656     my $note = Fieldmapper::asset::copy_note->new;
657     $note->owning_copy($copy->id);
658     $note->creator($e->requestor->id);
659     $note->pub($pub ? 't' : 'f');
660     $note->value($value);
661     $note->title($title);
662     $e->create_asset_copy_note($note) or return $e->die_event;
663     return undef;
664 }
665
666
667 sub remove_empty_objects {
668     my($class, $editor, $override, $vol, $force_delete_empty_bib) = @_; 
669
670     $override = { all => 1 } if($override && !ref $override);
671     $override = { all => 0 } if(!ref $override);
672
673     my $koe = $U->ou_ancestor_setting_value(
674         $editor->requestor->ws_ou, 'cat.bib.keep_on_empty', $editor);
675     my $aoe =  $U->ou_ancestor_setting_value(
676         $editor->requestor->ws_ou, 'cat.bib.alert_on_empty', $editor);
677
678     if( OpenILS::Application::Cat::BibCommon->title_is_empty($editor, $vol->record, $vol->id) ) {
679
680         # delete this volume if it's not already marked as deleted
681         unless( $U->is_true($vol->deleted) || $vol->isdeleted ) {
682             my $evt = $class->delete_volume($editor, $vol, $override, 0, 1);
683             return $evt if $evt;
684         }
685
686         return OpenILS::Event->new('TITLE_LAST_COPY', payload => $vol->record ) 
687             if $aoe and not ($override->{all} || grep { $_ eq 'TITLE_LAST_COPY' } @{$override->{events}}) and not $force_delete_empty_bib;
688
689         unless($koe and not $force_delete_empty_bib) {
690             # delete the bib record if the keep-on-empty setting is not set (and we're not otherwise forcing things, say through acq settings)
691             my $evt = OpenILS::Application::Cat::BibCommon->delete_rec($editor, $vol->record);
692             return $evt if $evt;
693         }
694
695     } else {
696
697         # this may be the last copy attached to the volume.  
698
699         if($U->ou_ancestor_setting_value(
700                 $editor->requestor->ws_ou, 'cat.volume.delete_on_empty', $editor)) {
701
702             # if this volume is "empty" and not mid-delete, delete it.
703             unless($U->is_true($vol->deleted) || $vol->isdeleted) {
704
705                 my $copies = $editor->search_asset_copy(
706                     [{call_number => $vol->id, deleted => 'f'}, {limit => 1}], {idlist => 1});
707
708                 if(!@$copies) {
709                     my $evt = $class->delete_volume($editor, $vol, $override, 0, 1);
710                     return $evt if $evt;
711                 }
712             }
713         }
714     }
715
716     return undef;
717 }
718
719 # Deletes a volume.  Returns undef on success, event on error
720 # force : deletes all attached copies
721 # skip_copy_check : assumes caller has verified no copies need deleting first
722 sub delete_volume {
723     my($class, $editor, $vol, $override, $delete_copies, $skip_copy_checks) = @_;
724     my $evt;
725
726     unless($skip_copy_checks) {
727         my $cs = $editor->search_asset_copy(
728             [{call_number => $vol->id, deleted => 'f'}, {limit => 1}], {idlist => 1});
729
730         return OpenILS::Event->new('VOLUME_NOT_EMPTY', payload => $vol->id) 
731             if @$cs and !$delete_copies;
732
733         my $copies = $editor->search_asset_copy({call_number => $vol->id, deleted => 'f'});
734
735         for my $copy (@$copies) {
736             $evt = $class->delete_copy($editor, $override, $vol, $copy, 0, 0, 1);
737             return $evt if $evt;
738         }
739     }
740
741     $vol->deleted('t');
742     $vol->edit_date('now');
743     $vol->editor($editor->requestor->id);
744     $editor->update_asset_call_number($vol) or return $editor->die_event;
745
746     $evt = $class->cancel_volume_holds($editor, $vol);
747     return $evt if $evt;
748
749     # handle the case where this is the last volume on the record
750     return $class->remove_empty_objects($editor, $override, $vol);
751 }
752
753
754 sub copy_perm_org {
755     my($class, $vol, $copy) = @_;
756     my $org = $vol->owning_lib;
757     if( $vol->id == OILS_PRECAT_CALL_NUMBER ) {
758         $org = ref($copy->circ_lib) ? $copy->circ_lib->id : $copy->circ_lib;
759     }
760     $logger->debug("using copy perm org $org");
761     return $org;
762 }
763
764
765 sub set_item_lost {
766     my ($class, $e, $copy_id) = @_;
767
768     return $class->set_item_lost_or_lod(
769         $e, $copy_id,
770         perm => 'SET_CIRC_LOST',
771         status => OILS_COPY_STATUS_LOST,
772         alt_status => 16, #Long Overdue,
773         ous_proc_fee => OILS_SETTING_LOST_PROCESSING_FEE,
774         ous_void_od => OILS_SETTING_VOID_OVERDUE_ON_LOST,
775         bill_type => 3,
776         bill_fee_type => 4,
777         bill_note => 'Lost Materials',
778         bill_fee_note => 'Lost Materials Processing Fee',
779         event => 'COPY_MARKED_LOST',
780         stop_fines => OILS_STOP_FINES_LOST,
781         at_hook => 'lost'
782     );
783 }
784
785 sub set_item_long_overdue {
786     my ($class, $e, $copy_id) = @_;
787
788     return $class->set_item_lost_or_lod(
789         $e, $copy_id,
790         perm => 'SET_CIRC_LONG_OVERDUE',
791         status => 16, # Long Overdue
792         alt_status => OILS_COPY_STATUS_LOST,
793         ous_proc_fee => 'circ.longoverdue_materials_processing_fee',
794         ous_void_od => 'circ.void_overdue_on_longoverdue',
795         bill_type => 10,
796         bill_fee_type => 11,
797         bill_note => 'Long Overdue Materials',
798         bill_fee_note => 'Long Overdue Materials Processing Fee',
799         event => 'COPY_MARKED_LONG_OVERDUE',
800         stop_fines => 'LONGOVERDUE',
801         at_hook => 'longoverdue'
802     );
803 }
804
805 # LOST or LONGOVERDUE
806 # basic process is the same.  details change.
807 sub set_item_lost_or_lod {
808     my ($class, $e, $copy_id, %args) = @_;
809
810     my $copy = $e->retrieve_asset_copy([
811         $copy_id, 
812         {flesh => 1, flesh_fields => {'acp' => ['call_number']}}])
813             or return $e->die_event;
814
815     my $owning_lib = 
816         ($copy->call_number->id == OILS_PRECAT_CALL_NUMBER) ? 
817             $copy->circ_lib : $copy->call_number->owning_lib;
818
819     my $circ = $e->search_action_circulation(
820         {checkin_time => undef, target_copy => $copy->id} )->[0]
821             or return $e->die_event;
822
823     $e->allowed($args{perm}, $circ->circ_lib) or return $e->die_event;
824
825     return $e->die_event(OpenILS::Event->new($args{event}))
826             if ($copy->status == $args{status} || $copy->status == $args{alt_status});
827
828     # ---------------------------------------------------------------------
829     # fetch the related org settings
830     my $proc_fee = $U->ou_ancestor_setting_value(
831         $owning_lib, $args{ous_proc_fee}, $e) || 0;
832     my $void_overdue = $U->ou_ancestor_setting_value(
833         $owning_lib, $args{ous_void_od}, $e) || 0;
834
835     # ---------------------------------------------------------------------
836     # move the copy into LOST status
837     $copy->status($args{status});
838     $copy->editor($e->requestor->id);
839     $copy->edit_date('now');
840     $e->update_asset_copy($copy) or return $e->die_event;
841
842     my $price = $U->get_copy_price($e, $copy, $copy->call_number);
843
844     if( $price > 0 ) {
845         my $evt = OpenILS::Application::Circ::CircCommon->create_bill($e, 
846             $price, $args{bill_type}, $args{bill_note}, $circ->id);
847         return $evt if $evt;
848     }
849
850     # ---------------------------------------------------------------------
851     # if there is a processing fee, charge that too
852     if( $proc_fee > 0 ) {
853         my $evt = OpenILS::Application::Circ::CircCommon->create_bill($e, 
854             $proc_fee, $args{bill_fee_type}, $args{bill_fee_note}, $circ->id);
855         return $evt if $evt;
856     }
857
858     # ---------------------------------------------------------------------
859     # mark the circ as lost and stop the fines
860     $circ->stop_fines($args{stop_fines});
861     $circ->stop_fines_time('now') unless $circ->stop_fines_time;
862     $e->update_action_circulation($circ) or return $e->die_event;
863
864     # ---------------------------------------------------------------------
865     # zero out overdue fines on this circ if configured
866     if( $void_overdue ) {
867         my $evt = OpenILS::Application::Circ::CircCommon->void_or_zero_overdues($e, $circ, {force_zero => 1, note => "System: OVERDUE REVERSED for " . $args{bill_note} . " Processing"});
868         return $evt if $evt;
869     }
870
871     my $evt = OpenILS::Application::Circ::CircCommon->reopen_xact($e, $circ->id);
872     return $evt if $evt;
873
874     my $ses = OpenSRF::AppSession->create('open-ils.trigger');
875     $ses->request(
876         'open-ils.trigger.event.autocreate', 
877         $args{at_hook}, $circ, $circ->circ_lib
878     );
879
880     my $evt2 = OpenILS::Utils::Penalty->calculate_penalties(
881         $e, $circ->usr, $U->xact_org($circ->id, $e));
882     return $evt2 if $evt2;
883
884     return undef;
885 }