Bug 9718 - Add POD and comments for Check_Userid and Generate_Userid subs
[koha.git] / suggestion / suggestion.pl
blobb4f4d37a7ed64f252f1dccc649e28aa973e97a60
1 #!/usr/bin/perl
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 under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
10 # version.
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 use strict;
21 #use warnings; FIXME - Bug 2505
22 require Exporter;
23 use CGI;
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::Dates qw(format_date);
32 use C4::Members;
33 use C4::Debug;
35 sub Init{
36 my $suggestion= shift @_;
37 # "Managed by" is used only when a suggestion is being edited (not when created)
38 if ($suggestion->{'suggesteddate'} eq "0000-00-00" ||$suggestion->{'suggesteddate'} eq "") {
39 # new suggestion
40 $suggestion->{'suggesteddate'} = C4::Dates->today;
41 $suggestion->{'suggestedby'} = C4::Context->userenv->{"number"} unless ($suggestion->{'suggestedby'});
43 else {
44 # editing of an existing suggestion
45 $suggestion->{'manageddate'} = C4::Dates->today;
46 $suggestion->{'managedby'} = C4::Context->userenv->{"number"} unless ($suggestion->{'managedby'});
47 # suggesteddate, when coming from the DB, needs to be formated
48 $suggestion->{'suggesteddate'} = format_date($suggestion->{'suggesteddate'});
50 foreach my $date ( qw(rejecteddate accepteddate) ){
51 $suggestion->{$date}=(($suggestion->{$date} eq "0000-00-00" ||$suggestion->{$date} eq "")?
52 "":
53 format_date($suggestion->{$date})
56 $suggestion->{'branchcode'}=C4::Context->userenv->{"branch"} unless ($suggestion->{'branchcode'});
59 sub GetCriteriumDesc{
60 my ($criteriumvalue,$displayby)=@_;
61 return ($criteriumvalue eq 'ASKED'?"Pending":ucfirst(lc( $criteriumvalue))) if ($displayby =~/status/i);
62 return (GetBranchName($criteriumvalue)) if ($displayby =~/branchcode/);
63 return (GetSupportName($criteriumvalue)) if ($displayby =~/itemtype/);
64 if ($displayby =~/suggestedby/||$displayby =~/managedby/||$displayby =~/acceptedby/){
65 my $borr=C4::Members::GetMember(borrowernumber=>$criteriumvalue);
66 return "" unless $borr;
67 return $$borr{surname} . ", " . $$borr{firstname};
69 if ( $displayby =~ /budgetid/) {
70 my $budget = GetBudget($criteriumvalue);
71 return "" unless $budget;
72 return $$budget{budget_name};
76 my $input = CGI->new;
77 my $suggestedbyme = (defined $input->param('suggestedbyme')? $input->param('suggestedbyme'):1);
78 my $op = $input->param('op')||'else';
79 my @editsuggestions = $input->param('edit_field');
80 my $suggestedby = $input->param('suggestedby');
81 my $returnsuggestedby = $input->param('returnsuggestedby');
82 my $returnsuggested = $input->param('returnsuggested');
83 my $managedby = $input->param('managedby');
84 my $displayby = $input->param('displayby') || '';
85 my $tabcode = $input->param('tabcode');
87 # filter informations which are not suggestion related.
88 my $suggestion_ref = $input->Vars;
90 delete $$suggestion_ref{$_} foreach qw( suggestedbyme op displayby tabcode edit_field );
91 foreach (keys %$suggestion_ref){
92 delete $$suggestion_ref{$_} if (!$$suggestion_ref{$_} && ($op eq 'else' || $op eq 'change'));
94 my ( $template, $borrowernumber, $cookie, $userflags ) = get_template_and_user(
96 template_name => "suggestion/suggestion.tmpl",
97 query => $input,
98 type => "intranet",
99 flagsrequired => { catalogue => 1 },
103 #########################################
104 ## Operations
106 if ( $op =~ /save/i ) {
107 if ( $$suggestion_ref{"STATUS"} ) {
108 if ( my $tmpstatus = lc( $$suggestion_ref{"STATUS"} ) =~ /ACCEPTED|REJECTED/i ) {
109 $$suggestion_ref{ lc( $$suggestion_ref{"STATUS"}) . "date" } = C4::Dates->today;
110 $$suggestion_ref{ lc( $$suggestion_ref{"STATUS"}) . "by" } = C4::Context->userenv->{number};
112 $$suggestion_ref{"manageddate"} = C4::Dates->today;
113 $$suggestion_ref{"managedby"} = C4::Context->userenv->{number};
115 if ( $$suggestion_ref{'suggestionid'} > 0 ) {
116 &ModSuggestion($suggestion_ref);
117 } else {
118 ###FIXME:Search here if suggestion already exists.
119 my $suggestions_loop =
120 SearchSuggestion( $suggestion_ref );
121 if (@$suggestions_loop>=1){
122 #some suggestion are answering the request Donot Add
124 else {
125 ## Adding some informations related to suggestion
126 &NewSuggestion($suggestion_ref);
128 # empty fields, to avoid filter in "SearchSuggestion"
130 map{delete $$suggestion_ref{$_}} keys %$suggestion_ref;
131 $op = 'else';
133 elsif ($op=~/add/) {
134 #Adds suggestion
135 Init($suggestion_ref);
136 $op ='save';
138 elsif ($op=~/edit/) {
139 #Edit suggestion
140 $suggestion_ref=&GetSuggestion($$suggestion_ref{'suggestionid'});
141 Init($suggestion_ref);
142 $op ='save';
144 elsif ($op eq "change" ) {
145 # set accepted/rejected/managed informations if applicable
146 # ie= if the librarian has choosen some action on the suggestions
147 if ($$suggestion_ref{"STATUS"} eq "ACCEPTED"){
148 $$suggestion_ref{"accepteddate"}=C4::Dates->today;
149 $$suggestion_ref{"acceptedby"}=C4::Context->userenv->{number};
150 } elsif ($$suggestion_ref{"STATUS"} eq "REJECTED"){
151 $$suggestion_ref{"rejecteddate"}=C4::Dates->today;
152 $$suggestion_ref{"rejectedby"}=C4::Context->userenv->{number};
154 if ($$suggestion_ref{"STATUS"}){
155 $$suggestion_ref{"manageddate"}=C4::Dates->today;
156 $$suggestion_ref{"managedby"}=C4::Context->userenv->{number};
158 if ( my $reason = $$suggestion_ref{"reason$tabcode"}){
159 if ( $reason eq "other" ) {
160 $reason = $$suggestion_ref{"other_reason$tabcode"};
162 $$suggestion_ref{'reason'}=$reason;
164 delete $$suggestion_ref{$_} foreach ("reason$tabcode", "other_reason$tabcode");
165 foreach (keys %$suggestion_ref){
166 delete $$suggestion_ref{$_} unless ($$suggestion_ref{$_});
168 foreach my $suggestionid (@editsuggestions) {
169 next unless $suggestionid;
170 $$suggestion_ref{'suggestionid'}=$suggestionid;
171 &ModSuggestion($suggestion_ref);
173 $op = 'else';
174 }elsif ($op eq "delete" ) {
175 foreach my $delete_field (@editsuggestions) {
176 &DelSuggestion( $borrowernumber, $delete_field,'intranet' );
178 $op = 'else';
180 elsif ( $op eq 'show' ) {
181 $suggestion_ref=&GetSuggestion($$suggestion_ref{'suggestionid'});
182 $$suggestion_ref{branchname} = GetBranchName $$suggestion_ref{branchcode};
183 my $budget = GetBudget $$suggestion_ref{budgetid};
184 $$suggestion_ref{budgetname} = $$budget{budget_name};
185 Init($suggestion_ref);
187 if ($op=~/else/) {
188 $op='else';
190 $displayby||="STATUS";
191 delete $$suggestion_ref{'branchcode'} if($displayby eq "branchcode");
192 # distinct values of display by
193 my $criteria_list=GetDistinctValues("suggestions.".$displayby);
194 my (@criteria_dv, $criteria_has_empty);
195 foreach (@$criteria_list) {
196 if ($_->{value}) {
197 push @criteria_dv, $_->{value};
198 } else {
199 $criteria_has_empty = 1;
202 # agregate null and empty values under empty value
203 push @criteria_dv, '' if $criteria_has_empty;
205 my @allsuggestions;
206 my $reasonsloop = GetAuthorisedValues("SUGGEST");
207 foreach my $criteriumvalue ( @criteria_dv ) {
208 # By default, display suggestions from current working branch
209 unless ( exists $$suggestion_ref{'branchcode'} ) {
210 $$suggestion_ref{'branchcode'} = C4::Context->userenv->{'branch'};
212 my $definedvalue = defined $$suggestion_ref{$displayby} && $$suggestion_ref{$displayby} ne "";
214 next if ( $definedvalue && $$suggestion_ref{$displayby} ne $criteriumvalue );
215 $$suggestion_ref{$displayby} = $criteriumvalue;
217 my $suggestions = &SearchSuggestion($suggestion_ref);
218 foreach my $suggestion (@$suggestions) {
219 if ($suggestion->{budgetid}){
220 my $bud = GetBudget( $suggestion->{budgetid} );
221 $suggestion->{budget_name} = $bud->{budget_name} if $bud;
223 foreach my $date (qw(suggesteddate manageddate accepteddate)) {
224 if ($suggestion->{$date} and $suggestion->{$date} ne "0000-00-00") {
225 $suggestion->{$date} = format_date( $suggestion->{$date} );
226 } else {
227 $suggestion->{$date} = "";
231 push @allsuggestions,{
232 "suggestiontype"=>$criteriumvalue||"suggest",
233 "suggestiontypelabel"=>GetCriteriumDesc($criteriumvalue,$displayby)||"",
234 "suggestionscount"=>scalar(@$suggestions),
235 'suggestions_loop'=>$suggestions,
236 'reasonsloop' => $reasonsloop,
239 delete $$suggestion_ref{$displayby} unless $definedvalue;
242 $template->param(
243 "displayby"=> $displayby,
244 "notabs"=> $displayby eq "",
245 suggestions => \@allsuggestions,
249 foreach my $element ( qw(managedby suggestedby acceptedby) ) {
250 # $debug || warn $$suggestion_ref{$element};
251 if ($$suggestion_ref{$element}){
252 my $member=GetMember(borrowernumber=>$$suggestion_ref{$element});
253 $template->param(
254 $element."_borrowernumber"=>$$member{borrowernumber},
255 $element."_firstname"=>$$member{firstname},
256 $element."_surname"=>$$member{surname},
257 $element."_branchcode"=>$$member{branchcode},
258 $element."_description"=>$$member{description},
259 $element."_category_type"=>$$member{category_type}
263 $template->param(
264 %$suggestion_ref,
265 "op_$op" => 1,
266 "op" =>$op,
269 if(defined($returnsuggested) and $returnsuggested ne "noone")
271 print $input->redirect("/cgi-bin/koha/members/moremember.pl?borrowernumber=".$returnsuggested."#suggestions");
274 ####################
275 ## Initializing selection lists
277 #branch display management
278 my $branchfilter = ($displayby ne "branchcode") ? $input->param('branchcode') : '';
279 my $onlymine=C4::Context->preference('IndependantBranches') &&
280 C4::Context->userenv &&
281 C4::Context->userenv->{flags}!=1 &&
282 C4::Context->userenv->{branch};
283 my $branches = GetBranches($onlymine);
284 my @branchloop;
286 foreach my $thisbranch ( sort {$branches->{$a}->{'branchname'} cmp $branches->{$b}->{'branchname'}} keys %$branches ) {
287 my %row = (
288 value => $thisbranch,
289 branchname => $branches->{$thisbranch}->{'branchname'},
290 selected => ($branchfilter and $branches->{$thisbranch}->{'branchcode'} eq $branchfilter ) || ( $$suggestion_ref{'branchcode'} and $branches->{$thisbranch}->{'branchcode'} eq $$suggestion_ref{'branchcode'} )
292 push @branchloop, \%row;
294 $branchfilter=C4::Context->userenv->{'branch'} if ($onlymine && !$branchfilter);
296 $template->param( branchloop => \@branchloop,
297 branchfilter => $branchfilter);
299 # the index parameter is different for item-level itemtypes
300 my $supportlist = GetSupportList();
302 foreach my $support (@$supportlist) {
303 $$support{'selected'} = (defined $$suggestion_ref{'itemtype'})
304 ? $$support{'itemtype'} eq $$suggestion_ref{'itemtype'}
305 : 0;
306 if ( $$support{'imageurl'} ) {
307 $$support{'imageurl'} = getitemtypeimagelocation( 'intranet', $$support{'imageurl'} );
308 } else {
309 delete $$support{'imageurl'};
312 $template->param(itemtypeloop=>$supportlist);
313 $template->param( returnsuggestedby => $returnsuggestedby );
315 my $patron_reason_loop = GetAuthorisedValues("OPAC_SUG",$$suggestion_ref{'patronreason'});
316 $template->param(patron_reason_loop=>$patron_reason_loop);
318 #Budgets management
319 my $budgets = [];
320 if ($branchfilter) {
321 my $searchbudgets = { budget_branchcode => $branchfilter };
322 $budgets = GetBudgets($searchbudgets);
323 } else {
324 $budgets = GetBudgets(undef);
327 my @budgets_loop;
328 foreach my $budget ( @{$budgets} ) {
329 next unless (CanUserUseBudget($borrowernumber, $budget, $userflags));
331 ## Please see file perltidy.ERR
332 $budget->{'selected'} = 1
333 if ($$suggestion_ref{'budgetid'}
334 && $budget->{'budget_id'} eq $$suggestion_ref{'budgetid'});
336 push @budgets_loop, $budget;
339 $template->param( budgetsloop => \@budgets_loop);
340 $template->param( "statusselected_$$suggestion_ref{'STATUS'}" =>1) if ($$suggestion_ref{'STATUS'});
342 # get currencies and rates
343 my @rates = GetCurrencies();
344 my $count = scalar @rates;
345 my $active_currency = GetCurrency();
346 my $selected_currency;
347 if ($$suggestion_ref{'currency'}) {
348 $selected_currency = $$suggestion_ref{'currency'};
350 else {
351 $selected_currency = $active_currency->{currency};
354 my @loop_currency = ();
355 for ( my $i = 0 ; $i < $count ; $i++ ) {
356 my %line;
357 $line{currcode} = $rates[$i]->{'currency'};
358 $line{rate} = $rates[$i]->{'rate'};
359 $line{selected} = 1 if ($line{'currcode'} eq $selected_currency);
360 push @loop_currency, \%line;
363 $template->param(loop_currency => \@loop_currency);
365 $template->param(
366 price => sprintf("%.2f", $$suggestion_ref{'price'}||0),
367 total => sprintf("%.2f", $$suggestion_ref{'total'}||0),
370 # lists of distinct values (without empty) for filters
371 my %hashlists;
372 foreach my $field ( qw(managedby acceptedby suggestedby budgetid) ) {
373 my $values_list;
374 $values_list = GetDistinctValues( "suggestions." . $field );
375 my @codes_list = map {
376 { 'code' => $$_{'value'},
377 'desc' => GetCriteriumDesc( $$_{'value'}, $field ) || $$_{'value'},
378 'selected' => ($$suggestion_ref{$field}) ? $$_{'value'} eq $$suggestion_ref{$field} : 0,
380 } grep {
381 $$_{'value'}
382 } @$values_list;
383 $hashlists{ lc($field) . "_loop" } = \@codes_list;
385 $template->param(%hashlists);
386 output_html_with_http_headers $input, $cookie, $template->output;