1 package OpenILS::Application::Booking;
6 use POSIX qw/strftime/;
7 use OpenILS::Application;
8 use base qw/OpenILS::Application/;
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";
16 use OpenSRF::Utils::Logger qw/$logger/;
19 my ($record_id, $owning_lib, $mvr) = @_;
21 my $brt = new Fieldmapper::booking::resource_type;
23 $brt->name($mvr->title);
24 $brt->record($record_id);
25 $brt->catalog_item('t');
26 $brt->transferable('t');
27 $brt->owner($owning_lib);
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}
38 return $results->[0] if scalar(@$results) > 0;
45 'open-ils.search.biblio.record.mods_slim.retrieve.authoritative',
50 sub get_unique_owning_libs {
52 $hash{$_->call_number->owning_lib} = 1 foreach (@_); # @_ are copies
56 sub fetch_copies_by_ids {
57 my ($e, $copy_ids) = @_;
58 my $results = $e->search_asset_copy([
60 {flesh => 1, flesh_fields => {acp => ['call_number']}}
62 return $results if ref($results) eq 'ARRAY';
66 sub get_single_record_id {
67 my $record_id = undef;
68 foreach (@_) { # @_ are copies
70 (defined $record_id && $record_id != $_->call_number->record);
71 $record_id = $_->call_number->record;
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).
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.
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 {
90 { '-and' => [{$_[2] => {'>=', $_[0]}}, {$_[2] => {'<', $_[1]}}]},
91 { '-and' => [{$_[3] => {'>', $_[0]}}, {$_[3] => {'<', $_[1]}}]},
92 { '-and' => { $_[3] => {'>', $_[0]}, $_[2] => {'<=', $_[0]}}},
93 { '-and' => { $_[3] => {'>', $_[1]}, $_[2] => {'<', $_[1]}}},
97 sub create_brt_and_brsrc {
98 my ($self, $conn, $authtoken, $copy_ids) = @_;
99 my (@created_brt, @created_brsrc);
102 my $e = new_editor(xact => 1, authtoken => $authtoken);
103 return $e->die_event unless $e->checkauth;
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;
109 foreach (get_unique_owning_libs(@copies)) {
110 $brt_table{$_} = get_existing_brt($e, $record_id, $_, $mvr) ||
111 prepare_new_brt($record_id, $_, $mvr);
114 while (my ($owning_lib, $brt) = each %brt_table) {
115 my $pre_existing = 1;
117 if ($e->allowed('ADMIN_BOOKING_RESOURCE_TYPE', $owning_lib)) {
119 return $e->die_event unless (
120 # v-- Important: assignment modifies original hash
121 $brt = $e->create_booking_resource_type($brt)
125 push @created_brt, [$brt->id, $brt->record, $pre_existing];
130 'ADMIN_BOOKING_RESOURCE', $_->call_number->owning_lib
132 # This block needs to disregard any cstore failures and just
133 # return what results it can.
134 my $brsrc = new Fieldmapper::booking::resource;
136 $brsrc->type($brt_table{$_->call_number->owning_lib}->id);
137 $brsrc->owner($_->call_number->owning_lib);
138 $brsrc->barcode($_->barcode);
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/ }
148 $usable_result = $usable_result->[0];
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
157 "Couldn't create or find brsrc for acp #" . $_->id
161 $e->release_savepoint("alpha");
164 if ($usable_result) {
166 [$usable_result->id, $_->id, $pre_existing];
172 return {brt => \@created_brt, brsrc => \@created_brsrc} or
173 return $e->die_event;
175 __PACKAGE__->register_method(
176 method => "create_brt_and_brsrc",
177 api_name => "open-ils.booking.resources.create_from_copies",
180 {type => 'string', desc => 'Authentication token'},
181 {type => 'array', desc => 'Copy IDs'},
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."}
193 my ($self, $client, $authtoken,
194 $target_user_barcode, $datetime_range, $pickup_lib,
195 $brt, $brsrc_list, $attr_values) = @_;
197 $brsrc_list = [ undef ] if not defined $brsrc_list;
198 return undef if scalar(@$brsrc_list) < 1; # Empty list not ok.
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");
204 my $usr = $U->fetch_user_by_barcode($target_user_barcode);
205 return $usr if ref($usr) eq 'HASH' and exists($usr->{"ilsevent"});
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]);
216 # A little sanity checking: don't agree to put a reservation on a
217 # brsrc and a brt when they don't match. In fact, bomb out of
218 # this transaction entirely.
220 my $brsrc_itself = $e->retrieve_booking_resource([
223 "flesh_fields" => {"brsrc" => ["type"]}
227 if (not $brsrc_itself) {
228 my $ev = new OpenILS::Event(
229 "RESERVATION_BAD_PARAMS",
230 desc => "brsrc $brsrc doesn't exist"
235 elsif ($brsrc_itself->type->id != $brt) {
236 my $ev = new OpenILS::Event(
237 "RESERVATION_BAD_PARAMS",
238 desc => "brsrc $brsrc doesn't match given brt $brt"
244 # Also bail if the user is trying to create a reservation at
245 # a pickup lib to which our resource won't go.
247 $brsrc_itself->owner != $pickup_lib and
248 not $brsrc_itself->type->transferable
250 my $ev = new OpenILS::Event(
251 "RESERVATION_BAD_PARAMS",
252 desc => "brsrc $brsrc doesn't belong to $pickup_lib and " .
253 "is not transferable"
259 $bresv->target_resource($brsrc); # undef is ok here
260 $bresv->target_resource_type($brt);
262 ($bresv = $e->create_booking_reservation($bresv)) or
263 return $e->die_event;
265 # We could/should do some sanity checking on this too: namely, on
266 # whether the attribute values given actually apply to the relevant
267 # brt. Not seeing any grievous side effects of not checking, though.
269 foreach my $value (@$attr_values) {
270 my $bravm = new Fieldmapper::booking::reservation_attr_value_map;
271 $bravm->reservation($bresv->id);
272 $bravm->attr_value($value);
273 $bravm = $e->create_booking_reservation_attr_value_map($bravm) or
274 return $e->die_event;
278 "bresv" => $bresv->id,
283 $e->commit or return $e->die_event;
285 # Targeting must be tacked on _after_ committing the transaction where the
286 # reservations are actually created.
287 foreach (@$results) {
288 $_->{"targeting"} = $U->storagereq(
289 "open-ils.storage.booking.reservation.resource_targeter",
295 __PACKAGE__->register_method(
296 method => "create_bresv",
297 api_name => "open-ils.booking.reservations.create",
300 {type => 'string', desc => 'Authentication token'},
301 {type => 'string', desc => 'Barcode of user for whom to reserve'},
302 {type => 'array', desc => 'Two elements: start and end timestamp'},
303 {type => 'int', desc => 'Desired reservation pickup lib'},
304 {type => 'int', desc => 'Booking resource type'},
305 {type => 'list', desc => 'Booking resource (undef ok; empty not ok)'},
306 {type => 'array', desc => 'Attribute values selected'},
308 return => { desc => "A hash containing the new bresv and a list " .
314 sub resource_list_by_attrs {
317 my $auth = shift; # Keep as argument, though not used just now.
320 return undef unless ($filters->{type} || $filters->{attribute_values});
323 "select" => {brsrc => [qw/id owner/], brt => ["elbow_room"]},
324 "from" => {brsrc => {"brt" => {}}},
329 $query->{where} = {"-and" => []};
330 if ($filters->{type}) {
331 push @{$query->{where}->{"-and"}}, {"type" => $filters->{type}};
334 if ($filters->{pickup_lib}) {
335 push @{$query->{where}->{"-and"}},
337 {"owner" => $filters->{pickup_lib}},
338 {"+brt" => {"transferable" => "t"}}
342 if ($filters->{attribute_values}) {
344 $query->{from}->{brsrc}->{bram} = { field => 'resource' };
346 $filters->{attribute_values} = [$filters->{attribute_values}]
347 if (!ref($filters->{attribute_values}));
349 $query->{having}->{'+bram'}->{value}->{'@>'} = {
350 transform => 'array_accum',
351 value => '$_' . $$ . '${' .
352 join(',', @{$filters->{attribute_values}}) .
357 if ($filters->{available}) {
358 # If only one timestamp has been provided, make it into a range.
359 if (!ref($filters->{available})) {
360 $filters->{available} = [($filters->{available}) x 2];
363 push @{$query->{where}->{"-and"}}, {
367 "select" => {"bresv" => ["id"]},
369 "where" => {"-and" => [
370 json_query_ranges_overlap(
371 $filters->{available}->[0],
372 $filters->{available}->[1],
376 {"cancel_time" => undef},
377 {"return_time" => undef},
378 {"current_resource" => {"=" => {"+brsrc" => "id"}}}
384 if ($filters->{booked}) {
385 # If only one timestamp has been provided, make it into a range.
386 if (!ref($filters->{booked})) {
387 $filters->{booked} = [($filters->{booked}) x 2];
390 push @{$query->{where}->{"-and"}}, {
392 "select" => {"bresv" => ["id"]},
394 "where" => {"-and" => [
395 json_query_ranges_overlap(
396 $filters->{booked}->[0],
397 $filters->{booked}->[1],
401 {"cancel_time" => undef},
402 {"current_resource" => { "=" => {"+brsrc" => "id"}}}
406 # I think that the "booked" case could be done with a JOIN instead of
407 # an EXISTS, but I'm leaving it this way for symmetry with the
408 # "available" case for now. The available case cannot be done with a
412 my $cstore = OpenSRF::AppSession->connect('open-ils.cstore');
413 my $rows = $cstore->request(
414 "open-ils.cstore.json_query.atomic", $query
418 return [] if not @$rows;
420 if ($filters->{"pickup_lib"} && $filters->{"available"}) {
422 my $general_elbow_room = $U->ou_ancestor_setting_value(
423 $filters->{"pickup_lib"},
424 "circ.booking_reservation.default_elbow_room"
426 my $would_start = $filters->{"available"}->[0];
427 my $dt_parser = new DateTime::Format::ISO8601;
430 "general_elbow_room: '$general_elbow_room', " .
431 "would_start: '$would_start'"
434 # Here, elbow_room will double as required transit time padding.
436 my $elbow_room = $_->{"elbow_room"} || $general_elbow_room;
437 if ($_->{"owner"} != $filters->{"pickup_lib"}) {
438 (my $ws = $would_start) =~ s/ /T/;
439 push @new_rows, $_ if DateTime->compare(
440 $dt_parser->parse_datetime($ws),
442 "time_zone" => DateTime::TimeZone->new(
445 )->add(seconds => interval_to_seconds($elbow_room))
451 return [map { $_->{id} } @new_rows];
453 return [map { $_->{id} } @$rows];
456 __PACKAGE__->register_method(
457 method => "resource_list_by_attrs",
458 api_name => "open-ils.booking.resources.filtered_id_list",
462 {type => 'string', desc => 'Authentication token (unused for now,' .
463 ' but at least pass undef here)'},
464 {type => 'object', desc => 'Filter object: see notes for details'},
466 return => { desc => "An array of brsrc ids matching the requested filters." },
470 The filter object parameter can contain the following keys:
471 * type => The id of a booking resource type (brt)
472 * attribute_values => The ids of booking resource type attribute values that the resource must have assigned to it (brav)
473 * available => Either:
474 A timestamp during which the resources are not reserved. If the resource is overbookable, this is ignored.
475 A range of two timestamps which do not overlap any reservations for the resources. If the resource is overbookable, this is ignored.
477 A timestamp during which the resources are reserved.
478 A range of two timestamps which overlap a reservation of the resources.
480 Note that at least one of 'type' or 'attribute_values' is required.
486 sub reservation_list_by_filters {
491 my $whole_obj = shift;
493 return undef unless ($filters->{user} || $filters->{user_barcode} || $filters->{resource} || $filters->{type} || $filters->{attribute_values});
495 my $e = new_editor(authtoken=>$auth);
496 return $e->event unless $e->checkauth;
497 return $e->event unless $e->allowed('VIEW_TRANSACTION');
500 'select' => { bresv => [ 'id', 'start_time' ] },
501 'from' => { bresv => {} },
503 'order_by' => [{ class => bresv => field => start_time => direction => 'asc' }],
507 if ($filters->{fields}) {
508 $query->{where} = $filters->{fields};
512 if ($filters->{user}) {
513 $query->{where}->{usr} = $filters->{user};
515 elsif ($filters->{user_barcode}) { # just one of user and user_barcode
516 my $usr = $U->fetch_user_by_barcode($filters->{user_barcode});
517 return $usr if ref($usr) eq 'HASH' and exists($usr->{"ilsevent"});
518 $query->{where}->{usr} = $usr->id;
522 if ($filters->{type}) {
523 $query->{where}->{target_resource_type} = $filters->{type};
526 $query->{where}->{"-and"} = [];
527 if ($filters->{resource}) {
528 # $query->{where}->{target_resource} = $filters->{resource};
529 push @{$query->{where}->{"-and"}}, {
531 "target_resource" => $filters->{resource},
532 "current_resource" => $filters->{resource}
537 if ($filters->{attribute_values}) {
539 $query->{from}->{bresv}->{bravm} = { field => 'reservation' };
541 $filters->{attribute_values} = [$filters->{attribute_values}]
542 if (!ref($filters->{attribute_values}));
544 $query->{having}->{'+bravm'}->{attr_value}->{'@>'} = {
545 transform => 'array_accum',
546 value => '$_' . $$ . '${' .
547 join(',', @{$filters->{attribute_values}}) .
552 if ($filters->{search_start} || $filters->{search_end}) {
556 {'between' => [ $filters->{search_start}, $filters->{search_end}]}
557 if $filters->{search_start};
560 {'between' =>[$filters->{search_start}, $filters->{search_end}]}
561 if $filters->{search_end};
563 push @{$query->{where}->{"-and"}}, {"-or" => $or};
566 if (not scalar @{$query->{"where"}->{"-and"}}) {
567 delete $query->{"where"}->{"-and"};
570 my $cstore = OpenSRF::AppSession->connect('open-ils.cstore');
571 my $ids = [ map { $_->{id} } @{
573 'open-ils.cstore.json_query.atomic', $query
578 if (not $whole_obj or @$ids < 1) {
583 my $bresv_list = $e->search_booking_reservation([
588 [qw/target_resource current_resource target_resource_type/]
593 return $bresv_list ? $bresv_list : [];
595 __PACKAGE__->register_method(
596 method => "reservation_list_by_filters",
597 api_name => "open-ils.booking.reservations.filtered_id_list",
601 {type => 'string', desc => 'Authentication token'},
602 {type => "object", desc => "Filter object: see notes for details"},
603 {type => "bool", desc => "Return whole object instead of ID? (default false)"}
605 return => { desc => "An array of bresv ids matching the requested filters." },
609 The filter object parameter can contain the following keys:
610 * user => The id of a user that has requested a bookable item -- filters on bresv.usr
611 * barcode => The barcode of a user that has requested a bookable item
612 * type => The id of a booking resource type (brt) -- filters on bresv.target_resource_type
613 * resource => The id of a booking resource (brsrc) -- filters on bresv.target_resource
614 * attribute_values => The ids of booking resource type attribute values that the resource must have assigned to it (brav)
615 * search_start => If search_end is not specified, booking interval (start_time to end_time) must contain this timestamp.
616 * search_end => If search_start is not specified, booking interval (start_time to end_time) must contain this timestamp.
617 * fields => An object containing any combination of bresv search filters in standard cstore/pcrud search format.
619 Note that at least one of 'user', 'type', 'resource' or 'attribute_values' is required. If both search_start and search_end are specified,
620 then the result includes any reservations that overlap with that time range. Any filter fields supplied in 'fields' are overridden
621 by the top-level filters ('user', 'type', 'resource').
627 sub naive_ts_string {strftime("%F %T", localtime($_[0] || time));}
628 sub naive_start_of_day {strftime("%F", localtime($_[0] || time))." 00:00:00";}
630 # Return a map of bresv or an ilsevent on failure.
631 sub get_uncaptured_bresv_for_brsrc {
632 my ($e, $o) = @_; # o's keys (all optional): owning_lib, barcode, range
636 "brsrc" => {"field" => "id", "fkey" => "current_resource"}
645 "column" => "start_time",
646 "transform" => "min",
651 "from" => $from_clause,
654 {"current_resource" => {"!=" => undef}},
655 {"capture_time" => undef},
656 {"cancel_time" => undef},
657 {"return_time" => undef},
658 {"pickup_time" => undef}
662 if ($o->{"owning_lib"}) {
663 push @{$query->{"where"}->{"-and"}},
664 {"+brsrc" => {"owner" => $o->{"owning_lib"}}};
667 push @{$query->{"where"}->{"-and"}},
668 json_query_ranges_overlap(
669 $o->{"range"}->[0], $o->{"range"}->[1],
670 "start_time", "end_time"
673 if ($o->{"barcode"}) {
674 push @{$query->{"where"}->{"-and"}},
675 {"+brsrc" => {"barcode" => $o->{"barcode"}}};
678 my $rows = $e->json_query($query);
679 my $current_resource_bresv_map = {};
682 "select" => {"bresv" => ["id"]},
683 "from" => $from_clause,
686 {"current_resource" => "PLACEHOLDER"},
687 {"start_time" => "PLACEHOLDER"},
688 {"capture_time" => undef},
689 {"cancel_time" => undef},
690 {"return_time" => undef},
691 {"pickup_time" => undef}
695 if ($o->{"owning_lib"}) {
696 push @{$id_query->{"where"}->{"-and"}},
697 {"+brsrc" => {"owner" => $o->{"owning_lib"}}};
701 $id_query->{"where"}->{"-and"}->[0]->{"current_resource"} =
702 $_->{"current_resource"};
703 $id_query->{"where"}->{"-and"}->[1]->{"start_time"} =
706 my $results = $e->json_query($id_query);
707 if ($results && @$results) {
708 $current_resource_bresv_map->{$_->{"current_resource"}} =
709 [map { $_->{"id"} } @$results];
713 return $current_resource_bresv_map;
717 my ($self, $client, $auth, $range, $interval_secs, $owning_lib) = @_;
719 my $e = new_editor(xact => 1, authtoken => $auth);
720 return $e->die_event unless $e->checkauth;
721 return $e->die_event unless $e->allowed("RETRIEVE_RESERVATION_PULL_LIST");
722 return $e->die_event unless (
723 ref($range) eq "ARRAY" or
724 ($interval_secs = int($interval_secs)) > 0
727 $owning_lib = $e->requestor->ws_ou if not $owning_lib;
728 $range = [ naive_ts_string(time), naive_ts_string(time + $interval_secs) ]
731 my $uncaptured = get_uncaptured_bresv_for_brsrc(
732 $e, {"range" => $range, "owning_lib" => $owning_lib}
735 if (keys(%$uncaptured)) {
736 my @all_bresv_ids = map { @{$_} } values %$uncaptured;
738 map { $_->id => $_ } @{
739 $e->search_booking_reservation([{"id" => [@all_bresv_ids]}, {
741 flesh_fields => { bresv => [
742 "usr", "target_resource_type", "current_resource"
750 my $one = $bresv_lookup{$uncaptured->{$key}->[0]};
752 "current_resource" => $one->current_resource,
753 "target_resource_type" => $one->target_resource_type,
755 map { $bresv_lookup{$_} } @{$uncaptured->{$key}}
758 foreach (@{$result->{"reservations"}}) { # deflesh
759 $_->current_resource($_->current_resource->id);
760 $_->target_resource_type($_->target_resource_type->id);
763 } keys %$uncaptured ];
769 __PACKAGE__->register_method(
770 method => "get_pull_list",
771 api_name => "open-ils.booking.reservations.get_pull_list",
775 {type => "string", desc => "Authentication token"},
776 {type => "array", desc =>
777 "range: Date/time range for reservations (opt)"},
778 {type => "int", desc =>
779 "interval: Seconds from now (instead of range)"},
780 {type => "number", desc => "(Optional) Owning library"}
782 return => { desc => "An array of hashes, each containing key/value " .
783 "pairs describing resource, resource type, and a list of " .
784 "reservations that claim the given resource." }
790 my ($self, $client, $auth, $barcode) = @_;
792 my $e = new_editor("authtoken" => $auth);
793 return $e->die_event unless $e->checkauth;
794 return $e->die_event unless $e->allowed("COPY_CHECKIN");
796 my $dt_parser = new DateTime::Format::ISO8601;
797 my $now = now DateTime; # sic
798 my $res = get_uncaptured_bresv_for_brsrc($e, {"barcode" => $barcode});
800 if ($res and keys %$res) {
802 while ((undef, $id) = each %$res) {
803 my $bresv = $e->retrieve_booking_reservation([
805 "flesh" => 1, "flesh_fields" => {
807 usr target_resource_type
808 target_resource current_resource
813 my $elbow_room = interval_to_seconds(
814 $bresv->target_resource_type->elbow_room ||
815 $U->ou_ancestor_setting_value(
817 "circ.booking_reservation.default_elbow_room"
822 unless ($elbow_room) {
823 $client->respond($bresv);
825 my $start_time = $dt_parser->parse_datetime(
826 clense_ISO8601($bresv->start_time)
829 if ($now >= $start_time->subtract("seconds" => $elbow_room)) {
830 $client->respond($bresv);
833 "not within elbow room: $elbow_room, " .
834 "else would have returned bresv " . $bresv->id
843 __PACKAGE__->register_method(
844 method => "could_capture",
845 api_name => "open-ils.booking.reservations.could_capture",
850 {type => "string", desc => "Authentication token"},
851 {type => "string", desc => "Resource barcode"}
853 return => {desc => "One or zero reservations; event on error."}
858 sub get_copy_fleshed_just_right {
859 my ($self, $client, $auth, $barcode) = @_;
861 return undef if not defined $barcode;
862 return {} if ref($barcode) eq "ARRAY" and not @$barcode;
864 my $e = new_editor(authtoken => $auth);
865 my $results = $e->search_asset_copy([
866 {"barcode" => $barcode},
869 "flesh_fields" => {"acp" => [qw/call_number location/]}
873 if (ref($results) eq "ARRAY") {
875 return $results->[0] unless ref $barcode;
876 return +{ map { $_->barcode => $_ } @$results };
878 return $e->die_event;
881 __PACKAGE__->register_method(
882 method => "get_copy_fleshed_just_right",
883 api_name => "open-ils.booking.asset.get_copy_fleshed_just_right",
887 {type => "string", desc => "Authentication token"},
888 {type => "mixed", desc => "One barcode or an array of them"},
891 "A copy, or a hash of copies keyed by barcode if an array of " .
898 sub best_bresv_candidate {
899 my ($e, $id_list) = @_;
901 # This will almost always be the case.
902 if (@$id_list == 1) {
903 $logger->info("best_bresv_candidate (only) " . $id_list->[0]);
904 return $id_list->[0];
908 my $this_ou = $e->requestor->ws_ou;
909 my $results = $e->json_query({
910 "select" => {"brsrc" => ["pickup_lib"], "bresv" => ["id"]},
913 "brsrc" => {"field" => "id", "fkey" => "current_resource"}
917 {"+bresv" => {"id" => $id_list}}
921 foreach (@$results) {
922 push @here, $_->{"id"} if $_->{"pickup_lib"} == $this_ou;
927 $result = @here == 1 ? pop @here : (sort @here)[0];
929 $result = (sort @$id_list)[0];
932 "best_bresv_candidate from " . join(",", @$id_list) . ": $result"
938 sub capture_resource_for_reservation {
939 my ($self, $client, $auth, $barcode, $no_update_copy) = @_;
941 my $e = new_editor(authtoken => $auth);
942 return $e->die_event unless $e->checkauth;
943 return $e->die_event unless $e->allowed("COPY_CHECKIN");
945 my $uncaptured = get_uncaptured_bresv_for_brsrc(
946 $e, {"barcode" => $barcode}
949 if (keys %$uncaptured) {
950 # Note this will only capture one reservation at a time, even in
951 # cases with overbooking (multiple "soonest" bresv's on a resource).
952 my $bresv = best_bresv_candidate(
954 (sort(keys %$uncaptured))[0]
958 return capture_reservation(
959 $self, $client, $auth, $bresv, $no_update_copy
962 return new OpenILS::Event(
963 "RESERVATION_NOT_FOUND",
964 "desc" => "No capturable reservation found pertaining " .
965 "to a resource with barcode $barcode",
966 "payload" => {"fail_cause" => "no-reservation", "captured" => 0}
970 __PACKAGE__->register_method(
971 method => "capture_resource_for_reservation",
972 api_name => "open-ils.booking.resources.capture_for_reservation",
976 {type => "string", desc => "Authentication token"},
977 {type => "string", desc => "Barcode of booked & targeted resource"},
978 {type => "number", desc => "(optional) 1 to not update copy"}
980 return => { desc => "An OpenILS event describing the capture outcome" }
985 sub capture_reservation {
986 my ($self, $client, $auth, $res_id, $no_update_copy) = @_;
988 my $e = new_editor("xact" => 1, "authtoken" => $auth);
989 return $e->die_event unless $e->checkauth;
990 return $e->die_event unless $e->allowed("COPY_CHECKIN");
991 my $here = $e->requestor->ws_ou;
993 my $reservation = $e->retrieve_booking_reservation([
995 "flesh" => 2, "flesh_fields" => {
996 "bresv" => [qw/usr current_resource type/],
1003 return new OpenILS::Event("RESERVATION_NOT_FOUND") unless $reservation;
1004 return new OpenILS::Event(
1005 "RESERVATION_CAPTURE_FAILED",
1006 payload => {"captured" => 0, "fail_cause" => "no-resource"}
1007 ) unless $reservation->current_resource;
1009 return new OpenILS::Event(
1010 "RESERVATION_CAPTURE_FAILED",
1011 "payload" => {"captured" => 0, "fail_cause" => "cancelled"}
1012 ) if $reservation->cancel_time;
1014 $reservation->capture_staff($e->requestor->id);
1015 $reservation->capture_time("now");
1017 $e->update_booking_reservation($reservation) or return $e->die_event;
1019 my $ret = {"captured" => 1, "reservation" => $reservation};
1021 my $search_acp_like_this = [
1023 "barcode" => $reservation->current_resource->barcode,
1026 {"flesh" => 1, "flesh_fields" => {"acp" => ["call_number"]}}
1029 if ($here != $reservation->pickup_lib) {
1030 $logger->info("resource isn't at the reservation's pickup lib...");
1031 return new OpenILS::Event(
1032 "RESERVATION_CAPTURE_FAILED",
1033 "payload" => {"captured" => 0, "fail_cause" => "not-transferable"}
1034 ) unless $U->is_true(
1035 $reservation->current_resource->type->transferable
1038 # need to transit the item ... is it already in transit?
1039 my $transit = $e->search_action_reservation_transit_copy(
1040 {"reservation" => $res_id, "dest_recv_time" => undef}
1043 if (!$transit) { # not yet in transit
1044 $transit = new Fieldmapper::action::reservation_transit_copy;
1046 $transit->reservation($reservation->id);
1047 $transit->target_copy($reservation->current_resource->id);
1048 $transit->copy_status(15);
1049 $transit->source_send_time("now");
1050 $transit->source($here);
1051 $transit->dest($reservation->pickup_lib);
1053 $e->create_action_reservation_transit_copy($transit);
1056 $reservation->current_resource->type->catalog_item
1058 my $copy = $e->search_asset_copy($search_acp_like_this)->[0];
1061 return new OpenILS::Event(
1062 "OPEN_CIRCULATION_EXISTS",
1063 "payload" => {"captured" => 0, "copy" => $copy}
1064 ) if $copy->status == 1 and not $no_update_copy;
1066 $ret->{"mvr"} = get_mvr($copy->call_number->record);
1067 if ($no_update_copy) {
1068 $ret->{"new_copy_status"} = 6;
1071 $e->update_asset_copy($copy) or return $e->die_event;
1077 $ret->{"transit"} = $transit;
1078 } elsif ($U->is_true($reservation->current_resource->type->catalog_item)) {
1079 $logger->info("resource is a catalog item...");
1080 my $copy = $e->search_asset_copy($search_acp_like_this)->[0];
1083 return new OpenILS::Event(
1084 "OPEN_CIRCULATION_EXISTS",
1085 "payload" => {"captured" => 0, "copy" => $copy}
1086 ) if $copy->status == 1 and not $no_update_copy;
1088 $ret->{"mvr"} = get_mvr($copy->call_number->record);
1089 if ($no_update_copy) {
1090 $ret->{"new_copy_status"} = 15;
1093 $e->update_asset_copy($copy) or return $e->die_event;
1098 $e->commit or return $e->die_event;
1100 # XXX I'm not sure whether these last two elements of the payload
1101 # actually get used anywhere.
1102 $ret->{"resource"} = $reservation->current_resource;
1103 $ret->{"type"} = $reservation->current_resource->type;
1104 return new OpenILS::Event("SUCCESS", "payload" => $ret);
1106 __PACKAGE__->register_method(
1107 method => "capture_reservation",
1108 api_name => "open-ils.booking.reservations.capture",
1112 {type => 'string', desc => 'Authentication token'},
1113 {type => 'mixed', desc =>
1114 'Reservation ID (number) or array of resource barcodes'}
1116 return => { desc => "An OpenILS Event object describing the outcome of the capture, with relevant payload." },
1121 sub cancel_reservation {
1122 my ($self, $client, $auth, $id_list) = @_;
1124 my $e = new_editor(xact => 1, authtoken => $auth);
1125 return $e->die_event unless $e->checkauth;
1126 # Should the following permission really be checked as relates to each
1127 # individual reservation's request_lib? Hrmm...
1128 return $e->die_event unless $e->allowed("ADMIN_BOOKING_RESERVATION");
1130 my $bresv_list = $e->search_booking_reservation([
1132 {"flesh" => 1, "flesh_fields" => {"bresv" => [
1133 "current_resource", "target_resource_type"
1136 return $e->die_event if not $bresv_list;
1139 my $circ = OpenSRF::AppSession->connect("open-ils.circ") or
1140 return $e->die_event;
1141 foreach my $bresv (@$bresv_list) {
1142 $bresv->cancel_time("now");
1143 $e->update_booking_reservation($bresv) or do {
1145 return $e->die_event;
1151 $bresv->target_resource_type->catalog_item == "t" &&
1152 $bresv->current_resource
1154 $logger->info("result of no-op checkin (upon cxl bresv) is " .
1156 "open-ils.circ.checkin", $auth,
1157 {"barcode" => $bresv->current_resource->barcode,
1159 )->gather(1)->{"textcode"});
1161 push @results, $bresv->id;
1169 __PACKAGE__->register_method(
1170 method => "cancel_reservation",
1171 api_name => "open-ils.booking.reservations.cancel",
1175 {type => "string", desc => "Authentication token"},
1176 {type => "array", desc => "List of reservation IDs"}
1178 return => { desc => "A list of canceled reservation IDs" },
1183 sub get_captured_reservations {
1184 my ($self, $client, $auth, $barcode, $which) = @_;
1186 my $e = new_editor(xact => 1, authtoken => $auth);
1187 return $e->die_event unless $e->checkauth;
1188 return $e->die_event unless $e->allowed("VIEW_USER");
1189 return $e->die_event unless $e->allowed("ADMIN_BOOKING_RESERVATION");
1191 # fetch the patron for our uses in any case...
1192 my $patron = $U->fetch_user_by_barcode($barcode);
1193 return $patron if ref($patron) eq "HASH" and exists $patron->{"ilsevent"};
1197 "flesh_fields" => {"bresv" => [
1198 qw/target_resource_type current_resource/
1207 return $e->search_booking_reservation([
1209 "usr" => $patron->id,
1210 "capture_time" => {"!=" => undef},
1211 "pickup_time" => undef,
1212 "start_time" => {">=" => naive_start_of_day()},
1213 "cancel_time" => undef
1216 ]) or $e->die_event;
1219 return $e->search_booking_reservation([
1221 "usr" => $patron->id,
1222 "pickup_time" => {"!=" => undef},
1223 "return_time" => undef,
1224 "cancel_time" => undef
1227 ]) or $e->die_event;
1230 return $e->search_booking_reservation([
1232 "usr" => $patron->id,
1233 "return_time" => {">=" => naive_start_of_day()},
1234 "cancel_time" => undef
1237 ]) or $e->die_event;
1243 my $f = $dispatch->{$_};
1246 return $r if (ref($r) eq "HASH" and exists $r->{"ilsevent"});
1253 __PACKAGE__->register_method(
1254 method => "get_captured_reservations",
1255 api_name => "open-ils.booking.reservations.get_captured",
1259 {type => "string", desc => "Authentication token"},
1260 {type => "string", desc => "Patron barcode"},
1261 {type => "array", desc => "Parts wanted (patron, ready, out, in?)"}
1263 return => { desc => "A hash of parts." } # XXX describe more fully
1268 sub get_bresv_by_returnable_resource_barcode {
1269 my ($self, $client, $auth, $barcode) = @_;
1271 my $e = new_editor(xact => 1, authtoken => $auth);
1272 return $e->die_event unless $e->checkauth;
1273 return $e->die_event unless $e->allowed("VIEW_USER");
1274 # return $e->die_event unless $e->allowed("ADMIN_BOOKING_RESERVATION");
1276 my $rows = $e->json_query({
1277 "select" => {"bresv" => ["id"]},
1280 "brsrc" => {"field" => "id", "fkey" => "current_resource"}
1284 "+brsrc" => {"barcode" => $barcode},
1286 "pickup_time" => {"!=" => undef},
1287 "cancel_time" => undef,
1288 "return_time" => undef
1291 }) or return $e->die_event;
1297 # More than one result might be possible, but we don't want to return
1298 # more than one at this time.
1299 my $id = $rows->[0]->{"id"};
1300 my $resp =$e->retrieve_booking_reservation([
1304 "bresv" => [qw/usr target_resource_type current_resource/],
1308 ]) or $e->die_event;
1314 __PACKAGE__->register_method(
1315 method => "get_bresv_by_returnable_resource_barcode",
1316 api_name => "open-ils.booking.reservations.by_returnable_resource_barcode",
1320 {type => "string", desc => "Authentication token"},
1321 {type => "string", desc => "Resource barcode"},
1323 return => { desc => "A fleshed bresv or an ilsevent on error" }