Bug 17843: Replace C4::Koha::getitemtypeinfo with Koha::ItemTypes
[koha.git] / opac / opac-shelves.pl
index f1b7f96..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.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-
-use strict;
-use warnings;
-use CGI;
-use C4::VirtualShelves::Page;
+# 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;
+
+use CGI qw ( -utf8 );
 use C4::Auth;
+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 Koha::Biblioitems;
+use Koha::ItemTypes;
+use Koha::Virtualshelves;
+use Koha::RecordProcessor;
+
+use constant ANYONE => 2;
 
-my $query = CGI->new();
+my $query = new CGI;
+
+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   => "opac-shelves.tmpl",
+        template_name   => $template_name,
         query           => $query,
         type            => "opac",
         authnotrequired => ( C4::Context->preference("OpacPublic") ? 1 : 0 ),
     });
-$template->param(listsview => 1);
-# if $loggedinuser is not defined, set it to -1, which should
-# not correspond to any real borrowernumber.  
-# FIXME: this is a hack to temporarily avoid changing several
-#        routines in C4::VirtualShelves and C4::VirtualShelves::page
-#        to deal with lists accessed during an anonymous OPAC session
-shelfpage('opac', $query, $template, (defined($loggedinuser) ? $loggedinuser : -1), $cookie);
+
+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' };
+    }
+} 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';
+}
+
+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;
+            }
+
+            $template->param(
+                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 ( $page ) {
+                my $pager = $contents->pager;
+                $template->param(
+                    pagination_bar => pagination_bar(
+                        q||, $pager->last_page - $pager->first_page + 1,
+                        $page, "page", { op => 'view', shelfnumber => $shelf->shelfnumber, sortfield => $sortfield, direction => $direction, }
+                    ),
+                );
+            }
+        } else {
+            push @messages, { type => 'error', code => 'unauthorized_on_view' };
+            undef $shelf;
+        }
+    } else {
+        push @messages, { type => 'error', code => 'does_not_exist' };
+    }
+}
+
+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(
+    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;