Bug 36935: Remove warning if file parsing is successful
[koha.git] / 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 qw( get_template_and_user );
24 use C4::Biblio qw( GetBiblioData GetFrameworkCode );
25 use C4::External::BakerTaylor qw( image_url link_url );
26 use C4::Koha qw(
27     GetNormalizedEAN
28     GetNormalizedISBN
29     GetNormalizedOCLCNumber
30     GetNormalizedUPC
31 );
32 use C4::Members;
33 use C4::Output qw( pagination_bar output_with_http_headers );
34 use C4::Tags qw( get_tags );
35 use C4::XSLT qw( XSLTParse4Display );
36
37 use Koha::Biblios;
38 use Koha::Biblioitems;
39 use Koha::CirculationRules;
40 use Koha::CsvProfiles;
41 use Koha::DateUtils qw/dt_from_string/;
42 use Koha::Items;
43 use Koha::ItemTypes;
44 use Koha::Patrons;
45 use Koha::Virtualshelfshares;
46 use Koha::Virtualshelves;
47 use Koha::RecordProcessor;
48
49 use constant ANYONE => 2;
50 use constant STAFF => 3;
51 use constant PERMITTED => 4;
52
53 my $query = CGI->new;
54
55 my $template_name = $query->param('rss') ? "opac-shelves-rss.tt" : "opac-shelves.tt";
56
57 # if virtualshelves is disabled, leave immediately
58 if ( ! C4::Context->preference('virtualshelves') ) {
59     print $query->redirect("/cgi-bin/koha/errors/404.pl");
60     exit;
61 }
62
63 my $op = $query->param('op') || 'list';
64 my ( $template, $loggedinuser, $cookie );
65
66 if( $op eq 'view' || $op eq 'list' ){
67     ( $template, $loggedinuser, $cookie ) = get_template_and_user({
68             template_name   => $template_name,
69             query           => $query,
70             type            => "opac",
71             authnotrequired => ( C4::Context->preference("OpacPublic") ? 1 : 0 ),
72         });
73 } else {
74     ( $template, $loggedinuser, $cookie ) = get_template_and_user({
75             template_name   => $template_name,
76             query           => $query,
77             type            => "opac",
78             authnotrequired => 0,
79         });
80 }
81
82 if (C4::Context->preference("BakerTaylorEnabled")) {
83     $template->param(
84         BakerTaylorImageURL => &image_url(),
85         BakerTaylorLinkURL  => &link_url(),
86     );
87 }
88
89 my $referer = $query->param('referer') || $op;
90 my $page    = int( $query->param('page') || 1 );
91 my $public  = 0;
92 $public = 1 if $query->param('public') && $query->param('public') == 1;
93
94 my ( $shelf, $shelfnumber, @messages );
95
96 # PART 1: Perform a few actions
97 if ( $op eq 'add_form' ) {
98     # Only pass default
99     $shelf = { allow_change_from_owner => 1 };
100 } elsif ( $op eq 'edit_form' ) {
101     $shelfnumber = $query->param('shelfnumber');
102     $shelf       = Koha::Virtualshelves->find($shelfnumber);
103
104     if ( $shelf ) {
105         $public = $shelf->public;
106         my $patron = Koha::Patrons->find( $shelf->owner );
107         $template->param( owner => $patron, );
108         unless ( $shelf->can_be_managed( $loggedinuser ) ) {
109             push @messages, { type => 'error', code => 'unauthorized_on_update' };
110             $op = 'list';
111         }
112     } else {
113         push @messages, { type => 'error', code => 'does_not_exist' };
114     }
115 } elsif ( $op eq 'cud-add' ) {
116     if ( $loggedinuser ) {
117         my $allow_changes_from = $query->param('allow_changes_from');
118         eval {
119             $shelf = Koha::Virtualshelf->new(
120                 {   shelfname          => scalar $query->param('shelfname'),
121                     sortfield          => scalar $query->param('sortfield'),
122                     public             => $public,
123                     allow_change_from_owner            => $allow_changes_from > 0,
124                     allow_change_from_others           => $allow_changes_from == ANYONE,
125                     allow_change_from_staff            => $allow_changes_from == STAFF,
126                     allow_change_from_permitted_staff => $allow_changes_from == PERMITTED,
127                     owner              => scalar $loggedinuser,
128                 }
129             );
130             $shelf->store;
131             $shelfnumber = $shelf->shelfnumber;
132         };
133         if ($@) {
134             push @messages, { type => 'error', code => ref($@), msg => $@ };
135         } elsif ( not $shelf ) {
136             push @messages, { type => 'error', code => 'error_on_insert' };
137         } else {
138             push @messages, { type => 'message', code => 'success_on_insert' };
139             $op = 'view';
140         }
141     } else {
142         push @messages, { type => 'error', code => 'unauthorized_on_insert' };
143         $op = 'list';
144     }
145 } elsif ( $op eq 'cud-edit' ) {
146     $shelfnumber = $query->param('shelfnumber');
147     $shelf       = Koha::Virtualshelves->find($shelfnumber);
148     if ( $shelf ) {
149         $op = $referer;
150         my $sortfield = $query->param('sortfield');
151         $sortfield = 'title' unless grep { $_ eq $sortfield } qw( title author copyrightdate itemcallnumber dateadded );
152         if ( $shelf->can_be_managed( $loggedinuser ) ) {
153             $shelf->shelfname( scalar $query->param('shelfname') );
154             $shelf->sortfield( $sortfield );
155             my $allow_changes_from = $query->param('allow_changes_from');
156             $shelf->allow_change_from_owner( $allow_changes_from > 0 );
157             $shelf->allow_change_from_others( $allow_changes_from == ANYONE );
158             $shelf->allow_change_from_staff( $allow_changes_from == STAFF );
159             $shelf->allow_change_from_permitted_staff( $allow_changes_from == PERMITTED );
160             $shelf->public( $public );
161             eval { $shelf->store };
162
163             if ($@) {
164                 push @messages, { type => 'error', code => 'error_on_update' };
165                 $op = 'edit_form';
166             } else {
167                 push @messages, { type => 'message', code => 'success_on_update' };
168             }
169         } else {
170             push @messages, { type => 'error', code => 'unauthorized_on_update' };
171         }
172     } else {
173         push @messages, { type => 'error', code => 'does_not_exist' };
174     }
175 } elsif ( $op eq 'cud-delete' ) {
176     $shelfnumber = $query->param('shelfnumber');
177     $shelf       = Koha::Virtualshelves->find($shelfnumber);
178     if ($shelf) {
179         if ( $shelf->can_be_deleted( $loggedinuser ) ) {
180             eval { $shelf->delete; };
181             if ($@) {
182                 push @messages, { type => 'error', code => ref($@), msg => $@ };
183             } else {
184                 push @messages, { type => 'message', code => 'success_on_delete' };
185             }
186         } else {
187             push @messages, { type => 'error', code => 'unauthorized_on_delete' };
188         }
189     } else {
190         push @messages, { type => 'error', code => 'does_not_exist' };
191     }
192     $op = $referer;
193 } elsif ( $op eq 'cud-remove_share' ) {
194     $shelfnumber = $query->param('shelfnumber');
195     $shelf = Koha::Virtualshelves->find($shelfnumber);
196     if ($shelf) {
197         my $removed = eval { $shelf->remove_share( $loggedinuser ); };
198         if ($@) {
199             push @messages, { type => 'error', code => ref($@), msg => $@ };
200         } elsif ( $removed ) {
201             push @messages, { type => 'message', code => 'success_on_remove_share' };
202         } else {
203             push @messages, { type => 'error', code => 'error_on_remove_share' };
204         }
205     } else {
206         push @messages, { type => 'error', code => 'does_not_exist' };
207     }
208     $op = $referer;
209
210 } elsif ( $op eq 'cud-add_biblio' ) {
211     $shelfnumber = $query->param('shelfnumber');
212     $shelf = Koha::Virtualshelves->find($shelfnumber);
213     if ($shelf) {
214         if( my $barcode = $query->param('barcode') ) {
215             my $item = Koha::Items->find({ barcode => $barcode });
216             if ( $item ) {
217                 if ( $shelf->can_biblios_be_added( $loggedinuser ) ) {
218                     my $added = eval { $shelf->add_biblio( $item->biblionumber, $loggedinuser ); };
219                     if ($@) {
220                         push @messages, { type => 'error', code => ref($@), msg => $@ };
221                     } elsif ( $added ) {
222                         push @messages, { type => 'message', code => 'success_on_add_biblio' };
223                     } else {
224                         push @messages, { type => 'message', code => 'error_on_add_biblio' };
225                     }
226                 } else {
227                     push @messages, { type => 'error', code => 'unauthorized_on_add_biblio' };
228                 }
229             } else {
230                 push @messages, { type => 'error', code => 'item_does_not_exist' };
231             }
232         }
233     } else {
234         push @messages, { type => 'error', code => 'does_not_exist' };
235     }
236     $op = $referer;
237 } elsif ( $op eq 'cud-remove_biblios' ) {
238     $shelfnumber = $query->param('shelfnumber');
239     $shelf = Koha::Virtualshelves->find($shelfnumber);
240     my @biblionumber = $query->multi_param('biblionumber');
241     if ($shelf) {
242         if ( $shelf->can_biblios_be_removed( $loggedinuser ) ) {
243             my $number_of_biblios_removed = eval {
244                 $shelf->remove_biblios(
245                     {
246                         biblionumbers => \@biblionumber,
247                         borrowernumber => $loggedinuser,
248                     }
249                 );
250             };
251             if ($@) {
252                 push @messages, { type => 'error', code => ref($@), msg => $@ };
253             } elsif ( $number_of_biblios_removed ) {
254                 push @messages, { type => 'message', code => 'success_on_remove_biblios' };
255             } else {
256                 push @messages, { type => 'error', code => 'no_biblio_removed' };
257             }
258         } else {
259             push @messages, { type => 'error', code => 'unauthorized_on_remove_biblios' };
260         }
261     } else {
262         push @messages, { type => 'error', code => 'does_not_exist' };
263     }
264     $op = 'view';
265 } elsif( $op eq 'cud-transfer' ) {
266     $shelfnumber = $query->param('shelfnumber');
267     $shelf = Koha::Virtualshelves->find($shelfnumber) if $shelfnumber;
268     my $new_owner = $query->param('new_owner'); # borrowernumber or undef
269     my $error_code = $shelf
270         ? $shelf->cannot_be_transferred({ by => $loggedinuser, to => $new_owner, interface => 'opac' })
271         : 'does_not_exist';
272
273     if( !$new_owner && $error_code eq 'missing_to_parameter' ) { # show transfer form
274         my $patrons = [];
275         my $shares = $shelf->get_shares->search({ borrowernumber => { '!=' => undef } });
276         while( my $share = $shares->next ) {
277             my $email = $share->sharee->notice_email_address;
278             push @$patrons, { email => $email, borrowernumber => $share->get_column('borrowernumber') } if $email;
279         }
280         if( @$patrons ) {
281             $template->param( shared_users => $patrons );
282             $op = 'cud-transfer';
283         } else {
284             push @messages, { type => 'error', code => 'no_email_found' };
285         }
286     } elsif( $error_code ) {
287         push @messages, { type => 'error', code => $error_code };
288         $op = 'list';
289     } else { # transfer; remove new_owner from virtualshelfshares, add loggedinuser
290         $shelf->_result->result_source->schema->txn_do( sub {
291             $shelf->get_shares->search({ borrowernumber => $new_owner })->delete;
292             Koha::Virtualshelfshare->new({ shelfnumber => $shelfnumber, borrowernumber => $loggedinuser, sharedate => dt_from_string })->store;
293             $shelf->owner($new_owner)->store;
294         });
295         $op = 'list';
296     }
297 }
298
299 # PART 2: After a possible action, view one list or show a number of lists
300 if ( $op eq 'view' ) {
301     $shelfnumber ||= $query->param('shelfnumber');
302     $shelf = Koha::Virtualshelves->find($shelfnumber);
303     if ( $shelf ) {
304         if ( $shelf->can_be_viewed( $loggedinuser ) ) {
305             $public = $shelf->public;
306
307             # Sortfield param may still include sort order with :asc or :desc, but direction overrides it
308             my( $sortfield, $direction );
309             if( $query->param('sortfield') ){
310                 ( $sortfield, $direction ) = split /:/, $query->param('sortfield');
311             } else {
312                 $sortfield = $shelf->sortfield;
313                 $direction = 'asc';
314             }
315             $direction = $query->param('direction') if $query->param('direction');
316             $direction = 'asc' if !$direction or ( $direction ne 'asc' and $direction ne 'desc' );
317             $sortfield = 'title' if !$sortfield or !grep { $_ eq $sortfield } qw( title author copyrightdate itemcallnumber dateadded );
318
319             my $rows;
320             unless ( $query->param('print') or $query->param('rss') ) {
321                 $rows = C4::Context->preference('OPACnumSearchResults') || 20;
322             }
323             my $order_by = $sortfield eq 'itemcallnumber' ? 'items.cn_sort' : $sortfield;
324             my $contents = $shelf->get_contents->search(
325                 {},
326                 {
327                     distinct => 'biblionumber',
328                     join     => [ { 'biblionumber' => { 'biblioitems' => 'items' } } ],
329                     page     => $page,
330                     rows     => $rows,
331                     order_by => { "-$direction" => $order_by },
332                 }
333             );
334
335             # get biblionumbers stored in the cart
336             my @cart_list;
337             if(my $cart_list = $query->cookie('bib_list')){
338                 @cart_list = split(/\//, $cart_list);
339             }
340
341             my $patron = Koha::Patrons->find( $loggedinuser );
342
343             my $categorycode; # needed for may_article_request
344             if( C4::Context->preference('ArticleRequests') ) {
345                 $categorycode = $patron ? $patron->categorycode : undef;
346             }
347
348             my $record_processor = Koha::RecordProcessor->new({ filters => 'ViewPolicy' });
349
350             my $art_req_itypes;
351             if( C4::Context->preference('ArticleRequests') ) {
352                 $art_req_itypes = Koha::CirculationRules->guess_article_requestable_itemtypes({ $patron ? ( categorycode => $patron->categorycode ) : () });
353             }
354
355             my @items_info;
356             while ( my $content = $contents->next ) {
357                 my $biblionumber = $content->biblionumber;
358                 my $this_item    = GetBiblioData($biblionumber);
359                 my $biblio       = Koha::Biblios->find($biblionumber);
360                 my $record       = $biblio->metadata->record;
361                 my $framework    = GetFrameworkCode($biblionumber);
362                 $record_processor->options(
363                     {
364                     interface => 'opac',
365                     frameworkcode => $framework
366                 });
367                 $record_processor->process($record);
368
369                 my $marcflavour = C4::Context->preference("marcflavour");
370                 my $itemtype = Koha::Biblioitems->search({ biblionumber => $content->biblionumber })->next->itemtype;
371                 $itemtype = Koha::ItemTypes->find( $itemtype );
372                 if( $itemtype ) {
373                     $this_item->{imageurl}          = C4::Koha::getitemtypeimagelocation( 'opac', $itemtype->imageurl );
374                     $this_item->{description}       = $itemtype->description; #FIXME Should not it be translated_description?
375                     $this_item->{notforloan}        = $itemtype->notforloan;
376                 }
377                 $this_item->{'coins'}           = $biblio->get_coins;
378                 $this_item->{'normalized_upc'}  = GetNormalizedUPC( $record, $marcflavour );
379                 $this_item->{'normalized_ean'}  = GetNormalizedEAN( $record, $marcflavour );
380                 $this_item->{'normalized_oclc'} = GetNormalizedOCLCNumber( $record, $marcflavour );
381                 $this_item->{'normalized_isbn'} = GetNormalizedISBN( undef, $record, $marcflavour );
382                 # BZ17530: 'Intelligent' guess if result can be article requested
383                 $this_item->{artreqpossible} = ( $art_req_itypes->{ $this_item->{itemtype} // q{} } || $art_req_itypes->{ '*' } ) ? 1 : q{};
384
385                 unless ( defined $this_item->{size} ) {
386
387                     #TT has problems with size
388                     $this_item->{size} = q||;
389                 }
390
391                 if (C4::Context->preference('TagsEnabled') and C4::Context->preference('TagsShowOnList')) {
392                     $this_item->{TagLoop} = get_tags({
393                         biblionumber => $biblionumber, approved=>1, 'sort'=>'-weight',
394                         limit => C4::Context->preference('TagsShowOnList'),
395                     });
396                 }
397
398                 my $items = $biblio->items->filter_by_visible_in_opac({ patron => $patron });
399                 my $allow_onshelf_holds;
400                 while ( my $item = $items->next ) {
401
402                     # This method must take a Koha::Items rs
403                     $allow_onshelf_holds ||= Koha::CirculationRules->get_onshelfholds_policy(
404                         { item => $item, patron => $patron } );
405
406                 }
407
408                 $this_item->{allow_onshelf_holds} = $allow_onshelf_holds;
409                 $this_item->{'ITEM_RESULTS'} = $items;
410
411                 my $variables = {
412                     anonymous_session => ($loggedinuser) ? 0 : 1
413                 };
414                 $this_item->{XSLTBloc} = XSLTParse4Display(
415                     {
416                         biblionumber   => $biblionumber,
417                         record         => $record,
418                         xsl_syspref    => "OPACXSLTListsDisplay",
419                         fix_amps       => 1,
420                         xslt_variables => $variables,
421                         items_rs       => $items->reset,
422                     }
423                 );
424
425
426                 if ( grep {$_ eq $biblionumber} @cart_list) {
427                     $this_item->{incart} = 1;
428                 }
429
430                 $this_item->{biblio_object} = $biblio;
431                 $this_item->{biblionumber}  = $biblionumber;
432                 $this_item->{shelves} =
433                   Koha::Virtualshelves->get_shelves_containing_record(
434                     {
435                         biblionumber   => $biblionumber,
436                         borrowernumber => $loggedinuser,
437                     }
438                   );
439                 push @items_info, $this_item;
440             }
441
442             $template->param(
443                 can_manage_shelf   => $shelf->can_be_managed($loggedinuser),
444                 can_delete_shelf   => $shelf->can_be_deleted($loggedinuser),
445                 can_remove_biblios => $shelf->can_biblios_be_removed($loggedinuser),
446                 can_add_biblios    => $shelf->can_biblios_be_added($loggedinuser),
447                 itemsloop          => \@items_info,
448                 sortfield          => $sortfield,
449                 direction          => $direction,
450                 csv_profiles => Koha::CsvProfiles->search(
451                     {
452                         type       => 'marc',
453                         used_for   => 'export_records',
454                         staff_only => 0
455                     }
456                   ),
457             );
458             if ( $page ) {
459                 my $pager = $contents->pager;
460                 $template->param(
461                     pagination_bar => pagination_bar(
462                         q||, $pager->last_page - $pager->first_page + 1,
463                         $page, "page", { op => 'view', shelfnumber => $shelf->shelfnumber, sortfield => $sortfield, direction => $direction, }
464                     ),
465                 );
466             }
467             my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
468                 {
469                     borrowernumber => $loggedinuser,
470                     add_allowed    => 1,
471                     public         => 0,
472                 }
473             );
474             my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
475                 {
476                     borrowernumber => $loggedinuser,
477                     add_allowed    => 1,
478                     public         => 1,
479                 }
480             );
481
482             $template->param(
483                 add_to_some_private_shelves => $some_private_shelves,
484                 add_to_some_public_shelves  => $some_public_shelves,
485             );
486         } else {
487             push @messages, { type => 'error', code => 'unauthorized_on_view' };
488             undef $shelf;
489         }
490     } else {
491         push @messages, { type => 'error', code => 'does_not_exist' };
492     }
493 } elsif ( $op eq 'list' ) {
494     my $shelves;
495     my ( $rows ) = ( 20 );
496     if ( !$public ) {
497         $shelves = Koha::Virtualshelves->get_private_shelves({ page => $page, rows => $rows, borrowernumber => $loggedinuser, });
498     } else {
499         $shelves = Koha::Virtualshelves->get_public_shelves({ page => $page, rows => $rows, });
500     }
501
502     my $pager = $shelves->pager;
503     $template->param(
504         shelves => $shelves,
505         pagination_bar => pagination_bar(
506             q||, $pager->last_page - $pager->first_page + 1,
507             $page, "page", { op => 'list', public => $public, }
508         ),
509     );
510 }
511
512 my ($staffuser, $permitteduser);
513 $staffuser = Koha::Patrons->find( $loggedinuser )->can_patron_change_staff_only_lists if $loggedinuser;
514 $permitteduser = Koha::Patrons->find( $loggedinuser )->can_patron_change_permitted_staff_lists if $loggedinuser;
515
516 $template->param(
517     op            => $op,
518     referer       => $referer,
519     shelf         => $shelf,
520     messages      => \@messages,
521     public        => $public,
522     print         => scalar $query->param('print') || 0,
523     listsview     => 1,
524     staffuser     => $staffuser,
525     permitteduser => $permitteduser
526 );
527
528 my $content_type = $query->param('rss')? 'rss' : 'html';
529 output_with_http_headers $query, $cookie, $template->output, $content_type;