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 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.
  11 #
  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.
  15 #
  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.
  19
  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;
  34
  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'});
  42     }
  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'});
  49     }
  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})
  54                               );
  55     }
  56     $suggestion->{'branchcode'}=C4::Context->userenv->{"branch"} unless ($suggestion->{'branchcode'});
  57 }
  58
  59 sub GetCriteriumDesc{
  60     my ($criteriumvalue,$displayby)=@_;
  61     unless ( grep { /$criteriumvalue/ } qw(ASKED ACCEPTED REJECTED CHECKED) ) {
  62         return GetAuthorisedValueByCode('SUGGEST_STATUS', $criteriumvalue ) || "Unknown";
  63     }
  64     return ($criteriumvalue eq 'ASKED'?"Pending":ucfirst(lc( $criteriumvalue))) if ($displayby =~/status/i);
  65     return (GetBranchName($criteriumvalue)) if ($displayby =~/branchcode/);
  66     return (GetSupportName($criteriumvalue)) if ($displayby =~/itemtype/);
  67     if ($displayby =~/suggestedby/||$displayby =~/managedby/||$displayby =~/acceptedby/){
  68         my $borr=C4::Members::GetMember(borrowernumber=>$criteriumvalue);
  69         return "" unless $borr;
  70         return $$borr{surname} . ", " . $$borr{firstname};
  71     }
  72     if ( $displayby =~ /budgetid/) {
  73         my $budget = GetBudget($criteriumvalue);
  74         return "" unless $budget;
  75         return $$budget{budget_name};
  76     }
  77 }
  78
  79 my $input           = CGI->new;
  80 my $redirect  = $input->param('redirect');
  81 my $suggestedbyme   = (defined $input->param('suggestedbyme')? $input->param('suggestedbyme'):1);
  82 my $op              = $input->param('op')||'else';
  83 my @editsuggestions = $input->param('edit_field');
  84 my $suggestedby     = $input->param('suggestedby');
  85 my $returnsuggestedby = $input->param('returnsuggestedby');
  86 my $returnsuggested = $input->param('returnsuggested');
  87 my $managedby       = $input->param('managedby');
  88 my $displayby       = $input->param('displayby') || '';
  89 my $tabcode         = $input->param('tabcode');
  90
  91 # filter informations which are not suggestion related.
  92 my $suggestion_ref  = $input->Vars;
  93
  94 delete $$suggestion_ref{$_} foreach qw( suggestedbyme op displayby tabcode edit_field );
  95 foreach (keys %$suggestion_ref){
  96     delete $$suggestion_ref{$_} if (!$$suggestion_ref{$_} && ($op eq 'else' || $op eq 'change'));
  97 }
  98 my ( $template, $borrowernumber, $cookie, $userflags ) = get_template_and_user(
  99         {
 100             template_name   => "suggestion/suggestion.tmpl",
 101             query           => $input,
 102             type            => "intranet",
 103             flagsrequired   => { catalogue => 1 },
 104         }
 105     );
 106
 107 $borrowernumber = $input->param('borrowernumber') if ( $input->param('borrowernumber') );
 108 $template->param('borrowernumber' => $borrowernumber);
 109
 110 #########################################
 111 ##  Operations
 112 ##
 113 if ( $op =~ /save/i ) {
 114         if ( $$suggestion_ref{"STATUS"} ) {
 115         if ( my $tmpstatus = lc( $$suggestion_ref{"STATUS"} ) =~ /ACCEPTED|REJECTED/i ) {
 116             $$suggestion_ref{ lc( $$suggestion_ref{"STATUS"}) . "date" } = C4::Dates->today;
 117             $$suggestion_ref{ lc( $$suggestion_ref{"STATUS"}) . "by" }   = C4::Context->userenv->{number};
 118         }
 119         $$suggestion_ref{"manageddate"} = C4::Dates->today;
 120         $$suggestion_ref{"managedby"}   = C4::Context->userenv->{number};
 121     }
 122     if ( $$suggestion_ref{'suggestionid'} > 0 ) {
 123         &ModSuggestion($suggestion_ref);
 124     } else {
 125         ###FIXME:Search here if suggestion already exists.
 126         my $suggestions_loop =
 127             SearchSuggestion( $suggestion_ref );
 128         if (@$suggestions_loop>=1){
 129             #some suggestion are answering the request Donot Add
 130         }
 131         else {
 132             ## Adding some informations related to suggestion
 133             &NewSuggestion($suggestion_ref);
 134         }
 135         # empty fields, to avoid filter in "SearchSuggestion"
 136     }
 137     map{delete $$suggestion_ref{$_}} keys %$suggestion_ref;
 138     $op = 'else';
 139
 140     if( $redirect eq 'purchase_suggestions' ) {
 141         print $input->redirect("/cgi-bin/koha/members/purchase-suggestions.pl?borrowernumber=$borrowernumber");
 142     }
 143
 144 }
 145 elsif ($op=~/add/) {
 146     #Adds suggestion
 147     Init($suggestion_ref);
 148     $op ='save';
 149 }
 150 elsif ($op=~/edit/) {
 151     #Edit suggestion
 152     $suggestion_ref=&GetSuggestion($$suggestion_ref{'suggestionid'});
 153     Init($suggestion_ref);
 154     $op ='save';
 155 }
 156 elsif ($op eq "change" ) {
 157     # set accepted/rejected/managed informations if applicable
 158     # ie= if the librarian has choosen some action on the suggestions
 159     if ($$suggestion_ref{"STATUS"} eq "ACCEPTED"){
 160         $$suggestion_ref{"accepteddate"}=C4::Dates->today;
 161         $$suggestion_ref{"acceptedby"}=C4::Context->userenv->{number};
 162     } elsif ($$suggestion_ref{"STATUS"} eq "REJECTED"){
 163         $$suggestion_ref{"rejecteddate"}=C4::Dates->today;
 164         $$suggestion_ref{"rejectedby"}=C4::Context->userenv->{number};
 165     }
 166     if ($$suggestion_ref{"STATUS"}){
 167         $$suggestion_ref{"manageddate"}=C4::Dates->today;
 168         $$suggestion_ref{"managedby"}=C4::Context->userenv->{number};
 169     }
 170     if ( my $reason = $$suggestion_ref{"reason$tabcode"}){
 171         if ( $reason eq "other" ) {
 172                 $reason = $$suggestion_ref{"other_reason$tabcode"};
 173         }
 174         $$suggestion_ref{'reason'}=$reason;
 175     }
 176     delete $$suggestion_ref{$_} foreach ("reason$tabcode", "other_reason$tabcode");
 177      foreach (keys %$suggestion_ref){
 178         delete $$suggestion_ref{$_} unless ($$suggestion_ref{$_});
 179     }
 180     foreach my $suggestionid (@editsuggestions) {
 181         next unless $suggestionid;
 182         $$suggestion_ref{'suggestionid'}=$suggestionid;
 183         &ModSuggestion($suggestion_ref);
 184     }
 185     $op = 'else';
 186 }elsif ($op eq "delete" ) {
 187     foreach my $delete_field (@editsuggestions) {
 188         &DelSuggestion( $borrowernumber, $delete_field,'intranet' );
 189     }
 190     $op = 'else';
 191 }
 192 elsif ( $op eq 'show' ) {
 193     $suggestion_ref=&GetSuggestion($$suggestion_ref{'suggestionid'});
 194     $$suggestion_ref{branchname} = GetBranchName $$suggestion_ref{branchcode};
 195     my $budget = GetBudget $$suggestion_ref{budgetid};
 196     $$suggestion_ref{budgetname} = $$budget{budget_name};
 197     Init($suggestion_ref);
 198 }
 199 if ($op=~/else/) {
 200     $op='else';
 201
 202     $displayby||="STATUS";
 203     delete $$suggestion_ref{'branchcode'} if($displayby eq "branchcode");
 204     # distinct values of display by
 205     my $criteria_list=GetDistinctValues("suggestions.".$displayby);
 206     my (@criteria_dv, $criteria_has_empty);
 207     foreach (@$criteria_list) {
 208         if ($_->{value}) {
 209             push @criteria_dv, $_->{value};
 210         } else {
 211             $criteria_has_empty = 1;
 212         }
 213     }
 214     # agregate null and empty values under empty value
 215     push @criteria_dv, '' if $criteria_has_empty;
 216
 217     my @allsuggestions;
 218     my $reasonsloop = GetAuthorisedValues("SUGGEST");
 219     foreach my $criteriumvalue ( @criteria_dv ) {
 220         # By default, display suggestions from current working branch
 221         unless ( exists $$suggestion_ref{'branchcode'} ) {
 222             $$suggestion_ref{'branchcode'} = C4::Context->userenv->{'branch'};
 223         }
 224         my $definedvalue = defined $$suggestion_ref{$displayby} && $$suggestion_ref{$displayby} ne "";
 225
 226         next if ( $definedvalue && $$suggestion_ref{$displayby} ne $criteriumvalue );
 227         $$suggestion_ref{$displayby} = $criteriumvalue;
 228
 229         my $suggestions = &SearchSuggestion($suggestion_ref);
 230         foreach my $suggestion (@$suggestions) {
 231             if ($suggestion->{budgetid}){
 232                 my $bud = GetBudget( $suggestion->{budgetid} );
 233                 $suggestion->{budget_name} = $bud->{budget_name} if $bud;
 234             }
 235             foreach my $date (qw(suggesteddate manageddate accepteddate)) {
 236                 if ($suggestion->{$date} and $suggestion->{$date} ne "0000-00-00") {
 237                     $suggestion->{$date} = format_date( $suggestion->{$date} );
 238                 } else {
 239                     $suggestion->{$date} = "";
 240                 }
 241             }
 242         }
 243         push @allsuggestions,{
 244                             "suggestiontype"=>$criteriumvalue||"suggest",
 245                             "suggestiontypelabel"=>GetCriteriumDesc($criteriumvalue,$displayby)||"",
 246                             "suggestionscount"=>scalar(@$suggestions),
 247                             'suggestions_loop'=>$suggestions,
 248                             'reasonsloop'     => $reasonsloop,
 249                             };
 250
 251         delete $$suggestion_ref{$displayby} unless $definedvalue;
 252     }
 253
 254     $template->param(
 255         "displayby"=> $displayby,
 256         "notabs"=> $displayby eq "",
 257         suggestions       => \@allsuggestions,
 258     );
 259 }
 260
 261 foreach my $element ( qw(managedby suggestedby acceptedby) ) {
 262 #    $debug || warn $$suggestion_ref{$element};
 263     if ($$suggestion_ref{$element}){
 264         my $member=GetMember(borrowernumber=>$$suggestion_ref{$element});
 265         $template->param(
 266             $element."_borrowernumber"=>$$member{borrowernumber},
 267             $element."_firstname"=>$$member{firstname},
 268             $element."_surname"=>$$member{surname},
 269             $element."_branchcode"=>$$member{branchcode},
 270             $element."_description"=>$$member{description},
 271             $element."_category_type"=>$$member{category_type}
 272         );
 273     }
 274 }
 275 $template->param(
 276     %$suggestion_ref,
 277     "op_$op"                => 1,
 278     "op"             =>$op,
 279 );
 280
 281 if(defined($returnsuggested) and $returnsuggested ne "noone")
 282 {
 283     print $input->redirect("/cgi-bin/koha/members/moremember.pl?borrowernumber=".$returnsuggested."#suggestions");
 284 }
 285
 286 ####################
 287 ## Initializing selection lists
 288
 289 #branch display management
 290 my $branchfilter = ($displayby ne "branchcode") ? $input->param('branchcode') : '';
 291 my $onlymine =
 292      C4::Context->preference('IndependentBranches')
 293   && C4::Context->userenv
 294   && !C4::Context->IsSuperLibrarian()
 295   && C4::Context->userenv->{branch};
 296 my $branches = GetBranches($onlymine);
 297 my @branchloop;
 298
 299 foreach my $thisbranch ( sort {$branches->{$a}->{'branchname'} cmp $branches->{$b}->{'branchname'}} keys %$branches ) {
 300     my %row = (
 301         value      => $thisbranch,
 302         branchname => $branches->{$thisbranch}->{'branchname'},
 303         selected   => ($branchfilter and $branches->{$thisbranch}->{'branchcode'} eq $branchfilter ) || ( $$suggestion_ref{'branchcode'} and $branches->{$thisbranch}->{'branchcode'} eq $$suggestion_ref{'branchcode'} )
 304     );
 305     push @branchloop, \%row;
 306 }
 307 $branchfilter=C4::Context->userenv->{'branch'} if ($onlymine && !$branchfilter);
 308
 309 $template->param( branchloop => \@branchloop,
 310                 branchfilter => $branchfilter);
 311
 312 # the index parameter is different for item-level itemtypes
 313 my $supportlist = GetSupportList();
 314
 315 foreach my $support (@$supportlist) {
 316     $$support{'selected'} = (defined $$suggestion_ref{'itemtype'})
 317         ? $$support{'itemtype'} eq $$suggestion_ref{'itemtype'}
 318         : 0;
 319     if ( $$support{'imageurl'} ) {
 320         $$support{'imageurl'} = getitemtypeimagelocation( 'intranet', $$support{'imageurl'} );
 321     } else {
 322         delete $$support{'imageurl'};
 323     }
 324 }
 325 $template->param(itemtypeloop=>$supportlist);
 326 $template->param( returnsuggestedby => $returnsuggestedby );
 327
 328 my $patron_reason_loop = GetAuthorisedValues("OPAC_SUG",$$suggestion_ref{'patronreason'});
 329 $template->param(patron_reason_loop=>$patron_reason_loop);
 330
 331 #Budgets management
 332 my $budgets = [];
 333 if ($branchfilter) {
 334     my $searchbudgets = { budget_branchcode => $branchfilter };
 335     $budgets = GetBudgets($searchbudgets);
 336 } else {
 337     $budgets = GetBudgets(undef);
 338 }
 339
 340 my @budgets_loop;
 341 foreach my $budget ( @{$budgets} ) {
 342     next unless (CanUserUseBudget($borrowernumber, $budget, $userflags));
 343
 344     ## Please see file perltidy.ERR
 345     $budget->{'selected'} = 1
 346         if ($$suggestion_ref{'budgetid'}
 347         && $budget->{'budget_id'} eq $$suggestion_ref{'budgetid'});
 348
 349     push @budgets_loop, $budget;
 350 }
 351
 352 $template->param( budgetsloop => \@budgets_loop);
 353 $template->param( "statusselected_$$suggestion_ref{'STATUS'}" =>1) if ($$suggestion_ref{'STATUS'});
 354
 355 # get currencies and rates
 356 my @rates = GetCurrencies();
 357 my $count = scalar @rates;
 358 my $active_currency = GetCurrency();
 359 my $selected_currency;
 360 if ($$suggestion_ref{'currency'}) {
 361     $selected_currency = $$suggestion_ref{'currency'};
 362 }
 363 else {
 364     $selected_currency = $active_currency->{currency};
 365 }
 366
 367 my @loop_currency = ();
 368 for ( my $i = 0 ; $i < $count ; $i++ ) {
 369     my %line;
 370     $line{currcode} = $rates[$i]->{'currency'};
 371     $line{rate}     = $rates[$i]->{'rate'};
 372     $line{selected} = 1 if ($line{'currcode'} eq $selected_currency);
 373     push @loop_currency, \%line;
 374 }
 375 $template->param(
 376     loop_currency => \@loop_currency,
 377     price        => sprintf("%.2f", $$suggestion_ref{'price'}||0),
 378     total            => sprintf("%.2f", $$suggestion_ref{'total'}||0),
 379 );
 380
 381 # lists of distinct values (without empty) for filters
 382 my %hashlists;
 383 foreach my $field ( qw(managedby acceptedby suggestedby budgetid) ) {
 384     my $values_list;
 385     $values_list = GetDistinctValues( "suggestions." . $field );
 386     my @codes_list = map {
 387         {   'code' => $$_{'value'},
 388             'desc' => GetCriteriumDesc( $$_{'value'}, $field ) || $$_{'value'},
 389             'selected' => ($$suggestion_ref{$field}) ? $$_{'value'} eq $$suggestion_ref{$field} : 0,
 390         }
 391     } grep {
 392         $$_{'value'}
 393     } @$values_list;
 394     $hashlists{ lc($field) . "_loop" } = \@codes_list;
 395 }
 396
 397 $template->param(
 398     %hashlists,
 399     borrowernumber           => $input->param('borrowernumber'),
 400     SuggestionStatuses       => GetAuthorisedValues('SUGGEST_STATUS'),
 401 );
 402 output_html_with_http_headers $input, $cookie, $template->output;