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( uniq );
25 use JSON qw( to_json );
26 use Text::Unaccent qw( unac_string );
35 use Koha::Exceptions::Password;
37 use Koha::Old::Checkouts;
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;
48 use base qw(Koha::Object);
50 our $RESULTSET_PATRON_ID_MAPPING = {
51 Accountline => 'borrowernumber',
52 Aqbasketuser => 'borrowernumber',
53 Aqbudget => 'budget_owner_id',
54 Aqbudgetborrower => 'borrowernumber',
55 ArticleRequest => 'borrowernumber',
56 BorrowerAttribute => 'borrowernumber',
57 BorrowerDebarment => 'borrowernumber',
58 BorrowerFile => 'borrowernumber',
59 BorrowerModification => 'borrowernumber',
60 ClubEnrollment => 'borrowernumber',
61 Issue => 'borrowernumber',
62 ItemsLastBorrower => 'borrowernumber',
63 Linktracker => 'borrowernumber',
64 Message => 'borrowernumber',
65 MessageQueue => 'borrowernumber',
66 OldIssue => 'borrowernumber',
67 OldReserve => 'borrowernumber',
68 Rating => 'borrowernumber',
69 Reserve => 'borrowernumber',
70 Review => 'borrowernumber',
71 SearchHistory => 'userid',
72 Statistic => 'borrowernumber',
73 Suggestion => 'suggestedby',
74 TagAll => 'borrowernumber',
75 Virtualshelfcontent => 'borrowernumber',
76 Virtualshelfshare => 'borrowernumber',
77 Virtualshelve => 'owner',
82 Koha::Patron - Koha Patron Object class
95 my ( $class, $params ) = @_;
97 return $class->SUPER::new($params);
100 =head3 fixup_cardnumber
102 Autogenerate next cardnumber from highest value found in database
106 sub fixup_cardnumber {
108 my $max = Koha::Patrons->search({
109 cardnumber => {-regexp => '^-?[0-9]+$'}
111 select => \'CAST(cardnumber AS SIGNED)',
112 as => ['cast_cardnumber']
113 })->_resultset->get_column('cast_cardnumber')->max;
114 $self->cardnumber(($max || 0) +1);
117 =head3 trim_whitespace
119 trim whitespace from data which has some non-whitespace in it.
120 Could be moved to Koha::Object if need to be reused
124 sub trim_whitespaces {
127 my $schema = Koha::Database->new->schema;
128 my @columns = $schema->source($self->_type)->columns;
130 for my $column( @columns ) {
131 my $value = $self->$column;
132 if ( defined $value ) {
133 $value =~ s/^\s*|\s*$//g;
134 $self->$column($value);
140 =head3 plain_text_password
142 $patron->plain_text_password( $password );
144 stores a copy of the unencrypted password in the object
145 for use in code before encrypting for db
149 sub plain_text_password {
150 my ( $self, $password ) = @_;
152 $self->{_plain_text_password} = $password;
155 return $self->{_plain_text_password}
156 if $self->{_plain_text_password};
163 Patron specific store method to cleanup record
164 and do other necessary things before saving
172 $self->_result->result_source->schema->txn_do(
175 C4::Context->preference("autoMemberNum")
176 and ( not defined $self->cardnumber
177 or $self->cardnumber eq '' )
180 # Warning: The caller is responsible for locking the members table in write
181 # mode, to avoid database corruption.
182 # We are in a transaction but the table is not locked
183 $self->fixup_cardnumber;
186 unless( $self->category->in_storage ) {
187 Koha::Exceptions::Object::FKConstraint->throw(
188 broken_fk => 'categorycode',
189 value => $self->categorycode,
193 $self->trim_whitespaces;
195 # We don't want invalid dates in the db (mysql has a bad habit of inserting 0000-00-00)
196 $self->dateofbirth(undef) unless $self->dateofbirth;
197 $self->debarred(undef) unless $self->debarred;
198 $self->date_renewed(undef) unless $self->date_renewed;
199 $self->lastseen(undef) unless $self->lastseen;
200 $self->updated_on(undef) unless $self->updated_on;
202 # Set default values if not set
203 $self->sms_provider_id(undef) unless $self->sms_provider_id;
204 $self->guarantorid(undef) unless $self->guarantorid;
206 # If flags == 0 or flags == '' => no permission
207 $self->flags(undef) unless $self->flags;
210 $self->gonenoaddress(0) unless $self->gonenoaddress;
211 $self->login_attempts(0) unless $self->login_attempts;
212 $self->privacy_guarantor_checkouts(0) unless $self->privacy_guarantor_checkouts;
213 $self->lost(0) unless $self->lost;
215 unless ( $self->in_storage ) { #AddMember
217 # Generate a valid userid/login if needed
218 $self->generate_userid
219 if not $self->userid or not $self->has_valid_userid;
221 # Add expiration date if it isn't already there
222 unless ( $self->dateexpiry ) {
223 $self->dateexpiry( $self->category->get_expiry_date );
226 # Add enrollment date if it isn't already there
227 unless ( $self->dateenrolled ) {
228 $self->dateenrolled(dt_from_string);
231 # Set the privacy depending on the patron's category
232 my $default_privacy = $self->category->default_privacy || q{};
234 $default_privacy eq 'default' ? 1
235 : $default_privacy eq 'never' ? 2
236 : $default_privacy eq 'forever' ? 0
238 $self->privacy($default_privacy);
240 unless ( defined $self->privacy_guarantor_checkouts ) {
241 $self->privacy_guarantor_checkouts(0);
244 # Make a copy of the plain text password for later use
245 $self->plain_text_password( $self->password );
247 # Create a disabled account if no password provided
248 $self->password( $self->password
249 ? Koha::AuthUtils::hash_password( $self->password )
252 $self->borrowernumber(undef);
254 $self = $self->SUPER::store;
256 $self->add_enrolment_fee_if_needed;
258 logaction( "MEMBERS", "CREATE", $self->borrowernumber, "" )
259 if C4::Context->preference("BorrowersLog");
263 # Come from ModMember, but should not be possible (?)
264 $self->dateenrolled(undef) unless $self->dateenrolled;
265 $self->dateexpiry(undef) unless $self->dateexpiry;
268 my $self_from_storage = $self->get_from_storage;
269 # FIXME We should not deal with that here, callers have to do this job
270 # Moved from ModMember to prevent regressions
271 unless ( $self->userid ) {
272 my $stored_userid = $self_from_storage->userid;
273 $self->userid($stored_userid);
276 # Password must be updated using $self->update_password
277 $self->password($self_from_storage->password);
279 if ( C4::Context->preference('FeeOnChangePatronCategory')
280 and $self->category->categorycode ne
281 $self_from_storage->category->categorycode )
283 $self->add_enrolment_fee_if_needed;
286 my $borrowers_log = C4::Context->preference("BorrowersLog");
287 my $previous_cardnumber = $self_from_storage->cardnumber;
289 && ( !defined $previous_cardnumber
290 || $previous_cardnumber ne $self->cardnumber )
296 $self->borrowernumber,
299 cardnumber_replaced => {
300 previous_cardnumber => $previous_cardnumber,
301 new_cardnumber => $self->cardnumber,
304 { utf8 => 1, pretty => 1 }
309 logaction( "MEMBERS", "MODIFY", $self->borrowernumber,
310 "UPDATE (executed w/ arg: " . $self->borrowernumber . ")" )
313 $self = $self->SUPER::store;
324 Delete patron's holds, lists and finally the patron.
326 Lists owned by the borrower are deleted, but entries from the borrower to
327 other lists are kept.
335 $self->_result->result_source->schema->txn_do(
337 # Delete Patron's holds
338 $self->holds->delete;
340 # Delete all lists and all shares of this borrower
341 # Consistent with the approach Koha uses on deleting individual lists
342 # Note that entries in virtualshelfcontents added by this borrower to
343 # lists of others will be handled by a table constraint: the borrower
344 # is set to NULL in those entries.
346 # We could handle the above deletes via a constraint too.
347 # But a new BZ report 11889 has been opened to discuss another approach.
348 # Instead of deleting we could also disown lists (based on a pref).
349 # In that way we could save shared and public lists.
350 # The current table constraints support that idea now.
351 # This pref should then govern the results of other routines/methods such as
352 # Koha::Virtualshelf->new->delete too.
353 # FIXME Could be $patron->get_lists
354 $_->delete for Koha::Virtualshelves->search( { owner => $self->borrowernumber } );
356 $deleted = $self->SUPER::delete;
358 logaction( "MEMBERS", "DELETE", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
367 my $patron_category = $patron->category
369 Return the patron category for this patron
375 return Koha::Patron::Category->_new_from_dbic( $self->_result->categorycode );
380 Returns a Koha::Patron object for this patron's guarantor
387 return unless $self->guarantorid();
389 return Koha::Patrons->find( $self->guarantorid() );
395 return scalar Koha::Patron::Images->find( $self->borrowernumber );
400 return Koha::Library->_new_from_dbic($self->_result->branchcode);
405 Returns the guarantees (list of Koha::Patron) of this patron
412 return Koha::Patrons->search( { guarantorid => $self->borrowernumber }, { order_by => { -asc => ['surname','firstname'] } } );
415 =head3 housebound_profile
417 Returns the HouseboundProfile associated with this patron.
421 sub housebound_profile {
423 my $profile = $self->_result->housebound_profile;
424 return Koha::Patron::HouseboundProfile->_new_from_dbic($profile)
429 =head3 housebound_role
431 Returns the HouseboundRole associated with this patron.
435 sub housebound_role {
438 my $role = $self->_result->housebound_role;
439 return Koha::Patron::HouseboundRole->_new_from_dbic($role) if ( $role );
445 Returns the siblings of this patron.
452 my $guarantor = $self->guarantor;
454 return unless $guarantor;
456 return Koha::Patrons->search(
460 '=' => $guarantor->id,
463 '!=' => $self->borrowernumber,
471 my $patron = Koha::Patrons->find($id);
472 $patron->merge_with( \@patron_ids );
474 This subroutine merges a list of patrons into the patron record. This is accomplished by finding
475 all related patron ids for the patrons to be merged in other tables and changing the ids to be that
476 of the keeper patron.
481 my ( $self, $patron_ids ) = @_;
483 my @patron_ids = @{ $patron_ids };
485 # Ensure the keeper isn't in the list of patrons to merge
486 @patron_ids = grep { $_ ne $self->id } @patron_ids;
488 my $schema = Koha::Database->new()->schema();
492 $self->_result->result_source->schema->txn_do( sub {
493 foreach my $patron_id (@patron_ids) {
494 my $patron = Koha::Patrons->find( $patron_id );
498 # Unbless for safety, the patron will end up being deleted
499 $results->{merged}->{$patron_id}->{patron} = $patron->unblessed;
501 while (my ($r, $field) = each(%$RESULTSET_PATRON_ID_MAPPING)) {
502 my $rs = $schema->resultset($r)->search({ $field => $patron_id });
503 $results->{merged}->{ $patron_id }->{updated}->{$r} = $rs->count();
504 $rs->update({ $field => $self->id });
507 $patron->move_to_deleted();
517 =head3 wants_check_for_previous_checkout
519 $wants_check = $patron->wants_check_for_previous_checkout;
521 Return 1 if Koha needs to perform PrevIssue checking, else 0.
525 sub wants_check_for_previous_checkout {
527 my $syspref = C4::Context->preference("checkPrevCheckout");
530 ## Hard syspref trumps all
531 return 1 if ($syspref eq 'hardyes');
532 return 0 if ($syspref eq 'hardno');
533 ## Now, patron pref trumps all
534 return 1 if ($self->checkprevcheckout eq 'yes');
535 return 0 if ($self->checkprevcheckout eq 'no');
537 # More complex: patron inherits -> determine category preference
538 my $checkPrevCheckoutByCat = $self->category->checkprevcheckout;
539 return 1 if ($checkPrevCheckoutByCat eq 'yes');
540 return 0 if ($checkPrevCheckoutByCat eq 'no');
542 # Finally: category preference is inherit, default to 0
543 if ($syspref eq 'softyes') {
550 =head3 do_check_for_previous_checkout
552 $do_check = $patron->do_check_for_previous_checkout($item);
554 Return 1 if the bib associated with $ITEM has previously been checked out to
555 $PATRON, 0 otherwise.
559 sub do_check_for_previous_checkout {
560 my ( $self, $item ) = @_;
562 # Find all items for bib and extract item numbers.
563 my @items = Koha::Items->search({biblionumber => $item->{biblionumber}});
565 foreach my $item (@items) {
566 push @item_nos, $item->itemnumber;
569 # Create (old)issues search criteria
571 borrowernumber => $self->borrowernumber,
572 itemnumber => \@item_nos,
575 # Check current issues table
576 my $issues = Koha::Checkouts->search($criteria);
577 return 1 if $issues->count; # 0 || N
579 # Check old issues table
580 my $old_issues = Koha::Old::Checkouts->search($criteria);
581 return $old_issues->count; # 0 || N
586 my $debarment_expiration = $patron->is_debarred;
588 Returns the date a patron debarment will expire, or undef if the patron is not
596 return unless $self->debarred;
597 return $self->debarred
598 if $self->debarred =~ '^9999'
599 or dt_from_string( $self->debarred ) > dt_from_string;
605 my $is_expired = $patron->is_expired;
607 Returns 1 if the patron is expired or 0;
613 return 0 unless $self->dateexpiry;
614 return 0 if $self->dateexpiry =~ '^9999';
615 return 1 if dt_from_string( $self->dateexpiry ) < dt_from_string->truncate( to => 'day' );
619 =head3 is_going_to_expire
621 my $is_going_to_expire = $patron->is_going_to_expire;
623 Returns 1 if the patron is going to expired, depending on the NotifyBorrowerDeparture pref or 0
627 sub is_going_to_expire {
630 my $delay = C4::Context->preference('NotifyBorrowerDeparture') || 0;
632 return 0 unless $delay;
633 return 0 unless $self->dateexpiry;
634 return 0 if $self->dateexpiry =~ '^9999';
635 return 1 if dt_from_string( $self->dateexpiry )->subtract( days => $delay ) < dt_from_string->truncate( to => 'day' );
639 =head3 update_password
641 my $updated = $patron->update_password( $userid, $password );
643 Update the userid and the password of a patron.
644 If the userid already exists, returns and let DBIx::Class warns
645 This will add an entry to action_logs if BorrowersLog is set.
649 sub update_password {
650 my ( $self, $userid, $password ) = @_;
651 eval { $self->userid($userid)->store; };
652 return if $@; # Make sure the userid is not already in used by another patron
654 return 0 if $password eq '****' or $password eq '';
656 my $digest = Koha::AuthUtils::hash_password($password);
664 logaction( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
670 $patron->set_password( $plain_text_password );
672 Set the patron's password.
676 The passed string is validated against the current password enforcement policy.
677 Exceptions are thrown if the password is not good enough.
681 =item Koha::Exceptions::Password::TooShort
683 =item Koha::Exceptions::Password::WhitespaceCharacters
685 =item Koha::Exceptions::Password::TooWeak
692 my ( $self, $password ) = @_;
694 my ( $is_valid, $error ) = Koha::AuthUtils::is_password_valid( $password );
697 if ( $error eq 'too_short' ) {
698 my $min_length = C4::Context->preference('minPasswordLength');
699 $min_length = 3 if not $min_length or $min_length < 3;
701 my $password_length = length($password);
702 Koha::Exceptions::Password::TooShort->throw(
703 { length => $password_length, min_length => $min_length } );
705 elsif ( $error eq 'has_whitespaces' ) {
706 Koha::Exceptions::Password::WhitespaceCharacters->throw();
708 elsif ( $error eq 'too_weak' ) {
709 Koha::Exceptions::Password::TooWeak->throw();
713 my $digest = Koha::AuthUtils::hash_password($password);
715 { password => $digest,
720 logaction( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" )
721 if C4::Context->preference("BorrowersLog");
729 my $new_expiry_date = $patron->renew_account
731 Extending the subscription to the expiry date.
738 if ( C4::Context->preference('BorrowerRenewalPeriodBase') eq 'combination' ) {
739 $date = ( dt_from_string gt dt_from_string( $self->dateexpiry ) ) ? dt_from_string : dt_from_string( $self->dateexpiry );
742 C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry'
743 ? dt_from_string( $self->dateexpiry )
746 my $expiry_date = $self->category->get_expiry_date($date);
748 $self->dateexpiry($expiry_date);
749 $self->date_renewed( dt_from_string() );
752 $self->add_enrolment_fee_if_needed;
754 logaction( "MEMBERS", "RENEW", $self->borrowernumber, "Membership renewed" ) if C4::Context->preference("BorrowersLog");
755 return dt_from_string( $expiry_date )->truncate( to => 'day' );
760 my $has_overdues = $patron->has_overdues;
762 Returns the number of patron's overdues
768 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
769 return $self->_result->issues->search({ date_due => { '<' => $dtf->format_datetime( dt_from_string() ) } })->count;
774 $patron->track_login;
775 $patron->track_login({ force => 1 });
777 Tracks a (successful) login attempt.
778 The preference TrackLastPatronActivity must be enabled. Or you
779 should pass the force parameter.
784 my ( $self, $params ) = @_;
787 !C4::Context->preference('TrackLastPatronActivity');
788 $self->lastseen( dt_from_string() )->store;
791 =head3 move_to_deleted
793 my $is_moved = $patron->move_to_deleted;
795 Move a patron to the deletedborrowers table.
796 This can be done before deleting a patron, to make sure the data are not completely deleted.
800 sub move_to_deleted {
802 my $patron_infos = $self->unblessed;
803 delete $patron_infos->{updated_on}; #This ensures the updated_on date in deletedborrowers will be set to the current timestamp
804 return Koha::Database->new->schema->resultset('Deletedborrower')->create($patron_infos);
807 =head3 article_requests
809 my @requests = $borrower->article_requests();
810 my $requests = $borrower->article_requests();
812 Returns either a list of ArticleRequests objects,
813 or an ArtitleRequests object, depending on the
818 sub article_requests {
821 $self->{_article_requests} ||= Koha::ArticleRequests->search({ borrowernumber => $self->borrowernumber() });
823 return $self->{_article_requests};
826 =head3 article_requests_current
828 my @requests = $patron->article_requests_current
830 Returns the article requests associated with this patron that are incomplete
834 sub article_requests_current {
837 $self->{_article_requests_current} ||= Koha::ArticleRequests->search(
839 borrowernumber => $self->id(),
841 { status => Koha::ArticleRequest::Status::Pending },
842 { status => Koha::ArticleRequest::Status::Processing }
847 return $self->{_article_requests_current};
850 =head3 article_requests_finished
852 my @requests = $biblio->article_requests_finished
854 Returns the article requests associated with this patron that are completed
858 sub article_requests_finished {
859 my ( $self, $borrower ) = @_;
861 $self->{_article_requests_finished} ||= Koha::ArticleRequests->search(
863 borrowernumber => $self->id(),
865 { status => Koha::ArticleRequest::Status::Completed },
866 { status => Koha::ArticleRequest::Status::Canceled }
871 return $self->{_article_requests_finished};
874 =head3 add_enrolment_fee_if_needed
876 my $enrolment_fee = $patron->add_enrolment_fee_if_needed;
878 Add enrolment fee for a patron if needed.
882 sub add_enrolment_fee_if_needed {
884 my $enrolment_fee = $self->category->enrolmentfee;
885 if ( $enrolment_fee && $enrolment_fee > 0 ) {
886 # insert fee in patron debts
887 C4::Accounts::manualinvoice( $self->borrowernumber, '', '', 'A', $enrolment_fee );
889 return $enrolment_fee || 0;
894 my $checkouts = $patron->checkouts
900 my $checkouts = $self->_result->issues;
901 return Koha::Checkouts->_new_from_dbic( $checkouts );
904 =head3 pending_checkouts
906 my $pending_checkouts = $patron->pending_checkouts
908 This method will return the same as $self->checkouts, but with a prefetch on
909 items, biblio and biblioitems.
911 It has been introduced to replaced the C4::Members::GetPendingIssues subroutine
913 It should not be used directly, prefer to access fields you need instead of
914 retrieving all these fields in one go.
919 sub pending_checkouts {
921 my $checkouts = $self->_result->issues->search(
925 { -desc => 'me.timestamp' },
926 { -desc => 'issuedate' },
927 { -desc => 'issue_id' }, # Sort by issue_id should be enough
929 prefetch => { item => { biblio => 'biblioitems' } },
932 return Koha::Checkouts->_new_from_dbic( $checkouts );
937 my $old_checkouts = $patron->old_checkouts
943 my $old_checkouts = $self->_result->old_issues;
944 return Koha::Old::Checkouts->_new_from_dbic( $old_checkouts );
949 my $overdue_items = $patron->get_overdues
951 Return the overdue items
957 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
958 return $self->checkouts->search(
960 'me.date_due' => { '<' => $dtf->format_datetime(dt_from_string) },
963 prefetch => { item => { biblio => 'biblioitems' } },
968 =head3 get_routing_lists
970 my @routinglists = $patron->get_routing_lists
972 Returns the routing lists a patron is subscribed to.
976 sub get_routing_lists {
978 my $routing_list_rs = $self->_result->subscriptionroutinglists;
979 return Koha::Subscription::Routinglists->_new_from_dbic($routing_list_rs);
984 my $age = $patron->get_age
986 Return the age of the patron
992 my $today_str = dt_from_string->strftime("%Y-%m-%d");
993 return unless $self->dateofbirth;
994 my $dob_str = dt_from_string( $self->dateofbirth )->strftime("%Y-%m-%d");
996 my ( $dob_y, $dob_m, $dob_d ) = split /-/, $dob_str;
997 my ( $today_y, $today_m, $today_d ) = split /-/, $today_str;
999 my $age = $today_y - $dob_y;
1000 if ( $dob_m . $dob_d > $today_m . $today_d ) {
1009 my $account = $patron->account
1015 return Koha::Account->new( { patron_id => $self->borrowernumber } );
1020 my $holds = $patron->holds
1022 Return all the holds placed by this patron
1028 my $holds_rs = $self->_result->reserves->search( {}, { order_by => 'reservedate' } );
1029 return Koha::Holds->_new_from_dbic($holds_rs);
1034 my $old_holds = $patron->old_holds
1036 Return all the historical holds for this patron
1042 my $old_holds_rs = $self->_result->old_reserves->search( {}, { order_by => 'reservedate' } );
1043 return Koha::Old::Holds->_new_from_dbic($old_holds_rs);
1046 =head3 notice_email_address
1048 my $email = $patron->notice_email_address;
1050 Return the email address of patron used for notices.
1051 Returns the empty string if no email address.
1055 sub notice_email_address{
1058 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1059 # if syspref is set to 'first valid' (value == OFF), look up email address
1060 if ( $which_address eq 'OFF' ) {
1061 return $self->first_valid_email_address;
1064 return $self->$which_address || '';
1067 =head3 first_valid_email_address
1069 my $first_valid_email_address = $patron->first_valid_email_address
1071 Return the first valid email address for a patron.
1072 For now, the order is defined as email, emailpro, B_email.
1073 Returns the empty string if the borrower has no email addresses.
1077 sub first_valid_email_address {
1080 return $self->email() || $self->emailpro() || $self->B_email() || q{};
1083 =head3 get_club_enrollments
1087 sub get_club_enrollments {
1088 my ( $self, $return_scalar ) = @_;
1090 my $e = Koha::Club::Enrollments->search( { borrowernumber => $self->borrowernumber(), date_canceled => undef } );
1092 return $e if $return_scalar;
1094 return wantarray ? $e->as_list : $e;
1097 =head3 get_enrollable_clubs
1101 sub get_enrollable_clubs {
1102 my ( $self, $is_enrollable_from_opac, $return_scalar ) = @_;
1105 $params->{is_enrollable_from_opac} = $is_enrollable_from_opac
1106 if $is_enrollable_from_opac;
1107 $params->{is_email_required} = 0 unless $self->first_valid_email_address();
1109 $params->{borrower} = $self;
1111 my $e = Koha::Clubs->get_enrollable($params);
1113 return $e if $return_scalar;
1115 return wantarray ? $e->as_list : $e;
1118 =head3 account_locked
1120 my $is_locked = $patron->account_locked
1122 Return true if the patron has reach the maximum number of login attempts (see pref FailedLoginAttempts).
1123 Otherwise return false.
1124 If the pref is not set (empty string, null or 0), the feature is considered as disabled.
1128 sub account_locked {
1130 my $FailedLoginAttempts = C4::Context->preference('FailedLoginAttempts');
1131 return ( $FailedLoginAttempts
1132 and $self->login_attempts
1133 and $self->login_attempts >= $FailedLoginAttempts )? 1 : 0;
1136 =head3 can_see_patron_infos
1138 my $can_see = $patron->can_see_patron_infos( $patron );
1140 Return true if the patron (usually the logged in user) can see the patron's infos for a given patron
1144 sub can_see_patron_infos {
1145 my ( $self, $patron ) = @_;
1146 return $self->can_see_patrons_from( $patron->library->branchcode );
1149 =head3 can_see_patrons_from
1151 my $can_see = $patron->can_see_patrons_from( $branchcode );
1153 Return true if the patron (usually the logged in user) can see the patron's infos from a given library
1157 sub can_see_patrons_from {
1158 my ( $self, $branchcode ) = @_;
1160 if ( $self->branchcode eq $branchcode ) {
1162 } elsif ( $self->has_permission( { borrowers => 'view_borrower_infos_from_any_libraries' } ) ) {
1164 } elsif ( my $library_groups = $self->library->library_groups ) {
1165 while ( my $library_group = $library_groups->next ) {
1166 if ( $library_group->parent->has_child( $branchcode ) ) {
1175 =head3 libraries_where_can_see_patrons
1177 my $libraries = $patron-libraries_where_can_see_patrons;
1179 Return the list of branchcodes(!) of libraries the patron is allowed to see other patron's infos.
1180 The branchcodes are arbitrarily returned sorted.
1181 We are supposing here that the object is related to the logged in patron (use of C4::Context::only_my_library)
1183 An empty array means no restriction, the patron can see patron's infos from any libraries.
1187 sub libraries_where_can_see_patrons {
1189 my $userenv = C4::Context->userenv;
1191 return () unless $userenv; # For tests, but userenv should be defined in tests...
1193 my @restricted_branchcodes;
1194 if (C4::Context::only_my_library) {
1195 push @restricted_branchcodes, $self->branchcode;
1199 $self->has_permission(
1200 { borrowers => 'view_borrower_infos_from_any_libraries' }
1204 my $library_groups = $self->library->library_groups({ ft_hide_patron_info => 1 });
1205 if ( $library_groups->count )
1207 while ( my $library_group = $library_groups->next ) {
1208 my $parent = $library_group->parent;
1209 if ( $parent->has_child( $self->branchcode ) ) {
1210 push @restricted_branchcodes, $parent->children->get_column('branchcode');
1215 @restricted_branchcodes = ( $self->branchcode ) unless @restricted_branchcodes;
1219 @restricted_branchcodes = grep { defined $_ } @restricted_branchcodes;
1220 @restricted_branchcodes = uniq(@restricted_branchcodes);
1221 @restricted_branchcodes = sort(@restricted_branchcodes);
1222 return @restricted_branchcodes;
1225 sub has_permission {
1226 my ( $self, $flagsrequired ) = @_;
1227 return unless $self->userid;
1228 # TODO code from haspermission needs to be moved here!
1229 return C4::Auth::haspermission( $self->userid, $flagsrequired );
1234 my $is_adult = $patron->is_adult
1236 Return true if the patron has a category with a type Adult (A) or Organization (I)
1242 return $self->category->category_type =~ /^(A|I)$/ ? 1 : 0;
1247 my $is_child = $patron->is_child
1249 Return true if the patron has a category with a type Child (C)
1254 return $self->category->category_type eq 'C' ? 1 : 0;
1257 =head3 has_valid_userid
1259 my $patron = Koha::Patrons->find(42);
1260 $patron->userid( $new_userid );
1261 my $has_a_valid_userid = $patron->has_valid_userid
1263 my $patron = Koha::Patron->new( $params );
1264 my $has_a_valid_userid = $patron->has_valid_userid
1266 Return true if the current userid of this patron is valid/unique, otherwise false.
1268 Note that this should be done in $self->store instead and raise an exception if needed.
1272 sub has_valid_userid {
1275 return 0 unless $self->userid;
1277 return 0 if ( $self->userid eq C4::Context->config('user') ); # DB user
1279 my $already_exists = Koha::Patrons->search(
1281 userid => $self->userid,
1284 ? ( borrowernumber => { '!=' => $self->borrowernumber } )
1289 return $already_exists ? 0 : 1;
1292 =head3 generate_userid
1294 my $patron = Koha::Patron->new( $params );
1295 $patron->generate_userid
1297 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
1299 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).
1303 sub generate_userid {
1306 my $firstname = $self->firstname // q{};
1307 my $surname = $self->surname // q{};
1308 #The script will "do" the following code and increment the $offset until the generated userid is unique
1310 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1311 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1312 my $userid = lc(($firstname)? "$firstname.$surname" : $surname);
1313 $userid = unac_string('utf-8',$userid);
1314 $userid .= $offset unless $offset == 0;
1315 $self->userid( $userid );
1317 } while (! $self->has_valid_userid );
1323 =head2 Internal methods
1335 Kyle M Hall <kyle@bywatersolutions.com>
1336 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>