Bug 22899: Database update
[koha.git] / opac / opac-shelves.pl
blobf23778d8c1a0f8dcf2e74dbffcb3af799fcce0da
1 #!/usr/bin/perl
3 # Copyright 2015 Koha Team
5 # This file is part of Koha.
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.
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.
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>.
20 use Modern::Perl;
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;
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;
41 use constant ANYONE => 2;
43 my $query = new CGI;
45 my $template_name = $query->param('rss') ? "opac-shelves-rss.tt" : "opac-shelves.tt";
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;
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 });
60 my $op = $query->param('op') || 'list';
61 my $referer = $query->param('referer') || $op;
62 my $category = $query->param('category') || 1;
63 $category = 2 if $category ne "1";
64 my ( $shelf, $shelfnumber, @messages );
66 if ( $op eq 'add_form' ) {
67 # Only pass default
68 $shelf = { allow_change_from_owner => 1 };
69 } elsif ( $op eq 'edit_form' ) {
70 $shelfnumber = $query->param('shelfnumber');
71 $shelf = Koha::Virtualshelves->find($shelfnumber);
73 if ( $shelf ) {
74 $category = $shelf->category;
75 my $patron = Koha::Patrons->find( $shelf->owner );
76 $template->param( owner => $patron, );
77 unless ( $shelf->can_be_managed( $loggedinuser ) ) {
78 push @messages, { type => 'error', code => 'unauthorized_on_update' };
79 $op = 'list';
81 } else {
82 push @messages, { type => 'error', code => 'does_not_exist' };
84 } elsif ( $op eq 'add' ) {
85 if ( $loggedinuser ) {
86 my $allow_changes_from = $query->param('allow_changes_from');
87 eval {
88 $shelf = Koha::Virtualshelf->new(
89 { shelfname => scalar $query->param('shelfname'),
90 sortfield => scalar $query->param('sortfield'),
91 category => scalar $query->param('category') || 1,
92 allow_change_from_owner => $allow_changes_from > 0,
93 allow_change_from_others => $allow_changes_from == ANYONE,
94 owner => scalar $loggedinuser,
97 $shelf->store;
98 $shelfnumber = $shelf->shelfnumber;
100 if ($@) {
101 push @messages, { type => 'error', code => ref($@), msg => $@ };
102 } elsif ( not $shelf ) {
103 push @messages, { type => 'error', code => 'error_on_insert' };
104 } else {
105 push @messages, { type => 'message', code => 'success_on_insert' };
106 $op = 'view';
108 } else {
109 push @messages, { type => 'error', code => 'unauthorized_on_insert' };
110 $op = 'list';
112 } elsif ( $op eq 'edit' ) {
113 $shelfnumber = $query->param('shelfnumber');
114 $shelf = Koha::Virtualshelves->find($shelfnumber);
115 if ( $shelf ) {
116 $op = $referer;
117 my $sortfield = $query->param('sortfield');
118 $sortfield = 'title' unless grep {/^$sortfield$/}qw( title author copyrightdate itemcallnumber dateadded );
119 if ( $shelf->can_be_managed( $loggedinuser ) ) {
120 $shelf->shelfname( scalar $query->param('shelfname') );
121 $shelf->sortfield( $sortfield );
122 my $allow_changes_from = $query->param('allow_changes_from');
123 $shelf->allow_change_from_owner( $allow_changes_from > 0 );
124 $shelf->allow_change_from_others( $allow_changes_from == ANYONE );
125 $shelf->category( scalar $query->param('category') );
126 eval { $shelf->store };
128 if ($@) {
129 push @messages, { type => 'error', code => 'error_on_update' };
130 $op = 'edit_form';
131 } else {
132 push @messages, { type => 'message', code => 'success_on_update' };
134 } else {
135 push @messages, { type => 'error', code => 'unauthorized_on_update' };
137 } else {
138 push @messages, { type => 'error', code => 'does_not_exist' };
140 } elsif ( $op eq 'delete' ) {
141 $shelfnumber = $query->param('shelfnumber');
142 $shelf = Koha::Virtualshelves->find($shelfnumber);
143 if ($shelf) {
144 if ( $shelf->can_be_deleted( $loggedinuser ) ) {
145 eval { $shelf->delete; };
146 if ($@) {
147 push @messages, { type => 'error', code => ref($@), msg => $@ };
148 } else {
149 push @messages, { type => 'message', code => 'success_on_delete' };
151 } else {
152 push @messages, { type => 'error', code => 'unauthorized_on_delete' };
154 } else {
155 push @messages, { type => 'error', code => 'does_not_exist' };
157 $op = $referer;
158 } elsif ( $op eq 'remove_share' ) {
159 $shelfnumber = $query->param('shelfnumber');
160 $shelf = Koha::Virtualshelves->find($shelfnumber);
161 if ($shelf) {
162 my $removed = eval { $shelf->remove_share( $loggedinuser ); };
163 if ($@) {
164 push @messages, { type => 'error', code => ref($@), msg => $@ };
165 } elsif ( $removed ) {
166 push @messages, { type => 'message', code => 'success_on_remove_share' };
167 } else {
168 push @messages, { type => 'error', code => 'error_on_remove_share' };
170 } else {
171 push @messages, { type => 'error', code => 'does_not_exist' };
173 $op = $referer;
175 } elsif ( $op eq 'add_biblio' ) {
176 $shelfnumber = $query->param('shelfnumber');
177 $shelf = Koha::Virtualshelves->find($shelfnumber);
178 if ($shelf) {
179 if( my $barcode = $query->param('barcode') ) {
180 my $item = Koha::Items->find({ barcode => $barcode });
181 if ( $item ) {
182 if ( $shelf->can_biblios_be_added( $loggedinuser ) ) {
183 my $added = eval { $shelf->add_biblio( $item->biblionumber, $loggedinuser ); };
184 if ($@) {
185 push @messages, { type => 'error', code => ref($@), msg => $@ };
186 } elsif ( $added ) {
187 push @messages, { type => 'message', code => 'success_on_add_biblio' };
188 } else {
189 push @messages, { type => 'message', code => 'error_on_add_biblio' };
191 } else {
192 push @messages, { type => 'error', code => 'unauthorized_on_add_biblio' };
194 } else {
195 push @messages, { type => 'error', code => 'item_does_not_exist' };
198 } else {
199 push @messages, { type => 'error', code => 'does_not_exist' };
201 $op = $referer;
202 } elsif ( $op eq 'remove_biblios' ) {
203 $shelfnumber = $query->param('shelfnumber');
204 $shelf = Koha::Virtualshelves->find($shelfnumber);
205 my @biblionumber = $query->multi_param('biblionumber');
206 if ($shelf) {
207 if ( $shelf->can_biblios_be_removed( $loggedinuser ) ) {
208 my $number_of_biblios_removed = eval {
209 $shelf->remove_biblios(
211 biblionumbers => \@biblionumber,
212 borrowernumber => $loggedinuser,
216 if ($@) {
217 push @messages, { type => 'error', code => ref($@), msg => $@ };
218 } elsif ( $number_of_biblios_removed ) {
219 push @messages, { type => 'message', code => 'success_on_remove_biblios' };
220 } else {
221 push @messages, { type => 'error', code => 'no_biblio_removed' };
223 } else {
224 push @messages, { type => 'error', code => 'unauthorized_on_remove_biblios' };
226 } else {
227 push @messages, { type => 'error', code => 'does_not_exist' };
229 $op = 'view';
232 if ( $op eq 'view' ) {
233 $shelfnumber ||= $query->param('shelfnumber');
234 $shelf = Koha::Virtualshelves->find($shelfnumber);
235 if ( $shelf ) {
236 if ( $shelf->can_be_viewed( $loggedinuser ) ) {
237 $category = $shelf->category;
238 my $sortfield = $query->param('sortfield') || $shelf->sortfield; # Passed in sorting overrides default sorting
239 $sortfield = 'title' unless grep {/^$sortfield$/}qw( title author copyrightdate itemcallnumber dateadded );
240 my $direction = $query->param('direction') || 'asc';
241 $direction = 'asc' if $direction ne 'asc' and $direction ne 'desc';
242 my ( $page, $rows );
243 unless ( $query->param('print') or $query->param('rss') ) {
244 $rows = C4::Context->preference('OPACnumSearchResults') || 20;
245 $page = ( $query->param('page') ? $query->param('page') : 1 );
247 my $order_by = $sortfield eq 'itemcallnumber' ? 'items.cn_sort' : $sortfield;
248 my $contents = $shelf->get_contents->search(
251 prefetch => [ { 'biblionumber' => { 'biblioitems' => 'items' } } ],
252 page => $page,
253 rows => $rows,
254 order_by => { "-$direction" => $order_by },
258 # get biblionumbers stored in the cart
259 my @cart_list;
260 if(my $cart_list = $query->cookie('bib_list')){
261 @cart_list = split(/\//, $cart_list);
264 my $patron = Koha::Patrons->find( $loggedinuser );
266 # Lists display falls back to search results configuration
267 my $xslfile = C4::Context->preference('OPACXSLTListsDisplay');
268 my $lang = $xslfile ? C4::Languages::getlanguage() : undef;
269 my $sysxml = $xslfile ? C4::XSLT::get_xslt_sysprefs() : undef;
271 my $record_processor = Koha::RecordProcessor->new({ filters => 'ViewPolicy' });
272 my @items;
273 while ( my $content = $contents->next ) {
274 my $biblionumber = $content->biblionumber;
275 my $this_item = GetBiblioData($biblionumber);
276 my $record = GetMarcBiblio({ biblionumber => $biblionumber });
277 my $framework = GetFrameworkCode( $biblionumber );
278 my $biblio = Koha::Biblios->find( $biblionumber );
279 $record_processor->options({
280 interface => 'opac',
281 frameworkcode => $framework
283 $record_processor->process($record);
285 if ( $xslfile ) {
286 $this_item->{XSLTBloc} = XSLTParse4Display( $biblionumber, $record, "OPACXSLTListsDisplay",
287 1, undef, $sysxml, $xslfile, $lang);
290 my $marcflavour = C4::Context->preference("marcflavour");
291 my $itemtype = Koha::Biblioitems->search({ biblionumber => $content->biblionumber })->next->itemtype;
292 $itemtype = Koha::ItemTypes->find( $itemtype );
293 if( $itemtype ) {
294 $this_item->{imageurl} = C4::Koha::getitemtypeimagelocation( 'opac', $itemtype->imageurl );
295 $this_item->{description} = $itemtype->description; #FIXME Should not it be translated_description?
296 $this_item->{notforloan} = $itemtype->notforloan;
298 $this_item->{'coins'} = $biblio->get_coins;
299 $this_item->{'subtitle'} = GetRecordValue( 'subtitle', $record, GetFrameworkCode( $biblionumber ) );
300 $this_item->{'normalized_upc'} = GetNormalizedUPC( $record, $marcflavour );
301 $this_item->{'normalized_ean'} = GetNormalizedEAN( $record, $marcflavour );
302 $this_item->{'normalized_oclc'} = GetNormalizedOCLCNumber( $record, $marcflavour );
303 $this_item->{'normalized_isbn'} = GetNormalizedISBN( undef, $record, $marcflavour );
305 unless ( defined $this_item->{size} ) {
307 #TT has problems with size
308 $this_item->{size} = q||;
311 # Getting items infos for location display
312 my @items_infos = &GetItemsLocationInfo( $biblionumber );
313 $this_item->{'ITEM_RESULTS'} = \@items_infos;
315 if (C4::Context->preference('TagsEnabled') and C4::Context->preference('TagsShowOnList')) {
316 $this_item->{TagLoop} = get_tags({
317 biblionumber => $biblionumber, approved=>1, 'sort'=>'-weight',
318 limit => C4::Context->preference('TagsShowOnList'),
322 my $items = $biblio->items;
323 while ( my $item = $items->next ) {
324 $this_item->{allow_onshelf_holds} = Koha::IssuingRules->get_onshelfholds_policy( { item => $item, patron => $patron } );
325 last if $this_item->{allow_onshelf_holds};
328 if ( grep {$_ eq $biblionumber} @cart_list) {
329 $this_item->{incart} = 1;
332 $this_item->{biblionumber} = $biblionumber;
333 push @items, $this_item;
336 $template->param(
337 can_manage_shelf => $shelf->can_be_managed($loggedinuser),
338 can_delete_shelf => $shelf->can_be_deleted($loggedinuser),
339 can_remove_biblios => $shelf->can_biblios_be_removed($loggedinuser),
340 can_add_biblios => $shelf->can_biblios_be_added($loggedinuser),
341 itemsloop => \@items,
342 sortfield => $sortfield,
343 direction => $direction,
345 if ( $page ) {
346 my $pager = $contents->pager;
347 $template->param(
348 pagination_bar => pagination_bar(
349 q||, $pager->last_page - $pager->first_page + 1,
350 $page, "page", { op => 'view', shelfnumber => $shelf->shelfnumber, sortfield => $sortfield, direction => $direction, }
354 } else {
355 push @messages, { type => 'error', code => 'unauthorized_on_view' };
356 undef $shelf;
358 } else {
359 push @messages, { type => 'error', code => 'does_not_exist' };
363 if ( $op eq 'list' ) {
364 my $shelves;
365 my ( $page, $rows ) = ( $query->param('page') || 1, 20 );
366 if ( $category == 1 ) {
367 $shelves = Koha::Virtualshelves->get_private_shelves({ page => $page, rows => $rows, borrowernumber => $loggedinuser, });
368 } else {
369 $shelves = Koha::Virtualshelves->get_public_shelves({ page => $page, rows => $rows, });
372 my $pager = $shelves->pager;
373 $template->param(
374 shelves => $shelves,
375 pagination_bar => pagination_bar(
376 q||, $pager->last_page - $pager->first_page + 1,
377 $page, "page", { op => 'list', category => $category, }
382 $template->param(
383 op => $op,
384 referer => $referer,
385 shelf => $shelf,
386 messages => \@messages,
387 category => $category,
388 print => scalar $query->param('print') || 0,
389 listsview => 1,
392 output_html_with_http_headers $query, $cookie, $template->output;