Bug 33146: Add public items lookup route
[srvgit] / Koha / REST / V1 / Items.pm
index 21e7aa9..938ffcd 100644 (file)
@@ -19,10 +19,12 @@ use Modern::Perl;
 
 use Mojo::Base 'Mojolicious::Controller';
 
+use C4::Circulation qw( barcodedecode );
+
 use Koha::Items;
 
-use List::MoreUtils qw(any);
-use Try::Tiny;
+use List::MoreUtils qw( any );
+use Try::Tiny qw( catch try );
 
 =head1 NAME
 
@@ -56,6 +58,31 @@ sub list {
     };
 }
 
+=head3 list_public
+
+Controller function that handles listing Koha::Item objects available to the opac
+
+=cut
+
+sub list_public {
+    my $c = shift->openapi->valid_input or return;
+
+    return try {
+        my $patron = $c->stash('koha.user');
+
+        my $items_set =
+          Koha::Items->filter_by_visible_in_opac( { patron => $patron } );
+        my $items = $c->objects->search($items_set);
+
+        return $c->render(
+            status  => 200,
+            openapi => $items
+        );
+    }
+    catch {
+        $c->unhandled_exception($_);
+    };
+}
 
 =head3 get
 
@@ -67,6 +94,31 @@ sub get {
     my $c = shift->openapi->valid_input or return;
 
     try {
+        my $items_rs = Koha::Items->new;
+        my $item = $c->objects->find($items_rs, $c->validation->param('item_id'));
+        unless ( $item ) {
+            return $c->render(
+                status => 404,
+                openapi => { error => 'Item not found'}
+            );
+        }
+        return $c->render( status => 200, openapi => $item );
+    }
+    catch {
+        $c->unhandled_exception($_);
+    };
+}
+
+=head3 delete
+
+Controller function that handles deleting a single Koha::Item
+
+=cut
+
+sub delete {
+    my $c = shift->openapi->valid_input or return;
+
+    return try {
         my $item = Koha::Items->find($c->validation->param('item_id'));
         unless ( $item ) {
             return $c->render(
@@ -74,7 +126,48 @@ sub get {
                 openapi => { error => 'Item not found'}
             );
         }
-        return $c->render( status => 200, openapi => $item->to_api );
+
+        my $safe_to_delete = $item->safe_to_delete;
+
+        if ( !$safe_to_delete ) {
+
+            # Pick the first error, if any
+            my ( $error ) = grep { $_->type eq 'error' } @{ $safe_to_delete->messages };
+
+            unless ( $error ) {
+                Koha::Exception->throw('Koha::Item->safe_to_delete returned false but carried no error message');
+            }
+
+            my $errors = {
+                book_on_loan       => { code => 'checked_out',        description => 'The item is checked out' },
+                book_reserved      => { code => 'found_hold',         description => 'Waiting or in-transit hold for the item' },
+                last_item_for_hold => { code => 'last_item_for_hold', description => 'The item is the last one on a record on which a biblio-level hold is placed' },
+                linked_analytics   => { code => 'linked_analytics',   description => 'The item has linked analytic records' },
+                not_same_branch    => { code => 'not_same_branch',    description => 'The item is blocked by independent branches' },
+            };
+
+            if ( any { $error->message eq $_ } keys %{$errors} ) {
+
+                my $code = $error->message;
+
+                return $c->render(
+                    status  => 409,
+                    openapi => {
+                        error      => $errors->{ $code }->{description},
+                        error_code => $errors->{ $code }->{code},
+                    }
+                );
+            } else {
+                Koha::Exception->throw( 'Koha::Patron->safe_to_delete carried an unexpected message: ' . $error->message );
+            }
+        }
+
+        $item->safe_delete;
+
+        return $c->render(
+            status  => 204,
+            openapi => q{}
+        );
     }
     catch {
         $c->unhandled_exception($_);
@@ -113,11 +206,9 @@ sub pickup_locations {
 
     return try {
 
-        my $ps_set = $item->pickup_locations( { patron => $patron } );
+        my $pl_set = $item->pickup_locations( { patron => $patron } );
 
-        my $pickup_locations = $c->objects->search( $ps_set );
         my @response = ();
-
         if ( C4::Context->preference('AllowHoldPolicyOverride') ) {
 
             my $libraries_rs = Koha::Libraries->search( { pickup_location => 1 } );
@@ -126,21 +217,19 @@ sub pickup_locations {
             @response = map {
                 my $library = $_;
                 $library->{needs_override} = (
-                    any { $_->{library_id} eq $library->{library_id} }
-                    @{$pickup_locations}
+                    any { $_->branchcode eq $library->{library_id} }
+                    @{ $pl_set->as_list }
                   )
                   ? Mojo::JSON->false
                   : Mojo::JSON->true;
                 $library;
             } @{$libraries};
-
-            return $c->render(
-                status  => 200,
-                openapi => \@response
-            );
         }
+        else {
 
-        @response = map { $_->{needs_override} = Mojo::JSON->false; $_; } @{$pickup_locations};
+            my $pickup_locations = $c->objects->search($pl_set);
+            @response = map { $_->{needs_override} = Mojo::JSON->false; $_; } @{$pickup_locations};
+        }
 
         return $c->render(
             status  => 200,
@@ -152,4 +241,170 @@ sub pickup_locations {
     };
 }
 
+=head3 bundled_items
+
+Controller function that handles bundled_items Koha::Item objects
+
+=cut
+
+sub bundled_items {
+    my $c = shift->openapi->valid_input or return;
+
+    my $item_id = $c->validation->param('item_id');
+    my $item = Koha::Items->find( $item_id );
+
+    unless ($item) {
+        return $c->render(
+            status  => 404,
+            openapi => { error => "Item not found" }
+        );
+    }
+
+    return try {
+        my $items_set = $item->bundle_items;
+        my $items     = $c->objects->search( $items_set );
+        return $c->render(
+            status  => 200,
+            openapi => $items
+        );
+    }
+    catch {
+        $c->unhandled_exception($_);
+    };
+}
+
+=head3 add_to_bundle
+
+Controller function that handles adding items to this bundle
+
+=cut
+
+sub add_to_bundle {
+    my $c = shift->openapi->valid_input or return;
+
+    my $item_id = $c->validation->param('item_id');
+    my $item = Koha::Items->find( $item_id );
+
+    unless ($item) {
+        return $c->render(
+            status  => 404,
+            openapi => { error => "Item not found" }
+        );
+    }
+
+    my $bundle_item_id = $c->validation->param('body')->{'external_id'};
+    $bundle_item_id = barcodedecode($bundle_item_id);
+    my $bundle_item = Koha::Items->find( { barcode => $bundle_item_id } );
+
+    unless ($bundle_item) {
+        return $c->render(
+            status  => 404,
+            openapi => { error => "Bundle item not found" }
+        );
+    }
+
+    return try {
+        my $body = $c->validation->param('body');
+        my $options = {
+            force_checkin => $body->{force_checkin},
+            ignore_holds => $body->{ignore_holds},
+        };
+
+        my $link = $item->add_to_bundle($bundle_item, $options);
+        return $c->render(
+            status  => 201,
+            openapi => $bundle_item
+        );
+    }
+    catch {
+        if ( ref($_) eq 'Koha::Exceptions::Object::DuplicateID' ) {
+            return $c->render(
+                status  => 409,
+                openapi => {
+                    error      => 'Item is already bundled',
+                    error_code => 'already_bundled',
+                    key        => $_->duplicate_id
+                }
+            );
+        }
+        elsif ( ref($_) eq 'Koha::Exceptions::Item::Bundle::ItemIsCheckedOut' )
+        {
+            return $c->render(
+                status  => 409,
+                openapi => {
+                    error      => 'Item is checked out',
+                    error_code => 'checked_out'
+                }
+            );
+        }
+        elsif ( ref($_) eq 'Koha::Exceptions::Checkin::FailedCheckin' ) {
+            return $c->render(
+                status  => 409,
+                openapi => {
+                    error      => 'Item cannot be checked in',
+                    error_code => 'failed_checkin'
+                }
+            );
+        }
+        elsif ( ref($_) eq 'Koha::Exceptions::Item::Bundle::ItemHasHolds' ) {
+            return $c->render(
+                status  => 409,
+                openapi => {
+                    error      => 'Item is reserved',
+                    error_code => 'reserved'
+                }
+            );
+        }
+        elsif ( ref($_) eq 'Koha::Exceptions::Item::Bundle::IsBundle' ) {
+            return $c->render(
+                status  => 400,
+                openapi => {
+                    error      => 'Bundles cannot be nested',
+                    error_code => 'failed_nesting'
+                }
+            );
+        }
+        else {
+            $c->unhandled_exception($_);
+        }
+    };
+}
+
+=head3 remove_from_bundle
+
+Controller function that handles removing items from this bundle
+
+=cut
+
+sub remove_from_bundle {
+    my $c = shift->openapi->valid_input or return;
+
+    my $item_id = $c->validation->param('item_id');
+    my $item = Koha::Items->find( $item_id );
+
+    unless ($item) {
+        return $c->render(
+            status  => 404,
+            openapi => { error => "Item not found" }
+        );
+    }
+
+    my $bundle_item_id = $c->validation->param('bundled_item_id');
+    $bundle_item_id = barcodedecode($bundle_item_id);
+    my $bundle_item = Koha::Items->find( { itemnumber => $bundle_item_id } );
+
+    unless ($bundle_item) {
+        return $c->render(
+            status  => 404,
+            openapi => { error => "Bundle item not found" }
+        );
+    }
+
+    $bundle_item->remove_from_bundle;
+    return $c->render(
+        status  => 204,
+        openapi => q{}
+    );
+}
+
 1;