#!/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
-
-=head1 NAME
-
- 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.
-
-=item C<shelfnumber>
-
- to know on which shelve this script has to work.
-
-=item C<addbarcode>
-
-=item C<op>
-
- op can be equals to:
- * modifsave to save change on the shelves
- * modif to change the template to allow to modify the shelves.
-
-=item C<viewshelf>
-
- to load the template with 'viewshelves param' which allow to read the shelves information.
-
-=item C<shelves>
-
- if equals to 1. then call the function shelves which 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
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
-=cut
-
-use strict;
-use CGI;
-use C4::VirtualShelves;
+use Modern::Perl;
+use CGI qw ( -utf8 );
+use C4::Auth;
use C4::Biblio;
+use C4::Koha;
use C4::Items;
-use C4::Auth;
+use C4::Members;
use C4::Output;
+use C4::XSLT;
+
+use Koha::Biblios;
+use Koha::Biblioitems;
+use Koha::ItemTypes;
+use Koha::CsvProfiles;
+use Koha::Patrons;
+use Koha::Virtualshelves;
+
+use constant ANYONE => 2;
my $query = new CGI;
my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
- {
- template_name => "virtualshelves/shelves.tmpl",
+ { template_name => "virtualshelves/shelves.tt",
query => $query,
type => "intranet",
authnotrequired => 0,
}
);
-if ( $query->param('modifyshelfcontents') ) {
- my $shelfnumber = $query->param('viewshelf');
- my $barcode = $query->param('addbarcode');
- my ($item) = GetItem( 0, $barcode );
- my ($biblio) = GetBiblioFromItemNumber($item->{'itemnumber'});
- if ( ShelfPossibleAction( $loggedinuser, $shelfnumber, 'manage' ) ) {
- AddToShelf( $biblio->{'biblionumber'}, $shelfnumber );
- foreach ( $query->param ) {
- if (/REM-(\d*)/) {
- my $biblionumber = $1;
- DelFromShelf( $biblionumber, $shelfnumber );
- }
+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 )->unblessed;
+ $template->param( owner => $patron, );
+ unless ( $shelf->can_be_managed( $loggedinuser ) ) {
+ push @messages, { type => 'alert', code => 'unauthorized_on_update' };
+ $op = 'list';
}
+ } else {
+ push @messages, { type => 'alert', code => 'does_not_exist' };
}
-}
-
-# 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'), $query->param('sortfield')
+} elsif ( $op eq 'add' ) {
+ 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'),
+ allow_change_from_owner => $allow_changes_from > 0,
+ allow_change_from_others => $allow_changes_from == ANYONE,
+ owner => scalar $query->param('owner'),
+ }
);
- last SWITCH;
+ $shelf->store;
+ $shelfnumber = $shelf->shelfnumber;
+ };
+ if ($@) {
+ push @messages, { type => 'alert', code => ref($@), msg => $@ };
+ } elsif ( not $shelf ) {
+ push @messages, { type => 'alert', code => 'error_on_insert' };
+
+ } else {
+ push @messages, { type => 'message', code => 'success_on_insert' };
+ $op = 'view';
}
- if ( $op && ( $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;
+} 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 dateadded );
+ 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 => 'alert', code => 'error_on_update' };
+ $op = 'edit_form';
+ } else {
+ push @messages, { type => 'message', code => 'success_on_update' };
+ }
+ } else {
+ push @messages, { type => 'alert', code => 'unauthorized_on_update' };
+ }
+ } else {
+ push @messages, { type => 'alert', code => 'does_not_exist' };
}
- 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,
- );
+} 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 => 'alert', code => ref($@), msg => $@ };
+ } else {
+ push @messages, { type => 'message', code => 'success_on_delete' };
+ }
+ } else {
+ push @messages, { type => 'alert', code => 'unauthorized_on_delete' };
}
- last SWITCH;
+ } else {
+ push @messages, { type => 'alert', code => 'does_not_exist' };
}
- if ( $query->param('shelves') ) {
- if ( my $newshelf = $query->param('addshelf') ) {
- my $shelfnumber = AddShelf(
- $newshelf,
- $query->param('owner'),
- $query->param('category')
- );
-
- if ( $shelfnumber == -1 ) { #shelf already exists.
- $template->param(
- {
- shelfnumber => $shelfnumber,
- already => 1
+ $op = 'list';
+} elsif ( $op eq 'add_biblio' ) {
+ $shelfnumber = $query->param('shelfnumber');
+ $shelf = Koha::Virtualshelves->find($shelfnumber);
+ if ($shelf) {
+ if( my $barcodes = $query->param('barcodes') ) {
+ if ( $shelf->can_biblios_be_added( $loggedinuser ) ) {
+ my @barcodes = split /\n/, $barcodes; # Entries are effectively passed in as a <cr> separated list
+ foreach my $barcode (@barcodes){
+ $barcode =~ s/\r$//; # strip any naughty return chars
+ next if $barcode eq '';
+ my $item = GetItem( 0, $barcode);
+ if (defined $item && $item->{itemnumber}) {
+ my $added = eval { $shelf->add_biblio( $item->{biblionumber}, $loggedinuser ); };
+ if ($@) {
+ push @messages, { item_barcode => $barcode, type => 'alert', code => ref($@), msg => $@ };
+ } elsif ( $added ) {
+ push @messages, { item_barcode => $barcode, type => 'message', code => 'success_on_add_biblio' };
+ } else {
+ push @messages, { item_barcode => $barcode, type => 'message', code => 'error_on_add_biblio' };
+ }
+ } else {
+ push @messages, { item_barcode => $barcode, type => 'alert', code => 'item_does_not_exist' };
}
- );
+ }
+ } else {
+ push @messages, { type => 'alert', code => 'unauthorized_on_add_biblio' };
}
- print $query->redirect("/cgi-bin/koha/virtualshelves/shelves.pl?viewshelf=$shelfnumber");
- exit;
}
- 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;
+ if ( my $biblionumbers = $query->param('biblionumbers') ) {
+ if ( $shelf->can_biblios_be_added( $loggedinuser ) ) {
+ my @biblionumbers = split /\n/, $biblionumbers;
+ foreach my $biblionumber (@biblionumbers) {
+ $biblionumber =~ s/\r$//; # strip any naughty return chars
+ next if $biblionumber eq '';
+ my $biblio = Koha::Biblios->find($biblionumber);
+ if (defined $biblio) {
+ my $added = eval { $shelf->add_biblio( $biblionumber, $loggedinuser ); };
+ if ($@) {
+ push @messages, { bibnum => $biblionumber, type => 'alert', code => ref($@), msg => $@ };
+ } elsif ( $added ) {
+ push @messages, { bibnum => $biblionumber, type => 'message', code => 'success_on_add_biblio' };
+ } else {
+ push @messages, { bibnum => $biblionumber, type => 'message', code => 'error_on_add_biblio' };
+ }
+ } else {
+ push @messages, { bibnum => $biblionumber, type => 'alert', code => 'item_does_not_exist' };
+ }
}
- print $query->redirect("/cgi-bin/koha/virtualshelves/shelves.pl");
- exit;
+ } else {
+ push @messages, { type => 'alert', code => 'unauthorized_on_add_biblio' };
}
-
- #if the shelf is not deleted, %line points on null
- # push( @paramsloop, \%line );
}
- $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 );
+ } else {
+ push @messages, { type => 'alert', code => 'does_not_exist' };
+ }
+ $op = $referer;
+} elsif ( $op eq 'remove_biblios' ) {
+ $shelfnumber = $query->param('shelfnumber');
+ $shelf = Koha::Virtualshelves->find($shelfnumber);
+ my @biblionumbers = $query->multi_param('biblionumber');
+ if ($shelf) {
+ if ( $shelf->can_biblios_be_removed( $loggedinuser ) ) {
+ my $number_of_biblios_removed = eval {
+ $shelf->remove_biblios(
+ {
+ biblionumbers => \@biblionumbers,
+ borrowernumber => $loggedinuser,
+ }
+ );
+ };
+ if ($@) {
+ push @messages, { type => 'alert', code => ref($@), msg => $@ };
+ } elsif ( $number_of_biblios_removed ) {
+ push @messages, { type => 'message', code => 'success_on_remove_biblios' };
+ } else {
+ push @messages, { type => 'alert', code => 'no_biblio_removed' };
+ }
+ } else {
+ push @messages, { type => 'alert', code => 'unauthorized_on_remove_biblios' };
}
- $template->param(
- shelvesloop => \@shelvesloop,
- shelves => 1,
- );
- last SWITCH;
+ } else {
+ push @messages, { type => 'alert', code => 'does_not_exist' };
}
+ $op = $referer;
}
-# rebuild shelflist in case a shelf has been added
-$shelflist = GetShelves( $loggedinuser, 2 );
-my $color = '';
-my @shelvesloop;
-my $numberCanManage = 0;
+if ( $op eq 'view' ) {
+ $shelfnumber ||= $query->param('shelfnumber');
+ $shelf = Koha::Virtualshelves->find($shelfnumber);
+ if ( $shelf ) {
+ if ( $shelf->can_be_viewed( $loggedinuser ) ) {
+ my $sortfield = $query->param('sortfield') || $shelf->sortfield || 'title'; # Passed in sorting overrides default sorting
+ $sortfield = 'title' unless grep {/^$sortfield$/}qw( title author copyrightdate itemcallnumber dateadded );
+ my $direction = $query->param('direction') || 'asc';
+ $direction = 'asc' if $direction ne 'asc' and $direction ne 'desc';
+ my ( $rows, $page );
+ unless ( $query->param('print') ) {
+ $rows = C4::Context->preference('numSearchResults') || 20;
+ $page = ( $query->param('page') ? $query->param('page') : 1 );
+ }
-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{'sortfield'}=$shelflist->{$element}->{'sortfield'};
- $line{"viewcategory$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;
- $numberCanManage++ if $line{'canmanage'};
- push( @shelvesloop, \%line );
-}
+ my $order_by = $sortfield eq 'itemcallnumber' ? 'items.cn_sort' : $sortfield;
+ my $contents = $shelf->get_contents->search(
+ {},
+ {
+ prefetch => [ { 'biblionumber' => { 'biblioitems' => 'items' } } ],
+ page => $page,
+ rows => $rows,
+ order_by => { "-$direction" => $order_by },
+ }
+ );
-$template->param(
- shelvesloop => \@shelvesloop,
- numberCanManage => $numberCanManage,
-);
+ my $xslfile = C4::Context->preference('XSLTListsDisplay');
+ my $lang = $xslfile ? C4::Languages::getlanguage() : undef;
+ my $sysxml = $xslfile ? C4::XSLT::get_xslt_sysprefs() : undef;
-output_html_with_http_headers $query, $cookie, $template->output;
+ my @items;
+ while ( my $content = $contents->next ) {
+ my $this_item;
+ my $biblionumber = $content->biblionumber;
+ my $record = GetMarcBiblio({ biblionumber => $biblionumber });
-sub shelves {
- my $innertemplate = shift;
- if ( my $newshelf = $query->param('addshelf') ) {
- my $shelfnumber = AddShelf(
- $newshelf,
- $query->param('owner'),
- $query->param('category')
- );
+ if ( $xslfile ) {
+ $this_item->{XSLTBloc} = XSLTParse4Display( $biblionumber, $record, "XSLTListsDisplay",
+ 1, undef, $sysxml, $xslfile, $lang);
+ }
- if ( $shelfnumber == -1 ) { #shelf already exists.
- $template->param(
+ my $marcflavour = C4::Context->preference("marcflavour");
+ my $itemtype = Koha::Biblioitems->search({ biblionumber => $content->biblionumber })->next->itemtype;
+ $itemtype = Koha::ItemTypes->find( $itemtype );
+ my $biblio = Koha::Biblios->find( $content->biblionumber );
+ $this_item->{title} = $biblio->title;
+ $this_item->{author} = $biblio->author;
+ $this_item->{dateadded} = $content->dateadded;
+ $this_item->{imageurl} = $itemtype ? C4::Koha::getitemtypeimagelocation( 'intranet', $itemtype->imageurl ) : q{};
+ $this_item->{description} = $itemtype ? $itemtype->description : q{}; #FIXME Should this be translated_description ?
+ $this_item->{notforloan} = $itemtype->notforloan if $itemtype;
+ $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;
+ $this_item->{biblionumber} = $biblionumber;
+ push @items, $this_item;
+ }
+
+ my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
{
- shelfnumber => $shelfnumber,
- already => 1
+ borrowernumber => $loggedinuser,
+ add_allowed => 1,
+ category => 1,
}
);
- }
- }
- 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;
+ my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
+ {
+ borrowernumber => $loggedinuser,
+ add_allowed => 1,
+ category => 2,
+ }
+ );
+
+ $template->param(
+ add_to_some_private_shelves => $some_private_shelves,
+ add_to_some_public_shelves => $some_public_shelves,
+ can_manage_shelf => $shelf->can_be_managed($loggedinuser),
+ can_remove_shelf => $shelf->can_be_deleted($loggedinuser),
+ can_remove_biblios => $shelf->can_biblios_be_removed($loggedinuser),
+ can_add_biblios => $shelf->can_biblios_be_added($loggedinuser),
+ sortfield => $sortfield,
+ 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;
}
-
- #if the shelf is not deleted, %line points on null
- push( @paramsloop, \%line );
- }
- $innertemplate->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 );
+ } else {
+ push @messages, { type => 'alert', code => 'does_not_exist' };
}
- $innertemplate->param(
- shelvesloop => \@shelvesloop,
- shelves => 1,
- );
}
+
+$template->param(
+ op => $op,
+ referer => $referer,
+ shelf => $shelf,
+ messages => \@messages,
+ category => $category,
+ print => scalar $query->param('print') || 0,
+ csv_profiles => [ Koha::CsvProfiles->search({ type => 'marc', used_for => 'export_records' }) ],
+);
+
+output_html_with_http_headers $query, $cookie, $template->output;