opac/opac-shelves.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright 2015 Koha Team
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use Modern::Perl;
  21
  22 use CGI qw ( -utf8 );
  23 use C4::Auth;
  24 use C4::Biblio;
  25 use C4::Koha;
  26 use C4::Items;
  27 use C4::Members;
  28 use C4::Output;
  29 use C4::Tags qw( get_tags );
  30 use C4::XSLT;
  31
  32 use Koha::Biblios;
  33 use Koha::Biblioitems;
  34 use Koha::IssuingRules;
  35 use Koha::Items;
  36 use Koha::ItemTypes;
  37 use Koha::Patrons;
  38 use Koha::Virtualshelves;
  39 use Koha::RecordProcessor;
  40
  41 use constant ANYONE => 2;
  42
  43 my $query = new CGI;
  44
  45 my $template_name = $query->param('rss') ? "opac-shelves-rss.tt" : "opac-shelves.tt";
  46
  47 # if virtualshelves is disabled, leave immediately
  48 if ( ! C4::Context->preference('virtualshelves') ) {
  49     print $query->redirect("/cgi-bin/koha/errors/404.pl");
  50     exit;
  51 }
  52
  53 my ( $template, $loggedinuser, $cookie ) = get_template_and_user({
  54         template_name   => $template_name,
  55         query           => $query,
  56         type            => "opac",
  57         authnotrequired => ( C4::Context->preference("OpacPublic") ? 1 : 0 ),
  58     });
  59
  60 my $op       = $query->param('op')       || 'list';
  61 my $referer  = $query->param('referer')  || $op;
  62 my $category = $query->param('category') || 1;
  63 my ( $shelf, $shelfnumber, @messages );
  64
  65 if ( $op eq 'add_form' ) {
  66     # Only pass default
  67     $shelf = { allow_change_from_owner => 1 };
  68 } elsif ( $op eq 'edit_form' ) {
  69     $shelfnumber = $query->param('shelfnumber');
  70     $shelf       = Koha::Virtualshelves->find($shelfnumber);
  71
  72     if ( $shelf ) {
  73         $category = $shelf->category;
  74         my $patron = Koha::Patrons->find( $shelf->owner );
  75         $template->param( owner => $patron, );
  76         unless ( $shelf->can_be_managed( $loggedinuser ) ) {
  77             push @messages, { type => 'error', code => 'unauthorized_on_update' };
  78             $op = 'list';
  79         }
  80     } else {
  81         push @messages, { type => 'error', code => 'does_not_exist' };
  82     }
  83 } elsif ( $op eq 'add' ) {
  84     if ( $loggedinuser ) {
  85         my $allow_changes_from = $query->param('allow_changes_from');
  86         eval {
  87             $shelf = Koha::Virtualshelf->new(
  88                 {   shelfname          => scalar $query->param('shelfname'),
  89                     sortfield          => scalar $query->param('sortfield'),
  90                     category           => scalar $query->param('category') || 1,
  91                     allow_change_from_owner => $allow_changes_from > 0,
  92                     allow_change_from_others => $allow_changes_from == ANYONE,
  93                     owner              => scalar $loggedinuser,
  94                 }
  95             );
  96             $shelf->store;
  97             $shelfnumber = $shelf->shelfnumber;
  98         };
  99         if ($@) {
 100             push @messages, { type => 'error', code => ref($@), msg => $@ };
 101         } elsif ( not $shelf ) {
 102             push @messages, { type => 'error', code => 'error_on_insert' };
 103         } else {
 104             push @messages, { type => 'message', code => 'success_on_insert' };
 105             $op = 'view';
 106         }
 107     } else {
 108         push @messages, { type => 'error', code => 'unauthorized_on_insert' };
 109         $op = 'list';
 110     }
 111 } elsif ( $op eq 'edit' ) {
 112     $shelfnumber = $query->param('shelfnumber');
 113     $shelf       = Koha::Virtualshelves->find($shelfnumber);
 114     if ( $shelf ) {
 115         $op = $referer;
 116         my $sortfield = $query->param('sortfield');
 117         $sortfield = 'title' unless grep {/^$sortfield$/}qw( title author copyrightdate itemcallnumber dateadded );
 118         if ( $shelf->can_be_managed( $loggedinuser ) ) {
 119             $shelf->shelfname( scalar $query->param('shelfname') );
 120             $shelf->sortfield( $sortfield );
 121             my $allow_changes_from = $query->param('allow_changes_from');
 122             $shelf->allow_change_from_owner( $allow_changes_from > 0 );
 123             $shelf->allow_change_from_others( $allow_changes_from == ANYONE );
 124             $shelf->category( scalar $query->param('category') );
 125             eval { $shelf->store };
 126
 127             if ($@) {
 128                 push @messages, { type => 'error', code => 'error_on_update' };
 129                 $op = 'edit_form';
 130             } else {
 131                 push @messages, { type => 'message', code => 'success_on_update' };
 132             }
 133         } else {
 134             push @messages, { type => 'error', code => 'unauthorized_on_update' };
 135         }
 136     } else {
 137         push @messages, { type => 'error', code => 'does_not_exist' };
 138     }
 139 } elsif ( $op eq 'delete' ) {
 140     $shelfnumber = $query->param('shelfnumber');
 141     $shelf       = Koha::Virtualshelves->find($shelfnumber);
 142     if ($shelf) {
 143         if ( $shelf->can_be_deleted( $loggedinuser ) ) {
 144             eval { $shelf->delete; };
 145             if ($@) {
 146                 push @messages, { type => 'error', code => ref($@), msg => $@ };
 147             } else {
 148                 push @messages, { type => 'message', code => 'success_on_delete' };
 149             }
 150         } else {
 151             push @messages, { type => 'error', code => 'unauthorized_on_delete' };
 152         }
 153     } else {
 154         push @messages, { type => 'error', code => 'does_not_exist' };
 155     }
 156     $op = $referer;
 157 } elsif ( $op eq 'remove_share' ) {
 158     $shelfnumber = $query->param('shelfnumber');
 159     $shelf = Koha::Virtualshelves->find($shelfnumber);
 160     if ($shelf) {
 161         my $removed = eval { $shelf->remove_share( $loggedinuser ); };
 162         if ($@) {
 163             push @messages, { type => 'error', code => ref($@), msg => $@ };
 164         } elsif ( $removed ) {
 165             push @messages, { type => 'message', code => 'success_on_remove_share' };
 166         } else {
 167             push @messages, { type => 'error', code => 'error_on_remove_share' };
 168         }
 169     } else {
 170         push @messages, { type => 'error', code => 'does_not_exist' };
 171     }
 172     $op = $referer;
 173
 174 } elsif ( $op eq 'add_biblio' ) {
 175     $shelfnumber = $query->param('shelfnumber');
 176     $shelf = Koha::Virtualshelves->find($shelfnumber);
 177     if ($shelf) {
 178         if( my $barcode = $query->param('barcode') ) {
 179             my $item = Koha::Items->find({ barcode => $barcode });
 180             if ( $item ) {
 181                 if ( $shelf->can_biblios_be_added( $loggedinuser ) ) {
 182                     my $added = eval { $shelf->add_biblio( $item->biblionumber, $loggedinuser ); };
 183                     if ($@) {
 184                         push @messages, { type => 'error', code => ref($@), msg => $@ };
 185                     } elsif ( $added ) {
 186                         push @messages, { type => 'message', code => 'success_on_add_biblio' };
 187                     } else {
 188                         push @messages, { type => 'message', code => 'error_on_add_biblio' };
 189                     }
 190                 } else {
 191                     push @messages, { type => 'error', code => 'unauthorized_on_add_biblio' };
 192                 }
 193             } else {
 194                 push @messages, { type => 'error', code => 'item_does_not_exist' };
 195             }
 196         }
 197     } else {
 198         push @messages, { type => 'error', code => 'does_not_exist' };
 199     }
 200     $op = $referer;
 201 } elsif ( $op eq 'remove_biblios' ) {
 202     $shelfnumber = $query->param('shelfnumber');
 203     $shelf = Koha::Virtualshelves->find($shelfnumber);
 204     my @biblionumber = $query->multi_param('biblionumber');
 205     if ($shelf) {
 206         if ( $shelf->can_biblios_be_removed( $loggedinuser ) ) {
 207             my $number_of_biblios_removed = eval {
 208                 $shelf->remove_biblios(
 209                     {
 210                         biblionumbers => \@biblionumber,
 211                         borrowernumber => $loggedinuser,
 212                     }
 213                 );
 214             };
 215             if ($@) {
 216                 push @messages, { type => 'error', code => ref($@), msg => $@ };
 217             } elsif ( $number_of_biblios_removed ) {
 218                 push @messages, { type => 'message', code => 'success_on_remove_biblios' };
 219             } else {
 220                 push @messages, { type => 'error', code => 'no_biblio_removed' };
 221             }
 222         } else {
 223             push @messages, { type => 'error', code => 'unauthorized_on_remove_biblios' };
 224         }
 225     } else {
 226         push @messages, { type => 'error', code => 'does_not_exist' };
 227     }
 228     $op = 'view';
 229 }
 230
 231 if ( $op eq 'view' ) {
 232     $shelfnumber ||= $query->param('shelfnumber');
 233     $shelf = Koha::Virtualshelves->find($shelfnumber);
 234     if ( $shelf ) {
 235         if ( $shelf->can_be_viewed( $loggedinuser ) ) {
 236             $category = $shelf->category;
 237             my( $sortfield, $direction );
 238             if( defined( $query->param('sortfield') ) ){ # Passed in sorting overrides default sorting
 239                 ( $sortfield, $direction ) = split /:/, $query->param('sortfield');
 240             } else {
 241                 $sortfield = $shelf->sortfield;
 242                 $direction = 'asc';
 243             }
 244             $sortfield = 'title' unless grep $_ eq $sortfield, qw( title author copyrightdate itemcallnumber dateadded );
 245             $direction = 'asc' if $direction ne 'asc' and $direction ne 'desc';
 246             my ( $page, $rows );
 247             unless ( $query->param('print') or $query->param('rss') ) {
 248                 $rows = C4::Context->preference('OPACnumSearchResults') || 20;
 249                 $page = ( $query->param('page') ? $query->param('page') : 1 );
 250             }
 251             my $order_by = $sortfield eq 'itemcallnumber' ? 'items.cn_sort' : $sortfield;
 252             my $contents = $shelf->get_contents->search(
 253                 {},
 254                 {
 255                     prefetch => [ { 'biblionumber' => { 'biblioitems' => 'items' } } ],
 256                     page     => $page,
 257                     rows     => $rows,
 258                     order_by => { "-$direction" => $order_by },
 259                 }
 260             );
 261
 262             # get biblionumbers stored in the cart
 263             my @cart_list;
 264             if(my $cart_list = $query->cookie('bib_list')){
 265                 @cart_list = split(/\//, $cart_list);
 266             }
 267
 268             my $patron = Koha::Patrons->find( $loggedinuser );
 269
 270             # Lists display falls back to search results configuration
 271             my $xslfile = C4::Context->preference('OPACXSLTListsDisplay');
 272             my $lang   = $xslfile ? C4::Languages::getlanguage()  : undef;
 273             my $sysxml = $xslfile ? C4::XSLT::get_xslt_sysprefs() : undef;
 274
 275             my $record_processor = Koha::RecordProcessor->new({ filters => 'ViewPolicy' });
 276             my @items;
 277             while ( my $content = $contents->next ) {
 278                 my $biblionumber = $content->biblionumber;
 279                 my $this_item    = GetBiblioData($biblionumber);
 280                 my $record = GetMarcBiblio({ biblionumber => $biblionumber });
 281                 my $framework = GetFrameworkCode( $biblionumber );
 282                 my $biblio = Koha::Biblios->find( $biblionumber );
 283                 $record_processor->options({
 284                     interface => 'opac',
 285                     frameworkcode => $framework
 286                 });
 287                 $record_processor->process($record);
 288
 289                 if ( $xslfile ) {
 290                     $this_item->{XSLTBloc} = XSLTParse4Display( $biblionumber, $record, "OPACXSLTListsDisplay",
 291                                                                 1, undef, $sysxml, $xslfile, $lang);
 292                 }
 293
 294                 my $marcflavour = C4::Context->preference("marcflavour");
 295                 my $itemtype = Koha::Biblioitems->search({ biblionumber => $content->biblionumber })->next->itemtype;
 296                 $itemtype = Koha::ItemTypes->find( $itemtype );
 297                 if( $itemtype ) {
 298                     $this_item->{imageurl}          = C4::Koha::getitemtypeimagelocation( 'opac', $itemtype->imageurl );
 299                     $this_item->{description}       = $itemtype->description; #FIXME Should not it be translated_description?
 300                     $this_item->{notforloan}        = $itemtype->notforloan;
 301                 }
 302                 $this_item->{'coins'}           = $biblio->get_coins;
 303                 $this_item->{'normalized_upc'}  = GetNormalizedUPC( $record, $marcflavour );
 304                 $this_item->{'normalized_ean'}  = GetNormalizedEAN( $record, $marcflavour );
 305                 $this_item->{'normalized_oclc'} = GetNormalizedOCLCNumber( $record, $marcflavour );
 306                 $this_item->{'normalized_isbn'} = GetNormalizedISBN( undef, $record, $marcflavour );
 307
 308                 unless ( defined $this_item->{size} ) {
 309
 310                     #TT has problems with size
 311                     $this_item->{size} = q||;
 312                 }
 313
 314                 # Getting items infos for location display
 315                 my @items_infos = &GetItemsLocationInfo( $biblionumber );
 316                 $this_item->{'ITEM_RESULTS'} = \@items_infos;
 317
 318                 if (C4::Context->preference('TagsEnabled') and C4::Context->preference('TagsShowOnList')) {
 319                     $this_item->{TagLoop} = get_tags({
 320                         biblionumber => $biblionumber, approved=>1, 'sort'=>'-weight',
 321                         limit => C4::Context->preference('TagsShowOnList'),
 322                     });
 323                 }
 324
 325                 my $items = $biblio->items;
 326                 while ( my $item = $items->next ) {
 327                     $this_item->{allow_onshelf_holds} = Koha::IssuingRules->get_onshelfholds_policy( { item => $item, patron => $patron } );
 328                     last if $this_item->{allow_onshelf_holds};
 329                 }
 330
 331                 if ( grep {$_ eq $biblionumber} @cart_list) {
 332                     $this_item->{incart} = 1;
 333                 }
 334
 335                 $this_item->{biblio_object} = $biblio;
 336                 $this_item->{biblionumber}  = $biblionumber;
 337                 push @items, $this_item;
 338             }
 339
 340             $template->param(
 341                 can_manage_shelf   => $shelf->can_be_managed($loggedinuser),
 342                 can_delete_shelf   => $shelf->can_be_deleted($loggedinuser),
 343                 can_remove_biblios => $shelf->can_biblios_be_removed($loggedinuser),
 344                 can_add_biblios    => $shelf->can_biblios_be_added($loggedinuser),
 345                 itemsloop          => \@items,
 346                 sortfield          => $sortfield,
 347                 direction          => $direction,
 348             );
 349             if ( $page ) {
 350                 my $pager = $contents->pager;
 351                 $template->param(
 352                     pagination_bar => pagination_bar(
 353                         q||, $pager->last_page - $pager->first_page + 1,
 354                         $page, "page", { op => 'view', shelfnumber => $shelf->shelfnumber, sortfield => $sortfield, direction => $direction, }
 355                     ),
 356                 );
 357             }
 358         } else {
 359             push @messages, { type => 'error', code => 'unauthorized_on_view' };
 360             undef $shelf;
 361         }
 362     } else {
 363         push @messages, { type => 'error', code => 'does_not_exist' };
 364     }
 365 }
 366
 367 if ( $op eq 'list' ) {
 368     my $shelves;
 369     my ( $page, $rows ) = ( $query->param('page') || 1, 20 );
 370     if ( $category == 1 ) {
 371         $shelves = Koha::Virtualshelves->get_private_shelves({ page => $page, rows => $rows, borrowernumber => $loggedinuser, });
 372     } else {
 373         $shelves = Koha::Virtualshelves->get_public_shelves({ page => $page, rows => $rows, });
 374     }
 375
 376     my $pager = $shelves->pager;
 377     $template->param(
 378         shelves => $shelves,
 379         pagination_bar => pagination_bar(
 380             q||, $pager->last_page - $pager->first_page + 1,
 381             $page, "page", { op => 'list', category => $category, }
 382         ),
 383     );
 384 }
 385
 386 $template->param(
 387     op       => $op,
 388     referer  => $referer,
 389     shelf    => $shelf,
 390     messages => \@messages,
 391     category => $category,
 392     print    => scalar $query->param('print') || 0,
 393     listsview => 1,
 394 );
 395
 396 output_html_with_http_headers $query, $cookie, $template->output;