Bug 17843: Replace C4::Koha::getitemtypeinfo with Koha::ItemTypes
[koha.git] / opac / opac-shelves.pl
index a118e43..b608657 100755 (executable)
 #!/usr/bin/perl
 
-# Copyright 2000-2002 Katipo Communications
+# Copyright 2015 Koha Team
 #
 # This file is part of Koha.
 #
-# Koha is free software; you can redistribute it and/or modify it under the
-# terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 2 of the License, or (at your option) any later
-# version.
+# Koha is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
 #
-# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
-# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
-# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+# Koha is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
 #
-# You should have received a copy of the GNU General Public License along with
-# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
-# Suite 330, Boston, MA  02111-1307 USA
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
 
+use Modern::Perl;
 
-=head1 NAME
-
-    opac-shelves.pl
-
-=head1 DESCRIPTION
-
-    this script is used to script to provide virtualshelf management
-
-=head1 CGI PARAMETERS
-
-=over 4
-
-=item C<modifyshelfcontents>
-
-    if this script has to modify the shelf content.
-
-=item C<shelfnumber>
-
-    to know on which shelf this script has to work.
-
-=item C<addbarcode>
-
-=item C<op>
-
-    op can equal the following values:
-        * 'modifsave' to save changes on the shelves
-        * 'modif' to change the template to allow modification of the shelves.
-
-=item C<viewshelf>
-
-    to load the template with 'viewshelves param' which allows reading the shelves information.
-
-=item C<shelves>
-
-    if == 1, then call the function shelves to add or delete a shelf.
-
-=item C<addshelf>
-
-    if the param shelves == 1, then addshelf must be equals to the name of the shelf to add.
-
-=back
-
-=cut
-
-use strict;
-use warnings;
-use CGI;
-use C4::Output;
-use C4::VirtualShelves;
-use C4::Circulation;
+use CGI qw ( -utf8 );
 use C4::Auth;
-use C4::Output;
 use C4::Biblio;
+use C4::Koha;
 use C4::Items;
+use C4::Members;
+use C4::Output;
+use C4::Tags qw( get_tags );
+use C4::XSLT;
 
-use vars qw($debug);
+use Koha::Biblioitems;
+use Koha::ItemTypes;
+use Koha::Virtualshelves;
+use Koha::RecordProcessor;
 
-BEGIN { 
-       $debug = $ENV{DEBUG} || 0;
-}
+use constant ANYONE => 2;
 
 my $query = new CGI;
 
-my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
-    {
-        template_name   => "opac-shelves.tmpl",
+my $template_name = $query->param('rss') ? "opac-shelves-rss.tt" : "opac-shelves.tt";
+
+# if virtualshelves is disabled, leave immediately
+if ( ! C4::Context->preference('virtualshelves') ) {
+    print $query->redirect("/cgi-bin/koha/errors/404.pl");
+    exit;
+}
+
+my ( $template, $loggedinuser, $cookie ) = get_template_and_user({
+        template_name   => $template_name,
         query           => $query,
         type            => "opac",
-        authnotrequired => 1,
+        authnotrequired => ( C4::Context->preference("OpacPublic") ? 1 : 0 ),
+    });
+
+my $op       = $query->param('op')       || 'list';
+my $referer  = $query->param('referer')  || $op;
+my $category = $query->param('category') || 1;
+my ( $shelf, $shelfnumber, @messages );
+
+if ( $op eq 'add_form' ) {
+    # Only pass default
+    $shelf = { allow_change_from_owner => 1 };
+} elsif ( $op eq 'edit_form' ) {
+    $shelfnumber = $query->param('shelfnumber');
+    $shelf       = Koha::Virtualshelves->find($shelfnumber);
+
+    if ( $shelf ) {
+        $category = $shelf->category;
+        my $patron = GetMember( 'borrowernumber' => $shelf->owner );
+        $template->param( owner => $patron, );
+        unless ( $shelf->can_be_managed( $loggedinuser ) ) {
+            push @messages, { type => 'error', code => 'unauthorized_on_update' };
+            $op = 'list';
+        }
+    } else {
+        push @messages, { type => 'error', code => 'does_not_exist' };
     }
-);
-
-if ( $query->param('modifyshelfcontents') ) {
-    my $shelfnumber = $query->param('viewshelf');
-    my $barcode     = $query->param('addbarcode');
-    my ($item) = GetItemnumberFromBarcode($barcode);
-    my ($biblio) = GetBiblioFromItemNumber($item->{'itemnumber'});
-    if ( ShelfPossibleAction( $loggedinuser, $shelfnumber, 'manage' ) ) {
-        AddToShelf( $biblio->{'biblionumber'}, $shelfnumber );
-        foreach ( $query->param ) {
-            /REM-(\d+)/ or next;
-                       $debug and warn "SHELVES: user $loggedinuser removing item $1 from shelf $shelfnumber";
-            DelFromShelf( $1, $shelfnumber );  # $1 is biblionumber
+} elsif ( $op eq 'add' ) {
+    if ( $loggedinuser ) {
+        my $allow_changes_from = $query->param('allow_changes_from');
+        eval {
+            $shelf = Koha::Virtualshelf->new(
+                {   shelfname          => scalar $query->param('shelfname'),
+                    sortfield          => scalar $query->param('sortfield'),
+                    category           => scalar $query->param('category') || 1,
+                    allow_change_from_owner => $allow_changes_from > 0,
+                    allow_change_from_others => $allow_changes_from == ANYONE,
+                    owner              => scalar $loggedinuser,
+                }
+            );
+            $shelf->store;
+            $shelfnumber = $shelf->shelfnumber;
+        };
+        if ($@) {
+            push @messages, { type => 'error', code => ref($@), msg => $@ };
+        } elsif ( not $shelf ) {
+            push @messages, { type => 'error', code => 'error_on_insert' };
+        } else {
+            push @messages, { type => 'message', code => 'success_on_insert' };
+            $op = 'view';
+        }
+    } else {
+        push @messages, { type => 'error', code => 'unauthorized_on_insert' };
+        $op = 'list';
+    }
+} elsif ( $op eq 'edit' ) {
+    $shelfnumber = $query->param('shelfnumber');
+    $shelf       = Koha::Virtualshelves->find($shelfnumber);
+    if ( $shelf ) {
+        $op = $referer;
+        my $sortfield = $query->param('sortfield');
+        $sortfield = 'title' unless grep {/^$sortfield$/}qw( title author copyrightdate itemcallnumber );
+        if ( $shelf->can_be_managed( $loggedinuser ) ) {
+            $shelf->shelfname( scalar $query->param('shelfname') );
+            $shelf->sortfield( $sortfield );
+            my $allow_changes_from = $query->param('allow_changes_from');
+            $shelf->allow_change_from_owner( $allow_changes_from > 0 );
+            $shelf->allow_change_from_others( $allow_changes_from == ANYONE );
+            $shelf->category( scalar $query->param('category') );
+            eval { $shelf->store };
+
+            if ($@) {
+                push @messages, { type => 'error', code => 'error_on_update' };
+                $op = 'edit_form';
+            } else {
+                push @messages, { type => 'message', code => 'success_on_update' };
+            }
+        } else {
+            push @messages, { type => 'error', code => 'unauthorized_on_update' };
+        }
+    } else {
+        push @messages, { type => 'error', code => 'does_not_exist' };
+    }
+} elsif ( $op eq 'delete' ) {
+    $shelfnumber = $query->param('shelfnumber');
+    $shelf       = Koha::Virtualshelves->find($shelfnumber);
+    if ($shelf) {
+        if ( $shelf->can_be_deleted( $loggedinuser ) ) {
+            eval { $shelf->delete; };
+            if ($@) {
+                push @messages, { type => 'error', code => ref($@), msg => $@ };
+            } else {
+                push @messages, { type => 'message', code => 'success_on_delete' };
+            }
+        } else {
+            push @messages, { type => 'error', code => 'unauthorized_on_delete' };
+        }
+    } else {
+        push @messages, { type => 'error', code => 'does_not_exist' };
+    }
+    $op = $referer;
+} elsif ( $op eq 'remove_share' ) {
+    $shelfnumber = $query->param('shelfnumber');
+    $shelf = Koha::Virtualshelves->find($shelfnumber);
+    if ($shelf) {
+        my $removed = eval { $shelf->remove_share( $loggedinuser ); };
+        if ($@) {
+            push @messages, { type => 'error', code => ref($@), msg => $@ };
+        } elsif ( $removed ) {
+            push @messages, { type => 'message', code => 'success_on_remove_share' };
+        } else {
+            push @messages, { type => 'error', code => 'error_on_remove_share' };
+        }
+    } else {
+        push @messages, { type => 'error', code => 'does_not_exist' };
+    }
+    $op = $referer;
+
+} elsif ( $op eq 'add_biblio' ) {
+    $shelfnumber = $query->param('shelfnumber');
+    $shelf = Koha::Virtualshelves->find($shelfnumber);
+    if ($shelf) {
+        if( my $barcode = $query->param('barcode') ) {
+            my $item = GetItem( 0, $barcode);
+            if (defined $item && $item->{itemnumber}) {
+                my $biblio = GetBiblioFromItemNumber( $item->{itemnumber} );
+                if ( $shelf->can_biblios_be_added( $loggedinuser ) ) {
+                    my $added = eval { $shelf->add_biblio( $biblio->{biblionumber}, $loggedinuser ); };
+                    if ($@) {
+                        push @messages, { type => 'error', code => ref($@), msg => $@ };
+                    } elsif ( $added ) {
+                        push @messages, { type => 'message', code => 'success_on_add_biblio' };
+                    } else {
+                        push @messages, { type => 'message', code => 'error_on_add_biblio' };
+                    }
+                } else {
+                    push @messages, { type => 'error', code => 'unauthorized_on_add_biblio' };
+                }
+            } else {
+                push @messages, { type => 'error', code => 'item_does_not_exist' };
+            }
         }
+    } else {
+        push @messages, { type => 'error', code => 'does_not_exist' };
     }
+    $op = $referer;
+} elsif ( $op eq 'remove_biblios' ) {
+    $shelfnumber = $query->param('shelfnumber');
+    $shelf = Koha::Virtualshelves->find($shelfnumber);
+    my @biblionumber = $query->multi_param('biblionumber');
+    if ($shelf) {
+        if ( $shelf->can_biblios_be_removed( $loggedinuser ) ) {
+            my $number_of_biblios_removed = eval {
+                $shelf->remove_biblios(
+                    {
+                        biblionumbers => \@biblionumber,
+                        borrowernumber => $loggedinuser,
+                    }
+                );
+            };
+            if ($@) {
+                push @messages, { type => 'error', code => ref($@), msg => $@ };
+            } elsif ( $number_of_biblios_removed ) {
+                push @messages, { type => 'message', code => 'success_on_remove_biblios' };
+            } else {
+                push @messages, { type => 'error', code => 'no_biblio_removed' };
+            }
+        } else {
+            push @messages, { type => 'error', code => 'unauthorized_on_remove_biblios' };
+        }
+    } else {
+        push @messages, { type => 'error', code => 'does_not_exist' };
+    }
+    $op = 'view';
 }
 
-my $showadd = 1;
-# set the default tab, etc.
-my $shelf_type = $query->param('display');
-if (defined $shelf_type) {
-       if ($shelf_type eq 'privateshelves')  {
-               $template->param(showprivateshelves => 1);
-       } elsif ($shelf_type eq 'publicshelves') {
-               $template->param(showpublicshelves => 1);
-               $showadd = 0;
-       } else {
-               $debug and warn "Invalid 'display' param ($shelf_type)";
-       }
-} else {
-    $template->param(showprivateshelves => 1);
-}
+if ( $op eq 'view' ) {
+    $shelfnumber ||= $query->param('shelfnumber');
+    $shelf = Koha::Virtualshelves->find($shelfnumber);
+    if ( $shelf ) {
+        if ( $shelf->can_be_viewed( $loggedinuser ) ) {
+            $category = $shelf->category;
+            my $sortfield = $query->param('sortfield') || $shelf->sortfield;    # Passed in sorting overrides default sorting
+            $sortfield = 'title' unless grep {/^$sortfield$/}qw( title author copyrightdate itemcallnumber );
+            my $direction = $query->param('direction') || 'asc';
+            $direction = 'asc' if $direction ne 'asc' and $direction ne 'desc';
+            my ( $page, $rows );
+            unless ( $query->param('print') or $query->param('rss') ) {
+                $rows = C4::Context->preference('OPACnumSearchResults') || 20;
+                $page = ( $query->param('page') ? $query->param('page') : 1 );
+            }
+            my $order_by = $sortfield eq 'itemcallnumber' ? 'items.itemcallnumber' : $sortfield;
+            my $contents = $shelf->get_contents->search(
+                {},
+                {
+                    prefetch => [ { 'biblionumber' => { 'biblioitems' => 'items' } } ],
+                    page     => $page,
+                    rows     => $rows,
+                    order_by => { "-$direction" => $order_by },
+                }
+            );
+
+            # get biblionumbers stored in the cart
+            my @cart_list;
+            if(my $cart_list = $query->cookie('bib_list')){
+                @cart_list = split(/\//, $cart_list);
+            }
+
+            my $borrower = GetMember( borrowernumber => $loggedinuser );
+
+            # Lists display falls back to search results configuration
+            my $xslfile = C4::Context->preference('OPACXSLTListsDisplay');
+            my $lang   = $xslfile ? C4::Languages::getlanguage()  : undef;
+            my $sysxml = $xslfile ? C4::XSLT::get_xslt_sysprefs() : undef;
+
+            my $record_processor = Koha::RecordProcessor->new({ filters => 'ViewPolicy' });
+            my @items;
+            while ( my $content = $contents->next ) {
+                my $biblionumber = $content->biblionumber;
+                my $this_item    = GetBiblioData($biblionumber);
+                my $record = GetMarcBiblio($biblionumber);
+                my $framework = GetFrameworkCode( $biblionumber );
+                $record_processor->options({
+                    interface => 'opac',
+                    frameworkcode => $framework
+                });
+                $record_processor->process($record);
+
+                if ( $xslfile ) {
+                    $this_item->{XSLTBloc} = XSLTParse4Display( $biblionumber, $record, "OPACXSLTListsDisplay",
+                                                                1, undef, $sysxml, $xslfile, $lang);
+                }
+
+                my $marcflavour = C4::Context->preference("marcflavour");
+                my $itemtype = Koha::Biblioitems->search({ biblionumber => $content->biblionumber })->next->itemtype;
+                $itemtype = Koha::ItemTypes->find( $itemtype );
+                $this_item->{imageurl}          = C4::Koha::getitemtypeimagelocation( 'opac', $itemtype->imageurl );
+                $this_item->{description}       = $itemtype->description; #FIXME Should not it be translated_description?
+                $this_item->{notforloan}        = $itemtype->notforloan;
+                $this_item->{'coins'}           = GetCOinSBiblio($record);
+                $this_item->{'subtitle'}        = GetRecordValue( 'subtitle', $record, GetFrameworkCode( $biblionumber ) );
+                $this_item->{'normalized_upc'}  = GetNormalizedUPC( $record, $marcflavour );
+                $this_item->{'normalized_ean'}  = GetNormalizedEAN( $record, $marcflavour );
+                $this_item->{'normalized_oclc'} = GetNormalizedOCLCNumber( $record, $marcflavour );
+                $this_item->{'normalized_isbn'} = GetNormalizedISBN( undef, $record, $marcflavour );
+
+                unless ( defined $this_item->{size} ) {
+
+                    #TT has problems with size
+                    $this_item->{size} = q||;
+                }
+
+                # Getting items infos for location display
+                my @items_infos = &GetItemsLocationInfo( $biblionumber );
+                $this_item->{'ITEM_RESULTS'} = \@items_infos;
+
+                if (C4::Context->preference('TagsEnabled') and C4::Context->preference('TagsShowOnList')) {
+                    $this_item->{TagLoop} = get_tags({
+                        biblionumber => $biblionumber, approved=>1, 'sort'=>'-weight',
+                        limit => C4::Context->preference('TagsShowOnList'),
+                    });
+                }
+
+                $this_item->{allow_onshelf_holds} = C4::Reserves::OnShelfHoldsAllowed($this_item, $borrower);
+
+
+                if ( grep {$_ eq $biblionumber} @cart_list) {
+                    $this_item->{incart} = 1;
+                }
+
+                $this_item->{biblionumber} = $biblionumber;
+                push @items, $this_item;
+            }
 
-# getting the Shelves list
-my $shelflist = GetShelves( $loggedinuser, 2 );
-$template->param( { loggedinuser => $loggedinuser } );
-my $op = $query->param('op');
-
-SWITCH: {
-       if ( $op ) {
-               if ( $op eq 'modifsave' ) {
-                       ModShelf(
-                               $query->param('shelfnumber'), $query->param('shelfname'),
-                               $loggedinuser,                $query->param('category'), $query->param('sortfield')
-                       );
-                       $shelflist = GetShelves( $loggedinuser, 2 );    # refresh after mods
-               } elsif ( $op eq 'modif' ) {
-                       my ( $shelfnumber, $shelfname, $owner, $category, $sortfield ) =GetShelf( $query->param('shelf') );
-                       $template->param(
-                               edit                => 1,
-                               shelfnumber         => $shelfnumber,
-                               shelfname           => $shelfname,
-                               "category$category" => 1,
-                               "sort_$sortfield"   => 1,
-                       );
-               }
-               last SWITCH;
-       }
-       if ( $query->param('viewshelf') ) {
-        #check that the user can view the shelf
-        my $shelfnumber = $query->param('viewshelf');
-        if ( ShelfPossibleAction( $loggedinuser, $shelfnumber, 'view' ) ) {
-            my $items = GetShelfContents($shelfnumber);
-                       $showadd = 1;
-                       my $i = 0;
-                       foreach (grep {$i++ % 2} @$items) {             # every other item
-                               $_->{toggle} = 1;
-                       }
             $template->param(
-                shelfname   => $shelflist->{$shelfnumber}->{'shelfname'},
-                shelfnumber => $shelfnumber,
-                viewshelf   => $query->param('viewshelf'),
-                manageshelf => &ShelfPossibleAction( $loggedinuser, $shelfnumber, 'manage' ),
-                itemsloop   => $items,
-            );
-        } # else {;}  # FIXME - some kind of warning *may* be in order
-        last SWITCH;
-    }
-    if ( $query->param('shelves') ) {
-        if ( my $newshelf = $query->param('addshelf') ) {
-            my $shelfnumber = AddShelf(
-                $newshelf,
-                $query->param('owner'),
-                $query->param('category')
+                can_manage_shelf   => $shelf->can_be_managed($loggedinuser),
+                can_delete_shelf   => $shelf->can_be_deleted($loggedinuser),
+                can_remove_biblios => $shelf->can_biblios_be_removed($loggedinuser),
+                can_add_biblios    => $shelf->can_biblios_be_added($loggedinuser),
+                itemsloop          => \@items,
+                sortfield          => $sortfield,
+                direction          => $direction,
             );
-
-            if ( $shelfnumber == -1 ) {    #shelf already exists.
-                               $showadd = 1;
+            if ( $page ) {
+                my $pager = $contents->pager;
                 $template->param(
-                        shelfnumber => $shelfnumber,
-                        already     => $newshelf,
+                    pagination_bar => pagination_bar(
+                        q||, $pager->last_page - $pager->first_page + 1,
+                        $page, "page", { op => 'view', shelfnumber => $shelf->shelfnumber, sortfield => $sortfield, direction => $direction, }
+                    ),
                 );
-            } else {
-               print $query->redirect("/cgi-bin/koha/opac-shelves.pl?viewshelf=$shelfnumber");
-                               exit;           # can't redirect AND expect %line to DO anything!
-                       }
-        }
-        my @paramsloop;
-        foreach ( $query->param() ) {
-                       /^DEL-(\d+)/ or next;
-                       my %line;
-                       ( $line{status}, $line{count} ) = DelShelf($1);
-                       (defined $shelflist->{$1}) and delete $shelflist->{$1};
-                       # print $query->redirect("/cgi-bin/koha/opac-shelves.pl"); exit;
-                       # can't redirect and expect %line to DO anything!
-                       push( @paramsloop, \%line );
+            }
+        } else {
+            push @messages, { type => 'error', code => 'unauthorized_on_view' };
+            undef $shelf;
         }
-               $showadd = 1;
-        $template->param( 
-                       paramsloop => \@paramsloop,
-            shelves    => 1,
-        );
-        last SWITCH;
+    } else {
+        push @messages, { type => 'error', code => 'does_not_exist' };
     }
 }
 
-# rebuilding shelflist (in case a shelf has been added) is not necessary since add redirects!
-
-$showadd and $template->param(showadd => 1);
-my $color = 0;
-my @shelvesloop;
-my @shelveslooppriv;
-
-foreach my $element (sort { lc($shelflist->{$a}->{'shelfname'}) cmp lc($shelflist->{$b}->{'shelfname'}) } keys %$shelflist) {
-       my %line;
-       $color = ($color) ? 0 : 1;
-       $color and $line{'toggle'} = $color;
-       $line{'shelf'} = $element;
-       $line{'shelfname'} = $shelflist->{$element}->{'shelfname'};
-       $line{'sortfield'} = $shelflist->{$element}->{'sortfield'};
-       $line{"category".$shelflist->{$element}->{'category'}} = 1;
-       $line{'shelfvirtualcount'} = $shelflist->{$element}->{'count'};
-       $line{'canmanage'} = ShelfPossibleAction($loggedinuser,$element,'manage');
-       if ($shelflist->{$element}->{'owner'} eq $loggedinuser) {
-               $line{'mine'} = 1;
-       } else {
-               $line{'firstname'} = $shelflist->{$element}->{'firstname'};
-               $line{ 'surname' } = $shelflist->{$element}->{ 'surname' };
-       }
-       if ($shelflist->{$element}->{'category'} eq 2) {
-               push (@shelvesloop,     \%line);
-       } elsif ($shelflist->{$element}->{'category'} eq 1) {
-        push (@shelveslooppriv, \%line);
+if ( $op eq 'list' ) {
+    my $shelves;
+    my ( $page, $rows ) = ( $query->param('page') || 1, 20 );
+    if ( $category == 1 ) {
+        $shelves = Koha::Virtualshelves->get_private_shelves({ page => $page, rows => $rows, borrowernumber => $loggedinuser, });
+    } else {
+        $shelves = Koha::Virtualshelves->get_public_shelves({ page => $page, rows => $rows, });
     }
+
+    my $pager = $shelves->pager;
+    $template->param(
+        shelves => $shelves,
+        pagination_bar => pagination_bar(
+            q||, $pager->last_page - $pager->first_page + 1,
+            $page, "page", { op => 'list', category => $category, }
+        ),
+    );
 }
 
 $template->param(
-    shelveslooppriv => \@shelveslooppriv,
-    shelvesloop     => \@shelvesloop,
-    "BiblioDefaultView".C4::Context->preference("BiblioDefaultView") => 1,
+    op       => $op,
+    referer  => $referer,
+    shelf    => $shelf,
+    messages => \@messages,
+    category => $category,
+    print    => scalar $query->param('print') || 0,
+    listsview => 1,
 );
 
 output_html_with_http_headers $query, $cookie, $template->output;