#!/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 shelve content.
+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;
-=item C<shelfnumber>
+use Koha::Biblios;
+use Koha::Biblioitems;
+use Koha::IssuingRules;
+use Koha::Items;
+use Koha::ItemTypes;
+use Koha::Patrons;
+use Koha::Virtualshelves;
+use Koha::RecordProcessor;
- to know on which shelve this script has to work.
+use constant ANYONE => 2;
-=item C<addbarcode>
+my $query = new CGI;
-=item C<op>
+my $template_name = $query->param('rss') ? "opac-shelves-rss.tt" : "opac-shelves.tt";
- op can be equals to:
- * modifsave to save change on the shelves
- * modif to change the template to allow to modify the shelves.
+# if virtualshelves is disabled, leave immediately
+if ( ! C4::Context->preference('virtualshelves') ) {
+ print $query->redirect("/cgi-bin/koha/errors/404.pl");
+ exit;
+}
-=item C<viewshelf>
+my ( $template, $loggedinuser, $cookie ) = get_template_and_user({
+ template_name => $template_name,
+ query => $query,
+ type => "opac",
+ 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 = Koha::Patrons->find( $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}) {
+ if ( $shelf->can_biblios_be_added( $loggedinuser ) ) {
+ my $added = eval { $shelf->add_biblio( $item->{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';
+}
- to load the template with 'viewshelves param' which allow to read the shelves information.
+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 },
+ }
+ );
-=item C<shelves>
+ # get biblionumbers stored in the cart
+ my @cart_list;
+ if(my $cart_list = $query->cookie('bib_list')){
+ @cart_list = split(/\//, $cart_list);
+ }
- if equals to 1. then call the function shelves which add
- or delete a shelf.
+ my $patron = Koha::Patrons->find( $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 => $biblionumber });
+ my $framework = GetFrameworkCode( $biblionumber );
+ my $biblio = Koha::Biblios->find( $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);
+ }
-=item C<addshelf>
+ my $marcflavour = C4::Context->preference("marcflavour");
+ my $itemtype = Koha::Biblioitems->search({ biblionumber => $content->biblionumber })->next->itemtype;
+ $itemtype = Koha::ItemTypes->find( $itemtype );
+ if( $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 );
- if the param shelves = 1 then addshelf must be equals to the name of the shelf to add.
+ unless ( defined $this_item->{size} ) {
-=back
+ #TT has problems with size
+ $this_item->{size} = q||;
+ }
-=cut
+ # Getting items infos for location display
+ my @items_infos = &GetItemsLocationInfo( $biblionumber );
+ $this_item->{'ITEM_RESULTS'} = \@items_infos;
-use strict;
-use CGI;
-use C4::Output;
-use C4::VirtualShelves;
-use C4::Circulation;
-use C4::Auth;
-use C4::Output;
-use C4::Biblio;
-
-my $query = new CGI;
+ 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'),
+ });
+ }
-my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
- {
- template_name => "opac-shelves.tmpl",
- query => $query,
- type => "opac",
- authnotrequired => 1,
- }
-);
+ my $items = $biblio->items;
+ while ( my $item = $items->next ) {
+ $this_item->{allow_onshelf_holds} = Koha::IssuingRules->get_onshelfholds_policy( { item => $item, patron => $patron } );
+ last if $this_item->{allow_onshelf_holds};
+ }
-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 ) {
- if (/MOD-(\d*)/) {
- my $biblionumber = $1;
- if ( $query->param('remove') eq "on" ) {
- DelFromShelf( $biblionumber, $shelfnumber );
+ 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 && ( $op eq 'modifsave' ) ) {
- ModShelf(
- $query->param('shelfnumber'), $query->param('shelfname'),
- $loggedinuser, $query->param('category')
- );
- last SWITCH;
- }
- if ( $op && ( $op eq 'modif' ) ) {
- my ( $shelfnumber, $shelfname, $owner, $category ) =
- GetShelf( $query->param('shelf') );
- $template->param(
- edit => 1,
- shelfnumber => $shelfnumber,
- shelfname => $shelfname,
- "category$category" => 1
- );
-
- # editshelf($query->param('shelf'));
- 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);
$template->param(
- shelfname => $shelflist->{$shelfnumber}->{'shelfname'},
- shelfnumber => $shelfnumber,
- viewshelf => $query->param('viewshelf'),
- manageshelf => &ShelfPossibleAction( $loggedinuser, $shelfnumber, 'manage' ),
- itemsloop => $items,
- );
- }
- 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.
+ if ( $page ) {
+ my $pager = $contents->pager;
$template->param(
- {
- shelfnumber => $shelfnumber,
- already => 1
- }
+ pagination_bar => pagination_bar(
+ q||, $pager->last_page - $pager->first_page + 1,
+ $page, "page", { op => 'view', shelfnumber => $shelf->shelfnumber, sortfield => $sortfield, direction => $direction, }
+ ),
);
}
- }
- my @paramsloop;
- foreach ( $query->param() ) {
- my %line;
- if (/DEL-(\d+)/) {
- my $delshelf = $1;
- my ( $status, $count ) = DelShelf($delshelf);
- if ($status) {
- $line{'status'} = $status;
- $line{'count'} = $count;
- }
+ } else {
+ push @messages, { type => 'error', code => 'unauthorized_on_view' };
+ undef $shelf;
}
-
- #if the shelf is not deleted, %line points on null
- push( @paramsloop, \%line );
+ } else {
+ push @messages, { type => 'error', code => 'does_not_exist' };
}
- $template->param( paramsloop => \@paramsloop );
- my ($shelflist) = GetShelves( $loggedinuser, 2 );
- my $color = '';
- my @shelvesloop;
- foreach my $element ( sort keys %$shelflist ) {
- my %line;
- ( $color eq 1 ) ? ( $color = 0 ) : ( $color = 1 );
- $line{'toggle'} = $color;
- $line{'shelf'} = $element;
- $line{'shelfname'} = $shelflist->{$element}->{'shelfname'};
- $line{'shelfvirtualcount'} = $shelflist->{$element}->{'count'};
- push( @shelvesloop, \%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(
- shelvesloop => \@shelvesloop,
- shelves => 1,
+ shelves => $shelves,
+ pagination_bar => pagination_bar(
+ q||, $pager->last_page - $pager->first_page + 1,
+ $page, "page", { op => 'list', category => $category, }
+ ),
);
- last SWITCH;
- }
}
-($shelflist) =
- GetShelves( $loggedinuser, 2 )
- ; # rebuild shelflist in case a shelf has been added
-
-my $color = '';
-my @shelvesloop;
-foreach my $element ( sort keys %$shelflist ) {
- my %line;
- ( $color eq 1 ) ? ( $color = 0 ) : ( $color = 1 );
- $line{'toggle'} = $color;
- $line{'shelf'} = $element;
- $line{'shelfname'} = $shelflist->{$element}->{'shelfname'};
- $line{ "category" . $shelflist->{$element}->{'category'} } = 1;
- $line{'mine'} = 1 if $shelflist->{$element}->{'owner'} eq $loggedinuser;
- $line{'shelfvirtualcount'} = $shelflist->{$element}->{'count'};
- $line{'canmanage'} =
- ShelfPossibleAction( $loggedinuser, $element, 'manage' );
- $line{'firstname'} = $shelflist->{$element}->{'firstname'}
- unless $shelflist->{$element}->{'owner'} eq $loggedinuser;
- $line{'surname'} = $shelflist->{$element}->{'surname'}
- unless $shelflist->{$element}->{'owner'} eq $loggedinuser;
- push( @shelvesloop, \%line );
- }
-
$template->param(
- 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;
-
-
-
-#
-# Revision 1.12 2007/04/24 13:54:29 hdl
-# functions that were in C4::Interface::CGI::Output are now in C4::Output.
-# So this implies quite a change for files.
-# Sorry about conflicts which will be caused.
-# directory Interface::CGI should now be dropped.
-# I noticed that many scripts (reports ones, but also some circ/stats.pl or opac-topissues) still use Date::Manip.
-#
-# Revision 1.11 2007/04/17 08:52:19 tipaul
-# circulation cleaning continued: bufixing
-#
-# Revision 1.10 2007/04/04 16:46:23 tipaul
-# HUGE COMMIT : code cleaning circulation.
-#
-# some stuff to do, i'll write a mail on koha-devel NOW !
-#
-# Revision 1.9 2007/03/09 15:12:54 tipaul
-# rel_3_0 moved to HEAD
-#
-# Revision 1.8.2.12 2007/01/15 17:19:30 toins
-# enable to add checked items to a shelf.
-# Some display enhancements.
-#
-# Revision 1.8.2.11 2007/01/10 10:52:58 toins
-# adding syspref directly to Auth.pm instead of to the template.
-#
-# Revision 1.8.2.10 2007/01/10 10:12:48 toins
-# Adding OpacTopissue, OpacCloud, OpacAuthorithies to the template->param.
-# + Some cleanup.
-#
-# Revision 1.8.2.9 2006/12/15 17:43:24 toins
-# sync with intranet.
-#
-# Revision 1.8.2.8 2006/12/14 17:59:17 toins
-# add the link to "BiblioDefaultView systempref" and not to opac-detail.pl
-#
-# Revision 1.8.2.7 2006/12/14 17:22:55 toins
-# virtualshelves work perfectly with mod_perl and are cleaned.
-#
-# Revision 1.8.2.6 2006/12/14 16:04:25 toins
-# sync with intranet.
-#
-# Revision 1.8.2.5 2006/12/11 17:10:06 toins
-# fixing some bugs on virtualshelves.
-#
-# Revision 1.8.2.4 2006/12/07 15:42:15 toins
-# synching opac & intranet.
-# fix some broken link & bugs.
-# removing warn compilation.
-#
-# Revision 1.8.2.3 2006/11/30 18:23:51 toins
-# theses scripts don't need to use C4::Search.
-#