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 Modern::Perl;
  21 require Exporter;
  22 use CGI qw ( -utf8 );
  23 use C4::Auth qw( get_template_and_user );
  24 use C4::Output qw( output_html_with_http_headers );
  25 use C4::Suggestions;
  26 use C4::Koha qw( GetAuthorisedValues );
  27 use C4::Budgets qw( GetBudget GetBudgets GetBudgetHierarchy CanUserUseBudget );
  28 use C4::Search qw( FindDuplicate GetDistinctValues );
  29 use C4::Members;
  30 use Koha::DateUtils qw( dt_from_string );
  31 use Koha::AuthorisedValues;
  32 use Koha::Acquisition::Currencies;
  33 use Koha::Libraries;
  34 use Koha::Patrons;
  35
  36 use URI::Escape qw( uri_escape );
  37
  38 sub Init{
  39     my $suggestion= shift @_;
  40     # "Managed by" is used only when a suggestion is being edited (not when created)
  41     if ($suggestion->{'suggesteddate'} eq "") {
  42         # new suggestion
  43         $suggestion->{suggesteddate} = dt_from_string;
  44         $suggestion->{'suggestedby'} = C4::Context->userenv->{"number"} unless ($suggestion->{'suggestedby'});
  45     }
  46     else {
  47         # editing of an existing suggestion
  48         $suggestion->{manageddate} = dt_from_string;
  49         $suggestion->{'managedby'} = C4::Context->userenv->{"number"} unless ($suggestion->{'managedby'});
  50     }
  51     $suggestion->{'branchcode'}=C4::Context->userenv->{"branch"} unless ($suggestion->{'branchcode'});
  52 }
  53
  54 sub GetCriteriumDesc{
  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';
  60         }
  61         return ($criteriumvalue eq 'ASKED'?"Pending":ucfirst(lc( $criteriumvalue))) if ($displayby =~/status/i);
  62     }
  63     if ( $displayby =~ /branchcode/ ) {
  64         return $criteriumvalue ? Koha::Libraries->find($criteriumvalue)->branchname : "__ANY__";
  65     }
  66     if ( $displayby =~ /itemtype/ ) {
  67         my $av = Koha::AuthorisedValues->search({ category => 'SUGGEST_FORMAT', authorised_value => $criteriumvalue });
  68         return $av->count ? $av->next->lib : 'Unknown';
  69     }
  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;
  74     }
  75     if ( $displayby =~ /budgetid/) {
  76         my $budget = GetBudget($criteriumvalue);
  77         return "" unless $budget;
  78         return $$budget{budget_name};
  79     }
  80 }
  81
  82 my $input           = CGI->new;
  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') || 0;
  96
  97 my $reasonsloop     = GetAuthorisedValues("SUGGEST");
  98
  99 # filter informations which are not suggestion related.
 100 my $suggestion_ref  = { %{$input->Vars} }; # Copying, otherwise $input will be modified
 101
 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};
 107
 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' ));
 111 }
 112 delete $suggestion_only->{branchcode} if $suggestion_only->{branchcode} eq '__ANY__';
 113 delete $suggestion_only->{budgetid}   if $suggestion_only->{budgetid}   eq '__ANY__';
 114 while ( my ( $k, $v ) = each %$suggestion_only ) {
 115     delete $suggestion_only->{$k} if $v eq '';
 116 }
 117
 118 my ( $template, $borrowernumber, $cookie, $userflags ) = get_template_and_user(
 119         {
 120             template_name   => "suggestion/suggestion.tt",
 121             query           => $input,
 122             type            => "intranet",
 123             flagsrequired   => { suggestions => 'suggestions_manage' },
 124         }
 125     );
 126
 127 $borrowernumber = $input->param('borrowernumber') if ( $input->param('borrowernumber') );
 128 $template->param('borrowernumber' => $borrowernumber);
 129 my $branchfilter = $input->param('branchcode') || C4::Context->userenv->{'branch'};
 130
 131 #########################################
 132 ##  Operations
 133 ##
 134
 135 if ( $op =~ /save/i ) {
 136     my @messages;
 137     my $biblio = MarcRecordFromNewSuggestion({
 138             title => $suggestion_only->{title},
 139             author => $suggestion_only->{author},
 140             itemtype => $suggestion_only->{itemtype},
 141             isbn => $suggestion_only->{isbn},
 142     });
 143
 144     my $manager = Koha::Patrons->find( $suggestion_only->{managedby} );
 145     if ( $manager && not $manager->has_permission({suggestions => 'suggestions_manage'})) {
 146         push @messages, { type => 'error', code => 'manager_not_enough_permissions' };
 147         $template->param(
 148             messages => \@messages,
 149         );
 150         delete $suggestion_ref->{suggesteddate};
 151         delete $suggestion_ref->{manageddate};
 152         delete $suggestion_ref->{managedby};
 153         Init($suggestion_ref);
 154     }
 155     elsif ( !$suggestion_only->{suggestionid} && ( my ($duplicatebiblionumber, $duplicatetitle) = FindDuplicate($biblio) ) && !$save_confirmed ) {
 156         push @messages, { type => 'error', code => 'biblio_exists', id => $duplicatebiblionumber, title => $duplicatetitle };
 157         $template->param(
 158             messages => \@messages,
 159             need_confirm => 1
 160         );
 161         delete $suggestion_ref->{suggesteddate};
 162         delete $suggestion_ref->{manageddate};
 163         Init($suggestion_ref);
 164     }
 165     else {
 166
 167         for my $date_key ( qw( suggesteddate manageddate accepteddate rejecteddate ) ) {
 168             $suggestion_only->{$date_key} = dt_from_string( $suggestion_only->{$date_key} )
 169                 if $suggestion_only->{$date_key};
 170         }
 171
 172         if ( $suggestion_only->{"STATUS"} ) {
 173             if ( my $tmpstatus = lc( $suggestion_only->{"STATUS"} ) =~ /ACCEPTED|REJECTED/i ) {
 174                 $suggestion_only->{ lc( $suggestion_only->{"STATUS"}) . "date" } = dt_from_string;
 175                 $suggestion_only->{ lc( $suggestion_only->{"STATUS"}) . "by" }   = C4::Context->userenv->{number};
 176             }
 177             $suggestion_only->{manageddate} = dt_from_string;
 178             $suggestion_only->{"managedby"} ||= C4::Context->userenv->{number};
 179         }
 180
 181         my $otherreason = $input->param('other_reason');
 182         if ($suggestion_only->{reason} eq 'other' && $otherreason) {
 183             $suggestion_only->{reason} = $otherreason;
 184         }
 185
 186         if ( $suggestion_only->{'suggestionid'} > 0 ) {
 187
 188             $suggestion_only->{lastmodificationdate} = dt_from_string;
 189             $suggestion_only->{lastmodificationby}   = C4::Context->userenv->{number};
 190             $suggestion_only->{branchcode} = undef
 191               if exists $suggestion_only->{branchcode}
 192               && $suggestion_only->{branchcode} eq "";
 193
 194             &ModSuggestion($suggestion_only);
 195
 196             if ( $notify ) {
 197                 my $patron = Koha::Patrons->find( $suggestion_only->{managedby} );
 198                 my $email_address = $patron->notice_email_address;
 199                 if ($patron->notice_email_address) {
 200
 201                     my $letter = C4::Letters::GetPreparedLetter(
 202                         module      => 'suggestions',
 203                         letter_code => 'NOTIFY_MANAGER',
 204                         branchcode  => $patron->branchcode,
 205                         lang        => $patron->lang,
 206                         tables      => {
 207                             suggestions => $suggestion_only->{suggestionid},
 208                             branches    => $patron->branchcode,
 209                             borrowers   => $patron->borrowernumber,
 210                         },
 211                     );
 212                     C4::Letters::EnqueueLetter(
 213                         {
 214                             letter                 => $letter,
 215                             borrowernumber         => $patron->borrowernumber,
 216                             message_transport_type => 'email'
 217                         }
 218                     );
 219                 }
 220             }
 221         } else {
 222             ###FIXME:Search here if suggestion already exists.
 223             my $suggestions= Koha::Suggestions->search_limited( $suggestion_only );
 224             if ( $suggestions->count ) {
 225                 #some suggestion are answering the request Donot Add
 226                 my @messages;
 227                 while ( my $suggestion = $suggestions->next ) {
 228                     push @messages, { type => 'error', code => 'already_exists', id => $suggestion->suggestionid };
 229                 }
 230                 $template->param( messages => \@messages );
 231             }
 232             else {
 233                 ## Adding some informations related to suggestion
 234                 &NewSuggestion($suggestion_only);
 235             }
 236             # empty fields, to avoid filter in "SearchSuggestion"
 237         }
 238         map{delete $$suggestion_ref{$_} unless $_ eq 'branchcode' } keys %$suggestion_ref;
 239         $op = 'else';
 240
 241         if( $redirect eq 'purchase_suggestions' ) {
 242             print $input->redirect("/cgi-bin/koha/members/purchase-suggestions.pl?borrowernumber=$borrowernumber");
 243         }
 244     }
 245 }
 246 elsif ($op=~/add/) {
 247     #Adds suggestion
 248     Init($suggestion_ref);
 249     $op ='save';
 250 }
 251 elsif ($op=~/edit/) {
 252     #Edit suggestion
 253     $suggestion_ref=&GetSuggestion($$suggestion_ref{'suggestionid'});
 254     $suggestion_ref->{reasonsloop} = $reasonsloop;
 255     my $other_reason = 1;
 256     foreach my $reason ( @{ $reasonsloop } ) {
 257         if ($suggestion_ref->{reason} eq $reason->{lib}) {
 258             $other_reason = 0;
 259         }
 260     }
 261     $other_reason = 0 unless $suggestion_ref->{reason};
 262     $template->param(other_reason => $other_reason);
 263     Init($suggestion_ref);
 264     $op ='save';
 265 }
 266 elsif ($op eq "update_status" ) {
 267
 268     my $suggestion;
 269     # set accepted/rejected/managed informations if applicable
 270     # ie= if the librarian has chosen some action on the suggestions
 271     my $STATUS      = $input->param('STATUS');
 272     my $accepted_by = $input->param('acceptedby');
 273     if ( $STATUS eq "ACCEPTED" ) {
 274         $suggestion = {
 275             accepteddate => dt_from_string,
 276             acceptedby => C4::Context->userenv->{number},
 277         };
 278     }
 279     elsif ( $STATUS eq "REJECTED" ) {
 280         $suggestion = {
 281             rejecteddate => dt_from_string,
 282             rejectedby   => C4::Context->userenv->{number},
 283         };
 284     }
 285     if ($STATUS) {
 286         $suggestion->{manageddate} = dt_from_string;
 287         $suggestion->{managedby}   = C4::Context->userenv->{number};
 288         $suggestion->{STATUS}      = $STATUS;
 289     }
 290     if ( my $reason = $input->param("reason") ) {
 291         if ( $reason eq "other" ) {
 292             $reason = $input->param("other_reason");
 293         }
 294         $suggestion->{reason} = $reason;
 295     }
 296
 297     foreach my $suggestionid (@editsuggestions) {
 298         next unless $suggestionid;
 299         $suggestion->{suggestionid} = $suggestionid;
 300         &ModSuggestion($suggestion);
 301     }
 302     redirect_with_params($input);
 303 }elsif ($op eq "delete" ) {
 304     foreach my $delete_field (@editsuggestions) {
 305         &DelSuggestion( $borrowernumber, $delete_field,'intranet' );
 306     }
 307     redirect_with_params($input);
 308 }
 309 elsif ($op eq "archive" ) {
 310     Koha::Suggestions->find($_)->update({ archived => 1 }) for @editsuggestions;
 311
 312     redirect_with_params($input);
 313 }
 314 elsif ($op eq "unarchive" ) {
 315     Koha::Suggestions->find($_)->update({ archived => 0 }) for @editsuggestions;
 316
 317     redirect_with_params($input);
 318 }
 319 elsif ( $op eq 'update_itemtype' ) {
 320     my $new_itemtype = $input->param('suggestion_itemtype');
 321     foreach my $suggestionid (@editsuggestions) {
 322         next unless $suggestionid;
 323         &ModSuggestion({ suggestionid => $suggestionid, itemtype => $new_itemtype });
 324     }
 325     redirect_with_params($input);
 326 }
 327 elsif ( $op eq 'update_manager' ) {
 328     my $managedby = $input->param('suggestion_managedby');
 329     foreach my $suggestionid (@editsuggestions) {
 330         next unless $suggestionid;
 331         &ModSuggestion({ suggestionid => $suggestionid, managedby => $managedby });
 332     }
 333     redirect_with_params($input);
 334 }
 335 elsif ( $op eq 'show' ) {
 336     $suggestion_ref=&GetSuggestion($$suggestion_ref{'suggestionid'});
 337     my $budget = GetBudget $$suggestion_ref{budgetid};
 338     $$suggestion_ref{budgetname} = $$budget{budget_name};
 339     Init($suggestion_ref);
 340 }
 341 if ($op=~/else/) {
 342     $op='else';
 343
 344     $displayby||="STATUS";
 345     # distinct values of display by
 346     my $criteria_list=GetDistinctValues("suggestions.".$displayby);
 347     my (@criteria_dv, $criteria_has_empty);
 348     foreach (@$criteria_list) {
 349         if ($_->{value}) {
 350             push @criteria_dv, $_->{value};
 351         } else {
 352             $criteria_has_empty = 1;
 353         }
 354     }
 355     # aggregate null and empty values under empty value
 356     push @criteria_dv, '' if $criteria_has_empty;
 357
 358     # Hack to not modify GetDistinctValues for this specific case
 359     if (   $displayby eq 'branchcode'
 360         && C4::Context->preference('IndependentBranches')
 361         && not C4::Context->IsSuperLibrarian )
 362     {
 363         @criteria_dv = ( C4::Context->userenv->{'branch'} );
 364     }
 365     # Pending tab first
 366     if ( $displayby eq 'STATUS' ) {
 367         @criteria_dv = grep { $_ ne 'ASKED' } @criteria_dv;
 368         unshift @criteria_dv, 'ASKED';
 369     }
 370
 371     unless ( exists $suggestion_ref->{branchcode} ) {
 372         $suggestion_ref->{branchcode} = C4::Context->userenv->{'branch'};
 373     }
 374
 375     my @allsuggestions;
 376     foreach my $criteriumvalue ( @criteria_dv ) {
 377         my $search_params = {%$suggestion_ref};
 378         # By default, display suggestions from current working branch
 379         my $definedvalue = defined $$suggestion_ref{$displayby} && $$suggestion_ref{$displayby} ne "";
 380
 381         next if ( $definedvalue && $$suggestion_ref{$displayby} ne $criteriumvalue ) and ($displayby ne 'branchcode' && $branchfilter ne '__ANY__' );
 382
 383         $search_params->{$displayby} = $criteriumvalue;
 384
 385         # filter on date fields
 386         foreach my $field (qw( suggesteddate manageddate accepteddate )) {
 387             my $from = $field . "_from";
 388             my $to   = $field . "_to";
 389             my $from_dt =
 390               $suggestion_ref->{$from}
 391               ? eval { dt_from_string( $suggestion_ref->{$from} ) }
 392               : undef;
 393             my $to_dt =
 394               $suggestion_ref->{$to}
 395               ? eval { dt_from_string( $suggestion_ref->{$to} ) }
 396               : undef;
 397
 398             if ( $from_dt || $to_dt ) {
 399                 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
 400                 if ( $from_dt && $to_dt ) {
 401                     $search_params->{$field} = { -between => [ $from_dt, $to_dt ] };
 402                 } elsif ( $from_dt ) {
 403                     $search_params->{$field} = { '>=' => $from_dt };
 404                 } elsif ( $to_dt ) {
 405                     $search_params->{$field} = { '<=' => $to_dt };
 406                 }
 407             }
 408         }
 409         if ( $search_params->{budgetid} && $search_params->{budgetid} eq '__NONE__' ) {
 410             $search_params->{budgetid} = [undef, '' ];
 411         }
 412         for my $f (qw (branchcode budgetid)) {
 413             delete $search_params->{$f}
 414               if $search_params->{$f} eq '__ANY__'
 415               || $search_params->{$f} eq '';
 416         }
 417
 418         my @suggestions =
 419           Koha::Suggestions->search_limited(
 420             { %$search_params, archived => $filter_archived } )->as_list;
 421
 422         push @allsuggestions,
 423           {
 424             "suggestiontype"      => $criteriumvalue || "suggest",
 425             "suggestiontypelabel" => GetCriteriumDesc( $criteriumvalue, $displayby ) || "",
 426             'suggestions'         => \@suggestions,
 427             'reasonsloop'         => $reasonsloop,
 428           }
 429           if scalar @suggestions > 0;
 430
 431         delete $$suggestion_ref{$displayby} unless $definedvalue;
 432     }
 433
 434     $template->param(
 435         "displayby"=> $displayby,
 436         "notabs"=> $displayby eq "",
 437         suggestions       => \@allsuggestions,
 438     );
 439 }
 440
 441 $template->param(
 442     "${_}_patron" => scalar Koha::Patrons->find( $suggestion_ref->{$_} ) )
 443   for qw(managedby suggestedby acceptedby lastmodificationby);
 444
 445 $template->param(
 446     %$suggestion_ref,
 447     filter_archived => $filter_archived,
 448     "op"             =>$op,
 449 );
 450
 451 if(defined($returnsuggested) and $returnsuggested ne "noone")
 452 {
 453     print $input->redirect("/cgi-bin/koha/members/moremember.pl?borrowernumber=".$returnsuggested."#suggestions");
 454 }
 455
 456 $template->param(
 457     branchfilter => $branchfilter,
 458 );
 459
 460 $template->param( returnsuggestedby => $returnsuggestedby );
 461
 462 my $patron_reason_loop = GetAuthorisedValues("OPAC_SUG");
 463 $template->param(patron_reason_loop=>$patron_reason_loop);
 464
 465 # Budgets for filtering
 466 my $budgets = GetBudgets;
 467 my @budgets_loop;
 468 foreach my $budget ( @{$budgets} ) {
 469     next unless (CanUserUseBudget($borrowernumber, $budget, $userflags));
 470
 471     ## Please see file perltidy.ERR
 472     $budget->{'selected'} = 1
 473         if ($$suggestion_ref{'budgetid'}
 474         && $budget->{'budget_id'} eq $$suggestion_ref{'budgetid'});
 475
 476     push @budgets_loop, $budget;
 477 }
 478 $template->param( budgetsloop => \@budgets_loop);
 479
 480 # Budgets for suggestion add or edition
 481 my $sugg_budget_loop = [];
 482 my $sugg_budgets     = GetBudgetHierarchy();
 483 foreach my $r ( @{$sugg_budgets} ) {
 484     next unless ( CanUserUseBudget( $borrowernumber, $r, $userflags ) );
 485     my $selected = ( $$suggestion_ref{budgetid} && $r->{budget_id} eq $$suggestion_ref{budgetid} ) ? 1 : 0;
 486     push @{$sugg_budget_loop},
 487       {
 488         b_id     => $r->{budget_id},
 489         b_txt    => $r->{budget_name},
 490         b_active => $r->{budget_period_active},
 491         selected => $selected,
 492       };
 493 }
 494 @{$sugg_budget_loop} = sort { uc( $a->{b_txt} ) cmp uc( $b->{b_txt} ) } @{$sugg_budget_loop};
 495 $template->param( sugg_budgets => $sugg_budget_loop);
 496
 497 if( $suggestion_ref->{STATUS} ) {
 498     $template->param(
 499         "statusselected_".$suggestion_ref->{STATUS} => 1,
 500         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
 501     );
 502 }
 503
 504 my $currencies = Koha::Acquisition::Currencies->search;
 505 $template->param(
 506     currencies   => $currencies,
 507     suggestion   => $suggestion_ref,
 508     price        => sprintf("%.2f", $$suggestion_ref{'price'}||0),
 509     total            => sprintf("%.2f", $$suggestion_ref{'total'}||0),
 510 );
 511
 512 # lists of distinct values (without empty) for filters
 513 my %hashlists;
 514 foreach my $field ( qw(managedby acceptedby suggestedby budgetid) ) {
 515     my $values_list;
 516     $values_list = GetDistinctValues( "suggestions." . $field );
 517     my @codes_list = map {
 518         {   'code' => $$_{'value'},
 519             'desc' => GetCriteriumDesc( $$_{'value'}, $field ) || $$_{'value'},
 520             'selected' => ($$suggestion_ref{$field}) ? $$_{'value'} eq $$suggestion_ref{$field} : 0,
 521         }
 522     } grep {
 523         $$_{'value'}
 524     } @$values_list;
 525     $hashlists{ lc($field) . "_loop" } = \@codes_list;
 526 }
 527
 528 $template->param(
 529     %hashlists,
 530     borrowernumber           => ($input->param('borrowernumber') // undef),
 531     SuggestionStatuses       => GetAuthorisedValues('SUGGEST_STATUS'),
 532 );
 533 output_html_with_http_headers $input, $cookie, $template->output;
 534
 535 sub redirect_with_params {
 536     my ( $input ) = @_;
 537     my $params = '';
 538     foreach my $key (
 539         qw(
 540         displayby branchcode title author isbn publishercode copyrightdate
 541         collectiontitle suggestedby suggesteddate_from suggesteddate_to
 542         manageddate_from manageddate_to accepteddate_from
 543         accepteddate_to budgetid filter_archived
 544         )
 545       )
 546     {
 547         $params .= $key . '=' . uri_escape(scalar $input->param($key)) . '&'
 548           if defined($input->param($key));
 549     }
 550     print $input->redirect("/cgi-bin/koha/suggestion/suggestion.pl?$params");
 551 }