Bug 31333: Add ability to make purchase suggestions by borrower type
[koha.git] / opac / opac-suggestions.pl
1 #!/usr/bin/perl
2
3 # This file is part of Koha.
4 #
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
9 #
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
17
18 use Modern::Perl;
19
20
21 use CGI qw ( -utf8 );
22 use Encode;
23 use C4::Auth qw( get_template_and_user );
24 use C4::Members;
25 use C4::Koha qw( GetAuthorisedValues );
26 use C4::Output qw( output_html_with_http_headers );
27 use C4::Suggestions qw(
28     DelSuggestion
29     MarcRecordFromNewSuggestion
30     NewSuggestion
31 );
32 use C4::Koha qw( GetAuthorisedValues );
33 use C4::Scrubber;
34 use C4::Search qw( FindDuplicate );
35
36 use Koha::AuthorisedValues;
37 use Koha::Libraries;
38 use Koha::Patrons;
39
40 use Koha::DateUtils qw( dt_from_string );
41
42 my $input           = CGI->new;
43 my $op              = $input->param('op') || 'else';
44 my $biblionumber    = $input->param('biblionumber');
45 my $negcaptcha      = $input->param('negcap');
46 my $suggested_by_anyone = $input->param('suggested_by_anyone') || 0;
47 my $title_filter    = $input->param('title_filter');
48 my $need_confirm    = 0;
49
50 my $suggestion = {
51     biblionumber    => scalar $input->param('biblionumber'),
52     title           => scalar $input->param('title'),
53     author          => scalar $input->param('author'),
54     copyrightdate   => scalar $input->param('copyrightdate'),
55     isbn            => scalar $input->param('isbn'),
56     publishercode   => scalar $input->param('publishercode'),
57     collectiontitle => scalar $input->param('collectiontitle'),
58     place           => scalar $input->param('place'),
59     quantity        => scalar $input->param('quantity'),
60     itemtype        => scalar $input->param('itemtype'),
61     branchcode      => scalar $input->param('branchcode'),
62     patronreason    => scalar $input->param('patronreason'),
63     note            => scalar $input->param('note'),
64 };
65
66 # If a spambot accidentally populates the 'negcap' field in the sugesstions form, then silently skip and return.
67 if ($negcaptcha ) {
68     print $input->redirect("/cgi-bin/koha/opac-suggestions.pl");
69     exit;
70 }
71
72 my ( $template, $borrowernumber, $cookie, @messages );
73 my $deleted = $input->param('deleted');
74 my $submitted = $input->param('submitted');
75
76 if ( ( C4::Context->preference("AnonSuggestions") and Koha::Patrons->find( C4::Context->preference("AnonymousPatron") ) ) or ( C4::Context->preference("OPACViewOthersSuggestions") and $op eq 'else' ) ) {
77     ( $template, $borrowernumber, $cookie ) = get_template_and_user(
78         {
79             template_name   => "opac-suggestions.tt",
80             query           => $input,
81             type            => "opac",
82             authnotrequired => ( C4::Context->preference("OpacPublic") ? 1 : 0 ),
83         }
84     );
85 }
86 else {
87     ( $template, $borrowernumber, $cookie ) = get_template_and_user(
88         {
89             template_name   => "opac-suggestions.tt",
90             query           => $input,
91             type            => "opac",
92         }
93     );
94 }
95
96 # If suggestions are turned off, or this patron belongs to a category not allowed to make suggestions (suggestionPatronCategoryExceptions syspref) we redirect to 404 error. This will also redirect guest suggestions
97 if ( !Koha::Patrons->find( $borrowernumber )->category->can_make_suggestions ) {
98     print $input->redirect("/cgi-bin/koha/errors/404.pl");
99     exit;
100 }
101
102 my $suggested_by;
103 if ( $op eq 'else' ) {
104     if ( C4::Context->preference("OPACViewOthersSuggestions") ) {
105         if ( $borrowernumber ) {
106             # A logged in user is able to see suggestions from others
107             $suggested_by = $suggested_by_anyone
108                 ? undef
109                 : $borrowernumber;
110         }
111         # else: Non logged in user is able to see all suggestions
112     }
113     else {
114         if ( $borrowernumber ) {
115             $suggested_by = $borrowernumber;
116         }
117         else {
118             $suggested_by = -1;
119         }
120     }
121 } else {
122     if ( $borrowernumber ) {
123         $suggested_by = $borrowernumber;
124     }
125     else {
126         $suggested_by = C4::Context->preference("AnonymousPatron");
127     }
128 }
129
130 $suggestion = {
131     map {
132         my $p = $suggestion->{$_};
133         # Keep parameters that are not an empty string
134         ( defined $p && $p ne '' ? ( $_ => $p ) : () )
135     } keys %$suggestion
136 };
137 $suggestion->{suggestedby} = $borrowernumber;
138
139 if ( $op eq "add_validate" && not $biblionumber ) { # If we are creating the suggestion from an existing record we do not want to search for duplicates
140     $op = 'add_confirm';
141     my $biblio = MarcRecordFromNewSuggestion($suggestion);
142     if ( my ($duplicatebiblionumber, $duplicatetitle) = FindDuplicate($biblio) ) {
143         push @messages, { type => 'error', code => 'biblio_exists', id => $duplicatebiblionumber, title => $duplicatetitle };
144         $need_confirm = 1;
145         $op = 'add';
146     }
147 }
148
149 my $patrons_pending_suggestions_count = 0;
150 my $patrons_total_suggestions_count = 0;
151 if ( $borrowernumber ){
152     if ( C4::Context->preference("MaxTotalSuggestions") ne '' && C4::Context->preference("NumberOfSuggestionDays") ne '' ) {
153         my $suggesteddate_from = dt_from_string()->subtract(days=>C4::Context->preference("NumberOfSuggestionDays"));
154         $patrons_total_suggestions_count = Koha::Suggestions->search({ suggestedby => $borrowernumber, suggesteddate => { '>=' => $suggesteddate_from } })->count;
155
156     }
157     if ( C4::Context->preference("MaxOpenSuggestions") ne '' ) {
158         $patrons_pending_suggestions_count = Koha::Suggestions->search({ suggestedby => $borrowernumber, STATUS => 'ASKED' } )->count ;
159     }
160 }
161
162 if ( $op eq "add_confirm" ) {
163     my $suggestions = Koha::Suggestions->search($suggestion);
164     if ( C4::Context->preference("MaxTotalSuggestions") ne '' && $patrons_total_suggestions_count >= C4::Context->preference("MaxTotalSuggestions") )
165     {
166         push @messages, { type => 'error', code => 'total_suggestions' };
167     }
168     elsif ( C4::Context->preference("MaxOpenSuggestions") ne '' && $patrons_pending_suggestions_count >= C4::Context->preference("MaxOpenSuggestions") ) #only check limit for signed in borrowers
169     {
170         push @messages, { type => 'error', code => 'too_many' };
171     }
172     elsif ( $suggestions->count >= 1 ) {
173
174         #some suggestion are answering the request Donot Add
175         while ( my $suggestion = $suggestions->next ) {
176             push @messages,
177               {
178                 type => 'error',
179                 code => 'already_exists',
180                 id   => $suggestion->suggestionid
181               };
182             last;
183         }
184     }
185     else {
186         for my $f ( split(/\s*\,\s*/, C4::Context->preference("OPACSuggestionUnwantedFields") ) ) {
187             delete $suggestion->{$f};
188         }
189
190         my $scrubber = C4::Scrubber->new();
191         foreach my $suggest ( keys %$suggestion ) {
192
193             # Don't know why the encode is needed for Perl v5.10 here
194             $suggestion->{$suggest} = Encode::encode( "utf8",
195                 $scrubber->scrub( $suggestion->{$suggest} ) );
196         }
197         $suggestion->{suggesteddate} = dt_from_string;
198         $suggestion->{branchcode} = $input->param('branchcode') || C4::Context->userenv->{"branch"};
199         $suggestion->{STATUS} = 'ASKED';
200
201         &NewSuggestion($suggestion);
202         $patrons_pending_suggestions_count++;
203         $patrons_total_suggestions_count++;
204
205         push @messages, { type => 'info', code => 'success_on_inserted' };
206
207     }
208     $op = 'else';
209 }
210
211 my $suggestions = [ Koha::Suggestions->search_limited(
212     {
213         $suggestion->{suggestedby}
214         ? ( suggestedby => $suggestion->{suggestedby} )
215         : (),
216         $title_filter
217         ? ( title       => $title_filter )
218         : (),
219     }
220 )->as_list ];
221
222 if ( $op eq "delete_confirm" ) {
223     my @delete_field = $input->multi_param("delete_field");
224     foreach my $delete_field (@delete_field) {
225         &DelSuggestion( $borrowernumber, $delete_field );
226     }
227     $op = 'else';
228     print $input->redirect("/cgi-bin/koha/opac-suggestions.pl?op=else");
229     exit;
230 }
231
232 my $patron_reason_loop = GetAuthorisedValues("OPAC_SUG", "opac");
233
234 my @mandatoryfields;
235 if ( $op eq 'add' ) {
236     my $fldsreq_sp = C4::Context->preference("OPACSuggestionMandatoryFields") || 'title';
237     @mandatoryfields = sort split(/\s*\|\s*/, $fldsreq_sp);
238     foreach (@mandatoryfields) {
239         $template->param( $_."_required" => 1);
240     }
241     if ( $biblionumber ) {
242         my $biblio = Koha::Biblios->find($biblionumber);
243         $suggestion = {
244             biblionumber    => $biblio->biblionumber,
245             title           => $biblio->title,
246             author          => $biblio->author,
247             copyrightdate   => $biblio->copyrightdate,
248             isbn            => $biblio->biblioitem->isbn,
249             publishercode   => $biblio->biblioitem->publishercode,
250             collectiontitle => $biblio->biblioitem->collectiontitle,
251             place           => $biblio->biblioitem->place,
252         };
253     }
254 }
255
256 my @unwantedfields;
257 {
258     last unless ($op eq 'add');
259     my $fldsreq_sp = C4::Context->preference("OPACSuggestionUnwantedFields");
260     @unwantedfields = sort split(/\s*\|\s*/, $fldsreq_sp);
261     foreach (@unwantedfields) {
262         $template->param( $_."_hidden" => 1);
263     }
264 }
265
266 $template->param(
267     %$suggestion,
268     suggestions           => $suggestions,
269     patron_reason_loop    => $patron_reason_loop,
270     "op_$op"              => 1,
271     $op                   => 1,
272     messages              => \@messages,
273     suggestionsview       => 1,
274     suggested_by_anyone   => $suggested_by_anyone,
275     title_filter          => $title_filter,
276     patrons_pending_suggestions_count => $patrons_pending_suggestions_count,
277     need_confirm => $need_confirm,
278     patrons_total_suggestions_count => $patrons_total_suggestions_count,
279 );
280
281 output_html_with_http_headers $input, $cookie, $template->output, undef, { force_no_caching => 1 };
282