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 under the
9 # terms of the GNU General Public License as published by the Free Software
10 # Foundation; either version 3 of the License, or (at your option) any later
13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License along
18 # with Koha; if not, write to the Free Software Foundation, Inc.,
19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 use List::MoreUtils qw( any uniq );
25 use JSON qw( to_json );
26 use Text::Unaccent qw( unac_string );
34 use Koha::Exceptions::Password;
36 use Koha::Old::Checkouts;
37 use Koha::Patron::Attributes;
38 use Koha::Patron::Categories;
39 use Koha::Patron::HouseboundProfile;
40 use Koha::Patron::HouseboundRole;
41 use Koha::Patron::Images;
43 use Koha::Virtualshelves;
44 use Koha::Club::Enrollments;
46 use Koha::Subscription::Routinglists;
49 use base qw(Koha::Object);
51 use constant ADMINISTRATIVE_LOCKOUT => -1;
53 our $RESULTSET_PATRON_ID_MAPPING = {
54 Accountline => 'borrowernumber',
55 Aqbasketuser => 'borrowernumber',
56 Aqbudget => 'budget_owner_id',
57 Aqbudgetborrower => 'borrowernumber',
58 ArticleRequest => 'borrowernumber',
59 BorrowerAttribute => 'borrowernumber',
60 BorrowerDebarment => 'borrowernumber',
61 BorrowerFile => 'borrowernumber',
62 BorrowerModification => 'borrowernumber',
63 ClubEnrollment => 'borrowernumber',
64 Issue => 'borrowernumber',
65 ItemsLastBorrower => 'borrowernumber',
66 Linktracker => 'borrowernumber',
67 Message => 'borrowernumber',
68 MessageQueue => 'borrowernumber',
69 OldIssue => 'borrowernumber',
70 OldReserve => 'borrowernumber',
71 Rating => 'borrowernumber',
72 Reserve => 'borrowernumber',
73 Review => 'borrowernumber',
74 SearchHistory => 'userid',
75 Statistic => 'borrowernumber',
76 Suggestion => 'suggestedby',
77 TagAll => 'borrowernumber',
78 Virtualshelfcontent => 'borrowernumber',
79 Virtualshelfshare => 'borrowernumber',
80 Virtualshelve => 'owner',
85 Koha::Patron - Koha Patron Object class
96 my ( $class, $params ) = @_;
98 return $class->SUPER::new($params);
101 =head3 fixup_cardnumber
103 Autogenerate next cardnumber from highest value found in database
107 sub fixup_cardnumber {
109 my $max = Koha::Patrons->search({
110 cardnumber => {-regexp => '^-?[0-9]+$'}
112 select => \'CAST(cardnumber AS SIGNED)',
113 as => ['cast_cardnumber']
114 })->_resultset->get_column('cast_cardnumber')->max;
115 $self->cardnumber(($max || 0) +1);
118 =head3 trim_whitespace
120 trim whitespace from data which has some non-whitespace in it.
121 Could be moved to Koha::Object if need to be reused
125 sub trim_whitespaces {
128 my $schema = Koha::Database->new->schema;
129 my @columns = $schema->source($self->_type)->columns;
131 for my $column( @columns ) {
132 my $value = $self->$column;
133 if ( defined $value ) {
134 $value =~ s/^\s*|\s*$//g;
135 $self->$column($value);
141 =head3 plain_text_password
143 $patron->plain_text_password( $password );
145 stores a copy of the unencrypted password in the object
146 for use in code before encrypting for db
150 sub plain_text_password {
151 my ( $self, $password ) = @_;
153 $self->{_plain_text_password} = $password;
156 return $self->{_plain_text_password}
157 if $self->{_plain_text_password};
164 Patron specific store method to cleanup record
165 and do other necessary things before saving
173 $self->_result->result_source->schema->txn_do(
176 C4::Context->preference("autoMemberNum")
177 and ( not defined $self->cardnumber
178 or $self->cardnumber eq '' )
181 # Warning: The caller is responsible for locking the members table in write
182 # mode, to avoid database corruption.
183 # We are in a transaction but the table is not locked
184 $self->fixup_cardnumber;
187 unless( $self->category->in_storage ) {
188 Koha::Exceptions::Object::FKConstraint->throw(
189 broken_fk => 'categorycode',
190 value => $self->categorycode,
194 $self->trim_whitespaces;
196 # Set surname to uppercase if uppercasesurname is true
197 $self->surname( uc($self->surname) )
198 if C4::Context->preference("uppercasesurname");
200 unless ( $self->in_storage ) { #AddMember
202 # Generate a valid userid/login if needed
203 $self->generate_userid
204 if not $self->userid or not $self->has_valid_userid;
206 # Add expiration date if it isn't already there
207 unless ( $self->dateexpiry ) {
208 $self->dateexpiry( $self->category->get_expiry_date );
211 # Add enrollment date if it isn't already there
212 unless ( $self->dateenrolled ) {
213 $self->dateenrolled(dt_from_string);
216 # Set the privacy depending on the patron's category
217 my $default_privacy = $self->category->default_privacy || q{};
219 $default_privacy eq 'default' ? 1
220 : $default_privacy eq 'never' ? 2
221 : $default_privacy eq 'forever' ? 0
223 $self->privacy($default_privacy);
226 # Make a copy of the plain text password for later use
227 $self->plain_text_password( $self->password );
229 # Create a disabled account if no password provided
230 $self->password( $self->password
231 ? Koha::AuthUtils::hash_password( $self->password )
234 $self->borrowernumber(undef);
236 $self = $self->SUPER::store;
238 $self->add_enrolment_fee_if_needed;
240 logaction( "MEMBERS", "CREATE", $self->borrowernumber, "" )
241 if C4::Context->preference("BorrowersLog");
245 my $self_from_storage = $self->get_from_storage;
246 # FIXME We should not deal with that here, callers have to do this job
247 # Moved from ModMember to prevent regressions
248 unless ( $self->userid ) {
249 my $stored_userid = $self_from_storage->userid;
250 $self->userid($stored_userid);
253 # Password must be updated using $self->set_password
254 $self->password($self_from_storage->password);
256 if ( C4::Context->preference('FeeOnChangePatronCategory')
257 and $self->category->categorycode ne
258 $self_from_storage->category->categorycode )
260 $self->add_enrolment_fee_if_needed;
264 if ( C4::Context->preference("BorrowersLog") ) {
266 my $from_storage = $self_from_storage->unblessed;
267 my $from_object = $self->unblessed;
268 my @skip_fields = (qw/lastseen updated_on/);
269 for my $key ( keys %{$from_storage} ) {
270 next if any { /$key/ } @skip_fields;
273 !defined( $from_storage->{$key} )
274 && defined( $from_object->{$key} )
276 || ( defined( $from_storage->{$key} )
277 && !defined( $from_object->{$key} ) )
279 defined( $from_storage->{$key} )
280 && defined( $from_object->{$key} )
281 && ( $from_storage->{$key} ne
282 $from_object->{$key} )
287 before => $from_storage->{$key},
288 after => $from_object->{$key}
293 if ( defined($info) ) {
297 $self->borrowernumber,
300 { utf8 => 1, pretty => 1, canonical => 1 }
307 $self = $self->SUPER::store;
318 Delete patron's holds, lists and finally the patron.
320 Lists owned by the borrower are deleted, but entries from the borrower to
321 other lists are kept.
329 $self->_result->result_source->schema->txn_do(
331 # Delete Patron's holds
332 $self->holds->delete;
334 # Delete all lists and all shares of this borrower
335 # Consistent with the approach Koha uses on deleting individual lists
336 # Note that entries in virtualshelfcontents added by this borrower to
337 # lists of others will be handled by a table constraint: the borrower
338 # is set to NULL in those entries.
340 # We could handle the above deletes via a constraint too.
341 # But a new BZ report 11889 has been opened to discuss another approach.
342 # Instead of deleting we could also disown lists (based on a pref).
343 # In that way we could save shared and public lists.
344 # The current table constraints support that idea now.
345 # This pref should then govern the results of other routines/methods such as
346 # Koha::Virtualshelf->new->delete too.
347 # FIXME Could be $patron->get_lists
348 $_->delete for Koha::Virtualshelves->search( { owner => $self->borrowernumber } );
350 $deleted = $self->SUPER::delete;
352 logaction( "MEMBERS", "DELETE", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
361 my $patron_category = $patron->category
363 Return the patron category for this patron
369 return Koha::Patron::Category->_new_from_dbic( $self->_result->categorycode );
374 Returns a Koha::Patron object for this patron's guarantor
381 return unless $self->guarantorid();
383 return Koha::Patrons->find( $self->guarantorid() );
389 return scalar Koha::Patron::Images->find( $self->borrowernumber );
394 return Koha::Library->_new_from_dbic($self->_result->branchcode);
399 Returns the guarantees (list of Koha::Patron) of this patron
406 return Koha::Patrons->search( { guarantorid => $self->borrowernumber }, { order_by => { -asc => ['surname','firstname'] } } );
409 =head3 housebound_profile
411 Returns the HouseboundProfile associated with this patron.
415 sub housebound_profile {
417 my $profile = $self->_result->housebound_profile;
418 return Koha::Patron::HouseboundProfile->_new_from_dbic($profile)
423 =head3 housebound_role
425 Returns the HouseboundRole associated with this patron.
429 sub housebound_role {
432 my $role = $self->_result->housebound_role;
433 return Koha::Patron::HouseboundRole->_new_from_dbic($role) if ( $role );
439 Returns the siblings of this patron.
446 my $guarantor = $self->guarantor;
448 return unless $guarantor;
450 return Koha::Patrons->search(
454 '=' => $guarantor->id,
457 '!=' => $self->borrowernumber,
465 my $patron = Koha::Patrons->find($id);
466 $patron->merge_with( \@patron_ids );
468 This subroutine merges a list of patrons into the patron record. This is accomplished by finding
469 all related patron ids for the patrons to be merged in other tables and changing the ids to be that
470 of the keeper patron.
475 my ( $self, $patron_ids ) = @_;
477 my @patron_ids = @{ $patron_ids };
479 # Ensure the keeper isn't in the list of patrons to merge
480 @patron_ids = grep { $_ ne $self->id } @patron_ids;
482 my $schema = Koha::Database->new()->schema();
486 $self->_result->result_source->schema->txn_do( sub {
487 foreach my $patron_id (@patron_ids) {
488 my $patron = Koha::Patrons->find( $patron_id );
492 # Unbless for safety, the patron will end up being deleted
493 $results->{merged}->{$patron_id}->{patron} = $patron->unblessed;
495 while (my ($r, $field) = each(%$RESULTSET_PATRON_ID_MAPPING)) {
496 my $rs = $schema->resultset($r)->search({ $field => $patron_id });
497 $results->{merged}->{ $patron_id }->{updated}->{$r} = $rs->count();
498 $rs->update({ $field => $self->id });
501 $patron->move_to_deleted();
511 =head3 wants_check_for_previous_checkout
513 $wants_check = $patron->wants_check_for_previous_checkout;
515 Return 1 if Koha needs to perform PrevIssue checking, else 0.
519 sub wants_check_for_previous_checkout {
521 my $syspref = C4::Context->preference("checkPrevCheckout");
524 ## Hard syspref trumps all
525 return 1 if ($syspref eq 'hardyes');
526 return 0 if ($syspref eq 'hardno');
527 ## Now, patron pref trumps all
528 return 1 if ($self->checkprevcheckout eq 'yes');
529 return 0 if ($self->checkprevcheckout eq 'no');
531 # More complex: patron inherits -> determine category preference
532 my $checkPrevCheckoutByCat = $self->category->checkprevcheckout;
533 return 1 if ($checkPrevCheckoutByCat eq 'yes');
534 return 0 if ($checkPrevCheckoutByCat eq 'no');
536 # Finally: category preference is inherit, default to 0
537 if ($syspref eq 'softyes') {
544 =head3 do_check_for_previous_checkout
546 $do_check = $patron->do_check_for_previous_checkout($item);
548 Return 1 if the bib associated with $ITEM has previously been checked out to
549 $PATRON, 0 otherwise.
553 sub do_check_for_previous_checkout {
554 my ( $self, $item ) = @_;
556 # Find all items for bib and extract item numbers.
557 my @items = Koha::Items->search({biblionumber => $item->{biblionumber}});
559 foreach my $item (@items) {
560 push @item_nos, $item->itemnumber;
563 # Create (old)issues search criteria
565 borrowernumber => $self->borrowernumber,
566 itemnumber => \@item_nos,
569 # Check current issues table
570 my $issues = Koha::Checkouts->search($criteria);
571 return 1 if $issues->count; # 0 || N
573 # Check old issues table
574 my $old_issues = Koha::Old::Checkouts->search($criteria);
575 return $old_issues->count; # 0 || N
580 my $debarment_expiration = $patron->is_debarred;
582 Returns the date a patron debarment will expire, or undef if the patron is not
590 return unless $self->debarred;
591 return $self->debarred
592 if $self->debarred =~ '^9999'
593 or dt_from_string( $self->debarred ) > dt_from_string;
599 my $is_expired = $patron->is_expired;
601 Returns 1 if the patron is expired or 0;
607 return 0 unless $self->dateexpiry;
608 return 0 if $self->dateexpiry =~ '^9999';
609 return 1 if dt_from_string( $self->dateexpiry ) < dt_from_string->truncate( to => 'day' );
613 =head3 is_going_to_expire
615 my $is_going_to_expire = $patron->is_going_to_expire;
617 Returns 1 if the patron is going to expired, depending on the NotifyBorrowerDeparture pref or 0
621 sub is_going_to_expire {
624 my $delay = C4::Context->preference('NotifyBorrowerDeparture') || 0;
626 return 0 unless $delay;
627 return 0 unless $self->dateexpiry;
628 return 0 if $self->dateexpiry =~ '^9999';
629 return 1 if dt_from_string( $self->dateexpiry, undef, 'floating' )->subtract( days => $delay ) < dt_from_string(undef, undef, 'floating')->truncate( to => 'day' );
635 $patron->set_password({ password => $plain_text_password [, skip_validation => 1 ] });
637 Set the patron's password.
641 The passed string is validated against the current password enforcement policy.
642 Validation can be skipped by passing the I<skip_validation> parameter.
644 Exceptions are thrown if the password is not good enough.
648 =item Koha::Exceptions::Password::TooShort
650 =item Koha::Exceptions::Password::WhitespaceCharacters
652 =item Koha::Exceptions::Password::TooWeak
659 my ( $self, $args ) = @_;
661 my $password = $args->{password};
663 unless ( $args->{skip_validation} ) {
664 my ( $is_valid, $error ) = Koha::AuthUtils::is_password_valid( $password );
667 if ( $error eq 'too_short' ) {
668 my $min_length = C4::Context->preference('minPasswordLength');
669 $min_length = 3 if not $min_length or $min_length < 3;
671 my $password_length = length($password);
672 Koha::Exceptions::Password::TooShort->throw(
673 length => $password_length, min_length => $min_length );
675 elsif ( $error eq 'has_whitespaces' ) {
676 Koha::Exceptions::Password::WhitespaceCharacters->throw();
678 elsif ( $error eq 'too_weak' ) {
679 Koha::Exceptions::Password::TooWeak->throw();
684 my $digest = Koha::AuthUtils::hash_password($password);
686 { password => $digest,
691 logaction( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" )
692 if C4::Context->preference("BorrowersLog");
700 my $new_expiry_date = $patron->renew_account
702 Extending the subscription to the expiry date.
709 if ( C4::Context->preference('BorrowerRenewalPeriodBase') eq 'combination' ) {
710 $date = ( dt_from_string gt dt_from_string( $self->dateexpiry ) ) ? dt_from_string : dt_from_string( $self->dateexpiry );
713 C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry'
714 ? dt_from_string( $self->dateexpiry )
717 my $expiry_date = $self->category->get_expiry_date($date);
719 $self->dateexpiry($expiry_date);
720 $self->date_renewed( dt_from_string() );
723 $self->add_enrolment_fee_if_needed;
725 logaction( "MEMBERS", "RENEW", $self->borrowernumber, "Membership renewed" ) if C4::Context->preference("BorrowersLog");
726 return dt_from_string( $expiry_date )->truncate( to => 'day' );
731 my $has_overdues = $patron->has_overdues;
733 Returns the number of patron's overdues
739 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
740 return $self->_result->issues->search({ date_due => { '<' => $dtf->format_datetime( dt_from_string() ) } })->count;
745 $patron->track_login;
746 $patron->track_login({ force => 1 });
748 Tracks a (successful) login attempt.
749 The preference TrackLastPatronActivity must be enabled. Or you
750 should pass the force parameter.
755 my ( $self, $params ) = @_;
758 !C4::Context->preference('TrackLastPatronActivity');
759 $self->lastseen( dt_from_string() )->store;
762 =head3 move_to_deleted
764 my $is_moved = $patron->move_to_deleted;
766 Move a patron to the deletedborrowers table.
767 This can be done before deleting a patron, to make sure the data are not completely deleted.
771 sub move_to_deleted {
773 my $patron_infos = $self->unblessed;
774 delete $patron_infos->{updated_on}; #This ensures the updated_on date in deletedborrowers will be set to the current timestamp
775 return Koha::Database->new->schema->resultset('Deletedborrower')->create($patron_infos);
778 =head3 article_requests
780 my @requests = $borrower->article_requests();
781 my $requests = $borrower->article_requests();
783 Returns either a list of ArticleRequests objects,
784 or an ArtitleRequests object, depending on the
789 sub article_requests {
792 $self->{_article_requests} ||= Koha::ArticleRequests->search({ borrowernumber => $self->borrowernumber() });
794 return $self->{_article_requests};
797 =head3 article_requests_current
799 my @requests = $patron->article_requests_current
801 Returns the article requests associated with this patron that are incomplete
805 sub article_requests_current {
808 $self->{_article_requests_current} ||= Koha::ArticleRequests->search(
810 borrowernumber => $self->id(),
812 { status => Koha::ArticleRequest::Status::Pending },
813 { status => Koha::ArticleRequest::Status::Processing }
818 return $self->{_article_requests_current};
821 =head3 article_requests_finished
823 my @requests = $biblio->article_requests_finished
825 Returns the article requests associated with this patron that are completed
829 sub article_requests_finished {
830 my ( $self, $borrower ) = @_;
832 $self->{_article_requests_finished} ||= Koha::ArticleRequests->search(
834 borrowernumber => $self->id(),
836 { status => Koha::ArticleRequest::Status::Completed },
837 { status => Koha::ArticleRequest::Status::Canceled }
842 return $self->{_article_requests_finished};
845 =head3 add_enrolment_fee_if_needed
847 my $enrolment_fee = $patron->add_enrolment_fee_if_needed;
849 Add enrolment fee for a patron if needed.
853 sub add_enrolment_fee_if_needed {
855 my $enrolment_fee = $self->category->enrolmentfee;
856 if ( $enrolment_fee && $enrolment_fee > 0 ) {
857 $self->account->add_debit(
859 amount => $enrolment_fee,
860 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
861 interface => C4::Context->interface,
862 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
867 return $enrolment_fee || 0;
872 my $checkouts = $patron->checkouts
878 my $checkouts = $self->_result->issues;
879 return Koha::Checkouts->_new_from_dbic( $checkouts );
882 =head3 pending_checkouts
884 my $pending_checkouts = $patron->pending_checkouts
886 This method will return the same as $self->checkouts, but with a prefetch on
887 items, biblio and biblioitems.
889 It has been introduced to replaced the C4::Members::GetPendingIssues subroutine
891 It should not be used directly, prefer to access fields you need instead of
892 retrieving all these fields in one go.
896 sub pending_checkouts {
898 my $checkouts = $self->_result->issues->search(
902 { -desc => 'me.timestamp' },
903 { -desc => 'issuedate' },
904 { -desc => 'issue_id' }, # Sort by issue_id should be enough
906 prefetch => { item => { biblio => 'biblioitems' } },
909 return Koha::Checkouts->_new_from_dbic( $checkouts );
914 my $old_checkouts = $patron->old_checkouts
920 my $old_checkouts = $self->_result->old_issues;
921 return Koha::Old::Checkouts->_new_from_dbic( $old_checkouts );
926 my $overdue_items = $patron->get_overdues
928 Return the overdue items
934 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
935 return $self->checkouts->search(
937 'me.date_due' => { '<' => $dtf->format_datetime(dt_from_string) },
940 prefetch => { item => { biblio => 'biblioitems' } },
945 =head3 get_routing_lists
947 my @routinglists = $patron->get_routing_lists
949 Returns the routing lists a patron is subscribed to.
953 sub get_routing_lists {
955 my $routing_list_rs = $self->_result->subscriptionroutinglists;
956 return Koha::Subscription::Routinglists->_new_from_dbic($routing_list_rs);
961 my $age = $patron->get_age
963 Return the age of the patron
969 my $today_str = dt_from_string->strftime("%Y-%m-%d");
970 return unless $self->dateofbirth;
971 my $dob_str = dt_from_string( $self->dateofbirth )->strftime("%Y-%m-%d");
973 my ( $dob_y, $dob_m, $dob_d ) = split /-/, $dob_str;
974 my ( $today_y, $today_m, $today_d ) = split /-/, $today_str;
976 my $age = $today_y - $dob_y;
977 if ( $dob_m . $dob_d > $today_m . $today_d ) {
986 my $account = $patron->account
992 return Koha::Account->new( { patron_id => $self->borrowernumber } );
997 my $holds = $patron->holds
999 Return all the holds placed by this patron
1005 my $holds_rs = $self->_result->reserves->search( {}, { order_by => 'reservedate' } );
1006 return Koha::Holds->_new_from_dbic($holds_rs);
1011 my $old_holds = $patron->old_holds
1013 Return all the historical holds for this patron
1019 my $old_holds_rs = $self->_result->old_reserves->search( {}, { order_by => 'reservedate' } );
1020 return Koha::Old::Holds->_new_from_dbic($old_holds_rs);
1023 =head3 notice_email_address
1025 my $email = $patron->notice_email_address;
1027 Return the email address of patron used for notices.
1028 Returns the empty string if no email address.
1032 sub notice_email_address{
1035 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1036 # if syspref is set to 'first valid' (value == OFF), look up email address
1037 if ( $which_address eq 'OFF' ) {
1038 return $self->first_valid_email_address;
1041 return $self->$which_address || '';
1044 =head3 first_valid_email_address
1046 my $first_valid_email_address = $patron->first_valid_email_address
1048 Return the first valid email address for a patron.
1049 For now, the order is defined as email, emailpro, B_email.
1050 Returns the empty string if the borrower has no email addresses.
1054 sub first_valid_email_address {
1057 return $self->email() || $self->emailpro() || $self->B_email() || q{};
1060 =head3 get_club_enrollments
1064 sub get_club_enrollments {
1065 my ( $self, $return_scalar ) = @_;
1067 my $e = Koha::Club::Enrollments->search( { borrowernumber => $self->borrowernumber(), date_canceled => undef } );
1069 return $e if $return_scalar;
1071 return wantarray ? $e->as_list : $e;
1074 =head3 get_enrollable_clubs
1078 sub get_enrollable_clubs {
1079 my ( $self, $is_enrollable_from_opac, $return_scalar ) = @_;
1082 $params->{is_enrollable_from_opac} = $is_enrollable_from_opac
1083 if $is_enrollable_from_opac;
1084 $params->{is_email_required} = 0 unless $self->first_valid_email_address();
1086 $params->{borrower} = $self;
1088 my $e = Koha::Clubs->get_enrollable($params);
1090 return $e if $return_scalar;
1092 return wantarray ? $e->as_list : $e;
1095 =head3 account_locked
1097 my $is_locked = $patron->account_locked
1099 Return true if the patron has reached the maximum number of login attempts
1100 (see pref FailedLoginAttempts). If login_attempts is < 0, this is interpreted
1101 as an administrative lockout (independent of FailedLoginAttempts; see also
1102 Koha::Patron->lock).
1103 Otherwise return false.
1104 If the pref is not set (empty string, null or 0), the feature is considered as
1109 sub account_locked {
1111 my $FailedLoginAttempts = C4::Context->preference('FailedLoginAttempts');
1112 return 1 if $FailedLoginAttempts
1113 and $self->login_attempts
1114 and $self->login_attempts >= $FailedLoginAttempts;
1115 return 1 if ($self->login_attempts || 0) < 0; # administrative lockout
1119 =head3 can_see_patron_infos
1121 my $can_see = $patron->can_see_patron_infos( $patron );
1123 Return true if the patron (usually the logged in user) can see the patron's infos for a given patron
1127 sub can_see_patron_infos {
1128 my ( $self, $patron ) = @_;
1129 return unless $patron;
1130 return $self->can_see_patrons_from( $patron->library->branchcode );
1133 =head3 can_see_patrons_from
1135 my $can_see = $patron->can_see_patrons_from( $branchcode );
1137 Return true if the patron (usually the logged in user) can see the patron's infos from a given library
1141 sub can_see_patrons_from {
1142 my ( $self, $branchcode ) = @_;
1144 if ( $self->branchcode eq $branchcode ) {
1146 } elsif ( $self->has_permission( { borrowers => 'view_borrower_infos_from_any_libraries' } ) ) {
1148 } elsif ( my $library_groups = $self->library->library_groups ) {
1149 while ( my $library_group = $library_groups->next ) {
1150 if ( $library_group->parent->has_child( $branchcode ) ) {
1159 =head3 libraries_where_can_see_patrons
1161 my $libraries = $patron-libraries_where_can_see_patrons;
1163 Return the list of branchcodes(!) of libraries the patron is allowed to see other patron's infos.
1164 The branchcodes are arbitrarily returned sorted.
1165 We are supposing here that the object is related to the logged in patron (use of C4::Context::only_my_library)
1167 An empty array means no restriction, the patron can see patron's infos from any libraries.
1171 sub libraries_where_can_see_patrons {
1173 my $userenv = C4::Context->userenv;
1175 return () unless $userenv; # For tests, but userenv should be defined in tests...
1177 my @restricted_branchcodes;
1178 if (C4::Context::only_my_library) {
1179 push @restricted_branchcodes, $self->branchcode;
1183 $self->has_permission(
1184 { borrowers => 'view_borrower_infos_from_any_libraries' }
1188 my $library_groups = $self->library->library_groups({ ft_hide_patron_info => 1 });
1189 if ( $library_groups->count )
1191 while ( my $library_group = $library_groups->next ) {
1192 my $parent = $library_group->parent;
1193 if ( $parent->has_child( $self->branchcode ) ) {
1194 push @restricted_branchcodes, $parent->children->get_column('branchcode');
1199 @restricted_branchcodes = ( $self->branchcode ) unless @restricted_branchcodes;
1203 @restricted_branchcodes = grep { defined $_ } @restricted_branchcodes;
1204 @restricted_branchcodes = uniq(@restricted_branchcodes);
1205 @restricted_branchcodes = sort(@restricted_branchcodes);
1206 return @restricted_branchcodes;
1209 sub has_permission {
1210 my ( $self, $flagsrequired ) = @_;
1211 return unless $self->userid;
1212 # TODO code from haspermission needs to be moved here!
1213 return C4::Auth::haspermission( $self->userid, $flagsrequired );
1218 my $is_adult = $patron->is_adult
1220 Return true if the patron has a category with a type Adult (A) or Organization (I)
1226 return $self->category->category_type =~ /^(A|I)$/ ? 1 : 0;
1231 my $is_child = $patron->is_child
1233 Return true if the patron has a category with a type Child (C)
1239 return $self->category->category_type eq 'C' ? 1 : 0;
1242 =head3 has_valid_userid
1244 my $patron = Koha::Patrons->find(42);
1245 $patron->userid( $new_userid );
1246 my $has_a_valid_userid = $patron->has_valid_userid
1248 my $patron = Koha::Patron->new( $params );
1249 my $has_a_valid_userid = $patron->has_valid_userid
1251 Return true if the current userid of this patron is valid/unique, otherwise false.
1253 Note that this should be done in $self->store instead and raise an exception if needed.
1257 sub has_valid_userid {
1260 return 0 unless $self->userid;
1262 return 0 if ( $self->userid eq C4::Context->config('user') ); # DB user
1264 my $already_exists = Koha::Patrons->search(
1266 userid => $self->userid,
1269 ? ( borrowernumber => { '!=' => $self->borrowernumber } )
1274 return $already_exists ? 0 : 1;
1277 =head3 generate_userid
1279 my $patron = Koha::Patron->new( $params );
1280 $patron->generate_userid
1282 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
1284 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).
1288 sub generate_userid {
1291 my $firstname = $self->firstname // q{};
1292 my $surname = $self->surname // q{};
1293 #The script will "do" the following code and increment the $offset until the generated userid is unique
1295 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1296 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1297 my $userid = lc(($firstname)? "$firstname.$surname" : $surname);
1298 $userid = unac_string('utf-8',$userid);
1299 $userid .= $offset unless $offset == 0;
1300 $self->userid( $userid );
1302 } while (! $self->has_valid_userid );
1310 my $attributes = $patron->attributes
1312 Return object of Koha::Patron::Attributes type with all attributes set for this patron
1318 return Koha::Patron::Attributes->search({
1319 borrowernumber => $self->borrowernumber,
1320 branchcode => $self->branchcode,
1326 Koha::Patrons->find($id)->lock({ expire => 1, remove => 1 });
1328 Lock and optionally expire a patron account.
1329 Remove holds and article requests if remove flag set.
1330 In order to distinguish from locking by entering a wrong password, let's
1331 call this an administrative lockout.
1336 my ( $self, $params ) = @_;
1337 $self->login_attempts( ADMINISTRATIVE_LOCKOUT );
1338 if( $params->{expire} ) {
1339 $self->dateexpiry( dt_from_string->subtract(days => 1) );
1342 if( $params->{remove} ) {
1343 $self->holds->delete;
1344 $self->article_requests->delete;
1351 Koha::Patrons->find($id)->anonymize;
1353 Anonymize or clear borrower fields. Fields in BorrowerMandatoryField
1354 are randomized, other personal data is cleared too.
1355 Patrons with issues are skipped.
1361 if( $self->_result->issues->count ) {
1362 warn "Exiting anonymize: patron ".$self->borrowernumber." still has issues";
1365 # Mandatory fields come from the corresponding pref, but email fields
1366 # are removed since scrambled email addresses only generate errors
1367 my $mandatory = { map { (lc $_, 1); } grep { !/email/ }
1368 split /\s*\|\s*/, C4::Context->preference('BorrowerMandatoryField') };
1369 $mandatory->{userid} = 1; # needed since sub store does not clear field
1370 my @columns = $self->_result->result_source->columns;
1371 @columns = grep { !/borrowernumber|branchcode|categorycode|^date|password|flags|updated_on|lastseen|lang|login_attempts|anonymized/ } @columns;
1372 push @columns, 'dateofbirth'; # add this date back in
1373 foreach my $col (@columns) {
1374 $self->_anonymize_column($col, $mandatory->{lc $col} );
1376 $self->anonymized(1)->store;
1379 sub _anonymize_column {
1380 my ( $self, $col, $mandatory ) = @_;
1381 my $col_info = $self->_result->result_source->column_info($col);
1382 my $type = $col_info->{data_type};
1383 my $nullable = $col_info->{is_nullable};
1385 if( $type =~ /char|text/ ) {
1387 ? Koha::Token->new->generate({ pattern => '\w{10}' })
1391 } elsif( $type =~ /integer|int$|float|dec|double/ ) {
1392 $val = $nullable ? undef : 0;
1393 } elsif( $type =~ /date|time/ ) {
1394 $val = $nullable ? undef : dt_from_string;
1399 =head2 Internal methods
1411 Kyle M Hall <kyle@bywatersolutions.com>
1412 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>
1413 Martin Renvoize <martin.renvoize@ptfs-europe.com>