3 # Copyright ByWater Solutions 2014
4 # Copyright PTFS Europe 2016
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use List::MoreUtils qw( any uniq );
24 use JSON qw( to_json );
25 use Unicode::Normalize qw( NFKD );
29 use C4::Auth qw( checkpw_hash );
31 use C4::Letters qw( GetPreparedLetter EnqueueLetter SendQueuedMessages );
32 use C4::Log qw( logaction );
34 use Koha::ArticleRequests;
38 use Koha::CirculationRules;
39 use Koha::Club::Enrollments;
40 use Koha::CurbsidePickups;
42 use Koha::DateUtils qw( dt_from_string );
44 use Koha::Exceptions::Password;
46 use Koha::Old::Checkouts;
47 use Koha::OverdueRules;
48 use Koha::Patron::Attributes;
49 use Koha::Patron::Categories;
50 use Koha::Patron::Consents;
51 use Koha::Patron::Debarments;
52 use Koha::Patron::HouseboundProfile;
53 use Koha::Patron::HouseboundRole;
54 use Koha::Patron::Images;
55 use Koha::Patron::Messages;
56 use Koha::Patron::Modifications;
57 use Koha::Patron::MessagePreferences;
58 use Koha::Patron::Relationships;
59 use Koha::Patron::Restrictions;
63 use Koha::Result::Boolean;
64 use Koha::Subscription::Routinglists;
66 use Koha::Virtualshelves;
68 use base qw(Koha::Object);
70 use constant ADMINISTRATIVE_LOCKOUT => -1;
72 our $RESULTSET_PATRON_ID_MAPPING = {
73 Accountline => 'borrowernumber',
74 Aqbasketuser => 'borrowernumber',
75 Aqbudget => 'budget_owner_id',
76 Aqbudgetborrower => 'borrowernumber',
77 ArticleRequest => 'borrowernumber',
78 BorrowerDebarment => 'borrowernumber',
79 BorrowerFile => 'borrowernumber',
80 BorrowerModification => 'borrowernumber',
81 ClubEnrollment => 'borrowernumber',
82 Issue => 'borrowernumber',
83 ItemsLastBorrower => 'borrowernumber',
84 Linktracker => 'borrowernumber',
85 Message => 'borrowernumber',
86 MessageQueue => 'borrowernumber',
87 OldIssue => 'borrowernumber',
88 OldReserve => 'borrowernumber',
89 Rating => 'borrowernumber',
90 Reserve => 'borrowernumber',
91 Review => 'borrowernumber',
92 SearchHistory => 'userid',
93 Statistic => 'borrowernumber',
94 Suggestion => 'suggestedby',
95 TagAll => 'borrowernumber',
96 Virtualshelfcontent => 'borrowernumber',
97 Virtualshelfshare => 'borrowernumber',
98 Virtualshelve => 'owner',
103 Koha::Patron - Koha Patron Object class
114 my ( $class, $params ) = @_;
116 return $class->SUPER::new($params);
119 =head3 fixup_cardnumber
121 Autogenerate next cardnumber from highest value found in database
125 sub fixup_cardnumber {
128 my $max = $self->cardnumber;
129 Koha::Plugins->call( 'patron_barcode_transform', \$max );
131 $max ||= Koha::Patrons->search({
132 cardnumber => {-regexp => '^-?[0-9]+$'}
134 select => \'CAST(cardnumber AS SIGNED)',
135 as => ['cast_cardnumber']
136 })->_resultset->get_column('cast_cardnumber')->max;
137 $self->cardnumber(($max || 0) +1);
140 =head3 trim_whitespace
142 trim whitespace from data which has some non-whitespace in it.
143 Could be moved to Koha::Object if need to be reused
147 sub trim_whitespaces {
150 my $schema = Koha::Database->new->schema;
151 my @columns = $schema->source($self->_type)->columns;
153 for my $column( @columns ) {
154 my $value = $self->$column;
155 if ( defined $value ) {
156 $value =~ s/^\s*|\s*$//g;
157 $self->$column($value);
163 =head3 plain_text_password
165 $patron->plain_text_password( $password );
167 stores a copy of the unencrypted password in the object
168 for use in code before encrypting for db
172 sub plain_text_password {
173 my ( $self, $password ) = @_;
175 $self->{_plain_text_password} = $password;
178 return $self->{_plain_text_password}
179 if $self->{_plain_text_password};
186 Patron specific store method to cleanup record
187 and do other necessary things before saving
195 $self->_result->result_source->schema->txn_do(
198 C4::Context->preference("autoMemberNum")
199 and ( not defined $self->cardnumber
200 or $self->cardnumber eq '' )
203 # Warning: The caller is responsible for locking the members table in write
204 # mode, to avoid database corruption.
205 # We are in a transaction but the table is not locked
206 $self->fixup_cardnumber;
209 unless( $self->category->in_storage ) {
210 Koha::Exceptions::Object::FKConstraint->throw(
211 broken_fk => 'categorycode',
212 value => $self->categorycode,
216 $self->trim_whitespaces;
218 my $new_cardnumber = $self->cardnumber;
219 Koha::Plugins->call( 'patron_barcode_transform', \$new_cardnumber );
220 $self->cardnumber( $new_cardnumber );
222 # Set surname to uppercase if uppercasesurname is true
223 $self->surname( uc($self->surname) )
224 if C4::Context->preference("uppercasesurnames");
226 $self->relationship(undef) # We do not want to store an empty string in this field
227 if defined $self->relationship
228 and $self->relationship eq "";
230 unless ( $self->in_storage ) { #AddMember
232 # Generate a valid userid/login if needed
233 $self->generate_userid unless $self->userid;
234 Koha::Exceptions::Patron::InvalidUserid->throw( userid => $self->userid )
235 unless $self->has_valid_userid;
237 # Add expiration date if it isn't already there
238 unless ( $self->dateexpiry ) {
239 $self->dateexpiry( $self->category->get_expiry_date );
242 # Add enrollment date if it isn't already there
243 unless ( $self->dateenrolled ) {
244 $self->dateenrolled(dt_from_string);
247 # Set the privacy depending on the patron's category
248 my $default_privacy = $self->category->default_privacy || q{};
250 $default_privacy eq 'default' ? 1
251 : $default_privacy eq 'never' ? 2
252 : $default_privacy eq 'forever' ? 0
254 $self->privacy($default_privacy);
256 # Call any check_password plugins if password is passed
257 if ( C4::Context->config("enable_plugins") && $self->password ) {
258 my @plugins = Koha::Plugins->new()->GetPlugins({
259 method => 'check_password',
261 foreach my $plugin ( @plugins ) {
262 # This plugin hook will also be used by a plugin for the Norwegian national
263 # patron database. This is why we need to pass both the password and the
264 # borrowernumber to the plugin.
265 my $ret = $plugin->check_password(
267 password => $self->password,
268 borrowernumber => $self->borrowernumber
271 if ( $ret->{'error'} == 1 ) {
272 Koha::Exceptions::Password::Plugin->throw();
277 # Make a copy of the plain text password for later use
278 $self->plain_text_password( $self->password );
280 $self->password_expiration_date( $self->password
281 ? $self->category->get_password_expiry_date || undef
283 # Create a disabled account if no password provided
284 $self->password( $self->password
285 ? Koha::AuthUtils::hash_password( $self->password )
288 $self->borrowernumber(undef);
290 $self = $self->SUPER::store;
292 $self->add_enrolment_fee_if_needed(0);
294 logaction( "MEMBERS", "CREATE", $self->borrowernumber, "" )
295 if C4::Context->preference("BorrowersLog");
299 my $self_from_storage = $self->get_from_storage;
301 # Do not accept invalid userid here
302 $self->generate_userid unless $self->userid;
303 Koha::Exceptions::Patron::InvalidUserid->throw( userid => $self->userid )
304 unless $self->has_valid_userid;
306 # If a borrower has set their privacy to never we should immediately anonymize
308 if( $self->privacy() == 2 && $self_from_storage->privacy() != 2 ){
310 $self->old_checkouts->anonymize;
313 Koha::Exceptions::Patron::FailedAnonymizing->throw(
319 # Password must be updated using $self->set_password
320 $self->password($self_from_storage->password);
322 if ( $self->category->categorycode ne
323 $self_from_storage->category->categorycode )
325 # Add enrolement fee on category change if required
326 $self->add_enrolment_fee_if_needed(1)
327 if C4::Context->preference('FeeOnChangePatronCategory');
329 # Clean up guarantors on category change if required
330 $self->guarantor_relationships->delete
331 unless ( $self->category->can_be_guarantee );
336 if ( C4::Context->preference("BorrowersLog") ) {
338 my $from_storage = $self_from_storage->unblessed;
339 my $from_object = $self->unblessed;
340 my @skip_fields = (qw/lastseen updated_on/);
341 for my $key ( keys %{$from_storage} ) {
342 next if any { /$key/ } @skip_fields;
345 !defined( $from_storage->{$key} )
346 && defined( $from_object->{$key} )
348 || ( defined( $from_storage->{$key} )
349 && !defined( $from_object->{$key} ) )
351 defined( $from_storage->{$key} )
352 && defined( $from_object->{$key} )
353 && ( $from_storage->{$key} ne
354 $from_object->{$key} )
359 before => $from_storage->{$key},
360 after => $from_object->{$key}
365 if ( defined($info) ) {
369 $self->borrowernumber,
372 { utf8 => 1, pretty => 1, canonical => 1 }
379 $self = $self->SUPER::store;
390 Delete patron's holds, lists and finally the patron.
392 Lists owned by the borrower are deleted or ownership is transferred depending on the
393 ListOwnershipUponPatronDeletion pref, but entries from the borrower to other lists are kept.
400 my $anonymous_patron = C4::Context->preference("AnonymousPatron");
401 Koha::Exceptions::Patron::FailedDeleteAnonymousPatron->throw() if $anonymous_patron && $self->id eq $anonymous_patron;
403 $self->_result->result_source->schema->txn_do(
405 # Cancel Patron's holds
406 my $holds = $self->holds;
407 while( my $hold = $holds->next ){
411 # Handle lists (virtualshelves)
412 $self->virtualshelves->disown_or_delete;
414 # We cannot have a FK on borrower_modifications.borrowernumber, the table is also used
416 $_->delete for Koha::Patron::Modifications->search( { borrowernumber => $self->borrowernumber } )->as_list;
418 $self->SUPER::delete;
420 logaction( "MEMBERS", "DELETE", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
428 my $patron_category = $patron->category
430 Return the patron category for this patron
436 return Koha::Patron::Category->_new_from_dbic( $self->_result->categorycode );
446 return Koha::Patron::Images->find( $self->borrowernumber );
451 Returns a Koha::Library object representing the patron's home library.
457 return Koha::Library->_new_from_dbic($self->_result->branchcode);
462 Returns a Koha::SMS::Provider object representing the patron's SMS provider.
468 my $sms_provider_rs = $self->_result->sms_provider;
469 return unless $sms_provider_rs;
470 return Koha::SMS::Provider->_new_from_dbic($sms_provider_rs);
473 =head3 guarantor_relationships
475 Returns Koha::Patron::Relationships object for this patron's guarantors
477 Returns the set of relationships for the patrons that are guarantors for this patron.
479 Note that a guarantor should exist as a patron in Koha; it was not possible
480 to add them without a guarantor_id in the interface for some time. Bug 30472
481 restricts it on db level.
485 sub guarantor_relationships {
488 return Koha::Patron::Relationships->search( { guarantee_id => $self->id } );
491 =head3 guarantee_relationships
493 Returns Koha::Patron::Relationships object for this patron's guarantors
495 Returns the set of relationships for the patrons that are guarantees for this patron.
497 The method returns Koha::Patron::Relationship objects for the sake
498 of consistency with the guantors method.
499 A guarantee by definition must exist as a patron in Koha.
503 sub guarantee_relationships {
506 return Koha::Patron::Relationships->search(
507 { guarantor_id => $self->id },
509 prefetch => 'guarantee',
510 order_by => { -asc => [ 'guarantee.surname', 'guarantee.firstname' ] },
515 =head3 relationships_debt
517 Returns the amount owed by the patron's guarantors *and* the other guarantees of those guarantors
521 sub relationships_debt {
522 my ($self, $params) = @_;
524 my $include_guarantors = $params->{include_guarantors};
525 my $only_this_guarantor = $params->{only_this_guarantor};
526 my $include_this_patron = $params->{include_this_patron};
529 if ( $only_this_guarantor ) {
530 @guarantors = $self->guarantee_relationships->count ? ( $self ) : ();
531 Koha::Exceptions::BadParameter->throw( { parameter => 'only_this_guarantor' } ) unless @guarantors;
532 } elsif ( $self->guarantor_relationships->count ) {
533 # I am a guarantee, just get all my guarantors
534 @guarantors = $self->guarantor_relationships->guarantors->as_list;
536 # I am a guarantor, I need to get all the guarantors of all my guarantees
537 @guarantors = map { $_->guarantor_relationships->guarantors->as_list } $self->guarantee_relationships->guarantees->as_list;
540 my $non_issues_charges = 0;
541 my $seen = $include_this_patron ? {} : { $self->id => 1 }; # For tracking members already added to the total
542 foreach my $guarantor (@guarantors) {
543 $non_issues_charges += $guarantor->account->non_issues_charges if $include_guarantors && !$seen->{ $guarantor->id };
545 # We've added what the guarantor owes, not added in that guarantor's guarantees as well
546 my @guarantees = map { $_->guarantee } $guarantor->guarantee_relationships->as_list;
547 my $guarantees_non_issues_charges = 0;
548 foreach my $guarantee (@guarantees) {
549 next if $seen->{ $guarantee->id };
550 $guarantees_non_issues_charges += $guarantee->account->non_issues_charges;
551 # Mark this guarantee as seen so we don't double count a guarantee linked to multiple guarantors
552 $seen->{ $guarantee->id } = 1;
555 $non_issues_charges += $guarantees_non_issues_charges;
556 $seen->{ $guarantor->id } = 1;
559 return $non_issues_charges;
562 =head3 housebound_profile
564 Returns the HouseboundProfile associated with this patron.
568 sub housebound_profile {
570 my $profile = $self->_result->housebound_profile;
571 return Koha::Patron::HouseboundProfile->_new_from_dbic($profile)
576 =head3 housebound_role
578 Returns the HouseboundRole associated with this patron.
582 sub housebound_role {
585 my $role = $self->_result->housebound_role;
586 return Koha::Patron::HouseboundRole->_new_from_dbic($role) if ( $role );
592 Returns the siblings of this patron.
599 my @guarantors = $self->guarantor_relationships()->guarantors()->as_list;
601 return unless @guarantors;
604 map { $_->guarantee_relationships()->guarantees()->as_list } @guarantors;
606 return unless @siblings;
610 grep { !$seen{ $_->id }++ && ( $_->id != $self->id ) } @siblings;
612 return Koha::Patrons->search( { borrowernumber => { -in => [ map { $_->id } @siblings ] } } );
617 my $patron = Koha::Patrons->find($id);
618 $patron->merge_with( \@patron_ids );
620 This subroutine merges a list of patrons into the patron record. This is accomplished by finding
621 all related patron ids for the patrons to be merged in other tables and changing the ids to be that
622 of the keeper patron.
627 my ( $self, $patron_ids ) = @_;
629 my $anonymous_patron = C4::Context->preference("AnonymousPatron");
630 return if $anonymous_patron && $self->id eq $anonymous_patron;
632 my @patron_ids = @{ $patron_ids };
634 # Ensure the keeper isn't in the list of patrons to merge
635 @patron_ids = grep { $_ ne $self->id } @patron_ids;
637 my $schema = Koha::Database->new()->schema();
641 $self->_result->result_source->schema->txn_do( sub {
642 foreach my $patron_id (@patron_ids) {
644 next if $patron_id eq $anonymous_patron;
646 my $patron = Koha::Patrons->find( $patron_id );
650 # Unbless for safety, the patron will end up being deleted
651 $results->{merged}->{$patron_id}->{patron} = $patron->unblessed;
653 my $attributes = $patron->extended_attributes;
654 my $new_attributes = [
655 map { { code => $_->code, attribute => $_->attribute } }
658 $attributes->delete; # We need to delete before trying to merge them to prevent exception on unique and repeatable
659 for my $attribute ( @$new_attributes ) {
661 $self->add_extended_attribute($attribute);
663 # Don't block the merge if there is a non-repeatable attribute that cannot be added to the current patron.
664 unless ( $_->isa('Koha::Exceptions::Patron::Attribute::NonRepeatable') ) {
670 while (my ($r, $field) = each(%$RESULTSET_PATRON_ID_MAPPING)) {
671 my $rs = $schema->resultset($r)->search({ $field => $patron_id });
672 $results->{merged}->{ $patron_id }->{updated}->{$r} = $rs->count();
673 $rs->update({ $field => $self->id });
674 if ( $r eq 'BorrowerDebarment' ) {
675 Koha::Patron::Debarments::UpdateBorrowerDebarmentFlags($self->id);
679 $patron->move_to_deleted();
688 =head3 messaging_preferences
690 my $patron = Koha::Patrons->find($id);
691 $patron->messaging_preferences();
695 sub messaging_preferences {
698 return Koha::Patron::MessagePreferences->search({
699 borrowernumber => $self->borrowernumber,
703 =head3 wants_check_for_previous_checkout
705 $wants_check = $patron->wants_check_for_previous_checkout;
707 Return 1 if Koha needs to perform PrevIssue checking, else 0.
711 sub wants_check_for_previous_checkout {
713 my $syspref = C4::Context->preference("checkPrevCheckout");
716 ## Hard syspref trumps all
717 return 1 if ($syspref eq 'hardyes');
718 return 0 if ($syspref eq 'hardno');
719 ## Now, patron pref trumps all
720 return 1 if ($self->checkprevcheckout eq 'yes');
721 return 0 if ($self->checkprevcheckout eq 'no');
723 # More complex: patron inherits -> determine category preference
724 my $checkPrevCheckoutByCat = $self->category->checkprevcheckout;
725 return 1 if ($checkPrevCheckoutByCat eq 'yes');
726 return 0 if ($checkPrevCheckoutByCat eq 'no');
728 # Finally: category preference is inherit, default to 0
729 if ($syspref eq 'softyes') {
736 =head3 do_check_for_previous_checkout
738 $do_check = $patron->do_check_for_previous_checkout($item);
740 Return 1 if the bib associated with $ITEM has previously been checked out to
741 $PATRON, 0 otherwise.
745 sub do_check_for_previous_checkout {
746 my ( $self, $item ) = @_;
749 my $biblio = Koha::Biblios->find( $item->{biblionumber} );
750 if ( $biblio->is_serial ) {
751 push @item_nos, $item->{itemnumber};
753 # Get all itemnumbers for given bibliographic record.
754 @item_nos = $biblio->items->get_column( 'itemnumber' );
757 # Create (old)issues search criteria
759 borrowernumber => $self->borrowernumber,
760 itemnumber => \@item_nos,
763 my $delay = C4::Context->preference('CheckPrevCheckoutDelay') || 0;
765 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
766 my $newer_than = dt_from_string()->subtract( days => $delay );
767 $criteria->{'returndate'} = { '>' => $dtf->format_datetime($newer_than), };
770 # Check current issues table
771 my $issues = Koha::Checkouts->search($criteria);
772 return 1 if $issues->count; # 0 || N
774 # Check old issues table
775 my $old_issues = Koha::Old::Checkouts->search($criteria);
776 return $old_issues->count; # 0 || N
781 my $debarment_expiration = $patron->is_debarred;
783 Returns the date a patron debarment will expire, or undef if the patron is not
791 return unless $self->debarred;
792 return $self->debarred
793 if $self->debarred =~ '^9999'
794 or dt_from_string( $self->debarred ) > dt_from_string;
800 my $is_expired = $patron->is_expired;
802 Returns 1 if the patron is expired or 0;
808 return 0 unless $self->dateexpiry;
809 return 0 if $self->dateexpiry =~ '^9999';
810 return 1 if dt_from_string( $self->dateexpiry ) < dt_from_string->truncate( to => 'day' );
816 $patron->is_active({ [ since => $date ], [ days|weeks|months|years => $value ] })
818 A patron is considered 'active' if the following conditions hold:
820 - account did not expire
821 - account has not been anonymized
822 - enrollment or lastseen within period specified
824 Note: lastseen is updated for triggers defined in preference
825 TrackLastPatronActivityTriggers. This includes logins, issues, holds, etc.
827 The period to check is defined by $date or $value in days, weeks or months. You should
828 pass one of those; otherwise an exception is thrown.
833 my ( $self, $params ) = @_;
834 return 0 if $self->is_expired or $self->anonymized;
837 if ( $params->{since} ) {
838 $dt = dt_from_string( $params->{since}, 'iso' );
839 } elsif ( grep { $params->{$_} } qw(days weeks months years) ) {
840 $dt = dt_from_string();
841 foreach my $duration (qw(days weeks months years)) {
842 $dt = $dt->subtract( $duration => $params->{$duration} ) if $params->{$duration};
845 Koha::Exceptions::MissingParameter->throw('is_active needs date or period');
848 # Enrollment within this period?
849 return 1 if DateTime->compare( dt_from_string( $self->dateenrolled ), $dt ) > -1;
851 # We look at lastseen regardless of TrackLastPatronActivityTriggers. If lastseen is set
852 # recently, the triggers may have been removed after that, etc.
853 return 1 if $self->lastseen && DateTime->compare( dt_from_string( $self->lastseen ), $dt ) > -1;
858 =head3 password_expired
860 my $password_expired = $patron->password_expired;
862 Returns 1 if the patron's password is expired or 0;
866 sub password_expired {
868 return 0 unless $self->password_expiration_date;
869 return 1 if dt_from_string( $self->password_expiration_date ) <= dt_from_string->truncate( to => 'day' );
873 =head3 is_going_to_expire
875 my $is_going_to_expire = $patron->is_going_to_expire;
877 Returns 1 if the patron is going to expired, depending on the NotifyBorrowerDeparture pref or 0
881 sub is_going_to_expire {
884 my $delay = C4::Context->preference('NotifyBorrowerDeparture') || 0;
886 return 0 unless $delay;
887 return 0 unless $self->dateexpiry;
888 return 0 if $self->dateexpiry =~ '^9999';
889 return 1 if dt_from_string( $self->dateexpiry, undef, 'floating' )->subtract( days => $delay ) < dt_from_string(undef, undef, 'floating')->truncate( to => 'day' );
895 $patron->set_password({ password => $plain_text_password [, skip_validation => 1 ] });
897 Set the patron's password.
901 The passed string is validated against the current password enforcement policy.
902 Validation can be skipped by passing the I<skip_validation> parameter.
904 Exceptions are thrown if the password is not good enough.
908 =item Koha::Exceptions::Password::TooShort
910 =item Koha::Exceptions::Password::WhitespaceCharacters
912 =item Koha::Exceptions::Password::TooWeak
914 =item Koha::Exceptions::Password::Plugin (if a "check password" plugin is enabled)
921 my ( $self, $args ) = @_;
923 my $password = $args->{password};
925 unless ( $args->{skip_validation} ) {
926 my ( $is_valid, $error ) = Koha::AuthUtils::is_password_valid( $password, $self->category );
929 if ( $error eq 'too_short' ) {
930 my $min_length = $self->category->effective_min_password_length;
931 $min_length = 3 if not $min_length or $min_length < 3;
933 my $password_length = length($password);
934 Koha::Exceptions::Password::TooShort->throw(
935 length => $password_length, min_length => $min_length );
937 elsif ( $error eq 'has_whitespaces' ) {
938 Koha::Exceptions::Password::WhitespaceCharacters->throw();
940 elsif ( $error eq 'too_weak' ) {
941 Koha::Exceptions::Password::TooWeak->throw();
946 if ( C4::Context->config("enable_plugins") ) {
947 # Call any check_password plugins
948 my @plugins = Koha::Plugins->new()->GetPlugins({
949 method => 'check_password',
951 foreach my $plugin ( @plugins ) {
952 # This plugin hook will also be used by a plugin for the Norwegian national
953 # patron database. This is why we need to pass both the password and the
954 # borrowernumber to the plugin.
955 my $ret = $plugin->check_password(
957 password => $password,
958 borrowernumber => $self->borrowernumber
961 # This plugin hook will also be used by a plugin for the Norwegian national
962 # patron database. This is why we need to call the actual plugins and then
963 # check skip_validation afterwards.
964 if ( $ret->{'error'} == 1 && !$args->{skip_validation} ) {
965 Koha::Exceptions::Password::Plugin->throw();
970 if ( C4::Context->preference('NotifyPasswordChange') ) {
971 my $self_from_storage = $self->get_from_storage;
972 if ( !C4::Auth::checkpw_hash( $password, $self_from_storage->password ) ) {
973 my $emailaddr = $self_from_storage->notice_email_address;
975 # if we manage to find a valid email address, send notice
977 my $letter = C4::Letters::GetPreparedLetter(
979 letter_code => 'PASSWORD_CHANGE',
980 branchcode => $self_from_storage->branchcode,
982 lang => $self_from_storage->lang || 'default',
984 'branches' => $self_from_storage->branchcode,
985 'borrowers' => $self_from_storage->borrowernumber,
990 my $message_id = C4::Letters::EnqueueLetter(
993 borrowernumber => $self_from_storage->id,
994 to_address => $emailaddr,
995 message_transport_type => 'email'
998 C4::Letters::SendQueuedMessages( { message_id => $message_id } ) if $message_id;
1003 my $digest = Koha::AuthUtils::hash_password($password);
1005 $self->password_expiration_date( $self->category->get_password_expiry_date || undef );
1007 # We do not want to call $self->store and retrieve password from DB
1008 $self->password($digest);
1009 $self->login_attempts(0);
1010 $self->SUPER::store;
1012 logaction( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" )
1013 if C4::Context->preference("BorrowersLog");
1019 =head3 renew_account
1021 my $new_expiry_date = $patron->renew_account
1023 Extending the subscription to the expiry date.
1030 if ( C4::Context->preference('BorrowerRenewalPeriodBase') eq 'combination' ) {
1031 $date = ( dt_from_string gt dt_from_string( $self->dateexpiry ) ) ? dt_from_string : dt_from_string( $self->dateexpiry );
1034 C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry'
1035 ? dt_from_string( $self->dateexpiry )
1038 my $expiry_date = $self->category->get_expiry_date($date);
1040 $self->dateexpiry($expiry_date);
1041 $self->date_renewed( dt_from_string() );
1044 $self->add_enrolment_fee_if_needed(1);
1046 logaction( "MEMBERS", "RENEW", $self->borrowernumber, "Membership renewed" ) if C4::Context->preference("BorrowersLog");
1047 return dt_from_string( $expiry_date )->truncate( to => 'day' );
1052 my $has_overdues = $patron->has_overdues;
1054 Returns the number of patron's overdues
1060 my $date = dt_from_string();
1061 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
1062 return $self->_result->issues->search({ date_due => { '<' => $dtf->format_datetime($date) } })->count;
1067 =head3 has_restricting_overdues
1069 my $has_restricting_overdues = $patron->has_restricting_overdues({ issue_branchcode => $branchcode });
1071 Returns true if patron has overdues that would result in debarment.
1075 sub has_restricting_overdues {
1076 my ( $self, $params ) = @_;
1078 my $date = dt_from_string()->truncate( to => 'day' );
1080 # If ignoring unrestricted overdues, calculate which delay value for
1081 # overdue messages is set with restrictions. Then only include overdue
1082 # issues older than that date when counting.
1083 #TODO: bail out/throw exception if $params->{issue_branchcode} not set?
1084 my $debarred_delay = _get_overdue_debarred_delay( $params->{issue_branchcode}, $self->categorycode() );
1085 return 0 unless defined $debarred_delay;
1087 # Emulate the conditions in overdue_notices.pl.
1088 # The overdue_notices-script effectively truncates both issues.date_due and current date
1089 # to days when selecting overdue issues.
1090 # Hours and minutes for issues.date_due is usually set to 23 and 59 respectively, though can theoretically
1091 # be set to any other value (truncated to minutes, except if CalcDateDue gets a $startdate)
1093 # No matter what time of day date_due is set to, overdue_notices.pl will select all issues that are due
1094 # the current date or later. We can emulate this query by instead of truncating both to days in the SQL-query,
1095 # using the condition that date_due must be less then the current date truncated to days (time set to 00:00:00)
1096 # offset by one day in the future.
1098 $date->add( days => 1 );
1101 if ( C4::Context->preference('OverdueNoticeCalendar') ) {
1102 $calendar = Koha::Calendar->new( branchcode => $params->{issue_branchcode} );
1105 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
1106 my $issues = $self->_result->issues->search( { date_due => { '<' => $dtf->format_datetime($date) } } );
1107 my $now = dt_from_string();
1109 while ( my $issue = $issues->next ) {
1111 C4::Context->preference('OverdueNoticeCalendar')
1112 ? $calendar->days_between( dt_from_string( $issue->date_due ), $now )->in_units('days')
1113 : $now->delta_days( dt_from_string( $issue->date_due ) )->in_units('days');
1114 if ( $days_between >= $debarred_delay ) {
1121 # Fetch first delayX value from overduerules where debarredX is set, or 0 for no delay
1122 sub _get_overdue_debarred_delay {
1123 my ( $branchcode, $categorycode ) = @_;
1124 my $dbh = C4::Context->dbh();
1126 # We get default rules if there is no rule for this branch
1127 my $rule = Koha::OverdueRules->find(
1129 branchcode => $branchcode,
1130 categorycode => $categorycode
1133 || Koha::OverdueRules->find(
1136 categorycode => $categorycode
1141 return $rule->delay1 if $rule->debarred1;
1142 return $rule->delay2 if $rule->debarred2;
1143 return $rule->delay3 if $rule->debarred3;
1147 =head3 update_lastseen
1149 $patron->update_lastseen('activity');
1151 Updates the lastseen field, limited to one update per day, whenever the activity passed is
1152 listed in TrackLastPatronActivityTriggers.
1154 The method should be called upon successful completion of the activity.
1158 sub update_lastseen {
1159 my ( $self, $activity ) = @_;
1160 my $tracked_activities = {
1161 map { ( lc $_, 1 ); } split /\s*\,\s*/,
1162 C4::Context->preference('TrackLastPatronActivityTriggers')
1164 return $self unless $tracked_activities->{$activity};
1166 my $cache = Koha::Caches->get_instance();
1167 my $cache_key = "track_activity_" . $self->borrowernumber;
1168 my $cached = $cache->get_from_cache($cache_key);
1169 my $now = dt_from_string();
1170 return $self if $cached && $cached eq $now->ymd;
1172 $self->lastseen($now)->store;
1173 $cache->set_in_cache( $cache_key, $now->ymd );
1177 =head3 move_to_deleted
1179 my $is_moved = $patron->move_to_deleted;
1181 Move a patron to the deletedborrowers table.
1182 This can be done before deleting a patron, to make sure the data are not completely deleted.
1186 sub move_to_deleted {
1188 my $patron_infos = $self->unblessed;
1189 delete $patron_infos->{updated_on}; #This ensures the updated_on date in deletedborrowers will be set to the current timestamp
1190 return Koha::Database->new->schema->resultset('Deletedborrower')->create($patron_infos);
1193 =head3 can_request_article
1195 if ( $patron->can_request_article( $library->id ) ) { ... }
1197 Returns true if the patron can request articles. As limits apply for the patron
1198 on the same day, those completed the same day are considered as current.
1200 A I<library_id> can be passed as parameter, falling back to userenv if absent.
1204 sub can_request_article {
1205 my ($self, $library_id) = @_;
1207 $library_id //= C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
1209 my $rule = Koha::CirculationRules->get_effective_rule(
1211 branchcode => $library_id,
1212 categorycode => $self->categorycode,
1213 rule_name => 'open_article_requests_limit'
1217 my $limit = ($rule) ? $rule->rule_value : undef;
1219 return 1 unless defined $limit;
1221 my $count = Koha::ArticleRequests->search(
1222 [ { borrowernumber => $self->borrowernumber, status => [ 'REQUESTED', 'PENDING', 'PROCESSING' ] },
1223 { borrowernumber => $self->borrowernumber, status => 'COMPLETED', updated_on => { '>=' => \'CAST(NOW() AS DATE)' } },
1226 return $count < $limit ? 1 : 0;
1229 =head3 article_request_fee
1231 my $fee = $patron->article_request_fee(
1233 [ library_id => $library->id, ]
1237 Returns the fee to be charged to the patron when it places an article request.
1239 A I<library_id> can be passed as parameter, falling back to userenv if absent.
1243 sub article_request_fee {
1244 my ($self, $params) = @_;
1246 my $library_id = $params->{library_id};
1248 $library_id //= C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
1250 my $rule = Koha::CirculationRules->get_effective_rule(
1252 branchcode => $library_id,
1253 categorycode => $self->categorycode,
1254 rule_name => 'article_request_fee'
1258 my $fee = ($rule) ? $rule->rule_value + 0 : 0;
1263 =head3 add_article_request_fee_if_needed
1265 my $fee = $patron->add_article_request_fee_if_needed(
1267 [ item_id => $item->id,
1268 library_id => $library->id, ]
1272 If an article request fee needs to be charged, it adds a debit to the patron's
1275 Returns the fee line.
1277 A I<library_id> can be passed as parameter, falling back to userenv if absent.
1281 sub add_article_request_fee_if_needed {
1282 my ($self, $params) = @_;
1284 my $library_id = $params->{library_id};
1285 my $item_id = $params->{item_id};
1287 $library_id //= C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
1289 my $amount = $self->article_request_fee(
1291 library_id => $library_id,
1297 if ( $amount > 0 ) {
1298 $debit_line = $self->account->add_debit(
1301 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
1302 interface => C4::Context->interface,
1303 library_id => $library_id,
1304 type => 'ARTICLE_REQUEST',
1305 item_id => $item_id,
1313 =head3 article_requests
1315 my $article_requests = $patron->article_requests;
1317 Returns the patron article requests.
1321 sub article_requests {
1324 return Koha::ArticleRequests->_new_from_dbic( scalar $self->_result->article_requests );
1327 =head3 add_enrolment_fee_if_needed
1329 my $enrolment_fee = $patron->add_enrolment_fee_if_needed($renewal);
1331 Add enrolment fee for a patron if needed.
1333 $renewal - boolean denoting whether this is an account renewal or not
1337 sub add_enrolment_fee_if_needed {
1338 my ($self, $renewal) = @_;
1339 my $enrolment_fee = $self->category->enrolmentfee;
1340 if ( $enrolment_fee && $enrolment_fee > 0 ) {
1341 my $type = $renewal ? 'ACCOUNT_RENEW' : 'ACCOUNT';
1342 $self->account->add_debit(
1344 amount => $enrolment_fee,
1345 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
1346 interface => C4::Context->interface,
1347 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
1352 return $enrolment_fee || 0;
1357 my $checkouts = $patron->checkouts
1363 my $checkouts = $self->_result->issues;
1364 return Koha::Checkouts->_new_from_dbic( $checkouts );
1367 =head3 pending_checkouts
1369 my $pending_checkouts = $patron->pending_checkouts
1371 This method will return the same as $self->checkouts, but with a prefetch on
1372 items, biblio and biblioitems.
1374 It has been introduced to replaced the C4::Members::GetPendingIssues subroutine
1376 It should not be used directly, prefer to access fields you need instead of
1377 retrieving all these fields in one go.
1381 sub pending_checkouts {
1383 my $checkouts = $self->_result->issues->search(
1387 { -desc => 'me.timestamp' },
1388 { -desc => 'issuedate' },
1389 { -desc => 'issue_id' }, # Sort by issue_id should be enough
1391 prefetch => { item => { biblio => 'biblioitems' } },
1394 return Koha::Checkouts->_new_from_dbic( $checkouts );
1397 =head3 old_checkouts
1399 my $old_checkouts = $patron->old_checkouts
1405 my $old_checkouts = $self->_result->old_issues;
1406 return Koha::Old::Checkouts->_new_from_dbic( $old_checkouts );
1411 my $overdue_items = $patron->overdues
1413 Return the overdue items
1419 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
1420 return $self->checkouts->search(
1422 'me.date_due' => { '<' => $dtf->format_datetime(dt_from_string) },
1425 prefetch => { item => { biblio => 'biblioitems' } },
1433 my $restrictions = $patron->restrictions;
1435 Returns the patron restrictions.
1441 my $restrictions_rs = $self->_result->restrictions;
1442 return Koha::Patron::Restrictions->_new_from_dbic($restrictions_rs);
1445 =head3 get_routing_lists
1447 my $routinglists = $patron->get_routing_lists
1449 Returns the routing lists a patron is subscribed to.
1453 sub get_routing_lists {
1455 my $routing_list_rs = $self->_result->subscriptionroutinglists;
1456 return Koha::Subscription::Routinglists->_new_from_dbic($routing_list_rs);
1461 my $age = $patron->get_age
1463 Return the age of the patron
1470 return unless $self->dateofbirth;
1472 #Set timezone to floating to avoid any datetime math issues caused by DST
1473 my $date_of_birth = dt_from_string( $self->dateofbirth, undef, 'floating' );
1474 my $today = dt_from_string(undef, undef, 'floating')->truncate( to => 'day' );
1476 return $today->subtract_datetime( $date_of_birth )->years;
1481 my $is_valid = $patron->is_valid_age
1483 Return 1 if patron's age is between allowed limits, returns 0 if it's not.
1489 my $age = $self->get_age;
1491 my $patroncategory = $self->category;
1492 my ($low,$high) = ($patroncategory->dateofbirthrequired, $patroncategory->upperagelimit);
1494 return (defined($age) && (($high && ($age > $high)) or ($low && ($age < $low)))) ? 0 : 1;
1499 my $account = $patron->account
1505 return Koha::Account->new( { patron_id => $self->borrowernumber } );
1510 my $holds = $patron->holds
1512 Return all the holds placed by this patron
1518 my $holds_rs = $self->_result->reserves->search( {}, { order_by => 'reservedate' } );
1519 return Koha::Holds->_new_from_dbic($holds_rs);
1524 my $old_holds = $patron->old_holds
1526 Return all the historical holds for this patron
1532 my $old_holds_rs = $self->_result->old_reserves->search( {}, { order_by => 'reservedate' } );
1533 return Koha::Old::Holds->_new_from_dbic($old_holds_rs);
1536 =head3 curbside_pickups
1538 my $curbside_pickups = $patron->curbside_pickups;
1540 Return all the curbside pickups for this patron
1544 sub curbside_pickups {
1546 my $curbside_pickups_rs = $self->_result->curbside_pickups_borrowernumbers->search;
1547 return Koha::CurbsidePickups->_new_from_dbic($curbside_pickups_rs);
1550 =head3 return_claims
1552 my $return_claims = $patron->return_claims
1558 my $return_claims = $self->_result->return_claims_borrowernumbers;
1559 return Koha::Checkouts::ReturnClaims->_new_from_dbic( $return_claims );
1562 =head3 notice_email_address
1564 my $email = $patron->notice_email_address;
1566 Return the email address of patron used for notices.
1567 Returns the empty string if no email address.
1571 sub notice_email_address{
1574 my $which_address = C4::Context->preference("EmailFieldPrimary");
1575 # if syspref is set to 'first valid' (value == OFF), look up email address
1576 if ( $which_address eq 'OFF' ) {
1577 return $self->first_valid_email_address;
1580 return $self->$which_address || '';
1583 =head3 first_valid_email_address
1585 my $first_valid_email_address = $patron->first_valid_email_address
1587 Return the first valid email address for a patron.
1588 For now, the order is defined as email, emailpro, B_email.
1589 Returns the empty string if the borrower has no email addresses.
1593 sub first_valid_email_address {
1598 my @fields = split /\s*\|\s*/,
1599 C4::Context->preference('EmailFieldPrecedence');
1600 for my $field (@fields) {
1601 $email = $self->$field;
1608 =head3 get_club_enrollments
1612 sub get_club_enrollments {
1615 return Koha::Club::Enrollments->search( { borrowernumber => $self->borrowernumber(), date_canceled => undef } );
1618 =head3 get_enrollable_clubs
1622 sub get_enrollable_clubs {
1623 my ( $self, $is_enrollable_from_opac ) = @_;
1626 $params->{is_enrollable_from_opac} = $is_enrollable_from_opac
1627 if $is_enrollable_from_opac;
1628 $params->{is_email_required} = 0 unless $self->first_valid_email_address();
1630 $params->{borrower} = $self;
1632 return Koha::Clubs->get_enrollable($params);
1635 =head3 account_locked
1637 my $is_locked = $patron->account_locked
1639 Return true if the patron has reached the maximum number of login attempts
1640 (see pref FailedLoginAttempts). If login_attempts is < 0, this is interpreted
1641 as an administrative lockout (independent of FailedLoginAttempts; see also
1642 Koha::Patron->lock).
1643 Otherwise return false.
1644 If the pref is not set (empty string, null or 0), the feature is considered as
1649 sub account_locked {
1651 my $FailedLoginAttempts = C4::Context->preference('FailedLoginAttempts');
1652 return 1 if $FailedLoginAttempts
1653 and $self->login_attempts
1654 and $self->login_attempts >= $FailedLoginAttempts;
1655 return 1 if ($self->login_attempts || 0) < 0; # administrative lockout
1659 =head3 can_see_patron_infos
1661 my $can_see = $patron->can_see_patron_infos( $patron );
1663 Return true if the patron (usually the logged in user) can see the patron's infos for a given patron
1667 sub can_see_patron_infos {
1668 my ( $self, $patron ) = @_;
1669 return unless $patron;
1670 return $self->can_see_patrons_from( $patron->branchcode );
1673 =head3 can_see_patrons_from
1675 my $can_see = $patron->can_see_patrons_from( $branchcode );
1677 Return true if the patron (usually the logged in user) can see the patron's infos from a given library
1681 sub can_see_patrons_from {
1682 my ( $self, $branchcode ) = @_;
1684 return $self->can_see_things_from(
1686 branchcode => $branchcode,
1687 permission => 'borrowers',
1688 subpermission => 'view_borrower_infos_from_any_libraries',
1693 =head3 can_edit_items_from
1695 my $can_edit = $patron->can_edit_items_from( $branchcode );
1697 Return true if the I<Koha::Patron> can edit items from the given branchcode
1701 sub can_edit_items_from {
1702 my ( $self, $branchcode ) = @_;
1704 return 1 if C4::Context->IsSuperLibrarian();
1706 my $userenv = C4::Context->userenv();
1707 if ( $userenv && C4::Context->preference('IndependentBranches') ) {
1708 return $userenv->{branch} eq $branchcode;
1711 return $self->can_see_things_from(
1713 branchcode => $branchcode,
1714 permission => 'editcatalogue',
1715 subpermission => 'edit_any_item',
1720 =head3 libraries_where_can_edit_items
1722 my $libraries = $patron->libraries_where_can_edit_items;
1724 Return the list of branchcodes(!) of libraries the patron is allowed to items for.
1725 The branchcodes are arbitrarily returned sorted.
1726 We are supposing here that the object is related to the logged in patron (use of C4::Context::only_my_library)
1728 An empty array means no restriction, the user can edit any item.
1732 sub libraries_where_can_edit_items {
1735 return $self->libraries_where_can_see_things(
1737 permission => 'editcatalogue',
1738 subpermission => 'edit_any_item',
1739 group_feature => 'ft_limit_item_editing',
1744 =head3 libraries_where_can_see_patrons
1746 my $libraries = $patron->libraries_where_can_see_patrons;
1748 Return the list of branchcodes(!) of libraries the patron is allowed to see other patron's infos.
1749 The branchcodes are arbitrarily returned sorted.
1750 We are supposing here that the object is related to the logged in patron (use of C4::Context::only_my_library)
1752 An empty array means no restriction, the patron can see patron's infos from any libraries.
1756 sub libraries_where_can_see_patrons {
1759 return $self->libraries_where_can_see_things(
1761 permission => 'borrowers',
1762 subpermission => 'view_borrower_infos_from_any_libraries',
1763 group_feature => 'ft_hide_patron_info',
1768 =head3 can_see_things_from
1770 my $can_see = $patron->can_see_things_from( $branchcode );
1772 Return true if the I<Koha::Patron> can perform some action on the given thing
1776 sub can_see_things_from {
1777 my ( $self, $params ) = @_;
1779 my $branchcode = $params->{branchcode};
1780 my $permission = $params->{permission};
1781 my $subpermission = $params->{subpermission};
1783 return 1 if C4::Context->IsSuperLibrarian();
1786 if ( $self->branchcode eq $branchcode ) {
1788 } elsif ( $self->has_permission( { $permission => $subpermission } ) ) {
1790 } elsif ( my $library_groups = $self->library->library_groups ) {
1791 while ( my $library_group = $library_groups->next ) {
1792 if ( $library_group->parent->has_child( $branchcode ) ) {
1803 my $can_log_into = $patron->can_log_into( $library );
1805 Given a I<Koha::Library> object, it returns a boolean representing
1806 the fact the patron can log into a the library.
1811 my ( $self, $library ) = @_;
1815 if ( C4::Context->preference('IndependentBranches') ) {
1817 if $self->is_superlibrarian
1818 or $self->branchcode eq $library->id;
1828 =head3 libraries_where_can_see_things
1830 my $libraries = $patron->libraries_where_can_see_things;
1832 Returns a list of libraries where an aribitarary action is allowed to be taken by the logged in librarian
1833 against an object based on some branchcode related to the object ( patron branchcode, item homebranch, etc ).
1835 We are supposing here that the object is related to the logged in librarian (use of C4::Context::only_my_library)
1837 An empty array means no restriction, the thing can see thing's infos from any libraries.
1841 sub libraries_where_can_see_things {
1842 my ( $self, $params ) = @_;
1843 my $permission = $params->{permission};
1844 my $subpermission = $params->{subpermission};
1845 my $group_feature = $params->{group_feature};
1847 my $userenv = C4::Context->userenv;
1849 return () unless $userenv; # For tests, but userenv should be defined in tests...
1851 my @restricted_branchcodes;
1852 if (C4::Context::only_my_library) {
1853 push @restricted_branchcodes, $self->branchcode;
1857 $self->has_permission(
1858 { $permission => $subpermission }
1862 my $library_groups = $self->library->library_groups({ $group_feature => 1 });
1863 if ( $library_groups->count )
1865 while ( my $library_group = $library_groups->next ) {
1866 my $parent = $library_group->parent;
1867 if ( $parent->has_child( $self->branchcode ) ) {
1868 push @restricted_branchcodes, $parent->children->get_column('branchcode');
1873 @restricted_branchcodes = ( $self->branchcode ) unless @restricted_branchcodes;
1877 @restricted_branchcodes = grep { defined $_ } @restricted_branchcodes;
1878 @restricted_branchcodes = uniq(@restricted_branchcodes);
1879 @restricted_branchcodes = sort(@restricted_branchcodes);
1880 return @restricted_branchcodes;
1883 =head3 has_permission
1885 my $permission = $patron->has_permission($required);
1887 See C4::Auth::haspermission for details of syntax for $required
1891 sub has_permission {
1892 my ( $self, $flagsrequired ) = @_;
1893 return unless $self->userid;
1894 # TODO code from haspermission needs to be moved here!
1895 return C4::Auth::haspermission( $self->userid, $flagsrequired );
1898 =head3 is_superlibrarian
1900 my $is_superlibrarian = $patron->is_superlibrarian;
1902 Return true if the patron is a superlibrarian.
1906 sub is_superlibrarian {
1908 return $self->has_permission( { superlibrarian => 1 } ) ? 1 : 0;
1913 my $is_adult = $patron->is_adult
1915 Return true if the patron has a category with a type Adult (A) or Organization (I)
1921 return $self->category->category_type =~ /^(A|I)$/ ? 1 : 0;
1926 my $is_child = $patron->is_child
1928 Return true if the patron has a category with a type Child (C)
1934 return $self->category->category_type eq 'C' ? 1 : 0;
1937 =head3 has_valid_userid
1939 my $patron = Koha::Patrons->find(42);
1940 $patron->userid( $new_userid );
1941 my $has_a_valid_userid = $patron->has_valid_userid
1943 my $patron = Koha::Patron->new( $params );
1944 my $has_a_valid_userid = $patron->has_valid_userid
1946 Return true if the current userid of this patron is valid/unique, otherwise false.
1948 Note that this should be done in $self->store instead and raise an exception if needed.
1952 sub has_valid_userid {
1955 return 0 unless $self->userid;
1957 return 0 if ( $self->userid eq C4::Context->config('user') ); # DB user
1959 my $already_exists = Koha::Patrons->search(
1961 userid => $self->userid,
1964 ? ( borrowernumber => { '!=' => $self->borrowernumber } )
1969 return $already_exists ? 0 : 1;
1972 =head3 generate_userid
1974 $patron->generate_userid;
1976 If you do not have a plugin for generating a userid, we will call
1977 the internal method here that returns firstname.surname[.number],
1978 where number is an optional suffix to make the userid unique.
1979 (Its behavior has not been changed on bug 32426.)
1981 If you have plugin(s), the first valid response will be used.
1982 A plugin is assumed to return a valid userid as suggestion, but not
1983 assumed to save it already.
1984 Does not fallback to internal (you could arrange for that in your plugin).
1985 Clears userid when there are no valid plugin responses.
1989 sub generate_userid {
1991 my @responses = Koha::Plugins->call(
1992 'patron_generate_userid', { patron => $self },
1994 unless( @responses ) {
1995 # Empty list only possible when there are NO enabled plugins for this method.
1996 # In that case we provide internal response.
1997 return $self->_generate_userid_internal;
1999 # If a plugin returned false value or invalid value, we do however not return
2000 # internal response. The plugins should deal with that themselves. So we prevent
2001 # unexpected/unwelcome internal codes for plugin failures.
2002 foreach my $response ( grep { $_ } @responses ) {
2003 $self->userid( $response );
2004 return $self if $self->has_valid_userid;
2006 $self->userid(undef);
2010 sub _generate_userid_internal { # as we always did
2013 my $firstname = $self->firstname // q{};
2014 my $surname = $self->surname // q{};
2015 #The script will "do" the following code and increment the $offset until the generated userid is unique
2017 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
2018 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
2019 my $userid = lc(($firstname)? "$firstname.$surname" : $surname);
2020 $userid = NFKD( $userid );
2021 $userid =~ s/\p{NonspacingMark}//g;
2022 $userid .= $offset unless $offset == 0;
2023 $self->userid( $userid );
2025 } while (! $self->has_valid_userid );
2030 =head3 add_extended_attribute
2034 sub add_extended_attribute {
2035 my ($self, $attribute) = @_;
2037 return Koha::Patron::Attribute->new(
2040 ( borrowernumber => $self->borrowernumber ),
2046 =head3 extended_attributes
2048 Return object of Koha::Patron::Attributes type with all attributes set for this patron
2054 sub extended_attributes {
2055 my ( $self, $attributes ) = @_;
2056 if ($attributes) { # setter
2057 my $schema = $self->_result->result_source->schema;
2060 # Remove the existing one
2061 $self->extended_attributes->filter_by_branch_limitations->delete;
2063 # Insert the new ones
2065 for my $attribute (@$attributes) {
2066 $self->add_extended_attribute($attribute);
2067 $new_types->{$attribute->{code}} = 1;
2070 # Check globally mandatory types
2071 my @required_attribute_types =
2072 Koha::Patron::Attribute::Types->search(
2075 category_code => [ undef, $self->categorycode ],
2076 'borrower_attribute_types_branches.b_branchcode' =>
2079 { join => 'borrower_attribute_types_branches' }
2080 )->get_column('code');
2081 for my $type ( @required_attribute_types ) {
2082 Koha::Exceptions::Patron::MissingMandatoryExtendedAttribute->throw(
2084 ) if !$new_types->{$type};
2090 my $rs = $self->_result->borrower_attributes;
2091 # We call search to use the filters in Koha::Patron::Attributes->search
2092 return Koha::Patron::Attributes->_new_from_dbic($rs)->search;
2097 my $messages = $patron->messages;
2099 Return the message attached to the patron.
2105 my $messages_rs = $self->_result->messages_borrowernumbers->search;
2106 return Koha::Patron::Messages->_new_from_dbic($messages_rs);
2111 Koha::Patrons->find($id)->lock({ expire => 1, remove => 1 });
2113 Lock and optionally expire a patron account.
2114 Remove holds and article requests if remove flag set.
2115 In order to distinguish from locking by entering a wrong password, let's
2116 call this an administrative lockout.
2121 my ( $self, $params ) = @_;
2122 $self->login_attempts( ADMINISTRATIVE_LOCKOUT );
2123 if( $params->{expire} ) {
2124 $self->dateexpiry( dt_from_string->subtract(days => 1) );
2127 if( $params->{remove} ) {
2128 $self->holds->delete;
2129 $self->article_requests->delete;
2136 Koha::Patrons->find($id)->anonymize;
2138 Anonymize or clear borrower fields. Fields in BorrowerMandatoryField
2139 are randomized, other personal data is cleared too.
2140 Patrons with issues are skipped.
2146 if( $self->_result->issues->count ) {
2147 warn "Exiting anonymize: patron ".$self->borrowernumber." still has issues";
2150 # Mandatory fields come from the corresponding pref, but email fields
2151 # are removed since scrambled email addresses only generate errors
2152 my $mandatory = { map { (lc $_, 1); } grep { !/email/ }
2153 split /\s*\|\s*/, C4::Context->preference('BorrowerMandatoryField') };
2154 $mandatory->{userid} = 1; # needed since sub store does not clear field
2155 my @columns = $self->_result->result_source->columns;
2156 @columns = grep { !/borrowernumber|branchcode|categorycode|^date|password|flags|updated_on|lastseen|lang|login_attempts|anonymized|auth_method/ } @columns;
2157 push @columns, 'dateofbirth'; # add this date back in
2158 foreach my $col (@columns) {
2159 $self->_anonymize_column($col, $mandatory->{lc $col} );
2161 $self->anonymized(1)->store;
2164 sub _anonymize_column {
2165 my ( $self, $col, $mandatory ) = @_;
2166 my $col_info = $self->_result->result_source->column_info($col);
2167 my $type = $col_info->{data_type};
2168 my $nullable = $col_info->{is_nullable};
2170 if( $type =~ /char|text/ ) {
2172 ? Koha::Token->new->generate({ pattern => '\w{10}' })
2176 } elsif( $type =~ /integer|int$|float|dec|double/ ) {
2177 $val = $nullable ? undef : 0;
2178 } elsif( $type =~ /date|time/ ) {
2179 $val = $nullable ? undef : dt_from_string;
2184 =head3 add_guarantor
2186 my $relationship = $patron->add_guarantor(
2188 borrowernumber => $borrowernumber,
2189 relationships => $relationship,
2193 Adds a new guarantor to a patron.
2198 my ( $self, $params ) = @_;
2200 my $guarantor_id = $params->{guarantor_id};
2201 my $relationship = $params->{relationship};
2203 return Koha::Patron::Relationship->new(
2205 guarantee_id => $self->id,
2206 guarantor_id => $guarantor_id,
2207 relationship => $relationship
2212 =head3 get_extended_attribute
2214 my $attribute_value = $patron->get_extended_attribute( $code );
2216 Return the attribute for the code passed in parameter.
2218 It not exist it returns undef
2220 Note that this will not work for repeatable attribute types.
2222 Maybe you certainly not want to use this method, it is actually only used for SHOW_BARCODE
2223 (which should be a real patron's attribute (not extended)
2227 sub get_extended_attribute {
2228 my ( $self, $code, $value ) = @_;
2229 my $rs = $self->_result->borrower_attributes;
2231 my $attribute = $rs->search({ code => $code, ( $value ? ( attribute => $value ) : () ) });
2232 return unless $attribute->count;
2233 return $attribute->next;
2236 =head3 set_default_messaging_preferences
2238 $patron->set_default_messaging_preferences
2240 Sets default messaging preferences on patron.
2242 See Koha::Patron::MessagePreference(s) for more documentation, especially on
2247 sub set_default_messaging_preferences {
2248 my ($self, $categorycode) = @_;
2250 my $options = Koha::Patron::MessagePreferences->get_options;
2252 foreach my $option (@$options) {
2253 # Check that this option has preference configuration for this category
2254 unless (Koha::Patron::MessagePreferences->search({
2255 message_attribute_id => $option->{message_attribute_id},
2256 categorycode => $categorycode || $self->categorycode,
2261 # Delete current setting
2262 Koha::Patron::MessagePreferences->search({
2263 borrowernumber => $self->borrowernumber,
2264 message_attribute_id => $option->{message_attribute_id},
2267 Koha::Patron::MessagePreference->new_from_default({
2268 borrowernumber => $self->borrowernumber,
2269 categorycode => $categorycode || $self->categorycode,
2270 message_attribute_id => $option->{message_attribute_id},
2279 my $json = $patron->to_api;
2281 Overloaded method that returns a JSON representation of the Koha::Patron object,
2282 suitable for API output.
2287 my ( $self, $params ) = @_;
2289 my $json_patron = $self->SUPER::to_api( $params );
2291 return unless $json_patron;
2293 $json_patron->{restricted} = ( $self->is_debarred )
2295 : Mojo::JSON->false;
2297 return $json_patron;
2300 =head3 to_api_mapping
2302 This method returns the mapping for representing a Koha::Patron object
2307 sub to_api_mapping {
2309 borrowernotes => 'staff_notes',
2310 borrowernumber => 'patron_id',
2311 branchcode => 'library_id',
2312 categorycode => 'category_id',
2313 checkprevcheckout => 'check_previous_checkout',
2314 contactfirstname => undef, # Unused
2315 contactname => undef, # Unused
2316 contactnote => 'altaddress_notes',
2317 contacttitle => undef, # Unused
2318 dateenrolled => 'date_enrolled',
2319 dateexpiry => 'expiry_date',
2320 dateofbirth => 'date_of_birth',
2321 debarred => undef, # replaced by 'restricted'
2322 debarredcomment => undef, # calculated, API consumers will use /restrictions instead
2323 emailpro => 'secondary_email',
2324 flags => undef, # permissions manipulation handled in /permissions
2325 gonenoaddress => 'incorrect_address',
2326 lastseen => 'last_seen',
2327 lost => 'patron_card_lost',
2328 opacnote => 'opac_notes',
2329 othernames => 'other_name',
2330 password => undef, # password manipulation handled in /password
2331 phonepro => 'secondary_phone',
2332 relationship => 'relationship_type',
2334 smsalertnumber => 'sms_number',
2335 sort1 => 'statistics_1',
2336 sort2 => 'statistics_2',
2337 autorenew_checkouts => 'autorenew_checkouts',
2338 streetnumber => 'street_number',
2339 streettype => 'street_type',
2340 zipcode => 'postal_code',
2341 B_address => 'altaddress_address',
2342 B_address2 => 'altaddress_address2',
2343 B_city => 'altaddress_city',
2344 B_country => 'altaddress_country',
2345 B_email => 'altaddress_email',
2346 B_phone => 'altaddress_phone',
2347 B_state => 'altaddress_state',
2348 B_streetnumber => 'altaddress_street_number',
2349 B_streettype => 'altaddress_street_type',
2350 B_zipcode => 'altaddress_postal_code',
2351 altcontactaddress1 => 'altcontact_address',
2352 altcontactaddress2 => 'altcontact_address2',
2353 altcontactaddress3 => 'altcontact_city',
2354 altcontactcountry => 'altcontact_country',
2355 altcontactfirstname => 'altcontact_firstname',
2356 altcontactphone => 'altcontact_phone',
2357 altcontactsurname => 'altcontact_surname',
2358 altcontactstate => 'altcontact_state',
2359 altcontactzipcode => 'altcontact_postal_code',
2360 password_expiration_date => undef,
2361 primary_contact_method => undef,
2363 auth_method => undef,
2369 Koha::Patrons->queue_notice({ letter_params => $letter_params, message_name => 'DUE'});
2370 Koha::Patrons->queue_notice({ letter_params => $letter_params, message_transports => \@message_transports });
2371 Koha::Patrons->queue_notice({ letter_params => $letter_params, message_transports => \@message_transports, test_mode => 1 });
2373 Queue messages to a patron. Can pass a message that is part of the message_attributes
2374 table or supply the transport to use.
2376 If passed a message name we retrieve the patrons preferences for transports
2377 Otherwise we use the supplied transport. In the case of email or sms we fall back to print if
2378 we have no address/number for sending
2380 $letter_params is a hashref of the values to be passed to GetPreparedLetter
2382 test_mode will only report which notices would be sent, but nothing will be queued
2387 my ( $self, $params ) = @_;
2388 my $letter_params = $params->{letter_params};
2389 my $test_mode = $params->{test_mode};
2391 return unless $letter_params;
2392 return unless exists $params->{message_name} xor $params->{message_transports}; # We only want one of these
2394 my $library = Koha::Libraries->find( $letter_params->{branchcode} );
2395 my $from_email_address = $library->from_email_address;
2397 my @message_transports;
2399 $letter_code = $letter_params->{letter_code};
2400 if( $params->{message_name} ){
2401 my $messaging_prefs = C4::Members::Messaging::GetMessagingPreferences( {
2402 borrowernumber => $letter_params->{borrowernumber},
2403 message_name => $params->{message_name}
2405 @message_transports = ( keys %{ $messaging_prefs->{transports} } );
2406 $letter_code = $messaging_prefs->{transports}->{$message_transports[0]} unless $letter_code;
2408 @message_transports = @{$params->{message_transports}};
2410 return unless defined $letter_code;
2411 $letter_params->{letter_code} = $letter_code;
2414 foreach my $mtt (@message_transports){
2415 next if ($mtt eq 'itiva' and C4::Context->preference('TalkingTechItivaPhoneNotification') );
2416 # Notice is handled by TalkingTech_itiva_outbound.pl
2417 if ( ( $mtt eq 'email' and not $self->notice_email_address )
2418 or ( $mtt eq 'sms' and not $self->smsalertnumber )
2419 or ( $mtt eq 'phone' and not $self->phone ) )
2421 push @{ $return{fallback} }, $mtt;
2424 next if $mtt eq 'print' && $print_sent;
2425 $letter_params->{message_transport_type} = $mtt;
2426 my $letter = C4::Letters::GetPreparedLetter( %$letter_params );
2427 C4::Letters::EnqueueLetter({
2429 borrowernumber => $self->borrowernumber,
2430 from_address => $from_email_address,
2431 message_transport_type => $mtt
2432 }) unless $test_mode;
2433 push @{$return{sent}}, $mtt;
2434 $print_sent = 1 if $mtt eq 'print';
2439 =head3 safe_to_delete
2441 my $result = $patron->safe_to_delete;
2442 if ( $result eq 'has_guarantees' ) { ... }
2443 elsif ( $result ) { ... }
2444 else { # cannot delete }
2446 This method tells if the Koha:Patron object can be deleted. Possible return values
2452 =item 'has_checkouts'
2456 =item 'has_guarantees'
2458 =item 'is_anonymous_patron'
2464 sub safe_to_delete {
2467 my $anonymous_patron = C4::Context->preference('AnonymousPatron');
2471 if ( $anonymous_patron && $self->id eq $anonymous_patron ) {
2472 $error = 'is_anonymous_patron';
2474 elsif ( $self->checkouts->count ) {
2475 $error = 'has_checkouts';
2477 elsif ( $self->account->outstanding_debits->total_outstanding > 0 ) {
2478 $error = 'has_debt';
2480 elsif ( $self->guarantee_relationships->count ) {
2481 $error = 'has_guarantees';
2485 return Koha::Result::Boolean->new(0)->add_message({ message => $error });
2488 return Koha::Result::Boolean->new(1);
2493 my $recalls = $patron->recalls;
2495 Return the patron's recalls.
2502 return Koha::Recalls->search({ patron_id => $self->borrowernumber });
2505 =head3 account_balance
2507 my $balance = $patron->account_balance
2509 Return the patron's account balance
2513 sub account_balance {
2515 return $self->account->balance;
2518 =head3 notify_library_of_registration
2520 $patron->notify_library_of_registration( $email_patron_registrations );
2522 Send patron registration email to library if EmailPatronRegistrations system preference is enabled.
2526 sub notify_library_of_registration {
2527 my ( $self, $email_patron_registrations ) = @_;
2530 my $letter = C4::Letters::GetPreparedLetter(
2531 module => 'members',
2532 letter_code => 'OPAC_REG',
2533 branchcode => $self->branchcode,
2534 lang => $self->lang || 'default',
2536 'borrowers' => $self->borrowernumber
2541 if ( $email_patron_registrations eq "BranchEmailAddress" ) {
2542 my $library = Koha::Libraries->find( $self->branchcode );
2543 $to_address = $library->inbound_email_address;
2545 elsif ( $email_patron_registrations eq "KohaAdminEmailAddress" ) {
2546 $to_address = C4::Context->preference('ReplytoDefault')
2547 || C4::Context->preference('KohaAdminEmailAddress');
2551 C4::Context->preference('EmailAddressForPatronRegistrations')
2552 || C4::Context->preference('ReplytoDefault')
2553 || C4::Context->preference('KohaAdminEmailAddress');
2556 my $message_id = C4::Letters::EnqueueLetter(
2559 borrowernumber => $self->borrowernumber,
2560 to_address => $to_address,
2561 message_transport_type => 'email'
2563 ) or warn "can't enqueue letter $letter";
2564 if ( $message_id ) {
2570 =head3 has_messaging_preference
2572 my $bool = $patron->has_messaging_preference({
2573 message_name => $message_name, # A value from message_attributes.message_name
2574 message_transport_type => $message_transport_type, # email, sms, phone, itiva, etc...
2575 wants_digest => $wants_digest, # 1 if you are looking for the digest version, don't pass if you just want either
2580 sub has_messaging_preference {
2581 my ( $self, $params ) = @_;
2583 my $message_name = $params->{message_name};
2584 my $message_transport_type = $params->{message_transport_type};
2585 my $wants_digest = $params->{wants_digest};
2587 return $self->_result->search_related_rs(
2588 'borrower_message_preferences',
2592 [ 'borrower_message_transport_preferences', 'message_attribute' ]
2597 =head3 can_patron_change_staff_only_lists
2599 $patron->can_patron_change_staff_only_lists;
2601 Return 1 if a patron has 'Superlibrarian' or 'Catalogue' permission.
2602 Otherwise, return 0.
2606 sub can_patron_change_staff_only_lists {
2607 my ( $self, $params ) = @_;
2608 return 1 if C4::Auth::haspermission( $self->userid, { 'catalogue' => 1 });
2612 =head3 can_patron_change_permitted_staff_lists
2614 $patron->can_patron_change_permitted_staff_lists;
2616 Return 1 if a patron has 'Superlibrarian' or 'Catalogue' and 'edit_public_list_contents' permissions.
2617 Otherwise, return 0.
2621 sub can_patron_change_permitted_staff_lists {
2622 my ( $self, $params ) = @_;
2623 return 1 if C4::Auth::haspermission( $self->userid, { 'catalogue' => 1, lists => 'edit_public_list_contents' } );
2627 =head3 encode_secret
2629 $patron->encode_secret($secret32);
2631 Secret (TwoFactorAuth expects it in base32 format) is encrypted.
2632 You still need to call ->store.
2637 my ( $self, $secret ) = @_;
2639 return $self->secret( Koha::Encryption->new->encrypt_hex($secret) );
2641 return $self->secret($secret);
2644 =head3 decoded_secret
2646 my $secret32 = $patron->decoded_secret;
2648 Decode the patron secret. We expect to get back a base32 string, but this
2649 is not checked here. Caller of encode_secret is responsible for that.
2653 sub decoded_secret {
2655 if( $self->secret ) {
2656 return Koha::Encryption->new->decrypt_hex( $self->secret );
2658 return $self->secret;
2661 =head3 virtualshelves
2663 my $shelves = $patron->virtualshelves;
2667 sub virtualshelves {
2669 return Koha::Virtualshelves->_new_from_dbic( scalar $self->_result->virtualshelves );
2674 my $savings = $patron->get_savings;
2676 Use the replacement price of patron's old and current issues to calculate how much they have 'saved' by using the library.
2683 my @itemnumbers = grep { defined $_ } ( $self->old_checkouts->get_column('itemnumber'), $self->checkouts->get_column('itemnumber') );
2685 return Koha::Items->search(
2686 { itemnumber => { -in => \@itemnumbers } },
2687 { select => [ { sum => 'me.replacementprice' } ],
2688 as => ['total_savings']
2690 )->next->get_column('total_savings') // 0;
2693 =head3 alert_subscriptions
2695 my $subscriptions = $patron->alert_subscriptions;
2697 Return a Koha::Subscriptions object containing subscriptions for which the patron has subscribed to email alerts.
2701 sub alert_subscriptions {
2704 my @alerts = $self->_result->alerts;
2705 my @subscription_ids = map { $_->externalid } @alerts;
2707 return Koha::Subscriptions->search( { subscriptionid => \@subscription_ids } );
2712 my $consent = $patron->consent(TYPE);
2714 Returns the first consent of type TYPE (there should be only one) or a new instance
2715 of Koha::Patron::Consent.
2720 my ( $self, $type ) = @_;
2721 Koha::Exceptions::MissingParameter->throw('Missing consent type') if !$type;
2722 my $consents = Koha::Patron::Consents->search(
2724 borrowernumber => $self->borrowernumber,
2728 return $consents && $consents->count
2730 : Koha::Patron::Consent->new( { borrowernumber => $self->borrowernumber, type => $type } );
2733 =head2 Internal methods
2745 Kyle M Hall <kyle@bywatersolutions.com>
2746 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>
2747 Martin Renvoize <martin.renvoize@ptfs-europe.com>