3 # This file is part of Koha.
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.
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.
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>.
21 use Digest::MD5 qw( md5_base64 md5_hex );
23 use List::MoreUtils qw( any each_array uniq );
24 use String::Random qw( random_string );
30 use C4::Form::MessagingPreferences;
33 use Koha::Patron::Consent;
34 use Koha::Patron::Modification;
35 use Koha::Patron::Modifications;
40 use Koha::Patron::Attribute::Types;
41 use Koha::Patron::Attributes;
42 use Koha::Patron::Images;
43 use Koha::Patron::Modification;
44 use Koha::Patron::Modifications;
45 use Koha::Patron::Categories;
49 my $dbh = C4::Context->dbh;
51 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
53 template_name => "opac-memberentry.tt",
60 unless ( C4::Context->preference('PatronSelfRegistration') || $borrowernumber )
62 print $cgi->redirect("/cgi-bin/koha/opac-main.pl");
66 my $action = $cgi->param('action') || q{};
67 if ( $action eq q{} ) {
68 if ($borrowernumber) {
76 my $mandatory = GetMandatoryFields($action);
78 my @libraries = Koha::Libraries->search;
79 if ( $action eq 'create' || $action eq 'new' ) {
80 my @PatronSelfRegistrationLibraryList = split '\|', C4::Context->preference('PatronSelfRegistrationLibraryList');
81 if (@PatronSelfRegistrationLibraryList) {
84 ( grep { $l->branchcode eq $_ } @PatronSelfRegistrationLibraryList )
91 my ( $min, $max ) = C4::Members::get_cardnumber_length();
94 minlength_cardnumber => $min,
95 maxlength_cardnumber => $max
99 my $defaultCategory = Koha::Patron::Categories->find(C4::Context->preference('PatronSelfRegistrationDefaultCategory'));
103 hidden => GetHiddenFields( $mandatory, $action ),
104 mandatory => $mandatory,
105 libraries => \@libraries,
106 OPACPatronDetails => C4::Context->preference('OPACPatronDetails'),
107 defaultCategory => $defaultCategory,
110 my $attributes = ParsePatronAttributes($borrowernumber,$cgi);
111 my $conflicting_attribute = 0;
113 foreach my $attr (@$attributes) {
114 my $attribute = Koha::Patron::Attribute->new($attr);
115 eval {$attribute->check_unique_id};
117 my $attr_type = Koha::Patron::Attribute::Types->find($attr->{code});
119 extended_unique_id_failed_code => $attr->{code},
120 extended_unique_id_failed_value => $attr->{attribute},
121 extended_unique_id_failed_description => $attr_type->description,
123 $conflicting_attribute = 1;
127 if ( $action eq 'create' ) {
129 my %borrower = ParseCgiForBorrower($cgi);
131 %borrower = DelEmptyFields(%borrower);
133 my @empty_mandatory_fields = (CheckMandatoryFields( \%borrower, $action ), CheckMandatoryAttributes( \%borrower, $attributes ) );
134 my $invalidformfields = CheckForInvalidFields(\%borrower);
135 delete $borrower{'password2'};
136 my $cardnumber_error_code;
137 if ( !grep { $_ eq 'cardnumber' } @empty_mandatory_fields ) {
138 # No point in checking the cardnumber if it's missing and mandatory, it'll just generate a
139 # spurious length warning.
140 $cardnumber_error_code = checkcardnumber( $borrower{cardnumber}, $borrower{borrowernumber} );
143 if ( @empty_mandatory_fields || @$invalidformfields || $cardnumber_error_code || $conflicting_attribute ) {
144 if ( $cardnumber_error_code == 1 ) {
145 $template->param( cardnumber_already_exists => 1 );
146 } elsif ( $cardnumber_error_code == 2 ) {
147 $template->param( cardnumber_wrong_length => 1 );
151 empty_mandatory_fields => \@empty_mandatory_fields,
152 invalid_form_fields => $invalidformfields,
153 borrower => \%borrower
155 $template->param( patron_attribute_classes => GeneratePatronAttributesForm( undef, $attributes ) );
158 md5_base64( uc( $cgi->param('captcha') ) ) ne $cgi->param('captcha_digest') )
162 borrower => \%borrower
164 $template->param( patron_attribute_classes => GeneratePatronAttributesForm( undef, $attributes ) );
165 } elsif ( ! grep { $borrower{branchcode} eq $_->branchcode } @libraries ) {
166 die "Branchcode not allowed"; # They hack the form
170 C4::Context->boolean_preference(
171 'PatronSelfRegistrationVerifyByEmail')
174 ( $template, $borrowernumber, $cookie ) = get_template_and_user(
176 template_name => "opac-registration-email-sent.tt",
179 authnotrequired => 1,
182 $template->param( 'email' => $borrower{'email'} );
184 my $verification_token = md5_hex( time().{}.rand().{}.$$ );
185 while ( Koha::Patron::Modifications->search( { verification_token => $verification_token } )->count() ) {
186 $verification_token = md5_hex( time().{}.rand().{}.$$ );
189 $borrower{password} = Koha::AuthUtils::generate_password(Koha::Patron::Categories->find($borrower{categorycode})) unless $borrower{password};
190 $borrower{verification_token} = $verification_token;
192 Koha::Patron::Modification->new( \%borrower )->store();
194 #Send verification email
195 my $letter = C4::Letters::GetPreparedLetter(
197 letter_code => 'OPAC_REG_VERIFY',
198 lang => 'default', # Patron does not have a preferred language defined yet
200 borrower_modifications => $verification_token,
204 C4::Letters::EnqueueLetter(
207 message_transport_type => 'email',
208 to_address => $borrower{'email'},
210 C4::Context->preference('KohaAdminEmailAddress'),
213 my $num_letters_attempted = C4::Letters::SendQueuedMessages( {
214 letter_code => 'OPAC_REG_VERIFY'
218 ( $template, $borrowernumber, $cookie ) = get_template_and_user(
220 template_name => "opac-registration-confirmation.tt",
223 authnotrequired => 1,
227 $borrower{categorycode} ||= C4::Context->preference('PatronSelfRegistrationDefaultCategory');
228 $borrower{password} ||= Koha::AuthUtils::generate_password(Koha::Patron::Categories->find($borrower{categorycode}));
229 my $consent_dt = delete $borrower{gdpr_proc_consent};
230 my $patron = Koha::Patron->new( \%borrower )->store;
231 Koha::Patron::Consent->new({ borrowernumber => $patron->borrowernumber, type => 'GDPR_PROCESSING', given_on => $consent_dt })->store if $consent_dt;
233 $patron->extended_attributes->filter_by_branch_limitations->delete;
234 $patron->extended_attributes($attributes);
235 if ( C4::Context->preference('EnhancedMessagingPreferences') ) {
236 C4::Form::MessagingPreferences::handle_form_action(
238 { borrowernumber => $patron->borrowernumber },
241 C4::Context->preference('PatronSelfRegistrationDefaultCategory')
245 $template->param( password_cleartext => $patron->plain_text_password );
246 $template->param( borrower => $patron->unblessed );
248 # FIXME Handle possible errors here
251 PatronSelfRegistrationAdditionalInstructions =>
252 C4::Context->preference(
253 'PatronSelfRegistrationAdditionalInstructions')
258 elsif ( $action eq 'update' ) {
260 my $borrower = Koha::Patrons->find( $borrowernumber )->unblessed;
261 die "Wrong CSRF token"
262 unless Koha::Token->new->check_csrf({
263 session_id => scalar $cgi->cookie('CGISESSID'),
264 token => scalar $cgi->param('csrf_token'),
267 my %borrower = ParseCgiForBorrower($cgi);
268 $borrower{borrowernumber} = $borrowernumber;
270 my @empty_mandatory_fields = grep { $_ ne 'password' } # password is not required when editing personal details
271 ( CheckMandatoryFields( \%borrower, $action ), CheckMandatoryAttributes( \%borrower, $attributes ) );
272 my $invalidformfields = CheckForInvalidFields(\%borrower);
274 # Send back the data to the template
275 %borrower = ( %$borrower, %borrower );
277 if (@empty_mandatory_fields || @$invalidformfields) {
279 empty_mandatory_fields => \@empty_mandatory_fields,
280 invalid_form_fields => $invalidformfields,
281 borrower => \%borrower,
282 csrf_token => Koha::Token->new->generate_csrf({
283 session_id => scalar $cgi->cookie('CGISESSID'),
286 $template->param( patron_attribute_classes => GeneratePatronAttributesForm( $borrowernumber, $attributes ) );
288 $template->param( action => 'edit' );
291 my %borrower_changes = DelUnchangedFields( $borrowernumber, %borrower );
292 $borrower_changes{'changed_fields'} = join ',', keys %borrower_changes;
293 my $extended_attributes_changes = FilterUnchangedAttributes( $borrowernumber, $attributes );
295 if ( %borrower_changes || scalar @{$extended_attributes_changes} > 0 ) {
296 ( $template, $borrowernumber, $cookie ) = get_template_and_user(
298 template_name => "opac-memberentry-update-submitted.tt",
301 authnotrequired => 1,
305 $borrower_changes{borrowernumber} = $borrowernumber;
306 $borrower_changes{extended_attributes} = to_json($extended_attributes_changes);
308 Koha::Patron::Modifications->search({ borrowernumber => $borrowernumber })->delete;
310 my $m = Koha::Patron::Modification->new( \%borrower_changes )->store();
311 #Automatically approve patron profile changes if set in syspref
313 if (C4::Context->preference('AutoApprovePatronProfileSettings')) {
314 # Need to get the object from database, otherwise it is not complete enough to allow deletion
315 # when approval has been performed.
316 my $tmp_m = Koha::Patron::Modifications->find({borrowernumber => $borrowernumber});
317 $tmp_m->approve() if $tmp_m;
320 my $patron = Koha::Patrons->find( $borrowernumber );
321 $template->param( borrower => $patron->unblessed );
324 my $patron = Koha::Patrons->find( $borrowernumber );
328 borrower => $patron->unblessed,
329 patron_attribute_classes => GeneratePatronAttributesForm( $borrowernumber, $attributes ),
330 csrf_token => Koha::Token->new->generate_csrf({
331 session_id => scalar $cgi->cookie('CGISESSID'),
337 elsif ( $action eq 'edit' ) { #Display logged in borrower's data
338 my $patron = Koha::Patrons->find( $borrowernumber );
339 my $borrower = $patron->unblessed;
342 borrower => $borrower,
343 hidden => GetHiddenFields( $mandatory, 'edit' ),
344 csrf_token => Koha::Token->new->generate_csrf({
345 session_id => scalar $cgi->cookie('CGISESSID'),
349 if (C4::Context->preference('OPACpatronimages')) {
350 $template->param( display_patron_image => 1 ) if $patron->image;
353 $template->param( patron_attribute_classes => GeneratePatronAttributesForm( $borrowernumber ) );
355 # Render self-registration page
356 $template->param( patron_attribute_classes => GeneratePatronAttributesForm() );
359 my $captcha = random_string("CCCCC");
360 my $patron_param = Koha::Patrons->find( $borrowernumber );
362 has_guarantor_flag => $patron_param->guarantor_relationships->guarantors->_resultset->count
367 captcha_digest => md5_base64($captcha),
368 patron => $patron_param
371 output_html_with_http_headers $cgi, $cookie, $template->output, undef, { force_no_caching => 1 };
373 sub GetHiddenFields {
374 my ( $mandatory, $action ) = @_;
377 my $BorrowerUnwantedField = $action eq 'edit' || $action eq 'update' ?
378 C4::Context->preference( "PatronSelfModificationBorrowerUnwantedField" ) :
379 C4::Context->preference( "PatronSelfRegistrationBorrowerUnwantedField" );
381 my @fields = split( /\|/, $BorrowerUnwantedField || q|| );
384 #Don't hide mandatory fields
385 next if $mandatory->{$_};
386 $hidden_fields{$_} = 1;
389 return \%hidden_fields;
392 sub GetMandatoryFields {
395 my %mandatory_fields;
397 my $BorrowerMandatoryField =
398 C4::Context->preference("PatronSelfRegistrationBorrowerMandatoryField");
400 my @fields = split( /\|/, $BorrowerMandatoryField );
401 push @fields, 'gdpr_proc_consent' if C4::Context->preference('GDPR_Policy') && $action eq 'create';
404 $mandatory_fields{$_} = 1;
407 if ( $action eq 'create' || $action eq 'new' ) {
408 $mandatory_fields{'email'} = 1
409 if C4::Context->boolean_preference(
410 'PatronSelfRegistrationVerifyByEmail');
413 return \%mandatory_fields;
416 sub CheckMandatoryFields {
417 my ( $borrower, $action ) = @_;
419 my @empty_mandatory_fields;
421 my $mandatory_fields = GetMandatoryFields($action);
422 delete $mandatory_fields->{'cardnumber'};
424 foreach my $key ( keys %$mandatory_fields ) {
425 push( @empty_mandatory_fields, $key )
426 unless ( defined( $borrower->{$key} ) && $borrower->{$key} );
429 return @empty_mandatory_fields;
432 sub CheckMandatoryAttributes{
433 my ( $borrower, $attributes ) = @_;
435 my @empty_mandatory_fields;
437 for my $attribute (@$attributes ) {
438 my $attr = Koha::Patron::Attribute::Types->find($attribute->{code});
439 push @empty_mandatory_fields, $attribute->{code}
440 if $attr && $attr->mandatory && $attribute->{attribute} =~ m|^\s*$|;
443 return @empty_mandatory_fields;
446 sub CheckForInvalidFields {
447 my $borrower = shift;
449 if ($borrower->{'email'}) {
450 unless ( Email::Valid->address($borrower->{'email'}) ) {
451 push(@invalidFields, "email");
452 } elsif ( C4::Context->preference("PatronSelfRegistrationEmailMustBeUnique") ) {
453 my $patrons_with_same_email = Koha::Patrons->search( # FIXME Should be search_limited?
455 email => $borrower->{email},
457 exists $borrower->{borrowernumber}
458 ? ( borrowernumber =>
459 { '!=' => $borrower->{borrowernumber} } )
464 if ( $patrons_with_same_email ) {
465 push @invalidFields, "duplicate_email";
467 } elsif ( C4::Context->preference("PatronSelfRegistrationConfirmEmail")
468 && $borrower->{'email'} ne $borrower->{'repeat_email'}
469 && !defined $borrower->{borrowernumber} ) {
470 push @invalidFields, "email_match";
472 # email passed all tests, so prevent attempting to store repeat_email
473 delete $borrower->{'repeat_email'};
475 if ($borrower->{'emailpro'}) {
476 push(@invalidFields, "emailpro") if (!Email::Valid->address($borrower->{'emailpro'}));
478 if ($borrower->{'B_email'}) {
479 push(@invalidFields, "B_email") if (!Email::Valid->address($borrower->{'B_email'}));
481 if ( defined $borrower->{'password'}
482 and $borrower->{'password'} ne $borrower->{'password2'} )
484 push( @invalidFields, "password_match" );
486 if ( $borrower->{'password'} ) {
487 my ( $is_valid, $error ) = Koha::AuthUtils::is_password_valid( $borrower->{password}, Koha::Patron::Categories->find($borrower->{categorycode}||C4::Context->preference('PatronSelfRegistrationDefaultCategory')) );
488 unless ( $is_valid ) {
489 push @invalidFields, 'password_too_short' if $error eq 'too_short';
490 push @invalidFields, 'password_too_weak' if $error eq 'too_weak';
491 push @invalidFields, 'password_has_whitespaces' if $error eq 'has_whitespaces';
495 return \@invalidFields;
498 sub ParseCgiForBorrower {
501 my $scrubber = C4::Scrubber->new();
504 foreach my $field ( $cgi->param ) {
505 if ( $field =~ '^borrower_' ) {
506 my ($key) = substr( $field, 9 );
507 if ( $field !~ '^borrower_password' ) {
508 $borrower{$key} = $scrubber->scrub( scalar $cgi->param($field) );
510 # Allow html characters for passwords
511 $borrower{$key} = $cgi->param($field);
516 if ( defined $borrower{'dateofbirth'} ) {
518 $dob_dt = eval { dt_from_string( $borrower{'dateofbirth'} ); }
519 if ( $borrower{'dateofbirth'} );
522 $borrower{'dateofbirth'} = output_pref( { dt => $dob_dt, dateonly => 1, dateformat => 'iso' } );
526 $borrower{'dateofbirth'} = undef;
530 # Replace checkbox 'agreed' by datetime in gdpr_proc_consent
531 $borrower{gdpr_proc_consent} = dt_from_string if $borrower{gdpr_proc_consent} && $borrower{gdpr_proc_consent} eq 'agreed';
536 sub DelUnchangedFields {
537 my ( $borrowernumber, %new_data ) = @_;
538 # get the mandatory fields so we can get the hidden fields
539 my $mandatory = GetMandatoryFields('edit');
540 my $patron = Koha::Patrons->find( $borrowernumber );
541 my $current_data = $patron->unblessed;
542 # get the hidden fields so we don't obliterate them should they have data patrons aren't allowed to modify
543 my $hidden_fields = GetHiddenFields($mandatory, 'edit');
546 foreach my $key ( keys %new_data ) {
547 next if defined($new_data{$key}) xor defined($current_data->{$key});
548 if ( !defined($new_data{$key}) || $current_data->{$key} eq $new_data{$key} || $hidden_fields->{$key} ) {
549 delete $new_data{$key};
559 foreach my $key ( keys %borrower ) {
560 delete $borrower{$key} unless $borrower{$key};
566 sub FilterUnchangedAttributes {
567 my ( $borrowernumber, $entered_attributes ) = @_;
569 my @patron_attributes = grep {$_->type->opac_editable ? $_ : ()} Koha::Patron::Attributes->search({ borrowernumber => $borrowernumber })->as_list;
571 my $patron_attribute_types;
572 foreach my $attr (@patron_attributes) {
573 $patron_attribute_types->{ $attr->code } += 1;
576 my $passed_attribute_types;
577 foreach my $attr (@{ $entered_attributes }) {
578 $passed_attribute_types->{ $attr->{ code } } += 1;
581 my @changed_attributes;
583 # Loop through the current patron attributes
584 foreach my $attribute_type ( keys %{ $patron_attribute_types } ) {
585 if ( $patron_attribute_types->{ $attribute_type } != $passed_attribute_types->{ $attribute_type } ) {
586 # count differs, overwrite all attributes for given type
587 foreach my $attr (@{ $entered_attributes }) {
588 push @changed_attributes, $attr
589 if $attr->{ code } eq $attribute_type;
592 # count matches, check values
594 foreach my $attr (grep { $_->code eq $attribute_type } @patron_attributes) {
596 unless any { $_->{ value } eq $attr->attribute } @{ $entered_attributes };
601 foreach my $attr (@{ $entered_attributes }) {
602 push @changed_attributes, $attr
603 if $attr->{ code } eq $attribute_type;
609 # Loop through passed attributes, looking for new ones
610 foreach my $attribute_type ( keys %{ $passed_attribute_types } ) {
611 if ( !defined $patron_attribute_types->{ $attribute_type } ) {
613 foreach my $attr (grep { $_->{code} eq $attribute_type } @{ $entered_attributes }) {
614 push @changed_attributes, $attr;
619 return \@changed_attributes;
622 sub GeneratePatronAttributesForm {
623 my ( $borrowernumber, $entered_attributes ) = @_;
625 # Get all attribute types and the values for this patron (if applicable)
626 my @types = grep { $_->opac_editable() or $_->opac_display }
627 Koha::Patron::Attribute::Types->search()->as_list();
628 if ( scalar(@types) == 0 ) {
632 my @displayable_attributes = grep { $_->type->opac_display ? $_ : () }
633 Koha::Patron::Attributes->search({ borrowernumber => $borrowernumber })->as_list;
635 my %attr_values = ();
637 # Build the attribute values list either from the passed values
638 # or taken from the patron itself
639 if ( defined $entered_attributes ) {
640 foreach my $attr (@$entered_attributes) {
641 push @{ $attr_values{ $attr->{code} } }, $attr->{value};
644 elsif ( defined $borrowernumber ) {
645 my @editable_attributes = grep { $_->type->opac_editable ? $_ : () } @displayable_attributes;
646 foreach my $attr (@editable_attributes) {
647 push @{ $attr_values{ $attr->code } }, $attr->attribute;
651 # Add the non-editable attributes (that don't come from the form)
652 foreach my $attr ( grep { !$_->type->opac_editable } @displayable_attributes ) {
653 push @{ $attr_values{ $attr->code } }, $attr->attribute;
656 # Find all existing classes
657 my @classes = sort( uniq( map { $_->class } @types ) );
660 foreach my $attr_type (@types) {
661 push @{ $items_by_class{ $attr_type->class() } }, {
663 # If editable, make sure there's at least one empty entry,
664 # to make the template's job easier
665 values => $attr_values{ $attr_type->code() } || ['']
667 unless !defined $attr_values{ $attr_type->code() }
668 and !$attr_type->opac_editable;
671 # Finally, build a list of containing classes
673 foreach my $class (@classes) {
674 next unless ( $items_by_class{$class} );
676 my $av = Koha::AuthorisedValues->search(
677 { category => 'PA_CLASS', authorised_value => $class } );
679 my $lib = $av->count ? $av->next->opac_description : $class;
684 items => $items_by_class{$class},
692 sub ParsePatronAttributes {
693 my ( $borrowernumber, $cgi ) = @_;
695 my @codes = $cgi->multi_param('patron_attribute_code');
696 my @values = $cgi->multi_param('patron_attribute_value');
698 my @editable_attribute_types
699 = map { $_->code } Koha::Patron::Attribute::Types->search({ opac_editable => 1 });
701 my $ea = each_array( @codes, @values );
704 my $delete_candidates = {};
706 while ( my ( $code, $value ) = $ea->() ) {
707 if ( any { $_ eq $code } @editable_attribute_types ) {
708 # It is an editable attribute
709 if ( !defined($value) or $value eq '' ) {
710 $delete_candidates->{$code} = 1
711 unless $delete_candidates->{$code};
715 push @attributes, { code => $code, attribute => $value };
717 # 'code' is no longer a delete candidate
718 delete $delete_candidates->{$code}
719 if defined $delete_candidates->{$code};
724 foreach my $code ( keys %{$delete_candidates} ) {
725 if ( not $borrowernumber # self-registration
726 || Koha::Patron::Attributes->search({
727 borrowernumber => $borrowernumber, code => $code })->count > 0 )
729 push @attributes, { code => $code, attribute => '' }
730 unless any { $_->{code} eq $code } @attributes;