3 # Copyright 2000-2002 Katipo Communications
4 # Copyright 2004-2010 BibLibre
5 # Parts Copyright Catalyst IT 2011
7 # This file is part of Koha.
9 # Koha is free software; you can redistribute it and/or modify it
10 # under the terms of the GNU General Public License as published by
11 # the Free Software Foundation; either version 3 of the License, or
12 # (at your option) any later version.
14 # Koha is distributed in the hope that it will be useful, but
15 # WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
19 # You should have received a copy of the GNU General Public License
20 # along with Koha; if not, see <http://www.gnu.org/licenses>.
25 use C4::Auth qw( get_template_and_user haspermission );
26 use C4::Output qw( output_and_exit_if_error output_and_exit output_html_with_http_headers );
31 IsMarcStructureInternal
35 use C4::Circulation qw( barcodedecode LostItem );
37 use C4::Barcodes::ValueBuilder;
38 use Koha::DateUtils qw( dt_from_string );
45 use Koha::SearchEngine::Indexer;
46 use C4::Search qw( enabled_staff_search_views );
47 use Storable qw( freeze thaw );
48 use URI::Escape qw( uri_escape_utf8 );
50 use Koha::UI::Form::Builder::Item;
53 use URI::Escape qw( uri_escape_utf8 );
54 use Encode qw( encode_utf8 );
55 use MIME::Base64 qw( decode_base64url encode_base64url );
56 use List::Util qw( first );
57 use List::MoreUtils qw( any uniq );
59 our $dbh = C4::Context->dbh;
61 sub add_item_to_item_group {
62 my ( $biblionumber, $itemnumber, $item_group, $item_group_description ) = @_;
64 return unless $item_group;
67 if ( $item_group eq 'create' ) {
68 my $item_group = Koha::Biblio::ItemGroup->new(
70 biblionumber => $biblionumber,
71 description => $item_group_description,
75 $item_group_id = $item_group->id;
78 $item_group_id = $item_group;
81 my $item_group_item = Koha::Biblio::ItemGroup::Item->new(
83 itemnumber => $itemnumber,
84 item_group_id => $item_group_id,
89 sub get_item_from_cookie {
93 my $lastitemcookie = $input->cookie('LastCreatedItem');
94 if ($lastitemcookie) {
95 $lastitemcookie = decode_base64url($lastitemcookie);
97 if ( thaw($lastitemcookie) ) {
98 $item_from_cookie = thaw($lastitemcookie);
102 $lastitemcookie ||= 'undef';
103 warn "Storable::thaw failed to thaw LastCreatedItem-cookie. Cookie value '".encode_base64url($lastitemcookie)."'. Caught error follows: '$@'";
106 return $item_from_cookie;
109 my $input = CGI->new;
113 if( $input->param('itemnumber') && !$input->param('biblionumber') ){
114 $itemnumber = $input->param('itemnumber');
115 my $item = Koha::Items->find( $itemnumber );
116 $biblionumber = $item->biblionumber;
118 $biblionumber = $input->param('biblionumber');
119 $itemnumber = $input->param('itemnumber');
122 my $biblio = Koha::Biblios->find($biblionumber);
124 my $op = $input->param('op') || q{};
125 my $hostitemnumber = $input->param('hostitemnumber');
126 my $marcflavour = C4::Context->preference("marcflavour");
127 my $searchid = $input->param('searchid');
128 # fast cataloguing datas
129 my $fa_circborrowernumber = $input->param('circborrowernumber');
130 my $fa_barcode = $input->param('barcode');
131 my $fa_branch = $input->param('branch');
132 my $fa_stickyduedate = $input->param('stickyduedate');
133 my $fa_duedatespec = $input->param('duedatespec');
134 my $volume = $input->param('volume');
135 my $volume_description = $input->param('volume_description');
137 our $frameworkcode = &GetFrameworkCode($biblionumber);
139 # Defining which userflag is needing according to the framework currently used
141 if (defined $input->param('frameworkcode')) {
142 $userflags = ($input->param('frameworkcode') eq 'FA') ? "fast_cataloging" : "edit_items";
145 if (not defined $userflags) {
146 $userflags = ($frameworkcode eq 'FA') ? "fast_cataloging" : "edit_items";
149 my ($template, $loggedinuser, $cookie)
150 = get_template_and_user({template_name => "cataloguing/additem.tt",
153 flagsrequired => {editcatalogue => $userflags},
157 # Does the user have a restricted item editing permission?
158 my $uid = Koha::Patrons->find( $loggedinuser )->userid;
159 my $restrictededition = $uid ? haspermission($uid, {'editcatalogue' => 'edit_items_restricted'}) : undef;
160 # In case user is a superlibrarian, editing is not restricted
161 $restrictededition = 0 if ($restrictededition != 0 && C4::Context->IsSuperLibrarian());
162 # In case user has fast cataloging permission (and we're in fast cataloging), editing is not restricted
163 $restrictededition = 0 if ($restrictededition != 0 && $frameworkcode eq 'FA' && haspermission($uid, {'editcatalogue' => 'fast_cataloging'}));
165 our $tagslib = &GetMarcStructure(1,$frameworkcode);
166 my $record = $biblio->metadata->record;
168 output_and_exit_if_error( $input, $cookie, $template,
169 { module => 'cataloguing', record => $record } );
172 my $nextop="additem";
173 my @errors; # store errors found while checking data BEFORE saving item.
175 # Getting last created item cookie
176 my $prefillitem = C4::Context->preference('PrefillItem');
178 #-------------------------------------------------------------------------------
179 if ($op eq "additem") {
181 my $add_submit = $input->param('add_submit');
182 my $add_duplicate_submit = $input->param('add_duplicate_submit');
183 my $add_multiple_copies_submit = $input->param('add_multiple_copies_submit');
184 my $number_of_copies = $input->param('number_of_copies');
186 my @columns = Koha::Items->columns;
187 my $item = Koha::Item->new;
188 $item->biblionumber($biblio->biblionumber);
189 for my $c ( @columns ) {
190 if ( $c eq 'more_subfields_xml' ) {
191 my @more_subfields_xml = $input->multi_param("items.more_subfields_xml");
192 my @unlinked_item_subfields;
193 for my $subfield ( @more_subfields_xml ) {
194 my $v = $input->param('items.more_subfields_xml_' . $subfield);
195 push @unlinked_item_subfields, $subfield, $v;
197 if ( @unlinked_item_subfields ) {
198 my $marc = MARC::Record->new();
199 # use of tag 999 is arbitrary, and doesn't need to match the item tag
200 # used in the framework
201 $marc->append_fields(MARC::Field->new('999', ' ', ' ', @unlinked_item_subfields));
202 $marc->encoding("UTF-8");
203 $item->more_subfields_xml($marc->as_xml("USMARC"));
206 $item->more_subfields_xml(undef);
208 my @v = grep { $_ ne "" }
209 uniq $input->multi_param( "items." . $c );
213 if ( $c eq 'permanent_location' ) { # See 27837
214 $item->make_column_dirty('permanent_location');
217 $item->$c(join ' | ', @v);
221 # if autoBarcode is set to 'incremental', calculate barcode...
222 if ( ! defined $item->barcode && C4::Context->preference('autoBarcode') eq 'incremental' ) {
223 my ( $barcode ) = C4::Barcodes::ValueBuilder::incremental::get_barcode;
224 $item->barcode($barcode);
227 $item->barcode(barcodedecode($item->barcode));
229 # If we have to add or add & duplicate, we add the item
230 if ( $add_submit || $add_duplicate_submit || $prefillitem) {
232 # check for item barcode # being unique
233 if ( defined $item->barcode
234 && Koha::Items->search( { barcode => $item->barcode } )->count )
236 # if barcode exists, don't create, but report The problem.
237 push @errors, "barcode_not_unique";
239 $current_item = $item->unblessed; # Restore edit form for the same item
242 $item->store->discard_changes;
243 add_item_to_item_group( $item->biblionumber, $item->biblioitemnumber, $volume, $volume_description );
245 # This is a bit tricky : if there is a cookie for the last created item and
246 # we just added an item, the cookie value is not correct yet (it will be updated
247 # next page). To prevent the form from being filled with outdated values, we
248 # force the use of "add and duplicate" feature, so the form will be filled with
251 # Pushing the last created item cookie back
252 if ( $prefillitem ) {
253 my $last_created_item_cookie = $input->cookie(
254 -name => 'LastCreatedItem',
255 # We encode_base64url the whole freezed structure so we're sure we won't have any encoding problems
256 -value => encode_base64url( freeze( { %{$item->unblessed}, itemnumber => undef } ) ),
262 $cookie = [ $cookie, $last_created_item_cookie ];
270 # If we have to add & duplicate
271 if ($prefillitem || $add_duplicate_submit) {
273 $current_item = $item->unblessed;
275 if (C4::Context->preference('autoBarcode') eq 'incremental') {
276 my ( $barcode ) = C4::Barcodes::ValueBuilder::incremental::get_barcode;
277 $current_item->{barcode} = $barcode;
280 # we have to clear the barcode field in the duplicate item record to make way for the new one generated by the javascript plugin
281 $current_item->{barcode} = undef; # FIXME or delete?
284 # Don't use the "prefill" feature if we want to generate the form with all the info from this item
285 # It will remove subfields that are not in SubfieldsToUseWhenPrefill.
286 $prefillitem = 0 if $add_duplicate_submit;
289 # If we have to add multiple copies
290 if ($add_multiple_copies_submit) {
292 $current_item = $item->unblessed;
294 my $copynumber = $current_item->{copynumber};
295 my $oldbarcode = $current_item->{barcode};
297 # If there is a barcode and we can't find their new values, we can't add multiple copies
299 my $barcodeobj = C4::Barcodes->new;
300 $testbarcode = $barcodeobj->next_value($oldbarcode) if $barcodeobj;
301 if ( $oldbarcode && !$testbarcode ) {
303 push @errors, "no_next_barcode";
309 # For the first iteration
310 my $barcodevalue = $oldbarcode;
311 my $exist_itemnumber;
313 for ( my $i = 0 ; $i < $number_of_copies ; ) {
315 # If there is a barcode
318 # Getting a new barcode (if it is not the first iteration or the barcode we tried already exists)
319 $barcodevalue = $barcodeobj->next_value($oldbarcode)
320 if ( $i > 0 || $exist_itemnumber );
322 # Putting it into the record
324 if ( C4::Context->preference("autoBarcode") eq
325 'hbyymmincr' && $i > 0 )
326 { # The first copy already contains the homebranch prefix
327 # This is terribly hacky but the easiest way to fix the way hbyymmincr is working
328 # Contrary to what one might think, the barcode plugin does not prefix the returned string with the homebranch
329 # For a single item, it is handled with some JS code (see cataloguing/value_builder/barcode.pl)
330 # But when adding multiple copies we need to prefix it here,
331 # so we retrieve the homebranch from the item and prefix the barcode with it.
332 my $homebranch = $current_item->{homebranch};
333 $barcodevalue = $homebranch . $barcodevalue;
335 $current_item->{barcode} = $barcodevalue;
338 # Checking if the barcode already exists
339 $exist_itemnumber = Koha::Items->search({ barcode => $barcodevalue })->count;
342 # Updating record with the new copynumber
344 $current_item->{copynumber} = $copynumber;
348 if ( !$exist_itemnumber ) {
349 delete $current_item->{itemnumber};
350 $current_item = Koha::Item->new($current_item)->store(
351 { skip_record_index => 1 } );
352 $current_item->discard_changes; # Cannot chain discard_changes
353 $current_item = $current_item->unblessed;
354 add_item_to_item_group( $item->biblionumber, $item->biblioitemnumber, $volume, $volume_description );
356 # We count the item only if it was really added
357 # That way, all items are added, even if there was some already existing barcodes
358 # FIXME : Please note that there is a risk of infinite loop here if we never find a suitable barcode
361 # Only increment copynumber if item was really added
362 $copynumber++ if ( $copynumber && $copynumber =~ m/^\d+$/ );
365 # Preparing the next iteration
366 $oldbarcode = $barcodevalue;
369 my $indexer = Koha::SearchEngine::Indexer->new(
370 { index => $Koha::SearchEngine::BIBLIOS_INDEX } );
371 $indexer->index_records( $biblionumber, "specialUpdate",
374 undef($current_item);
377 if ($frameworkcode eq 'FA' && $fa_circborrowernumber){
378 print $input->redirect(
379 '/cgi-bin/koha/circ/circulation.pl?'
380 .'borrowernumber='.$fa_circborrowernumber
381 .'&barcode='.uri_escape_utf8($fa_barcode)
382 .'&duedatespec='.$fa_duedatespec
383 .'&stickyduedate='.$fa_stickyduedate
389 #-------------------------------------------------------------------------------
390 } elsif ($op eq "edititem") {
391 #-------------------------------------------------------------------------------
392 # retrieve item if exist => then, it's a modif
393 $current_item = Koha::Items->find($itemnumber)->unblessed;
394 # FIXME Handle non existent item
395 $nextop = "saveitem";
396 #-------------------------------------------------------------------------------
397 } elsif ($op eq "dupeitem") {
398 #-------------------------------------------------------------------------------
399 # retrieve item if exist => then, it's a modif
400 $current_item = Koha::Items->find($itemnumber)->unblessed;
401 # FIXME Handle non existent item
402 if (C4::Context->preference('autoBarcode') eq 'incremental') {
403 my ( $barcode ) = C4::Barcodes::ValueBuilder::incremental::get_barcode;
404 $current_item->{barcode} = $barcode;
407 $current_item->{barcode} = undef; # Don't save it!
411 #-------------------------------------------------------------------------------
412 } elsif ($op eq "delitem") {
413 #-------------------------------------------------------------------------------
414 # check that there is no issue on this item before deletion.
415 my $item = Koha::Items->find($itemnumber);
416 my $deleted = $item->safe_delete;
418 print $input->redirect("additem.pl?biblionumber=$biblionumber&frameworkcode=$frameworkcode&searchid=$searchid");
422 push @errors, @{ $deleted->messages }[0]->message;
425 #-------------------------------------------------------------------------------
426 } elsif ($op eq "delallitems") {
427 #-------------------------------------------------------------------------------
428 my $items = Koha::Items->search({ biblionumber => $biblionumber });
429 while ( my $item = $items->next ) {
430 my $deleted = $item->safe_delete({ skip_record_index => 1 });
431 push @errors, @{$deleted->messages}[0]->message unless $deleted;
433 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
434 $indexer->index_records( $biblionumber, "specialUpdate", "biblioserver" );
438 my $defaultview = C4::Context->preference('IntranetBiblioDefaultView');
439 my $views = { C4::Search::enabled_staff_search_views };
440 if ($defaultview eq 'isbd' && $views->{can_view_ISBD}) {
441 print $input->redirect("/cgi-bin/koha/catalogue/ISBDdetail.pl?biblionumber=$biblionumber&searchid=$searchid");
442 } elsif ($defaultview eq 'marc' && $views->{can_view_MARC}) {
443 print $input->redirect("/cgi-bin/koha/catalogue/MARCdetail.pl?biblionumber=$biblionumber&searchid=$searchid");
444 } elsif ($defaultview eq 'labeled_marc' && $views->{can_view_labeledMARC}) {
445 print $input->redirect("/cgi-bin/koha/catalogue/labeledMARCdetail.pl?biblionumber=$biblionumber&searchid=$searchid");
447 print $input->redirect("/cgi-bin/koha/catalogue/detail.pl?biblionumber=$biblionumber&searchid=$searchid");
451 #-------------------------------------------------------------------------------
452 } elsif ($op eq "saveitem") {
453 #-------------------------------------------------------------------------------
455 my $itemnumber = $input->param('itemnumber');
456 my $item = Koha::Items->find($itemnumber);
457 # FIXME Handle non existent item
458 my $olditemlost = $item->itemlost;
459 my @columns = Koha::Items->columns;
460 my $new_values = $item->unblessed;
461 for my $c ( @columns ) {
462 if ( $c eq 'more_subfields_xml' ) {
463 my @more_subfields_xml = $input->multi_param("items.more_subfields_xml");
464 my @unlinked_item_subfields;
465 for my $subfield ( uniq @more_subfields_xml ) {
466 my @v = $input->multi_param('items.more_subfields_xml_' . encode_utf8($subfield));
467 push @unlinked_item_subfields, $subfield, $_ for @v;
469 if ( @unlinked_item_subfields ) {
470 my $marc = MARC::Record->new();
471 # use of tag 999 is arbitrary, and doesn't need to match the item tag
472 # used in the framework
473 $marc->append_fields(MARC::Field->new('999', ' ', ' ', @unlinked_item_subfields));
474 $marc->encoding("UTF-8");
475 $new_values->{more_subfields_xml} = $marc->as_xml("USMARC");
478 $item->more_subfields_xml(undef);
480 my @v = map { ( defined $_ && $_ eq '' ) ? undef : $_ } $input->multi_param( "items." . $c );
483 if ( $c eq 'permanent_location' ) { # See 27837
484 $item->make_column_dirty('permanent_location');
487 if ( scalar(@v) == 1 && not defined $v[0] ) {
488 delete $new_values->{$c};
490 $new_values->{$c} = join ' | ', @v;
494 $item = $item->set_or_blank($new_values);
496 # check that the barcode don't exist already
498 defined $item->barcode
499 && Koha::Items->search(
501 barcode => $item->barcode,
502 itemnumber => { '!=' => $item->itemnumber }
507 # FIXME We shouldn't need that, ->store would explode as there is a unique constraint on items.barcode
508 push @errors,"barcode_not_unique";
509 $current_item = $item->unblessed; # Restore edit form for the same item
511 my $newitemlost = $item->itemlost;
512 if ( $newitemlost && $newitemlost ge '1' && !$olditemlost ) {
513 LostItem( $item->itemnumber, 'additem' );
519 } elsif ($op eq "delinkitem"){
521 my $analyticfield = '773';
522 if ($marcflavour eq 'MARC21'){
523 $analyticfield = '773';
524 } elsif ($marcflavour eq 'UNIMARC') {
525 $analyticfield = '461';
527 foreach my $field ($record->field($analyticfield)){
528 if ($field->subfield('9') eq $hostitemnumber){
529 $record->delete_field($field);
533 my $modbibresult = ModBiblio($record, $biblionumber,'');
536 # update OAI-PMH sets
538 if (C4::Context->preference("OAI-PMH:AutoUpdateSets")) {
539 C4::OAI::Sets::UpdateOAISetsBiblio($biblionumber, $record);
544 #-------------------------------------------------------------------------------
545 # build screen with existing items. and "new" one
546 #-------------------------------------------------------------------------------
548 # now, build existiing item list
551 for my $item ( $biblio->items->as_list, $biblio->host_items->as_list ) {
552 push @items, $item->columns_to_str;
555 my @witness_attributes = uniq map {
557 map { defined $item->{$_} && $item->{$_} ne "" ? $_ : () } keys %$item
560 our ( $itemtagfield, $itemtagsubfield ) = GetMarcFromKohaField("items.itemnumber");
562 my $subfieldcode_attribute_mappings;
563 for my $subfield_code ( keys %{ $tagslib->{$itemtagfield} } ) {
565 my $subfield = $tagslib->{$itemtagfield}->{$subfield_code};
567 next if IsMarcStructureInternal( $subfield );
568 next unless $subfield->{tab} eq 10; # Is this really needed?
571 if ( $subfield->{kohafield} ) {
572 ( $attribute = $subfield->{kohafield} ) =~ s|^items\.||;
574 $attribute = $subfield_code; # It's in more_subfields_xml
576 next unless grep { $attribute eq $_ } @witness_attributes;
577 $subfieldcode_attribute_mappings->{$subfield_code} = $attribute;
580 my @header_value_loop = map {
582 header_value => $tagslib->{$itemtagfield}->{$_}->{lib},
583 attribute => $subfieldcode_attribute_mappings->{$_},
586 } sort keys %$subfieldcode_attribute_mappings;
588 # Using last created item if it exists
592 && $op ne "dupeitem" )
594 my $item_from_cookie = get_item_from_cookie($input);
595 $current_item = $item_from_cookie if $item_from_cookie;
598 if ( $current_item->{more_subfields_xml} ) {
599 # FIXME Use Maybe MARC::Record::new_from_xml if encoding issues on subfield (??)
600 $current_item->{marc_more_subfields_xml} = MARC::Record->new_from_xml($current_item->{more_subfields_xml}, 'UTF-8');
603 my $branchcode = $input->param('branch') || C4::Context->userenv->{branch};
605 # If we are not adding a new item
607 # If the subfield must be prefilled with last catalogued item
608 my @subfields_to_prefill;
609 if ( $nextop eq 'additem' && $op ne 'dupeitem' && $prefillitem ) {
610 @subfields_to_prefill = split(' ', C4::Context->preference('SubfieldsToUseWhenPrefill'));
611 # Setting to 1 element if SubfieldsToUseWhenPrefill is empty to prevent all the subfields to be prefilled
612 @subfields_to_prefill = ("") unless @subfields_to_prefill;
615 # Getting list of subfields to keep when restricted editing is enabled
616 my @subfields_to_allow = $restrictededition ? split ' ', C4::Context->preference('SubfieldsToAllowForRestrictedEditing') : ();
619 Koha::UI::Form::Builder::Item->new(
620 { biblionumber => $biblionumber, item => $current_item } )->edit_form(
622 branchcode => $branchcode,
623 restricted_editition => $restrictededition,
626 ? ( subfields_to_allow => \@subfields_to_allow )
630 @subfields_to_prefill
631 ? ( subfields_to_prefill => \@subfields_to_prefill )
634 prefill_with_default_values => 1,
635 branch_limit => C4::Context->userenv->{"branch"},
638 ? ( ignore_invisible_subfields => 1 )
644 if ( $frameworkcode eq 'FA' ) {
645 my ( $barcode_field ) = grep {$_->{kohafield} eq 'items.barcode'} @$subfields;
646 $barcode_field->{marc_value}->{value} ||= $input->param('barcode');
649 if( my $default_location = C4::Context->preference('NewItemsDefaultLocation') ) {
650 my ( $location_field ) = grep {$_->{kohafield} eq 'items.location'} @$subfields;
651 $location_field->{marc_value}->{value} ||= $default_location;
654 my @ig = Koha::Biblio::ItemGroups->search({ biblio_id => $biblionumber })->as_list();
655 # what's the next op ? it's what we are not in : an add if we're editing, otherwise, and edit.
660 item_header_loop => \@header_value_loop,
661 subfields => $subfields,
662 itemnumber => $itemnumber,
663 barcode => $current_item->{barcode},
665 popup => scalar $input->param('popup') ? 1: 0,
666 C4::Search::enabled_staff_search_views,
668 $template->{'VARS'}->{'searchid'} = $searchid;
670 if ($frameworkcode eq 'FA'){
671 # fast cataloguing datas
673 'circborrowernumber' => $fa_circborrowernumber,
674 'barcode' => $fa_barcode,
675 'branch' => $fa_branch,
676 'stickyduedate' => $fa_stickyduedate,
677 'duedatespec' => $fa_duedatespec,
681 foreach my $error (@errors) {
682 $template->param($error => 1);
684 output_html_with_http_headers $input, $cookie, $template->output;