Open-ILS/src/perlmods/OpenILS/Application/Circ.pm

   1 package OpenILS::Application::Circ;
   2 use base qw/OpenSRF::Application/;
   3 use strict; use warnings;
   4
   5 use OpenILS::Application::Circ::Circulate;
   6 use OpenILS::Application::Circ::Survey;
   7 use OpenILS::Application::Circ::StatCat;
   8 use OpenILS::Application::Circ::Holds;
   9 use OpenILS::Application::Circ::HoldNotify;
  10 use OpenILS::Application::Circ::Money;
  11 use OpenILS::Application::Circ::NonCat;
  12 use OpenILS::Application::Circ::CopyLocations;
  13
  14 use DateTime;
  15 use DateTime::Format::ISO8601;
  16
  17 use OpenILS::Application::AppUtils;
  18
  19 use OpenSRF::Utils qw/:datetime/;
  20 use OpenILS::Utils::ModsParser;
  21 use OpenILS::Event;
  22 use OpenSRF::EX qw(:try);
  23 use OpenSRF::Utils::Logger qw(:logger);
  24 use OpenILS::Utils::Fieldmapper;
  25 use OpenILS::Utils::Editor;
  26 use OpenILS::Utils::CStoreEditor q/:funcs/;
  27 use OpenILS::Const qw/:const/;
  28 use OpenSRF::Utils::SettingsClient;
  29
  30 my $apputils = "OpenILS::Application::AppUtils";
  31 my $U = $apputils;
  32
  33
  34 # ------------------------------------------------------------------------
  35 # Top level Circ package;
  36 # ------------------------------------------------------------------------
  37
  38 sub initialize {
  39         my $self = shift;
  40         OpenILS::Application::Circ::Circulate->initialize();
  41 }
  42
  43
  44 __PACKAGE__->register_method(
  45         method => 'retrieve_circ',
  46         api_name        => 'open-ils.circ.retrieve',
  47         signature => q/
  48                 Retrieve a circ object by id
  49                 @param authtoken Login session key
  50                 @pararm circid The id of the circ object
  51         /
  52 );
  53 sub retrieve_circ {
  54         my( $s, $c, $a, $i ) = @_;
  55         my $e = new_editor(authtoken => $a);
  56         return $e->event unless $e->checkauth;
  57         my $circ = $e->retrieve_action_circulation($i) or return $e->event;
  58         if( $e->requestor->id ne $circ->usr ) {
  59                 return $e->event unless $e->allowed('VIEW_CIRCULATIONS');
  60         }
  61         return $circ;
  62 }
  63
  64
  65 __PACKAGE__->register_method(
  66         method => 'fetch_circ_mods',
  67         api_name => 'open-ils.circ.circ_modifier.retrieve.all');
  68 sub fetch_circ_mods {
  69         my $conf = OpenSRF::Utils::SettingsClient->new;
  70         return $conf->config_value(
  71                 'apps', 'open-ils.circ', 'app_settings', 'circ_modifiers', 'mod' );
  72 }
  73
  74 __PACKAGE__->register_method(
  75         method => 'fetch_bill_types',
  76         api_name => 'open-ils.circ.billing_type.retrieve.all');
  77 sub fetch_bill_types {
  78         my $conf = OpenSRF::Utils::SettingsClient->new;
  79         return $conf->config_value(
  80                 'apps', 'open-ils.circ', 'app_settings', 'billing_types', 'type' );
  81 }
  82
  83
  84 # ------------------------------------------------------------------------
  85 # Returns an array of {circ, record} hashes checked out by the user.
  86 # ------------------------------------------------------------------------
  87 __PACKAGE__->register_method(
  88         method  => "checkouts_by_user",
  89         api_name        => "open-ils.circ.actor.user.checked_out",
  90         NOTES           => <<"  NOTES");
  91         Returns a list of open circulations as a pile of objects.  each object
  92         contains the relevant copy, circ, and record
  93         NOTES
  94
  95 sub checkouts_by_user {
  96         my( $self, $client, $user_session, $user_id ) = @_;
  97
  98         my( $requestor, $target, $copy, $record, $evt );
  99
 100         ( $requestor, $target, $evt ) =
 101                 $apputils->checkses_requestor( $user_session, $user_id, 'VIEW_CIRCULATIONS');
 102         return $evt if $evt;
 103
 104         my $circs = $apputils->simplereq(
 105                 'open-ils.cstore',
 106                 "open-ils.cstore.direct.action.open_circulation.search.atomic",
 107                 { usr => $target->id, checkin_time => undef } );
 108 #               { usr => $target->id } );
 109
 110         my @results;
 111         for my $circ (@$circs) {
 112
 113                 ( $copy, $evt )  = $apputils->fetch_copy($circ->target_copy);
 114                 return $evt if $evt;
 115
 116                 $logger->debug("Retrieving record for copy " . $circ->target_copy);
 117
 118                 ($record, $evt) = $apputils->fetch_record_by_copy( $circ->target_copy );
 119                 return $evt if $evt;
 120
 121                 my $mods = $apputils->record_to_mvr($record);
 122
 123                 push( @results, { copy => $copy, circ => $circ, record => $mods } );
 124         }
 125
 126         return \@results;
 127
 128 }
 129
 130
 131
 132 __PACKAGE__->register_method(
 133         method  => "checkouts_by_user_slim",
 134         api_name        => "open-ils.circ.actor.user.checked_out.slim",
 135         NOTES           => <<"  NOTES");
 136         Returns a list of open circulation objects
 137         NOTES
 138
 139 # DEPRECAT ME?? XXX
 140 sub checkouts_by_user_slim {
 141         my( $self, $client, $user_session, $user_id ) = @_;
 142
 143         my( $requestor, $target, $copy, $record, $evt );
 144
 145         ( $requestor, $target, $evt ) =
 146                 $apputils->checkses_requestor( $user_session, $user_id, 'VIEW_CIRCULATIONS');
 147         return $evt if $evt;
 148
 149         $logger->debug( 'User ' . $requestor->id .
 150                 " retrieving checked out items for user " . $target->id );
 151
 152         # XXX Make the call correct..
 153         return $apputils->simplereq(
 154                 'open-ils.cstore',
 155                 "open-ils.cstore.direct.action.open_circulation.search.atomic",
 156                 { usr => $target->id, checkin_time => undef } );
 157 #               { usr => $target->id } );
 158 }
 159
 160
 161 __PACKAGE__->register_method(
 162         method  => "checkouts_by_user_opac",
 163         api_name        => "open-ils.circ.actor.user.checked_out.opac",);
 164
 165 # XXX Deprecate Me
 166 sub checkouts_by_user_opac {
 167         my( $self, $client, $auth, $user_id ) = @_;
 168
 169         my $e = OpenILS::Utils::Editor->new( authtoken => $auth );
 170         return $e->event unless $e->checkauth;
 171         $user_id ||= $e->requestor->id;
 172         return $e->event unless
 173                 my $patron = $e->retrieve_actor_user($user_id);
 174
 175         my $data;
 176         my $search = {usr => $user_id, stop_fines => undef};
 177
 178         if( $user_id ne $e->requestor->id ) {
 179                 $data = $e->search_action_circulation(
 180                         $search, {checkperm=>1, permorg=>$patron->home_ou})
 181                         or return $e->event;
 182
 183         } else {
 184                 $data = $e->search_action_circulation($search);
 185         }
 186
 187         return $data;
 188 }
 189
 190
 191 __PACKAGE__->register_method(
 192         method  => "title_from_transaction",
 193         api_name        => "open-ils.circ.circ_transaction.find_title",
 194         NOTES           => <<"  NOTES");
 195         Returns a mods object for the title that is linked to from the
 196         copy from the hold that created the given transaction
 197         NOTES
 198
 199 sub title_from_transaction {
 200         my( $self, $client, $login_session, $transactionid ) = @_;
 201
 202         my( $user, $circ, $title, $evt );
 203
 204         ( $user, $evt ) = $apputils->checkses( $login_session );
 205         return $evt if $evt;
 206
 207         ( $circ, $evt ) = $apputils->fetch_circulation($transactionid);
 208         return $evt if $evt;
 209
 210         ($title, $evt) = $apputils->fetch_record_by_copy($circ->target_copy);
 211         return $evt if $evt;
 212
 213         return $apputils->record_to_mvr($title);
 214 }
 215
 216
 217 __PACKAGE__->register_method(
 218         method  => "set_circ_lost",
 219         api_name        => "open-ils.circ.circulation.set_lost",
 220         NOTES           => <<"  NOTES");
 221         Params are login, barcode
 222         login must have SET_CIRC_LOST perms
 223         Sets a circulation to lost
 224         NOTES
 225
 226 __PACKAGE__->register_method(
 227         method  => "set_circ_lost",
 228         api_name        => "open-ils.circ.circulation.set_claims_returned",
 229         NOTES           => <<"  NOTES");
 230         Params are login, barcode
 231         login must have SET_CIRC_MISSING perms
 232         Sets a circulation to lost
 233         NOTES
 234
 235 sub set_circ_lost {
 236         my( $self, $client, $login, $args ) = @_;
 237         my( $user, $circ, $copy, $evt );
 238
 239         my $barcode             = $$args{barcode};
 240         my $backdate    = $$args{backdate};
 241
 242         ( $user, $evt ) = $U->checkses($login);
 243         return $evt if $evt;
 244
 245         # Grab the related copy
 246         ($copy, $evt) = $U->fetch_copy_by_barcode($barcode);
 247         return $evt if $evt;
 248
 249         my $isclaims    = $self->api_name =~ /claims_returned/;
 250         my $islost              = $self->api_name =~ /lost/;
 251         my $session             = $U->start_db_session();
 252
 253         # grab the circulation
 254         ( $circ ) = $U->fetch_open_circulation( $copy->id );
 255         return 1 unless $circ;
 256
 257         if($islost) {
 258                 $evt  = _set_circ_lost($copy, $circ, $user, $session) if $islost;
 259                 return $evt if $evt;
 260         }
 261
 262         if($isclaims) {
 263                 $evt = _set_circ_claims_returned(
 264                         $user, $circ, $session, $backdate );
 265                 return $evt if $evt;
 266
 267         }
 268
 269         $circ->stop_fines_time('now') unless $circ->stop_fines_time;
 270         my $s = $session->request(
 271                 "open-ils.storage.direct.action.circulation.update", $circ )->gather(1);
 272
 273         return $U->DB_UPDATE_FAILED($circ) unless defined($s);
 274         $U->commit_db_session($session);
 275
 276         return 1;
 277 }
 278
 279 sub _set_circ_lost {
 280         my( $copy, $circ, $reqr, $session ) = @_;
 281
 282         my $evt = $U->check_perms($reqr->id, $circ->circ_lib, 'SET_CIRC_LOST');
 283         return $evt if $evt;
 284
 285         $logger->activity("user ".$reqr->id." marking copy ".$copy->id.
 286                 " lost  for circ ".  $circ->id. " and checking for necessary charges");
 287
 288         if( $copy->status ne OILS_COPY_STATUS_LOST ) {
 289                 $copy->status(OILS_COPY_STATUS_LOST);
 290                 $U->update_copy(
 291                         copy            => $copy,
 292                         editor  => $reqr->id,
 293                         session => $session);
 294         }
 295
 296         # if the copy has a price defined and/or a processing fee, bill the patron
 297
 298         # if the location that owns the copy has a processing fee, charge the user
 299         my $owner = $U->fetch_copy_owner($copy->id);
 300         $logger->info("circ fetching org settings for $owner ".
 301                 "to determine processing fee and default copy price");
 302
 303         my $settings = $U->simplereq(
 304                 'open-ils.actor', 'open-ils.actor.org_unit.settings.retrieve', $owner );
 305         my $fee = $settings->{'circ.lost_materials_processing_fee'} || 0;
 306
 307         # If the copy has a price configured, charge said price to the user
 308         my $s = OILS_SETTING_DEF_ITEM_PRICE;
 309         my $copy_price = $copy->price || 0;
 310         $copy_price = $settings->{$s} unless $copy_price and $copy_price > 0;
 311         if($copy_price and $copy_price > 0) {
 312                 $logger->debug("lost copy has a price of $copy_price");
 313                 $evt = _make_bill($session, $copy_price, 'Lost Materials', $circ->id);
 314                 return $evt if $evt;
 315         }
 316
 317
 318         if( $fee ) {
 319                 $evt = _make_bill($session, $fee, 'Lost Materials Processing Fee', $circ->id);
 320                 return $evt if $evt;
 321         }
 322
 323         $circ->stop_fines(OILS_STOP_FINES_LOST);
 324         return undef;
 325 }
 326
 327 sub _make_bill {
 328         my( $session, $amount, $type, $xactid ) = @_;
 329
 330         $logger->activity("The system is charging $amount ".
 331                 " [$type] for lost materials on circulation $xactid");
 332
 333         my $bill = Fieldmapper::money::billing->new;
 334
 335         $bill->xact($xactid);
 336         $bill->amount($amount);
 337         $bill->billing_type($type); # - XXX these strings should be configurable some day
 338         $bill->note('SYSTEM GENERATED');
 339
 340         my $id = $session->request(
 341                 'open-ils.storage.direct.money.billing.create', $bill )->gather(1);
 342
 343         return $U->DB_UPDATE_FAILED($bill) unless defined $id;
 344         return undef;
 345 }
 346
 347 sub _set_circ_claims_returned {
 348         my( $reqr, $circ, $session, $backdate ) = @_;
 349
 350         my $evt = $U->check_perms($reqr->id, $circ->circ_lib, 'SET_CIRC_CLAIMS_RETURNED');
 351         return $evt if $evt;
 352         $circ->stop_fines("CLAIMSRETURNED");
 353
 354         $logger->activity("user ".$reqr->id.
 355                 " marking circ".  $circ->id. " as claims returned");
 356
 357         # allow the caller to backdate the circulation and void any fines
 358         # that occurred after the backdate
 359         if($backdate) {
 360                 OpenILS::Application::Circ::Circulate::_checkin_handle_backdate(
 361                         $backdate, $circ, $reqr, $session );
 362                 $circ->stop_fines_time(clense_ISO8601($backdate))
 363         }
 364
 365         return undef;
 366 }
 367
 368
 369
 370 __PACKAGE__->register_method (
 371         method          => 'set_circ_due_date',
 372         api_name                => 'open-ils.circ.circulation.due_date.update',
 373         signature       => q/
 374                 Updates the due_date on the given circ
 375                 @param authtoken
 376                 @param circid The id of the circ to update
 377                 @param date The timestamp of the new due date
 378         /
 379 );
 380
 381 sub set_circ_due_date {
 382         my( $s, $c, $authtoken, $circid, $date ) = @_;
 383         my ($circ, $evt) = $U->fetch_circulation($circid);
 384         return $evt if $evt;
 385
 386         my $reqr;
 387         ($reqr, $evt) = $U->checkses($authtoken);
 388         return $evt if $evt;
 389
 390         $evt = $U->check_perms($reqr->id, $circ->circ_lib, 'CIRC_OVERRIDE_DUE_DATE');
 391         return $evt if $evt;
 392
 393         $date = clense_ISO8601($date);
 394         $logger->activity("user ".$reqr->id.
 395                 " updating due_date on circ $circid: $date");
 396
 397         $circ->due_date($date);
 398         my $stat = $U->storagereq(
 399                 'open-ils.storage.direct.action.circulation.update', $circ);
 400         return $U->DB_UPDATE_FAILED unless defined $stat;
 401         return $stat;
 402 }
 403
 404
 405 __PACKAGE__->register_method(
 406         method          => "create_in_house_use",
 407         api_name                => 'open-ils.circ.in_house_use.create',
 408         signature       =>      q/
 409                 Creates an in-house use action.
 410                 @param $authtoken The login session key
 411                 @param params A hash of params including
 412                         'location' The org unit id where the in-house use occurs
 413                         'copyid' The copy in question
 414                         'count' The number of in-house uses to apply to this copy
 415                 @return An array of id's representing the id's of the newly created
 416                 in-house use objects or an event on an error
 417         /);
 418
 419 __PACKAGE__->register_method(
 420         method          => "create_in_house_use",
 421         api_name                => 'open-ils.circ.non_cat_in_house_use.create',
 422 );
 423
 424 =head OLD CODE
 425 sub ___create_in_house_use {
 426         my( $self, $client, $authtoken, $params ) = @_;
 427
 428         my( $staff, $evt, $copy );
 429         my $org                 = $params->{location};
 430         my $copyid              = $params->{copyid};
 431         my $count               = $params->{count} || 1;
 432         my $nc_type             = $params->{non_cat_type};
 433         my $use_time    = $params->{use_time} || 'now';
 434
 435         my $non_cat = 1 if $self->api_name =~ /non_cat/;
 436
 437         unless( $non_cat ) {
 438                 unless( $copyid ) {
 439                         my $barcode = $params->{barcode};
 440                         ($copy, $evt) = $U->fetch_copy_by_barcode($barcode);
 441                         return $evt if $evt;
 442                         $copyid = $copy->id;
 443                 }
 444                 ($copy, $evt) = $U->fetch_copy($copyid) unless $copy;
 445                 return $evt if $evt;
 446         }
 447
 448         ($staff, $evt) = $U->checkses($authtoken);
 449         return $evt if $evt;
 450
 451         $evt = $U->check_perms($staff->id, $org, 'CREATE_IN_HOUSE_USE');
 452         return $evt if $evt;
 453
 454         if( $use_time ne 'now' ) {
 455                 $use_time = clense_ISO8601($use_time);
 456                 $logger->debug("in_house_use setting use time to $use_time");
 457         }
 458
 459         my @ids;
 460         for(1..$count) {
 461
 462                 my $ihu;
 463                 my $method;
 464
 465                 if($non_cat) {
 466                         $ihu = Fieldmapper::action::non_cat_in_house_use->new;
 467                         $ihu->noncat_type($nc_type);
 468                         $method = 'open-ils.storage.direct.action.non_cat_in_house_use.create';
 469                 } else {
 470                         $ihu = Fieldmapper::action::in_house_use->new;
 471                         $ihu->item($copyid);
 472                         $method = 'open-ils.storage.direct.action.in_house_use.create';
 473                 }
 474
 475                 $ihu->staff($staff->id);
 476                 $ihu->org_unit($org);
 477                 $ihu->use_time($use_time);
 478
 479                 my $id = $U->simplereq('open-ils.storage', $method, $ihu );
 480
 481                 return $U->DB_UPDATE_FAILED($ihu) unless $id;
 482                 push @ids, $id;
 483         }
 484
 485         return \@ids;
 486 }
 487 =cut
 488
 489
 490
 491
 492 sub create_in_house_use {
 493         my( $self, $client, $auth, $params ) = @_;
 494
 495         my( $evt, $copy );
 496         my $org                 = $params->{location};
 497         my $copyid              = $params->{copyid};
 498         my $count               = $params->{count} || 1;
 499         my $nc_type             = $params->{non_cat_type};
 500         my $use_time    = $params->{use_time} || 'now';
 501
 502         my $e = new_editor(xact=>1,authtoken=>$auth);
 503         return $e->event unless $e->checkauth;
 504         return $e->event unless $e->allowed('CREATE_IN_HOUSE_USE');
 505
 506         my $non_cat = 1 if $self->api_name =~ /non_cat/;
 507
 508         unless( $non_cat ) {
 509                 if( $copyid ) {
 510                         $copy = $e->retrieve_asset_copy($copyid) or return $e->event;
 511                 } else {
 512                         $copy = $e->search_asset_copy({barcode=>$params->{barcode}, deleted => 'f'})->[0]
 513                                 or return $e->event;
 514                         $copyid = $copy->id;
 515                 }
 516         }
 517
 518         if( $use_time ne 'now' ) {
 519                 $use_time = clense_ISO8601($use_time);
 520                 $logger->debug("in_house_use setting use time to $use_time");
 521         }
 522
 523         my @ids;
 524         for(1..$count) {
 525
 526                 my $ihu;
 527                 my $method;
 528                 my $cmeth;
 529
 530                 if($non_cat) {
 531                         $ihu = Fieldmapper::action::non_cat_in_house_use->new;
 532                         $ihu->item_type($nc_type);
 533                         $method = 'open-ils.storage.direct.action.non_cat_in_house_use.create';
 534                         $cmeth = "create_action_non_cat_in_house_use";
 535
 536                 } else {
 537                         $ihu = Fieldmapper::action::in_house_use->new;
 538                         $ihu->item($copyid);
 539                         $method = 'open-ils.storage.direct.action.in_house_use.create';
 540                         $cmeth = "create_action_in_house_use";
 541                 }
 542
 543                 $ihu->staff($e->requestor->id);
 544                 $ihu->org_unit($org);
 545                 $ihu->use_time($use_time);
 546
 547                 $ihu = $e->$cmeth($ihu) or return $e->event;
 548                 push( @ids, $ihu->id );
 549         }
 550
 551         return \@ids;
 552 }
 553
 554
 555
 556
 557
 558 __PACKAGE__->register_method(
 559         method  => "view_circs",
 560         api_name        => "open-ils.circ.copy_checkout_history.retrieve",
 561         notes           => q/
 562                 Retrieves the last X circs for a given copy
 563                 @param authtoken The login session key
 564                 @param copyid The copy to check
 565                 @param count How far to go back in the item history
 566                 @return An array of circ ids
 567         /);
 568
 569
 570
 571 sub view_circs {
 572         my( $self, $client, $authtoken, $copyid, $count ) = @_;
 573
 574         my( $requestor, $evt ) = $U->checksesperm(
 575                         $authtoken, 'VIEW_COPY_CHECKOUT_HISTORY' );
 576         return $evt if $evt;
 577
 578         return [] unless $count;
 579
 580         my $circs = $U->cstorereq(
 581                 'open-ils.cstore.direct.action.circulation.search.atomic',
 582                         {
 583                                 target_copy => $copyid,
 584                         },
 585                         {
 586                                 limit => $count,
 587                                 order_by => { circ => "xact_start DESC" }
 588                         }
 589         );
 590
 591         return $circs;
 592 }
 593
 594
 595 __PACKAGE__->register_method(
 596         method  => "circ_count",
 597         api_name        => "open-ils.circ.circulation.count",
 598         notes           => q/
 599                 Returns the number of times the item has circulated
 600                 @param copyid The copy to check
 601         /);
 602
 603 sub circ_count {
 604         my( $self, $client, $copyid, $range ) = @_;
 605         my $e = OpenILS::Utils::Editor->new;
 606         return $e->request('open-ils.storage.asset.copy.circ_count', $copyid, $range);
 607 }
 608
 609
 610
 611 __PACKAGE__->register_method(
 612         method          => 'fetch_notes',
 613         api_name                => 'open-ils.circ.copy_note.retrieve.all',
 614         signature       => q/
 615                 Returns an array of copy note objects.
 616                 @param args A named hash of parameters including:
 617                         authtoken       : Required if viewing non-public notes
 618                         itemid          : The id of the item whose notes we want to retrieve
 619                         pub                     : True if all the caller wants are public notes
 620                 @return An array of note objects
 621         /);
 622
 623 __PACKAGE__->register_method(
 624         method          => 'fetch_notes',
 625         api_name                => 'open-ils.circ.call_number_note.retrieve.all',
 626         signature       => q/@see open-ils.circ.copy_note.retrieve.all/);
 627
 628 __PACKAGE__->register_method(
 629         method          => 'fetch_notes',
 630         api_name                => 'open-ils.circ.title_note.retrieve.all',
 631         signature       => q/@see open-ils.circ.copy_note.retrieve.all/);
 632
 633
 634 # NOTE: VIEW_COPY/VOLUME/TITLE_NOTES perms should always be global
 635 sub fetch_notes {
 636         my( $self, $connection, $args ) = @_;
 637
 638         my $id = $$args{itemid};
 639         my $authtoken = $$args{authtoken};
 640         my( $r, $evt);
 641
 642         if( $self->api_name =~ /copy/ ) {
 643                 if( $$args{pub} ) {
 644                         return $U->cstorereq(
 645                                 'open-ils.cstore.direct.asset.copy_note.search.atomic',
 646                                 { owning_copy => $id, pub => 't' } );
 647                 } else {
 648                         ( $r, $evt ) = $U->checksesperm($authtoken, 'VIEW_COPY_NOTES');
 649                         return $evt if $evt;
 650                         return $U->cstorereq(
 651                                 'open-ils.cstore.direct.asset.copy_note.search.atomic', {owning_copy => $id} );
 652                 }
 653
 654         } elsif( $self->api_name =~ /call_number/ ) {
 655                 if( $$args{pub} ) {
 656                         return $U->cstorereq(
 657                                 'open-ils.cstore.direct.asset.call_number_note.search.atomic',
 658                                 { call_number => $id, pub => 't' } );
 659                 } else {
 660                         ( $r, $evt ) = $U->checksesperm($authtoken, 'VIEW_VOLUME_NOTES');
 661                         return $evt if $evt;
 662                         return $U->cstorereq(
 663                                 'open-ils.cstore.direct.asset.call_number_note.search.atomic', { call_number => $id } );
 664                 }
 665
 666         } elsif( $self->api_name =~ /title/ ) {
 667                 if( $$args{pub} ) {
 668                         return $U->cstorereq(
 669                                 'open-ils.cstore.direct.bilbio.record_note.search.atomic',
 670                                 { record => $id, pub => 't' } );
 671                 } else {
 672                         ( $r, $evt ) = $U->checksesperm($authtoken, 'VIEW_TITLE_NOTES');
 673                         return $evt if $evt;
 674                         return $U->cstorereq(
 675                                 'open-ils.cstore.direct.biblio.record_note.search.atomic', { record => $id } );
 676                 }
 677         }
 678
 679         return undef;
 680 }
 681
 682 __PACKAGE__->register_method(
 683         method  => 'has_notes',
 684         api_name        => 'open-ils.circ.copy.has_notes');
 685 __PACKAGE__->register_method(
 686         method  => 'has_notes',
 687         api_name        => 'open-ils.circ.call_number.has_notes');
 688 __PACKAGE__->register_method(
 689         method  => 'has_notes',
 690         api_name        => 'open-ils.circ.title.has_notes');
 691
 692
 693 sub has_notes {
 694         my( $self, $conn, $authtoken, $id ) = @_;
 695         my $editor = OpenILS::Utils::Editor->new(authtoken => $authtoken);
 696         return $editor->event unless $editor->checkauth;
 697
 698         my $n = $editor->search_asset_copy_note(
 699                 {owning_copy=>$id}, {idlist=>1}) if $self->api_name =~ /copy/;
 700
 701         $n = $editor->search_asset_call_number_note(
 702                 {call_number=>$id}, {idlist=>1}) if $self->api_name =~ /call_number/;
 703
 704         $n = $editor->search_biblio_record_note(
 705                 {record=>$id}, {idlist=>1}) if $self->api_name =~ /title/;
 706
 707         return scalar @$n;
 708 }
 709
 710 __PACKAGE__->register_method(
 711         method          => 'create_copy_note',
 712         api_name                => 'open-ils.circ.copy_note.create',
 713         signature       => q/
 714                 Creates a new copy note
 715                 @param authtoken The login session key
 716                 @param note     The note object to create
 717                 @return The id of the new note object
 718         /);
 719
 720 sub create_copy_note {
 721         my( $self, $connection, $authtoken, $note ) = @_;
 722         my( $cnowner, $requestor, $evt );
 723
 724         ($cnowner, $evt) = $U->fetch_copy_owner($note->owning_copy);
 725         return $evt if $evt;
 726         ($requestor, $evt) = $U->checkses($authtoken);
 727         return $evt if $evt;
 728         $evt = $U->check_perms($requestor->id, $cnowner, 'CREATE_COPY_NOTE');
 729         return $evt if $evt;
 730
 731         $note->create_date('now');
 732         $note->creator($requestor->id);
 733         $note->pub( ($U->is_true($note->pub)) ? 1 : 0 );
 734
 735         my $id = $U->storagereq(
 736                 'open-ils.storage.direct.asset.copy_note.create', $note );
 737         return $U->DB_UPDATE_FAILED($note) unless $id;
 738
 739         $logger->activity("User ".$requestor->id." created a new copy ".
 740                 "note [$id] for copy ".$note->owning_copy." with text ".$note->value);
 741
 742         return $id;
 743 }
 744
 745 __PACKAGE__->register_method(
 746         method          => 'delete_copy_note',
 747         api_name                =>      'open-ils.circ.copy_note.delete',
 748         signature       => q/
 749                 Deletes an existing copy note
 750                 @param authtoken The login session key
 751                 @param noteid The id of the note to delete
 752                 @return 1 on success - Event otherwise.
 753                 /);
 754
 755 sub delete_copy_note {
 756         my( $self, $conn, $authtoken, $noteid ) = @_;
 757         my( $requestor, $note, $owner, $evt );
 758
 759         ($requestor, $evt) = $U->checkses($authtoken);
 760         return $evt if $evt;
 761
 762         ($note, $evt) = $U->fetch_copy_note($noteid);
 763         return $evt if $evt;
 764
 765         if( $note->creator ne $requestor->id ) {
 766                 ($owner, $evt) = $U->fetch_copy_onwer($note->owning_copy);
 767                 return $evt if $evt;
 768                 $evt = $U->check_perms($requestor->id, $owner, 'DELETE_COPY_NOTE');
 769                 return $evt if $evt;
 770         }
 771
 772         my $stat = $U->storagereq(
 773                 'open-ils.storage.direct.asset.copy_note.delete', $noteid );
 774         return $U->DB_UPDATE_FAILED($noteid) unless $stat;
 775
 776         $logger->activity("User ".$requestor->id." deleted copy note $noteid");
 777         return 1;
 778 }
 779
 780
 781 __PACKAGE__->register_method(
 782         method => 'age_hold_rules',
 783         api_name        =>  'open-ils.circ.config.rules.age_hold_protect.retrieve.all',
 784 );
 785
 786 sub age_hold_rules {
 787         my( $self, $conn ) = @_;
 788         return new_editor()->retrieve_all_config_rules_age_hold_protect();
 789 }
 790
 791
 792
 793
 794 __PACKAGE__->register_method(
 795         method => 'copy_details',
 796         api_name => 'open-ils.circ.copy_details.retrieve',
 797         signature => q/
 798         /
 799 );
 800
 801 sub copy_details {
 802         my( $self, $conn, $auth, $copy_id ) = @_;
 803         my $e = new_editor(authtoken=>$auth);
 804         return $e->event unless $e->checkauth;
 805
 806         my $copy = $e->retrieve_asset_copy($copy_id)
 807                 or return $e->event;
 808
 809         my $hold = $e->search_action_hold_request(
 810                 {
 811                         current_copy => $copy_id,
 812                         capture_time => { "!=" => undef },
 813                         fulfillment_time => undef,
 814                 }
 815         )->[0];
 816
 817         OpenILS::Application::Circ::Holds::flesh_hold_transits([$hold]) if $hold;
 818
 819         my $transit = $e->search_action_transit_copy(
 820                 { target_copy => $copy_id, dest_recv_time => undef } )->[0];
 821
 822         # find the latest circ, open or closed
 823         my $circ = $e->search_action_circulation(
 824                 [
 825                         { target_copy => $copy_id },
 826                         { order_by => { circ => 'xact_start desc' }, limit => 1 }
 827                 ]
 828         )->[0];
 829
 830         return {
 831                 copy            => $copy,
 832                 hold            => $hold,
 833                 transit => $transit,
 834                 circ            => $circ,
 835         };
 836 }
 837
 838
 839
 840
 841 __PACKAGE__->register_method(
 842         method => 'mark_item',
 843         api_name => 'open-ils.circ.mark_item_damaged',
 844 );
 845 __PACKAGE__->register_method(
 846         method => 'mark_item',
 847         api_name => 'open-ils.circ.mark_item_missing',
 848 );
 849
 850 sub mark_item {
 851         my( $self, $conn, $auth, $copy_id ) = @_;
 852         my $e = new_editor(authtoken=>$auth, xact =>1);
 853         return $e->event unless $e->checkauth;
 854
 855         my $perm = 'MARK_ITEM_MISSING';
 856         my $stat = OILS_COPY_STATUS_MISSING;
 857
 858         if( $self->api_name =~ /damaged/ ) {
 859                 $perm = 'MARK_ITEM_DAMAGED';
 860                 $stat = OILS_COPY_STATUS_DAMAGED;
 861         }
 862
 863         my $copy = $e->retrieve_asset_copy($copy_id)
 864                 or return $e->event;
 865         $copy->status($stat);
 866
 867         $e->update_asset_copy($copy) or return $e->event;
 868
 869
 870         my $holds = $e->search_action_hold_request(
 871                 {
 872                         current_copy => $copy->id,
 873                         fulfillment_time => undef,
 874                         cancel_time => undef,
 875                 }
 876         );
 877
 878         $e->commit;
 879
 880         $logger->debug("reseting holds that target the marked copy");
 881         OpenILS::Application::Circ::Holds->_reset_hold($e->requestor, $_) for @$holds;
 882
 883         return 1;
 884 }
 885
 886
 887
 888
 889
 890
 891 # ----------------------------------------------------------------------
 892 __PACKAGE__->register_method(
 893         method => 'magic_fetch',
 894         api_name => 'open-ils.agent.fetch'
 895 );
 896
 897 my @FETCH_ALLOWED = qw/ aou aout acp acn bre /;
 898
 899 sub magic_fetch {
 900         my( $self, $conn, $auth, $args ) = @_;
 901         my $e = new_editor( authtoken => $auth );
 902         return $e->event unless $e->checkauth;
 903
 904         my $hint = $$args{hint};
 905         my $id  = $$args{id};
 906
 907         # Is the call allowed to fetch this type of object?
 908         return undef unless grep { $_ eq $hint } @FETCH_ALLOWED;
 909
 910         # Find the class the iplements the given hint
 911         my ($class) = grep {
 912                 $Fieldmapper::fieldmap->{$_}{hint} eq $hint } Fieldmapper->classes;
 913
 914         $class =~ s/Fieldmapper:://og;
 915         $class =~ s/::/_/og;
 916         my $method = "retrieve_$class";
 917
 918         my $obj = $e->$method($id) or return $e->event;
 919         return $obj;
 920 }
 921 # ----------------------------------------------------------------------
 922
 923
 924
 925
 926
 927
 928 1;