Bug 16844: (follow-up of 15656) Remove export of GetMemberRelatives from C4::Members
[koha.git] / suggestion / suggestion.pl
1 #!/usr/bin/perl
2
3 # This file is part of Koha.
4 # Copyright 2006-2010 BibLibre
5
6 #
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.
11 #
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.
16 #
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>.
19
20 use strict;
21 #use warnings; FIXME - Bug 2505
22 require Exporter;
23 use CGI qw ( -utf8 );
24 use C4::Auth;    # get_template_and_user
25 use C4::Output;
26 use C4::Suggestions;
27 use C4::Koha; #GetItemTypes
28 use C4::Branch;
29 use C4::Budgets;
30 use C4::Search;
31 use C4::Members;
32 use C4::Debug;
33
34 use Koha::DateUtils qw( dt_from_string );
35 use Koha::Acquisition::Currencies;
36
37 use URI::Escape;
38
39 sub Init{
40     my $suggestion= shift @_;
41     # "Managed by" is used only when a suggestion is being edited (not when created)
42     if ($suggestion->{'suggesteddate'} eq "0000-00-00" ||$suggestion->{'suggesteddate'} eq "") {
43         # new suggestion
44         $suggestion->{suggesteddate} = dt_from_string;
45         $suggestion->{'suggestedby'} = C4::Context->userenv->{"number"} unless ($suggestion->{'suggestedby'});
46     }
47     else {
48         # editing of an existing suggestion
49         $suggestion->{manageddate} = dt_from_string;
50         $suggestion->{'managedby'} = C4::Context->userenv->{"number"} unless ($suggestion->{'managedby'});
51     }
52     $suggestion->{'branchcode'}=C4::Context->userenv->{"branch"} unless ($suggestion->{'branchcode'});
53 }
54
55 sub GetCriteriumDesc{
56     my ($criteriumvalue,$displayby)=@_;
57     if ($displayby =~ /status/i) {
58         unless ( grep { /$criteriumvalue/ } qw(ASKED ACCEPTED REJECTED CHECKED ORDERED AVAILABLE) ) {
59             return GetAuthorisedValueByCode('SUGGEST_STATUS', $criteriumvalue ) || "Unknown";
60         }
61         return ($criteriumvalue eq 'ASKED'?"Pending":ucfirst(lc( $criteriumvalue))) if ($displayby =~/status/i);
62     }
63     return (GetBranchName($criteriumvalue)) if ($displayby =~/branchcode/);
64     return GetAuthorisedValueByCode('SUGGEST_FORMAT', $criteriumvalue) || "Unknown" if ($displayby =~/itemtype/);
65     if ($displayby =~/suggestedby/||$displayby =~/managedby/||$displayby =~/acceptedby/){
66         my $borr=C4::Members::GetMember(borrowernumber=>$criteriumvalue);
67         return "" unless $borr;
68         return $$borr{surname} . ", " . $$borr{firstname};
69     }
70     if ( $displayby =~ /budgetid/) {
71         my $budget = GetBudget($criteriumvalue);
72         return "" unless $budget;
73         return $$budget{budget_name};
74     }
75 }
76
77 my $input           = CGI->new;
78 my $redirect  = $input->param('redirect');
79 my $suggestedbyme   = (defined $input->param('suggestedbyme')? $input->param('suggestedbyme'):1);
80 my $op              = $input->param('op')||'else';
81 my @editsuggestions = $input->multi_param('edit_field');
82 my $suggestedby     = $input->param('suggestedby');
83 my $returnsuggestedby = $input->param('returnsuggestedby');
84 my $returnsuggested = $input->param('returnsuggested');
85 my $managedby       = $input->param('managedby');
86 my $displayby       = $input->param('displayby') || '';
87 my $tabcode         = $input->param('tabcode');
88
89 # filter informations which are not suggestion related.
90 my $suggestion_ref  = $input->Vars;
91
92 # get only the columns of Suggestion
93 my $schema = Koha::Database->new()->schema;
94 my $columns = ' '.join(' ', $schema->source('Suggestion')->columns).' ';
95 my $suggestion_only = { map { $columns =~ / $_ / ? ($_ => $suggestion_ref->{$_}) : () } keys %$suggestion_ref };
96 $suggestion_only->{STATUS} = $suggestion_ref->{STATUS};
97
98 delete $$suggestion_ref{$_} foreach qw( suggestedbyme op displayby tabcode edit_field );
99 foreach (keys %$suggestion_ref){
100     delete $$suggestion_ref{$_} if (!$$suggestion_ref{$_} && ($op eq 'else' || $op eq 'change'));
101 }
102 my ( $template, $borrowernumber, $cookie, $userflags ) = get_template_and_user(
103         {
104             template_name   => "suggestion/suggestion.tt",
105             query           => $input,
106             type            => "intranet",
107             flagsrequired   => { catalogue => 1 },
108         }
109     );
110
111 $borrowernumber = $input->param('borrowernumber') if ( $input->param('borrowernumber') );
112 $template->param('borrowernumber' => $borrowernumber);
113
114 #########################################
115 ##  Operations
116 ##
117 if ( $op =~ /save/i ) {
118     $suggestion_only->{suggesteddate} = dt_from_string( $suggestion_only->{suggesteddate} )
119         if $suggestion_only->{suggesteddate};
120
121     if ( $suggestion_only->{"STATUS"} ) {
122         if ( my $tmpstatus = lc( $suggestion_only->{"STATUS"} ) =~ /ACCEPTED|REJECTED/i ) {
123             $suggestion_only->{ lc( $suggestion_only->{"STATUS"}) . "date" } = dt_from_string;
124             $suggestion_only->{ lc( $suggestion_only->{"STATUS"}) . "by" }   = C4::Context->userenv->{number};
125         }
126         $suggestion_only->{manageddate} = dt_from_string;
127         $suggestion_only->{"managedby"}   = C4::Context->userenv->{number};
128     }
129     if ( $suggestion_only->{'suggestionid'} > 0 ) {
130         &ModSuggestion($suggestion_only);
131     } else {
132         ###FIXME:Search here if suggestion already exists.
133         my $suggestions_loop =
134             SearchSuggestion( $suggestion_only );
135         if (@$suggestions_loop>=1){
136             #some suggestion are answering the request Donot Add
137             my @messages;
138             for my $suggestion ( @$suggestions_loop ) {
139                 push @messages, { type => 'error', code => 'already_exists', id => $suggestion->{suggestionid} };
140             }
141             $template->param( messages => \@messages );
142         } 
143         else {    
144             ## Adding some informations related to suggestion
145             &NewSuggestion($suggestion_only);
146         }
147         # empty fields, to avoid filter in "SearchSuggestion"
148     }  
149     map{delete $$suggestion_ref{$_}} keys %$suggestion_ref;
150     $op = 'else';
151
152     if( $redirect eq 'purchase_suggestions' ) {
153         print $input->redirect("/cgi-bin/koha/members/purchase-suggestions.pl?borrowernumber=$borrowernumber");
154     }
155
156 }
157 elsif ($op=~/add/) {
158     #Adds suggestion  
159     Init($suggestion_ref);
160     $op ='save';
161
162 elsif ($op=~/edit/) {
163     #Edit suggestion  
164     $suggestion_ref=&GetSuggestion($$suggestion_ref{'suggestionid'});
165     Init($suggestion_ref);
166     $op ='save';
167 }  
168 elsif ($op eq "change" ) {
169     # set accepted/rejected/managed informations if applicable
170     # ie= if the librarian has chosen some action on the suggestions
171     if ($suggestion_only->{"STATUS"} eq "ACCEPTED"){
172         $suggestion_only->{accepteddate} = dt_from_string;
173         $suggestion_only->{"acceptedby"}=C4::Context->userenv->{number};
174     } elsif ($suggestion_only->{"STATUS"} eq "REJECTED"){
175         $suggestion_only->{rejecteddate} = dt_from_string;
176         $suggestion_only->{"rejectedby"}=C4::Context->userenv->{number};
177     }
178     if ($suggestion_only->{"STATUS"}){
179         $suggestion_only->{manageddate} = dt_from_string;
180         $suggestion_only->{"managedby"}=C4::Context->userenv->{number};
181     }
182     if ( my $reason = $$suggestion_ref{"reason$tabcode"}){
183         if ( $reason eq "other" ) {
184             $reason = $$suggestion_ref{"other_reason$tabcode"};
185         }
186         $suggestion_only->{reason}=$reason;
187     }
188
189     foreach my $suggestionid (@editsuggestions) {
190         next unless $suggestionid;
191         $suggestion_only->{'suggestionid'}=$suggestionid;
192         &ModSuggestion($suggestion_only);
193     }
194     my $params = '';
195     foreach my $key (
196         qw(
197         displayby branchcode title author isbn publishercode copyrightdate
198         collectiontitle suggestedby suggesteddate_from suggesteddate_to
199         manageddate_from manageddate_to accepteddate_from
200         accepteddate_to budgetid
201         )
202       )
203     {
204         $params .= $key . '=' . uri_escape($input->param($key)) . '&'
205           if defined($input->param($key));
206     }
207     print $input->redirect("/cgi-bin/koha/suggestion/suggestion.pl?$params");
208 }elsif ($op eq "delete" ) {
209     foreach my $delete_field (@editsuggestions) {
210         &DelSuggestion( $borrowernumber, $delete_field,'intranet' );
211     }
212     $op = 'else';
213 }
214 elsif ( $op eq 'show' ) {
215     $suggestion_ref=&GetSuggestion($$suggestion_ref{'suggestionid'});
216     $$suggestion_ref{branchname} = GetBranchName $$suggestion_ref{branchcode};
217     my $budget = GetBudget $$suggestion_ref{budgetid};
218     $$suggestion_ref{budgetname} = $$budget{budget_name};
219     Init($suggestion_ref);
220 }
221 if ($op=~/else/) {
222     $op='else';
223     
224     $displayby||="STATUS";
225     delete $$suggestion_ref{'branchcode'} if($displayby eq "branchcode");
226     # distinct values of display by
227     my $criteria_list=GetDistinctValues("suggestions.".$displayby);
228     my (@criteria_dv, $criteria_has_empty);
229     foreach (@$criteria_list) {
230         if ($_->{value}) {
231             push @criteria_dv, $_->{value};
232         } else {
233             $criteria_has_empty = 1;
234         }
235     }
236     # aggregate null and empty values under empty value
237     push @criteria_dv, '' if $criteria_has_empty;
238
239     my @allsuggestions;
240     my $reasonsloop = GetAuthorisedValues("SUGGEST");
241     foreach my $criteriumvalue ( @criteria_dv ) {
242         # By default, display suggestions from current working branch
243         unless ( exists $$suggestion_ref{'branchcode'} ) {
244             $$suggestion_ref{'branchcode'} = C4::Context->userenv->{'branch'};
245         }
246         my $definedvalue = defined $$suggestion_ref{$displayby} && $$suggestion_ref{$displayby} ne "";
247
248         next if ( $definedvalue && $$suggestion_ref{$displayby} ne $criteriumvalue );
249         $$suggestion_ref{$displayby} = $criteriumvalue;
250
251         my $suggestions = &SearchSuggestion($suggestion_ref);
252         foreach my $suggestion (@$suggestions) {
253             if ($suggestion->{budgetid}){
254                 my $bud = GetBudget( $suggestion->{budgetid} );
255                 $suggestion->{budget_name} = $bud->{budget_name} if $bud;
256             }
257         }
258         push @allsuggestions,{
259                             "suggestiontype"=>$criteriumvalue||"suggest",
260                             "suggestiontypelabel"=>GetCriteriumDesc($criteriumvalue,$displayby)||"",
261                             "suggestionscount"=>scalar(@$suggestions),             
262                             'suggestions_loop'=>$suggestions,
263                             'reasonsloop'     => $reasonsloop,
264                             };
265
266         delete $$suggestion_ref{$displayby} unless $definedvalue;
267     }
268
269     $template->param(
270         "displayby"=> $displayby,
271         "notabs"=> $displayby eq "",
272         suggestions       => \@allsuggestions,
273     );
274 }
275
276 foreach my $element ( qw(managedby suggestedby acceptedby) ) {
277 #    $debug || warn $$suggestion_ref{$element};
278     if ($$suggestion_ref{$element}){
279         my $member=GetMember(borrowernumber=>$$suggestion_ref{$element});
280         $template->param(
281             $element."_borrowernumber"=>$$member{borrowernumber},
282             $element."_firstname"=>$$member{firstname},
283             $element."_surname"=>$$member{surname},
284             $element."_branchcode"=>$$member{branchcode},
285             $element."_description"=>$$member{description},
286             $element."_category_type"=>$$member{category_type}
287         );
288     }
289 }
290 $template->param(
291     %$suggestion_ref,  
292     "op_$op"                => 1,
293     "op"             =>$op,
294 );
295
296 if(defined($returnsuggested) and $returnsuggested ne "noone")
297 {
298     print $input->redirect("/cgi-bin/koha/members/moremember.pl?borrowernumber=".$returnsuggested."#suggestions");
299 }
300
301 ####################
302 ## Initializing selection lists
303
304 #branch display management
305 my $branchfilter = ($displayby ne "branchcode") ? $input->param('branchcode') : '';
306 my $onlymine =
307      C4::Context->preference('IndependentBranches')
308   && C4::Context->userenv
309   && !C4::Context->IsSuperLibrarian()
310   && C4::Context->userenv->{branch};
311 my $branches = GetBranches($onlymine);
312 my @branchloop;
313
314 foreach my $thisbranch ( sort {$branches->{$a}->{'branchname'} cmp $branches->{$b}->{'branchname'}} keys %$branches ) {
315     my %row = (
316         value      => $thisbranch,
317         branchname => $branches->{$thisbranch}->{'branchname'},
318         selected   => ($branchfilter and $branches->{$thisbranch}->{'branchcode'} eq $branchfilter ) || ( $$suggestion_ref{'branchcode'} and $branches->{$thisbranch}->{'branchcode'} eq $$suggestion_ref{'branchcode'} )
319     );
320     push @branchloop, \%row;
321 }
322 $branchfilter=C4::Context->userenv->{'branch'} if ($onlymine && !$branchfilter);
323
324 $template->param( branchloop => \@branchloop,
325                 branchfilter => $branchfilter);
326
327 $template->param( returnsuggestedby => $returnsuggestedby );
328
329 my $patron_reason_loop = GetAuthorisedValues("OPAC_SUG");
330 $template->param(patron_reason_loop=>$patron_reason_loop);
331
332 #Budgets management
333 my $budgets = [];
334 if ($branchfilter) {
335     my $searchbudgets = { budget_branchcode => $branchfilter };
336     $budgets = GetBudgets($searchbudgets);
337 } else {
338     $budgets = GetBudgets(undef);
339 }
340
341 my @budgets_loop;
342 foreach my $budget ( @{$budgets} ) {
343     next unless (CanUserUseBudget($borrowernumber, $budget, $userflags));
344
345     ## Please see file perltidy.ERR
346     $budget->{'selected'} = 1
347         if ($$suggestion_ref{'budgetid'}
348         && $budget->{'budget_id'} eq $$suggestion_ref{'budgetid'});
349
350     push @budgets_loop, $budget;
351 }
352
353 $template->param( budgetsloop => \@budgets_loop);
354 $template->param( "statusselected_$$suggestion_ref{'STATUS'}" =>1) if ($$suggestion_ref{'STATUS'});
355
356 my @currencies = Koha::Acquisition::Currencies->search;
357 $template->param(
358     currencies   => \@currencies,
359     suggestion   => $suggestion_ref,
360     price        => sprintf("%.2f", $$suggestion_ref{'price'}||0),
361     total            => sprintf("%.2f", $$suggestion_ref{'total'}||0),
362 );
363
364 # lists of distinct values (without empty) for filters
365 my %hashlists;
366 foreach my $field ( qw(managedby acceptedby suggestedby budgetid) ) {
367     my $values_list;
368     $values_list = GetDistinctValues( "suggestions." . $field );
369     my @codes_list = map {
370         {   'code' => $$_{'value'},
371             'desc' => GetCriteriumDesc( $$_{'value'}, $field ) || $$_{'value'},
372             'selected' => ($$suggestion_ref{$field}) ? $$_{'value'} eq $$suggestion_ref{$field} : 0,
373         }
374     } grep {
375         $$_{'value'}
376     } @$values_list;
377     $hashlists{ lc($field) . "_loop" } = \@codes_list;
378 }
379
380 $template->param(
381     %hashlists,
382     borrowernumber           => ($input->param('borrowernumber') // undef),
383     SuggestionStatuses       => GetAuthorisedValues('SUGGEST_STATUS'),
384 );
385 output_html_with_http_headers $input, $cookie, $template->output;