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 under the
9 # terms of the GNU General Public License as published by the Free Software
10 # Foundation; either version 2 of the License, or (at your option) any later
13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License along
18 # with Koha; if not, write to the Free Software Foundation, Inc.,
19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 # perldoc at the end of the file, per convention.
30 use C4::VirtualShelves qw/:DEFAULT ShelvesMax/;
34 use C4::Auth qw/get_session/;
37 use C4::Dates qw/format_date/;
38 use C4::Tags qw(get_tags);
42 use constant VIRTUALSHELVES_COUNT => 20;
44 use vars qw($debug @EXPORT @ISA $VERSION);
47 $VERSION = 3.07.00.049;
49 @EXPORT = qw(&shelfpage);
50 $debug = $ENV{DEBUG} || 0;
54 intranet => { redirect => '/cgi-bin/koha/virtualshelves/shelves.pl', },
55 opac => { redirect => '/cgi-bin/koha/opac-shelves.pl', },
59 my ( $type, $query, $template, $loggedinuser, $cookie ) = @_;
60 ( $pages{$type} ) or $type = 'opac';
61 $query or die "No query";
62 $template or die "No template";
64 loggedinuser => $loggedinuser,
65 OpacAllowPublicListCreation => C4::Context->preference('OpacAllowPublicListCreation'),
71 my $shelfoff = ( $query->param('shelfoff') ? $query->param('shelfoff') : 1 );
72 $template->{VARS}->{'shelfoff'} = $shelfoff;
73 my $itemoff = ( $query->param('itemoff') ? $query->param('itemoff') : 1 );
74 my $displaymode = ( $query->param('display') ? $query->param('display') : 'publicshelves' );
75 my ( $shelflimit, $shelfoffset, $shelveslimit, $shelvesoffset );
76 my $marcflavour = C4::Context->preference("marcflavour");
78 # get biblionumbers stored in the cart
80 my $cart_cookie = ( $type eq 'opac' ? "bib_list" : "intranet_bib_list" );
81 if($query->cookie($cart_cookie)){
82 my $cart_list = $query->cookie($cart_cookie);
83 @cart_list = split(/\//, $cart_list);
86 $shelflimit = ( $type eq 'opac' ? C4::Context->preference('OPACnumSearchResults') : C4::Context->preference('numSearchResults') );
87 $shelflimit = $shelflimit || ShelvesMax('MGRPAGE');
88 $shelfoffset = ( $itemoff - 1 ) * $shelflimit; # Sets the offset to begin retrieving items at
89 $shelveslimit = $shelflimit; # Limits number of shelves returned for a given query (row_count)
90 $shelvesoffset = ( $shelfoff - 1 ) * $shelflimit; # Sets the offset to begin retrieving shelves at (offset)
91 # getting the Shelves list
92 my $category = ( ( $displaymode eq 'privateshelves' ) ? 1 : 2 );
93 my ( $shelflist, $totshelves ) = GetShelves( $category, $shelveslimit, $shelvesoffset, $loggedinuser );
95 #Get a list of private shelves for possible deletion. Only do this when we've defaulted to public shelves
96 my ( $privshelflist, $privtotshelves );
97 if ( $category == 2 ) {
98 ( $privshelflist, $privtotshelves ) = GetShelves( 1, $shelveslimit, $shelvesoffset, $loggedinuser );
100 my $op = $query->param('op');
102 # the format of this is unindented for ease of diff comparison to the old script
103 # Note: do not mistake the assignment statements below for comparisons!
104 if ( $query->param('modifyshelfcontents') ) {
105 my ( $shelfnumber, $barcode, $item, $biblio );
106 if ( $shelfnumber = $query->param('viewshelf') ) {
108 if($barcode = $query->param('addbarcode') ) {
109 if(ShelfPossibleAction( $loggedinuser, $shelfnumber, 'add')) {
110 $item = GetItem( 0, $barcode);
111 if (defined $item && $item->{'itemnumber'}) {
112 $biblio = GetBiblioFromItemNumber( $item->{'itemnumber'} );
113 AddToShelf( $biblio->{'biblionumber'}, $shelfnumber, $loggedinuser)
114 or push @paramsloop, { duplicatebiblio => $barcode };
117 push @paramsloop, { failgetitem => $barcode };
121 push @paramsloop, { nopermission => $shelfnumber };
124 elsif(grep { /REM-(\d+)/ } $query->param) {
125 #remove item(s) from shelf
126 if(ShelfPossibleAction($loggedinuser, $shelfnumber, 'delete')) {
127 #This is just a general okay; DelFromShelf checks further
129 foreach($query->param) {
131 push @bib, $1; #$1 is biblionumber
133 my $t= DelFromShelf(\@bib, $shelfnumber, $loggedinuser);
135 push @paramsloop, {nothingdeleted => $shelfnumber};
138 push @paramsloop, {somedeleted => $shelfnumber};
142 push @paramsloop, { nopermission => $shelfnumber };
147 push @paramsloop, { noshelfnumber => 1 };
153 # set the default tab, etc. (for OPAC)
154 my $shelf_type = ( $query->param('display') ? $query->param('display') : 'publicshelves' );
155 if ( defined $shelf_type ) {
156 if ( $shelf_type eq 'privateshelves' ) {
157 $template->param( showprivateshelves => 1 );
158 } elsif ( $shelf_type eq 'publicshelves' ) {
159 $template->param( showpublicshelves => 1 );
162 $debug and warn "Invalid 'display' param ($shelf_type)";
164 } elsif ( $loggedinuser == -1 ) {
165 $template->param( showpublicshelves => 1 );
167 $template->param( showprivateshelves => 1 );
170 my ( $okmanage, $okview );
171 my $shelfnumber = $query->param('shelfnumber') || $query->param('viewshelf');
173 $okmanage = ShelfPossibleAction( $loggedinuser, $shelfnumber, 'manage' );
174 $okview = ShelfPossibleAction( $loggedinuser, $shelfnumber, 'view' );
181 #Saving modified shelf
182 if ( $op eq 'modifsave' ) {
184 push @paramsloop, { nopermission => $shelfnumber };
188 shelfname => $query->param('shelfname'),
189 sortfield => $query->param('sortfield'),
190 allow_add => $query->param('allow_add'),
191 allow_delete_own => $query->param('allow_delete_own'),
192 allow_delete_other => $query->param('allow_delete_other'),
194 if($query->param('category')) { #optional
195 $shelf->{category}= $query->param('category');
197 unless(ModShelf($shelfnumber, $shelf )) {
198 push @paramsloop, {modifyfailure => $shelf->{shelfname}};
202 if($displaymode eq "viewshelf"){
203 print $query->redirect( $pages{$type}->{redirect} . "?viewshelf=$shelfnumber" );
204 } elsif($displaymode eq "publicshelves"){
205 print $query->redirect( $pages{$type}->{redirect} );
207 print $query->redirect( $pages{$type}->{redirect} . "?display=privateshelves" );
212 elsif ( $op eq 'modif' ) {
213 my ( $shelfnumber2, $shelfname, $owner, $category, $sortfield, $allow_add, $allow_delete_own, $allow_delete_other) = GetShelf($shelfnumber);
214 my $member = GetMember( 'borrowernumber' => $owner );
215 my $ownername = defined($member) ? $member->{firstname} . " " . $member->{surname} : '';
219 display => $displaymode,
220 shelfnumber => $shelfnumber2,
221 shelfname => $shelfname,
223 ownername => $ownername,
224 "category$category" => 1,
225 category => $category,
226 sortfield => $sortfield,
227 allow_add => $allow_add,
228 allow_delete_own => $allow_delete_own,
229 allow_delete_other => $allow_delete_other,
236 if ( $shelfnumber = $query->param('viewshelf') ) {
237 # explicitly fetch this shelf
238 my ($shelfnumber2,$shelfname,$owner,$category,$sorton) = GetShelf($shelfnumber);
241 'AllowOnShelfHolds' => C4::Context->preference('AllowOnShelfHolds'),
242 'DisplayMultiPlaceHold' => C4::Context->preference('DisplayMultiPlaceHold'),
244 if (C4::Context->preference('TagsEnabled')) {
245 $template->param(TagsEnabled => 1);
246 foreach (qw(TagsShowOnList TagsInputOnList)) {
247 C4::Context->preference($_) and $template->param($_ => 1);
250 #check that the user can view the shelf
251 if ( ShelfPossibleAction( $loggedinuser, $shelfnumber, 'view' ) ) {
254 my $sortfield = ( $sorton ? $sorton : 'title' );
255 $sortfield = $query->param('sort') || $sortfield; ## Passed in sorting overrides default sorting
256 my $direction = $query->param('direction') || 'asc';
259 direction => $direction,
261 ( $items, $totitems ) = GetShelfContents( $shelfnumber, $shelflimit, $shelfoffset, $sortfield, $direction );
262 for my $this_item (@$items) {
263 my $biblionumber = $this_item->{'biblionumber'};
264 my $record = GetMarcBiblio($biblionumber);
265 if (C4::Context->preference("OPACXSLTResultsDisplay") && $type eq 'opac') {
266 $this_item->{XSLTBloc} = XSLTParse4Display($biblionumber, $record, "OPACXSLTResultsDisplay");
267 } elsif (C4::Context->preference("XSLTResultsDisplay") && $type eq 'intranet') {
268 $this_item->{XSLTBloc} = XSLTParse4Display($biblionumber, $record, "XSLTResultsDisplay");
271 # the virtualshelfcontents table does not store these columns nor are they retrieved from the items
272 # and itemtypes tables, so I'm commenting them out for now to quiet the log -crn
273 #$this_item->{imageurl} = $imgdir."/".$itemtypes->{ $this_item->{itemtype} }->{'imageurl'};
274 #$this_item->{'description'} = $itemtypes->{ $this_item->{itemtype} }->{'description'};
275 $this_item->{'dateadded'} = format_date( $this_item->{'dateadded'} );
276 $this_item->{'imageurl'} = getitemtypeinfo( $this_item->{'itemtype'}, $type )->{'imageurl'};
277 $this_item->{'coins'} = GetCOinSBiblio( $record );
278 $this_item->{'subtitle'} = GetRecordValue('subtitle', $record, GetFrameworkCode($this_item->{'biblionumber'}));
279 $this_item->{'normalized_upc'} = GetNormalizedUPC( $record,$marcflavour);
280 $this_item->{'normalized_ean'} = GetNormalizedEAN( $record,$marcflavour);
281 $this_item->{'normalized_oclc'} = GetNormalizedOCLCNumber($record,$marcflavour);
282 $this_item->{'normalized_isbn'} = GetNormalizedISBN(undef,$record,$marcflavour);
283 if(!defined($this_item->{'size'})) { $this_item->{'size'} = "" }; #TT has problems with size
284 # Getting items infos for location display
285 my @items_infos = &GetItemsLocationInfo( $this_item->{'biblionumber'});
286 $this_item->{'itemsissued'} = CountItemsIssued( $this_item->{'biblionumber'} );
287 $this_item->{'ITEM_RESULTS'} = \@items_infos;
288 if ( grep {$_ eq $biblionumber} @cart_list) {
289 $this_item->{'incart'} = 1;
292 if (C4::Context->preference('TagsEnabled') and $tag_quantity = C4::Context->preference('TagsShowOnList')) {
293 $this_item->{'TagLoop'} = get_tags({
294 biblionumber=>$this_item->{'biblionumber'}, approved=>1, 'sort'=>'-weight',
300 if($type eq 'intranet'){
301 # Build drop-down list for 'Add To:' menu...
302 my ($totalref, $pubshelves, $barshelves)=
303 C4::VirtualShelves::GetSomeShelfNames($loggedinuser,'COMBO',1);
305 addbarshelves => $totalref->{bartotal},
306 addbarshelvesloop => $barshelves,
307 addpubshelves => $totalref->{pubtotal},
308 addpubshelvesloop => $pubshelves,
311 push @paramsloop, { display => 'privateshelves' } if $category == 1;
314 my $manageshelf = ShelfPossibleAction( $loggedinuser, $shelfnumber, 'manage' );
316 shelfname => $shelfname,
317 shelfnumber => $shelfnumber,
318 viewshelf => $shelfnumber,
319 sortfield => $sortfield,
320 manageshelf => $manageshelf,
321 allowremovingitems => ShelfPossibleAction( $loggedinuser, $shelfnumber, 'delete'),
322 allowaddingitem => ShelfPossibleAction( $loggedinuser, $shelfnumber, 'add'),
323 "category$category" => 1,
324 category => $category,
326 showprivateshelves => $category==1,
329 push @paramsloop, { nopermission => $shelfnumber };
334 if ( $query->param('shelves') ) {
338 if ( my $newshelf = $query->param('addshelf') ) {
340 # note: a user can always add a new shelf (except database administrator account)
341 my $shelfnumber = AddShelf( {
342 shelfname => $newshelf,
343 sortfield => $query->param('sortfield'),
344 category => $query->param('category'),
345 allow_add => $query->param('allow_add'),
346 allow_delete_own => $query->param('allow_delete_own'),
347 allow_delete_other => $query->param('allow_delete_other'),
349 $query->param('owner') );
351 if( !$shelfnumber ) {
352 push @paramsloop, { addshelf_failed => 1 };
353 } elsif ( $shelfnumber == -1 ) { #shelf already exists.
355 push @paramsloop, { already => $newshelf };
356 $template->param( shelfnumber => $shelfnumber );
358 print $query->redirect( $pages{$type}->{redirect} . "?viewshelf=$shelfnumber" );
363 #Deleting a shelf (asking for confirmation if it has entries)
364 foreach ( $query->param() ) {
365 /(DEL|REMSHR)-(\d+)/ or next;
368 unless ( defined $shelflist->{$number} || defined $privshelflist->{$number} ) {
369 push( @paramsloop, { unrecognized => $number } );
374 RemoveShare($loggedinuser, $number);
375 delete $shelflist->{$number} if exists $shelflist->{$number};
376 delete $privshelflist->{$number} if exists $privshelflist->{$number};
381 unless ( ShelfPossibleAction( $loggedinuser, $number, 'manage' ) ) {
382 push( @paramsloop, { nopermission => $shelfnumber } );
386 ( $contents, $totshelves ) = GetShelfContents( $number, $shelveslimit, $shelvesoffset );
387 if ( my $count = scalar @$contents ) {
388 unless ( scalar grep { /^CONFIRM-$number$/ } $query->param() ) {
389 if ( defined $shelflist->{$number} ) {
390 push( @paramsloop, { need_confirm => $shelflist->{$number}->{shelfname}, count => $count, single => ($count eq 1 ? 1:0) } );
391 $shelflist->{$number}->{confirm} = $number;
393 push( @paramsloop, { need_confirm => $privshelflist->{$number}->{shelfname}, count => $count } );
394 $privshelflist->{$number}->{confirm} = $number;
401 if ( defined $shelflist->{$number} ) {
402 $name = $shelflist->{$number}->{'shelfname'};
403 delete $shelflist->{$number};
405 $name = $privshelflist->{$number}->{'shelfname'};
406 delete $privshelflist->{$number};
408 unless ( DelShelf($number) ) {
409 push( @paramsloop, { delete_fail => $name } );
412 push( @paramsloop, { delete_ok => $name } );
418 $template->param( shelves => 1 );
423 } # end of SWITCH block
425 (@paramsloop) and $template->param( paramsloop => \@paramsloop );
426 $showadd and $template->param( showadd => 1 );
429 my $numberCanManage = 0;
431 # rebuild shelflist in case a shelf has been added
432 ( $shelflist, $totshelves ) = GetShelves( $category, $shelveslimit, $shelvesoffset, $loggedinuser ) unless $delflag;
433 foreach my $element ( sort { lc( $shelflist->{$a}->{'shelfname'} ) cmp lc( $shelflist->{$b}->{'shelfname'} ) } keys %$shelflist ) {
435 $shelflist->{$element}->{shelf} = $element;
436 my $category = $shelflist->{$element}->{'category'};
437 my $owner = $shelflist->{$element}->{'owner'}||0;
438 my $canmanage = ShelfPossibleAction( $loggedinuser, $element, 'manage' );
439 $shelflist->{$element}->{"viewcategory$category"} = 1;
440 $shelflist->{$element}->{manageshelf} = $canmanage;
441 if($canmanage || ($loggedinuser && $owner==$loggedinuser)) {
442 $shelflist->{$element}->{'mine'} = 1;
444 my $member = GetMember( 'borrowernumber' => $owner );
445 $shelflist->{$element}->{ownername} = defined($member) ? $member->{firstname} . " " . $member->{surname} : '';
446 $numberCanManage++ if $canmanage; # possibly outmoded
447 if ( $shelflist->{$element}->{'category'} eq '1' ) {
448 $shelflist->{$element}->{shares} = IsSharedList($element);
449 push( @shelveslooppriv, $shelflist->{$element} );
451 push( @shelvesloop, $shelflist->{$element} );
455 my $url = $type eq 'opac' ? "/cgi-bin/koha/opac-shelves.pl" : "/cgi-bin/koha/virtualshelves/shelves.pl";
457 foreach (qw(display viewshelf sortfield sort direction)) {
458 $qhash{$_} = $query->param($_) if $query->param($_);
460 ( scalar keys %qhash ) and $url .= '?' . join '&', map { "$_=$qhash{$_}" } keys %qhash;
461 if ( $shelfnumber && $totitems ) {
462 $template->param( pagination_bar => pagination_bar( $url, ( int( $totitems / $shelflimit ) ) + ( ( $totitems % $shelflimit ) > 0 ? 1 : 0 ), $itemoff, "itemoff" ) );
463 } elsif ( $totshelves ) {
465 pagination_bar => pagination_bar( $url, ( int( $totshelves / $shelveslimit ) ) + ( ( $totshelves % $shelveslimit ) > 0 ? 1 : 0 ), $shelfoff, "shelfoff" ) );
468 shelveslooppriv => \@shelveslooppriv,
469 shelvesloop => \@shelvesloop,
470 shelvesloopall => [ ( @shelvesloop, @shelveslooppriv ) ],
471 numberCanManage => $numberCanManage,
472 "BiblioDefaultView" . C4::Context->preference("BiblioDefaultView") => 1,
473 csv_profiles => GetCsvProfilesLoop('marc')
478 $template->param( vseflag => 1 );
480 if ($shelves or # note: this part looks duplicative, but is intentional
483 $template->param( seflag => 1 );
484 #This hack is just another argument for refactoring this script one day
485 #At this point you are adding or editing a list; if you add, then you add a private list (by default) with permissions as below; if you edit, do not pass these permissions, they must come from the database
486 $template->param( allow_add => 0, allow_delete_own => 1, allow_delete_other => 0) unless $shelfnumber;
489 #Next call updates the shelves for the Lists button.
490 #May not always be needed (when nothing changed), but doesn't take much.
491 my ($total, $pubshelves, $barshelves) = C4::VirtualShelves::GetSomeShelfNames($loggedinuser, 'MASTHEAD');
493 barshelves => $total->{bartotal},
494 barshelvesloop => $barshelves,
495 pubshelves => $total->{pubtotal},
496 pubshelvesloop => $pubshelves,
499 output_html_with_http_headers $query, $cookie, $template->output;
507 VirtualShelves/Page.pm
511 Module used for both OPAC and intranet pages.
513 =head1 CGI PARAMETERS
517 =item C<modifyshelfcontents>
519 If this script has to modify the shelf content.
523 To know on which shelf to work.
530 * modif: show the template allowing modification of the shelves;
531 * modifsave: save changes from modif mode.
535 Load template with 'viewshelves param' displaying the shelf's information.
539 If the param shelves == 1, then add or delete a shelf.
543 If the param shelves == 1, then addshelf is the name of the shelf to add.