virtualshelves/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 use CGI qw ( -utf8 );
  22 use C4::Auth;
  23 use C4::Biblio;
  24 use C4::Koha;
  25 use C4::Items;
  26 use C4::Members;
  27 use C4::Output;
  28 use C4::XSLT;
  29
  30 use Koha::Biblios;
  31 use Koha::Biblioitems;
  32 use Koha::CsvProfiles;
  33 use Koha::Virtualshelves;
  34
  35 use constant ANYONE => 2;
  36
  37 my $query = new CGI;
  38
  39 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
  40     {   template_name   => "virtualshelves/shelves.tt",
  41         query           => $query,
  42         type            => "intranet",
  43         authnotrequired => 0,
  44         flagsrequired   => { catalogue => 1 },
  45     }
  46 );
  47
  48 my $op       = $query->param('op')       || 'list';
  49 my $referer  = $query->param('referer')  || $op;
  50 my $category = $query->param('category') || 1;
  51 my ( $shelf, $shelfnumber, @messages );
  52
  53 if ( $op eq 'add_form' ) {
  54     # Only pass default
  55     $shelf = { allow_change_from_owner => 1 };
  56 } elsif ( $op eq 'edit_form' ) {
  57     $shelfnumber = $query->param('shelfnumber');
  58     $shelf       = Koha::Virtualshelves->find($shelfnumber);
  59
  60     if ( $shelf ) {
  61         $category = $shelf->category;
  62         my $patron = GetMember( 'borrowernumber' => $shelf->owner );
  63         $template->param( owner => $patron, );
  64         unless ( $shelf->can_be_managed( $loggedinuser ) ) {
  65             push @messages, { type => 'alert', code => 'unauthorized_on_update' };
  66             $op = 'list';
  67         }
  68     } else {
  69         push @messages, { type => 'alert', code => 'does_not_exist' };
  70     }
  71 } elsif ( $op eq 'add' ) {
  72     my $allow_changes_from = $query->param('allow_changes_from');
  73     eval {
  74         $shelf = Koha::Virtualshelf->new(
  75             {   shelfname          => scalar $query->param('shelfname'),
  76                 sortfield          => scalar $query->param('sortfield'),
  77                 category           => scalar $query->param('category'),
  78                 allow_change_from_owner => $allow_changes_from > 0,
  79                 allow_change_from_others => $allow_changes_from == ANYONE,
  80                 owner              => scalar $query->param('owner'),
  81             }
  82         );
  83         $shelf->store;
  84         $shelfnumber = $shelf->shelfnumber;
  85     };
  86     if ($@) {
  87         push @messages, { type => 'alert', code => ref($@), msg => $@ };
  88     } elsif ( not $shelf ) {
  89         push @messages, { type => 'alert', code => 'error_on_insert' };
  90
  91     } else {
  92         push @messages, { type => 'message', code => 'success_on_insert' };
  93         $op = 'view';
  94     }
  95 } elsif ( $op eq 'edit' ) {
  96     $shelfnumber = $query->param('shelfnumber');
  97     $shelf       = Koha::Virtualshelves->find($shelfnumber);
  98
  99     if ( $shelf ) {
 100         $op = $referer;
 101         my $sortfield = $query->param('sortfield');
 102         $sortfield = 'title' unless grep {/^$sortfield$/}qw( title author copyrightdate itemcallnumber );
 103         if ( $shelf->can_be_managed( $loggedinuser ) ) {
 104             $shelf->shelfname( scalar $query->param('shelfname') );
 105             $shelf->sortfield( $sortfield );
 106             my $allow_changes_from = $query->param('allow_changes_from');
 107             $shelf->allow_change_from_owner( $allow_changes_from > 0 );
 108             $shelf->allow_change_from_others( $allow_changes_from == ANYONE );
 109             $shelf->category( scalar $query->param('category') );
 110             eval { $shelf->store };
 111
 112             if ($@) {
 113                 push @messages, { type => 'alert', code => 'error_on_update' };
 114                 $op = 'edit_form';
 115             } else {
 116                 push @messages, { type => 'message', code => 'success_on_update' };
 117             }
 118         } else {
 119             push @messages, { type => 'alert', code => 'unauthorized_on_update' };
 120         }
 121     } else {
 122         push @messages, { type => 'alert', code => 'does_not_exist' };
 123     }
 124 } elsif ( $op eq 'delete' ) {
 125     $shelfnumber = $query->param('shelfnumber');
 126     $shelf       = Koha::Virtualshelves->find($shelfnumber);
 127     if ($shelf) {
 128         if ( $shelf->can_be_deleted( $loggedinuser ) ) {
 129             eval { $shelf->delete; };
 130             if ($@) {
 131                 push @messages, { type => 'alert', code => ref($@), msg => $@ };
 132             } else {
 133                 push @messages, { type => 'message', code => 'success_on_delete' };
 134             }
 135         } else {
 136             push @messages, { type => 'alert', code => 'unauthorized_on_delete' };
 137         }
 138     } else {
 139         push @messages, { type => 'alert', code => 'does_not_exist' };
 140     }
 141     $op = 'list';
 142 } elsif ( $op eq 'add_biblio' ) {
 143     $shelfnumber = $query->param('shelfnumber');
 144     $shelf = Koha::Virtualshelves->find($shelfnumber);
 145     if ($shelf) {
 146         if( my $barcodes = $query->param('barcodes') ) {
 147             if ( $shelf->can_biblios_be_added( $loggedinuser ) ) {
 148                 my @barcodes = split /\n/, $barcodes; # Entries are effectively passed in as a <cr> separated list
 149                 foreach my $barcode (@barcodes){
 150                     $barcode =~ s/\r$//; # strip any naughty return chars
 151                     next if $barcode eq '';
 152                     my $item = GetItem( 0, $barcode);
 153                     if (defined $item && $item->{itemnumber}) {
 154                         my $biblio = GetBiblioFromItemNumber( $item->{itemnumber} );
 155                         my $added = eval { $shelf->add_biblio( $biblio->{biblionumber}, $loggedinuser ); };
 156                         if ($@) {
 157                             push @messages, { item_barcode => $barcode, type => 'alert', code => ref($@), msg => $@ };
 158                         } elsif ( $added ) {
 159                             push @messages, { item_barcode => $barcode, type => 'message', code => 'success_on_add_biblio' };
 160                         } else {
 161                             push @messages, { item_barcode => $barcode, type => 'message', code => 'error_on_add_biblio' };
 162                         }
 163                     } else {
 164                         push @messages, { item_barcode => $barcode, type => 'alert', code => 'item_does_not_exist' };
 165                     }
 166                 }
 167             } else {
 168                 push @messages, { type => 'alert', code => 'unauthorized_on_add_biblio' };
 169             }
 170         }
 171     } else {
 172         push @messages, { type => 'alert', code => 'does_not_exist' };
 173     }
 174     $op = $referer;
 175 } elsif ( $op eq 'remove_biblios' ) {
 176     $shelfnumber = $query->param('shelfnumber');
 177     $shelf = Koha::Virtualshelves->find($shelfnumber);
 178     my @biblionumbers = $query->multi_param('biblionumber');
 179     if ($shelf) {
 180         if ( $shelf->can_biblios_be_removed( $loggedinuser ) ) {
 181             my $number_of_biblios_removed = eval {
 182                 $shelf->remove_biblios(
 183                     {
 184                         biblionumbers => \@biblionumbers,
 185                         borrowernumber => $loggedinuser,
 186                     }
 187                 );
 188             };
 189             if ($@) {
 190                 push @messages, { type => 'alert', code => ref($@), msg => $@ };
 191             } elsif ( $number_of_biblios_removed ) {
 192                 push @messages, { type => 'message', code => 'success_on_remove_biblios' };
 193             } else {
 194                 push @messages, { type => 'alert', code => 'no_biblio_removed' };
 195             }
 196         } else {
 197             push @messages, { type => 'alert', code => 'unauthorized_on_remove_biblios' };
 198         }
 199     } else {
 200         push @messages, { type => 'alert', code => 'does_not_exist' };
 201     }
 202     $op = $referer;
 203 }
 204
 205 if ( $op eq 'view' ) {
 206     $shelfnumber ||= $query->param('shelfnumber');
 207     $shelf = Koha::Virtualshelves->find($shelfnumber);
 208     if ( $shelf ) {
 209         if ( $shelf->can_be_viewed( $loggedinuser ) ) {
 210             my $sortfield = $query->param('sortfield') || $shelf->sortfield || 'title';    # Passed in sorting overrides default sorting
 211             $sortfield = 'title' unless grep {/^$sortfield$/}qw( title author copyrightdate itemcallnumber );
 212             my $direction = $query->param('direction') || 'asc';
 213             $direction = 'asc' if $direction ne 'asc' and $direction ne 'desc';
 214             my ( $rows, $page );
 215             unless ( $query->param('print') ) {
 216                 $rows = C4::Context->preference('numSearchResults') || 20;
 217                 $page = ( $query->param('page') ? $query->param('page') : 1 );
 218             }
 219
 220             my $order_by = $sortfield eq 'itemcallnumber' ? 'items.itemcallnumber' : $sortfield;
 221             my $contents = $shelf->get_contents->search(
 222                 {},
 223                 {
 224                     prefetch => [ { 'biblionumber' => { 'biblioitems' => 'items' } } ],
 225                     page     => $page,
 226                     rows     => $rows,
 227                     order_by => { "-$direction" => $order_by },
 228                 }
 229             );
 230
 231             my $borrower = GetMember( borrowernumber => $loggedinuser );
 232
 233             my $xslfile = C4::Context->preference('XSLTListsDisplay');
 234             my $lang   = $xslfile ? C4::Languages::getlanguage()  : undef;
 235             my $sysxml = $xslfile ? C4::XSLT::get_xslt_sysprefs() : undef;
 236
 237             my @items;
 238             while ( my $content = $contents->next ) {
 239                 my $this_item;
 240                 my $biblionumber = $content->biblionumber;
 241                 my $record       = GetMarcBiblio($biblionumber);
 242
 243                 if ( $xslfile ) {
 244                     $this_item->{XSLTBloc} = XSLTParse4Display( $biblionumber, $record, "XSLTListsDisplay",
 245                                                                 1, undef, $sysxml, $xslfile, $lang);
 246                 }
 247
 248                 my $marcflavour = C4::Context->preference("marcflavour");
 249                 my $itemtype = Koha::Biblioitems->search({ biblionumber => $content->biblionumber })->next->itemtype;
 250                 my $itemtypeinfo = getitemtypeinfo( $itemtype, 'intranet' );
 251                 my $biblio = Koha::Biblios->find( $content->biblionumber );
 252                 $this_item->{title}             = $biblio->title;
 253                 $this_item->{author}            = $biblio->author;
 254                 $this_item->{dateadded}         = $content->dateadded;
 255                 $this_item->{imageurl}          = $itemtypeinfo->{imageurl};
 256                 $this_item->{description}       = $itemtypeinfo->{description};
 257                 $this_item->{notforloan}        = $itemtypeinfo->{notforloan};
 258                 $this_item->{'coins'}           = GetCOinSBiblio($record);
 259                 $this_item->{'subtitle'}        = GetRecordValue( 'subtitle', $record, GetFrameworkCode( $biblionumber ) );
 260                 $this_item->{'normalized_upc'}  = GetNormalizedUPC( $record, $marcflavour );
 261                 $this_item->{'normalized_ean'}  = GetNormalizedEAN( $record, $marcflavour );
 262                 $this_item->{'normalized_oclc'} = GetNormalizedOCLCNumber( $record, $marcflavour );
 263                 $this_item->{'normalized_isbn'} = GetNormalizedISBN( undef, $record, $marcflavour );
 264
 265                 unless ( defined $this_item->{size} ) {
 266
 267                     #TT has problems with size
 268                     $this_item->{size} = q||;
 269                 }
 270
 271                 # Getting items infos for location display
 272                 my @items_infos = &GetItemsLocationInfo( $biblionumber );
 273                 $this_item->{'ITEM_RESULTS'} = \@items_infos;
 274                 $this_item->{biblionumber} = $biblionumber;
 275                 push @items, $this_item;
 276             }
 277
 278             my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
 279                 {
 280                     borrowernumber => $loggedinuser,
 281                     add_allowed    => 1,
 282                     category       => 1,
 283                 }
 284             );
 285             my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
 286                 {
 287                     borrowernumber => $loggedinuser,
 288                     add_allowed    => 1,
 289                     category       => 2,
 290                 }
 291             );
 292
 293             $template->param(
 294                 add_to_some_private_shelves => $some_private_shelves,
 295                 add_to_some_public_shelves  => $some_public_shelves,
 296                 can_manage_shelf   => $shelf->can_be_managed($loggedinuser),
 297                 can_remove_shelf   => $shelf->can_be_deleted($loggedinuser),
 298                 can_remove_biblios => $shelf->can_biblios_be_removed($loggedinuser),
 299                 can_add_biblios    => $shelf->can_biblios_be_added($loggedinuser),
 300                 sortfield          => $sortfield,
 301                 itemsloop          => \@items,
 302                 sortfield          => $sortfield,
 303                 direction          => $direction,
 304             );
 305             if ( $page ) {
 306                 my $pager = $contents->pager;
 307                 $template->param(
 308                     pagination_bar => pagination_bar(
 309                         q||, $pager->last_page - $pager->first_page + 1,
 310                         $page, "page", { op => 'view', shelfnumber => $shelf->shelfnumber, sortfield => $sortfield, direction => $direction, }
 311                     ),
 312                 );
 313             }
 314         } else {
 315             push @messages, { type => 'error', code => 'unauthorized_on_view' };
 316             undef $shelf;
 317         }
 318     } else {
 319         push @messages, { type => 'alert', code => 'does_not_exist' };
 320     }
 321 }
 322
 323 $template->param(
 324     op       => $op,
 325     referer  => $referer,
 326     shelf    => $shelf,
 327     messages => \@messages,
 328     category => $category,
 329     print    => scalar $query->param('print') || 0,
 330     csv_profiles => [ Koha::CsvProfiles->search({ type => 'marc', used_for => 'export_records' }) ],
 331 );
 332
 333 output_html_with_http_headers $query, $cookie, $template->output;