Open-ILS/src/perlmods/lib/OpenILS/Application/Booking.pm

   1 package OpenILS::Application::Booking;
   2
   3 use strict;
   4 use warnings;
   5
   6 use POSIX qw/strftime/;
   7 use OpenILS::Application;
   8 use base qw/OpenILS::Application/;
   9
  10 use OpenSRF::Utils qw/:datetime/;
  11 use OpenILS::Utils::CStoreEditor qw/:funcs/;
  12 use OpenILS::Utils::Fieldmapper;
  13 use OpenILS::Application::AppUtils;
  14 my $U = "OpenILS::Application::AppUtils";
  15
  16 use OpenSRF::Utils::Logger qw/$logger/;
  17
  18 sub prepare_new_brt {
  19     my ($record_id, $owning_lib, $mvr) = @_;
  20
  21     my $brt = new Fieldmapper::booking::resource_type;
  22     $brt->isnew(1);
  23     $brt->name($mvr->title);
  24     $brt->record($record_id);
  25     $brt->catalog_item('t');
  26     $brt->transferable('t');
  27     $brt->owner($owning_lib);
  28
  29     return $brt;
  30 }
  31
  32 sub get_existing_brt {
  33     my ($e, $record_id, $owning_lib, $mvr) = @_;
  34     my $results = $e->search_booking_resource_type(
  35         {name => $mvr->title, owner => $owning_lib, record => $record_id}
  36     );
  37
  38     return $results->[0] if scalar(@$results) > 0;
  39     return undef;
  40 }
  41
  42 sub get_mvr {
  43     return $U->simplereq(
  44         'open-ils.search',
  45         'open-ils.search.biblio.record.mods_slim.retrieve.authoritative',
  46         shift # record id
  47     );
  48 }
  49
  50 sub get_unique_owning_libs {
  51     my %hash = ();
  52     $hash{$_->call_number->owning_lib} = 1 foreach (@_);    # @_ are copies
  53     return keys %hash;
  54 }
  55
  56 sub fetch_copies_by_ids {
  57     my ($e, $copy_ids) = @_;
  58     my $results = $e->search_asset_copy([
  59         {id => $copy_ids},
  60         {flesh => 1, flesh_fields => {acp => ['call_number']}}
  61     ]);
  62     return $results if ref($results) eq 'ARRAY';
  63     return [];
  64 }
  65
  66 sub get_single_record_id {
  67     my $record_id = undef;
  68     foreach (@_) {  # @_ are copies
  69         return undef if
  70             (defined $record_id && $record_id != $_->call_number->record);
  71         $record_id = $_->call_number->record;
  72     }
  73     return $record_id;
  74 }
  75
  76 # This function generates the correct json_query clause for determining
  77 # whether two given ranges overlap.  Each range is composed of a start
  78 # and an end point.  All four points should be the same type (could be int,
  79 # date, time, timestamp, or perhaps other types).
  80 #
  81 # The first range (or the first two points) should be specified as
  82 # literal values.  The second range (or the last two points) should be
  83 # specified as the names of columns, the values of which in a given row
  84 # will constitute the second range in the comparison.
  85 #
  86 # ALSO: PostgreSQL includes an OVERLAPS operator which provides the same
  87 # functionality in a much more concise way, but json_query does not (yet).
  88 sub json_query_ranges_overlap {
  89     +{ '-or' => [
  90         { '-and' => [{$_[2] => {'>=', $_[0]}}, {$_[2] => {'<',  $_[1]}}]},
  91         { '-and' => [{$_[3] => {'>',  $_[0]}}, {$_[3] => {'<',  $_[1]}}]},
  92         { '-and' => { $_[3] => {'>',  $_[0]},   $_[2] => {'<=', $_[0]}}},
  93         { '-and' => { $_[3] => {'>',  $_[1]},   $_[2] => {'<',  $_[1]}}},
  94     ]};
  95 }
  96
  97 sub create_brt_and_brsrc {
  98     my ($self, $conn, $authtoken, $copy_ids) = @_;
  99     my (@created_brt, @created_brsrc);
 100     my %brt_table = ();
 101
 102     my $e = new_editor(xact => 1, authtoken => $authtoken);
 103     return $e->die_event unless $e->checkauth;
 104
 105     my @copies = @{fetch_copies_by_ids($e, $copy_ids)};
 106     my $record_id = get_single_record_id(@copies) or return $e->die_event;
 107     my $mvr = get_mvr($record_id) or return $e->die_event;
 108
 109     foreach (get_unique_owning_libs(@copies)) {
 110         $brt_table{$_} = get_existing_brt($e, $record_id, $_, $mvr) ||
 111             prepare_new_brt($record_id, $_, $mvr);
 112     }
 113
 114     while (my ($owning_lib, $brt) = each %brt_table) {
 115         my $pre_existing = 1;
 116         if ($brt->isnew) {
 117             if ($e->allowed('ADMIN_BOOKING_RESOURCE_TYPE', $owning_lib)) {
 118                 $pre_existing = 0;
 119                 return $e->die_event unless (
 120                     #    v-- Important: assignment modifies original hash
 121                     $brt = $e->create_booking_resource_type($brt)
 122                 );
 123             }
 124         }
 125         push @created_brt, [$brt->id, $brt->record, $pre_existing];
 126     }
 127
 128     foreach (@copies) {
 129         if ($e->allowed(
 130             'ADMIN_BOOKING_RESOURCE', $_->call_number->owning_lib
 131         )) {
 132             # This block needs to disregard any cstore failures and just
 133             # return what results it can.
 134             my $brsrc = new Fieldmapper::booking::resource;
 135             $brsrc->isnew(1);
 136             $brsrc->type($brt_table{$_->call_number->owning_lib}->id);
 137             $brsrc->owner($_->call_number->owning_lib);
 138             $brsrc->barcode($_->barcode);
 139
 140             $e->set_savepoint("alpha");
 141             my $pre_existing = 0;
 142             my $usable_result = undef;
 143             if (!($usable_result = $e->create_booking_resource($brsrc))) {
 144                 $e->rollback_savepoint("alpha");
 145                 if (($usable_result = $e->search_booking_resource(
 146                     +{ map { ($_, $brsrc->$_()) } qw/type owner barcode/ }
 147                 ))) {
 148                     $usable_result = $usable_result->[0];
 149                     $pre_existing = 1;
 150                 } else {
 151                     # So we failed to create a booking resource for this copy.
 152                     # For now, let's just keep going.  If the calling app wants
 153                     # to consider this an error, it can notice the absence
 154                     # of a booking resource for the copy in the returned
 155                     # results.
 156                     $logger->warn(
 157                         "Couldn't create or find brsrc for acp #" .  $_->id
 158                     );
 159                 }
 160             } else {
 161                 $e->release_savepoint("alpha");
 162             }
 163
 164             if ($usable_result) {
 165                 push @created_brsrc,
 166                     [$usable_result->id, $_->id, $pre_existing];
 167             }
 168         }
 169     }
 170
 171     $e->commit and
 172         return {brt => \@created_brt, brsrc => \@created_brsrc} or
 173         return $e->die_event;
 174 }
 175 __PACKAGE__->register_method(
 176     method   => "create_brt_and_brsrc",
 177     api_name => "open-ils.booking.resources.create_from_copies",
 178     signature => {
 179         params => [
 180             {type => 'string', desc => 'Authentication token'},
 181             {type => 'array', desc => 'Copy IDs'},
 182         ],
 183         return => { desc => "A two-element hash. The 'brt' element " .
 184             "is a list of created booking resource types described by " .
 185             "3-tuples (id, copy id, was pre-existing).  The 'brsrc' " .
 186             "element is a similar list of created booking resources " .
 187             "described by (id, record id, was pre-existing) 3-tuples."}
 188     }
 189 );
 190
 191
 192 sub create_bresv {
 193     my ($self, $client, $authtoken,
 194         $target_user_barcode, $datetime_range, $pickup_lib,
 195         $brt, $brsrc_list, $attr_values, $email_notify) = @_;
 196
 197     $brsrc_list = [ undef ] if not defined $brsrc_list;
 198     return undef if scalar(@$brsrc_list) < 1; # Empty list not ok.
 199
 200     my $e = new_editor(xact => 1, authtoken => $authtoken);
 201     return $e->die_event unless $e->checkauth;
 202     return $e->die_event unless $e->allowed("ADMIN_BOOKING_RESERVATION");
 203
 204     my $usr = $U->fetch_user_by_barcode($target_user_barcode);
 205     return $usr if ref($usr) eq 'HASH' and exists($usr->{"ilsevent"});
 206
 207     my $results = [];
 208     foreach my $brsrc (@$brsrc_list) {
 209         my $bresv = new Fieldmapper::booking::reservation;
 210         $bresv->usr($usr->id);
 211         $bresv->request_lib($e->requestor->ws_ou);
 212         $bresv->pickup_lib($pickup_lib);
 213         $bresv->start_time($datetime_range->[0]);
 214         $bresv->end_time($datetime_range->[1]);
 215         $bresv->email_notify(1) if $email_notify;
 216
 217         # A little sanity checking: don't agree to put a reservation on a
 218         # brsrc and a brt when they don't match.  In fact, bomb out of
 219         # this transaction entirely.
 220         if ($brsrc) {
 221             my $brsrc_itself = $e->retrieve_booking_resource([
 222                 $brsrc, {
 223                     "flesh" => 1,
 224                     "flesh_fields" => {"brsrc" => ["type"]}
 225                 }
 226             ]);
 227
 228             if (not $brsrc_itself) {
 229                 my $ev = new OpenILS::Event(
 230                     "RESERVATION_BAD_PARAMS",
 231                     desc => "brsrc $brsrc doesn't exist"
 232                 );
 233                 $e->disconnect;
 234                 return $ev;
 235             }
 236             elsif ($brsrc_itself->type->id != $brt) {
 237                 my $ev = new OpenILS::Event(
 238                     "RESERVATION_BAD_PARAMS",
 239                     desc => "brsrc $brsrc doesn't match given brt $brt"
 240                 );
 241                 $e->disconnect;
 242                 return $ev;
 243             }
 244
 245             # Also bail if the user is trying to create a reservation at
 246             # a pickup lib to which our resource won't go.
 247             if (
 248                 $brsrc_itself->owner != $pickup_lib and
 249                     not $brsrc_itself->type->transferable
 250             ) {
 251                 my $ev = new OpenILS::Event(
 252                     "RESERVATION_BAD_PARAMS",
 253                     desc => "brsrc $brsrc doesn't belong to $pickup_lib and " .
 254                         "is not transferable"
 255                 );
 256                 $e->disconnect;
 257                 return $ev;
 258             }
 259         }
 260         $bresv->target_resource($brsrc);    # undef is ok here
 261         $bresv->target_resource_type($brt);
 262
 263         ($bresv = $e->create_booking_reservation($bresv)) or
 264             return $e->die_event;
 265
 266         # We could/should do some sanity checking on this too: namely, on
 267         # whether the attribute values given actually apply to the relevant
 268         # brt.  Not seeing any grievous side effects of not checking, though.
 269         my @bravm = ();
 270         foreach my $value (@$attr_values) {
 271             my $bravm = new Fieldmapper::booking::reservation_attr_value_map;
 272             $bravm->reservation($bresv->id);
 273             $bravm->attr_value($value);
 274             $bravm = $e->create_booking_reservation_attr_value_map($bravm) or
 275                 return $e->die_event;
 276             push @bravm, $bravm;
 277         }
 278         push @$results, {
 279             "bresv" => $bresv->id,
 280             "bravm" => \@bravm,
 281         };
 282     }
 283
 284     $e->commit or return $e->die_event;
 285
 286     # Targeting must be tacked on _after_ committing the transaction where the
 287     # reservations are actually created.
 288     foreach (@$results) {
 289         $_->{"targeting"} = $U->storagereq(
 290             "open-ils.storage.booking.reservation.resource_targeter",
 291             $_->{"bresv"}
 292         )->[0];
 293     }
 294     return $results;
 295 }
 296 __PACKAGE__->register_method(
 297     method   => "create_bresv",
 298     api_name => "open-ils.booking.reservations.create",
 299     signature => {
 300         params => [
 301             {type => 'string', desc => 'Authentication token'},
 302             {type => 'string', desc => 'Barcode of user for whom to reserve'},
 303             {type => 'array', desc => 'Two elements: start and end timestamp'},
 304             {type => 'int', desc => 'Desired reservation pickup lib'},
 305             {type => 'int', desc => 'Booking resource type'},
 306             {type => 'list', desc => 'Booking resource (undef ok; empty not ok)'},
 307             {type => 'array', desc => 'Attribute values selected'},
 308             {type => 'bool', desc => 'Email notification?'},
 309         ],
 310         return => { desc => "A hash containing the new bresv and a list " .
 311             "of new bravm"}
 312     }
 313 );
 314
 315
 316 sub resource_list_by_attrs {
 317     my $self = shift;
 318     my $client = shift;
 319     my $auth = shift; # Keep as argument, though not used just now.
 320     my $filters = shift;
 321
 322     return undef unless ($filters->{type} || $filters->{attribute_values});
 323
 324     my $query = {
 325         "select"   => {brsrc => [qw/id owner/], brt => ["elbow_room"]},
 326         "from"     => {brsrc => {"brt" => {}}},
 327         "where"    => {},
 328         "distinct" => 1
 329     };
 330
 331     $query->{where} = {"-and" => []};
 332     if ($filters->{type}) {
 333         push @{$query->{where}->{"-and"}}, {"type" => $filters->{type}};
 334     }
 335
 336     if ($filters->{pickup_lib}) {
 337         push @{$query->{where}->{"-and"}},
 338             {"-or" => [
 339                 {"owner" => $filters->{pickup_lib}},
 340                 {"+brt" => {"transferable" => "t"}}
 341             ]};
 342     }
 343
 344     if ($filters->{attribute_values}) {
 345
 346         $query->{from}->{brsrc}->{bram} = { field => 'resource' };
 347
 348         $filters->{attribute_values} = [$filters->{attribute_values}]
 349             if (!ref($filters->{attribute_values}));
 350
 351         $query->{having}->{'+bram'}->{value}->{'@>'} = {
 352             transform => 'array_accum',
 353             value => '$_' . $$ . '${' .
 354                 join(',', @{$filters->{attribute_values}}) .
 355                 '}$_' . $$ . '$'
 356         };
 357     }
 358
 359     if ($filters->{available}) {
 360         # If only one timestamp has been provided, make it into a range.
 361         if (!ref($filters->{available})) {
 362             $filters->{available} = [($filters->{available}) x 2];
 363         }
 364
 365         push @{$query->{where}->{"-and"}}, {
 366             "-or" => [
 367                 {"overbook" => "t"},
 368                 {"-not-exists" => {
 369                     "select" => {"bresv" => ["id"]},
 370                     "from" => "bresv",
 371                     "where" => {"-and" => [
 372                         json_query_ranges_overlap(
 373                             $filters->{available}->[0],
 374                             $filters->{available}->[1],
 375                             "start_time",
 376                             "end_time"
 377                         ),
 378                         {"cancel_time" => undef},
 379                         {"return_time" => undef},
 380                         {"current_resource" => {"=" => {"+brsrc" => "id"}}}
 381                     ]},
 382                 }}
 383             ]
 384         };
 385     }
 386     if ($filters->{booked}) {
 387         # If only one timestamp has been provided, make it into a range.
 388         if (!ref($filters->{booked})) {
 389             $filters->{booked} = [($filters->{booked}) x 2];
 390         }
 391
 392         push @{$query->{where}->{"-and"}}, {
 393             "-exists" => {
 394                 "select" => {"bresv" => ["id"]},
 395                 "from" => "bresv",
 396                 "where" => {"-and" => [
 397                     json_query_ranges_overlap(
 398                         $filters->{booked}->[0],
 399                         $filters->{booked}->[1],
 400                         "start_time",
 401                         "end_time"
 402                     ),
 403                     {"cancel_time" => undef},
 404                     {"current_resource" => { "=" => {"+brsrc" => "id"}}}
 405                 ]},
 406             }
 407         };
 408         # I think that the "booked" case could be done with a JOIN instead of
 409         # an EXISTS, but I'm leaving it this way for symmetry with the
 410         # "available" case for now.  The available case cannot be done with a
 411         # join.
 412     }
 413
 414     my $cstore = OpenSRF::AppSession->connect('open-ils.cstore');
 415     my $rows = $cstore->request(
 416         "open-ils.cstore.json_query.atomic", $query
 417     )->gather(1);
 418     $cstore->disconnect;
 419
 420     return [] if not @$rows;
 421
 422     if ($filters->{"pickup_lib"} && $filters->{"available"}) {
 423         my @new_rows = ();
 424         my $general_elbow_room = $U->ou_ancestor_setting_value(
 425             $filters->{"pickup_lib"},
 426             "circ.booking_reservation.default_elbow_room"
 427         ) || '0 seconds';
 428         my $would_start = $filters->{"available"}->[0];
 429         my $dt_parser = new DateTime::Format::ISO8601;
 430
 431         $logger->info(
 432             "general_elbow_room: '$general_elbow_room', " .
 433             "would_start: '$would_start'"
 434         );
 435
 436         # Here, elbow_room will double as required transit time padding.
 437         foreach (@$rows) {
 438             my $elbow_room = $_->{"elbow_room"} || $general_elbow_room;
 439             if ($_->{"owner"} != $filters->{"pickup_lib"}) {
 440                 (my $ws = $would_start) =~ s/ /T/;
 441                 push @new_rows, $_ if DateTime->compare(
 442                     $dt_parser->parse_datetime($ws),
 443                     DateTime->now(
 444                         "time_zone" => DateTime::TimeZone->new(
 445                             "name" => "local"
 446                         )
 447                     )->add(seconds => interval_to_seconds($elbow_room))
 448                 ) >= 0;
 449             } else {
 450                 push @new_rows, $_;
 451             }
 452         }
 453         return [map { $_->{id} } @new_rows];
 454     } else {
 455         return [map { $_->{id} } @$rows];
 456     }
 457 }
 458 __PACKAGE__->register_method(
 459     method   => "resource_list_by_attrs",
 460     api_name => "open-ils.booking.resources.filtered_id_list",
 461     argc     => 2,
 462     signature=> {
 463         params => [
 464             {type => 'string', desc => 'Authentication token (unused for now,' .
 465                ' but at least pass undef here)'},
 466             {type => 'object', desc => 'Filter object: see notes for details'},
 467         ],
 468         return => { desc => "An array of brsrc ids matching the requested filters." },
 469     },
 470     notes    => <<'NOTES'
 471
 472 The filter object parameter can contain the following keys:
 473  * type             => The id of a booking resource type (brt)
 474  * attribute_values => The ids of booking resource type attribute values that the resource must have assigned to it (brav)
 475  * available        => Either:
 476                         A timestamp during which the resources are not reserved.  If the resource is overbookable, this is ignored.
 477                         A range of two timestamps which do not overlap any reservations for the resources.  If the resource is overbookable, this is ignored.
 478  * booked           => Either:
 479                         A timestamp during which the resources are reserved.
 480                         A range of two timestamps which overlap a reservation of the resources.
 481
 482 Note that at least one of 'type' or 'attribute_values' is required.
 483
 484 NOTES
 485 );
 486
 487
 488 sub reservation_list_by_filters {
 489     my $self = shift;
 490     my $client = shift;
 491     my $auth = shift;
 492     my $filters = shift;
 493     my $whole_obj = shift;
 494
 495     return undef unless ($filters->{user} || $filters->{user_barcode} || $filters->{resource} || $filters->{type} || $filters->{attribute_values});
 496
 497     my $e = new_editor(authtoken=>$auth);
 498     return $e->event unless $e->checkauth;
 499     return $e->event unless $e->allowed('VIEW_TRANSACTION');
 500
 501     my $query = {
 502         'select'   => { bresv => [ 'id', 'start_time' ] },
 503         'from'     => { bresv => {} },
 504         'where'    => {},
 505         'order_by' => [{ class => bresv => field => start_time => direction => 'asc' }],
 506         'distinct' => 1
 507     };
 508
 509     if ($filters->{fields}) {
 510         $query->{where} = $filters->{fields};
 511     }
 512
 513
 514     if ($filters->{user}) {
 515         $query->{where}->{usr} = $filters->{user};
 516     }
 517     elsif ($filters->{user_barcode}) {  # just one of user and user_barcode
 518         my $usr = $U->fetch_user_by_barcode($filters->{user_barcode});
 519         return $usr if ref($usr) eq 'HASH' and exists($usr->{"ilsevent"});
 520         $query->{where}->{usr} = $usr->id;
 521     }
 522
 523
 524     if ($filters->{type}) {
 525         $query->{where}->{target_resource_type} = $filters->{type};
 526     }
 527
 528     $query->{where}->{"-and"} = [];
 529     if ($filters->{resource}) {
 530 #       $query->{where}->{target_resource} = $filters->{resource};
 531         push @{$query->{where}->{"-and"}}, {
 532             "-or" => {
 533                 "target_resource" => $filters->{resource},
 534                 "current_resource" => $filters->{resource}
 535             }
 536         };
 537     }
 538
 539     if ($filters->{attribute_values}) {
 540
 541         $query->{from}->{bresv}->{bravm} = { field => 'reservation' };
 542
 543         $filters->{attribute_values} = [$filters->{attribute_values}]
 544             if (!ref($filters->{attribute_values}));
 545
 546         $query->{having}->{'+bravm'}->{attr_value}->{'@>'} = {
 547             transform => 'array_accum',
 548             value => '$_' . $$ . '${' .
 549                 join(',', @{$filters->{attribute_values}}) .
 550                 '}$_' . $$ . '$'
 551         };
 552     }
 553
 554     if ($filters->{search_start} || $filters->{search_end}) {
 555         my $or = {};
 556
 557         $or->{start_time} =
 558             {'between' => [ $filters->{search_start}, $filters->{search_end}]}
 559                 if $filters->{search_start};
 560
 561         $or->{end_time} =
 562             {'between' =>[$filters->{search_start}, $filters->{search_end}]}
 563                 if $filters->{search_end};
 564
 565         push @{$query->{where}->{"-and"}}, {"-or" => $or};
 566     }
 567
 568     if (not scalar @{$query->{"where"}->{"-and"}}) {
 569         delete $query->{"where"}->{"-and"};
 570     }
 571
 572     my $cstore = OpenSRF::AppSession->connect('open-ils.cstore');
 573     my $ids = [ map { $_->{id} } @{
 574         $cstore->request(
 575             'open-ils.cstore.json_query.atomic', $query
 576         )->gather(1)
 577     } ];
 578     $cstore->disconnect;
 579
 580     if (not $whole_obj or @$ids < 1) {
 581         $e->disconnect;
 582         return $ids;
 583     }
 584
 585     my $bresv_list = $e->search_booking_reservation([
 586         {"id" => $ids},
 587         {"flesh" => 1,
 588             "flesh_fields" => {
 589                 "bresv" =>
 590                     [qw/target_resource current_resource target_resource_type/]
 591             }
 592         }]
 593     );
 594     $e->disconnect;
 595     return $bresv_list ? $bresv_list : [];
 596 }
 597 __PACKAGE__->register_method(
 598     method   => "reservation_list_by_filters",
 599     api_name => "open-ils.booking.reservations.filtered_id_list",
 600     argc     => 3,
 601     signature=> {
 602         params => [
 603             {type => 'string', desc => 'Authentication token'},
 604             {type => "object", desc => "Filter object: see notes for details"},
 605             {type => "bool", desc => "Return whole object instead of ID? (default false)"}
 606         ],
 607         return => { desc => "An array of bresv ids matching the requested filters." },
 608     },
 609     notes    => <<'NOTES'
 610
 611 The filter object parameter can contain the following keys:
 612  * user             => The id of a user that has requested a bookable item -- filters on bresv.usr
 613  * barcode          => The barcode of a user that has requested a bookable item
 614  * type             => The id of a booking resource type (brt) -- filters on bresv.target_resource_type
 615  * resource         => The id of a booking resource (brsrc) -- filters on bresv.target_resource
 616  * attribute_values => The ids of booking resource type attribute values that the resource must have assigned to it (brav)
 617  * search_start     => If search_end is not specified, booking interval (start_time to end_time) must contain this timestamp.
 618  * search_end       => If search_start is not specified, booking interval (start_time to end_time) must contain this timestamp.
 619  * fields           => An object containing any combination of bresv search filters in standard cstore/pcrud search format.
 620
 621 Note that at least one of 'user', 'type', 'resource' or 'attribute_values' is required.  If both search_start and search_end are specified,
 622 then the result includes any reservations that overlap with that time range.  Any filter fields supplied in 'fields' are overridden
 623 by the top-level filters ('user', 'type', 'resource').
 624
 625 NOTES
 626 );
 627
 628
 629 sub naive_ts_string {strftime("%F %T", localtime($_[0] || time));}
 630
 631 # Return a map of bresv or an ilsevent on failure.
 632 sub get_uncaptured_bresv_for_brsrc {
 633     my ($e, $o) = @_; # o's keys (all optional): owning_lib, barcode, range
 634
 635     my $from_clause = {
 636         "bresv" => {
 637             "brsrc" => {"field" => "id", "fkey" => "current_resource"}
 638         }
 639     };
 640
 641     my $query = {
 642         "select" => {
 643             "bresv" => [
 644                 "current_resource",
 645                 {
 646                     "column" => "start_time",
 647                     "transform" => "min",
 648                     "aggregate" => 1
 649                 }
 650             ]
 651         },
 652         "from" => $from_clause,
 653         "where" => {
 654             "-and" => [
 655                 {"current_resource" => {"!=" => undef}},
 656                 {"capture_time" => undef},
 657                 {"cancel_time" => undef},
 658                 {"return_time" => undef},
 659                 {"pickup_time" => undef}
 660             ]
 661         }
 662     };
 663     if ($o->{"owning_lib"}) {
 664         push @{$query->{"where"}->{"-and"}},
 665             {"+brsrc" => {"owner" => $o->{"owning_lib"}}};
 666     }
 667     if ($o->{"range"}) {
 668         push @{$query->{"where"}->{"-and"}},
 669             json_query_ranges_overlap(
 670                 $o->{"range"}->[0], $o->{"range"}->[1],
 671                 "start_time", "end_time"
 672             );
 673     }
 674     if ($o->{"barcode"}) {
 675         push @{$query->{"where"}->{"-and"}},
 676             {"+brsrc" => {"barcode" => $o->{"barcode"}}};
 677     }
 678
 679     my $rows = $e->json_query($query);
 680     my $current_resource_bresv_map = {};
 681     if (@$rows) {
 682         my $id_query = {
 683             "select" => {"bresv" => ["id"]},
 684             "from" => $from_clause,
 685             "where" => {
 686                 "-and" => [
 687                     {"current_resource" => "PLACEHOLDER"},
 688                     {"start_time" => "PLACEHOLDER"},
 689                     {"capture_time" => undef},
 690                     {"cancel_time" => undef},
 691                     {"return_time" => undef},
 692                     {"pickup_time" => undef}
 693                 ]
 694             }
 695         };
 696         if ($o->{"owning_lib"}) {
 697             push @{$id_query->{"where"}->{"-and"}},
 698                 {"+brsrc" => {"owner" => $o->{"owning_lib"}}};
 699         }
 700
 701         foreach (@$rows) {
 702             $id_query->{"where"}->{"-and"}->[0]->{"current_resource"} =
 703                 $_->{"current_resource"};
 704             $id_query->{"where"}->{"-and"}->[1]->{"start_time"} =
 705                 $_->{"start_time"};
 706
 707             my $results = $e->json_query($id_query);
 708             if ($results && @$results) {
 709                 $current_resource_bresv_map->{$_->{"current_resource"}} =
 710                     [map { $_->{"id"} } @$results];
 711             }
 712         }
 713     }
 714     return $current_resource_bresv_map;
 715 }
 716
 717 sub get_pull_list {
 718     my ($self, $client, $auth, $range, $interval_secs, $owning_lib) = @_;
 719
 720     my $e = new_editor(xact => 1, authtoken => $auth);
 721     return $e->die_event unless $e->checkauth;
 722     return $e->die_event unless $e->allowed("RETRIEVE_RESERVATION_PULL_LIST");
 723     return $e->die_event unless (
 724         ref($range) eq "ARRAY" or
 725         ($interval_secs = int($interval_secs)) > 0
 726     );
 727
 728     $owning_lib = $e->requestor->ws_ou if not $owning_lib;
 729     $range = [ naive_ts_string(time), naive_ts_string(time + $interval_secs) ]
 730         if not $range;
 731
 732     my $uncaptured = get_uncaptured_bresv_for_brsrc(
 733         $e, {"range" => $range, "owning_lib" => $owning_lib}
 734     );
 735
 736     if (keys(%$uncaptured)) {
 737         my @all_bresv_ids = map { @{$_} } values %$uncaptured;
 738         my %bresv_lookup = (
 739             map { $_->id => $_ } @{
 740                 $e->search_booking_reservation([{"id" => [@all_bresv_ids]}, {
 741                     flesh => 1,
 742                     flesh_fields => { bresv => [
 743                         "usr", "target_resource_type", "current_resource"
 744                     ]}
 745                 }])
 746             }
 747         );
 748         $e->disconnect;
 749         return [ map {
 750             my $key = $_;
 751             my $one = $bresv_lookup{$uncaptured->{$key}->[0]};
 752             my $result = {
 753                 "current_resource" => $one->current_resource,
 754                 "target_resource_type" => $one->target_resource_type,
 755                 "reservations" => [
 756                     map { $bresv_lookup{$_} } @{$uncaptured->{$key}}
 757                 ]
 758             };
 759             foreach (@{$result->{"reservations"}}) {    # deflesh
 760                 $_->current_resource($_->current_resource->id);
 761                 $_->target_resource_type($_->target_resource_type->id);
 762             }
 763             $result;
 764         } keys %$uncaptured ];
 765     } else {
 766         $e->disconnect;
 767         return [];
 768     }
 769 }
 770 __PACKAGE__->register_method(
 771     method   => "get_pull_list",
 772     api_name => "open-ils.booking.reservations.get_pull_list",
 773     argc     => 4,
 774     signature=> {
 775         params => [
 776             {type => "string", desc => "Authentication token"},
 777             {type => "array", desc =>
 778                 "range: Date/time range for reservations (opt)"},
 779             {type => "int", desc =>
 780                 "interval: Seconds from now (instead of range)"},
 781             {type => "number", desc => "(Optional) Owning library"}
 782         ],
 783         return => { desc => "An array of hashes, each containing key/value " .
 784             "pairs describing resource, resource type, and a list of " .
 785             "reservations that claim the given resource." }
 786     }
 787 );
 788
 789
 790 sub could_capture {
 791     my ($self, $client, $auth, $barcode) = @_;
 792
 793     my $e = new_editor("authtoken" => $auth);
 794     return $e->die_event unless $e->checkauth;
 795     return $e->die_event unless $e->allowed("COPY_CHECKIN");
 796
 797     my $dt_parser = new DateTime::Format::ISO8601;
 798     my $now = now DateTime; # sic
 799     my $res = get_uncaptured_bresv_for_brsrc($e, {"barcode" => $barcode});
 800
 801     if ($res and keys %$res) {
 802         my $id;
 803         while ((undef, $id) = each %$res) {
 804             my $bresv = $e->retrieve_booking_reservation([
 805                 $id, {
 806                     "flesh" => 1, "flesh_fields" => {
 807                         "bresv" => [qw(
 808                             usr target_resource_type
 809                             target_resource current_resource
 810                         )]
 811                     }
 812                 }
 813             ]);
 814             my $elbow_room = interval_to_seconds(
 815                 $bresv->target_resource_type->elbow_room ||
 816                 $U->ou_ancestor_setting_value(
 817                     $bresv->pickup_lib,
 818                     "circ.booking_reservation.default_elbow_room"
 819                 ) ||
 820                 "0 seconds"
 821             );
 822
 823             unless ($elbow_room) {
 824                 $client->respond($bresv);
 825             } else {
 826                 my $start_time = $dt_parser->parse_datetime(
 827                     clense_ISO8601($bresv->start_time)
 828                 );
 829
 830                 if ($now >= $start_time->subtract("seconds" => $elbow_room)) {
 831                     $client->respond($bresv);
 832                 } else {
 833                     $logger->info(
 834                         "not within elbow room: $elbow_room, " .
 835                         "else would have returned bresv " . $bresv->id
 836                     );
 837                 }
 838             }
 839         }
 840     }
 841     $e->disconnect;
 842     undef;
 843 }
 844 __PACKAGE__->register_method(
 845     method   => "could_capture",
 846     api_name => "open-ils.booking.reservations.could_capture",
 847     argc     => 2,
 848     streaming=> 1,
 849     signature=> {
 850         params => [
 851             {type => "string", desc => "Authentication token"},
 852             {type => "string", desc => "Resource barcode"}
 853         ],
 854         return => {desc => "One or zero reservations; event on error."}
 855     }
 856 );
 857
 858
 859 sub get_copy_fleshed_just_right {
 860     my ($self, $client, $auth, $barcode) = @_;
 861
 862     return undef if not defined $barcode;
 863     return {} if ref($barcode) eq "ARRAY" and not @$barcode;
 864
 865     my $e = new_editor(authtoken => $auth);
 866     my $results = $e->search_asset_copy([
 867         {"barcode" => $barcode},
 868         {
 869             "flesh" => 1,
 870             "flesh_fields" => {"acp" => [qw/call_number location/]}
 871         }
 872     ]);
 873
 874     if (ref($results) eq "ARRAY") {
 875         $e->disconnect;
 876         return $results->[0] unless ref $barcode;
 877         return +{ map { $_->barcode => $_ } @$results };
 878     } else {
 879         return $e->die_event;
 880     }
 881 }
 882 __PACKAGE__->register_method(
 883     method   => "get_copy_fleshed_just_right",
 884     api_name => "open-ils.booking.asset.get_copy_fleshed_just_right",
 885     argc     => 2,
 886     signature=> {
 887         params => [
 888             {type => "string", desc => "Authentication token"},
 889             {type => "mixed", desc => "One barcode or an array of them"},
 890         ],
 891         return => { desc =>
 892             "A copy, or a hash of copies keyed by barcode if an array of " .
 893             "barcodes was given"
 894         }
 895     }
 896 );
 897
 898
 899 sub best_bresv_candidate {
 900     my ($e, $id_list) = @_;
 901
 902     # This will almost always be the case.
 903     if (@$id_list == 1) {
 904         $logger->info("best_bresv_candidate (only) " . $id_list->[0]);
 905         return $id_list->[0];
 906     }
 907
 908     my @here = ();
 909     my $this_ou = $e->requestor->ws_ou;
 910     my $results = $e->json_query({
 911         "select" => {"brsrc" => ["pickup_lib"], "bresv" => ["id"]},
 912         "from" => {
 913             "bresv" => {
 914                 "brsrc" => {"field" => "id", "fkey" => "current_resource"}
 915             }
 916         },
 917         "where" => {
 918             {"+bresv" => {"id" => $id_list}}
 919         }
 920     });
 921
 922     foreach (@$results) {
 923         push @here, $_->{"id"} if $_->{"pickup_lib"} == $this_ou;
 924     }
 925
 926     my $result;
 927     if (@here > 0) {
 928         $result = @here == 1 ? pop @here : (sort @here)[0];
 929     } else {
 930         $result = (sort @$id_list)[0];
 931     }
 932     $logger->info(
 933         "best_bresv_candidate from " . join(",", @$id_list) . ": $result"
 934     );
 935     return $result;
 936 }
 937
 938
 939 sub capture_resource_for_reservation {
 940     my ($self, $client, $auth, $barcode, $no_update_copy) = @_;
 941
 942     my $e = new_editor(authtoken => $auth);
 943     return $e->die_event unless $e->checkauth;
 944     return $e->die_event unless $e->allowed("COPY_CHECKIN");
 945
 946     my $uncaptured = get_uncaptured_bresv_for_brsrc(
 947         $e, {"barcode" => $barcode}
 948     );
 949
 950     if (keys %$uncaptured) {
 951         # Note this will only capture one reservation at a time, even in
 952         # cases with overbooking (multiple "soonest" bresv's on a resource).
 953         my $bresv = best_bresv_candidate(
 954             $e, $uncaptured->{
 955                 (sort(keys %$uncaptured))[0]
 956             }
 957         );
 958         $e->disconnect;
 959         return capture_reservation(
 960             $self, $client, $auth, $bresv, $no_update_copy
 961         );
 962     } else {
 963         return new OpenILS::Event(
 964             "RESERVATION_NOT_FOUND",
 965             "desc" => "No capturable reservation found pertaining " .
 966                 "to a resource with barcode $barcode",
 967             "payload" => {"fail_cause" => "no-reservation", "captured" => 0}
 968         );
 969     }
 970 }
 971 __PACKAGE__->register_method(
 972     method   => "capture_resource_for_reservation",
 973     api_name => "open-ils.booking.resources.capture_for_reservation",
 974     argc     => 3,
 975     signature=> {
 976         params => [
 977             {type => "string", desc => "Authentication token"},
 978             {type => "string", desc => "Barcode of booked & targeted resource"},
 979             {type => "number", desc => "(optional) 1 to not update copy"}
 980         ],
 981         return => { desc => "An OpenILS event describing the capture outcome" }
 982     }
 983 );
 984
 985
 986 sub capture_reservation {
 987     my ($self, $client, $auth, $res_id, $no_update_copy) = @_;
 988
 989     my $e = new_editor("xact" => 1, "authtoken" => $auth);
 990     return $e->die_event unless $e->checkauth;
 991     return $e->die_event unless $e->allowed("COPY_CHECKIN");
 992     my $here = $e->requestor->ws_ou;
 993
 994     my $reservation = $e->retrieve_booking_reservation([
 995         $res_id, {
 996             "flesh" => 2, "flesh_fields" => {
 997                 "bresv" => [qw/usr current_resource type/],
 998                 "au" => ["card"],
 999                 "brsrc" => ["type"]
1000             }
1001         }
1002     ]);
1003
1004     return new OpenILS::Event("RESERVATION_NOT_FOUND") unless $reservation;
1005     return new OpenILS::Event(
1006         "RESERVATION_CAPTURE_FAILED",
1007         payload => {"captured" => 0, "fail_cause" => "no-resource"}
1008     ) unless $reservation->current_resource;
1009
1010     return new OpenILS::Event(
1011         "RESERVATION_CAPTURE_FAILED",
1012         "payload" => {"captured" => 0, "fail_cause" => "cancelled"}
1013     ) if $reservation->cancel_time;
1014
1015     $reservation->capture_staff($e->requestor->id);
1016     $reservation->capture_time("now");
1017
1018     $e->update_booking_reservation($reservation) or return $e->die_event;
1019
1020     my $ret = {"captured" => 1, "reservation" => $reservation};
1021
1022     my $search_acp_like_this = [
1023         {
1024             "barcode" => $reservation->current_resource->barcode,
1025             "deleted" => "f"
1026         },
1027         {"flesh" => 1, "flesh_fields" => {"acp" => ["call_number"]}}
1028     ];
1029
1030     if ($here != $reservation->pickup_lib) {
1031         $logger->info("resource isn't at the reservation's pickup lib...");
1032         return new OpenILS::Event(
1033             "RESERVATION_CAPTURE_FAILED",
1034             "payload" => {"captured" => 0, "fail_cause" => "not-transferable"}
1035         ) unless $U->is_true(
1036             $reservation->current_resource->type->transferable
1037         );
1038
1039         # need to transit the item ... is it already in transit?
1040         my $transit = $e->search_action_reservation_transit_copy(
1041             {"reservation" => $res_id, "dest_recv_time" => undef}
1042         )->[0];
1043
1044         if (!$transit) { # not yet in transit
1045             $transit = new Fieldmapper::action::reservation_transit_copy;
1046
1047             $transit->reservation($reservation->id);
1048             $transit->target_copy($reservation->current_resource->id);
1049             $transit->copy_status(15);
1050             $transit->source_send_time("now");
1051             $transit->source($here);
1052             $transit->dest($reservation->pickup_lib);
1053
1054             $e->create_action_reservation_transit_copy($transit);
1055
1056             if ($U->is_true(
1057                 $reservation->current_resource->type->catalog_item
1058             )) {
1059                 my $copy = $e->search_asset_copy($search_acp_like_this)->[0];
1060
1061                 if ($copy) {
1062                     return new OpenILS::Event(
1063                         "OPEN_CIRCULATION_EXISTS",
1064                         "payload" => {"captured" => 0, "copy" => $copy}
1065                     ) if $copy->status == 1 and not $no_update_copy;
1066
1067                     $ret->{"mvr"} = get_mvr($copy->call_number->record);
1068                     if ($no_update_copy) {
1069                         $ret->{"new_copy_status"} = 6;
1070                     } else {
1071                         $copy->status(6);
1072                         $e->update_asset_copy($copy) or return $e->die_event;
1073                     }
1074                 }
1075             }
1076         }
1077
1078         $ret->{"transit"} = $transit;
1079     } elsif ($U->is_true($reservation->current_resource->type->catalog_item)) {
1080         $logger->info("resource is a catalog item...");
1081         my $copy = $e->search_asset_copy($search_acp_like_this)->[0];
1082
1083         if ($copy) {
1084             return new OpenILS::Event(
1085                 "OPEN_CIRCULATION_EXISTS",
1086                 "payload" => {"captured" => 0, "copy" => $copy}
1087             ) if $copy->status == 1 and not $no_update_copy;
1088
1089             $ret->{"mvr"} = get_mvr($copy->call_number->record);
1090             if ($no_update_copy) {
1091                 $ret->{"new_copy_status"} = 15;
1092             } else {
1093                 $copy->status(15);
1094                 $e->update_asset_copy($copy) or return $e->die_event;
1095             }
1096         }
1097     }
1098
1099     $e->commit or return $e->die_event;
1100
1101     # create action trigger event to notify that reservation is available
1102     if ($reservation->email_notify) {
1103         my $ses = OpenSRF::AppSession->create('open-ils.trigger');
1104         $ses->request('open-ils.trigger.event.autocreate', 'reservation.available', $reservation, $reservation->pickup_lib);
1105     }
1106
1107     # XXX I'm not sure whether these last two elements of the payload
1108     # actually get used anywhere.
1109     $ret->{"resource"} = $reservation->current_resource;
1110     $ret->{"type"} = $reservation->current_resource->type;
1111     return new OpenILS::Event("SUCCESS", "payload" => $ret);
1112 }
1113 __PACKAGE__->register_method(
1114     method   => "capture_reservation",
1115     api_name => "open-ils.booking.reservations.capture",
1116     argc     => 2,
1117     signature=> {
1118         params => [
1119             {type => 'string', desc => 'Authentication token'},
1120             {type => 'mixed', desc =>
1121                 'Reservation ID (number) or array of resource barcodes'}
1122         ],
1123         return => { desc => "An OpenILS Event object describing the outcome of the capture, with relevant payload." },
1124     }
1125 );
1126
1127
1128 sub cancel_reservation {
1129     my ($self, $client, $auth, $id_list) = @_;
1130
1131     my $e = new_editor(xact => 1, authtoken => $auth);
1132     return $e->die_event unless $e->checkauth;
1133     # Should the following permission really be checked as relates to each
1134     # individual reservation's request_lib?  Hrmm...
1135     return $e->die_event unless $e->allowed("ADMIN_BOOKING_RESERVATION");
1136
1137     my $bresv_list = $e->search_booking_reservation([
1138         {"id" => $id_list},
1139         {"flesh" => 1, "flesh_fields" => {"bresv" => [
1140             "current_resource", "target_resource_type"
1141         ]}}
1142     ]);
1143     return $e->die_event if not $bresv_list;
1144
1145     my @results = ();
1146     my $circ = OpenSRF::AppSession->connect("open-ils.circ") or
1147         return $e->die_event;
1148     foreach my $bresv (@$bresv_list) {
1149         $bresv->cancel_time("now");
1150         $e->update_booking_reservation($bresv) or do {
1151             $circ->disconnect;
1152             return $e->die_event;
1153         };
1154         $e->xact_commit;
1155         $e->xact_begin;
1156
1157         if (
1158             $bresv->target_resource_type->catalog_item == "t" &&
1159             $bresv->current_resource
1160         ) {
1161             $logger->info("result of no-op checkin (upon cxl bresv) is " .
1162                 $circ->request(
1163                     "open-ils.circ.checkin", $auth,
1164                     {"barcode" => $bresv->current_resource->barcode,
1165                         "noop" => 1}
1166                 )->gather(1)->{"textcode"});
1167         }
1168         push @results, $bresv->id;
1169     }
1170
1171     $e->disconnect;
1172     $circ->disconnect;
1173
1174     return \@results;
1175 }
1176 __PACKAGE__->register_method(
1177     method   => "cancel_reservation",
1178     api_name => "open-ils.booking.reservations.cancel",
1179     argc     => 2,
1180     signature=> {
1181         params => [
1182             {type => "string", desc => "Authentication token"},
1183             {type => "array", desc => "List of reservation IDs"}
1184         ],
1185         return => { desc => "A list of canceled reservation IDs" },
1186     }
1187 );
1188
1189
1190 sub get_captured_reservations {
1191     my ($self, $client, $auth, $barcode, $which) = @_;
1192
1193     my $e = new_editor(xact => 1, authtoken => $auth);
1194     return $e->die_event unless $e->checkauth;
1195     return $e->die_event unless $e->allowed("VIEW_USER");
1196     return $e->die_event unless $e->allowed("ADMIN_BOOKING_RESERVATION");
1197
1198     # fetch the patron for our uses in any case...
1199     my $patron = $U->fetch_user_by_barcode($barcode);
1200     return $patron if ref($patron) eq "HASH" and exists $patron->{"ilsevent"};
1201
1202     my $bresv_flesh = {
1203         "flesh" => 1,
1204         "flesh_fields" => {"bresv" => [
1205             qw/target_resource_type current_resource/
1206         ]}
1207     };
1208
1209     my $dispatch = {
1210         "patron" => sub {
1211             return $patron;
1212         },
1213         "ready" => sub {
1214             return $e->search_booking_reservation([
1215                 {
1216                     "usr" => $patron->id,
1217                     "capture_time" => {"!=" => undef},
1218                     "pickup_time" => undef,
1219                     "start_time" => {"!=" => undef},
1220                     "cancel_time" => undef
1221                 },
1222                 $bresv_flesh
1223             ]) or $e->die_event;
1224         },
1225         "out" => sub {
1226             return $e->search_booking_reservation([
1227                 {
1228                     "usr" => $patron->id,
1229                     "pickup_time" => {"!=" => undef},
1230                     "return_time" => undef,
1231                     "cancel_time" => undef
1232                 },
1233                 $bresv_flesh
1234             ]) or $e->die_event;
1235         },
1236         "in" => sub {
1237             return $e->search_booking_reservation([
1238                 {
1239                     "usr" => $patron->id,
1240                     "return_time" => {">=" => "today"},
1241                     "cancel_time" => undef
1242                 },
1243                 $bresv_flesh
1244             ]) or $e->die_event;
1245         }
1246     };
1247
1248     my $result = {};
1249     foreach (@$which) {
1250         my $f = $dispatch->{$_};
1251         if ($f) {
1252             my $r = &{$f}();
1253             return $r if (ref($r) eq "HASH" and exists $r->{"ilsevent"});
1254             $result->{$_} = $r;
1255         }
1256     }
1257
1258     return $result;
1259 }
1260 __PACKAGE__->register_method(
1261     method   => "get_captured_reservations",
1262     api_name => "open-ils.booking.reservations.get_captured",
1263     argc     => 3,
1264     signature=> {
1265         params => [
1266             {type => "string", desc => "Authentication token"},
1267             {type => "string", desc => "Patron barcode"},
1268             {type => "array", desc => "Parts wanted (patron, ready, out, in?)"}
1269         ],
1270         return => { desc => "A hash of parts." } # XXX describe more fully
1271     }
1272 );
1273
1274
1275 sub get_bresv_by_returnable_resource_barcode {
1276     my ($self, $client, $auth, $barcode) = @_;
1277
1278     my $e = new_editor(xact => 1, authtoken => $auth);
1279     return $e->die_event unless $e->checkauth;
1280     return $e->die_event unless $e->allowed("VIEW_USER");
1281 #    return $e->die_event unless $e->allowed("ADMIN_BOOKING_RESERVATION");
1282
1283     my $rows = $e->json_query({
1284         "select" => {"bresv" => ["id"]},
1285         "from" => {
1286             "bresv" => {
1287                 "brsrc" => {"field" => "id", "fkey" => "current_resource"}
1288             }
1289         },
1290         "where" => {
1291             "+brsrc" => {"barcode" => $barcode},
1292             "-and" => {
1293                 "pickup_time" => {"!=" => undef},
1294                 "cancel_time" => undef,
1295                 "return_time" => undef
1296             }
1297         }
1298     }) or return $e->die_event;
1299
1300     if (@$rows < 1) {
1301         $e->rollback;
1302         return $rows;
1303     } else {
1304         # More than one result might be possible, but we don't want to return
1305         # more than one at this time.
1306         my $id = $rows->[0]->{"id"};
1307         my $resp =$e->retrieve_booking_reservation([
1308             $id, {
1309                 "flesh" => 2,
1310                 "flesh_fields" => {
1311                     "bresv" => [qw/usr target_resource_type current_resource/],
1312                     "au" => ["card"]
1313                 }
1314             }
1315         ]) or $e->die_event;
1316         $e->rollback;
1317         return $resp;
1318     }
1319 }
1320
1321 __PACKAGE__->register_method(
1322     method   => "get_bresv_by_returnable_resource_barcode",
1323     api_name => "open-ils.booking.reservations.by_returnable_resource_barcode",
1324     argc     => 2,
1325     signature=> {
1326         params => [
1327             {type => "string", desc => "Authentication token"},
1328             {type => "string", desc => "Resource barcode"},
1329         ],
1330         return => { desc => "A fleshed bresv or an ilsevent on error" }
1331     }
1332 );
1333
1334
1335 1;