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 = 1.01;
  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                 };
 191                 if($query->param('category')) { #optional
 192                     $shelf->{category}= $query->param('category');
 193                 }
 194                 unless(ModShelf($shelfnumber, $shelf )) {
 195                   push @paramsloop, {modifyfailure => $shelf->{shelfname}};
 196                   last SWITCH;
 197                 }
 198
 199                 if($displaymode eq "viewshelf"){
 200                     print $query->redirect( $pages{$type}->{redirect} . "?viewshelf=$shelfnumber" );
 201                 } elsif($displaymode eq "publicshelves"){
 202                     print $query->redirect( $pages{$type}->{redirect} );
 203                 } else {
 204                     print $query->redirect( $pages{$type}->{redirect} . "?display=privateshelves" );
 205                 }
 206                 exit;
 207             }
 208         #Editing a shelf
 209         elsif ( $op eq 'modif' ) {
 210                 my ( $shelfnumber2, $shelfname, $owner, $category, $sortfield ) = GetShelf($shelfnumber);
 211                 my $member = GetMember( 'borrowernumber' => $owner );
 212                 my $ownername = defined($member) ? $member->{firstname} . " " . $member->{surname} : '';
 213                 $edit = 1;
 214                 $sortfield='' unless $sortfield;
 215                 $template->param(
 216                     edit                => 1,
 217                     display             => $displaymode,
 218                     shelfnumber         => $shelfnumber2,
 219                     shelfname           => $shelfname,
 220                     owner               => $owner,
 221                     ownername           => $ownername,
 222                     "category$category" => 1,
 223                     category            => $category,
 224                     "sort_$sortfield"   => 1,
 225                 );
 226             }
 227             last SWITCH;
 228         }
 229
 230         #View a shelf
 231         if ( $shelfnumber = $query->param('viewshelf') ) {
 232             # explicitly fetch this shelf
 233             my ($shelfnumber2,$shelfname,$owner,$category,$sorton) = GetShelf($shelfnumber);
 234
 235             $template->param( 'AllowOnShelfHolds' => C4::Context->preference('AllowOnShelfHolds') );
 236             if (C4::Context->preference('TagsEnabled')) {
 237                 $template->param(TagsEnabled => 1);
 238                     foreach (qw(TagsShowOnList TagsInputOnList)) {
 239                     C4::Context->preference($_) and $template->param($_ => 1);
 240                 }
 241             }
 242             #check that the user can view the shelf
 243             if ( ShelfPossibleAction( $loggedinuser, $shelfnumber, 'view' ) ) {
 244                 my $items;
 245                 my $authorsort;
 246                 my $yearsort;
 247                 my $tag_quantity;
 248                 my $sortfield = ( $query->param('sortfield') ? $query->param('sortfield') : 'title' );
 249                 if ( $sortfield eq 'author' ) {
 250                     $authorsort = 'author';
 251                 }
 252                 if ( $sortfield eq 'year' ) {
 253                     $yearsort = 'year';
 254                 }
 255                 ( $items, $totitems ) = GetShelfContents( $shelfnumber, $shelflimit, $shelfoffset );
 256                 for my $this_item (@$items) {
 257                     my $biblionumber = $this_item->{'biblionumber'};
 258                     my $record = GetMarcBiblio($biblionumber);
 259                     $this_item->{XSLTBloc} =
 260                         XSLTParse4Display($biblionumber, $record, "OPACXSLTResultsDisplay")
 261                             if C4::Context->preference("OPACXSLTResultsDisplay") && $type eq 'opac';
 262
 263                     # the virtualshelfcontents table does not store these columns nor are they retrieved from the items
 264                     # and itemtypes tables, so I'm commenting them out for now to quiet the log -crn
 265                     #$this_item->{imageurl} = $imgdir."/".$itemtypes->{ $this_item->{itemtype}  }->{'imageurl'};
 266                     #$this_item->{'description'} = $itemtypes->{ $this_item->{itemtype} }->{'description'};
 267                     $this_item->{'dateadded'} = format_date( $this_item->{'dateadded'} );
 268                     $this_item->{'imageurl'}  = getitemtypeinfo( $this_item->{'itemtype'} )->{'imageurl'};
 269                     $this_item->{'coins'}     = GetCOinSBiblio( $record );
 270                     $this_item->{'subtitle'} = GetRecordValue('subtitle', $record, GetFrameworkCode($this_item->{'biblionumber'}));
 271                     $this_item->{'normalized_upc'}  = GetNormalizedUPC(       $record,$marcflavour);
 272                     $this_item->{'normalized_ean'}  = GetNormalizedEAN(       $record,$marcflavour);
 273                     $this_item->{'normalized_oclc'} = GetNormalizedOCLCNumber($record,$marcflavour);
 274                     $this_item->{'normalized_isbn'} = GetNormalizedISBN(undef,$record,$marcflavour);
 275                     # Getting items infos for location display
 276                     my @items_infos = &GetItemsLocationInfo( $this_item->{'biblionumber'});
 277                     $this_item->{'itemsissued'} = CountItemsIssued( $this_item->{'biblionumber'} );
 278                     $this_item->{'ITEM_RESULTS'} = \@items_infos;
 279                     if ( grep {$_ eq $biblionumber} @cart_list) {
 280                         $this_item->{'incart'} = 1;
 281                     }
 282
 283                     if (C4::Context->preference('TagsEnabled') and $tag_quantity = C4::Context->preference('TagsShowOnList')) {
 284                         $this_item->{'TagLoop'} = get_tags({
 285                             biblionumber=>$this_item->{'biblionumber'}, approved=>1, 'sort'=>'-weight',
 286                             limit=>$tag_quantity
 287                             });
 288                     }
 289
 290                 }
 291                 push @paramsloop, { display => 'privateshelves' } if $category == 1;
 292                 $showadd = 1;
 293                 my $i = 0;
 294                 my $manageshelf = ShelfPossibleAction( $loggedinuser, $shelfnumber, 'manage' );
 295                 $template->param(
 296                     shelfname           => $shelfname,
 297                     shelfnumber         => $shelfnumber,
 298                     viewshelf           => $shelfnumber,
 299                     authorsort          => $authorsort,
 300                     yearsort            => $yearsort,
 301                     manageshelf         => $manageshelf,
 302                     allowremovingitems  => ShelfPossibleAction( $loggedinuser, $shelfnumber, 'delete'),
 303                     allowaddingitem     => ShelfPossibleAction( $loggedinuser, $shelfnumber, 'add'),
 304                     "category$category" => 1,
 305                     category            => $category,
 306                     itemsloop           => $items,
 307                     showprivateshelves  => $category==1,
 308                 );
 309             } else {
 310                 push @paramsloop, { nopermission => $shelfnumber };
 311             }
 312             last SWITCH;
 313         }
 314
 315         if ( $query->param('shelves') ) {
 316             my $stay = 1;
 317
 318         #Add a shelf
 319             if ( my $newshelf = $query->param('addshelf') ) {
 320
 321                 # note: a user can always add a new shelf
 322                 my $shelfnumber = AddShelf( {
 323                     shelfname => $newshelf,
 324                     sortfield => $query->param('sortfield'),
 325                     category => $query->param('category') },
 326                     $query->param('owner') );
 327                 $stay = 1;
 328                 if ( $shelfnumber == -1 ) {    #shelf already exists.
 329                     $showadd = 1;
 330                     push @paramsloop, { already => $newshelf };
 331                     $template->param( shelfnumber => $shelfnumber );
 332                 } else {
 333                     print $query->redirect( $pages{$type}->{redirect} . "?viewshelf=$shelfnumber" );
 334                     exit;
 335                 }
 336             }
 337
 338         #Deleting a shelf (asking for confirmation if it has entries)
 339             foreach ( $query->param() ) {
 340                 /DEL-(\d+)/ or next;
 341                 $delflag = 1;
 342                 my $number = $1;
 343                 unless ( defined $shelflist->{$number} || defined $privshelflist->{$number} ) {
 344                     push( @paramsloop, { unrecognized => $number } );
 345                     last;
 346                 }
 347                 unless ( ShelfPossibleAction( $loggedinuser, $number, 'manage' ) ) {
 348                     push( @paramsloop, { nopermission => $shelfnumber } );
 349                     last;
 350                 }
 351                 my $contents;
 352                 ( $contents, $totshelves ) = GetShelfContents( $number, $shelveslimit, $shelvesoffset );
 353                 if ( my $count = scalar @$contents ) {
 354                     unless ( scalar grep { /^CONFIRM-$number$/ } $query->param() ) {
 355                         if ( defined $shelflist->{$number} ) {
 356                             push( @paramsloop, { need_confirm => $shelflist->{$number}->{shelfname}, count => $count, single => ($count eq 1 ? 1:0) } );
 357                             $shelflist->{$number}->{confirm} = $number;
 358                         } else {
 359                             push( @paramsloop, { need_confirm => $privshelflist->{$number}->{shelfname}, count => $count } );
 360                             $privshelflist->{$number}->{confirm} = $number;
 361                         }
 362                         $stay = 0;
 363                         next;
 364                     }
 365                 }
 366                 my $name;
 367                 if ( defined $shelflist->{$number} ) {
 368                     $name = $shelflist->{$number}->{'shelfname'};
 369                     delete $shelflist->{$number};
 370                 } else {
 371                     $name = $privshelflist->{$number}->{'shelfname'};
 372                     delete $privshelflist->{$number};
 373                 }
 374                 unless ( DelShelf($number) ) {
 375                     push( @paramsloop, { delete_fail => $name } );
 376                     last;
 377                 }
 378                 push( @paramsloop, { delete_ok => $name } );
 379
 380                 $stay = 0;
 381             }
 382             $showadd = 1;
 383             if ($stay){
 384                 $template->param( shelves => 1 );
 385                 $shelves = 1;
 386             }
 387             last SWITCH;
 388         }
 389     } # end of SWITCH block
 390
 391     (@paramsloop) and $template->param( paramsloop => \@paramsloop );
 392     $showadd      and $template->param( showadd    => 1 );
 393     my @shelvesloop;
 394     my @shelveslooppriv;
 395     my $numberCanManage = 0;
 396
 397     # rebuild shelflist in case a shelf has been added
 398     ( $shelflist, $totshelves ) = GetShelves( $category, $shelveslimit, $shelvesoffset, $loggedinuser ) unless $delflag;
 399     foreach my $element ( sort { lc( $shelflist->{$a}->{'shelfname'} ) cmp lc( $shelflist->{$b}->{'shelfname'} ) } keys %$shelflist ) {
 400         my %line;
 401         $shelflist->{$element}->{shelf} = $element;
 402         my $category  = $shelflist->{$element}->{'category'};
 403         my $owner     = $shelflist->{$element}->{'owner'}||0;
 404         my $canmanage = ShelfPossibleAction( $loggedinuser, $element, 'manage' );
 405         my $sortfield = $shelflist->{$element}->{'sortfield'};
 406         if ( $sortfield ){
 407             if ( $sortfield eq 'author' ) {
 408                 $shelflist->{$element}->{"authorsort"} = 'author';
 409             } elsif ( $sortfield eq 'year' ) {
 410                 $shelflist->{$element}->{"yearsort"} = 'year';
 411             }
 412         }
 413         $shelflist->{$element}->{"viewcategory$category"} = 1;
 414         $shelflist->{$element}->{manageshelf} = $canmanage;
 415         if($canmanage || ($loggedinuser && $owner==$loggedinuser)) {
 416             $shelflist->{$element}->{'mine'} = 1;
 417         }
 418         my $member = GetMember( 'borrowernumber' => $owner );
 419         $shelflist->{$element}->{ownername} = defined($member) ? $member->{firstname} . " " . $member->{surname} : '';
 420         $numberCanManage++ if $canmanage;    # possibly outmoded
 421         if ( $shelflist->{$element}->{'category'} eq '1' ) {
 422             push( @shelveslooppriv, $shelflist->{$element} );
 423         } else {
 424             push( @shelvesloop, $shelflist->{$element} );
 425         }
 426     }
 427
 428     my $url = $type eq 'opac' ? "/cgi-bin/koha/opac-shelves.pl" : "/cgi-bin/koha/virtualshelves/shelves.pl";
 429     my %qhash = ();
 430     foreach (qw(display viewshelf sortfield)) {
 431         $qhash{$_} = $query->param($_) if $query->param($_);
 432     }
 433     ( scalar keys %qhash ) and $url .= '?' . join '&', map { "$_=$qhash{$_}" } keys %qhash;
 434     if ( $shelfnumber && $totitems ) {
 435         $template->param(  pagination_bar => pagination_bar( $url, ( int( $totitems / $shelflimit ) ) + ( ( $totitems % $shelflimit ) > 0 ? 1 : 0 ), $itemoff, "itemoff" )  );
 436     } elsif ( $totshelves ) {
 437         $template->param(
 438              pagination_bar => pagination_bar( $url, ( int( $totshelves / $shelveslimit ) ) + ( ( $totshelves % $shelveslimit ) > 0 ? 1 : 0 ), $shelfoff, "shelfoff" )  );
 439     }
 440     $template->param(
 441         shelveslooppriv                                                    => \@shelveslooppriv,
 442         shelvesloop                                                        => \@shelvesloop,
 443         shelvesloopall                                                     => [ ( @shelvesloop, @shelveslooppriv ) ],
 444         numberCanManage                                                    => $numberCanManage,
 445         "BiblioDefaultView" . C4::Context->preference("BiblioDefaultView") => 1,
 446         csv_profiles                                                       => GetCsvProfilesLoop()
 447     );
 448     if (   $shelfnumber
 449         or $shelves
 450         or $edit ) {
 451         $template->param( vseflag => 1 );
 452     }
 453     if ($shelves or    # note: this part looks duplicative, but is intentional
 454         $edit
 455       ) {
 456         $template->param( seflag => 1 );
 457     }
 458
 459 #Next call updates the shelves for the Lists button.
 460 #May not always be needed (when nothing changed), but doesn't take much.
 461     my ($total, $pubshelves, $barshelves) = C4::VirtualShelves::GetSomeShelfNames($loggedinuser, 'MASTHEAD');
 462     $template->param(
 463             barshelves     => $total->{bartotal},
 464             barshelvesloop => $barshelves,
 465             pubshelves     => $total->{pubtotal},
 466             pubshelvesloop => $pubshelves,
 467     );
 468
 469     output_html_with_http_headers $query, $cookie, $template->output;
 470 }
 471
 472 1;
 473 __END__
 474
 475 =head1 NAME
 476
 477 VirtualShelves/Page.pm
 478
 479 =head1 DESCRIPTION
 480
 481 Module used for both OPAC and intranet pages.
 482
 483 =head1 CGI PARAMETERS
 484
 485 =over 4
 486
 487 =item C<modifyshelfcontents>
 488
 489 If this script has to modify the shelf content.
 490
 491 =item C<shelfnumber>
 492
 493 To know on which shelf to work.
 494
 495 =item C<addbarcode>
 496
 497 =item C<op>
 498
 499  Op can be:
 500     * modif: show the template allowing modification of the shelves;
 501     * modifsave: save changes from modif mode.
 502
 503 =item C<viewshelf>
 504
 505 Load template with 'viewshelves param' displaying the shelf's information.
 506
 507 =item C<shelves>
 508
 509 If the param shelves == 1, then add or delete a shelf.
 510
 511 =item C<addshelf>
 512
 513 If the param shelves == 1, then addshelf is the name of the shelf to add.
 514
 515 =back
 516
 517 =cut