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 );
29 use C4
::Members
::Attributes
qw( GetBorrowerAttributes );
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
;
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 ( my @libraries_to_display = split '\|', C4
::Context
->preference('PatronSelfRegistrationLibraryList') ) {
80 @libraries = map { my $b = $_; my $branchcode = $_->branchcode; grep( /^$branchcode$/, @libraries_to_display ) ?
$b : () } @libraries;
82 my ( $min, $max ) = C4
::Members
::get_cardnumber_length
();
85 minlength_cardnumber
=> $min,
86 maxlength_cardnumber
=> $max
92 hidden
=> GetHiddenFields
( $mandatory, $action ),
93 mandatory
=> $mandatory,
94 libraries
=> \
@libraries,
95 OPACPatronDetails
=> C4
::Context
->preference('OPACPatronDetails'),
98 my $attributes = ParsePatronAttributes
($borrowernumber,$cgi);
99 my $conflicting_attribute = 0;
101 foreach my $attr (@
$attributes) {
102 unless ( C4
::Members
::Attributes
::CheckUniqueness
($attr->{code
}, $attr->{value
}, $borrowernumber) ) {
103 my $attr_info = C4
::Members
::AttributeTypes
->fetch($attr->{code
});
105 extended_unique_id_failed_code
=> $attr->{code
},
106 extended_unique_id_failed_value
=> $attr->{value
},
107 extended_unique_id_failed_description
=> $attr_info->description()
109 $conflicting_attribute = 1;
113 if ( $action eq 'create' ) {
115 my %borrower = ParseCgiForBorrower
($cgi);
117 %borrower = DelEmptyFields
(%borrower);
119 my @empty_mandatory_fields = CheckMandatoryFields
( \
%borrower, $action );
120 my $invalidformfields = CheckForInvalidFields
(\
%borrower);
121 delete $borrower{'password2'};
122 my $cardnumber_error_code;
123 if ( !grep { $_ eq 'cardnumber' } @empty_mandatory_fields ) {
124 # No point in checking the cardnumber if it's missing and mandatory, it'll just generate a
125 # spurious length warning.
126 $cardnumber_error_code = checkcardnumber
( $borrower{cardnumber
}, $borrower{borrowernumber
} );
129 if ( @empty_mandatory_fields || @
$invalidformfields || $cardnumber_error_code || $conflicting_attribute ) {
130 if ( $cardnumber_error_code == 1 ) {
131 $template->param( cardnumber_already_exists
=> 1 );
132 } elsif ( $cardnumber_error_code == 2 ) {
133 $template->param( cardnumber_wrong_length
=> 1 );
137 empty_mandatory_fields
=> \
@empty_mandatory_fields,
138 invalid_form_fields
=> $invalidformfields,
139 borrower
=> \
%borrower
141 $template->param( patron_attribute_classes
=> GeneratePatronAttributesForm
( undef, $attributes ) );
144 md5_base64
( uc( $cgi->param('captcha') ) ) ne $cgi->param('captcha_digest') )
148 borrower
=> \
%borrower
150 $template->param( patron_attribute_classes
=> GeneratePatronAttributesForm
( undef, $attributes ) );
154 C4
::Context
->boolean_preference(
155 'PatronSelfRegistrationVerifyByEmail')
158 ( $template, $borrowernumber, $cookie ) = get_template_and_user
(
160 template_name
=> "opac-registration-email-sent.tt",
163 authnotrequired
=> 1,
166 $template->param( 'email' => $borrower{'email'} );
168 my $verification_token = md5_hex
( time().{}.rand().{}.$$ );
169 while ( Koha
::Patron
::Modifications
->search( { verification_token
=> $verification_token } )->count() ) {
170 $verification_token = md5_hex
( time().{}.rand().{}.$$ );
173 $borrower{password
} = Koha
::AuthUtils
::generate_password
unless $borrower{password
};
174 $borrower{verification_token
} = $verification_token;
176 Koha
::Patron
::Modification
->new( \
%borrower )->store();
178 #Send verification email
179 my $letter = C4
::Letters
::GetPreparedLetter
(
181 letter_code
=> 'OPAC_REG_VERIFY',
182 lang
=> 'default', # Patron does not have a preferred language defined yet
184 borrower_modifications
=> $verification_token,
188 C4
::Letters
::EnqueueLetter
(
191 message_transport_type
=> 'email',
192 to_address
=> $borrower{'email'},
194 C4
::Context
->preference('KohaAdminEmailAddress'),
199 ( $template, $borrowernumber, $cookie ) = get_template_and_user
(
201 template_name
=> "opac-registration-confirmation.tt",
204 authnotrequired
=> 1,
208 $borrower{categorycode
} ||= C4
::Context
->preference('PatronSelfRegistrationDefaultCategory');
209 $borrower{password
} ||= Koha
::AuthUtils
::generate_password
;
210 my $consent_dt = delete $borrower{gdpr_proc_consent
};
211 my $patron = Koha
::Patron
->new( \
%borrower )->store;
212 Koha
::Patron
::Consent
->new({ borrowernumber
=> $patron->borrowernumber, type
=> 'GDPR_PROCESSING', given_on
=> $consent_dt })->store if $consent_dt;
214 C4
::Members
::Attributes
::SetBorrowerAttributes
( $patron->borrowernumber, $attributes );
215 if ( C4
::Context
->preference('EnhancedMessagingPreferences') ) {
216 C4
::Form
::MessagingPreferences
::handle_form_action
(
218 { borrowernumber
=> $patron->borrowernumber },
221 C4
::Context
->preference('PatronSelfRegistrationDefaultCategory')
225 $template->param( password_cleartext
=> $patron->plain_text_password );
226 $template->param( borrower
=> $patron->unblessed );
228 # FIXME Handle possible errors here
231 PatronSelfRegistrationAdditionalInstructions
=>
232 C4
::Context
->preference(
233 'PatronSelfRegistrationAdditionalInstructions')
238 elsif ( $action eq 'update' ) {
240 my $borrower = Koha
::Patrons
->find( $borrowernumber )->unblessed;
241 die "Wrong CSRF token"
242 unless Koha
::Token
->new->check_csrf({
243 session_id
=> scalar $cgi->cookie('CGISESSID'),
244 token
=> scalar $cgi->param('csrf_token'),
247 my %borrower = ParseCgiForBorrower
($cgi);
248 $borrower{borrowernumber
} = $borrowernumber;
250 my @empty_mandatory_fields =
251 CheckMandatoryFields
( \
%borrower, $action );
252 my $invalidformfields = CheckForInvalidFields
(\
%borrower);
254 # Send back the data to the template
255 %borrower = ( %$borrower, %borrower );
257 if (@empty_mandatory_fields || @
$invalidformfields) {
259 empty_mandatory_fields
=> \
@empty_mandatory_fields,
260 invalid_form_fields
=> $invalidformfields,
261 borrower
=> \
%borrower,
262 csrf_token
=> Koha
::Token
->new->generate_csrf({
263 session_id
=> scalar $cgi->cookie('CGISESSID'),
266 $template->param( patron_attribute_classes
=> GeneratePatronAttributesForm
( $borrowernumber, $attributes ) );
268 $template->param( action
=> 'edit' );
271 my %borrower_changes = DelUnchangedFields
( $borrowernumber, %borrower );
272 $borrower_changes{'changed_fields'} = join ',', keys %borrower_changes;
273 my $extended_attributes_changes = FilterUnchangedAttributes
( $borrowernumber, $attributes );
275 if ( %borrower_changes || scalar @
{$extended_attributes_changes} > 0 ) {
276 ( $template, $borrowernumber, $cookie ) = get_template_and_user
(
278 template_name
=> "opac-memberentry-update-submitted.tt",
281 authnotrequired
=> 1,
285 $borrower_changes{borrowernumber
} = $borrowernumber;
286 $borrower_changes{extended_attributes
} = to_json
($extended_attributes_changes);
288 Koha
::Patron
::Modifications
->search({ borrowernumber
=> $borrowernumber })->delete;
290 my $m = Koha
::Patron
::Modification
->new( \
%borrower_changes )->store();
292 my $patron = Koha
::Patrons
->find( $borrowernumber );
293 $template->param( borrower
=> $patron->unblessed );
296 my $patron = Koha
::Patrons
->find( $borrowernumber );
300 borrower
=> $patron->unblessed,
301 patron_attribute_classes
=> GeneratePatronAttributesForm
( $borrowernumber, $attributes ),
302 csrf_token
=> Koha
::Token
->new->generate_csrf({
303 session_id
=> scalar $cgi->cookie('CGISESSID'),
309 elsif ( $action eq 'edit' ) { #Display logged in borrower's data
310 my $patron = Koha
::Patrons
->find( $borrowernumber );
311 my $borrower = $patron->unblessed;
314 borrower
=> $borrower,
315 hidden
=> GetHiddenFields
( $mandatory, 'edit' ),
316 csrf_token
=> Koha
::Token
->new->generate_csrf({
317 session_id
=> scalar $cgi->cookie('CGISESSID'),
321 if (C4
::Context
->preference('OPACpatronimages')) {
322 $template->param( display_patron_image
=> 1 ) if $patron->image;
325 $template->param( patron_attribute_classes
=> GeneratePatronAttributesForm
( $borrowernumber ) );
327 # Render self-registration page
328 $template->param( patron_attribute_classes
=> GeneratePatronAttributesForm
() );
331 my $captcha = random_string
("CCCCC");
335 captcha_digest
=> md5_base64
($captcha),
336 patron
=> scalar Koha
::Patrons
->find( $borrowernumber ),
339 output_html_with_http_headers
$cgi, $cookie, $template->output, undef, { force_no_caching
=> 1 };
341 sub GetHiddenFields
{
342 my ( $mandatory, $action ) = @_;
345 my $BorrowerUnwantedField = $action eq 'edit' || $action eq 'update' ?
346 C4
::Context
->preference( "PatronSelfModificationBorrowerUnwantedField" ) :
347 C4
::Context
->preference( "PatronSelfRegistrationBorrowerUnwantedField" );
349 my @fields = split( /\|/, $BorrowerUnwantedField || q
|| );
352 #Don't hide mandatory fields
353 next if $mandatory->{$_};
354 $hidden_fields{$_} = 1;
357 return \
%hidden_fields;
360 sub GetMandatoryFields
{
363 my %mandatory_fields;
365 my $BorrowerMandatoryField =
366 C4
::Context
->preference("PatronSelfRegistrationBorrowerMandatoryField");
368 my @fields = split( /\|/, $BorrowerMandatoryField );
369 push @fields, 'gdpr_proc_consent' if C4
::Context
->preference('GDPR_Policy') && $action eq 'create';
372 $mandatory_fields{$_} = 1;
375 if ( $action eq 'create' || $action eq 'new' ) {
376 $mandatory_fields{'email'} = 1
377 if C4
::Context
->boolean_preference(
378 'PatronSelfRegistrationVerifyByEmail');
381 return \
%mandatory_fields;
384 sub CheckMandatoryFields
{
385 my ( $borrower, $action ) = @_;
387 my @empty_mandatory_fields;
389 my $mandatory_fields = GetMandatoryFields
($action);
390 delete $mandatory_fields->{'cardnumber'};
392 foreach my $key ( keys %$mandatory_fields ) {
393 push( @empty_mandatory_fields, $key )
394 unless ( defined( $borrower->{$key} ) && $borrower->{$key} );
397 return @empty_mandatory_fields;
400 sub CheckForInvalidFields
{
401 my $borrower = shift;
403 if ($borrower->{'email'}) {
404 unless ( Email
::Valid
->address($borrower->{'email'}) ) {
405 push(@invalidFields, "email");
406 } elsif ( C4
::Context
->preference("PatronSelfRegistrationEmailMustBeUnique") ) {
407 my $patrons_with_same_email = Koha
::Patrons
->search( # FIXME Should be search_limited?
409 email
=> $borrower->{email
},
411 exists $borrower->{borrowernumber
}
412 ?
( borrowernumber
=>
413 { '!=' => $borrower->{borrowernumber
} } )
418 if ( $patrons_with_same_email ) {
419 push @invalidFields, "duplicate_email";
423 if ($borrower->{'emailpro'}) {
424 push(@invalidFields, "emailpro") if (!Email
::Valid
->address($borrower->{'emailpro'}));
426 if ($borrower->{'B_email'}) {
427 push(@invalidFields, "B_email") if (!Email
::Valid
->address($borrower->{'B_email'}));
429 if ( defined $borrower->{'password'}
430 and $borrower->{'password'} ne $borrower->{'password2'} )
432 push( @invalidFields, "password_match" );
434 if ( $borrower->{'password'} ) {
435 my ( $is_valid, $error ) = Koha
::AuthUtils
::is_password_valid
( $borrower->{password
} );
436 unless ( $is_valid ) {
437 push @invalidFields, 'password_too_short' if $error eq 'too_short';
438 push @invalidFields, 'password_too_weak' if $error eq 'too_weak';
439 push @invalidFields, 'password_has_whitespaces' if $error eq 'has_whitespaces';
443 return \
@invalidFields;
446 sub ParseCgiForBorrower
{
449 my $scrubber = C4
::Scrubber
->new();
452 foreach my $field ( $cgi->param ) {
453 if ( $field =~ '^borrower_' ) {
454 my ($key) = substr( $field, 9 );
455 if ( $field !~ '^borrower_password' ) {
456 $borrower{$key} = $scrubber->scrub( scalar $cgi->param($field) );
458 # Allow html characters for passwords
459 $borrower{$key} = $cgi->param($field);
465 $dob_dt = eval { dt_from_string
( $borrower{'dateofbirth'} ); }
466 if ( $borrower{'dateofbirth'} );
469 $borrower{'dateofbirth'} = output_pref
( { dt
=> $dob_dt, dateonly
=> 1, dateformat
=> 'iso' } );
473 $borrower{'dateofbirth'} = undef;
476 # Replace checkbox 'agreed' by datetime in gdpr_proc_consent
477 $borrower{gdpr_proc_consent
} = dt_from_string
if $borrower{gdpr_proc_consent
} && $borrower{gdpr_proc_consent
} eq 'agreed';
482 sub DelUnchangedFields
{
483 my ( $borrowernumber, %new_data ) = @_;
484 # get the mandatory fields so we can get the hidden fields
485 my $mandatory = GetMandatoryFields
('edit');
486 my $patron = Koha
::Patrons
->find( $borrowernumber );
487 my $current_data = $patron->unblessed;
488 # get the hidden fields so we don't obliterate them should they have data patrons aren't allowed to modify
489 my $hidden_fields = GetHiddenFields
($mandatory, 'edit');
492 foreach my $key ( keys %new_data ) {
493 if ( ($current_data->{$key} eq $new_data{$key}) || $hidden_fields->{$key} ) {
494 delete $new_data{$key};
504 foreach my $key ( keys %borrower ) {
505 delete $borrower{$key} unless $borrower{$key};
511 sub FilterUnchangedAttributes
{
512 my ( $borrowernumber, $entered_attributes ) = @_;
514 my @patron_attributes = grep {$_->opac_editable} Koha
::Patron
::Attributes
->search({ borrowernumber
=> $borrowernumber })->as_list;
516 my $patron_attribute_types;
517 foreach my $attr (@patron_attributes) {
518 $patron_attribute_types->{ $attr->code } += 1;
521 my $passed_attribute_types;
522 foreach my $attr (@
{ $entered_attributes }) {
523 $passed_attribute_types->{ $attr->{ code
} } += 1;
526 my @changed_attributes;
528 # Loop through the current patron attributes
529 foreach my $attribute_type ( keys %{ $patron_attribute_types } ) {
530 if ( $patron_attribute_types->{ $attribute_type } != $passed_attribute_types->{ $attribute_type } ) {
531 # count differs, overwrite all attributes for given type
532 foreach my $attr (@
{ $entered_attributes }) {
533 push @changed_attributes, $attr
534 if $attr->{ code
} eq $attribute_type;
537 # count matches, check values
539 foreach my $attr (grep { $_->code eq $attribute_type } @patron_attributes) {
541 unless any
{ $_->{ value
} eq $attr->attribute } @
{ $entered_attributes };
546 foreach my $attr (@
{ $entered_attributes }) {
547 push @changed_attributes, $attr
548 if $attr->{ code
} eq $attribute_type;
554 # Loop through passed attributes, looking for new ones
555 foreach my $attribute_type ( keys %{ $passed_attribute_types } ) {
556 if ( !defined $patron_attribute_types->{ $attribute_type } ) {
558 foreach my $attr (grep { $_->{code
} eq $attribute_type } @
{ $entered_attributes }) {
559 push @changed_attributes, $attr;
564 return \
@changed_attributes;
567 sub GeneratePatronAttributesForm
{
568 my ( $borrowernumber, $entered_attributes ) = @_;
570 # Get all attribute types and the values for this patron (if applicable)
571 my @types = grep { $_->opac_editable() or $_->opac_display }
572 Koha
::Patron
::Attribute
::Types
->search()->as_list();
573 if ( scalar(@types) == 0 ) {
577 my @displayable_attributes = grep { $_->opac_display }
578 Koha
::Patron
::Attributes
->search({ borrowernumber
=> $borrowernumber })->as_list;
580 my %attr_values = ();
582 # Build the attribute values list either from the passed values
583 # or taken from the patron itself
584 if ( defined $entered_attributes ) {
585 foreach my $attr (@
$entered_attributes) {
586 push @
{ $attr_values{ $attr->{code
} } }, $attr->{value
};
589 elsif ( defined $borrowernumber ) {
590 my @editable_attributes = grep { $_->opac_editable } @displayable_attributes;
591 foreach my $attr (@editable_attributes) {
592 push @
{ $attr_values{ $attr->code } }, $attr->attribute;
596 # Add the non-editable attributes (that don't come from the form)
597 foreach my $attr ( grep { !$_->opac_editable } @displayable_attributes ) {
598 push @
{ $attr_values{ $attr->code } }, $attr->attribute;
601 # Find all existing classes
602 my @classes = sort( uniq
( map { $_->class } @types ) );
605 foreach my $attr_type (@types) {
606 push @
{ $items_by_class{ $attr_type->class() } }, {
608 # If editable, make sure there's at least one empty entry,
609 # to make the template's job easier
610 values => $attr_values{ $attr_type->code() } || ['']
612 unless !defined $attr_values{ $attr_type->code() }
613 and !$attr_type->opac_editable;
616 # Finally, build a list of containing classes
618 foreach my $class (@classes) {
619 next unless ( $items_by_class{$class} );
621 my $av = Koha
::AuthorisedValues
->search(
622 { category
=> 'PA_CLASS', authorised_value
=> $class } );
624 my $lib = $av->count ?
$av->next->opac_description : $class;
629 items
=> $items_by_class{$class},
637 sub ParsePatronAttributes
{
638 my ( $borrowernumber, $cgi ) = @_;
640 my @codes = $cgi->multi_param('patron_attribute_code');
641 my @values = $cgi->multi_param('patron_attribute_value');
643 my @editable_attribute_types
644 = map { $_->code } Koha
::Patron
::Attribute
::Types
->search({ opac_editable
=> 1 });
646 my $ea = each_array
( @codes, @values );
649 my $delete_candidates = {};
651 while ( my ( $code, $value ) = $ea->() ) {
652 if ( any
{ $_ eq $code } @editable_attribute_types ) {
653 # It is an editable attribute
654 if ( !defined($value) or $value eq '' ) {
655 $delete_candidates->{$code} = 1
656 unless $delete_candidates->{$code};
660 push @attributes, { code
=> $code, value
=> $value };
662 # 'code' is no longer a delete candidate
663 delete $delete_candidates->{$code}
664 if defined $delete_candidates->{$code};
669 foreach my $code ( keys %{$delete_candidates} ) {
670 if ( Koha
::Patron
::Attributes
->search({
671 borrowernumber
=> $borrowernumber, code
=> $code })->count > 0 )
673 push @attributes, { code
=> $code, value
=> '' }
674 unless any
{ $_->{code
} eq $code } @attributes;