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 # Cancel Patron's holds
332 my $holds = $self->holds;
333 while( my $hold = $holds->next ){
337 # Delete all lists and all shares of this borrower
338 # Consistent with the approach Koha uses on deleting individual lists
339 # Note that entries in virtualshelfcontents added by this borrower to
340 # lists of others will be handled by a table constraint: the borrower
341 # is set to NULL in those entries.
343 # We could handle the above deletes via a constraint too.
344 # But a new BZ report 11889 has been opened to discuss another approach.
345 # Instead of deleting we could also disown lists (based on a pref).
346 # In that way we could save shared and public lists.
347 # The current table constraints support that idea now.
348 # This pref should then govern the results of other routines/methods such as
349 # Koha::Virtualshelf->new->delete too.
350 # FIXME Could be $patron->get_lists
351 $_->delete for Koha
::Virtualshelves
->search( { owner
=> $self->borrowernumber } );
353 $deleted = $self->SUPER::delete;
355 logaction
( "MEMBERS", "DELETE", $self->borrowernumber, "" ) if C4
::Context
->preference("BorrowersLog");
364 my $patron_category = $patron->category
366 Return the patron category for this patron
372 return Koha
::Patron
::Category
->_new_from_dbic( $self->_result->categorycode );
377 Returns a Koha::Patron object for this patron's guarantor
384 return unless $self->guarantorid();
386 return Koha
::Patrons
->find( $self->guarantorid() );
392 return scalar Koha
::Patron
::Images
->find( $self->borrowernumber );
397 return Koha
::Library
->_new_from_dbic($self->_result->branchcode);
402 Returns the guarantees (list of Koha::Patron) of this patron
409 return Koha
::Patrons
->search( { guarantorid
=> $self->borrowernumber }, { order_by
=> { -asc
=> ['surname','firstname'] } } );
412 =head3 housebound_profile
414 Returns the HouseboundProfile associated with this patron.
418 sub housebound_profile
{
420 my $profile = $self->_result->housebound_profile;
421 return Koha
::Patron
::HouseboundProfile
->_new_from_dbic($profile)
426 =head3 housebound_role
428 Returns the HouseboundRole associated with this patron.
432 sub housebound_role
{
435 my $role = $self->_result->housebound_role;
436 return Koha
::Patron
::HouseboundRole
->_new_from_dbic($role) if ( $role );
442 Returns the siblings of this patron.
449 my $guarantor = $self->guarantor;
451 return unless $guarantor;
453 return Koha
::Patrons
->search(
457 '=' => $guarantor->id,
460 '!=' => $self->borrowernumber,
468 my $patron = Koha::Patrons->find($id);
469 $patron->merge_with( \@patron_ids );
471 This subroutine merges a list of patrons into the patron record. This is accomplished by finding
472 all related patron ids for the patrons to be merged in other tables and changing the ids to be that
473 of the keeper patron.
478 my ( $self, $patron_ids ) = @_;
480 my @patron_ids = @
{ $patron_ids };
482 # Ensure the keeper isn't in the list of patrons to merge
483 @patron_ids = grep { $_ ne $self->id } @patron_ids;
485 my $schema = Koha
::Database
->new()->schema();
489 $self->_result->result_source->schema->txn_do( sub {
490 foreach my $patron_id (@patron_ids) {
491 my $patron = Koha
::Patrons
->find( $patron_id );
495 # Unbless for safety, the patron will end up being deleted
496 $results->{merged
}->{$patron_id}->{patron
} = $patron->unblessed;
498 while (my ($r, $field) = each(%$RESULTSET_PATRON_ID_MAPPING)) {
499 my $rs = $schema->resultset($r)->search({ $field => $patron_id });
500 $results->{merged
}->{ $patron_id }->{updated
}->{$r} = $rs->count();
501 $rs->update({ $field => $self->id });
504 $patron->move_to_deleted();
514 =head3 wants_check_for_previous_checkout
516 $wants_check = $patron->wants_check_for_previous_checkout;
518 Return 1 if Koha needs to perform PrevIssue checking, else 0.
522 sub wants_check_for_previous_checkout
{
524 my $syspref = C4
::Context
->preference("checkPrevCheckout");
527 ## Hard syspref trumps all
528 return 1 if ($syspref eq 'hardyes');
529 return 0 if ($syspref eq 'hardno');
530 ## Now, patron pref trumps all
531 return 1 if ($self->checkprevcheckout eq 'yes');
532 return 0 if ($self->checkprevcheckout eq 'no');
534 # More complex: patron inherits -> determine category preference
535 my $checkPrevCheckoutByCat = $self->category->checkprevcheckout;
536 return 1 if ($checkPrevCheckoutByCat eq 'yes');
537 return 0 if ($checkPrevCheckoutByCat eq 'no');
539 # Finally: category preference is inherit, default to 0
540 if ($syspref eq 'softyes') {
547 =head3 do_check_for_previous_checkout
549 $do_check = $patron->do_check_for_previous_checkout($item);
551 Return 1 if the bib associated with $ITEM has previously been checked out to
552 $PATRON, 0 otherwise.
556 sub do_check_for_previous_checkout
{
557 my ( $self, $item ) = @_;
559 # Find all items for bib and extract item numbers.
560 my @items = Koha
::Items
->search({biblionumber
=> $item->{biblionumber
}});
562 foreach my $item (@items) {
563 push @item_nos, $item->itemnumber;
566 # Create (old)issues search criteria
568 borrowernumber
=> $self->borrowernumber,
569 itemnumber
=> \
@item_nos,
572 # Check current issues table
573 my $issues = Koha
::Checkouts
->search($criteria);
574 return 1 if $issues->count; # 0 || N
576 # Check old issues table
577 my $old_issues = Koha
::Old
::Checkouts
->search($criteria);
578 return $old_issues->count; # 0 || N
583 my $debarment_expiration = $patron->is_debarred;
585 Returns the date a patron debarment will expire, or undef if the patron is not
593 return unless $self->debarred;
594 return $self->debarred
595 if $self->debarred =~ '^9999'
596 or dt_from_string
( $self->debarred ) > dt_from_string
;
602 my $is_expired = $patron->is_expired;
604 Returns 1 if the patron is expired or 0;
610 return 0 unless $self->dateexpiry;
611 return 0 if $self->dateexpiry =~ '^9999';
612 return 1 if dt_from_string
( $self->dateexpiry ) < dt_from_string
->truncate( to
=> 'day' );
616 =head3 is_going_to_expire
618 my $is_going_to_expire = $patron->is_going_to_expire;
620 Returns 1 if the patron is going to expired, depending on the NotifyBorrowerDeparture pref or 0
624 sub is_going_to_expire
{
627 my $delay = C4
::Context
->preference('NotifyBorrowerDeparture') || 0;
629 return 0 unless $delay;
630 return 0 unless $self->dateexpiry;
631 return 0 if $self->dateexpiry =~ '^9999';
632 return 1 if dt_from_string
( $self->dateexpiry )->subtract( days
=> $delay ) < dt_from_string
->truncate( to
=> 'day' );
638 $patron->set_password({ password => $plain_text_password [, skip_validation => 1 ] });
640 Set the patron's password.
644 The passed string is validated against the current password enforcement policy.
645 Validation can be skipped by passing the I<skip_validation> parameter.
647 Exceptions are thrown if the password is not good enough.
651 =item Koha::Exceptions::Password::TooShort
653 =item Koha::Exceptions::Password::WhitespaceCharacters
655 =item Koha::Exceptions::Password::TooWeak
662 my ( $self, $args ) = @_;
664 my $password = $args->{password
};
666 unless ( $args->{skip_validation
} ) {
667 my ( $is_valid, $error ) = Koha
::AuthUtils
::is_password_valid
( $password );
670 if ( $error eq 'too_short' ) {
671 my $min_length = C4
::Context
->preference('minPasswordLength');
672 $min_length = 3 if not $min_length or $min_length < 3;
674 my $password_length = length($password);
675 Koha
::Exceptions
::Password
::TooShort
->throw(
676 length => $password_length, min_length
=> $min_length );
678 elsif ( $error eq 'has_whitespaces' ) {
679 Koha
::Exceptions
::Password
::WhitespaceCharacters
->throw();
681 elsif ( $error eq 'too_weak' ) {
682 Koha
::Exceptions
::Password
::TooWeak
->throw();
687 my $digest = Koha
::AuthUtils
::hash_password
($password);
689 { password
=> $digest,
694 logaction
( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" )
695 if C4
::Context
->preference("BorrowersLog");
703 my $new_expiry_date = $patron->renew_account
705 Extending the subscription to the expiry date.
712 if ( C4
::Context
->preference('BorrowerRenewalPeriodBase') eq 'combination' ) {
713 $date = ( dt_from_string
gt dt_from_string
( $self->dateexpiry ) ) ? dt_from_string
: dt_from_string
( $self->dateexpiry );
716 C4
::Context
->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry'
717 ? dt_from_string
( $self->dateexpiry )
720 my $expiry_date = $self->category->get_expiry_date($date);
722 $self->dateexpiry($expiry_date);
723 $self->date_renewed( dt_from_string
() );
726 $self->add_enrolment_fee_if_needed;
728 logaction
( "MEMBERS", "RENEW", $self->borrowernumber, "Membership renewed" ) if C4
::Context
->preference("BorrowersLog");
729 return dt_from_string
( $expiry_date )->truncate( to
=> 'day' );
734 my $has_overdues = $patron->has_overdues;
736 Returns the number of patron's overdues
742 my $dtf = Koha
::Database
->new->schema->storage->datetime_parser;
743 return $self->_result->issues->search({ date_due
=> { '<' => $dtf->format_datetime( dt_from_string
() ) } })->count;
748 $patron->track_login;
749 $patron->track_login({ force => 1 });
751 Tracks a (successful) login attempt.
752 The preference TrackLastPatronActivity must be enabled. Or you
753 should pass the force parameter.
758 my ( $self, $params ) = @_;
761 !C4
::Context
->preference('TrackLastPatronActivity');
762 $self->lastseen( dt_from_string
() )->store;
765 =head3 move_to_deleted
767 my $is_moved = $patron->move_to_deleted;
769 Move a patron to the deletedborrowers table.
770 This can be done before deleting a patron, to make sure the data are not completely deleted.
774 sub move_to_deleted
{
776 my $patron_infos = $self->unblessed;
777 delete $patron_infos->{updated_on
}; #This ensures the updated_on date in deletedborrowers will be set to the current timestamp
778 return Koha
::Database
->new->schema->resultset('Deletedborrower')->create($patron_infos);
781 =head3 article_requests
783 my @requests = $borrower->article_requests();
784 my $requests = $borrower->article_requests();
786 Returns either a list of ArticleRequests objects,
787 or an ArtitleRequests object, depending on the
792 sub article_requests
{
795 $self->{_article_requests
} ||= Koha
::ArticleRequests
->search({ borrowernumber
=> $self->borrowernumber() });
797 return $self->{_article_requests
};
800 =head3 article_requests_current
802 my @requests = $patron->article_requests_current
804 Returns the article requests associated with this patron that are incomplete
808 sub article_requests_current
{
811 $self->{_article_requests_current
} ||= Koha
::ArticleRequests
->search(
813 borrowernumber
=> $self->id(),
815 { status
=> Koha
::ArticleRequest
::Status
::Pending
},
816 { status
=> Koha
::ArticleRequest
::Status
::Processing
}
821 return $self->{_article_requests_current
};
824 =head3 article_requests_finished
826 my @requests = $biblio->article_requests_finished
828 Returns the article requests associated with this patron that are completed
832 sub article_requests_finished
{
833 my ( $self, $borrower ) = @_;
835 $self->{_article_requests_finished
} ||= Koha
::ArticleRequests
->search(
837 borrowernumber
=> $self->id(),
839 { status
=> Koha
::ArticleRequest
::Status
::Completed
},
840 { status
=> Koha
::ArticleRequest
::Status
::Canceled
}
845 return $self->{_article_requests_finished
};
848 =head3 add_enrolment_fee_if_needed
850 my $enrolment_fee = $patron->add_enrolment_fee_if_needed;
852 Add enrolment fee for a patron if needed.
856 sub add_enrolment_fee_if_needed
{
858 my $enrolment_fee = $self->category->enrolmentfee;
859 if ( $enrolment_fee && $enrolment_fee > 0 ) {
860 $self->account->add_debit(
862 amount
=> $enrolment_fee,
863 user_id
=> C4
::Context
->userenv ? C4
::Context
->userenv->{'number'} : undef,
864 interface
=> C4
::Context
->interface,
865 library_id
=> C4
::Context
->userenv ? C4
::Context
->userenv->{'branch'} : undef,
870 return $enrolment_fee || 0;
875 my $checkouts = $patron->checkouts
881 my $checkouts = $self->_result->issues;
882 return Koha
::Checkouts
->_new_from_dbic( $checkouts );
885 =head3 pending_checkouts
887 my $pending_checkouts = $patron->pending_checkouts
889 This method will return the same as $self->checkouts, but with a prefetch on
890 items, biblio and biblioitems.
892 It has been introduced to replaced the C4::Members::GetPendingIssues subroutine
894 It should not be used directly, prefer to access fields you need instead of
895 retrieving all these fields in one go.
899 sub pending_checkouts
{
901 my $checkouts = $self->_result->issues->search(
905 { -desc
=> 'me.timestamp' },
906 { -desc
=> 'issuedate' },
907 { -desc
=> 'issue_id' }, # Sort by issue_id should be enough
909 prefetch
=> { item
=> { biblio
=> 'biblioitems' } },
912 return Koha
::Checkouts
->_new_from_dbic( $checkouts );
917 my $old_checkouts = $patron->old_checkouts
923 my $old_checkouts = $self->_result->old_issues;
924 return Koha
::Old
::Checkouts
->_new_from_dbic( $old_checkouts );
929 my $overdue_items = $patron->get_overdues
931 Return the overdue items
937 my $dtf = Koha
::Database
->new->schema->storage->datetime_parser;
938 return $self->checkouts->search(
940 'me.date_due' => { '<' => $dtf->format_datetime(dt_from_string
) },
943 prefetch
=> { item
=> { biblio
=> 'biblioitems' } },
948 =head3 get_routing_lists
950 my @routinglists = $patron->get_routing_lists
952 Returns the routing lists a patron is subscribed to.
956 sub get_routing_lists
{
958 my $routing_list_rs = $self->_result->subscriptionroutinglists;
959 return Koha
::Subscription
::Routinglists
->_new_from_dbic($routing_list_rs);
964 my $age = $patron->get_age
966 Return the age of the patron
972 my $today_str = dt_from_string
->strftime("%Y-%m-%d");
973 return unless $self->dateofbirth;
974 my $dob_str = dt_from_string
( $self->dateofbirth )->strftime("%Y-%m-%d");
976 my ( $dob_y, $dob_m, $dob_d ) = split /-/, $dob_str;
977 my ( $today_y, $today_m, $today_d ) = split /-/, $today_str;
979 my $age = $today_y - $dob_y;
980 if ( $dob_m . $dob_d > $today_m . $today_d ) {
989 my $is_valid = $patron->is_valid_age
991 Return 1 if patron's age is between allowed limits, returns 0 if it's not.
997 my $age = $self->get_age;
999 my $patroncategory = $self->category;
1000 my ($low,$high) = ($patroncategory->dateofbirthrequired, $patroncategory->upperagelimit);
1002 return (defined($age) && (($high && ($age > $high)) or ($age < $low))) ?
0 : 1;
1007 my $account = $patron->account
1013 return Koha
::Account
->new( { patron_id
=> $self->borrowernumber } );
1018 my $holds = $patron->holds
1020 Return all the holds placed by this patron
1026 my $holds_rs = $self->_result->reserves->search( {}, { order_by
=> 'reservedate' } );
1027 return Koha
::Holds
->_new_from_dbic($holds_rs);
1032 my $old_holds = $patron->old_holds
1034 Return all the historical holds for this patron
1040 my $old_holds_rs = $self->_result->old_reserves->search( {}, { order_by
=> 'reservedate' } );
1041 return Koha
::Old
::Holds
->_new_from_dbic($old_holds_rs);
1044 =head3 notice_email_address
1046 my $email = $patron->notice_email_address;
1048 Return the email address of patron used for notices.
1049 Returns the empty string if no email address.
1053 sub notice_email_address
{
1056 my $which_address = C4
::Context
->preference("AutoEmailPrimaryAddress");
1057 # if syspref is set to 'first valid' (value == OFF), look up email address
1058 if ( $which_address eq 'OFF' ) {
1059 return $self->first_valid_email_address;
1062 return $self->$which_address || '';
1065 =head3 first_valid_email_address
1067 my $first_valid_email_address = $patron->first_valid_email_address
1069 Return the first valid email address for a patron.
1070 For now, the order is defined as email, emailpro, B_email.
1071 Returns the empty string if the borrower has no email addresses.
1075 sub first_valid_email_address
{
1078 return $self->email() || $self->emailpro() || $self->B_email() || q{};
1081 =head3 get_club_enrollments
1085 sub get_club_enrollments
{
1086 my ( $self, $return_scalar ) = @_;
1088 my $e = Koha
::Club
::Enrollments
->search( { borrowernumber
=> $self->borrowernumber(), date_canceled
=> undef } );
1090 return $e if $return_scalar;
1092 return wantarray ?
$e->as_list : $e;
1095 =head3 get_enrollable_clubs
1099 sub get_enrollable_clubs
{
1100 my ( $self, $is_enrollable_from_opac, $return_scalar ) = @_;
1103 $params->{is_enrollable_from_opac
} = $is_enrollable_from_opac
1104 if $is_enrollable_from_opac;
1105 $params->{is_email_required
} = 0 unless $self->first_valid_email_address();
1107 $params->{borrower
} = $self;
1109 my $e = Koha
::Clubs
->get_enrollable($params);
1111 return $e if $return_scalar;
1113 return wantarray ?
$e->as_list : $e;
1116 =head3 account_locked
1118 my $is_locked = $patron->account_locked
1120 Return true if the patron has reached the maximum number of login attempts
1121 (see pref FailedLoginAttempts). If login_attempts is < 0, this is interpreted
1122 as an administrative lockout (independent of FailedLoginAttempts; see also
1123 Koha::Patron->lock).
1124 Otherwise return false.
1125 If the pref is not set (empty string, null or 0), the feature is considered as
1130 sub account_locked
{
1132 my $FailedLoginAttempts = C4
::Context
->preference('FailedLoginAttempts');
1133 return 1 if $FailedLoginAttempts
1134 and $self->login_attempts
1135 and $self->login_attempts >= $FailedLoginAttempts;
1136 return 1 if ($self->login_attempts || 0) < 0; # administrative lockout
1140 =head3 can_see_patron_infos
1142 my $can_see = $patron->can_see_patron_infos( $patron );
1144 Return true if the patron (usually the logged in user) can see the patron's infos for a given patron
1148 sub can_see_patron_infos
{
1149 my ( $self, $patron ) = @_;
1150 return unless $patron;
1151 return $self->can_see_patrons_from( $patron->library->branchcode );
1154 =head3 can_see_patrons_from
1156 my $can_see = $patron->can_see_patrons_from( $branchcode );
1158 Return true if the patron (usually the logged in user) can see the patron's infos from a given library
1162 sub can_see_patrons_from
{
1163 my ( $self, $branchcode ) = @_;
1165 if ( $self->branchcode eq $branchcode ) {
1167 } elsif ( $self->has_permission( { borrowers
=> 'view_borrower_infos_from_any_libraries' } ) ) {
1169 } elsif ( my $library_groups = $self->library->library_groups ) {
1170 while ( my $library_group = $library_groups->next ) {
1171 if ( $library_group->parent->has_child( $branchcode ) ) {
1180 =head3 libraries_where_can_see_patrons
1182 my $libraries = $patron-libraries_where_can_see_patrons;
1184 Return the list of branchcodes(!) of libraries the patron is allowed to see other patron's infos.
1185 The branchcodes are arbitrarily returned sorted.
1186 We are supposing here that the object is related to the logged in patron (use of C4::Context::only_my_library)
1188 An empty array means no restriction, the patron can see patron's infos from any libraries.
1192 sub libraries_where_can_see_patrons
{
1194 my $userenv = C4
::Context
->userenv;
1196 return () unless $userenv; # For tests, but userenv should be defined in tests...
1198 my @restricted_branchcodes;
1199 if (C4
::Context
::only_my_library
) {
1200 push @restricted_branchcodes, $self->branchcode;
1204 $self->has_permission(
1205 { borrowers
=> 'view_borrower_infos_from_any_libraries' }
1209 my $library_groups = $self->library->library_groups({ ft_hide_patron_info
=> 1 });
1210 if ( $library_groups->count )
1212 while ( my $library_group = $library_groups->next ) {
1213 my $parent = $library_group->parent;
1214 if ( $parent->has_child( $self->branchcode ) ) {
1215 push @restricted_branchcodes, $parent->children->get_column('branchcode');
1220 @restricted_branchcodes = ( $self->branchcode ) unless @restricted_branchcodes;
1224 @restricted_branchcodes = grep { defined $_ } @restricted_branchcodes;
1225 @restricted_branchcodes = uniq
(@restricted_branchcodes);
1226 @restricted_branchcodes = sort(@restricted_branchcodes);
1227 return @restricted_branchcodes;
1230 sub has_permission
{
1231 my ( $self, $flagsrequired ) = @_;
1232 return unless $self->userid;
1233 # TODO code from haspermission needs to be moved here!
1234 return C4
::Auth
::haspermission
( $self->userid, $flagsrequired );
1239 my $is_adult = $patron->is_adult
1241 Return true if the patron has a category with a type Adult (A) or Organization (I)
1247 return $self->category->category_type =~ /^(A|I)$/ ?
1 : 0;
1252 my $is_child = $patron->is_child
1254 Return true if the patron has a category with a type Child (C)
1260 return $self->category->category_type eq 'C' ?
1 : 0;
1263 =head3 has_valid_userid
1265 my $patron = Koha::Patrons->find(42);
1266 $patron->userid( $new_userid );
1267 my $has_a_valid_userid = $patron->has_valid_userid
1269 my $patron = Koha::Patron->new( $params );
1270 my $has_a_valid_userid = $patron->has_valid_userid
1272 Return true if the current userid of this patron is valid/unique, otherwise false.
1274 Note that this should be done in $self->store instead and raise an exception if needed.
1278 sub has_valid_userid
{
1281 return 0 unless $self->userid;
1283 return 0 if ( $self->userid eq C4
::Context
->config('user') ); # DB user
1285 my $already_exists = Koha
::Patrons
->search(
1287 userid
=> $self->userid,
1290 ?
( borrowernumber
=> { '!=' => $self->borrowernumber } )
1295 return $already_exists ?
0 : 1;
1298 =head3 generate_userid
1300 my $patron = Koha::Patron->new( $params );
1301 $patron->generate_userid
1303 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
1305 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).
1309 sub generate_userid
{
1312 my $firstname = $self->firstname // q{};
1313 my $surname = $self->surname // q{};
1314 #The script will "do" the following code and increment the $offset until the generated userid is unique
1316 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1317 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1318 my $userid = lc(($firstname)?
"$firstname.$surname" : $surname);
1319 $userid = unac_string
('utf-8',$userid);
1320 $userid .= $offset unless $offset == 0;
1321 $self->userid( $userid );
1323 } while (! $self->has_valid_userid );
1331 my $attributes = $patron->attributes
1333 Return object of Koha::Patron::Attributes type with all attributes set for this patron
1339 return Koha
::Patron
::Attributes
->search({
1340 borrowernumber
=> $self->borrowernumber,
1341 branchcode
=> $self->branchcode,
1347 Koha::Patrons->find($id)->lock({ expire => 1, remove => 1 });
1349 Lock and optionally expire a patron account.
1350 Remove holds and article requests if remove flag set.
1351 In order to distinguish from locking by entering a wrong password, let's
1352 call this an administrative lockout.
1357 my ( $self, $params ) = @_;
1358 $self->login_attempts( ADMINISTRATIVE_LOCKOUT
);
1359 if( $params->{expire
} ) {
1360 $self->dateexpiry( dt_from_string
->subtract(days
=> 1) );
1363 if( $params->{remove
} ) {
1364 $self->holds->delete;
1365 $self->article_requests->delete;
1372 Koha::Patrons->find($id)->anonymize;
1374 Anonymize or clear borrower fields. Fields in BorrowerMandatoryField
1375 are randomized, other personal data is cleared too.
1376 Patrons with issues are skipped.
1382 if( $self->_result->issues->count ) {
1383 warn "Exiting anonymize: patron ".$self->borrowernumber." still has issues";
1386 # Mandatory fields come from the corresponding pref, but email fields
1387 # are removed since scrambled email addresses only generate errors
1388 my $mandatory = { map { (lc $_, 1); } grep { !/email/ }
1389 split /\s*\|\s*/, C4
::Context
->preference('BorrowerMandatoryField') };
1390 $mandatory->{userid
} = 1; # needed since sub store does not clear field
1391 my @columns = $self->_result->result_source->columns;
1392 @columns = grep { !/borrowernumber|branchcode|categorycode|^date|password|flags|updated_on|lastseen|lang|login_attempts|anonymized/ } @columns;
1393 push @columns, 'dateofbirth'; # add this date back in
1394 foreach my $col (@columns) {
1395 $self->_anonymize_column($col, $mandatory->{lc $col} );
1397 $self->anonymized(1)->store;
1400 sub _anonymize_column
{
1401 my ( $self, $col, $mandatory ) = @_;
1402 my $col_info = $self->_result->result_source->column_info($col);
1403 my $type = $col_info->{data_type
};
1404 my $nullable = $col_info->{is_nullable
};
1406 if( $type =~ /char|text/ ) {
1408 ? Koha
::Token
->new->generate({ pattern
=> '\w{10}' })
1412 } elsif( $type =~ /integer|int$|float|dec|double/ ) {
1413 $val = $nullable ?
undef : 0;
1414 } elsif( $type =~ /date|time/ ) {
1415 $val = $nullable ?
undef : dt_from_string
;
1420 =head2 Internal methods
1432 Kyle M Hall <kyle@bywatersolutions.com>
1433 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>
1434 Martin Renvoize <martin.renvoize@ptfs-europe.com>