Bug 9458 - Add sorting to lists - QA Followup 3
[koha.git] / C4 / VirtualShelves / Page.pm
1 package C4::VirtualShelves::Page;
2
3 #
4 # Copyright 2000-2002 Katipo Communications
5 #
6 # This file is part of Koha.
7 #
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
11 # version.
12 #
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.
16 #
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.
20
21 # perldoc at the end of the file, per convention.
22
23 use strict;
24 use warnings;
25
26 use CGI;
27 use Exporter;
28 use Data::Dumper;
29
30 use C4::VirtualShelves qw/:DEFAULT ShelvesMax/;
31 use C4::Biblio;
32 use C4::Items;
33 use C4::Koha;
34 use C4::Auth qw/get_session/;
35 use C4::Members;
36 use C4::Output;
37 use C4::Dates qw/format_date/;
38 use C4::Tags qw(get_tags);
39 use C4::Csv;
40 use C4::XSLT;
41
42 use constant VIRTUALSHELVES_COUNT => 20;
43
44 use vars qw($debug @EXPORT @ISA $VERSION);
45
46 BEGIN {
47     $VERSION = 3.07.00.049;
48     @ISA     = qw(Exporter);
49     @EXPORT  = qw(&shelfpage);
50     $debug   = $ENV{DEBUG} || 0;
51 }
52
53 our %pages = (
54     intranet => { redirect => '/cgi-bin/koha/virtualshelves/shelves.pl', },
55     opac     => { redirect => '/cgi-bin/koha/opac-shelves.pl', },
56 );
57
58 sub shelfpage {
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";
63     $template->param(
64     loggedinuser => $loggedinuser,
65     OpacAllowPublicListCreation => C4::Context->preference('OpacAllowPublicListCreation'),
66     );
67     my $edit;
68     my $shelves;
69     my @paramsloop;
70     my $totitems;
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");
77
78     # get biblionumbers stored in the cart
79     my @cart_list;
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);
84     }
85
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 );
94
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 );
99     }
100     my $op = $query->param('op');
101
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') ) {
107             #add to shelf
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 };
115                     }
116                     else {
117                         push @paramsloop, { failgetitem => $barcode };
118                     }
119                 }
120                 else {
121                     push @paramsloop, { nopermission => $shelfnumber };
122                 }
123             }
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
128                     my @bib;
129                     foreach($query->param) {
130                         /REM-(\d+)/ or next;
131                         push @bib, $1; #$1 is biblionumber
132                     }
133                     my $t= DelFromShelf(\@bib, $shelfnumber, $loggedinuser);
134                     if($t==0) {
135                         push @paramsloop, {nothingdeleted => $shelfnumber};
136                     }
137                     elsif($t<@bib) {
138                         push @paramsloop, {somedeleted => $shelfnumber};
139                     }
140                 }
141                 else {
142                     push @paramsloop, { nopermission => $shelfnumber };
143                 }
144             }
145         }
146         else {
147             push @paramsloop, { noshelfnumber => 1 };
148         }
149     }
150
151     my $showadd = 1;
152
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 );
160             $showadd = 0;
161         } else {
162             $debug and warn "Invalid 'display' param ($shelf_type)";
163         }
164     } elsif ( $loggedinuser == -1 ) {
165         $template->param( showpublicshelves => 1 );
166     } else {
167         $template->param( showprivateshelves => 1 );
168     }
169
170     my ( $okmanage, $okview );
171     my $shelfnumber = $query->param('shelfnumber') || $query->param('viewshelf');
172     if ($shelfnumber) {
173         $okmanage = ShelfPossibleAction( $loggedinuser, $shelfnumber, 'manage' );
174         $okview   = ShelfPossibleAction( $loggedinuser, $shelfnumber, 'view' );
175     }
176
177     my $delflag = 0;
178
179   SWITCH: {
180         if ($op) {
181         #Saving modified shelf
182             if ( $op eq 'modifsave' ) {
183                 unless ($okmanage) {
184                         push @paramsloop, { nopermission => $shelfnumber };
185                         last SWITCH;
186                 }
187                 my $shelf = {
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'),
193                 };
194                 if($query->param('category')) { #optional
195                     $shelf->{category}= $query->param('category');
196                 }
197                 unless(ModShelf($shelfnumber, $shelf )) {
198                   push @paramsloop, {modifyfailure => $shelf->{shelfname}};
199                   last SWITCH;
200                 }
201
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} );
206                 } else {
207                     print $query->redirect( $pages{$type}->{redirect} . "?display=privateshelves" );
208                 }
209                 exit;
210             }
211         #Editing a shelf
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} : '';
216                 $edit = 1;
217                 $sortfield='' unless $sortfield;
218                 $template->param(
219                     edit                => 1,
220                     display             => $displaymode,
221                     shelfnumber         => $shelfnumber2,
222                     shelfname           => $shelfname,
223                     owner               => $owner,
224                     ownername           => $ownername,
225                     "category$category" => 1,
226                     category            => $category,
227                     "sort_$sortfield"   => 1,
228                     allow_add           => $allow_add,
229                     allow_delete_own    => $allow_delete_own,
230                     allow_delete_other  => $allow_delete_other,
231                 );
232             }
233             last SWITCH;
234         }
235
236         #View a shelf
237         if ( $shelfnumber = $query->param('viewshelf') ) {
238             # explicitly fetch this shelf
239             my ($shelfnumber2,$shelfname,$owner,$category,$sorton) = GetShelf($shelfnumber);
240
241             $template->param( 'AllowOnShelfHolds' => C4::Context->preference('AllowOnShelfHolds') );
242             if (C4::Context->preference('TagsEnabled')) {
243                 $template->param(TagsEnabled => 1);
244                     foreach (qw(TagsShowOnList TagsInputOnList)) {
245                     C4::Context->preference($_) and $template->param($_ => 1);
246                 }
247             }
248             #check that the user can view the shelf
249             if ( ShelfPossibleAction( $loggedinuser, $shelfnumber, 'view' ) ) {
250                 my $items;
251                 my $authorsort;
252                 my $yearsort;
253                 my $tag_quantity;
254                 my $sortfield = ( $sorton ? $sorton : 'title' );
255                 if ( $sortfield eq 'author' ) {
256                     $authorsort = 'author';
257                 }
258                 if ( $sortfield eq 'year' ) {
259                     $yearsort = 'year';
260                 }
261                 $sortfield = $query->param('sort') || $sortfield; ## Passed in sorting overrides default sorting
262                 my $direction = $query->param('direction') || 'asc';
263                 $template->param(
264                     sort      => $sortfield,
265                     direction => $direction,
266                 );
267                 ( $items, $totitems ) = GetShelfContents( $shelfnumber, $shelflimit, $shelfoffset, $sortfield, $direction );
268                 for my $this_item (@$items) {
269                     my $biblionumber = $this_item->{'biblionumber'};
270                     my $record = GetMarcBiblio($biblionumber);
271                     $this_item->{XSLTBloc} =
272                         XSLTParse4Display($biblionumber, $record, "OPACXSLTResultsDisplay")
273                             if C4::Context->preference("OPACXSLTResultsDisplay") && $type eq 'opac';
274
275                     # the virtualshelfcontents table does not store these columns nor are they retrieved from the items
276                     # and itemtypes tables, so I'm commenting them out for now to quiet the log -crn
277                     #$this_item->{imageurl} = $imgdir."/".$itemtypes->{ $this_item->{itemtype}  }->{'imageurl'};
278                     #$this_item->{'description'} = $itemtypes->{ $this_item->{itemtype} }->{'description'};
279                     $this_item->{'dateadded'} = format_date( $this_item->{'dateadded'} );
280                     $this_item->{'imageurl'}  = getitemtypeinfo( $this_item->{'itemtype'}, $type )->{'imageurl'};
281                     $this_item->{'coins'}     = GetCOinSBiblio( $record );
282                     $this_item->{'subtitle'} = GetRecordValue('subtitle', $record, GetFrameworkCode($this_item->{'biblionumber'}));
283                     $this_item->{'normalized_upc'}  = GetNormalizedUPC(       $record,$marcflavour);
284                     $this_item->{'normalized_ean'}  = GetNormalizedEAN(       $record,$marcflavour);
285                     $this_item->{'normalized_oclc'} = GetNormalizedOCLCNumber($record,$marcflavour);
286                     $this_item->{'normalized_isbn'} = GetNormalizedISBN(undef,$record,$marcflavour);
287                     if(!defined($this_item->{'size'})) { $this_item->{'size'} = "" }; #TT has problems with size
288                     # Getting items infos for location display
289                     my @items_infos = &GetItemsLocationInfo( $this_item->{'biblionumber'});
290                     $this_item->{'itemsissued'} = CountItemsIssued( $this_item->{'biblionumber'} );
291                     $this_item->{'ITEM_RESULTS'} = \@items_infos;
292                     if ( grep {$_ eq $biblionumber} @cart_list) {
293                         $this_item->{'incart'} = 1;
294                     }
295
296                     if (C4::Context->preference('TagsEnabled') and $tag_quantity = C4::Context->preference('TagsShowOnList')) {
297                         $this_item->{'TagLoop'} = get_tags({
298                             biblionumber=>$this_item->{'biblionumber'}, approved=>1, 'sort'=>'-weight',
299                             limit=>$tag_quantity
300                             });
301                     }
302
303                 }
304                 push @paramsloop, { display => 'privateshelves' } if $category == 1;
305                 $showadd = 1;
306                 my $i = 0;
307                 my $manageshelf = ShelfPossibleAction( $loggedinuser, $shelfnumber, 'manage' );
308                 $template->param(
309                     shelfname           => $shelfname,
310                     shelfnumber         => $shelfnumber,
311                     viewshelf           => $shelfnumber,
312                     authorsort          => $authorsort,
313                     yearsort            => $yearsort,
314                     manageshelf         => $manageshelf,
315                     allowremovingitems  => ShelfPossibleAction( $loggedinuser, $shelfnumber, 'delete'),
316                     allowaddingitem     => ShelfPossibleAction( $loggedinuser, $shelfnumber, 'add'),
317                     "category$category" => 1,
318                     category            => $category,
319                     itemsloop           => $items,
320                     showprivateshelves  => $category==1,
321                 );
322             } else {
323                 push @paramsloop, { nopermission => $shelfnumber };
324             }
325             last SWITCH;
326         }
327
328         if ( $query->param('shelves') ) {
329             my $stay = 1;
330
331         #Add a shelf
332             if ( my $newshelf = $query->param('addshelf') ) {
333
334                 # note: a user can always add a new shelf
335                 my $shelfnumber = AddShelf( {
336                     shelfname => $newshelf,
337                     sortfield => $query->param('sortfield'),
338                     category => $query->param('category'),
339                     allow_add => $query->param('allow_add'),
340                     allow_delete_own => $query->param('allow_delete_own'),
341                     allow_delete_other => $query->param('allow_delete_other'),
342                     },
343                     $query->param('owner') );
344                 $stay = 1;
345                 if ( $shelfnumber == -1 ) {    #shelf already exists.
346                     $showadd = 1;
347                     push @paramsloop, { already => $newshelf };
348                     $template->param( shelfnumber => $shelfnumber );
349                 } else {
350                     print $query->redirect( $pages{$type}->{redirect} . "?viewshelf=$shelfnumber" );
351                     exit;
352                 }
353             }
354
355         #Deleting a shelf (asking for confirmation if it has entries)
356             foreach ( $query->param() ) {
357                 /DEL-(\d+)/ or next;
358                 $delflag = 1;
359                 my $number = $1;
360                 unless ( defined $shelflist->{$number} || defined $privshelflist->{$number} ) {
361                     push( @paramsloop, { unrecognized => $number } );
362                     last;
363                 }
364                 unless ( ShelfPossibleAction( $loggedinuser, $number, 'manage' ) ) {
365                     push( @paramsloop, { nopermission => $shelfnumber } );
366                     last;
367                 }
368                 my $contents;
369                 ( $contents, $totshelves ) = GetShelfContents( $number, $shelveslimit, $shelvesoffset );
370                 if ( my $count = scalar @$contents ) {
371                     unless ( scalar grep { /^CONFIRM-$number$/ } $query->param() ) {
372                         if ( defined $shelflist->{$number} ) {
373                             push( @paramsloop, { need_confirm => $shelflist->{$number}->{shelfname}, count => $count, single => ($count eq 1 ? 1:0) } );
374                             $shelflist->{$number}->{confirm} = $number;
375                         } else {
376                             push( @paramsloop, { need_confirm => $privshelflist->{$number}->{shelfname}, count => $count } );
377                             $privshelflist->{$number}->{confirm} = $number;
378                         }
379                         $stay = 0;
380                         next;
381                     }
382                 }
383                 my $name;
384                 if ( defined $shelflist->{$number} ) {
385                     $name = $shelflist->{$number}->{'shelfname'};
386                     delete $shelflist->{$number};
387                 } else {
388                     $name = $privshelflist->{$number}->{'shelfname'};
389                     delete $privshelflist->{$number};
390                 }
391                 unless ( DelShelf($number) ) {
392                     push( @paramsloop, { delete_fail => $name } );
393                     last;
394                 }
395                 push( @paramsloop, { delete_ok => $name } );
396
397                 $stay = 0;
398             }
399             $showadd = 1;
400             if ($stay){
401                 $template->param( shelves => 1 );
402                 $shelves = 1;
403             }
404             last SWITCH;
405         }
406     } # end of SWITCH block
407
408     (@paramsloop) and $template->param( paramsloop => \@paramsloop );
409     $showadd      and $template->param( showadd    => 1 );
410     my @shelvesloop;
411     my @shelveslooppriv;
412     my $numberCanManage = 0;
413
414     # rebuild shelflist in case a shelf has been added
415     ( $shelflist, $totshelves ) = GetShelves( $category, $shelveslimit, $shelvesoffset, $loggedinuser ) unless $delflag;
416     foreach my $element ( sort { lc( $shelflist->{$a}->{'shelfname'} ) cmp lc( $shelflist->{$b}->{'shelfname'} ) } keys %$shelflist ) {
417         my %line;
418         $shelflist->{$element}->{shelf} = $element;
419         my $category  = $shelflist->{$element}->{'category'};
420         my $owner     = $shelflist->{$element}->{'owner'}||0;
421         my $canmanage = ShelfPossibleAction( $loggedinuser, $element, 'manage' );
422         my $sortfield = $shelflist->{$element}->{'sortfield'};
423         if ( $sortfield ){
424             if ( $sortfield eq 'author' ) {
425                 $shelflist->{$element}->{"authorsort"} = 'author';
426             } elsif ( $sortfield eq 'year' ) {
427                 $shelflist->{$element}->{"yearsort"} = 'year';
428             }
429         }
430         $shelflist->{$element}->{"viewcategory$category"} = 1;
431         $shelflist->{$element}->{manageshelf} = $canmanage;
432         if($canmanage || ($loggedinuser && $owner==$loggedinuser)) {
433             $shelflist->{$element}->{'mine'} = 1;
434         }
435         my $member = GetMember( 'borrowernumber' => $owner );
436         $shelflist->{$element}->{ownername} = defined($member) ? $member->{firstname} . " " . $member->{surname} : '';
437         $numberCanManage++ if $canmanage;    # possibly outmoded
438         if ( $shelflist->{$element}->{'category'} eq '1' ) {
439             push( @shelveslooppriv, $shelflist->{$element} );
440         } else {
441             push( @shelvesloop, $shelflist->{$element} );
442         }
443     }
444
445     my $url = $type eq 'opac' ? "/cgi-bin/koha/opac-shelves.pl" : "/cgi-bin/koha/virtualshelves/shelves.pl";
446     my %qhash = ();
447     foreach (qw(display viewshelf sortfield sort direction)) {
448         $qhash{$_} = $query->param($_) if $query->param($_);
449     }
450     ( scalar keys %qhash ) and $url .= '?' . join '&', map { "$_=$qhash{$_}" } keys %qhash;
451     if ( $shelfnumber && $totitems ) {
452         $template->param(  pagination_bar => pagination_bar( $url, ( int( $totitems / $shelflimit ) ) + ( ( $totitems % $shelflimit ) > 0 ? 1 : 0 ), $itemoff, "itemoff" )  );
453     } elsif ( $totshelves ) {
454         $template->param(
455              pagination_bar => pagination_bar( $url, ( int( $totshelves / $shelveslimit ) ) + ( ( $totshelves % $shelveslimit ) > 0 ? 1 : 0 ), $shelfoff, "shelfoff" )  );
456     }
457     $template->param(
458         shelveslooppriv                                                    => \@shelveslooppriv,
459         shelvesloop                                                        => \@shelvesloop,
460         shelvesloopall                                                     => [ ( @shelvesloop, @shelveslooppriv ) ],
461         numberCanManage                                                    => $numberCanManage,
462         "BiblioDefaultView" . C4::Context->preference("BiblioDefaultView") => 1,
463         csv_profiles                                                       => GetCsvProfilesLoop()
464     );
465     if (   $shelfnumber
466         or $shelves
467         or $edit ) {
468         $template->param( vseflag => 1 );
469     }
470     if ($shelves or    # note: this part looks duplicative, but is intentional
471         $edit
472       ) {
473         $template->param( seflag => 1 );
474         #This hack is just another argument for refactoring this script one day
475         #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
476         $template->param( allow_add => 0, allow_delete_own => 1, allow_delete_other => 0) unless $shelfnumber;
477     }
478
479 #Next call updates the shelves for the Lists button.
480 #May not always be needed (when nothing changed), but doesn't take much.
481     my ($total, $pubshelves, $barshelves) = C4::VirtualShelves::GetSomeShelfNames($loggedinuser, 'MASTHEAD');
482     $template->param(
483             barshelves     => $total->{bartotal},
484             barshelvesloop => $barshelves,
485             pubshelves     => $total->{pubtotal},
486             pubshelvesloop => $pubshelves,
487     );
488
489     output_html_with_http_headers $query, $cookie, $template->output;
490 }
491
492 1;
493 __END__
494
495 =head1 NAME
496
497 VirtualShelves/Page.pm
498
499 =head1 DESCRIPTION
500
501 Module used for both OPAC and intranet pages.
502
503 =head1 CGI PARAMETERS
504
505 =over 4
506
507 =item C<modifyshelfcontents>
508
509 If this script has to modify the shelf content.
510
511 =item C<shelfnumber>
512
513 To know on which shelf to work.
514
515 =item C<addbarcode>
516
517 =item C<op>
518
519  Op can be:
520     * modif: show the template allowing modification of the shelves;
521     * modifsave: save changes from modif mode.
522
523 =item C<viewshelf>
524
525 Load template with 'viewshelves param' displaying the shelf's information.
526
527 =item C<shelves>
528
529 If the param shelves == 1, then add or delete a shelf.
530
531 =item C<addshelf>
532
533 If the param shelves == 1, then addshelf is the name of the shelf to add.
534
535 =back
536
537 =cut