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 with
  18 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  19 # Suite 330, Boston, MA  02111-1307 USA
  20
  21 # perldoc at the end of the file, per convention.
  22
  23 use strict;
  24 use warnings;
  25 use CGI;
  26 use C4::VirtualShelves qw/:DEFAULT GetShelvesSummary/;
  27 use C4::Biblio;
  28 use C4::Items;
  29 use C4::Koha;
  30 use C4::Auth qw/get_session/;
  31 use C4::Members;
  32 use C4::Output;
  33 use C4::Date qw/format_date/;
  34 use Exporter;
  35
  36 use vars qw($debug @EXPORT @ISA $VERSION);
  37
  38 BEGIN {
  39         $VERSION = 1.01;
  40         @ISA = qw(Exporter);
  41         @EXPORT = qw(&shelfpage);
  42     $debug = $ENV{DEBUG} || 0;
  43 }
  44
  45 our %pages = (
  46         intranet => {
  47                 redirect=>'/cgi-bin/koha/virtualshelves/shelves.pl',
  48         },
  49         opac => {
  50                 redirect=>'/cgi-bin/koha/opac-shelves.pl',
  51         },
  52 );
  53
  54 sub shelfpage ($$$$$) {
  55         my ($type, $query, $template, $loggedinuser, $cookie ) = @_;
  56         ($pages{$type}) or $type = 'opac';
  57         $query or die "No query";
  58         $template or die "No template";
  59         $template->param( { loggedinuser => $loggedinuser } );
  60         my @paramsloop;
  61         # getting the Shelves list
  62         my $shelflist = GetShelves( $loggedinuser, 2 );
  63         my $op = $query->param('op');
  64     my $imgdir = getitemtypeimagesrc();
  65     my $itemtypes = GetItemTypes();
  66
  67 # the format of this is unindented for ease of diff comparison to the old script
  68 # Note: do not mistake the assignment statements below for comparisons!
  69
  70 if ( $query->param('modifyshelfcontents') ) {
  71         my ($shelfnumber,$barcode,$item,$biblio);
  72     if ($shelfnumber = $query->param('viewshelf')) {
  73         if (ShelfPossibleAction($loggedinuser, $shelfnumber, 'manage')) {
  74                 if ($barcode = $query->param('addbarcode')) {
  75                         if ($item = GetItem( 0, $barcode )) {
  76                                 $biblio = GetBiblioFromItemNumber($item->{'itemnumber'});
  77                                 AddToShelf($biblio->{'biblionumber'}, $shelfnumber) or
  78                                                 push @paramsloop, {duplicatebiblio=>$barcode};
  79                                 } else { push @paramsloop, {failgetitem=>$barcode}; }
  80                 } else {
  81                                 (grep {/REM-(\d+)/} $query->param) or push @paramsloop, {nobarcode=>1};
  82                         foreach ($query->param) {
  83                                         /REM-(\d+)/ or next;
  84                                         $debug and warn
  85                                                 "SHELVES: user $loggedinuser removing item $1 from shelf $shelfnumber";
  86                                         DelFromShelf($1, $shelfnumber);  # $1 is biblionumber
  87                                 }
  88                         }
  89                 } else { push @paramsloop, {nopermission=>$shelfnumber}; }
  90     } else { push @paramsloop, {noshelfnumber=>1}; }
  91 }
  92
  93 my $showadd = 1;
  94 # set the default tab, etc. (for OPAC)
  95 my $shelf_type = $query->param('display');
  96 if (defined $shelf_type) {
  97         if ($shelf_type eq 'privateshelves')  {
  98                 $template->param(showprivateshelves => 1);
  99         } elsif ($shelf_type eq 'publicshelves') {
 100                 $template->param(showpublicshelves => 1);
 101                 $showadd = 0;
 102         } else {
 103                 $debug and warn "Invalid 'display' param ($shelf_type)";
 104         }
 105 } else {
 106         $template->param(showprivateshelves => 1);
 107 }
 108
 109 my($okmanage, $okview);
 110 my $shelfnumber = $query->param('shelfnumber') || $query->param('viewshelf');
 111 if ($shelfnumber) {
 112         $okmanage = &ShelfPossibleAction( $loggedinuser, $shelfnumber, 'manage' );
 113         $okview   = &ShelfPossibleAction( $loggedinuser, $shelfnumber, 'view' );
 114 }
 115
 116 SWITCH: {
 117         if ( $op ) {
 118                 unless ($okmanage) {
 119                         push @paramsloop, {nopermission=>$shelfnumber};
 120                         last SWITCH;
 121                 }
 122                 if ( $op eq 'modifsave' ) {
 123                         my $shelf = {
 124                         'shelfname'             => $query->param('shelfname'),
 125                                 'category'              => $query->param('category'),
 126                                 'sortfield'             => $query->param('sortfield'),
 127                         };
 128                         $shelf->{'owner'} = $loggedinuser if $type eq 'intranet';       #we only overwrite the list owner if &ModShelf was called from the staff client
 129
 130                         ModShelf( $shelfnumber, $shelf );
 131                         $shelflist = GetShelves( $loggedinuser, 2 );    # refresh after mods
 132
 133                 } elsif ( $op eq 'modif' ) {
 134                         my ( $shelfnumber2, $shelfname, $owner, $category, $sortfield ) =GetShelf( $shelfnumber );
 135                         $template->param(
 136                                 edit                => 1,
 137                                 shelfnumber         => $shelfnumber2,
 138                                 shelfname           => $shelfname,
 139                                 owner               => $owner,
 140                                 "category$category"     => 1,
 141                                 category                        => $category,
 142                                 "sort_$sortfield"   => 1,
 143                         );
 144                 }
 145                 last SWITCH;
 146         }
 147     if ($shelfnumber = $query->param('viewshelf') ) {
 148         #check that the user can view the shelf
 149                 if ( ShelfPossibleAction( $loggedinuser, $shelfnumber, 'view' ) ) {
 150                         my $items = GetShelfContents($shelfnumber);
 151                         for my $this_item (@$items) {
 152                                 $this_item->{imageurl} = $imgdir."/".$itemtypes->{ $this_item->{itemtype}  }->{'imageurl'};
 153                                 $this_item->{'description'} = $itemtypes->{ $this_item->{itemtype} }->{'description'};
 154                                 $this_item->{'dateadded'} = format_date($this_item->{'dateadded'});
 155                         }
 156                         $showadd = 1;
 157                         my $i = 0;
 158                         foreach (grep {$i++ % 2} @$items) {     # every other item
 159                                 $_->{toggle} = 1;
 160                         }
 161                         # my $manageshelf = &ShelfPossibleAction( $loggedinuser, $shelfnumber, 'manage' );
 162                         # ($manageshelf) and $showadd = 1;
 163                         $template->param(
 164                                 shelfname   => $shelflist->{$shelfnumber}->{'shelfname'},
 165                                 shelfnumber => $shelfnumber,
 166                                 viewshelf   => $shelfnumber,
 167                                 manageshelf => &ShelfPossibleAction( $loggedinuser, $shelfnumber, 'manage' ),
 168                                 itemsloop => $items,
 169                         );
 170                 } else { push @paramsloop, {nopermission=>$shelfnumber} };
 171         last SWITCH;
 172     }
 173     if ( $query->param('shelves') ) {
 174                 my $stay = 1;
 175         if (my $newshelf = $query->param('addshelf')) {
 176                         # note: a user can always add a new shelf
 177             my $shelfnumber = AddShelf(
 178                 $newshelf,
 179                 $query->param('owner'),
 180                 $query->param('category')
 181             );
 182                         $stay = 1;
 183             if ( $shelfnumber == -1 ) {    #shelf already exists.
 184                                 $showadd = 1;
 185                                 push @paramsloop, { already => $newshelf };
 186                 $template->param(shelfnumber => $shelfnumber);
 187             } else {
 188                 print $query->redirect($pages{$type}->{redirect} . "?viewshelf=$shelfnumber");
 189                 exit;
 190                         }
 191         }
 192                 foreach ($query->param()) {
 193                         /DEL-(\d+)/ or next;
 194                         my $number = $1;
 195                         unless (defined $shelflist->{$number}) {
 196                                 push(@paramsloop, {unrecognized=>$number}); last;
 197                         }
 198                         unless (ShelfPossibleAction($loggedinuser, $number, 'manage')) {
 199                                 push(@paramsloop, {nopermission=>$shelfnumber}); last;
 200                         }
 201                         my $contents = GetShelfContents($number);
 202                         if (my $count = scalar @$contents){
 203                                 unless (scalar grep {/^CONFIRM-$number$/} $query->param()) {
 204                                         push(@paramsloop, {need_confirm=>$shelflist->{$number}->{shelfname}, count=>$count});
 205                                         $shelflist->{$number}->{confirm} = $number;
 206                                         $stay = 0;
 207                                         next;
 208                                 }
 209                         }
 210                         my $name = $shelflist->{$number}->{'shelfname'};
 211                         unless (DelShelf($number)) {
 212                                 push(@paramsloop, {delete_fail=>$name}); last;
 213                         }
 214                         delete $shelflist->{$number};
 215                         push(@paramsloop, {delete_ok=>$name});
 216                         # print $query->redirect($pages{$type}->{redirect}); exit;
 217                         $stay = 0;
 218                 }
 219                 $showadd = 1;
 220                 $stay and $template->param(shelves => 1);
 221                 last SWITCH;
 222         }
 223 }
 224
 225 (@paramsloop) and $template->param(paramsloop => \@paramsloop);
 226 # rebuild shelflist in case a shelf has been added
 227 # $shelflist = GetShelves( $loggedinuser, 2 );
 228 $showadd and $template->param(showadd => 1);
 229 my @shelvesloop;
 230 my @shelveslooppriv;
 231 my $numberCanManage = 0;
 232
 233 foreach my $element (sort { lc($shelflist->{$a}->{'shelfname'}) cmp lc($shelflist->{$b}->{'shelfname'}) } keys %$shelflist) {
 234         my %line;
 235         $shelflist->{$element}->{shelf} = $element;
 236         my $category = $shelflist->{$element}->{'category'};
 237         my $owner    = $shelflist->{$element}->{ 'owner'  };
 238         my $canmanage = ShelfPossibleAction( $loggedinuser, $element, 'manage' );
 239         $shelflist->{$element}->{"viewcategory$category"} = 1;
 240         $shelflist->{$element}->{canmanage} = $canmanage;
 241         if ($owner eq $loggedinuser or $canmanage) {
 242                 $shelflist->{$element}->{'mine'} = 1;
 243         }
 244         my $member = GetMember($owner,'borrowernumber');
 245         $shelflist->{$element}->{ownername} = defined($member) ? $member->{firstname} . " " . $member->{surname} : '';
 246         $numberCanManage++ if $canmanage;       # possibly outmoded
 247         if ($shelflist->{$element}->{'category'} eq '1') {
 248                 (scalar(@shelveslooppriv) % 2) and $shelflist->{$element}->{toggle} = 1;
 249                 push (@shelveslooppriv, $shelflist->{$element});
 250         } else {
 251                 (scalar(@shelvesloop)     % 2) and $shelflist->{$element}->{toggle} = 1;
 252                 push (@shelvesloop, $shelflist->{$element});
 253         }
 254 }
 255
 256 $template->param(
 257     shelveslooppriv => \@shelveslooppriv,
 258     shelvesloop     => \@shelvesloop,
 259     shelvesloopall  => [(@shelvesloop, @shelveslooppriv)],
 260     numberCanManage => $numberCanManage,
 261         "BiblioDefaultView".C4::Context->preference("BiblioDefaultView") => 1,
 262 );
 263 if ($template->param('viewshelf') or
 264         $template->param( 'shelves' ) or
 265         $template->param(  'edit'   ) ) {
 266         $template->param(vseflag => 1);
 267 }
 268 if ($template->param( 'shelves' ) or
 269         $template->param(  'edit'   ) ) {
 270         $template->param( seflag => 1);
 271 }
 272
 273 my $sessionID = $query->cookie("CGISESSID") ;
 274 my $session = get_session($sessionID);
 275 my $barshelves = GetShelvesSummary($loggedinuser, 2, 10);
 276 if (defined($barshelves)) {
 277         $session->param('barshelves', $barshelves);
 278         $template->param( barshelves     => scalar (@$barshelves));
 279         $template->param( barshelvesloop => $barshelves);
 280 }
 281
 282 output_html_with_http_headers $query, $cookie, $template->output;
 283 }
 284
 285 1;
 286 __END__
 287
 288 =head1 NAME
 289
 290     VirtualShelves/Page.pm
 291
 292 =head1 DESCRIPTION
 293
 294     Module used for both OPAC and intranet pages.
 295
 296 =head1 CGI PARAMETERS
 297
 298 =over 4
 299
 300 =item C<modifyshelfcontents>
 301
 302     If this script has to modify the shelf content.
 303
 304 =item C<shelfnumber>
 305
 306     To know on which shelf to work.
 307
 308 =item C<addbarcode>
 309
 310 =item C<op>
 311
 312     Op can be:
 313         * modif: show the template allowing modification of the shelves;
 314         * modifsave: save changes from modif mode.
 315
 316 =item C<viewshelf>
 317
 318     Load template with 'viewshelves param' displaying the shelf's information.
 319
 320 =item C<shelves>
 321
 322     If the param shelves == 1, then add or delete a shelf.
 323
 324 =item C<addshelf>
 325
 326     If the param shelves == 1, then addshelf is the name of the shelf to add.
 327
 328 =back
 329
 330 =cut