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::Dates 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
 129                         ModShelf( $shelfnumber, $shelf );
 130                         $shelflist = GetShelves( $loggedinuser, 2 );    # refresh after mods; this also retrieves all public shelves
 131
 132                 } elsif ( $op eq 'modif' ) {
 133                         my ( $shelfnumber2, $shelfname, $owner, $category, $sortfield ) =GetShelf( $shelfnumber );
 134                         my $member = GetMember($owner,'borrowernumber');
 135                         my $ownername = defined($member) ? $member->{firstname} . " " . $member->{surname} : '';
 136                         $template->param(
 137                                 edit                => 1,
 138                                 shelfnumber         => $shelfnumber2,
 139                                 shelfname           => $shelfname,
 140                                 owner               => $owner,
 141                                 ownername                       => $ownername,
 142                                 "category$category"     => 1,
 143                                 category                        => $category,
 144                                 "sort_$sortfield"   => 1,
 145                         );
 146                 }
 147                 last SWITCH;
 148         }
 149     if ($shelfnumber = $query->param('viewshelf') ) {
 150         #check that the user can view the shelf
 151                 if ( ShelfPossibleAction( $loggedinuser, $shelfnumber, 'view' ) ) {
 152                         my $items = GetShelfContents($shelfnumber);
 153                         for my $this_item (@$items) {
 154                                 $this_item->{imageurl} = $imgdir."/".$itemtypes->{ $this_item->{itemtype}  }->{'imageurl'};
 155                                 $this_item->{'description'} = $itemtypes->{ $this_item->{itemtype} }->{'description'};
 156                                 $this_item->{'dateadded'} = format_date($this_item->{'dateadded'});
 157                         }
 158                         $showadd = 1;
 159                         my $i = 0;
 160                         foreach (grep {$i++ % 2} @$items) {     # every other item
 161                                 $_->{toggle} = 1;
 162                         }
 163                         # my $manageshelf = &ShelfPossibleAction( $loggedinuser, $shelfnumber, 'manage' );
 164                         # ($manageshelf) and $showadd = 1;
 165                         $template->param(
 166                                 shelfname   => $shelflist->{$shelfnumber}->{'shelfname'},
 167                                 shelfnumber => $shelfnumber,
 168                                 viewshelf   => $shelfnumber,
 169                                 manageshelf => &ShelfPossibleAction( $loggedinuser, $shelfnumber, 'manage' ),
 170                                 itemsloop => $items,
 171                         );
 172                 } else { push @paramsloop, {nopermission=>$shelfnumber} };
 173         last SWITCH;
 174     }
 175     if ( $query->param('shelves') ) {
 176                 my $stay = 1;
 177         if (my $newshelf = $query->param('addshelf')) {
 178                         # note: a user can always add a new shelf
 179             my $shelfnumber = AddShelf(
 180                 $newshelf,
 181                 $query->param('owner'),
 182                 $query->param('category')
 183             );
 184                         $stay = 1;
 185             if ( $shelfnumber == -1 ) {    #shelf already exists.
 186                                 $showadd = 1;
 187                                 push @paramsloop, { already => $newshelf };
 188                 $template->param(shelfnumber => $shelfnumber);
 189             } else {
 190                 print $query->redirect($pages{$type}->{redirect} . "?viewshelf=$shelfnumber");
 191                 exit;
 192                         }
 193         }
 194                 foreach ($query->param()) {
 195                         /DEL-(\d+)/ or next;
 196                         my $number = $1;
 197                         unless (defined $shelflist->{$number}) {
 198                                 push(@paramsloop, {unrecognized=>$number}); last;
 199                         }
 200                         unless (ShelfPossibleAction($loggedinuser, $number, 'manage')) {
 201                                 push(@paramsloop, {nopermission=>$shelfnumber}); last;
 202                         }
 203                         my $contents = GetShelfContents($number);
 204                         if (my $count = scalar @$contents){
 205                                 unless (scalar grep {/^CONFIRM-$number$/} $query->param()) {
 206                                         push(@paramsloop, {need_confirm=>$shelflist->{$number}->{shelfname}, count=>$count});
 207                                         $shelflist->{$number}->{confirm} = $number;
 208                                         $stay = 0;
 209                                         next;
 210                                 }
 211                         }
 212                         my $name = $shelflist->{$number}->{'shelfname'};
 213                         unless (DelShelf($number)) {
 214                                 push(@paramsloop, {delete_fail=>$name}); last;
 215                         }
 216                         delete $shelflist->{$number};
 217                         push(@paramsloop, {delete_ok=>$name});
 218                         # print $query->redirect($pages{$type}->{redirect}); exit;
 219                         $stay = 0;
 220                 }
 221                 $showadd = 1;
 222                 $stay and $template->param(shelves => 1);
 223                 last SWITCH;
 224         }
 225 }
 226
 227 (@paramsloop) and $template->param(paramsloop => \@paramsloop);
 228 # rebuild shelflist in case a shelf has been added
 229 # $shelflist = GetShelves( $loggedinuser, 2 );
 230 $showadd and $template->param(showadd => 1);
 231 my @shelvesloop;
 232 my @shelveslooppriv;
 233 my $numberCanManage = 0;
 234
 235 foreach my $element (sort { lc($shelflist->{$a}->{'shelfname'}) cmp lc($shelflist->{$b}->{'shelfname'}) } keys %$shelflist) {
 236         my %line;
 237         $shelflist->{$element}->{shelf} = $element;
 238         my $category = $shelflist->{$element}->{'category'};
 239         my $owner    = $shelflist->{$element}->{ 'owner'  };
 240         my $canmanage = ShelfPossibleAction( $loggedinuser, $element, 'manage' );
 241         $shelflist->{$element}->{"viewcategory$category"} = 1;
 242         $shelflist->{$element}->{canmanage} = $canmanage;
 243         if ($owner eq $loggedinuser or $canmanage) {
 244                 $shelflist->{$element}->{'mine'} = 1;
 245         }
 246         my $member = GetMember($owner,'borrowernumber');
 247         $shelflist->{$element}->{ownername} = defined($member) ? $member->{firstname} . " " . $member->{surname} : '';
 248         $numberCanManage++ if $canmanage;       # possibly outmoded
 249         if ($shelflist->{$element}->{'category'} eq '1') {
 250                 (scalar(@shelveslooppriv) % 2) and $shelflist->{$element}->{toggle} = 1;
 251                 push (@shelveslooppriv, $shelflist->{$element});
 252         } else {
 253                 (scalar(@shelvesloop)     % 2) and $shelflist->{$element}->{toggle} = 1;
 254                 push (@shelvesloop, $shelflist->{$element});
 255         }
 256 }
 257
 258 $template->param(
 259     shelveslooppriv => \@shelveslooppriv,
 260     shelvesloop     => \@shelvesloop,
 261     shelvesloopall  => [(@shelvesloop, @shelveslooppriv)],
 262     numberCanManage => $numberCanManage,
 263         "BiblioDefaultView".C4::Context->preference("BiblioDefaultView") => 1,
 264 );
 265 if ($template->param('viewshelf') or
 266         $template->param( 'shelves' ) or
 267         $template->param(  'edit'   ) ) {
 268         $template->param(vseflag => 1);
 269 }
 270 if ($template->param( 'shelves' ) or
 271         $template->param(  'edit'   ) ) {
 272         $template->param( seflag => 1);
 273 }
 274
 275 my $sessionID = $query->cookie("CGISESSID") ;
 276 my $session = get_session($sessionID);
 277 my $barshelves = GetShelvesSummary($loggedinuser, 2, 10);
 278 if (defined($barshelves)) {
 279         $session->param('barshelves', $barshelves);
 280         $template->param( barshelves     => scalar (@$barshelves));
 281         $template->param( barshelvesloop => $barshelves);
 282 }
 283
 284 output_html_with_http_headers $query, $cookie, $template->output;
 285 }
 286
 287 1;
 288 __END__
 289
 290 =head1 NAME
 291
 292     VirtualShelves/Page.pm
 293
 294 =head1 DESCRIPTION
 295
 296     Module used for both OPAC and intranet pages.
 297
 298 =head1 CGI PARAMETERS
 299
 300 =over 4
 301
 302 =item C<modifyshelfcontents>
 303
 304     If this script has to modify the shelf content.
 305
 306 =item C<shelfnumber>
 307
 308     To know on which shelf to work.
 309
 310 =item C<addbarcode>
 311
 312 =item C<op>
 313
 314     Op can be:
 315         * modif: show the template allowing modification of the shelves;
 316         * modifsave: save changes from modif mode.
 317
 318 =item C<viewshelf>
 319
 320     Load template with 'viewshelves param' displaying the shelf's information.
 321
 322 =item C<shelves>
 323
 324     If the param shelves == 1, then add or delete a shelf.
 325
 326 =item C<addshelf>
 327
 328     If the param shelves == 1, then addshelf is the name of the shelf to add.
 329
 330 =back
 331
 332 =cut