4 # Copyright 2000-2002 Katipo Communications
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
30 use C4::BackgroundJob;
35 use List::MoreUtils qw/uniq/;
37 use Koha::AuthorisedValues;
45 my $dbh = C4::Context->dbh;
46 my $error = $input->param('error');
47 my @itemnumbers = $input->multi_param('itemnumber');
48 my $biblionumber = $input->param('biblionumber');
49 my $op = $input->param('op');
50 my $del = $input->param('del');
51 my $del_records = $input->param('del_records');
52 my $completedJobID = $input->param('completedJobID');
53 my $runinbackground = $input->param('runinbackground');
54 my $src = $input->param('src');
55 my $use_default_values = $input->param('use_default_values');
60 $template_name = "tools/batchMod.tt";
61 $template_flag = { tools => '*' };
64 $template_name = ($del) ? "tools/batchMod-del.tt" : "tools/batchMod-edit.tt";
65 $template_flag = ($del) ? { tools => 'items_batchdel' } : { tools => 'items_batchmod' };
69 my ($template, $loggedinuser, $cookie)
70 = get_template_and_user({template_name => $template_name,
74 flagsrequired => $template_flag,
77 # Does the user have a restricted item edition permission?
78 my $uid = $loggedinuser ? Koha::Patrons->find( $loggedinuser )->userid : undef;
79 my $restrictededition = $uid ? haspermission($uid, {'tools' => 'items_batchmod_restricted'}) : undef;
80 # In case user is a superlibrarian, edition is not restricted
81 $restrictededition = 0 if ($restrictededition != 0 && C4::Context->IsSuperLibrarian());
83 $template->param(del => $del);
87 my @errors; # store errors found while checking data BEFORE saving item.
88 my $items_display_hashref;
89 our $tagslib = &GetMarcStructure(1);
91 my $deleted_items = 0; # Number of deleted items
92 my $deleted_records = 0; # Number of deleted records ( with no items attached )
93 my $not_deleted_items = 0; # Number of items that could not be deleted
94 my @not_deleted; # List of the itemnumbers that could not be deleted
95 my $modified_items = 0; # Numbers of modified items
96 my $modified_fields = 0; # Numbers of modified fields
98 my %cookies = parse CGI::Cookie($cookie);
99 my $sessionID = $cookies{'CGISESSID'}->value;
102 #--- ----------------------------------------------------------------------------
103 if ($op eq "action") {
104 #-------------------------------------------------------------------------------
105 my @tags = $input->multi_param('tag');
106 my @subfields = $input->multi_param('subfield');
107 my @values = $input->multi_param('field_value');
108 my @disabled = $input->multi_param('disable_input');
109 # build indicator hash.
110 my @ind_tag = $input->multi_param('ind_tag');
111 my @indicator = $input->multi_param('indicator');
113 # Is there something to modify ?
114 # TODO : We shall use this var to warn the user in case no modification was done to the items
115 my $values_to_modify = scalar(grep {!/^$/} @values);
116 my $values_to_blank = scalar(@disabled);
119 # Once the job is done
120 if ($completedJobID) {
121 # If we have a reasonable amount of items, we display them
122 if (scalar(@itemnumbers) <= ( C4::Context->preference("MaxItemsToDisplayForBatchDel") // 1000 ) ) {
123 $items_display_hashref=BuildItemsData(@itemnumbers);
125 # Else, we only display the barcode
126 my @simple_items_display = map {
128 my $item = Koha::Items->find($itemnumber);
130 itemnumber => $itemnumber,
131 barcode => $item ? ( $item->barcode // q{} ) : q{},
132 biblionumber => $item ? $item->biblio->biblionumber : q{},
135 $template->param("simple_items_display" => \@simple_items_display);
138 # Setting the job as done
139 my $job = C4::BackgroundJob->fetch($sessionID, $completedJobID);
141 # Calling the template
142 add_saved_job_results_to_template($template, $completedJobID);
145 # While the job is getting done
147 # Job size is the number of items we have to process
148 my $job_size = scalar(@itemnumbers);
151 # If we asked for background processing
152 if ($runinbackground) {
153 $job = put_in_background($job_size);
156 #initializing values for updates
157 my ( $itemtagfield, $itemtagsubfield) = &GetMarcFromKohaField("items.itemnumber", "");
158 if ($values_to_modify){
159 my $xml = TransformHtmlToXml(\@tags,\@subfields,\@values,\@indicator,\@ind_tag, 'ITEM');
160 $marcitem = MARC::Record::new_from_xml($xml, 'UTF-8');
162 if ($values_to_blank){
163 foreach my $disabledsubf (@disabled){
164 if ($marcitem && $marcitem->field($itemtagfield)){
165 $marcitem->field($itemtagfield)->update( $disabledsubf => "" );
168 $marcitem = MARC::Record->new();
169 $marcitem->append_fields( MARC::Field->new( $itemtagfield, '', '', $disabledsubf => "" ) );
176 foreach my $itemnumber(@itemnumbers){
178 $job->progress($i) if $runinbackground;
179 my $itemdata = GetItem($itemnumber);
181 my $return = DelItemCheck( $itemdata->{'biblionumber'}, $itemdata->{'itemnumber'});
185 $not_deleted_items++;
187 { biblionumber => $itemdata->{'biblionumber'},
188 itemnumber => $itemdata->{'itemnumber'},
189 barcode => $itemdata->{'barcode'},
190 title => $itemdata->{'title'},
195 # If there are no items left, delete the biblio
196 if ( $del_records ) {
197 my $itemscount = Koha::Biblios->find( $itemdata->{'biblionumber'} )->items->count;
198 if ( $itemscount == 0 ) {
199 my $error = DelBiblio($itemdata->{'biblionumber'});
200 $deleted_records++ unless ( $error );
204 if ($values_to_modify || $values_to_blank) {
205 my $localmarcitem = Item2Marc($itemdata);
207 my $modified = UpdateMarcWith( $marcitem, $localmarcitem );
210 if ( my $item = ModItemFromMarc( $localmarcitem, $itemdata->{biblionumber}, $itemnumber ) ) {
211 LostItem($itemnumber, 'batchmod') if $item->{itemlost} and not $itemdata->{itemlost};
215 if ( $runinbackground ) {
216 $modified_items++ if $modified;
217 $modified_fields += $modified;
219 modified_items => $modified_items,
220 modified_fields => $modified_fields,
230 #-------------------------------------------------------------------------------
231 # build screen with existing items. and "new" one
232 #-------------------------------------------------------------------------------
235 my $filefh = $input->upload('uploadfile');
236 my $filecontent = $input->param('filecontent');
237 my ( @notfoundbarcodes, @notfounditemnumbers);
241 binmode $filefh, ':encoding(UTF-8)';
242 while (my $content=<$filefh>){
243 $content =~ s/[\r\n]*$//;
244 push @contentlist, $content if $content;
247 @contentlist = uniq @contentlist;
248 if ($filecontent eq 'barcode_file') {
249 foreach my $barcode (@contentlist) {
251 my $itemnumber = GetItemnumberFromBarcode($barcode);
253 push @itemnumbers,$itemnumber;
255 push @notfoundbarcodes, $barcode;
259 elsif ( $filecontent eq 'itemid_file') {
260 @itemnumbers = Koha::Items->search({ itemnumber => \@contentlist })->get_column('itemnumber');
261 my %exists = map {$_=>1} @itemnumbers;
262 @notfounditemnumbers = grep { !$exists{$_} } @contentlist;
265 if (defined $biblionumber){
266 my @all_items = GetItemsInfo( $biblionumber );
267 foreach my $itm (@all_items) {
268 push @itemnumbers, $itm->{itemnumber};
271 if ( my $list=$input->param('barcodelist')){
272 push my @barcodelist, uniq( split(/\s\n/, $list) );
274 foreach my $barcode (@barcodelist) {
276 my $itemnumber = GetItemnumberFromBarcode($barcode);
278 push @itemnumbers,$itemnumber;
280 push @notfoundbarcodes, $barcode;
287 # Flag to tell the template there are valid results, hidden or not
288 if(scalar(@itemnumbers) > 0){ $template->param("itemresults" => 1); }
289 # Only display the items if there are no more than pref MaxItemsToProcessForBatchMod or MaxItemsToDisplayForBatchDel
291 ? C4::Context->preference("MaxItemsToDisplayForBatchDel")
292 : C4::Context->preference("MaxItemsToProcessForBatchMod");
293 if (scalar(@itemnumbers) <= ( $max_items // 1000 ) ) {
294 $items_display_hashref=BuildItemsData(@itemnumbers);
296 $template->param("too_many_items" => scalar(@itemnumbers));
297 # Even if we do not display the items, we need the itemnumbers
298 $template->param(itemnumbers_array => \@itemnumbers);
300 # now, build the item form for entering a new item
303 my $branch_limit = C4::Context->userenv ? C4::Context->userenv->{"branch"} : "";
305 my $libraries = Koha::Libraries->search({}, { order_by => ['branchname'] })->unblessed;# build once ahead of time, instead of multiple times later.
307 # Adding a default choice, in case the user does not want to modify the branch
308 my $nochange_branch = { branchname => '', value => '', selected => 1 };
309 unshift (@$libraries, $nochange_branch);
311 my $pref_itemcallnumber = C4::Context->preference('itemcallnumber');
313 # Getting list of subfields to keep when restricted batchmod edit is enabled
314 my $subfieldsToAllowForBatchmod = C4::Context->preference('SubfieldsToAllowForRestrictedBatchmod');
315 my $allowAllSubfields = (
316 not defined $subfieldsToAllowForBatchmod
317 or $subfieldsToAllowForBatchmod eq q||
319 my @subfieldsToAllow = split(/ /, $subfieldsToAllowForBatchmod);
321 foreach my $tag (sort keys %{$tagslib}) {
322 # loop through each subfield
323 foreach my $subfield (sort keys %{$tagslib->{$tag}}) {
324 next if IsMarcStructureInternal( $tagslib->{$tag}{$subfield} );
325 next if (not $allowAllSubfields and $restrictededition && !grep { $tag . '$' . $subfield eq $_ } @subfieldsToAllow );
326 next if ($tagslib->{$tag}->{$subfield}->{'tab'} ne "10");
327 # barcode and stocknumber are not meant to be batch-modified
328 next if $tagslib->{$tag}->{$subfield}->{'kohafield'} eq 'items.barcode';
329 next if $tagslib->{$tag}->{$subfield}->{'kohafield'} eq 'items.stocknumber';
332 my $index_subfield = int(rand(1000000));
333 if ($subfield eq '@'){
334 $subfield_data{id} = "tag_".$tag."_subfield_00_".$index_subfield;
336 $subfield_data{id} = "tag_".$tag."_subfield_".$subfield."_".$index_subfield;
338 $subfield_data{tag} = $tag;
339 $subfield_data{subfield} = $subfield;
340 $subfield_data{marc_lib} ="<span id=\"error$i\" title=\"".$tagslib->{$tag}->{$subfield}->{lib}."\">".$tagslib->{$tag}->{$subfield}->{lib}."</span>";
341 $subfield_data{mandatory} = $tagslib->{$tag}->{$subfield}->{mandatory};
342 $subfield_data{repeatable} = $tagslib->{$tag}->{$subfield}->{repeatable};
344 $value =~ s/"/"/g;
345 if ( !$value && $use_default_values) {
346 $value = $tagslib->{$tag}->{$subfield}->{defaultvalue};
347 # get today date & replace YYYY, MM, DD if provided in the default value
348 my $today = dt_from_string;
349 my $year = $today->year;
350 my $month = $today->month;
351 my $day = $today->day;
352 $value =~ s/YYYY/$year/g;
353 $value =~ s/MM/$month/g;
354 $value =~ s/DD/$day/g;
356 $subfield_data{visibility} = "display:none;" if (($tagslib->{$tag}->{$subfield}->{hidden} > 4) || ($tagslib->{$tag}->{$subfield}->{hidden} < -4));
357 # testing branch value if IndependentBranches.
359 if ( $tagslib->{$tag}->{$subfield}->{authorised_value} ) {
360 my @authorised_values;
362 # builds list, depending on authorised value...
364 if ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "branches" ) {
365 foreach my $library (@$libraries) {
366 push @authorised_values, $library->{branchcode};
367 $authorised_lib{$library->{branchcode}} = $library->{branchname};
371 elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "itemtypes" ) {
372 push @authorised_values, "";
373 my $itemtypes = Koha::ItemTypes->search_with_localization;
374 while ( my $itemtype = $itemtypes->next ) {
375 push @authorised_values, $itemtype->itemtype;
376 $authorised_lib{$itemtype->itemtype} = $itemtype->translated_description;
382 elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "cn_source" ) {
383 push @authorised_values, "" unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
385 my $class_sources = GetClassSources();
386 my $default_source = C4::Context->preference("DefaultClassificationSource");
388 foreach my $class_source (sort keys %$class_sources) {
389 next unless $class_sources->{$class_source}->{'used'} or
390 ($value and $class_source eq $value) or
391 ($class_source eq $default_source);
392 push @authorised_values, $class_source;
393 $authorised_lib{$class_source} = $class_sources->{$class_source}->{'description'};
397 #---- "true" authorised value
400 push @authorised_values, ""; # unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
402 my @avs = Koha::AuthorisedValues->search({ category => $tagslib->{$tag}->{$subfield}->{authorised_value}, branchcode => $branch_limit },{order_by=>'lib'});
403 for my $av ( @avs ) {
404 push @authorised_values, $av->authorised_value;
405 $authorised_lib{$av->authorised_value} = $av->lib;
409 $subfield_data{marc_value} = {
411 id => "tag_".$tag."_subfield_".$subfield."_".$index_subfield,
412 name => "field_value",
413 values => \@authorised_values,
414 labels => \%authorised_lib,
417 # it's a thesaurus / authority field
419 elsif ( $tagslib->{$tag}->{$subfield}->{authtypecode} ) {
420 $subfield_data{marc_value} = {
422 id => $subfield_data{id},
424 authtypecode => $tagslib->{$tag}->{$subfield}->{authtypecode},
427 elsif ( $tagslib->{$tag}->{$subfield}->{value_builder} ) { # plugin
428 require Koha::FrameworkPlugin;
429 my $plugin = Koha::FrameworkPlugin->new( {
430 name => $tagslib->{$tag}->{$subfield}->{'value_builder'},
434 my $pars= { dbh => $dbh, record => $temp, tagslib => $tagslib,
435 id => $subfield_data{id}, tabloop => \@loop_data };
436 $plugin->build( $pars );
437 if( !$plugin->errstr ) {
438 $subfield_data{marc_value} = {
440 id => $subfield_data{id},
442 javascript => $plugin->javascript,
443 noclick => $plugin->noclick,
446 warn $plugin->errstr;
447 $subfield_data{marc_value} = { # supply default input form
449 id => $subfield_data{id},
454 elsif ( $tag eq '' ) { # it's an hidden field
455 $subfield_data{marc_value} = {
457 id => $subfield_data{id},
461 elsif ( $tagslib->{$tag}->{$subfield}->{'hidden'} ) { # FIXME: shouldn't input type be "hidden" ?
462 $subfield_data{marc_value} = {
464 id => $subfield_data{id},
468 elsif ( length($value) > 100
469 or (C4::Context->preference("marcflavour") eq "UNIMARC" and
470 300 <= $tag && $tag < 400 && $subfield eq 'a' )
471 or (C4::Context->preference("marcflavour") eq "MARC21" and
472 500 <= $tag && $tag < 600 )
474 # oversize field (textarea)
475 $subfield_data{marc_value} = {
477 id => $subfield_data{id},
481 # it's a standard field
482 $subfield_data{marc_value} = {
484 id => $subfield_data{id},
488 # $subfield_data{marc_value}="<input type=\"text\" name=\"field_value\">";
489 push (@loop_data, \%subfield_data);
492 } # -- End foreach tag
496 # what's the next op ? it's what we are not in : an add if we're editing, otherwise, and edit.
499 notfoundbarcodes => \@notfoundbarcodes,
500 notfounditemnumbers => \@notfounditemnumbers
503 } # -- End action="show"
505 $template->param(%$items_display_hashref) if $items_display_hashref;
509 $template->param( $op => 1 ) if $op;
511 if ($op eq "action") {
513 #my @not_deleted_loop = map{{itemnumber=>$_}}@not_deleted;
516 not_deleted_items => $not_deleted_items,
517 deleted_items => $deleted_items,
518 delete_records => $del_records,
519 deleted_records => $deleted_records,
520 not_deleted_loop => \@not_deleted
524 foreach my $error (@errors) {
525 $template->param($error => 1) if $error;
527 $template->param(src => $src);
528 $template->param(biblionumber => $biblionumber);
529 output_html_with_http_headers $input, $cookie, $template->output;
533 # ---------------- Functions
537 # now, build existiing item list
538 my %witness; #---- stores the list of subfields used at least once, with the "meaning" of the code
540 #---- finds where items.itemnumber is stored
541 my ( $itemtagfield, $itemtagsubfield) = &GetMarcFromKohaField("items.itemnumber", "");
542 my ($branchtagfield, $branchtagsubfield) = &GetMarcFromKohaField("items.homebranch", "");
543 foreach my $itemnumber (@itemnumbers){
544 my $itemdata=GetItem($itemnumber);
545 my $itemmarc=Item2Marc($itemdata);
547 foreach my $field (grep {$_->tag() eq $itemtagfield} $itemmarc->fields()) {
548 # loop through each subfield
549 my $itembranchcode=$field->subfield($branchtagsubfield);
550 if ($itembranchcode && C4::Context->preference("IndependentBranches")) {
552 my $userenv = C4::Context->userenv();
553 unless (C4::Context->IsSuperLibrarian() or (($userenv->{'branch'} eq $itembranchcode))){
554 $this_row{'nomod'}=1;
557 my $tag=$field->tag();
558 foreach my $subfield ($field->subfields) {
559 my ($subfcode,$subfvalue)=@$subfield;
560 next if ($tagslib->{$tag}->{$subfcode}->{tab} ne 10
561 && $tag ne $itemtagfield
562 && $subfcode ne $itemtagsubfield);
564 $witness{$subfcode} = $tagslib->{$tag}->{$subfcode}->{lib} if ($tagslib->{$tag}->{$subfcode}->{tab} eq 10);
565 if ($tagslib->{$tag}->{$subfcode}->{tab} eq 10) {
566 $this_row{$subfcode}=GetAuthorisedValueDesc( $tag,
567 $subfcode, $subfvalue, '', $tagslib)
571 $this_row{itemnumber} = $subfvalue if ($tag eq $itemtagfield && $subfcode eq $itemtagsubfield);
575 # grab title, author, and ISBN to identify bib that the item
576 # belongs to in the display
577 my $biblio = Koha::Biblios->find( $itemdata->{biblionumber} );
578 $this_row{title} = $biblio->title;
579 $this_row{author} = $biblio->author;
580 $this_row{isbn} = $biblio->biblioitem->isbn;
581 $this_row{biblionumber} = $biblio->biblionumber;
584 push(@big_array, \%this_row);
587 @big_array = sort {$a->{0} cmp $b->{0}} @big_array;
589 # now, construct template !
590 # First, the existing items for display
592 my @witnesscodessorted=sort keys %witness;
593 for my $row ( @big_array ) {
595 my @item_fields = map +{ field => $_ || '' }, @$row{ @witnesscodessorted };
596 $row_data{item_value} = [ @item_fields ];
597 $row_data{itemnumber} = $row->{itemnumber};
598 #reporting this_row values
599 $row_data{'nomod'} = $row->{'nomod'};
600 $row_data{bibinfo} = $row->{bibinfo};
601 $row_data{author} = $row->{author};
602 $row_data{title} = $row->{title};
603 $row_data{isbn} = $row->{isbn};
604 $row_data{biblionumber} = $row->{biblionumber};
605 my $is_on_loan = C4::Circulation::IsItemIssued( $row->{itemnumber} );
606 $row_data{onloan} = $is_on_loan ? 1 : 0;
607 push(@item_value_loop,\%row_data);
609 my @header_loop=map { { header_value=> $witness{$_}} } @witnesscodessorted;
611 return { item_loop => \@item_value_loop, item_header_loop => \@header_loop };
614 #BE WARN : it is not the general case
615 # This function can be OK in the item marc record special case
616 # Where subfield is not repeated
617 # And where we are sure that field should correspond
620 my ($marcfrom,$marcto)=@_;
621 my ( $itemtag, $itemtagsubfield) = &GetMarcFromKohaField("items.itemnumber", "");
622 my $fieldfrom=$marcfrom->field($itemtag);
623 my @fields_to=$marcto->field($itemtag);
625 foreach my $subfield ( $fieldfrom->subfields() ) {
626 foreach my $field_to_update ( @fields_to ) {
627 if ( $subfield->[1] ) {
628 unless ( $field_to_update->subfield($subfield->[0]) eq $subfield->[1] ) {
630 $field_to_update->update( $subfield->[0] => $subfield->[1] );
635 $field_to_update->delete_subfield( code => $subfield->[0] );
643 my ($tagfield,$insubfield,$record) = @_;
646 foreach my $field ($record->field($tagfield)) {
647 my @subfields = $field->subfields();
648 foreach my $subfield (@subfields) {
649 if (@$subfield[0] eq $insubfield) {
650 $result .= @$subfield[1];
651 $indicator = $field->indicator(1).$field->indicator(2);
655 return($indicator,$result);
658 # ----------------------------
659 # Background functions
662 sub add_results_to_template {
663 my $template = shift;
665 $template->param(map { $_ => $results->{$_} } keys %{ $results });
668 sub add_saved_job_results_to_template {
669 my $template = shift;
670 my $completedJobID = shift;
671 my $job = C4::BackgroundJob->fetch($sessionID, $completedJobID);
672 my $results = $job->results();
673 add_results_to_template($template, $results);
675 my $fields = $job->get("modified_fields");
676 my $items = $job->get("modified_items");
678 modified_items => $items,
679 modified_fields => $fields,
683 sub put_in_background {
684 my $job_size = shift;
686 my $job = C4::BackgroundJob->new($sessionID, "test", '/cgi-bin/koha/tools/batchMod.pl', $job_size);
687 my $jobID = $job->id();
690 if (my $pid = fork) {
692 # return job ID as JSON
694 # prevent parent exiting from
695 # destroying the kid's database handle
696 # FIXME: according to DBI doc, this may not work for Oracle
697 $dbh->{InactiveDestroy} = 1;
699 my $reply = CGI->new("");
700 print $reply->header(-type => 'text/html');
701 print '{"jobID":"' . $jobID . '"}';
703 } elsif (defined $pid) {
705 # close STDOUT to signal to Apache that
706 # we're now running in the background
710 # fork failed, so exit immediately
711 warn "fork failed while attempting to run tools/batchMod.pl as a background job";