1 package C4::VirtualShelves::Page;
4 # Copyright 2000-2002 Katipo Communications
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
21 # perldoc at the end of the file, per convention.
30 use C4::VirtualShelves qw/:DEFAULT ShelvesMax/;
35 use C4::Auth qw/get_session/;
38 use C4::Dates qw/format_date/;
39 use C4::Tags qw(get_tags);
43 use Koha::Virtualshelves;
45 use constant VIRTUALSHELVES_COUNT => 20;
47 use vars qw($debug @EXPORT @ISA $VERSION);
50 $VERSION = 3.07.00.049;
52 @EXPORT = qw(&shelfpage);
53 $debug = $ENV{DEBUG} || 0;
58 intranet => { redirect => '/cgi-bin/koha/virtualshelves/shelves.pl', },
59 opac => { redirect => '/cgi-bin/koha/opac-shelves.pl', },
63 my ( $type, $query, $template, $loggedinuser, $cookie ) = @_;
64 ( $pages{$type} ) or $type = 'opac';
65 $query or die "No query";
66 $template or die "No template";
68 loggedinuser => $loggedinuser,
69 OpacAllowPublicListCreation => C4::Context->preference('OpacAllowPublicListCreation'),
74 my $shelfoff = ( $query->param('shelfoff') ? $query->param('shelfoff') : 1 );
75 $template->{VARS}->{'shelfoff'} = $shelfoff;
76 my $itemoff = ( $query->param('itemoff') ? $query->param('itemoff') : 1 );
77 my $displaymode = ( $query->param('display') ? $query->param('display') : 'publicshelves' );
78 my ( $shelflimit, $shelfoffset, $shelveslimit, $shelvesoffset );
79 my $marcflavour = C4::Context->preference("marcflavour");
81 unless ( $query->param('print') ) {
82 $shelflimit = ( $type eq 'opac' ? C4::Context->preference('OPACnumSearchResults') : C4::Context->preference('numSearchResults') );
83 $shelflimit = $shelflimit || ShelvesMax('MGRPAGE');
84 $shelflimit = undef if $query->param('rss');
85 $shelfoffset = ( $itemoff - 1 ) * $shelflimit; # Sets the offset to begin retrieving items at
86 $shelveslimit = $shelflimit; # Limits number of shelves returned for a given query (row_count)
87 $shelvesoffset = ( $shelfoff - 1 ) * $shelflimit; # Sets the offset to begin retrieving shelves at (offset)
90 # getting the Shelves list
91 my $category = ( ( $displaymode eq 'privateshelves' ) ? 1 : 2 );
94 if ( $category == 2 ) {
95 $shelflist = Koha::Virtualshelves->get_public_shelves({ limit => $shelveslimit, offset => $shelvesoffset });
97 $shelflist = Koha::Virtualshelves->get_private_shelves({ limit => $shelveslimit, offset => $shelvesoffset, borrowernumber => $loggedinuser });
99 my $totshelves = C4::VirtualShelves::GetShelfCount( $loggedinuser, $category );
101 my $op = $query->param('op');
103 # the format of this is unindented for ease of diff comparison to the old script
104 # Note: do not mistake the assignment statements below for comparisons!
105 if ( $query->param('modifyshelfcontents') ) {
106 my ( $shelfnumber, $barcode, $item, $biblio );
107 if ( $shelfnumber = $query->param('viewshelf') ) {
109 if($barcode = $query->param('addbarcode') ) {
110 if(ShelfPossibleAction( $loggedinuser, $shelfnumber, 'add')) {
111 $item = GetItem( 0, $barcode);
112 if (defined $item && $item->{'itemnumber'}) {
113 $biblio = GetBiblioFromItemNumber( $item->{'itemnumber'} );
114 Koha::Virtualshelves->find( $shelfnumber )->add_biblio( $biblio->{biblionumber}, $loggedinuser )
115 or push @paramsloop, { duplicatebiblio => $barcode };
118 push @paramsloop, { failgetitem => $barcode };
122 push @paramsloop, { nopermission => $shelfnumber };
125 elsif(grep { /REM-(\d+)/ } $query->param) {
126 #remove item(s) from shelf
127 if(ShelfPossibleAction($loggedinuser, $shelfnumber, 'delete')) {
129 foreach($query->param) {
131 push @bib, $1; #$1 is biblionumber
133 my $shelf = Koha::Virtualshelves->find( $shelfnumber );
134 my $number_of_biblios_removed = $shelf->remove_biblios( { biblionumbers => \@bib, borrowernumber => $loggedinuser } );
135 if( $number_of_biblios_removed == 0) {
136 push @paramsloop, {nothingdeleted => $shelfnumber};
138 elsif( $number_of_biblios_removed < @bib ) {
139 push @paramsloop, {somedeleted => $shelfnumber};
143 push @paramsloop, { nopermission => $shelfnumber };
148 push @paramsloop, { noshelfnumber => 1 };
154 # set the default tab, etc. (for OPAC)
155 my $shelf_type = ( $query->param('display') ? $query->param('display') : 'publicshelves' );
156 if ( defined $shelf_type ) {
157 if ( $shelf_type eq 'privateshelves' ) {
158 $template->param( showprivateshelves => 1 );
159 } elsif ( $shelf_type eq 'publicshelves' ) {
160 $template->param( showpublicshelves => 1 );
163 $debug and warn "Invalid 'display' param ($shelf_type)";
165 } elsif ( $loggedinuser == -1 ) {
166 $template->param( showpublicshelves => 1 );
168 $template->param( showprivateshelves => 1 );
171 my ( $okmanage, $okview );
172 my $shelfnumber = $query->param('shelfnumber') || $query->param('viewshelf');
174 $okmanage = ShelfPossibleAction( $loggedinuser, $shelfnumber, 'manage' );
175 $okview = ShelfPossibleAction( $loggedinuser, $shelfnumber, 'view' );
182 #Saving modified shelf
183 if ( $op eq 'modifsave' ) {
185 push @paramsloop, { nopermission => $shelfnumber };
188 my $shelf = Koha::Virtualshelves->find( $shelfnumber );
189 $shelf->shelfname($query->param('shelfname'));
190 $shelf->sortfield($query->param('sortfield'));
191 $shelf->allow_add($query->param('allow_add'));
192 $shelf->allow_delete_own($query->param('allow_delete_own'));
193 $shelf->allow_delete_other($query->param('allow_delete_other'));
194 if( my $category = $query->param('category')) { #optional
195 $shelf->category($category);
197 eval { $shelf->store };
199 push @paramsloop, {modifyfailure => $shelf->{shelfname}};
203 if($displaymode eq "viewshelf"){
204 print $query->redirect( $pages{$type}->{redirect} . "?viewshelf=$shelfnumber" );
205 } elsif($displaymode eq "publicshelves"){
206 print $query->redirect( $pages{$type}->{redirect} );
208 print $query->redirect( $pages{$type}->{redirect} . "?display=privateshelves" );
213 elsif ( $op eq 'modif' ) {
214 my $shelf = Koha::Virtualshelves->find( $shelfnumber );
215 my $member = GetMember( 'borrowernumber' => $shelf->owner );
216 my $ownername = defined($member) ? $member->{firstname} . " " . $member->{surname} : '';
219 display => $displaymode,
220 shelfnumber => $shelf->shelfnumber,
221 shelfname => $shelf->shelfname,
222 owner => $shelf->owner,
223 ownername => $ownername,
224 "category".$shelf->category => 1,
225 category => $shelf->category,
226 sortfield => $shelf->sortfield,
227 allow_add => $shelf->allow_add,
228 allow_delete_own => $shelf->allow_delete_own,
229 allow_delete_other => $shelf->allow_delete_other,
236 if ( $shelfnumber = $query->param('viewshelf') ) {
237 my $shelf = Koha::Virtualshelves->find( $shelfnumber );
238 if (C4::Context->preference('TagsEnabled')) {
239 $template->param(TagsEnabled => 1);
240 foreach (qw(TagsShowOnList TagsInputOnList)) {
241 C4::Context->preference($_) and $template->param($_ => 1);
244 #check that the user can view the shelf
245 if ( ShelfPossibleAction( $loggedinuser, $shelfnumber, 'view' ) ) {
248 my $sortfield = ( $shelf->sortfield ? $shelf->sortfield : 'title' );
249 $sortfield = $query->param('sort') || $sortfield; ## Passed in sorting overrides default sorting
250 my $direction = $query->param('direction') || 'asc';
253 direction => $direction,
255 ( $items, $totitems ) = GetShelfContents( $shelfnumber, $shelflimit, $shelfoffset, $sortfield, $direction );
257 # get biblionumbers stored in the cart
258 # Note that it's not use at the intranet
260 my $cart_cookie = ( $type eq 'opac' ? "bib_list" : "intranet_bib_list" );
261 if($query->cookie($cart_cookie)){
262 my $cart_list = $query->cookie($cart_cookie);
263 @cart_list = split(/\//, $cart_list);
266 my $borrower = GetMember( 'borrowernumber' => $loggedinuser );
268 for my $this_item (@$items) {
269 my $biblionumber = $this_item->{'biblionumber'};
270 my $record = GetMarcBiblio($biblionumber);
271 if (C4::Context->preference("OPACXSLTResultsDisplay") && $type eq 'opac') {
272 $this_item->{XSLTBloc} = XSLTParse4Display($biblionumber, $record, "OPACXSLTResultsDisplay");
273 } elsif (C4::Context->preference("XSLTResultsDisplay") && $type eq 'intranet') {
274 $this_item->{XSLTBloc} = XSLTParse4Display($biblionumber, $record, "XSLTResultsDisplay");
277 # the virtualshelfcontents table does not store these columns nor are they retrieved from the items
278 # and itemtypes tables, so I'm commenting them out for now to quiet the log -crn
279 #$this_item->{imageurl} = $imgdir."/".$itemtypes->{ $this_item->{itemtype} }->{'imageurl'};
280 #$this_item->{'description'} = $itemtypes->{ $this_item->{itemtype} }->{'description'};
281 $this_item->{'dateadded'} = format_date( $this_item->{'dateadded'} );
282 $this_item->{'imageurl'} = getitemtypeinfo( $this_item->{'itemtype'}, $type )->{'imageurl'};
283 $this_item->{'coins'} = GetCOinSBiblio( $record );
284 $this_item->{'subtitle'} = GetRecordValue('subtitle', $record, GetFrameworkCode($this_item->{'biblionumber'}));
285 $this_item->{'normalized_upc'} = GetNormalizedUPC( $record,$marcflavour);
286 $this_item->{'normalized_ean'} = GetNormalizedEAN( $record,$marcflavour);
287 $this_item->{'normalized_oclc'} = GetNormalizedOCLCNumber($record,$marcflavour);
288 $this_item->{'normalized_isbn'} = GetNormalizedISBN(undef,$record,$marcflavour);
289 if(!defined($this_item->{'size'})) { $this_item->{'size'} = "" }; #TT has problems with size
290 # Getting items infos for location display
291 my @items_infos = &GetItemsLocationInfo( $this_item->{'biblionumber'});
292 $this_item->{'itemsissued'} = CountItemsIssued( $this_item->{'biblionumber'} );
293 $this_item->{'ITEM_RESULTS'} = \@items_infos;
294 if ( grep {$_ eq $biblionumber} @cart_list) {
295 $this_item->{'incart'} = 1;
298 if (C4::Context->preference('TagsEnabled') and $tag_quantity = C4::Context->preference('TagsShowOnList')) {
299 $this_item->{'TagLoop'} = get_tags({
300 biblionumber=>$this_item->{'biblionumber'}, approved=>1, 'sort'=>'-weight',
305 $this_item->{'allow_onshelf_holds'} = C4::Reserves::OnShelfHoldsAllowed($this_item, $borrower);
307 if($type eq 'intranet'){
308 # Build drop-down list for 'Add To:' menu...
309 my ($totalref, $pubshelves, $barshelves)=
310 C4::VirtualShelves::GetSomeShelfNames($loggedinuser,'COMBO',1);
312 addbarshelves => $totalref->{bartotal},
313 addbarshelvesloop => $barshelves,
314 addpubshelves => $totalref->{pubtotal},
315 addpubshelvesloop => $pubshelves,
318 push @paramsloop, { display => 'privateshelves' } if $shelf->category == 1;
321 my $manageshelf = ShelfPossibleAction( $loggedinuser, $shelfnumber, 'manage' );
322 my $can_delete_shelf = ShelfPossibleAction( $loggedinuser, $shelfnumber, 'delete_shelf' );
324 shelfname => $shelf->shelfname,
325 shelfnumber => $shelfnumber,
326 viewshelf => $shelfnumber,
327 sortfield => $sortfield,
328 manageshelf => $manageshelf,
329 allowremovingitems => ShelfPossibleAction( $loggedinuser, $shelfnumber, 'delete'),
330 allowaddingitem => ShelfPossibleAction( $loggedinuser, $shelfnumber, 'add'),
331 allowdeletingshelf => $can_delete_shelf,
332 "category".$shelf->category => 1,
333 category => $shelf->category,
335 showprivateshelves => $shelf->category==1,
338 push @paramsloop, { nopermission => $shelfnumber };
343 if ( $query->param('shelves') ) {
347 my $shelfname = $query->param('addshelf');
351 # note: a user can always add a new shelf (except database administrator account)
353 Koha::Virtualshelf->new(
355 shelfname => $shelfname,
356 sortfield => $query->param('sortfield'),
357 category => $query->param('category'),
358 allow_add => $query->param('allow_add'),
359 allow_delete_own => $query->param('allow_delete_own'),
360 allow_delete_other => $query->param('allow_delete_other'),
361 owner => $query->param('owner'),
367 push @messages, { type => 'error', code => ref($@) };
368 } elsif ( not $shelf ) {
370 push @messages, { type => 'error', 'error_on_insert' };
372 print $query->redirect( $pages{$type}->{redirect} . "?viewshelf=$shelfnumber" );
377 shelfname => $shelfname,
382 #Deleting a shelf (asking for confirmation if it has entries)
383 foreach ( $query->param() ) {
384 /(DEL|REMSHR)-(\d+)/ or next;
387 unless ( defined $shelflist->{$number} ) {
388 push( @paramsloop, { unrecognized => $number } );
393 my $shelf = Koha::Virtualshelves->find( $number );
394 $shelf->delete_share( $loggedinuser );
395 delete $shelflist->{$number} if exists $shelflist->{$number};
400 my $can_manage = ShelfPossibleAction( $loggedinuser, $number, 'manage' );
401 my $can_delete = ShelfPossibleAction( $loggedinuser, $number, 'delete_shelf' );
402 unless ( $can_manage or $can_delete ) {
403 push( @paramsloop, { nopermission => $shelfnumber } );
407 ( $contents, $totshelves ) = GetShelfContents( $number, $shelveslimit, $shelvesoffset );
408 if ( $totshelves > 0 ) {
409 unless ( scalar grep { /^CONFIRM-$number$/ } $query->param() ) {
410 if ( defined $shelflist->{$number} ) {
411 push( @paramsloop, { need_confirm => $shelflist->{$number}->{shelfname}, count => $totshelves, single => ($totshelves eq 1 ? 1:0) } );
412 $shelflist->{$number}->{confirm} = $number;
419 if ( defined $shelflist->{$number} ) {
420 $name = $shelflist->{$number}->{'shelfname'};
421 delete $shelflist->{$number};
423 unless( Koha::Virtualshelves->find($number)->delete ) {
424 push( @paramsloop, { delete_fail => $name } );
427 push( @paramsloop, { delete_ok => $name } );
433 $template->param( shelves => 1 );
438 } # end of SWITCH block
440 (@paramsloop) and $template->param( paramsloop => \@paramsloop );
441 $showadd and $template->param( showadd => 1 );
444 my $numberCanManage = 0;
446 # rebuild shelflist in case a shelf has been added
447 unless ( $delflag ) {
448 if ( $category == 2 ) {
449 $shelflist = Koha::Virtualshelves->get_public_shelves({ limit => $shelveslimit, offset => $shelvesoffset });
451 $shelflist = Koha::Virtualshelves->get_private_shelves({ limit => $shelveslimit, offset => $shelvesoffset, borrowernumber => $loggedinuser });
455 $totshelves = C4::VirtualShelves::GetShelfCount( $loggedinuser, $category ) unless $delflag;
456 foreach my $element ( sort { lc( $shelflist->{$a}->{'shelfname'} ) cmp lc( $shelflist->{$b}->{'shelfname'} ) } keys %$shelflist ) {
458 $shelflist->{$element}->{shelf} = $element;
459 my $category = $shelflist->{$element}->{'category'};
460 my $owner = $shelflist->{$element}->{'owner'}||0;
461 my $canmanage = ShelfPossibleAction( $loggedinuser, $element, 'manage' );
462 my $candelete = ShelfPossibleAction( $loggedinuser, $element, 'delete_shelf' );
463 $shelflist->{$element}->{"viewcategory$category"} = 1;
464 $shelflist->{$element}->{manageshelf} = $canmanage;
465 $shelflist->{$element}->{allowdeletingshelf} = $candelete;
466 if($canmanage || ($loggedinuser && $owner==$loggedinuser)) {
467 $shelflist->{$element}->{'mine'} = 1;
469 my $member = GetMember( 'borrowernumber' => $owner );
470 $shelflist->{$element}->{ownername} = defined($member) ? $member->{firstname} . " " . $member->{surname} : '';
471 $numberCanManage++ if $canmanage; # possibly outmoded
472 if ( $shelflist->{$element}->{'category'} eq '1' ) {
473 my $shelf = Koha::Virtualshelves->find( $element );
474 $shelflist->{$element}->{shares} = $shelf->is_shared;
475 push( @shelveslooppriv, $shelflist->{$element} );
477 push( @shelvesloop, $shelflist->{$element} );
481 my $url = $type eq 'opac' ? "/cgi-bin/koha/opac-shelves.pl" : "/cgi-bin/koha/virtualshelves/shelves.pl";
483 foreach (qw(display viewshelf sortfield sort direction)) {
484 $qhash{$_} = $query->param($_) if $query->param($_);
486 ( scalar keys %qhash ) and $url .= '?' . join '&', map { "$_=$qhash{$_}" } keys %qhash;
488 if ( $shelfnumber && $totitems ) {
489 $template->param( pagination_bar => pagination_bar( $url, ( int( $totitems / $shelflimit ) ) + ( ( $totitems % $shelflimit ) > 0 ? 1 : 0 ), $itemoff, "itemoff" ) );
490 } elsif ( $totshelves ) {
492 pagination_bar => pagination_bar( $url, ( int( $totshelves / $shelveslimit ) ) + ( ( $totshelves % $shelveslimit ) > 0 ? 1 : 0 ), $shelfoff, "shelfoff" ) );
497 shelveslooppriv => \@shelveslooppriv,
498 shelvesloop => \@shelvesloop,
499 shelvesloopall => [ ( @shelvesloop, @shelveslooppriv ) ],
500 numberCanManage => $numberCanManage,
501 "BiblioDefaultView" . C4::Context->preference("BiblioDefaultView") => 1,
502 csv_profiles => GetCsvProfilesLoop('marc')
505 #Next call updates the shelves for the Lists button.
506 #May not always be needed (when nothing changed), but doesn't take much.
507 my ($total, $pubshelves, $barshelves) = C4::VirtualShelves::GetSomeShelfNames($loggedinuser, 'MASTHEAD');
509 barshelves => $total->{bartotal},
510 barshelvesloop => $barshelves,
511 pubshelves => $total->{pubtotal},
512 pubshelvesloop => $pubshelves,
513 messages => \@messages,
516 output_html_with_http_headers $query, $cookie, $template->output;
524 VirtualShelves/Page.pm
528 Module used for both OPAC and intranet pages.
530 =head1 CGI PARAMETERS
534 =item C<modifyshelfcontents>
536 If this script has to modify the shelf content.
540 To know on which shelf to work.
547 * modif: show the template allowing modification of the shelves;
548 * modifsave: save changes from modif mode.
552 Load template with 'viewshelves param' displaying the shelf's information.
556 If the param shelves == 1, then add or delete a shelf.
560 If the param shelves == 1, then addshelf is the name of the shelf to add.