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>.
23 #use warnings; FIXME - Bug 2505
30 use C4
::Koha
; # XXX subfield_is_koha_internal_p
31 use C4
::Branch
; # XXX subfield_is_koha_internal_p
32 use C4
::BackgroundJob
;
37 use List
::MoreUtils qw
/uniq/;
41 my $dbh = C4
::Context
->dbh;
42 my $error = $input->param('error');
43 my @itemnumbers = $input->param('itemnumber');
44 my $biblionumber = $input->param('biblionumber');
45 my $op = $input->param('op');
46 my $del = $input->param('del');
47 my $del_records = $input->param('del_records');
48 my $completedJobID = $input->param('completedJobID');
49 my $runinbackground = $input->param('runinbackground');
50 my $src = $input->param('src');
51 my $use_default_values = $input->param('use_default_values');
56 $template_name = "tools/batchMod.tt";
57 $template_flag = { tools
=> '*' };
60 $template_name = ($del) ?
"tools/batchMod-del.tt" : "tools/batchMod-edit.tt";
61 $template_flag = ($del) ?
{ tools
=> 'items_batchdel' } : { tools
=> 'items_batchmod' };
65 my ($template, $loggedinuser, $cookie)
66 = get_template_and_user
({template_name
=> $template_name,
70 flagsrequired
=> $template_flag,
73 # Does the user have a restricted item edition permission?
74 my $uid = $loggedinuser ? GetMember
( borrowernumber
=> $loggedinuser )->{userid
} : undef;
75 my $restrictededition = $uid ? haspermission
($uid, {'tools' => 'items_batchmod_restricted'}) : undef;
76 # In case user is a superlibrarian, edition is not restricted
77 $restrictededition = 0 if ($restrictededition != 0 && C4
::Context
->IsSuperLibrarian());
79 $template->param(del
=> $del);
83 my @errors; # store errors found while checking data BEFORE saving item.
84 my $items_display_hashref;
85 our $tagslib = &GetMarcStructure
(1);
87 my $deleted_items = 0; # Number of deleted items
88 my $deleted_records = 0; # Number of deleted records ( with no items attached )
89 my $not_deleted_items = 0; # Number of items that could not be deleted
90 my @not_deleted; # List of the itemnumbers that could not be deleted
91 my $modified_items = 0; # Numbers of modified items
92 my $modified_fields = 0; # Numbers of modified fields
94 my %cookies = parse CGI
::Cookie
($cookie);
95 my $sessionID = $cookies{'CGISESSID'}->value;
98 #--- ----------------------------------------------------------------------------
99 if ($op eq "action") {
100 #-------------------------------------------------------------------------------
101 my @tags = $input->param('tag');
102 my @subfields = $input->param('subfield');
103 my @values = $input->param('field_value');
104 my @disabled = $input->param('disable_input');
105 # build indicator hash.
106 my @ind_tag = $input->param('ind_tag');
107 my @indicator = $input->param('indicator');
109 # Is there something to modify ?
110 # TODO : We shall use this var to warn the user in case no modification was done to the items
111 my $values_to_modify = scalar(grep {!/^$/} @values);
112 my $values_to_blank = scalar(@disabled);
115 # Once the job is done
116 if ($completedJobID) {
117 # If we have a reasonable amount of items, we display them
118 if (scalar(@itemnumbers) <= ( C4
::Context
->preference("MaxItemsForBatch") // 1000 ) ) {
119 $items_display_hashref=BuildItemsData
(@itemnumbers);
121 # Else, we only display the barcode
122 my @simple_items_display = map {{ itemnumber
=> $_, barcode
=> (GetBarcodeFromItemnumber
($_) or ""), biblionumber
=> (GetBiblionumberFromItemnumber
($_) or "") }} @itemnumbers;
123 $template->param("simple_items_display" => \
@simple_items_display);
126 # Setting the job as done
127 my $job = C4
::BackgroundJob
->fetch($sessionID, $completedJobID);
129 # Calling the template
130 add_saved_job_results_to_template
($template, $completedJobID);
133 # While the job is getting done
135 # Job size is the number of items we have to process
136 my $job_size = scalar(@itemnumbers);
139 # If we asked for background processing
140 if ($runinbackground) {
141 $job = put_in_background
($job_size);
144 #initializing values for updates
145 my ( $itemtagfield, $itemtagsubfield) = &GetMarcFromKohaField
("items.itemnumber", "");
146 if ($values_to_modify){
147 my $xml = TransformHtmlToXml
(\
@tags,\
@subfields,\
@values,\
@indicator,\
@ind_tag, 'ITEM');
148 $marcitem = MARC
::Record
::new_from_xml
($xml, 'UTF-8');
150 if ($values_to_blank){
151 foreach my $disabledsubf (@disabled){
152 if ($marcitem && $marcitem->field($itemtagfield)){
153 $marcitem->field($itemtagfield)->update( $disabledsubf => "" );
156 $marcitem = MARC
::Record
->new();
157 $marcitem->append_fields( MARC
::Field
->new( $itemtagfield, '', '', $disabledsubf => "" ) );
164 foreach my $itemnumber(@itemnumbers){
166 $job->progress($i) if $runinbackground;
167 my $itemdata = GetItem
($itemnumber);
169 my $return = DelItemCheck
(C4
::Context
->dbh, $itemdata->{'biblionumber'}, $itemdata->{'itemnumber'});
173 $not_deleted_items++;
175 { biblionumber
=> $itemdata->{'biblionumber'},
176 itemnumber
=> $itemdata->{'itemnumber'},
177 barcode
=> $itemdata->{'barcode'},
178 title
=> $itemdata->{'title'},
183 # If there are no items left, delete the biblio
184 if ( $del_records ) {
185 my $itemscount = GetItemsCount
($itemdata->{'biblionumber'});
186 if ( $itemscount == 0 ) {
187 my $error = DelBiblio
($itemdata->{'biblionumber'});
188 $deleted_records++ unless ( $error );
192 if ($values_to_modify || $values_to_blank) {
193 my $localmarcitem = Item2Marc
($itemdata);
195 my $modified = UpdateMarcWith
( $marcitem, $localmarcitem );
198 if ( my $item = ModItemFromMarc
( $localmarcitem, $itemdata->{biblionumber
}, $itemnumber ) ) {
199 LostItem
($itemnumber, 'MARK RETURNED') if $item->{itemlost
} and not $itemdata->{itemlost
};
203 if ( $runinbackground ) {
204 $modified_items++ if $modified;
205 $modified_fields += $modified;
207 modified_items
=> $modified_items,
208 modified_fields
=> $modified_fields,
218 #-------------------------------------------------------------------------------
219 # build screen with existing items. and "new" one
220 #-------------------------------------------------------------------------------
223 my $filefh = $input->upload('uploadfile');
224 my $filecontent = $input->param('filecontent');
225 my @notfoundbarcodes;
229 while (my $content=<$filefh>){
230 $content =~ s/[\r\n]*$//;
231 push @contentlist, $content if $content;
234 if ($filecontent eq 'barcode_file') {
235 foreach my $barcode (@contentlist) {
237 my $itemnumber = GetItemnumberFromBarcode
($barcode);
239 push @itemnumbers,$itemnumber;
241 push @notfoundbarcodes, $barcode;
245 elsif ( $filecontent eq 'itemid_file') {
246 @itemnumbers = @contentlist;
249 if (defined $biblionumber){
250 my @all_items = GetItemsInfo
( $biblionumber );
251 foreach my $itm (@all_items) {
252 push @itemnumbers, $itm->{itemnumber
};
255 if ( my $list=$input->param('barcodelist')){
256 push my @barcodelist, uniq
( split(/\s\n/, $list) );
258 foreach my $barcode (@barcodelist) {
260 my $itemnumber = GetItemnumberFromBarcode
($barcode);
262 push @itemnumbers,$itemnumber;
264 push @notfoundbarcodes, $barcode;
271 # Flag to tell the template there are valid results, hidden or not
272 if(scalar(@itemnumbers) > 0){ $template->param("itemresults" => 1); }
273 # Only display the items if there are no more than pref MaxItemsForBatch
274 if (scalar(@itemnumbers) <= ( C4
::Context
->preference("MaxItemsForBatch") // 1000 ) ) {
275 $items_display_hashref=BuildItemsData
(@itemnumbers);
277 $template->param("too_many_items" => scalar(@itemnumbers));
278 # Even if we do not display the items, we need the itemnumbers
279 $template->param(itemnumbers_array
=> \
@itemnumbers);
281 # now, build the item form for entering a new item
284 my $branch_limit = C4
::Context
->userenv ? C4
::Context
->userenv->{"branch"} : "";
285 my $query = qq{SELECT authorised_value
, lib FROM authorised_values
};
286 $query .= qq{ LEFT JOIN authorised_values_branches ON
( id
= av_id
) } if $branch_limit;
287 $query .= qq{ WHERE category
= ?
};
288 $query .= qq{ AND
( branchcode
= ? OR branchcode IS NULL
) } if $branch_limit;
289 $query .= qq{ GROUP BY lib ORDER BY lib
, lib_opac
};
290 my $authorised_values_sth = $dbh->prepare( $query );
292 my $branches = GetBranchesLoop
(); # build once ahead of time, instead of multiple times later.
294 # Adding a default choice, in case the user does not want to modify the branch
295 my $nochange_branch = { branchname
=> '', value
=> '', selected
=> 1 };
296 unshift (@
$branches, $nochange_branch);
298 my $pref_itemcallnumber = C4
::Context
->preference('itemcallnumber');
300 # Getting list of subfields to keep when restricted batchmod edit is enabled
301 my $subfieldsToAllowForBatchmod = C4
::Context
->preference('SubfieldsToAllowForRestrictedBatchmod');
302 my $allowAllSubfields = (
303 not defined $subfieldsToAllowForBatchmod
304 or $subfieldsToAllowForBatchmod == q
||
306 my @subfieldsToAllow = split(/ /, $subfieldsToAllowForBatchmod);
308 foreach my $tag (sort keys %{$tagslib}) {
309 # loop through each subfield
310 foreach my $subfield (sort keys %{$tagslib->{$tag}}) {
311 next if subfield_is_koha_internal_p
($subfield);
312 next if (not $allowAllSubfields and $restrictededition && !grep { $tag . '$' . $subfield eq $_ } @subfieldsToAllow );
313 next if ($tagslib->{$tag}->{$subfield}->{'tab'} ne "10");
314 # barcode and stocknumber are not meant to be batch-modified
315 next if $tagslib->{$tag}->{$subfield}->{'kohafield'} eq 'items.barcode';
316 next if $tagslib->{$tag}->{$subfield}->{'kohafield'} eq 'items.stocknumber';
319 my $index_subfield = int(rand(1000000));
320 if ($subfield eq '@'){
321 $subfield_data{id
} = "tag_".$tag."_subfield_00_".$index_subfield;
323 $subfield_data{id
} = "tag_".$tag."_subfield_".$subfield."_".$index_subfield;
325 $subfield_data{tag
} = $tag;
326 $subfield_data{subfield
} = $subfield;
327 $subfield_data{marc_lib
} ="<span id=\"error$i\" title=\"".$tagslib->{$tag}->{$subfield}->{lib
}."\">".$tagslib->{$tag}->{$subfield}->{lib
}."</span>";
328 $subfield_data{mandatory
} = $tagslib->{$tag}->{$subfield}->{mandatory
};
329 $subfield_data{repeatable
} = $tagslib->{$tag}->{$subfield}->{repeatable
};
331 $value =~ s/"/"/g;
332 if ( !$value && $use_default_values) {
333 $value = $tagslib->{$tag}->{$subfield}->{defaultvalue
};
334 # get today date & replace YYYY, MM, DD if provided in the default value
335 my $today = dt_from_string
;
336 my $year = $today->year;
337 my $month = $today->month;
338 my $day = $today->day;
339 $value =~ s/YYYY/$year/g;
340 $value =~ s/MM/$month/g;
341 $value =~ s/DD/$day/g;
343 $subfield_data{visibility
} = "display:none;" if (($tagslib->{$tag}->{$subfield}->{hidden
} > 4) || ($tagslib->{$tag}->{$subfield}->{hidden
} < -4));
344 # testing branch value if IndependentBranches.
346 if ( $tagslib->{$tag}->{$subfield}->{authorised_value
} ) {
347 my @authorised_values;
349 # builds list, depending on authorised value...
351 if ( $tagslib->{$tag}->{$subfield}->{authorised_value
} eq "branches" ) {
352 foreach my $thisbranch (@
$branches) {
353 push @authorised_values, $thisbranch->{value
};
354 $authorised_lib{$thisbranch->{value
}} = $thisbranch->{branchname
};
358 elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value
} eq "itemtypes" ) {
359 push @authorised_values, "";
360 my $itemtypes = GetItemTypes
( style
=> 'array' );
361 for my $itemtype ( @
$itemtypes ) {
362 push @authorised_values, $itemtype->{itemtype
};
363 $authorised_lib{$itemtype->{itemtype
}} = $itemtype->{translated_description
};
369 elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value
} eq "cn_source" ) {
370 push @authorised_values, "" unless ( $tagslib->{$tag}->{$subfield}->{mandatory
} );
372 my $class_sources = GetClassSources
();
373 my $default_source = C4
::Context
->preference("DefaultClassificationSource");
375 foreach my $class_source (sort keys %$class_sources) {
376 next unless $class_sources->{$class_source}->{'used'} or
377 ($value and $class_source eq $value) or
378 ($class_source eq $default_source);
379 push @authorised_values, $class_source;
380 $authorised_lib{$class_source} = $class_sources->{$class_source}->{'description'};
384 #---- "true" authorised value
387 push @authorised_values, ""; # unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
388 $authorised_values_sth->execute( $tagslib->{$tag}->{$subfield}->{authorised_value
}, $branch_limit ?
$branch_limit : () );
389 while ( my ( $value, $lib ) = $authorised_values_sth->fetchrow_array ) {
390 push @authorised_values, $value;
391 $authorised_lib{$value} = $lib;
395 $subfield_data{marc_value
} = {
397 id
=> "tag_".$tag."_subfield_".$subfield."_".$index_subfield,
398 name
=> "field_value",
399 values => \
@authorised_values,
400 labels
=> \
%authorised_lib,
403 # it's a thesaurus / authority field
405 elsif ( $tagslib->{$tag}->{$subfield}->{authtypecode
} ) {
406 $subfield_data{marc_value
} = {
408 id
=> $subfield_data{id
},
410 authtypecode
=> $tagslib->{$tag}->{$subfield}->{authtypecode
},
413 elsif ( $tagslib->{$tag}->{$subfield}->{value_builder
} ) { # plugin
414 require Koha
::FrameworkPlugin
;
415 my $plugin = Koha
::FrameworkPlugin
->new( {
416 name
=> $tagslib->{$tag}->{$subfield}->{'value_builder'},
420 my $pars= { dbh
=> $dbh, record
=> $temp, tagslib
=> $tagslib,
421 id
=> $subfield_data{id
}, tabloop
=> \
@loop_data };
422 $plugin->build( $pars );
423 if( !$plugin->errstr ) {
424 $subfield_data{marc_value
} = {
426 id
=> $subfield_data{id
},
428 javascript
=> $plugin->javascript,
429 noclick
=> $plugin->noclick,
432 warn $plugin->errstr;
433 $subfield_data{marc_value
} = { # supply default input form
435 id
=> $subfield_data{id
},
440 elsif ( $tag eq '' ) { # it's an hidden field
441 $subfield_data{marc_value
} = {
443 id
=> $subfield_data{id
},
447 elsif ( $tagslib->{$tag}->{$subfield}->{'hidden'} ) { # FIXME: shouldn't input type be "hidden" ?
448 $subfield_data{marc_value
} = {
450 id
=> $subfield_data{id
},
454 elsif ( length($value) > 100
455 or (C4
::Context
->preference("marcflavour") eq "UNIMARC" and
456 300 <= $tag && $tag < 400 && $subfield eq 'a' )
457 or (C4
::Context
->preference("marcflavour") eq "MARC21" and
458 500 <= $tag && $tag < 600 )
460 # oversize field (textarea)
461 $subfield_data{marc_value
} = {
463 id
=> $subfield_data{id
},
467 # it's a standard field
468 $subfield_data{marc_value
} = {
470 id
=> $subfield_data{id
},
474 # $subfield_data{marc_value}="<input type=\"text\" name=\"field_value\">";
475 push (@loop_data, \
%subfield_data);
478 } # -- End foreach tag
479 $authorised_values_sth->finish;
483 # what's the next op ? it's what we are not in : an add if we're editing, otherwise, and edit.
484 $template->param(item
=> \
@loop_data);
485 if (@notfoundbarcodes) {
486 my @notfoundbarcodesloop = map{{barcode
=>$_}}@notfoundbarcodes;
487 $template->param(notfoundbarcodes
=> \
@notfoundbarcodesloop);
490 } # -- End action="show"
492 $template->param(%$items_display_hashref) if $items_display_hashref;
496 $template->param( $op => 1 ) if $op;
498 if ($op eq "action") {
500 #my @not_deleted_loop = map{{itemnumber=>$_}}@not_deleted;
503 not_deleted_items
=> $not_deleted_items,
504 deleted_items
=> $deleted_items,
505 delete_records
=> $del_records,
506 deleted_records
=> $deleted_records,
507 not_deleted_loop
=> \
@not_deleted
511 foreach my $error (@errors) {
512 $template->param($error => 1) if $error;
514 $template->param(src
=> $src);
515 $template->param(biblionumber
=> $biblionumber);
516 output_html_with_http_headers
$input, $cookie, $template->output;
520 # ---------------- Functions
524 # now, build existiing item list
525 my %witness; #---- stores the list of subfields used at least once, with the "meaning" of the code
527 #---- finds where items.itemnumber is stored
528 my ( $itemtagfield, $itemtagsubfield) = &GetMarcFromKohaField
("items.itemnumber", "");
529 my ($branchtagfield, $branchtagsubfield) = &GetMarcFromKohaField
("items.homebranch", "");
530 foreach my $itemnumber (@itemnumbers){
531 my $itemdata=GetItem
($itemnumber);
532 my $itemmarc=Item2Marc
($itemdata);
534 foreach my $field (grep {$_->tag() eq $itemtagfield} $itemmarc->fields()) {
535 # loop through each subfield
536 my $itembranchcode=$field->subfield($branchtagsubfield);
537 if ($itembranchcode && C4
::Context
->preference("IndependentBranches")) {
539 my $userenv = C4
::Context
->userenv();
540 unless (C4
::Context
->IsSuperLibrarian() or (($userenv->{'branch'} eq $itembranchcode))){
541 $this_row{'nomod'}=1;
544 my $tag=$field->tag();
545 foreach my $subfield ($field->subfields) {
546 my ($subfcode,$subfvalue)=@
$subfield;
547 next if ($tagslib->{$tag}->{$subfcode}->{tab
} ne 10
548 && $tag ne $itemtagfield
549 && $subfcode ne $itemtagsubfield);
551 $witness{$subfcode} = $tagslib->{$tag}->{$subfcode}->{lib
} if ($tagslib->{$tag}->{$subfcode}->{tab
} eq 10);
552 if ($tagslib->{$tag}->{$subfcode}->{tab
} eq 10) {
553 $this_row{$subfcode}=GetAuthorisedValueDesc
( $tag,
554 $subfcode, $subfvalue, '', $tagslib)
558 $this_row{itemnumber
} = $subfvalue if ($tag eq $itemtagfield && $subfcode eq $itemtagsubfield);
562 # grab title, author, and ISBN to identify bib that the item
563 # belongs to in the display
564 my $biblio=GetBiblioData
($$itemdata{biblionumber
});
565 $this_row{title
} = $biblio->{title
};
566 $this_row{author
} = $biblio->{author
};
567 $this_row{isbn
} = $biblio->{isbn
};
568 $this_row{biblionumber
} = $biblio->{biblionumber
};
571 push(@big_array, \
%this_row);
574 @big_array = sort {$a->{0} cmp $b->{0}} @big_array;
576 # now, construct template !
577 # First, the existing items for display
579 my @witnesscodessorted=sort keys %witness;
580 for my $row ( @big_array ) {
582 my @item_fields = map +{ field
=> $_ || '' }, @
$row{ @witnesscodessorted };
583 $row_data{item_value
} = [ @item_fields ];
584 $row_data{itemnumber
} = $row->{itemnumber
};
585 #reporting this_row values
586 $row_data{'nomod'} = $row->{'nomod'};
587 $row_data{bibinfo
} = $row->{bibinfo
};
588 $row_data{author
} = $row->{author
};
589 $row_data{title
} = $row->{title
};
590 $row_data{isbn
} = $row->{isbn
};
591 $row_data{biblionumber
} = $row->{biblionumber
};
592 my $is_on_loan = C4
::Circulation
::IsItemIssued
( $row->{itemnumber
} );
593 $row_data{onloan
} = $is_on_loan ?
1 : 0;
594 push(@item_value_loop,\
%row_data);
596 my @header_loop=map { { header_value
=> $witness{$_}} } @witnesscodessorted;
598 return { item_loop
=> \
@item_value_loop, item_header_loop
=> \
@header_loop };
601 #BE WARN : it is not the general case
602 # This function can be OK in the item marc record special case
603 # Where subfield is not repeated
604 # And where we are sure that field should correspond
607 my ($marcfrom,$marcto)=@_;
608 my ( $itemtag, $itemtagsubfield) = &GetMarcFromKohaField
("items.itemnumber", "");
609 my $fieldfrom=$marcfrom->field($itemtag);
610 my @fields_to=$marcto->field($itemtag);
612 foreach my $subfield ( $fieldfrom->subfields() ) {
613 foreach my $field_to_update ( @fields_to ) {
614 if ( $subfield->[1] ) {
615 unless ( $field_to_update->subfield($subfield->[0]) eq $subfield->[1] ) {
617 $field_to_update->update( $subfield->[0] => $subfield->[1] );
622 $field_to_update->delete_subfield( code
=> $subfield->[0] );
630 my ($tagfield,$insubfield,$record) = @_;
633 foreach my $field ($record->field($tagfield)) {
634 my @subfields = $field->subfields();
635 foreach my $subfield (@subfields) {
636 if (@
$subfield[0] eq $insubfield) {
637 $result .= @
$subfield[1];
638 $indicator = $field->indicator(1).$field->indicator(2);
642 return($indicator,$result);
645 # ----------------------------
646 # Background functions
649 sub add_results_to_template
{
650 my $template = shift;
652 $template->param(map { $_ => $results->{$_} } keys %{ $results });
655 sub add_saved_job_results_to_template
{
656 my $template = shift;
657 my $completedJobID = shift;
658 my $job = C4
::BackgroundJob
->fetch($sessionID, $completedJobID);
659 my $results = $job->results();
660 add_results_to_template
($template, $results);
662 my $fields = $job->get("modified_fields");
663 my $items = $job->get("modified_items");
665 modified_items
=> $items,
666 modified_fields
=> $fields,
670 sub put_in_background
{
671 my $job_size = shift;
673 my $job = C4
::BackgroundJob
->new($sessionID, "test", '/cgi-bin/koha/tools/batchMod.pl', $job_size);
674 my $jobID = $job->id();
677 if (my $pid = fork) {
679 # return job ID as JSON
681 # prevent parent exiting from
682 # destroying the kid's database handle
683 # FIXME: according to DBI doc, this may not work for Oracle
684 $dbh->{InactiveDestroy
} = 1;
686 my $reply = CGI
->new("");
687 print $reply->header(-type
=> 'text/html');
688 print '{"jobID":"' . $jobID . '"}';
690 } elsif (defined $pid) {
692 # close STDOUT to signal to Apache that
693 # we're now running in the background
697 # fork failed, so exit immediately
698 warn "fork failed while attempting to run tools/batchMod.pl as a background job";