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