3 # This file is part of Koha.
4 # Copyright 2006-2010 BibLibre
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>.
23 use C4::Auth qw( get_template_and_user );
24 use C4::Output qw( output_html_with_http_headers );
26 use C4::Koha qw( GetAuthorisedValues );
27 use C4::Budgets qw( GetBudget GetBudgets GetBudgetHierarchy CanUserUseBudget );
28 use C4::Search qw( FindDuplicate GetDistinctValues );
30 use Koha::DateUtils qw( dt_from_string );
31 use Koha::AuthorisedValues;
32 use Koha::Acquisition::Currencies;
36 use URI::Escape qw( uri_escape );
39 my $suggestion= shift @_;
40 # "Managed by" is used only when a suggestion is being edited (not when created)
41 if ($suggestion->{'suggesteddate'} eq "") {
43 $suggestion->{suggesteddate} = dt_from_string;
44 $suggestion->{'suggestedby'} = C4::Context->userenv->{"number"} unless ($suggestion->{'suggestedby'});
47 # editing of an existing suggestion
48 $suggestion->{manageddate} = dt_from_string;
49 $suggestion->{'managedby'} = C4::Context->userenv->{"number"} unless ($suggestion->{'managedby'});
51 $suggestion->{'branchcode'}=C4::Context->userenv->{"branch"} unless ($suggestion->{'branchcode'});
55 my ($criteriumvalue,$displayby)=@_;
56 if ($displayby =~ /status/i) {
57 unless ( grep { /$criteriumvalue/ } qw(ASKED ACCEPTED REJECTED CHECKED ORDERED AVAILABLE) ) {
58 my $av = Koha::AuthorisedValues->search({ category => 'SUGGEST_STATUS', authorised_value => $criteriumvalue });
59 return $av->count ? $av->next->lib : 'Unknown';
61 return ($criteriumvalue eq 'ASKED'?"Pending":ucfirst(lc( $criteriumvalue))) if ($displayby =~/status/i);
63 if ( $displayby =~ /branchcode/ ) {
64 return $criteriumvalue ? Koha::Libraries->find($criteriumvalue)->branchname : "__ANY__";
66 if ( $displayby =~ /itemtype/ ) {
67 my $av = Koha::AuthorisedValues->search({ category => 'SUGGEST_FORMAT', authorised_value => $criteriumvalue });
68 return $av->count ? $av->next->lib : 'Unknown';
70 if ($displayby =~/suggestedby/||$displayby =~/managedby/||$displayby =~/acceptedby/){
71 my $patron = Koha::Patrons->find( $criteriumvalue );
72 return "" unless $patron;
73 return $patron->surname . ", " . $patron->firstname;
75 if ( $displayby =~ /budgetid/) {
76 my $budget = GetBudget($criteriumvalue);
77 return "" unless $budget;
78 return $$budget{budget_name};
83 my $redirect = $input->param('redirect');
84 my $suggestedbyme = (defined $input->param('suggestedbyme')? $input->param('suggestedbyme'):1);
85 my $op = $input->param('op')||'else';
86 my @editsuggestions = $input->multi_param('suggestionid');
87 my $suggestedby = $input->param('suggestedby');
88 my $returnsuggestedby = $input->param('returnsuggestedby');
89 my $returnsuggested = $input->param('returnsuggested');
90 my $managedby = $input->param('managedby');
91 my $displayby = $input->param('displayby') || '';
92 my $tabcode = $input->param('tabcode');
93 my $save_confirmed = $input->param('save_confirmed') || 0;
94 my $notify = $input->param('notify');
95 my $filter_archived = $input->param('filter_archived');
97 my $reasonsloop = GetAuthorisedValues("SUGGEST");
99 # filter informations which are not suggestion related.
100 my $suggestion_ref = { %{$input->Vars} }; # Copying, otherwise $input will be modified
102 # get only the columns of Suggestion
103 my $schema = Koha::Database->new()->schema;
104 my $columns = ' '.join(' ', $schema->source('Suggestion')->columns).' ';
105 my $suggestion_only = { map { $columns =~ / $_ / ? ($_ => $suggestion_ref->{$_}) : () } keys %$suggestion_ref };
106 $suggestion_only->{STATUS} = $suggestion_ref->{STATUS};
108 delete $$suggestion_ref{$_} foreach qw( suggestedbyme op displayby tabcode notify filter_archived );
109 foreach (keys %$suggestion_ref){
110 delete $$suggestion_ref{$_} if (!$$suggestion_ref{$_} && ($op eq 'else' ));
112 my ( $template, $borrowernumber, $cookie, $userflags ) = get_template_and_user(
114 template_name => "suggestion/suggestion.tt",
117 flagsrequired => { suggestions => 'suggestions_manage' },
121 $borrowernumber = $input->param('borrowernumber') if ( $input->param('borrowernumber') );
122 $template->param('borrowernumber' => $borrowernumber);
123 my $branchfilter = $input->param('branchcode') || C4::Context->userenv->{'branch'};
125 #########################################
129 if ( $op =~ /save/i ) {
131 my $biblio = MarcRecordFromNewSuggestion({
132 title => $suggestion_only->{title},
133 author => $suggestion_only->{author},
134 itemtype => $suggestion_only->{itemtype},
137 my $manager = Koha::Patrons->find( $suggestion_only->{managedby} );
138 if ( $manager && not $manager->has_permission({suggestions => 'suggestions_manage'})) {
139 push @messages, { type => 'error', code => 'manager_not_enough_permissions' };
141 messages => \@messages,
143 delete $suggestion_ref->{suggesteddate};
144 delete $suggestion_ref->{manageddate};
145 delete $suggestion_ref->{managedby};
146 Init($suggestion_ref);
148 elsif ( !$suggestion_only->{suggestionid} && ( my ($duplicatebiblionumber, $duplicatetitle) = FindDuplicate($biblio) ) && !$save_confirmed ) {
149 push @messages, { type => 'error', code => 'biblio_exists', id => $duplicatebiblionumber, title => $duplicatetitle };
151 messages => \@messages,
154 delete $suggestion_ref->{suggesteddate};
155 delete $suggestion_ref->{manageddate};
156 Init($suggestion_ref);
160 for my $date_key ( qw( suggesteddate manageddate accepteddate rejecteddate ) ) {
161 $suggestion_only->{$date_key} = dt_from_string( $suggestion_only->{$date_key} )
162 if $suggestion_only->{$date_key};
165 if ( $suggestion_only->{"STATUS"} ) {
166 if ( my $tmpstatus = lc( $suggestion_only->{"STATUS"} ) =~ /ACCEPTED|REJECTED/i ) {
167 $suggestion_only->{ lc( $suggestion_only->{"STATUS"}) . "date" } = dt_from_string;
168 $suggestion_only->{ lc( $suggestion_only->{"STATUS"}) . "by" } = C4::Context->userenv->{number};
170 $suggestion_only->{manageddate} = dt_from_string;
171 $suggestion_only->{"managedby"} ||= C4::Context->userenv->{number};
174 my $otherreason = $input->param('other_reason');
175 if ($suggestion_only->{reason} eq 'other' && $otherreason) {
176 $suggestion_only->{reason} = $otherreason;
179 if ( $suggestion_only->{'suggestionid'} > 0 ) {
181 $suggestion_only->{lastmodificationdate} = dt_from_string;
182 $suggestion_only->{lastmodificationby} = C4::Context->userenv->{number};
183 $suggestion_only->{branchcode} = undef
184 if exists $suggestion_only->{branchcode}
185 && $suggestion_only->{branchcode} eq "";
187 &ModSuggestion($suggestion_only);
190 my $patron = Koha::Patrons->find( $suggestion_only->{managedby} );
191 my $email_address = $patron->notice_email_address;
192 if ($patron->notice_email_address) {
194 my $letter = C4::Letters::GetPreparedLetter(
195 module => 'suggestions',
196 letter_code => 'NOTIFY_MANAGER',
197 branchcode => $patron->branchcode,
198 lang => $patron->lang,
200 suggestions => $suggestion_only->{suggestionid},
201 branches => $patron->branchcode,
202 borrowers => $patron->borrowernumber,
205 C4::Letters::EnqueueLetter(
208 borrowernumber => $patron->borrowernumber,
209 message_transport_type => 'email'
215 ###FIXME:Search here if suggestion already exists.
216 my $suggestions_loop =
217 SearchSuggestion( $suggestion_only );
218 if (@$suggestions_loop>=1){
219 #some suggestion are answering the request Donot Add
221 for my $suggestion ( @$suggestions_loop ) {
222 push @messages, { type => 'error', code => 'already_exists', id => $suggestion->{suggestionid} };
224 $template->param( messages => \@messages );
227 ## Adding some informations related to suggestion
228 &NewSuggestion($suggestion_only);
230 # empty fields, to avoid filter in "SearchSuggestion"
232 map{delete $$suggestion_ref{$_} unless $_ eq 'branchcode' } keys %$suggestion_ref;
235 if( $redirect eq 'purchase_suggestions' ) {
236 print $input->redirect("/cgi-bin/koha/members/purchase-suggestions.pl?borrowernumber=$borrowernumber");
242 Init($suggestion_ref);
245 elsif ($op=~/edit/) {
247 $suggestion_ref=&GetSuggestion($$suggestion_ref{'suggestionid'});
248 $suggestion_ref->{reasonsloop} = $reasonsloop;
249 my $other_reason = 1;
250 foreach my $reason ( @{ $reasonsloop } ) {
251 if ($suggestion_ref->{reason} eq $reason->{lib}) {
255 $other_reason = 0 unless $suggestion_ref->{reason};
256 $template->param(other_reason => $other_reason);
257 Init($suggestion_ref);
260 elsif ($op eq "update_status" ) {
263 # set accepted/rejected/managed informations if applicable
264 # ie= if the librarian has chosen some action on the suggestions
265 my $STATUS = $input->param('STATUS');
266 my $accepted_by = $input->param('acceptedby');
267 if ( $STATUS eq "ACCEPTED" ) {
269 accepteddate => dt_from_string,
270 acceptedby => C4::Context->userenv->{number},
273 elsif ( $STATUS eq "REJECTED" ) {
275 rejecteddate => dt_from_string,
276 rejectedby => C4::Context->userenv->{number},
280 $suggestion->{manageddate} = dt_from_string;
281 $suggestion->{managedby} = C4::Context->userenv->{number};
282 $suggestion->{STATUS} = $STATUS;
284 if ( my $reason = $input->param("reason") ) {
285 if ( $reason eq "other" ) {
286 $reason = $input->param("other_reason");
288 $suggestion->{reason} = $reason;
291 foreach my $suggestionid (@editsuggestions) {
292 next unless $suggestionid;
293 $suggestion->{suggestionid} = $suggestionid;
294 &ModSuggestion($suggestion);
296 redirect_with_params($input);
297 }elsif ($op eq "delete" ) {
298 foreach my $delete_field (@editsuggestions) {
299 &DelSuggestion( $borrowernumber, $delete_field,'intranet' );
301 redirect_with_params($input);
303 elsif ($op eq "archive" ) {
304 Koha::Suggestions->find($_)->update({ archived => 1 }) for @editsuggestions;
306 redirect_with_params($input);
308 elsif ($op eq "unarchive" ) {
309 Koha::Suggestions->find($_)->update({ archived => 0 }) for @editsuggestions;
311 redirect_with_params($input);
313 elsif ( $op eq 'update_itemtype' ) {
314 my $new_itemtype = $input->param('suggestion_itemtype');
315 foreach my $suggestionid (@editsuggestions) {
316 next unless $suggestionid;
317 &ModSuggestion({ suggestionid => $suggestionid, itemtype => $new_itemtype });
319 redirect_with_params($input);
321 elsif ( $op eq 'update_manager' ) {
322 my $managedby = $input->param('suggestion_managedby');
323 foreach my $suggestionid (@editsuggestions) {
324 next unless $suggestionid;
325 &ModSuggestion({ suggestionid => $suggestionid, managedby => $managedby });
327 redirect_with_params($input);
329 elsif ( $op eq 'show' ) {
330 $suggestion_ref=&GetSuggestion($$suggestion_ref{'suggestionid'});
331 my $budget = GetBudget $$suggestion_ref{budgetid};
332 $$suggestion_ref{budgetname} = $$budget{budget_name};
333 Init($suggestion_ref);
338 $displayby||="STATUS";
339 # distinct values of display by
340 my $criteria_list=GetDistinctValues("suggestions.".$displayby);
341 my (@criteria_dv, $criteria_has_empty);
342 foreach (@$criteria_list) {
344 push @criteria_dv, $_->{value};
346 $criteria_has_empty = 1;
349 # aggregate null and empty values under empty value
350 push @criteria_dv, '' if $criteria_has_empty;
352 # Hack to not modify GetDistinctValues for this specific case
353 if ( $displayby eq 'branchcode'
354 && C4::Context->preference('IndependentBranches')
355 && not C4::Context->IsSuperLibrarian )
357 @criteria_dv = ( C4::Context->userenv->{'branch'} );
361 foreach my $criteriumvalue ( @criteria_dv ) {
362 # By default, display suggestions from current working branch
363 unless ( exists $$suggestion_ref{'branchcode'} ) {
364 $$suggestion_ref{'branchcode'} = C4::Context->userenv->{'branch'};
366 my $definedvalue = defined $$suggestion_ref{$displayby} && $$suggestion_ref{$displayby} ne "";
368 next if ( $definedvalue && $$suggestion_ref{$displayby} ne $criteriumvalue ) and ($displayby ne 'branchcode' && $branchfilter ne '__ANY__' );
369 $$suggestion_ref{$displayby} = $criteriumvalue;
371 my $suggestions = &SearchSuggestion({ %$suggestion_ref, archived => $filter_archived });
372 foreach my $suggestion (@$suggestions) {
373 if ($suggestion->{budgetid}){
374 my $bud = GetBudget( $suggestion->{budgetid} );
375 $suggestion->{budget_name} = $bud->{budget_name} if $bud;
378 push @allsuggestions,{
379 "suggestiontype"=>$criteriumvalue||"suggest",
380 "suggestiontypelabel"=>GetCriteriumDesc($criteriumvalue,$displayby)||"",
381 "suggestionscount"=>scalar(@$suggestions),
382 'suggestions_loop'=>$suggestions,
383 'reasonsloop' => $reasonsloop,
386 delete $$suggestion_ref{$displayby} unless $definedvalue;
390 "displayby"=> $displayby,
391 "notabs"=> $displayby eq "",
392 suggestions => \@allsuggestions,
397 "${_}_patron" => scalar Koha::Patrons->find( $suggestion_ref->{$_} ) )
398 for qw(managedby suggestedby acceptedby lastmodificationby);
402 filter_archived => $filter_archived,
406 if(defined($returnsuggested) and $returnsuggested ne "noone")
408 print $input->redirect("/cgi-bin/koha/members/moremember.pl?borrowernumber=".$returnsuggested."#suggestions");
412 branchfilter => $branchfilter,
415 $template->param( returnsuggestedby => $returnsuggestedby );
417 my $patron_reason_loop = GetAuthorisedValues("OPAC_SUG");
418 $template->param(patron_reason_loop=>$patron_reason_loop);
420 # Budgets for filtering
421 my $budgets = GetBudgets;
423 foreach my $budget ( @{$budgets} ) {
424 next unless (CanUserUseBudget($borrowernumber, $budget, $userflags));
426 ## Please see file perltidy.ERR
427 $budget->{'selected'} = 1
428 if ($$suggestion_ref{'budgetid'}
429 && $budget->{'budget_id'} eq $$suggestion_ref{'budgetid'});
431 push @budgets_loop, $budget;
433 $template->param( budgetsloop => \@budgets_loop);
435 # Budgets for suggestion add or edition
436 my $sugg_budget_loop = [];
437 my $sugg_budgets = GetBudgetHierarchy();
438 foreach my $r ( @{$sugg_budgets} ) {
439 next unless ( CanUserUseBudget( $borrowernumber, $r, $userflags ) );
440 my $selected = ( $$suggestion_ref{budgetid} && $r->{budget_id} eq $$suggestion_ref{budgetid} ) ? 1 : 0;
441 push @{$sugg_budget_loop},
443 b_id => $r->{budget_id},
444 b_txt => $r->{budget_name},
445 b_active => $r->{budget_period_active},
446 selected => $selected,
449 @{$sugg_budget_loop} = sort { uc( $a->{b_txt} ) cmp uc( $b->{b_txt} ) } @{$sugg_budget_loop};
450 $template->param( sugg_budgets => $sugg_budget_loop);
452 if( $suggestion_ref->{STATUS} ) {
454 "statusselected_".$suggestion_ref->{STATUS} => 1,
455 selected_status => $suggestion_ref->{STATUS}, # We need template var selected_status in the second part of the template where template var suggestion.STATUS is out of scope
459 my @currencies = Koha::Acquisition::Currencies->search;
461 currencies => \@currencies,
462 suggestion => $suggestion_ref,
463 price => sprintf("%.2f", $$suggestion_ref{'price'}||0),
464 total => sprintf("%.2f", $$suggestion_ref{'total'}||0),
467 # lists of distinct values (without empty) for filters
469 foreach my $field ( qw(managedby acceptedby suggestedby budgetid) ) {
471 $values_list = GetDistinctValues( "suggestions." . $field );
472 my @codes_list = map {
473 { 'code' => $$_{'value'},
474 'desc' => GetCriteriumDesc( $$_{'value'}, $field ) || $$_{'value'},
475 'selected' => ($$suggestion_ref{$field}) ? $$_{'value'} eq $$suggestion_ref{$field} : 0,
480 $hashlists{ lc($field) . "_loop" } = \@codes_list;
485 borrowernumber => ($input->param('borrowernumber') // undef),
486 SuggestionStatuses => GetAuthorisedValues('SUGGEST_STATUS'),
488 output_html_with_http_headers $input, $cookie, $template->output;
490 sub redirect_with_params {
495 displayby branchcode title author isbn publishercode copyrightdate
496 collectiontitle suggestedby suggesteddate_from suggesteddate_to
497 manageddate_from manageddate_to accepteddate_from
498 accepteddate_to budgetid filter_archived
502 $params .= $key . '=' . uri_escape(scalar $input->param($key)) . '&'
503 if defined($input->param($key));
505 print $input->redirect("/cgi-bin/koha/suggestion/suggestion.pl?$params");