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>.
24 use List::MoreUtils qw( any uniq );
25 use JSON qw( to_json );
26 use Unicode::Normalize;
31 use Koha::ArticleRequests;
34 use Koha::Club::Enrollments;
37 use Koha::Exceptions::Password;
39 use Koha::Old::Checkouts;
40 use Koha::Patron::Attributes;
41 use Koha::Patron::Categories;
42 use Koha::Patron::Debarments;
43 use Koha::Patron::HouseboundProfile;
44 use Koha::Patron::HouseboundRole;
45 use Koha::Patron::Images;
46 use Koha::Patron::Modifications;
47 use Koha::Patron::Relationships;
50 use Koha::Subscription::Routinglists;
52 use Koha::Virtualshelves;
54 use base qw(Koha::Object);
56 use constant ADMINISTRATIVE_LOCKOUT => -1;
58 our $RESULTSET_PATRON_ID_MAPPING = {
59 Accountline => 'borrowernumber',
60 Aqbasketuser => 'borrowernumber',
61 Aqbudget => 'budget_owner_id',
62 Aqbudgetborrower => 'borrowernumber',
63 ArticleRequest => 'borrowernumber',
64 BorrowerAttribute => 'borrowernumber',
65 BorrowerDebarment => 'borrowernumber',
66 BorrowerFile => 'borrowernumber',
67 BorrowerModification => 'borrowernumber',
68 ClubEnrollment => 'borrowernumber',
69 Issue => 'borrowernumber',
70 ItemsLastBorrower => 'borrowernumber',
71 Linktracker => 'borrowernumber',
72 Message => 'borrowernumber',
73 MessageQueue => 'borrowernumber',
74 OldIssue => 'borrowernumber',
75 OldReserve => 'borrowernumber',
76 Rating => 'borrowernumber',
77 Reserve => 'borrowernumber',
78 Review => 'borrowernumber',
79 SearchHistory => 'userid',
80 Statistic => 'borrowernumber',
81 Suggestion => 'suggestedby',
82 TagAll => 'borrowernumber',
83 Virtualshelfcontent => 'borrowernumber',
84 Virtualshelfshare => 'borrowernumber',
85 Virtualshelve => 'owner',
90 Koha::Patron - Koha Patron Object class
101 my ( $class, $params ) = @_;
103 return $class->SUPER::new($params);
106 =head3 fixup_cardnumber
108 Autogenerate next cardnumber from highest value found in database
112 sub fixup_cardnumber {
114 my $max = Koha::Patrons->search({
115 cardnumber => {-regexp => '^-?[0-9]+$'}
117 select => \'CAST(cardnumber AS SIGNED)',
118 as => ['cast_cardnumber']
119 })->_resultset->get_column('cast_cardnumber')->max;
120 $self->cardnumber(($max || 0) +1);
123 =head3 trim_whitespace
125 trim whitespace from data which has some non-whitespace in it.
126 Could be moved to Koha::Object if need to be reused
130 sub trim_whitespaces {
133 my $schema = Koha::Database->new->schema;
134 my @columns = $schema->source($self->_type)->columns;
136 for my $column( @columns ) {
137 my $value = $self->$column;
138 if ( defined $value ) {
139 $value =~ s/^\s*|\s*$//g;
140 $self->$column($value);
146 =head3 plain_text_password
148 $patron->plain_text_password( $password );
150 stores a copy of the unencrypted password in the object
151 for use in code before encrypting for db
155 sub plain_text_password {
156 my ( $self, $password ) = @_;
158 $self->{_plain_text_password} = $password;
161 return $self->{_plain_text_password}
162 if $self->{_plain_text_password};
169 Patron specific store method to cleanup record
170 and do other necessary things before saving
178 $self->_result->result_source->schema->txn_do(
181 C4::Context->preference("autoMemberNum")
182 and ( not defined $self->cardnumber
183 or $self->cardnumber eq '' )
186 # Warning: The caller is responsible for locking the members table in write
187 # mode, to avoid database corruption.
188 # We are in a transaction but the table is not locked
189 $self->fixup_cardnumber;
192 unless( $self->category->in_storage ) {
193 Koha::Exceptions::Object::FKConstraint->throw(
194 broken_fk => 'categorycode',
195 value => $self->categorycode,
199 $self->trim_whitespaces;
201 # Set surname to uppercase if uppercasesurname is true
202 $self->surname( uc($self->surname) )
203 if C4::Context->preference("uppercasesurnames");
205 $self->relationship(undef) # We do not want to store an empty string in this field
206 if defined $self->relationship
207 and $self->relationship eq "";
209 unless ( $self->in_storage ) { #AddMember
211 # Generate a valid userid/login if needed
212 $self->generate_userid
213 if not $self->userid or not $self->has_valid_userid;
215 # Add expiration date if it isn't already there
216 unless ( $self->dateexpiry ) {
217 $self->dateexpiry( $self->category->get_expiry_date );
220 # Add enrollment date if it isn't already there
221 unless ( $self->dateenrolled ) {
222 $self->dateenrolled(dt_from_string);
225 # Set the privacy depending on the patron's category
226 my $default_privacy = $self->category->default_privacy || q{};
228 $default_privacy eq 'default' ? 1
229 : $default_privacy eq 'never' ? 2
230 : $default_privacy eq 'forever' ? 0
232 $self->privacy($default_privacy);
234 # Call any check_password plugins if password is passed
235 if ( C4::Context->config("enable_plugins") && $self->password ) {
236 my @plugins = Koha::Plugins->new()->GetPlugins({
237 method => 'check_password',
239 foreach my $plugin ( @plugins ) {
240 # This plugin hook will also be used by a plugin for the Norwegian national
241 # patron database. This is why we need to pass both the password and the
242 # borrowernumber to the plugin.
243 my $ret = $plugin->check_password(
245 password => $self->password,
246 borrowernumber => $self->borrowernumber
249 if ( $ret->{'error'} == 1 ) {
250 Koha::Exceptions::Password::Plugin->throw();
255 # Make a copy of the plain text password for later use
256 $self->plain_text_password( $self->password );
258 # Create a disabled account if no password provided
259 $self->password( $self->password
260 ? Koha::AuthUtils::hash_password( $self->password )
263 $self->borrowernumber(undef);
265 $self = $self->SUPER::store;
267 $self->add_enrolment_fee_if_needed(0);
269 logaction( "MEMBERS", "CREATE", $self->borrowernumber, "" )
270 if C4::Context->preference("BorrowersLog");
274 my $self_from_storage = $self->get_from_storage;
275 # FIXME We should not deal with that here, callers have to do this job
276 # Moved from ModMember to prevent regressions
277 unless ( $self->userid ) {
278 my $stored_userid = $self_from_storage->userid;
279 $self->userid($stored_userid);
282 # Password must be updated using $self->set_password
283 $self->password($self_from_storage->password);
285 if ( $self->category->categorycode ne
286 $self_from_storage->category->categorycode )
288 # Add enrolement fee on category change if required
289 $self->add_enrolment_fee_if_needed(1)
290 if C4::Context->preference('FeeOnChangePatronCategory');
292 # Clean up guarantors on category change if required
293 $self->guarantor_relationships->delete
294 if ( $self->category->category_type ne 'C'
295 && $self->category->category_type ne 'P' );
300 if ( C4::Context->preference("BorrowersLog") ) {
302 my $from_storage = $self_from_storage->unblessed;
303 my $from_object = $self->unblessed;
304 my @skip_fields = (qw/lastseen updated_on/);
305 for my $key ( keys %{$from_storage} ) {
306 next if any { /$key/ } @skip_fields;
309 !defined( $from_storage->{$key} )
310 && defined( $from_object->{$key} )
312 || ( defined( $from_storage->{$key} )
313 && !defined( $from_object->{$key} ) )
315 defined( $from_storage->{$key} )
316 && defined( $from_object->{$key} )
317 && ( $from_storage->{$key} ne
318 $from_object->{$key} )
323 before => $from_storage->{$key},
324 after => $from_object->{$key}
329 if ( defined($info) ) {
333 $self->borrowernumber,
336 { utf8 => 1, pretty => 1, canonical => 1 }
343 $self = $self->SUPER::store;
354 Delete patron's holds, lists and finally the patron.
356 Lists owned by the borrower are deleted, but entries from the borrower to
357 other lists are kept.
364 my $anonymous_patron = C4::Context->preference("AnonymousPatron");
365 Koha::Exceptions::Patron::FailedDeleteAnonymousPatron->throw() if $anonymous_patron && $self->id eq $anonymous_patron;
367 $self->_result->result_source->schema->txn_do(
369 # Cancel Patron's holds
370 my $holds = $self->holds;
371 while( my $hold = $holds->next ){
375 # Delete all lists and all shares of this borrower
376 # Consistent with the approach Koha uses on deleting individual lists
377 # Note that entries in virtualshelfcontents added by this borrower to
378 # lists of others will be handled by a table constraint: the borrower
379 # is set to NULL in those entries.
381 # We could handle the above deletes via a constraint too.
382 # But a new BZ report 11889 has been opened to discuss another approach.
383 # Instead of deleting we could also disown lists (based on a pref).
384 # In that way we could save shared and public lists.
385 # The current table constraints support that idea now.
386 # This pref should then govern the results of other routines/methods such as
387 # Koha::Virtualshelf->new->delete too.
388 # FIXME Could be $patron->get_lists
389 $_->delete for Koha::Virtualshelves->search( { owner => $self->borrowernumber } );
391 # We cannot have a FK on borrower_modifications.borrowernumber, the table is also used
393 $_->delete for Koha::Patron::Modifications->search( { borrowernumber => $self->borrowernumber } );
395 $self->SUPER::delete;
397 logaction( "MEMBERS", "DELETE", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
406 my $patron_category = $patron->category
408 Return the patron category for this patron
414 return Koha::Patron::Category->_new_from_dbic( $self->_result->categorycode );
424 return Koha::Patron::Images->find( $self->borrowernumber );
429 Returns a Koha::Library object representing the patron's home library.
435 return Koha::Library->_new_from_dbic($self->_result->branchcode);
440 Returns a Koha::SMS::Provider object representing the patron's SMS provider.
446 my $sms_provider_rs = $self->_result->sms_provider;
447 return unless $sms_provider_rs;
448 return Koha::SMS::Provider->_new_from_dbic($sms_provider_rs);
451 =head3 guarantor_relationships
453 Returns Koha::Patron::Relationships object for this patron's guarantors
455 Returns the set of relationships for the patrons that are guarantors for this patron.
457 This is returned instead of a Koha::Patron object because the guarantor
458 may not exist as a patron in Koha. If this is true, the guarantors name
459 exists in the Koha::Patron::Relationship object and will have no guarantor_id.
463 sub guarantor_relationships {
466 return Koha::Patron::Relationships->search( { guarantee_id => $self->id } );
469 =head3 guarantee_relationships
471 Returns Koha::Patron::Relationships object for this patron's guarantors
473 Returns the set of relationships for the patrons that are guarantees for this patron.
475 The method returns Koha::Patron::Relationship objects for the sake
476 of consistency with the guantors method.
477 A guarantee by definition must exist as a patron in Koha.
481 sub guarantee_relationships {
484 return Koha::Patron::Relationships->search(
485 { guarantor_id => $self->id },
487 prefetch => 'guarantee',
488 order_by => { -asc => [ 'guarantee.surname', 'guarantee.firstname' ] },
493 =head3 relationships_debt
495 Returns the amount owed by the patron's guarantors *and* the other guarantees of those guarantors
499 sub relationships_debt {
500 my ($self, $params) = @_;
502 my $include_guarantors = $params->{include_guarantors};
503 my $only_this_guarantor = $params->{only_this_guarantor};
504 my $include_this_patron = $params->{include_this_patron};
507 if ( $only_this_guarantor ) {
508 @guarantors = $self->guarantee_relationships->count ? ( $self ) : ();
509 Koha::Exceptions::BadParameter->throw( { parameter => 'only_this_guarantor' } ) unless @guarantors;
510 } elsif ( $self->guarantor_relationships->count ) {
511 # I am a guarantee, just get all my guarantors
512 @guarantors = $self->guarantor_relationships->guarantors;
514 # I am a guarantor, I need to get all the guarantors of all my guarantees
515 @guarantors = map { $_->guarantor_relationships->guarantors } $self->guarantee_relationships->guarantees;
518 my $non_issues_charges = 0;
519 my $seen = $include_this_patron ? {} : { $self->id => 1 }; # For tracking members already added to the total
520 foreach my $guarantor (@guarantors) {
521 $non_issues_charges += $guarantor->account->non_issues_charges if $include_guarantors && !$seen->{ $guarantor->id };
523 # We've added what the guarantor owes, not added in that guarantor's guarantees as well
524 my @guarantees = map { $_->guarantee } $guarantor->guarantee_relationships();
525 my $guarantees_non_issues_charges = 0;
526 foreach my $guarantee (@guarantees) {
527 next if $seen->{ $guarantee->id };
528 $guarantees_non_issues_charges += $guarantee->account->non_issues_charges;
529 # Mark this guarantee as seen so we don't double count a guarantee linked to multiple guarantors
530 $seen->{ $guarantee->id } = 1;
533 $non_issues_charges += $guarantees_non_issues_charges;
534 $seen->{ $guarantor->id } = 1;
537 return $non_issues_charges;
540 =head3 housebound_profile
542 Returns the HouseboundProfile associated with this patron.
546 sub housebound_profile {
548 my $profile = $self->_result->housebound_profile;
549 return Koha::Patron::HouseboundProfile->_new_from_dbic($profile)
554 =head3 housebound_role
556 Returns the HouseboundRole associated with this patron.
560 sub housebound_role {
563 my $role = $self->_result->housebound_role;
564 return Koha::Patron::HouseboundRole->_new_from_dbic($role) if ( $role );
570 Returns the siblings of this patron.
577 my @guarantors = $self->guarantor_relationships()->guarantors();
579 return unless @guarantors;
582 map { $_->guarantee_relationships()->guarantees() } @guarantors;
584 return unless @siblings;
588 grep { !$seen{ $_->id }++ && ( $_->id != $self->id ) } @siblings;
590 return wantarray ? @siblings : Koha::Patrons->search( { borrowernumber => { -in => [ map { $_->id } @siblings ] } } );
595 my $patron = Koha::Patrons->find($id);
596 $patron->merge_with( \@patron_ids );
598 This subroutine merges a list of patrons into the patron record. This is accomplished by finding
599 all related patron ids for the patrons to be merged in other tables and changing the ids to be that
600 of the keeper patron.
605 my ( $self, $patron_ids ) = @_;
607 my $anonymous_patron = C4::Context->preference("AnonymousPatron");
608 return if $anonymous_patron && $self->id eq $anonymous_patron;
610 my @patron_ids = @{ $patron_ids };
612 # Ensure the keeper isn't in the list of patrons to merge
613 @patron_ids = grep { $_ ne $self->id } @patron_ids;
615 my $schema = Koha::Database->new()->schema();
619 $self->_result->result_source->schema->txn_do( sub {
620 foreach my $patron_id (@patron_ids) {
622 next if $patron_id eq $anonymous_patron;
624 my $patron = Koha::Patrons->find( $patron_id );
628 # Unbless for safety, the patron will end up being deleted
629 $results->{merged}->{$patron_id}->{patron} = $patron->unblessed;
631 while (my ($r, $field) = each(%$RESULTSET_PATRON_ID_MAPPING)) {
632 my $rs = $schema->resultset($r)->search({ $field => $patron_id });
633 $results->{merged}->{ $patron_id }->{updated}->{$r} = $rs->count();
634 $rs->update({ $field => $self->id });
635 if ( $r eq 'BorrowerDebarment' ) {
636 Koha::Patron::Debarments::UpdateBorrowerDebarmentFlags($self->id);
640 $patron->move_to_deleted();
650 =head3 wants_check_for_previous_checkout
652 $wants_check = $patron->wants_check_for_previous_checkout;
654 Return 1 if Koha needs to perform PrevIssue checking, else 0.
658 sub wants_check_for_previous_checkout {
660 my $syspref = C4::Context->preference("checkPrevCheckout");
663 ## Hard syspref trumps all
664 return 1 if ($syspref eq 'hardyes');
665 return 0 if ($syspref eq 'hardno');
666 ## Now, patron pref trumps all
667 return 1 if ($self->checkprevcheckout eq 'yes');
668 return 0 if ($self->checkprevcheckout eq 'no');
670 # More complex: patron inherits -> determine category preference
671 my $checkPrevCheckoutByCat = $self->category->checkprevcheckout;
672 return 1 if ($checkPrevCheckoutByCat eq 'yes');
673 return 0 if ($checkPrevCheckoutByCat eq 'no');
675 # Finally: category preference is inherit, default to 0
676 if ($syspref eq 'softyes') {
683 =head3 do_check_for_previous_checkout
685 $do_check = $patron->do_check_for_previous_checkout($item);
687 Return 1 if the bib associated with $ITEM has previously been checked out to
688 $PATRON, 0 otherwise.
692 sub do_check_for_previous_checkout {
693 my ( $self, $item ) = @_;
696 my $biblio = Koha::Biblios->find( $item->{biblionumber} );
697 if ( $biblio->is_serial ) {
698 push @item_nos, $item->{itemnumber};
700 # Get all itemnumbers for given bibliographic record.
701 @item_nos = $biblio->items->get_column( 'itemnumber' );
704 # Create (old)issues search criteria
706 borrowernumber => $self->borrowernumber,
707 itemnumber => \@item_nos,
710 my $delay = C4::Context->preference('CheckPrevCheckoutDelay') || 0;
712 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
713 my $newer_than = dt_from_string()->subtract( days => $delay );
714 $criteria->{'returndate'} = { '>' => $dtf->format_datetime($newer_than), };
717 # Check current issues table
718 my $issues = Koha::Checkouts->search($criteria);
719 return 1 if $issues->count; # 0 || N
721 # Check old issues table
722 my $old_issues = Koha::Old::Checkouts->search($criteria);
723 return $old_issues->count; # 0 || N
728 my $debarment_expiration = $patron->is_debarred;
730 Returns the date a patron debarment will expire, or undef if the patron is not
738 return unless $self->debarred;
739 return $self->debarred
740 if $self->debarred =~ '^9999'
741 or dt_from_string( $self->debarred ) > dt_from_string;
747 my $is_expired = $patron->is_expired;
749 Returns 1 if the patron is expired or 0;
755 return 0 unless $self->dateexpiry;
756 return 0 if $self->dateexpiry =~ '^9999';
757 return 1 if dt_from_string( $self->dateexpiry ) < dt_from_string->truncate( to => 'day' );
761 =head3 is_going_to_expire
763 my $is_going_to_expire = $patron->is_going_to_expire;
765 Returns 1 if the patron is going to expired, depending on the NotifyBorrowerDeparture pref or 0
769 sub is_going_to_expire {
772 my $delay = C4::Context->preference('NotifyBorrowerDeparture') || 0;
774 return 0 unless $delay;
775 return 0 unless $self->dateexpiry;
776 return 0 if $self->dateexpiry =~ '^9999';
777 return 1 if dt_from_string( $self->dateexpiry, undef, 'floating' )->subtract( days => $delay ) < dt_from_string(undef, undef, 'floating')->truncate( to => 'day' );
783 $patron->set_password({ password => $plain_text_password [, skip_validation => 1 ] });
785 Set the patron's password.
789 The passed string is validated against the current password enforcement policy.
790 Validation can be skipped by passing the I<skip_validation> parameter.
792 Exceptions are thrown if the password is not good enough.
796 =item Koha::Exceptions::Password::TooShort
798 =item Koha::Exceptions::Password::WhitespaceCharacters
800 =item Koha::Exceptions::Password::TooWeak
802 =item Koha::Exceptions::Password::Plugin (if a "check password" plugin is enabled)
809 my ( $self, $args ) = @_;
811 my $password = $args->{password};
813 unless ( $args->{skip_validation} ) {
814 my ( $is_valid, $error ) = Koha::AuthUtils::is_password_valid( $password, $self->category );
817 if ( $error eq 'too_short' ) {
818 my $min_length = $self->category->effective_min_password_length;
819 $min_length = 3 if not $min_length or $min_length < 3;
821 my $password_length = length($password);
822 Koha::Exceptions::Password::TooShort->throw(
823 length => $password_length, min_length => $min_length );
825 elsif ( $error eq 'has_whitespaces' ) {
826 Koha::Exceptions::Password::WhitespaceCharacters->throw();
828 elsif ( $error eq 'too_weak' ) {
829 Koha::Exceptions::Password::TooWeak->throw();
834 if ( C4::Context->config("enable_plugins") ) {
835 # Call any check_password plugins
836 my @plugins = Koha::Plugins->new()->GetPlugins({
837 method => 'check_password',
839 foreach my $plugin ( @plugins ) {
840 # This plugin hook will also be used by a plugin for the Norwegian national
841 # patron database. This is why we need to pass both the password and the
842 # borrowernumber to the plugin.
843 my $ret = $plugin->check_password(
845 password => $password,
846 borrowernumber => $self->borrowernumber
849 # This plugin hook will also be used by a plugin for the Norwegian national
850 # patron database. This is why we need to call the actual plugins and then
851 # check skip_validation afterwards.
852 if ( $ret->{'error'} == 1 && !$args->{skip_validation} ) {
853 Koha::Exceptions::Password::Plugin->throw();
858 my $digest = Koha::AuthUtils::hash_password($password);
860 # We do not want to call $self->store and retrieve password from DB
861 $self->password($digest);
862 $self->login_attempts(0);
865 logaction( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" )
866 if C4::Context->preference("BorrowersLog");
874 my $new_expiry_date = $patron->renew_account
876 Extending the subscription to the expiry date.
883 if ( C4::Context->preference('BorrowerRenewalPeriodBase') eq 'combination' ) {
884 $date = ( dt_from_string gt dt_from_string( $self->dateexpiry ) ) ? dt_from_string : dt_from_string( $self->dateexpiry );
887 C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry'
888 ? dt_from_string( $self->dateexpiry )
891 my $expiry_date = $self->category->get_expiry_date($date);
893 $self->dateexpiry($expiry_date);
894 $self->date_renewed( dt_from_string() );
897 $self->add_enrolment_fee_if_needed(1);
899 logaction( "MEMBERS", "RENEW", $self->borrowernumber, "Membership renewed" ) if C4::Context->preference("BorrowersLog");
900 return dt_from_string( $expiry_date )->truncate( to => 'day' );
905 my $has_overdues = $patron->has_overdues;
907 Returns the number of patron's overdues
913 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
914 return $self->_result->issues->search({ date_due => { '<' => $dtf->format_datetime( dt_from_string() ) } })->count;
919 $patron->track_login;
920 $patron->track_login({ force => 1 });
922 Tracks a (successful) login attempt.
923 The preference TrackLastPatronActivity must be enabled. Or you
924 should pass the force parameter.
929 my ( $self, $params ) = @_;
932 !C4::Context->preference('TrackLastPatronActivity');
933 $self->lastseen( dt_from_string() )->store;
936 =head3 move_to_deleted
938 my $is_moved = $patron->move_to_deleted;
940 Move a patron to the deletedborrowers table.
941 This can be done before deleting a patron, to make sure the data are not completely deleted.
945 sub move_to_deleted {
947 my $patron_infos = $self->unblessed;
948 delete $patron_infos->{updated_on}; #This ensures the updated_on date in deletedborrowers will be set to the current timestamp
949 return Koha::Database->new->schema->resultset('Deletedborrower')->create($patron_infos);
952 =head3 article_requests
954 my @requests = $borrower->article_requests();
955 my $requests = $borrower->article_requests();
957 Returns either a list of ArticleRequests objects,
958 or an ArtitleRequests object, depending on the
963 sub article_requests {
966 $self->{_article_requests} ||= Koha::ArticleRequests->search({ borrowernumber => $self->borrowernumber() });
968 return $self->{_article_requests};
971 =head3 article_requests_current
973 my @requests = $patron->article_requests_current
975 Returns the article requests associated with this patron that are incomplete
979 sub article_requests_current {
982 $self->{_article_requests_current} ||= Koha::ArticleRequests->search(
984 borrowernumber => $self->id(),
986 { status => Koha::ArticleRequest::Status::Pending },
987 { status => Koha::ArticleRequest::Status::Processing }
992 return $self->{_article_requests_current};
995 =head3 article_requests_finished
997 my @requests = $biblio->article_requests_finished
999 Returns the article requests associated with this patron that are completed
1003 sub article_requests_finished {
1004 my ( $self, $borrower ) = @_;
1006 $self->{_article_requests_finished} ||= Koha::ArticleRequests->search(
1008 borrowernumber => $self->id(),
1010 { status => Koha::ArticleRequest::Status::Completed },
1011 { status => Koha::ArticleRequest::Status::Canceled }
1016 return $self->{_article_requests_finished};
1019 =head3 add_enrolment_fee_if_needed
1021 my $enrolment_fee = $patron->add_enrolment_fee_if_needed($renewal);
1023 Add enrolment fee for a patron if needed.
1025 $renewal - boolean denoting whether this is an account renewal or not
1029 sub add_enrolment_fee_if_needed {
1030 my ($self, $renewal) = @_;
1031 my $enrolment_fee = $self->category->enrolmentfee;
1032 if ( $enrolment_fee && $enrolment_fee > 0 ) {
1033 my $type = $renewal ? 'ACCOUNT_RENEW' : 'ACCOUNT';
1034 $self->account->add_debit(
1036 amount => $enrolment_fee,
1037 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
1038 interface => C4::Context->interface,
1039 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
1044 return $enrolment_fee || 0;
1049 my $checkouts = $patron->checkouts
1055 my $checkouts = $self->_result->issues;
1056 return Koha::Checkouts->_new_from_dbic( $checkouts );
1059 =head3 pending_checkouts
1061 my $pending_checkouts = $patron->pending_checkouts
1063 This method will return the same as $self->checkouts, but with a prefetch on
1064 items, biblio and biblioitems.
1066 It has been introduced to replaced the C4::Members::GetPendingIssues subroutine
1068 It should not be used directly, prefer to access fields you need instead of
1069 retrieving all these fields in one go.
1073 sub pending_checkouts {
1075 my $checkouts = $self->_result->issues->search(
1079 { -desc => 'me.timestamp' },
1080 { -desc => 'issuedate' },
1081 { -desc => 'issue_id' }, # Sort by issue_id should be enough
1083 prefetch => { item => { biblio => 'biblioitems' } },
1086 return Koha::Checkouts->_new_from_dbic( $checkouts );
1089 =head3 old_checkouts
1091 my $old_checkouts = $patron->old_checkouts
1097 my $old_checkouts = $self->_result->old_issues;
1098 return Koha::Old::Checkouts->_new_from_dbic( $old_checkouts );
1103 my $overdue_items = $patron->get_overdues
1105 Return the overdue items
1111 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
1112 return $self->checkouts->search(
1114 'me.date_due' => { '<' => $dtf->format_datetime(dt_from_string) },
1117 prefetch => { item => { biblio => 'biblioitems' } },
1122 =head3 get_routing_lists
1124 my @routinglists = $patron->get_routing_lists
1126 Returns the routing lists a patron is subscribed to.
1130 sub get_routing_lists {
1132 my $routing_list_rs = $self->_result->subscriptionroutinglists;
1133 return Koha::Subscription::Routinglists->_new_from_dbic($routing_list_rs);
1138 my $age = $patron->get_age
1140 Return the age of the patron
1146 my $today_str = dt_from_string->strftime("%Y-%m-%d");
1147 return unless $self->dateofbirth;
1148 my $dob_str = dt_from_string( $self->dateofbirth )->strftime("%Y-%m-%d");
1150 my ( $dob_y, $dob_m, $dob_d ) = split /-/, $dob_str;
1151 my ( $today_y, $today_m, $today_d ) = split /-/, $today_str;
1153 my $age = $today_y - $dob_y;
1154 if ( $dob_m . $dob_d > $today_m . $today_d ) {
1163 my $is_valid = $patron->is_valid_age
1165 Return 1 if patron's age is between allowed limits, returns 0 if it's not.
1171 my $age = $self->get_age;
1173 my $patroncategory = $self->category;
1174 my ($low,$high) = ($patroncategory->dateofbirthrequired, $patroncategory->upperagelimit);
1176 return (defined($age) && (($high && ($age > $high)) or ($low && ($age < $low)))) ? 0 : 1;
1181 my $account = $patron->account
1187 return Koha::Account->new( { patron_id => $self->borrowernumber } );
1192 my $holds = $patron->holds
1194 Return all the holds placed by this patron
1200 my $holds_rs = $self->_result->reserves->search( {}, { order_by => 'reservedate' } );
1201 return Koha::Holds->_new_from_dbic($holds_rs);
1206 my $old_holds = $patron->old_holds
1208 Return all the historical holds for this patron
1214 my $old_holds_rs = $self->_result->old_reserves->search( {}, { order_by => 'reservedate' } );
1215 return Koha::Old::Holds->_new_from_dbic($old_holds_rs);
1218 =head3 return_claims
1220 my $return_claims = $patron->return_claims
1226 my $return_claims = $self->_result->return_claims_borrowernumbers;
1227 return Koha::Checkouts::ReturnClaims->_new_from_dbic( $return_claims );
1230 =head3 notice_email_address
1232 my $email = $patron->notice_email_address;
1234 Return the email address of patron used for notices.
1235 Returns the empty string if no email address.
1239 sub notice_email_address{
1242 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1243 # if syspref is set to 'first valid' (value == OFF), look up email address
1244 if ( $which_address eq 'OFF' ) {
1245 return $self->first_valid_email_address;
1248 return $self->$which_address || '';
1251 =head3 first_valid_email_address
1253 my $first_valid_email_address = $patron->first_valid_email_address
1255 Return the first valid email address for a patron.
1256 For now, the order is defined as email, emailpro, B_email.
1257 Returns the empty string if the borrower has no email addresses.
1261 sub first_valid_email_address {
1264 return $self->email() || $self->emailpro() || $self->B_email() || q{};
1267 =head3 get_club_enrollments
1271 sub get_club_enrollments {
1272 my ( $self, $return_scalar ) = @_;
1274 my $e = Koha::Club::Enrollments->search( { borrowernumber => $self->borrowernumber(), date_canceled => undef } );
1276 return $e if $return_scalar;
1278 return wantarray ? $e->as_list : $e;
1281 =head3 get_enrollable_clubs
1285 sub get_enrollable_clubs {
1286 my ( $self, $is_enrollable_from_opac, $return_scalar ) = @_;
1289 $params->{is_enrollable_from_opac} = $is_enrollable_from_opac
1290 if $is_enrollable_from_opac;
1291 $params->{is_email_required} = 0 unless $self->first_valid_email_address();
1293 $params->{borrower} = $self;
1295 my $e = Koha::Clubs->get_enrollable($params);
1297 return $e if $return_scalar;
1299 return wantarray ? $e->as_list : $e;
1302 =head3 account_locked
1304 my $is_locked = $patron->account_locked
1306 Return true if the patron has reached the maximum number of login attempts
1307 (see pref FailedLoginAttempts). If login_attempts is < 0, this is interpreted
1308 as an administrative lockout (independent of FailedLoginAttempts; see also
1309 Koha::Patron->lock).
1310 Otherwise return false.
1311 If the pref is not set (empty string, null or 0), the feature is considered as
1316 sub account_locked {
1318 my $FailedLoginAttempts = C4::Context->preference('FailedLoginAttempts');
1319 return 1 if $FailedLoginAttempts
1320 and $self->login_attempts
1321 and $self->login_attempts >= $FailedLoginAttempts;
1322 return 1 if ($self->login_attempts || 0) < 0; # administrative lockout
1326 =head3 can_see_patron_infos
1328 my $can_see = $patron->can_see_patron_infos( $patron );
1330 Return true if the patron (usually the logged in user) can see the patron's infos for a given patron
1334 sub can_see_patron_infos {
1335 my ( $self, $patron ) = @_;
1336 return unless $patron;
1337 return $self->can_see_patrons_from( $patron->library->branchcode );
1340 =head3 can_see_patrons_from
1342 my $can_see = $patron->can_see_patrons_from( $branchcode );
1344 Return true if the patron (usually the logged in user) can see the patron's infos from a given library
1348 sub can_see_patrons_from {
1349 my ( $self, $branchcode ) = @_;
1351 if ( $self->branchcode eq $branchcode ) {
1353 } elsif ( $self->has_permission( { borrowers => 'view_borrower_infos_from_any_libraries' } ) ) {
1355 } elsif ( my $library_groups = $self->library->library_groups ) {
1356 while ( my $library_group = $library_groups->next ) {
1357 if ( $library_group->parent->has_child( $branchcode ) ) {
1366 =head3 libraries_where_can_see_patrons
1368 my $libraries = $patron-libraries_where_can_see_patrons;
1370 Return the list of branchcodes(!) of libraries the patron is allowed to see other patron's infos.
1371 The branchcodes are arbitrarily returned sorted.
1372 We are supposing here that the object is related to the logged in patron (use of C4::Context::only_my_library)
1374 An empty array means no restriction, the patron can see patron's infos from any libraries.
1378 sub libraries_where_can_see_patrons {
1380 my $userenv = C4::Context->userenv;
1382 return () unless $userenv; # For tests, but userenv should be defined in tests...
1384 my @restricted_branchcodes;
1385 if (C4::Context::only_my_library) {
1386 push @restricted_branchcodes, $self->branchcode;
1390 $self->has_permission(
1391 { borrowers => 'view_borrower_infos_from_any_libraries' }
1395 my $library_groups = $self->library->library_groups({ ft_hide_patron_info => 1 });
1396 if ( $library_groups->count )
1398 while ( my $library_group = $library_groups->next ) {
1399 my $parent = $library_group->parent;
1400 if ( $parent->has_child( $self->branchcode ) ) {
1401 push @restricted_branchcodes, $parent->children->get_column('branchcode');
1406 @restricted_branchcodes = ( $self->branchcode ) unless @restricted_branchcodes;
1410 @restricted_branchcodes = grep { defined $_ } @restricted_branchcodes;
1411 @restricted_branchcodes = uniq(@restricted_branchcodes);
1412 @restricted_branchcodes = sort(@restricted_branchcodes);
1413 return @restricted_branchcodes;
1416 =head3 has_permission
1418 my $permission = $patron->has_permission($required);
1420 See C4::Auth::haspermission for details of syntax for $required
1424 sub has_permission {
1425 my ( $self, $flagsrequired ) = @_;
1426 return unless $self->userid;
1427 # TODO code from haspermission needs to be moved here!
1428 return C4::Auth::haspermission( $self->userid, $flagsrequired );
1431 =head3 is_superlibrarian
1433 my $is_superlibrarian = $patron->is_superlibrarian;
1435 Return true if the patron is a superlibrarian.
1439 sub is_superlibrarian {
1441 return $self->has_permission( { superlibrarian => 1 } ) ? 1 : 0;
1446 my $is_adult = $patron->is_adult
1448 Return true if the patron has a category with a type Adult (A) or Organization (I)
1454 return $self->category->category_type =~ /^(A|I)$/ ? 1 : 0;
1459 my $is_child = $patron->is_child
1461 Return true if the patron has a category with a type Child (C)
1467 return $self->category->category_type eq 'C' ? 1 : 0;
1470 =head3 has_valid_userid
1472 my $patron = Koha::Patrons->find(42);
1473 $patron->userid( $new_userid );
1474 my $has_a_valid_userid = $patron->has_valid_userid
1476 my $patron = Koha::Patron->new( $params );
1477 my $has_a_valid_userid = $patron->has_valid_userid
1479 Return true if the current userid of this patron is valid/unique, otherwise false.
1481 Note that this should be done in $self->store instead and raise an exception if needed.
1485 sub has_valid_userid {
1488 return 0 unless $self->userid;
1490 return 0 if ( $self->userid eq C4::Context->config('user') ); # DB user
1492 my $already_exists = Koha::Patrons->search(
1494 userid => $self->userid,
1497 ? ( borrowernumber => { '!=' => $self->borrowernumber } )
1502 return $already_exists ? 0 : 1;
1505 =head3 generate_userid
1507 my $patron = Koha::Patron->new( $params );
1508 $patron->generate_userid
1510 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
1512 Set a generated userid ($firstname.$surname if there is a $firstname, or $surname if there is no value in $firstname) plus offset (0 if the $userid is unique, or a higher numeric value if not unique).
1516 sub generate_userid {
1519 my $firstname = $self->firstname // q{};
1520 my $surname = $self->surname // q{};
1521 #The script will "do" the following code and increment the $offset until the generated userid is unique
1523 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1524 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1525 my $userid = lc(($firstname)? "$firstname.$surname" : $surname);
1526 $userid = NFKD( $userid );
1527 $userid =~ s/\p{NonspacingMark}//g;
1528 $userid .= $offset unless $offset == 0;
1529 $self->userid( $userid );
1531 } while (! $self->has_valid_userid );
1536 =head3 add_extended_attribute
1540 sub add_extended_attribute {
1541 my ($self, $attribute) = @_;
1542 $attribute->{borrowernumber} = $self->borrowernumber;
1543 return Koha::Patron::Attribute->new($attribute)->store;
1546 =head3 extended_attributes
1548 Return object of Koha::Patron::Attributes type with all attributes set for this patron
1554 sub extended_attributes {
1555 my ( $self, $attributes ) = @_;
1556 if ($attributes) { # setter
1557 my $schema = $self->_result->result_source->schema;
1560 # Remove the existing one
1561 $self->extended_attributes->filter_by_branch_limitations->delete;
1563 # Insert the new ones
1564 for my $attribute (@$attributes) {
1566 $self->_result->create_related('borrower_attributes', $attribute);
1569 # 1 - Raise an exception
1570 # 2 - Execute in a transaction and don't save
1571 # or Insert anyway but display a message on the UI
1578 my $rs = $self->_result->borrower_attributes;
1579 # We call search to use the filters in Koha::Patron::Attributes->search
1580 return Koha::Patron::Attributes->_new_from_dbic($rs)->search;
1585 Koha::Patrons->find($id)->lock({ expire => 1, remove => 1 });
1587 Lock and optionally expire a patron account.
1588 Remove holds and article requests if remove flag set.
1589 In order to distinguish from locking by entering a wrong password, let's
1590 call this an administrative lockout.
1595 my ( $self, $params ) = @_;
1596 $self->login_attempts( ADMINISTRATIVE_LOCKOUT );
1597 if( $params->{expire} ) {
1598 $self->dateexpiry( dt_from_string->subtract(days => 1) );
1601 if( $params->{remove} ) {
1602 $self->holds->delete;
1603 $self->article_requests->delete;
1610 Koha::Patrons->find($id)->anonymize;
1612 Anonymize or clear borrower fields. Fields in BorrowerMandatoryField
1613 are randomized, other personal data is cleared too.
1614 Patrons with issues are skipped.
1620 if( $self->_result->issues->count ) {
1621 warn "Exiting anonymize: patron ".$self->borrowernumber." still has issues";
1624 # Mandatory fields come from the corresponding pref, but email fields
1625 # are removed since scrambled email addresses only generate errors
1626 my $mandatory = { map { (lc $_, 1); } grep { !/email/ }
1627 split /\s*\|\s*/, C4::Context->preference('BorrowerMandatoryField') };
1628 $mandatory->{userid} = 1; # needed since sub store does not clear field
1629 my @columns = $self->_result->result_source->columns;
1630 @columns = grep { !/borrowernumber|branchcode|categorycode|^date|password|flags|updated_on|lastseen|lang|login_attempts|anonymized/ } @columns;
1631 push @columns, 'dateofbirth'; # add this date back in
1632 foreach my $col (@columns) {
1633 $self->_anonymize_column($col, $mandatory->{lc $col} );
1635 $self->anonymized(1)->store;
1638 sub _anonymize_column {
1639 my ( $self, $col, $mandatory ) = @_;
1640 my $col_info = $self->_result->result_source->column_info($col);
1641 my $type = $col_info->{data_type};
1642 my $nullable = $col_info->{is_nullable};
1644 if( $type =~ /char|text/ ) {
1646 ? Koha::Token->new->generate({ pattern => '\w{10}' })
1650 } elsif( $type =~ /integer|int$|float|dec|double/ ) {
1651 $val = $nullable ? undef : 0;
1652 } elsif( $type =~ /date|time/ ) {
1653 $val = $nullable ? undef : dt_from_string;
1658 =head3 add_guarantor
1660 my @relationships = $patron->add_guarantor(
1662 borrowernumber => $borrowernumber,
1663 relationships => $relationship,
1667 Adds a new guarantor to a patron.
1672 my ( $self, $params ) = @_;
1674 my $guarantor_id = $params->{guarantor_id};
1675 my $relationship = $params->{relationship};
1677 return Koha::Patron::Relationship->new(
1679 guarantee_id => $self->id,
1680 guarantor_id => $guarantor_id,
1681 relationship => $relationship
1686 =head3 get_extended_attribute
1688 my $attribute_value = $patron->get_extended_attribute( $code );
1690 Return the attribute for the code passed in parameter.
1692 It not exist it returns undef
1694 Note that this will not work for repeatable attribute types.
1696 Maybe you certainly not want to use this method, it is actually only used for SHOW_BARCODE
1697 (which should be a real patron's attribute (not extended)
1701 sub get_extended_attribute {
1702 my ( $self, $code, $value ) = @_;
1703 my $rs = $self->_result->borrower_attributes;
1705 my $attribute = $rs->search({ code => $code, ( $value ? ( attribute => $value ) : () ) });
1706 return unless $attribute->count;
1707 return $attribute->next;
1712 my $json = $patron->to_api;
1714 Overloaded method that returns a JSON representation of the Koha::Patron object,
1715 suitable for API output.
1720 my ( $self, $params ) = @_;
1722 my $json_patron = $self->SUPER::to_api( $params );
1724 $json_patron->{restricted} = ( $self->is_debarred )
1726 : Mojo::JSON->false;
1728 return $json_patron;
1731 =head3 to_api_mapping
1733 This method returns the mapping for representing a Koha::Patron object
1738 sub to_api_mapping {
1740 borrowernotes => 'staff_notes',
1741 borrowernumber => 'patron_id',
1742 branchcode => 'library_id',
1743 categorycode => 'category_id',
1744 checkprevcheckout => 'check_previous_checkout',
1745 contactfirstname => undef, # Unused
1746 contactname => undef, # Unused
1747 contactnote => 'altaddress_notes',
1748 contacttitle => undef, # Unused
1749 dateenrolled => 'date_enrolled',
1750 dateexpiry => 'expiry_date',
1751 dateofbirth => 'date_of_birth',
1752 debarred => undef, # replaced by 'restricted'
1753 debarredcomment => undef, # calculated, API consumers will use /restrictions instead
1754 emailpro => 'secondary_email',
1755 flags => undef, # permissions manipulation handled in /permissions
1756 gonenoaddress => 'incorrect_address',
1757 guarantorid => 'guarantor_id',
1758 lastseen => 'last_seen',
1759 lost => 'patron_card_lost',
1760 opacnote => 'opac_notes',
1761 othernames => 'other_name',
1762 password => undef, # password manipulation handled in /password
1763 phonepro => 'secondary_phone',
1764 relationship => 'relationship_type',
1766 smsalertnumber => 'sms_number',
1767 sort1 => 'statistics_1',
1768 sort2 => 'statistics_2',
1769 autorenew_checkouts => 'autorenew_checkouts',
1770 streetnumber => 'street_number',
1771 streettype => 'street_type',
1772 zipcode => 'postal_code',
1773 B_address => 'altaddress_address',
1774 B_address2 => 'altaddress_address2',
1775 B_city => 'altaddress_city',
1776 B_country => 'altaddress_country',
1777 B_email => 'altaddress_email',
1778 B_phone => 'altaddress_phone',
1779 B_state => 'altaddress_state',
1780 B_streetnumber => 'altaddress_street_number',
1781 B_streettype => 'altaddress_street_type',
1782 B_zipcode => 'altaddress_postal_code',
1783 altcontactaddress1 => 'altcontact_address',
1784 altcontactaddress2 => 'altcontact_address2',
1785 altcontactaddress3 => 'altcontact_city',
1786 altcontactcountry => 'altcontact_country',
1787 altcontactfirstname => 'altcontact_firstname',
1788 altcontactphone => 'altcontact_phone',
1789 altcontactsurname => 'altcontact_surname',
1790 altcontactstate => 'altcontact_state',
1791 altcontactzipcode => 'altcontact_postal_code'
1795 =head2 Internal methods
1807 Kyle M Hall <kyle@bywatersolutions.com>
1808 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>
1809 Martin Renvoize <martin.renvoize@ptfs-europe.com>