Bug 14358: Changing the module refreshes the page and resets library choice
[koha.git] / opac / opac-memberentry.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 use CGI qw ( -utf8 );
21 use Digest::MD5 qw( md5_base64 md5_hex );
22 use JSON;
23 use List::MoreUtils qw( any each_array uniq );
24 use String::Random qw( random_string );
25
26 use C4::Auth;
27 use C4::Output;
28 use C4::Members;
29 use C4::Members::Attributes qw( GetBorrowerAttributes );
30 use C4::Form::MessagingPreferences;
31 use Koha::AuthUtils;
32 use Koha::Patrons;
33 use Koha::Patron::Modification;
34 use Koha::Patron::Modifications;
35 use C4::Scrubber;
36 use Email::Valid;
37 use Koha::DateUtils;
38 use Koha::Libraries;
39 use Koha::Patron::Attribute::Types;
40 use Koha::Patron::Attributes;
41 use Koha::Patron::Images;
42 use Koha::Patron::Modification;
43 use Koha::Patron::Modifications;
44 use Koha::Patrons;
45 use Koha::Token;
46
47 my $cgi = new CGI;
48 my $dbh = C4::Context->dbh;
49
50 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
51     {
52         template_name   => "opac-memberentry.tt",
53         type            => "opac",
54         query           => $cgi,
55         authnotrequired => 1,
56     }
57 );
58
59 unless ( C4::Context->preference('PatronSelfRegistration') || $borrowernumber )
60 {
61     print $cgi->redirect("/cgi-bin/koha/opac-main.pl");
62     exit;
63 }
64
65 my $action = $cgi->param('action') || q{};
66 if ( $action eq q{} ) {
67     if ($borrowernumber) {
68         $action = 'edit';
69     }
70     else {
71         $action = 'new';
72     }
73 }
74
75 my $mandatory = GetMandatoryFields($action);
76
77 my @libraries = Koha::Libraries->search;
78 if ( my @libraries_to_display = split '\|', C4::Context->preference('PatronSelfRegistrationLibraryList') ) {
79     @libraries = map { my $b = $_; my $branchcode = $_->branchcode; grep( /^$branchcode$/, @libraries_to_display ) ? $b : () } @libraries;
80 }
81 my ( $min, $max ) = C4::Members::get_cardnumber_length();
82 if ( defined $min ) {
83      $template->param(
84          minlength_cardnumber => $min,
85          maxlength_cardnumber => $max
86      );
87  }
88
89 $template->param(
90     action            => $action,
91     hidden            => GetHiddenFields( $mandatory, $action ),
92     mandatory         => $mandatory,
93     libraries         => \@libraries,
94     OPACPatronDetails => C4::Context->preference('OPACPatronDetails'),
95 );
96
97 my $attributes = ParsePatronAttributes($borrowernumber,$cgi);
98 my $conflicting_attribute = 0;
99
100 foreach my $attr (@$attributes) {
101     unless ( C4::Members::Attributes::CheckUniqueness($attr->{code}, $attr->{value}, $borrowernumber) ) {
102         my $attr_info = C4::Members::AttributeTypes->fetch($attr->{code});
103         $template->param(
104             extended_unique_id_failed_code => $attr->{code},
105             extended_unique_id_failed_value => $attr->{value},
106             extended_unique_id_failed_description => $attr_info->description()
107         );
108         $conflicting_attribute = 1;
109     }
110 }
111
112 if ( $action eq 'create' ) {
113
114     my %borrower = ParseCgiForBorrower($cgi);
115
116     %borrower = DelEmptyFields(%borrower);
117
118     my @empty_mandatory_fields = CheckMandatoryFields( \%borrower, $action );
119     my $invalidformfields = CheckForInvalidFields(\%borrower);
120     delete $borrower{'password2'};
121     my $cardnumber_error_code;
122     if ( !grep { $_ eq 'cardnumber' } @empty_mandatory_fields ) {
123         # No point in checking the cardnumber if it's missing and mandatory, it'll just generate a
124         # spurious length warning.
125         $cardnumber_error_code = checkcardnumber( $borrower{cardnumber}, $borrower{borrowernumber} );
126     }
127
128     if ( @empty_mandatory_fields || @$invalidformfields || $cardnumber_error_code || $conflicting_attribute ) {
129         if ( $cardnumber_error_code == 1 ) {
130             $template->param( cardnumber_already_exists => 1 );
131         } elsif ( $cardnumber_error_code == 2 ) {
132             $template->param( cardnumber_wrong_length => 1 );
133         }
134
135         $template->param(
136             empty_mandatory_fields => \@empty_mandatory_fields,
137             invalid_form_fields    => $invalidformfields,
138             borrower               => \%borrower
139         );
140         $template->param( patron_attribute_classes => GeneratePatronAttributesForm( undef, $attributes ) );
141     }
142     elsif (
143         md5_base64( uc( $cgi->param('captcha') ) ) ne $cgi->param('captcha_digest') )
144     {
145         $template->param(
146             failed_captcha => 1,
147             borrower       => \%borrower
148         );
149         $template->param( patron_attribute_classes => GeneratePatronAttributesForm( undef, $attributes ) );
150     }
151     else {
152         if (
153             C4::Context->boolean_preference(
154                 'PatronSelfRegistrationVerifyByEmail')
155           )
156         {
157             ( $template, $borrowernumber, $cookie ) = get_template_and_user(
158                 {
159                     template_name   => "opac-registration-email-sent.tt",
160                     type            => "opac",
161                     query           => $cgi,
162                     authnotrequired => 1,
163                 }
164             );
165             $template->param( 'email' => $borrower{'email'} );
166
167             my $verification_token = md5_hex( time().{}.rand().{}.$$ );
168             while ( Koha::Patron::Modifications->search( { verification_token => $verification_token } )->count() ) {
169                 $verification_token = md5_hex( time().{}.rand().{}.$$ );
170             }
171
172             $borrower{password}           = Koha::AuthUtils::generate_password unless $borrower{password};
173             $borrower{verification_token} = $verification_token;
174
175             Koha::Patron::Modification->new( \%borrower )->store();
176
177             #Send verification email
178             my $letter = C4::Letters::GetPreparedLetter(
179                 module      => 'members',
180                 letter_code => 'OPAC_REG_VERIFY',
181                 lang        => 'default', # Patron does not have a preferred language defined yet
182                 tables      => {
183                     borrower_modifications => $verification_token,
184                 },
185             );
186
187             C4::Letters::EnqueueLetter(
188                 {
189                     letter                 => $letter,
190                     message_transport_type => 'email',
191                     to_address             => $borrower{'email'},
192                     from_address =>
193                       C4::Context->preference('KohaAdminEmailAddress'),
194                 }
195             );
196         }
197         else {
198             ( $template, $borrowernumber, $cookie ) = get_template_and_user(
199                 {
200                     template_name   => "opac-registration-confirmation.tt",
201                     type            => "opac",
202                     query           => $cgi,
203                     authnotrequired => 1,
204                 }
205             );
206
207             $template->param( OpacPasswordChange =>
208                   C4::Context->preference('OpacPasswordChange') );
209
210             my ( $borrowernumber, $password ) = AddMember_Opac(%borrower);
211             C4::Members::Attributes::SetBorrowerAttributes( $borrowernumber, $attributes );
212             C4::Form::MessagingPreferences::handle_form_action($cgi, { borrowernumber => $borrowernumber }, $template, 1, C4::Context->preference('PatronSelfRegistrationDefaultCategory') ) if $borrowernumber && C4::Context->preference('EnhancedMessagingPreferences');
213
214             $template->param( password_cleartext => $password );
215             my $patron = Koha::Patrons->find( $borrowernumber );
216             $template->param( borrower => $patron->unblessed );
217             $template->param(
218                 PatronSelfRegistrationAdditionalInstructions =>
219                   C4::Context->preference(
220                     'PatronSelfRegistrationAdditionalInstructions')
221             );
222         }
223     }
224 }
225 elsif ( $action eq 'update' ) {
226
227     my $borrower = Koha::Patrons->find( $borrowernumber )->unblessed;
228     die "Wrong CSRF token"
229         unless Koha::Token->new->check_csrf({
230             session_id => scalar $cgi->cookie('CGISESSID'),
231             token  => scalar $cgi->param('csrf_token'),
232         });
233
234     my %borrower = ParseCgiForBorrower($cgi);
235     $borrower{borrowernumber} = $borrowernumber;
236
237     my %borrower_changes = DelEmptyFields(%borrower);
238     my @empty_mandatory_fields =
239       CheckMandatoryFields( \%borrower_changes, $action );
240     my $invalidformfields = CheckForInvalidFields(\%borrower);
241
242     # Send back the data to the template
243     %borrower = ( %$borrower, %borrower );
244
245     if (@empty_mandatory_fields || @$invalidformfields) {
246         $template->param(
247             empty_mandatory_fields => \@empty_mandatory_fields,
248             invalid_form_fields    => $invalidformfields,
249             borrower               => \%borrower,
250             csrf_token             => Koha::Token->new->generate_csrf({
251                 session_id => scalar $cgi->cookie('CGISESSID'),
252             }),
253         );
254         $template->param( patron_attribute_classes => GeneratePatronAttributesForm( $borrowernumber, $attributes ) );
255
256         $template->param( action => 'edit' );
257     }
258     else {
259         my %borrower_changes = DelUnchangedFields( $borrowernumber, %borrower );
260         my $extended_attributes_changes = FilterUnchangedAttributes( $borrowernumber, $attributes );
261
262         if ( %borrower_changes || scalar @{$extended_attributes_changes} > 0 ) {
263             ( $template, $borrowernumber, $cookie ) = get_template_and_user(
264                 {
265                     template_name   => "opac-memberentry-update-submitted.tt",
266                     type            => "opac",
267                     query           => $cgi,
268                     authnotrequired => 1,
269                 }
270             );
271
272             $borrower_changes{borrowernumber} = $borrowernumber;
273             $borrower_changes{extended_attributes} = to_json($extended_attributes_changes);
274
275             Koha::Patron::Modifications->search({ borrowernumber => $borrowernumber })->delete;
276
277             my $m = Koha::Patron::Modification->new( \%borrower_changes )->store();
278
279             my $patron = Koha::Patrons->find( $borrowernumber );
280             $template->param( borrower => $patron->unblessed );
281         }
282         else {
283             my $patron = Koha::Patrons->find( $borrowernumber );
284             $template->param(
285                 action => 'edit',
286                 nochanges => 1,
287                 borrower => $patron->unblessed,
288                 patron_attribute_classes => GeneratePatronAttributesForm( $borrowernumber, $attributes ),
289                 csrf_token => Koha::Token->new->generate_csrf({
290                     session_id => scalar $cgi->cookie('CGISESSID'),
291                 }),
292             );
293         }
294     }
295 }
296 elsif ( $action eq 'edit' ) {    #Display logged in borrower's data
297     my $patron = Koha::Patrons->find( $borrowernumber );
298     my $borrower = $patron->unblessed;
299
300     $template->param(
301         borrower  => $borrower,
302         guarantor => scalar Koha::Patrons->find($borrowernumber)->guarantor(),
303         hidden => GetHiddenFields( $mandatory, 'edit' ),
304         csrf_token => Koha::Token->new->generate_csrf({
305             session_id => scalar $cgi->cookie('CGISESSID'),
306         }),
307     );
308
309     if (C4::Context->preference('OPACpatronimages')) {
310         $template->param( display_patron_image => 1 ) if $patron->image;
311     }
312
313     $template->param( patron_attribute_classes => GeneratePatronAttributesForm( $borrowernumber ) );
314 } else {
315     # Render self-registration page
316     $template->param( patron_attribute_classes => GeneratePatronAttributesForm() );
317 }
318
319 my $captcha = random_string("CCCCC");
320
321 $template->param(
322     captcha        => $captcha,
323     captcha_digest => md5_base64($captcha)
324 );
325
326 output_html_with_http_headers $cgi, $cookie, $template->output, undef, { force_no_caching => 1 };
327
328 sub GetHiddenFields {
329     my ( $mandatory, $action ) = @_;
330     my %hidden_fields;
331
332     my $BorrowerUnwantedField = $action eq 'edit' || $action eq 'update' ?
333       C4::Context->preference( "PatronSelfModificationBorrowerUnwantedField" ) :
334       C4::Context->preference( "PatronSelfRegistrationBorrowerUnwantedField" );
335
336     my @fields = split( /\|/, $BorrowerUnwantedField || q|| );
337     foreach (@fields) {
338         next unless m/\w/o;
339         #Don't hide mandatory fields
340         next if $mandatory->{$_};
341         $hidden_fields{$_} = 1;
342     }
343
344     return \%hidden_fields;
345 }
346
347 sub GetMandatoryFields {
348     my ($action) = @_;
349
350     my %mandatory_fields;
351
352     my $BorrowerMandatoryField =
353       C4::Context->preference("PatronSelfRegistrationBorrowerMandatoryField");
354
355     my @fields = split( /\|/, $BorrowerMandatoryField );
356
357     foreach (@fields) {
358         $mandatory_fields{$_} = 1;
359     }
360
361     if ( $action eq 'create' || $action eq 'new' ) {
362         $mandatory_fields{'email'} = 1
363           if C4::Context->boolean_preference(
364             'PatronSelfRegistrationVerifyByEmail');
365     }
366
367     return \%mandatory_fields;
368 }
369
370 sub CheckMandatoryFields {
371     my ( $borrower, $action ) = @_;
372
373     my @empty_mandatory_fields;
374
375     my $mandatory_fields = GetMandatoryFields($action);
376     delete $mandatory_fields->{'cardnumber'};
377
378     foreach my $key ( keys %$mandatory_fields ) {
379         push( @empty_mandatory_fields, $key )
380           unless ( defined( $borrower->{$key} ) && $borrower->{$key} );
381     }
382
383     return @empty_mandatory_fields;
384 }
385
386 sub CheckForInvalidFields {
387     my $borrower = shift;
388     my @invalidFields;
389     if ($borrower->{'email'}) {
390         unless ( Email::Valid->address($borrower->{'email'}) ) {
391             push(@invalidFields, "email");
392         } elsif ( C4::Context->preference("PatronSelfRegistrationEmailMustBeUnique") ) {
393             my $patrons_with_same_email = Koha::Patrons->search( # FIXME Should be search_limited?
394                 {
395                     email => $borrower->{email},
396                     (
397                         exists $borrower->{borrowernumber}
398                         ? ( borrowernumber =>
399                               { '!=' => $borrower->{borrowernumber} } )
400                         : ()
401                     )
402                 }
403             )->count;
404             if ( $patrons_with_same_email ) {
405                 push @invalidFields, "duplicate_email";
406             }
407         }
408     }
409     if ($borrower->{'emailpro'}) {
410         push(@invalidFields, "emailpro") if (!Email::Valid->address($borrower->{'emailpro'}));
411     }
412     if ($borrower->{'B_email'}) {
413         push(@invalidFields, "B_email") if (!Email::Valid->address($borrower->{'B_email'}));
414     }
415     if ( defined $borrower->{'password'}
416         and $borrower->{'password'} ne $borrower->{'password2'} )
417     {
418         push( @invalidFields, "password_match" );
419     }
420     if ( $borrower->{'password'} ) {
421         my ( $is_valid, $error ) = Koha::AuthUtils::is_password_valid( $borrower->{password} );
422           unless ( $is_valid ) {
423               push @invalidFields, 'password_too_short' if $error eq 'too_short';
424               push @invalidFields, 'password_too_weak' if $error eq 'too_weak';
425               push @invalidFields, 'password_has_whitespaces' if $error eq 'has_whitespaces';
426           }
427     }
428
429     return \@invalidFields;
430 }
431
432 sub ParseCgiForBorrower {
433     my ($cgi) = @_;
434
435     my $scrubber = C4::Scrubber->new();
436     my %borrower;
437
438     foreach my $field ( $cgi->param ) {
439         if ( $field =~ '^borrower_' ) {
440             my ($key) = substr( $field, 9 );
441             if ( $field !~ '^borrower_password' ) {
442                 $borrower{$key} = $scrubber->scrub( scalar $cgi->param($field) );
443             } else {
444                 # Allow html characters for passwords
445                 $borrower{$key} = $cgi->param($field);
446             }
447         }
448     }
449
450     my $dob_dt;
451     $dob_dt = eval { dt_from_string( $borrower{'dateofbirth'} ); }
452         if ( $borrower{'dateofbirth'} );
453
454     if ( $dob_dt ) {
455         $borrower{'dateofbirth'} = output_pref ( { dt => $dob_dt, dateonly => 1, dateformat => 'iso' } );
456     }
457     else {
458         # Trigger validation
459         $borrower{'dateofbirth'} = undef;
460     }
461
462     return %borrower;
463 }
464
465 sub DelUnchangedFields {
466     my ( $borrowernumber, %new_data ) = @_;
467
468     my $patron = Koha::Patrons->find( $borrowernumber );
469     my $current_data = $patron->unblessed;
470
471     foreach my $key ( keys %new_data ) {
472         if ( $current_data->{$key} eq $new_data{$key} ) {
473             delete $new_data{$key};
474         }
475     }
476
477     return %new_data;
478 }
479
480 sub DelEmptyFields {
481     my (%borrower) = @_;
482
483     foreach my $key ( keys %borrower ) {
484         delete $borrower{$key} unless $borrower{$key};
485     }
486
487     return %borrower;
488 }
489
490 sub FilterUnchangedAttributes {
491     my ( $borrowernumber, $entered_attributes ) = @_;
492
493     my @patron_attributes = grep {$_->opac_editable} Koha::Patron::Attributes->search({ borrowernumber => $borrowernumber })->as_list;
494
495     my $patron_attribute_types;
496     foreach my $attr (@patron_attributes) {
497         $patron_attribute_types->{ $attr->code } += 1;
498     }
499
500     my $passed_attribute_types;
501     foreach my $attr (@{ $entered_attributes }) {
502         $passed_attribute_types->{ $attr->{ code } } += 1;
503     }
504
505     my @changed_attributes;
506
507     # Loop through the current patron attributes
508     foreach my $attribute_type ( keys %{ $patron_attribute_types } ) {
509         if ( $patron_attribute_types->{ $attribute_type } !=  $passed_attribute_types->{ $attribute_type } ) {
510             # count differs, overwrite all attributes for given type
511             foreach my $attr (@{ $entered_attributes }) {
512                 push @changed_attributes, $attr
513                     if $attr->{ code } eq $attribute_type;
514             }
515         } else {
516             # count matches, check values
517             my $changes = 0;
518             foreach my $attr (grep { $_->code eq $attribute_type } @patron_attributes) {
519                 $changes = 1
520                     unless any { $_->{ value } eq $attr->attribute } @{ $entered_attributes };
521                 last if $changes;
522             }
523
524             if ( $changes ) {
525                 foreach my $attr (@{ $entered_attributes }) {
526                     push @changed_attributes, $attr
527                         if $attr->{ code } eq $attribute_type;
528                 }
529             }
530         }
531     }
532
533     # Loop through passed attributes, looking for new ones
534     foreach my $attribute_type ( keys %{ $passed_attribute_types } ) {
535         if ( !defined $patron_attribute_types->{ $attribute_type } ) {
536             # YAY, new stuff
537             foreach my $attr (grep { $_->{code} eq $attribute_type } @{ $entered_attributes }) {
538                 push @changed_attributes, $attr;
539             }
540         }
541     }
542
543     return \@changed_attributes;
544 }
545
546 sub GeneratePatronAttributesForm {
547     my ( $borrowernumber, $entered_attributes ) = @_;
548
549     # Get all attribute types and the values for this patron (if applicable)
550     my @types = grep { $_->opac_editable() or $_->opac_display }
551         Koha::Patron::Attribute::Types->search()->as_list();
552     if ( scalar(@types) == 0 ) {
553         return [];
554     }
555
556     my @displayable_attributes = grep { $_->opac_display }
557         Koha::Patron::Attributes->search({ borrowernumber => $borrowernumber })->as_list;
558
559     my %attr_values = ();
560
561     # Build the attribute values list either from the passed values
562     # or taken from the patron itself
563     if ( defined $entered_attributes ) {
564         foreach my $attr (@$entered_attributes) {
565             push @{ $attr_values{ $attr->{code} } }, $attr->{value};
566         }
567     }
568     elsif ( defined $borrowernumber ) {
569         my @editable_attributes = grep { $_->opac_editable } @displayable_attributes;
570         foreach my $attr (@editable_attributes) {
571             push @{ $attr_values{ $attr->code } }, $attr->attribute;
572         }
573     }
574
575     # Add the non-editable attributes (that don't come from the form)
576     foreach my $attr ( grep { !$_->opac_editable } @displayable_attributes ) {
577         push @{ $attr_values{ $attr->code } }, $attr->attribute;
578     }
579
580     # Find all existing classes
581     my @classes = sort( uniq( map { $_->class } @types ) );
582     my %items_by_class;
583
584     foreach my $attr_type (@types) {
585         push @{ $items_by_class{ $attr_type->class() } }, {
586             type => $attr_type,
587             # If editable, make sure there's at least one empty entry,
588             # to make the template's job easier
589             values => $attr_values{ $attr_type->code() } || ['']
590         }
591             unless !defined $attr_values{ $attr_type->code() }
592                     and !$attr_type->opac_editable;
593     }
594
595     # Finally, build a list of containing classes
596     my @class_loop;
597     foreach my $class (@classes) {
598         next unless ( $items_by_class{$class} );
599
600         my $av = Koha::AuthorisedValues->search(
601             { category => 'PA_CLASS', authorised_value => $class } );
602
603         my $lib = $av->count ? $av->next->opac_description : $class;
604
605         push @class_loop,
606             {
607             class => $class,
608             items => $items_by_class{$class},
609             lib   => $lib,
610             };
611     }
612
613     return \@class_loop;
614 }
615
616 sub ParsePatronAttributes {
617     my ( $borrowernumber, $cgi ) = @_;
618
619     my @codes  = $cgi->multi_param('patron_attribute_code');
620     my @values = $cgi->multi_param('patron_attribute_value');
621
622     my @editable_attribute_types
623         = map { $_->code } Koha::Patron::Attribute::Types->search({ opac_editable => 1 });
624
625     my $ea = each_array( @codes, @values );
626     my @attributes;
627
628     my $delete_candidates = {};
629
630     while ( my ( $code, $value ) = $ea->() ) {
631         if ( any { $_ eq $code } @editable_attribute_types ) {
632             # It is an editable attribute
633             if ( !defined($value) or $value eq '' ) {
634                 $delete_candidates->{$code} = 1
635                     unless $delete_candidates->{$code};
636             }
637             else {
638                 # we've got a value
639                 push @attributes, { code => $code, value => $value };
640
641                 # 'code' is no longer a delete candidate
642                 delete $delete_candidates->{$code}
643                     if defined $delete_candidates->{$code};
644             }
645         }
646     }
647
648     foreach my $code ( keys %{$delete_candidates} ) {
649         if ( Koha::Patron::Attributes->search({
650                 borrowernumber => $borrowernumber, code => $code })->count > 0 )
651         {
652             push @attributes, { code => $code, value => '' }
653                 unless any { $_->{code} eq $code } @attributes;
654         }
655     }
656
657     return \@attributes;
658 }
659
660
661 1;