copy checkout history now limited by org setting and better permission checking....
[Evergreen.git] / Open-ILS / src / perlmods / OpenILS / Application / Circ.pm
1 package OpenILS::Application::Circ;
2 use OpenILS::Application;
3 use base qw/OpenILS::Application/;
4 use strict; use warnings;
5
6 use OpenILS::Application::Circ::Circulate;
7 use OpenILS::Application::Circ::Survey;
8 use OpenILS::Application::Circ::StatCat;
9 use OpenILS::Application::Circ::Holds;
10 use OpenILS::Application::Circ::HoldNotify;
11 use OpenILS::Application::Circ::Money;
12 use OpenILS::Application::Circ::NonCat;
13 use OpenILS::Application::Circ::CopyLocations;
14
15 use DateTime;
16 use DateTime::Format::ISO8601;
17
18 use OpenILS::Application::AppUtils;
19
20 use OpenSRF::Utils qw/:datetime/;
21 use OpenILS::Utils::ModsParser;
22 use OpenILS::Event;
23 use OpenSRF::EX qw(:try);
24 use OpenSRF::Utils::Logger qw(:logger);
25 use OpenILS::Utils::Fieldmapper;
26 use OpenILS::Utils::Editor;
27 use OpenILS::Utils::CStoreEditor q/:funcs/;
28 use OpenILS::Const qw/:const/;
29 use OpenSRF::Utils::SettingsClient;
30
31 my $apputils = "OpenILS::Application::AppUtils";
32 my $U = $apputils;
33
34
35 # ------------------------------------------------------------------------
36 # Top level Circ package;
37 # ------------------------------------------------------------------------
38
39 sub initialize {
40         my $self = shift;
41         OpenILS::Application::Circ::Circulate->initialize();
42 }
43
44
45 __PACKAGE__->register_method(
46         method => 'retrieve_circ',
47         api_name        => 'open-ils.circ.retrieve',
48         signature => q/
49                 Retrieve a circ object by id
50                 @param authtoken Login session key
51                 @pararm circid The id of the circ object
52         /
53 );
54 sub retrieve_circ {
55         my( $s, $c, $a, $i ) = @_;
56         my $e = new_editor(authtoken => $a);
57         return $e->event unless $e->checkauth;
58         my $circ = $e->retrieve_action_circulation($i) or return $e->event;
59         if( $e->requestor->id ne $circ->usr ) {
60                 return $e->event unless $e->allowed('VIEW_CIRCULATIONS');
61         }
62         return $circ;
63 }
64
65
66 __PACKAGE__->register_method(
67         method => 'fetch_circ_mods',
68         api_name => 'open-ils.circ.circ_modifier.retrieve.all');
69 sub fetch_circ_mods {
70     my($self, $conn, $args) = @_;
71     my $mods = new_editor()->retrieve_all_config_circ_modifier;
72     return [ map {$_->code} @$mods ] unless $$args{full};
73     return $mods;
74 }
75
76 __PACKAGE__->register_method(
77         method => 'fetch_bill_types',
78         api_name => 'open-ils.circ.billing_type.retrieve.all');
79 sub fetch_bill_types {
80         my $conf = OpenSRF::Utils::SettingsClient->new;
81         return $conf->config_value(
82                 'apps', 'open-ils.circ', 'app_settings', 'billing_types', 'type' );
83 }
84
85
86 # ------------------------------------------------------------------------
87 # Returns an array of {circ, record} hashes checked out by the user.
88 # ------------------------------------------------------------------------
89 __PACKAGE__->register_method(
90         method  => "checkouts_by_user",
91         api_name        => "open-ils.circ.actor.user.checked_out",
92         NOTES           => <<"  NOTES");
93         Returns a list of open circulations as a pile of objects.  each object
94         contains the relevant copy, circ, and record
95         NOTES
96
97 sub checkouts_by_user {
98         my( $self, $client, $user_session, $user_id ) = @_;
99
100         my( $requestor, $target, $copy, $record, $evt );
101
102         ( $requestor, $target, $evt ) = 
103                 $apputils->checkses_requestor( $user_session, $user_id, 'VIEW_CIRCULATIONS');
104         return $evt if $evt;
105
106         my $circs = $apputils->simplereq(
107                 'open-ils.cstore',
108                 "open-ils.cstore.direct.action.open_circulation.search.atomic", 
109                 { usr => $target->id, checkin_time => undef } );
110 #               { usr => $target->id } );
111
112         my @results;
113         for my $circ (@$circs) {
114
115                 ( $copy, $evt )  = $apputils->fetch_copy($circ->target_copy);
116                 return $evt if $evt;
117
118                 $logger->debug("Retrieving record for copy " . $circ->target_copy);
119
120                 ($record, $evt) = $apputils->fetch_record_by_copy( $circ->target_copy );
121                 return $evt if $evt;
122
123                 my $mods = $apputils->record_to_mvr($record);
124
125                 push( @results, { copy => $copy, circ => $circ, record => $mods } );
126         }
127
128         return \@results;
129
130 }
131
132
133
134 __PACKAGE__->register_method(
135         method  => "checkouts_by_user_slim",
136         api_name        => "open-ils.circ.actor.user.checked_out.slim",
137         NOTES           => <<"  NOTES");
138         Returns a list of open circulation objects
139         NOTES
140
141 # DEPRECAT ME?? XXX
142 sub checkouts_by_user_slim {
143         my( $self, $client, $user_session, $user_id ) = @_;
144
145         my( $requestor, $target, $copy, $record, $evt );
146
147         ( $requestor, $target, $evt ) = 
148                 $apputils->checkses_requestor( $user_session, $user_id, 'VIEW_CIRCULATIONS');
149         return $evt if $evt;
150
151         $logger->debug( 'User ' . $requestor->id . 
152                 " retrieving checked out items for user " . $target->id );
153
154         # XXX Make the call correct..
155         return $apputils->simplereq(
156                 'open-ils.cstore',
157                 "open-ils.cstore.direct.action.open_circulation.search.atomic", 
158                 { usr => $target->id, checkin_time => undef } );
159 #               { usr => $target->id } );
160 }
161
162
163 __PACKAGE__->register_method(
164         method  => "checkouts_by_user_opac",
165         api_name        => "open-ils.circ.actor.user.checked_out.opac",);
166
167 # XXX Deprecate Me
168 sub checkouts_by_user_opac {
169         my( $self, $client, $auth, $user_id ) = @_;
170
171         my $e = OpenILS::Utils::Editor->new( authtoken => $auth );
172         return $e->event unless $e->checkauth;
173         $user_id ||= $e->requestor->id;
174         return $e->event unless 
175                 my $patron = $e->retrieve_actor_user($user_id);
176
177         my $data;
178         my $search = {usr => $user_id, stop_fines => undef};
179
180         if( $user_id ne $e->requestor->id ) {
181                 $data = $e->search_action_circulation(
182                         $search, {checkperm=>1, permorg=>$patron->home_ou})
183                         or return $e->event;
184
185         } else {
186                 $data = $e->search_action_circulation($search);
187         }
188
189         return $data;
190 }
191
192
193 __PACKAGE__->register_method(
194         method  => "title_from_transaction",
195         api_name        => "open-ils.circ.circ_transaction.find_title",
196         NOTES           => <<"  NOTES");
197         Returns a mods object for the title that is linked to from the 
198         copy from the hold that created the given transaction
199         NOTES
200
201 sub title_from_transaction {
202         my( $self, $client, $login_session, $transactionid ) = @_;
203
204         my( $user, $circ, $title, $evt );
205
206         ( $user, $evt ) = $apputils->checkses( $login_session );
207         return $evt if $evt;
208
209         ( $circ, $evt ) = $apputils->fetch_circulation($transactionid);
210         return $evt if $evt;
211         
212         ($title, $evt) = $apputils->fetch_record_by_copy($circ->target_copy);
213         return $evt if $evt;
214
215         return $apputils->record_to_mvr($title);
216 }
217
218
219
220 __PACKAGE__->register_method(
221         method  => "new_set_circ_lost",
222         api_name        => "open-ils.circ.circulation.set_lost",
223         signature       => q/
224         Sets the copy and related open circulation to lost
225                 @param auth
226                 @param args : barcode
227         /
228 );
229
230
231 # ---------------------------------------------------------------------
232 # Sets a circulation to lost.  updates copy status to lost
233 # applies copy and/or prcoessing fees depending on org settings
234 # ---------------------------------------------------------------------
235 sub new_set_circ_lost {
236     my( $self, $conn, $auth, $args ) = @_;
237
238     my $e = new_editor(authtoken=>$auth, xact=>1);
239     return $e->die_event unless $e->checkauth;
240
241     my $barcode = $$args{barcode};
242     $logger->info("marking item lost $barcode");
243
244     # ---------------------------------------------------------------------
245     # gather the pieces
246     my $copy = $e->search_asset_copy([
247         {barcode=>$barcode, deleted=>'f'},
248         {flesh => 1, flesh_fields => {'acp' => ['call_number']}}])->[0] 
249             or return $e->die_event;
250
251     my $owning_lib = 
252         ($copy->call_number == OILS_PRECAT_CALL_NUMBER) ? 
253             $copy->circ_lib : $copy->call_number->owning_lib;
254
255     my $circ = $e->search_action_circulation(
256         {checkin_time => undef, target_copy => $copy->id} )->[0]
257             or return $e->die_event;
258
259     $e->allowed('SET_CIRC_LOST', $circ->circ_lib) or return $e->die_event;
260
261     return OpenILS::Event->new('COPY_MARKED_LOST')
262             if $copy->status == OILS_COPY_STATUS_LOST;
263
264     # ---------------------------------------------------------------------
265     # fetch the related org settings
266     my $default_price = $U->ou_ancestor_setting_value(
267         $owning_lib, OILS_SETTING_DEF_ITEM_PRICE, $e) || 0;
268     my $proc_fee = $U->ou_ancestor_setting_value(
269         $owning_lib, OILS_SETTING_LOST_PROCESSING_FEE, $e) || 0;
270     my $charge_on_0 = $U->ou_ancestor_setting_value(
271         $owning_lib, OILS_SETTING_CHARGE_LOST_ON_ZERO, $e) || 0;
272     my $void_overdue = $U->ou_ancestor_setting_value(
273         $owning_lib, OILS_SETTING_VOID_OVERDUE_ON_LOST, $e) || 0;
274
275     $logger->info("org settings: default price = $default_price, ".
276         "processing fee = $proc_fee, charge on 0 = $charge_on_0, void overdues = $void_overdue");
277
278     # ---------------------------------------------------------------------
279     # move the copy into LOST status
280     $copy->status(OILS_COPY_STATUS_LOST);
281     $copy->editor($e->requestor->id);
282     $copy->edit_date('now');
283     $e->update_asset_copy($copy) or return $e->die_event;
284
285     # ---------------------------------------------------------------------
286     # determine the appropriate item price to charge and create the billing
287     my $price = $copy->price;
288     $price = $default_price unless defined $price;
289     $price = 0 if $price < 0;
290     $price = $default_price if $price == 0 and $charge_on_0;
291
292     if( $price > 0 ) {
293         my $evt = create_bill($e, $price, 'Lost Materials', $circ->id);
294         return $evt if $evt;
295     }
296
297     # ---------------------------------------------------------------------
298     # if there is a processing fee, charge that too
299     if( $proc_fee > 0 ) {
300         my $evt = create_bill($e, $proc_fee, 'Lost Materials Processing Fee', $circ->id);
301         return $evt if $evt;
302     }
303
304     # ---------------------------------------------------------------------
305     # mark the circ as lost and stop the fines
306     $circ->stop_fines(OILS_STOP_FINES_LOST);
307     $circ->stop_fines_time('now') unless $circ->stop_fines_time;
308     $e->update_action_circulation($circ) or return $e->die_event;
309
310     # ---------------------------------------------------------------------
311     # void all overdue fines on this circ if configured
312     if( $void_overdue ) {
313         my $evt = void_overdues($e, $circ);
314         return $evt if $evt;
315     }
316
317     my $evt = reopen_xact($e, $circ->id);
318     return $evt if $evt;
319
320     $e->commit;
321     return 1;
322 }
323
324 sub reopen_xact {
325     my($e, $xactid) = @_;
326
327     # -----------------------------------------------------------------
328     # make sure the transaction is not closed
329     my $xact = $e->retrieve_money_billable_transaction($xactid)
330         or return $e->die_event;
331
332     if( $xact->xact_finish ) {
333         my ($mbts) = $U->fetch_mbts($xactid, $e);
334         if( $mbts->balance_owed != 0 ) {
335             $logger->info("* re-opening xact $xactid, orig xact_finish is ".$xact->xact_finish);
336             $xact->clear_xact_finish;
337             $e->update_money_billable_transaction($xact)
338                 or return $e->die_event;
339         } 
340     }
341
342     return undef;
343 }
344
345
346 sub create_bill {
347         my( $e, $amount, $type, $xactid ) = @_;
348
349         $logger->info("The system is charging $amount [$type] on xact $xactid");
350
351     # -----------------------------------------------------------------
352     # now create the billing
353         my $bill = Fieldmapper::money::billing->new;
354         $bill->xact($xactid);
355         $bill->amount($amount);
356         $bill->billing_type($type); 
357         $bill->note('SYSTEM GENERATED');
358     $e->create_money_billing($bill) or return $e->die_event;
359
360         return undef;
361 }
362
363
364
365 # -----------------------------------------------------------------
366 # Voids overdue fines on the given circ.  if a backdate is 
367 # provided, then we only void back to the backdate
368 # -----------------------------------------------------------------
369 sub void_overdues {
370     my( $e, $circ, $backdate ) = @_;
371
372     my $bill_search = { 
373         xact => $circ->id, 
374         billing_type => OILS_BILLING_TYPE_OVERDUE_MATERIALS 
375     };
376
377     if( $backdate ) {
378         # ------------------------------------------------------------------
379         # Fines for overdue materials are assessed up to, but not including,
380         # one fine interval after the fines are applicable.  Here, we add
381         # one fine interval to the backdate to ensure that we are not 
382         # voiding fines that were applicable before the backdate.
383         # ------------------------------------------------------------------
384
385         # if there is a raw time component (e.g. from postgres), 
386         # turn it into an interval that interval_to_seconds can parse
387         my $duration = $circ->fine_interval;
388         $duration =~ s/(\d{2}):(\d{2}):(\d{2})/$1 h $2 m $3 s/o;
389         my $interval = OpenSRF::Utils->interval_to_seconds($duration);
390
391         my $date = DateTime::Format::ISO8601->parse_datetime($backdate);
392         $backdate = $U->epoch2ISO8601($date->epoch + $interval);
393         $logger->info("applying backdate $backdate in overdue voiding");
394         $$bill_search{billing_ts} = {'>=' => $backdate};
395     }
396
397     my $bills = $e->search_money_billing($bill_search);
398     
399     for my $bill (@$bills) {
400         next if $U->is_true($bill->voided);
401         $logger->info("voiding overdue bill ".$bill->id);
402         $bill->voided('t');
403         $bill->void_time('now');
404         $bill->voider($e->requestor->id);
405         my $n = $bill->note || "";
406         $bill->note("$n\nSystem: VOIDED FOR BACKDATE");
407         $e->update_money_billing($bill) or return $e->die_event;
408     }
409
410         return undef;
411 }
412
413
414
415
416 __PACKAGE__->register_method(
417         method  => "set_circ_claims_returned",
418         api_name        => "open-ils.circ.circulation.set_claims_returned",
419         signature       => q/
420         Sets the circ for the given item as claims returned
421         If a backdate is provided, overdue fines will be voided
422         back to the backdate
423                 @param auth
424                 @param args : barcode, backdate
425         /
426 );
427
428 sub set_circ_claims_returned {
429     my( $self, $conn, $auth, $args ) = @_;
430
431     my $e = new_editor(authtoken=>$auth, xact=>1);
432     return $e->die_event unless $e->checkauth;
433
434     my $barcode = $$args{barcode};
435     my $backdate = $$args{backdate};
436
437     $logger->info("marking circ for item $barcode as claims returned".
438         (($backdate) ? " with backdate $backdate" : ''));
439
440     my $copy = $e->search_asset_copy({barcode=>$barcode, deleted=>'f'})->[0] 
441         or return $e->die_event;
442
443     my $circ = $e->search_action_circulation(
444         {checkin_time => undef, target_copy => $copy->id})->[0]
445             or return $e->die_event;
446
447     $e->allowed('SET_CIRC_CLAIMS_RETURNED', $circ->circ_lib) 
448         or return $e->die_event;
449
450     $circ->stop_fines(OILS_STOP_FINES_CLAIMSRETURNED);
451         $circ->stop_fines_time('now') unless $circ->stop_fines_time;
452
453     if( $backdate ) {
454         # make it look like the circ stopped at the cliams returned time
455         $circ->stop_fines_time(clense_ISO8601($backdate));
456         my $evt = void_overdues($e, $circ, $backdate);
457         return $evt if $evt;
458     }
459
460     $e->update_action_circulation($circ) or return $e->die_event;
461     $e->commit;
462     return 1;
463 }
464
465
466
467
468
469 __PACKAGE__->register_method (
470         method          => 'set_circ_due_date',
471         api_name                => 'open-ils.circ.circulation.due_date.update',
472         signature       => q/
473                 Updates the due_date on the given circ
474                 @param authtoken
475                 @param circid The id of the circ to update
476                 @param date The timestamp of the new due date
477         /
478 );
479
480 sub set_circ_due_date {
481         my( $self, $conn, $auth, $circ_id, $date ) = @_;
482
483     my $e = new_editor(xact=>1, authtoken=>$auth);
484     return $e->die_event unless $e->checkauth;
485     my $circ = $e->retrieve_action_circulation($circ_id)
486         or return $e->die_event;
487
488     return $e->die_event unless $e->allowed('CIRC_OVERRIDE_DUE_DATE', $circ->circ_lib);
489         $date = clense_ISO8601($date);
490         $circ->due_date($date);
491     $e->update_action_circulation($circ) or return $e->die_event;
492     $e->commit;
493
494     return $circ->id;
495 }
496
497
498 __PACKAGE__->register_method(
499         method          => "create_in_house_use",
500         api_name                => 'open-ils.circ.in_house_use.create',
501         signature       =>      q/
502                 Creates an in-house use action.
503                 @param $authtoken The login session key
504                 @param params A hash of params including
505                         'location' The org unit id where the in-house use occurs
506                         'copyid' The copy in question
507                         'count' The number of in-house uses to apply to this copy
508                 @return An array of id's representing the id's of the newly created
509                 in-house use objects or an event on an error
510         /);
511
512 __PACKAGE__->register_method(
513         method          => "create_in_house_use",
514         api_name                => 'open-ils.circ.non_cat_in_house_use.create',
515 );
516
517
518 sub create_in_house_use {
519         my( $self, $client, $auth, $params ) = @_;
520
521         my( $evt, $copy );
522         my $org                 = $params->{location};
523         my $copyid              = $params->{copyid};
524         my $count               = $params->{count} || 1;
525         my $nc_type             = $params->{non_cat_type};
526         my $use_time    = $params->{use_time} || 'now';
527
528         my $e = new_editor(xact=>1,authtoken=>$auth);
529         return $e->event unless $e->checkauth;
530         return $e->event unless $e->allowed('CREATE_IN_HOUSE_USE');
531
532         my $non_cat = 1 if $self->api_name =~ /non_cat/;
533
534         unless( $non_cat ) {
535                 if( $copyid ) {
536                         $copy = $e->retrieve_asset_copy($copyid) or return $e->event;
537                 } else {
538                         $copy = $e->search_asset_copy({barcode=>$params->{barcode}, deleted => 'f'})->[0]
539                                 or return $e->event;
540                         $copyid = $copy->id;
541                 }
542         }
543
544         if( $use_time ne 'now' ) {
545                 $use_time = clense_ISO8601($use_time);
546                 $logger->debug("in_house_use setting use time to $use_time");
547         }
548
549         my @ids;
550         for(1..$count) {
551
552                 my $ihu;
553                 my $method;
554                 my $cmeth;
555
556                 if($non_cat) {
557                         $ihu = Fieldmapper::action::non_cat_in_house_use->new;
558                         $ihu->item_type($nc_type);
559                         $method = 'open-ils.storage.direct.action.non_cat_in_house_use.create';
560                         $cmeth = "create_action_non_cat_in_house_use";
561
562                 } else {
563                         $ihu = Fieldmapper::action::in_house_use->new;
564                         $ihu->item($copyid);
565                         $method = 'open-ils.storage.direct.action.in_house_use.create';
566                         $cmeth = "create_action_in_house_use";
567                 }
568
569                 $ihu->staff($e->requestor->id);
570                 $ihu->org_unit($org);
571                 $ihu->use_time($use_time);
572
573                 $ihu = $e->$cmeth($ihu) or return $e->event;
574                 push( @ids, $ihu->id );
575         }
576
577         $e->commit;
578         return \@ids;
579 }
580
581
582
583
584
585 __PACKAGE__->register_method(
586         method  => "view_circs",
587         api_name        => "open-ils.circ.copy_checkout_history.retrieve",
588         notes           => q/
589                 Retrieves the last X circs for a given copy
590                 @param authtoken The login session key
591                 @param copyid The copy to check
592                 @param count How far to go back in the item history
593                 @return An array of circ ids
594         /);
595
596 # ----------------------------------------------------------------------
597 # Returns $count most recent circs.  If count exceeds the configured 
598 # max, use the configured max instead
599 # ----------------------------------------------------------------------
600 sub view_circs {
601         my( $self, $client, $authtoken, $copyid, $count ) = @_; 
602
603     my $e = new_editor(authtoken => $authtoken);
604     return $e->event unless $e->checkauth;
605     
606     my $copy = $e->retrieve_asset_copy([
607         $copyid,
608         {   flesh => 1,
609             flesh_fields => {acp => ['call_number']}
610         }
611     ]) or return $e->event;
612
613     return $e->event unless $e->allowed(
614         'VIEW_COPY_CHECKOUT_HISTORY', 
615         ($copy->call_number == OILS_PRECAT_CALL_NUMBER) ? 
616             $copy->circ_lib : $copy->call_number->owning_lib);
617         
618     my $max_history = $U->ou_ancestor_setting_value(
619         $user->home_ou, 'circ.item_checkout_history.max', $e);
620     $count = ($max_history and $max_history < $count) ? $max_history : $count;
621
622         return [] unless $count;
623
624     return $e->search_action_circulation([
625         {target_copy => $copyid}, 
626         {limit => $count, order_by => { circ => "xact_start DESC" }} 
627     ]);
628 }
629
630
631 __PACKAGE__->register_method(
632         method  => "circ_count",
633         api_name        => "open-ils.circ.circulation.count",
634         notes           => q/
635                 Returns the number of times the item has circulated
636                 @param copyid The copy to check
637         /);
638
639 sub circ_count {
640         my( $self, $client, $copyid, $range ) = @_; 
641         my $e = OpenILS::Utils::Editor->new;
642         return $e->request('open-ils.storage.asset.copy.circ_count', $copyid, $range);
643 }
644
645
646
647 __PACKAGE__->register_method(
648         method          => 'fetch_notes',
649         api_name                => 'open-ils.circ.copy_note.retrieve.all',
650         signature       => q/
651                 Returns an array of copy note objects.  
652                 @param args A named hash of parameters including:
653                         authtoken       : Required if viewing non-public notes
654                         itemid          : The id of the item whose notes we want to retrieve
655                         pub                     : True if all the caller wants are public notes
656                 @return An array of note objects
657         /);
658
659 __PACKAGE__->register_method(
660         method          => 'fetch_notes',
661         api_name                => 'open-ils.circ.call_number_note.retrieve.all',
662         signature       => q/@see open-ils.circ.copy_note.retrieve.all/);
663
664 __PACKAGE__->register_method(
665         method          => 'fetch_notes',
666         api_name                => 'open-ils.circ.title_note.retrieve.all',
667         signature       => q/@see open-ils.circ.copy_note.retrieve.all/);
668
669
670 # NOTE: VIEW_COPY/VOLUME/TITLE_NOTES perms should always be global
671 sub fetch_notes {
672         my( $self, $connection, $args ) = @_;
673
674         my $id = $$args{itemid};
675         my $authtoken = $$args{authtoken};
676         my( $r, $evt);
677
678         if( $self->api_name =~ /copy/ ) {
679                 if( $$args{pub} ) {
680                         return $U->cstorereq(
681                                 'open-ils.cstore.direct.asset.copy_note.search.atomic',
682                                 { owning_copy => $id, pub => 't' } );
683                 } else {
684                         ( $r, $evt ) = $U->checksesperm($authtoken, 'VIEW_COPY_NOTES');
685                         return $evt if $evt;
686                         return $U->cstorereq(
687                                 'open-ils.cstore.direct.asset.copy_note.search.atomic', {owning_copy => $id} );
688                 }
689
690         } elsif( $self->api_name =~ /call_number/ ) {
691                 if( $$args{pub} ) {
692                         return $U->cstorereq(
693                                 'open-ils.cstore.direct.asset.call_number_note.search.atomic',
694                                 { call_number => $id, pub => 't' } );
695                 } else {
696                         ( $r, $evt ) = $U->checksesperm($authtoken, 'VIEW_VOLUME_NOTES');
697                         return $evt if $evt;
698                         return $U->cstorereq(
699                                 'open-ils.cstore.direct.asset.call_number_note.search.atomic', { call_number => $id } );
700                 }
701
702         } elsif( $self->api_name =~ /title/ ) {
703                 if( $$args{pub} ) {
704                         return $U->cstorereq(
705                                 'open-ils.cstore.direct.bilbio.record_note.search.atomic',
706                                 { record => $id, pub => 't' } );
707                 } else {
708                         ( $r, $evt ) = $U->checksesperm($authtoken, 'VIEW_TITLE_NOTES');
709                         return $evt if $evt;
710                         return $U->cstorereq(
711                                 'open-ils.cstore.direct.biblio.record_note.search.atomic', { record => $id } );
712                 }
713         }
714
715         return undef;
716 }
717
718 __PACKAGE__->register_method(
719         method  => 'has_notes',
720         api_name        => 'open-ils.circ.copy.has_notes');
721 __PACKAGE__->register_method(
722         method  => 'has_notes',
723         api_name        => 'open-ils.circ.call_number.has_notes');
724 __PACKAGE__->register_method(
725         method  => 'has_notes',
726         api_name        => 'open-ils.circ.title.has_notes');
727
728
729 sub has_notes {
730         my( $self, $conn, $authtoken, $id ) = @_;
731         my $editor = OpenILS::Utils::Editor->new(authtoken => $authtoken);
732         return $editor->event unless $editor->checkauth;
733
734         my $n = $editor->search_asset_copy_note(
735                 {owning_copy=>$id}, {idlist=>1}) if $self->api_name =~ /copy/;
736
737         $n = $editor->search_asset_call_number_note(
738                 {call_number=>$id}, {idlist=>1}) if $self->api_name =~ /call_number/;
739
740         $n = $editor->search_biblio_record_note(
741                 {record=>$id}, {idlist=>1}) if $self->api_name =~ /title/;
742
743         return scalar @$n;
744 }
745
746
747
748 __PACKAGE__->register_method(
749         method          => 'create_copy_note',
750         api_name                => 'open-ils.circ.copy_note.create',
751         signature       => q/
752                 Creates a new copy note
753                 @param authtoken The login session key
754                 @param note     The note object to create
755                 @return The id of the new note object
756         /);
757
758 sub create_copy_note {
759         my( $self, $connection, $authtoken, $note ) = @_;
760
761         my $e = new_editor(xact=>1, authtoken=>$authtoken);
762         return $e->event unless $e->checkauth;
763         my $copy = $e->retrieve_asset_copy(
764                 [
765                         $note->owning_copy,
766                         {       flesh => 1,
767                                 flesh_fields => { 'acp' => ['call_number'] }
768                         }
769                 ]
770         );
771
772         return $e->event unless 
773                 $e->allowed('CREATE_COPY_NOTE', $copy->call_number->owning_lib);
774
775         $note->create_date('now');
776         $note->creator($e->requestor->id);
777         $note->pub( ($U->is_true($note->pub)) ? 't' : 'f' );
778         $note->clear_id;
779
780         $e->create_asset_copy_note($note) or return $e->event;
781         $e->commit;
782         return $note->id;
783 }
784
785
786 __PACKAGE__->register_method(
787         method          => 'delete_copy_note',
788         api_name                =>      'open-ils.circ.copy_note.delete',
789         signature       => q/
790                 Deletes an existing copy note
791                 @param authtoken The login session key
792                 @param noteid The id of the note to delete
793                 @return 1 on success - Event otherwise.
794                 /);
795 sub delete_copy_note {
796         my( $self, $conn, $authtoken, $noteid ) = @_;
797
798         my $e = new_editor(xact=>1, authtoken=>$authtoken);
799         return $e->die_event unless $e->checkauth;
800
801         my $note = $e->retrieve_asset_copy_note([
802                 $noteid,
803                 { flesh => 2,
804                         flesh_fields => {
805                                 'acpn' => [ 'owning_copy' ],
806                                 'acp' => [ 'call_number' ],
807                         }
808                 }
809         ]) or return $e->die_event;
810
811         if( $note->creator ne $e->requestor->id ) {
812                 return $e->die_event unless 
813                         $e->allowed('DELETE_COPY_NOTE', $note->owning_copy->call_number->owning_lib);
814         }
815
816         $e->delete_asset_copy_note($note) or return $e->die_event;
817         $e->commit;
818         return 1;
819 }
820
821
822 __PACKAGE__->register_method(
823         method => 'age_hold_rules',
824         api_name        =>  'open-ils.circ.config.rules.age_hold_protect.retrieve.all',
825 );
826
827 sub age_hold_rules {
828         my( $self, $conn ) = @_;
829         return new_editor()->retrieve_all_config_rules_age_hold_protect();
830 }
831
832
833
834 __PACKAGE__->register_method(
835         method => 'copy_details_barcode',
836     authoritative => 1,
837         api_name => 'open-ils.circ.copy_details.retrieve.barcode');
838 sub copy_details_barcode {
839         my( $self, $conn, $auth, $barcode ) = @_;
840     my $e = new_editor();
841     my $cid = $e->search_asset_copy({barcode=>$barcode, deleted=>'f'}, {idlist=>1})->[0];
842     return $e->event unless $cid;
843         return copy_details( $self, $conn, $auth, $cid );
844 }
845
846
847 __PACKAGE__->register_method(
848         method => 'copy_details',
849         api_name => 'open-ils.circ.copy_details.retrieve');
850
851 sub copy_details {
852         my( $self, $conn, $auth, $copy_id ) = @_;
853         my $e = new_editor(authtoken=>$auth);
854         return $e->event unless $e->checkauth;
855
856         my $flesh = { flesh => 1 };
857
858         my $copy = $e->retrieve_asset_copy(
859                 [
860                         $copy_id,
861                         {
862                                 flesh => 2,
863                                 flesh_fields => {
864                                         acp => ['call_number'],
865                                         acn => ['record']
866                                 }
867                         }
868                 ]) or return $e->event;
869
870
871         # De-flesh the copy for backwards compatibility
872         my $mvr;
873         my $vol = $copy->call_number;
874         if( ref $vol ) {
875                 $copy->call_number($vol->id);
876                 my $record = $vol->record;
877                 if( ref $record ) {
878                         $vol->record($record->id);
879                         $mvr = $U->record_to_mvr($record);
880                 }
881         }
882
883
884         my $hold = $e->search_action_hold_request(
885                 { 
886                         current_copy            => $copy_id, 
887                         capture_time            => { "!=" => undef },
888                         fulfillment_time        => undef,
889                         cancel_time                     => undef,
890                 }
891         )->[0];
892
893         OpenILS::Application::Circ::Holds::flesh_hold_transits([$hold]) if $hold;
894
895         my $transit = $e->search_action_transit_copy(
896                 { target_copy => $copy_id, dest_recv_time => undef } )->[0];
897
898         # find the latest circ, open or closed
899         my $circ = $e->search_action_circulation(
900                 [
901                         { target_copy => $copy_id },
902                         { order_by => { circ => 'xact_start desc' }, limit => 1 }
903                 ]
904         )->[0];
905
906
907         return {
908                 copy            => $copy,
909                 hold            => $hold,
910                 transit => $transit,
911                 circ            => $circ,
912                 volume  => $vol,
913                 mvr             => $mvr,
914         };
915 }
916
917
918
919
920 __PACKAGE__->register_method(
921         method => 'mark_item',
922         api_name => 'open-ils.circ.mark_item_damaged',
923 );
924 __PACKAGE__->register_method(
925         method => 'mark_item',
926         api_name => 'open-ils.circ.mark_item_missing',
927 );
928
929 sub mark_item {
930         my( $self, $conn, $auth, $copy_id ) = @_;
931         my $e = new_editor(authtoken=>$auth, xact =>1);
932         return $e->event unless $e->checkauth;
933
934         my $perm = 'MARK_ITEM_MISSING';
935         my $stat = OILS_COPY_STATUS_MISSING;
936
937         if( $self->api_name =~ /damaged/ ) {
938                 $perm = 'MARK_ITEM_DAMAGED';
939                 $stat = OILS_COPY_STATUS_DAMAGED;
940         }
941
942         my $copy = $e->retrieve_asset_copy($copy_id)
943                 or return $e->event;
944         $copy->status($stat);
945         $copy->edit_date('now');
946         $copy->editor($e->requestor->id);
947
948         $e->update_asset_copy($copy) or return $e->event;
949
950
951         my $holds = $e->search_action_hold_request(
952                 { 
953                         current_copy => $copy->id,
954                         fulfillment_time => undef,
955                         cancel_time => undef,
956                 }
957         );
958
959         $e->commit;
960
961         $logger->debug("reseting holds that target the marked copy");
962         OpenILS::Application::Circ::Holds->_reset_hold($e->requestor, $_) for @$holds;
963
964         return 1;
965 }
966
967
968
969
970
971
972 # ----------------------------------------------------------------------
973 __PACKAGE__->register_method(
974         method => 'magic_fetch',
975         api_name => 'open-ils.agent.fetch'
976 );
977
978 my @FETCH_ALLOWED = qw/ aou aout acp acn bre /;
979
980 sub magic_fetch {
981         my( $self, $conn, $auth, $args ) = @_;
982         my $e = new_editor( authtoken => $auth );
983         return $e->event unless $e->checkauth;
984
985         my $hint = $$args{hint};
986         my $id  = $$args{id};
987
988         # Is the call allowed to fetch this type of object?
989         return undef unless grep { $_ eq $hint } @FETCH_ALLOWED;
990
991         # Find the class the iplements the given hint
992         my ($class) = grep { 
993                 $Fieldmapper::fieldmap->{$_}{hint} eq $hint } Fieldmapper->classes;
994
995         $class =~ s/Fieldmapper:://og;
996         $class =~ s/::/_/og;
997         my $method = "retrieve_$class";
998
999         my $obj = $e->$method($id) or return $e->event;
1000         return $obj;
1001 }
1002 # ----------------------------------------------------------------------
1003
1004
1005 __PACKAGE__->register_method(
1006         method  => "fleshed_circ_retrieve",
1007     authoritative => 1,
1008         api_name        => "open-ils.circ.fleshed.retrieve",);
1009
1010 sub fleshed_circ_retrieve {
1011         my( $self, $client, $id ) = @_;
1012         my $e = new_editor();
1013         my $circ = $e->retrieve_action_circulation(
1014                 [
1015                         $id,
1016                         { 
1017                                 flesh                           => 4,
1018                                 flesh_fields    => { 
1019                                         circ => [ qw/ target_copy / ],
1020                                         acp => [ qw/ location status stat_cat_entry_copy_maps notes age_protect call_number / ],
1021                                         ascecm => [ qw/ stat_cat stat_cat_entry / ],
1022                                         acn => [ qw/ record / ],
1023                                 }
1024                         }
1025                 ]
1026         ) or return $e->event;
1027         
1028         my $copy = $circ->target_copy;
1029         my $vol = $copy->call_number;
1030         my $rec = $circ->target_copy->call_number->record;
1031
1032         $vol->record($rec->id);
1033         $copy->call_number($vol->id);
1034         $circ->target_copy($copy->id);
1035
1036         my $mvr;
1037
1038         if( $rec->id == OILS_PRECAT_RECORD ) {
1039                 $rec = undef;
1040                 $vol = undef;
1041         } else { 
1042                 $mvr = $U->record_to_mvr($rec);
1043                 $rec->marc(''); # drop the bulky marc data
1044         }
1045
1046         return {
1047                 circ => $circ,
1048                 copy => $copy,
1049                 volume => $vol,
1050                 record => $rec,
1051                 mvr => $mvr,
1052         };
1053 }
1054
1055 # {"select":{"acp":["id"],"circ":[{"aggregate":true,"transform":"count","alias":"count","column":"id"}]},"from":{"acp":{"circ":{"field":"target_copy","fkey":"id","type":"left"},"acn"{"field":"id","fkey":"call_number"}}},"where":{"+acn":{"record":200057}}
1056
1057
1058 1;