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;
200 # Set default values if not set
201 $self->sms_provider_id(undef) unless $self->sms_provider_id;
202 $self->guarantorid(undef) unless $self->guarantorid;
204 unless ( $self->in_storage ) { #AddMember
206 # Generate a valid userid/login if needed
207 $self->generate_userid
208 if not $self->userid or not $self->has_valid_userid;
210 # Add expiration date if it isn't already there
211 unless ( $self->dateexpiry ) {
212 $self->dateexpiry( $self->category->get_expiry_date );
215 # Add enrollment date if it isn't already there
216 unless ( $self->dateenrolled ) {
217 $self->dateenrolled(dt_from_string);
220 # Set the privacy depending on the patron's category
221 my $default_privacy = $self->category->default_privacy || q{};
223 $default_privacy eq 'default' ? 1
224 : $default_privacy eq 'never' ? 2
225 : $default_privacy eq 'forever' ? 0
227 $self->privacy($default_privacy);
229 unless ( defined $self->privacy_guarantor_checkouts ) {
230 $self->privacy_guarantor_checkouts(0);
233 # Make a copy of the plain text password for later use
234 $self->plain_text_password( $self->password );
236 # Create a disabled account if no password provided
237 $self->password( $self->password
238 ? Koha::AuthUtils::hash_password( $self->password )
241 $self->borrowernumber(undef);
243 $self = $self->SUPER::store;
245 $self->add_enrolment_fee_if_needed;
247 logaction( "MEMBERS", "CREATE", $self->borrowernumber, "" )
248 if C4::Context->preference("BorrowersLog");
252 # Come from ModMember, but should not be possible (?)
253 $self->dateenrolled(undef) unless $self->dateenrolled;
254 $self->dateexpiry(undef) unless $self->dateexpiry;
257 my $self_from_storage = $self->get_from_storage;
258 # FIXME We should not deal with that here, callers have to do this job
259 # Moved from ModMember to prevent regressions
260 unless ( $self->userid ) {
261 my $stored_userid = $self_from_storage->userid;
262 $self->userid($stored_userid);
265 # Password must be updated using $self->update_password
266 $self->password($self_from_storage->password);
268 if ( C4::Context->preference('FeeOnChangePatronCategory')
269 and $self->category->categorycode ne
270 $self_from_storage->category->categorycode )
272 $self->add_enrolment_fee_if_needed;
275 my $borrowers_log = C4::Context->preference("BorrowersLog");
276 my $previous_cardnumber = $self_from_storage->cardnumber;
278 && ( !defined $previous_cardnumber
279 || $previous_cardnumber ne $self->cardnumber )
285 $self->borrowernumber,
288 cardnumber_replaced => {
289 previous_cardnumber => $previous_cardnumber,
290 new_cardnumber => $self->cardnumber,
293 { utf8 => 1, pretty => 1 }
298 logaction( "MEMBERS", "MODIFY", $self->borrowernumber,
299 "UPDATE (executed w/ arg: " . $self->borrowernumber . ")" )
302 $self = $self->SUPER::store;
313 Delete patron's holds, lists and finally the patron.
315 Lists owned by the borrower are deleted, but entries from the borrower to
316 other lists are kept.
324 $self->_result->result_source->schema->txn_do(
326 # Delete Patron's holds
327 $self->holds->delete;
329 # Delete all lists and all shares of this borrower
330 # Consistent with the approach Koha uses on deleting individual lists
331 # Note that entries in virtualshelfcontents added by this borrower to
332 # lists of others will be handled by a table constraint: the borrower
333 # is set to NULL in those entries.
335 # We could handle the above deletes via a constraint too.
336 # But a new BZ report 11889 has been opened to discuss another approach.
337 # Instead of deleting we could also disown lists (based on a pref).
338 # In that way we could save shared and public lists.
339 # The current table constraints support that idea now.
340 # This pref should then govern the results of other routines/methods such as
341 # Koha::Virtualshelf->new->delete too.
342 # FIXME Could be $patron->get_lists
343 $_->delete for Koha::Virtualshelves->search( { owner => $self->borrowernumber } );
345 $deleted = $self->SUPER::delete;
347 logaction( "MEMBERS", "DELETE", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
356 my $patron_category = $patron->category
358 Return the patron category for this patron
364 return Koha::Patron::Category->_new_from_dbic( $self->_result->categorycode );
369 Returns a Koha::Patron object for this patron's guarantor
376 return unless $self->guarantorid();
378 return Koha::Patrons->find( $self->guarantorid() );
384 return scalar Koha::Patron::Images->find( $self->borrowernumber );
389 return Koha::Library->_new_from_dbic($self->_result->branchcode);
394 Returns the guarantees (list of Koha::Patron) of this patron
401 return Koha::Patrons->search( { guarantorid => $self->borrowernumber }, { order_by => { -asc => ['surname','firstname'] } } );
404 =head3 housebound_profile
406 Returns the HouseboundProfile associated with this patron.
410 sub housebound_profile {
412 my $profile = $self->_result->housebound_profile;
413 return Koha::Patron::HouseboundProfile->_new_from_dbic($profile)
418 =head3 housebound_role
420 Returns the HouseboundRole associated with this patron.
424 sub housebound_role {
427 my $role = $self->_result->housebound_role;
428 return Koha::Patron::HouseboundRole->_new_from_dbic($role) if ( $role );
434 Returns the siblings of this patron.
441 my $guarantor = $self->guarantor;
443 return unless $guarantor;
445 return Koha::Patrons->search(
449 '=' => $guarantor->id,
452 '!=' => $self->borrowernumber,
460 my $patron = Koha::Patrons->find($id);
461 $patron->merge_with( \@patron_ids );
463 This subroutine merges a list of patrons into the patron record. This is accomplished by finding
464 all related patron ids for the patrons to be merged in other tables and changing the ids to be that
465 of the keeper patron.
470 my ( $self, $patron_ids ) = @_;
472 my @patron_ids = @{ $patron_ids };
474 # Ensure the keeper isn't in the list of patrons to merge
475 @patron_ids = grep { $_ ne $self->id } @patron_ids;
477 my $schema = Koha::Database->new()->schema();
481 $self->_result->result_source->schema->txn_do( sub {
482 foreach my $patron_id (@patron_ids) {
483 my $patron = Koha::Patrons->find( $patron_id );
487 # Unbless for safety, the patron will end up being deleted
488 $results->{merged}->{$patron_id}->{patron} = $patron->unblessed;
490 while (my ($r, $field) = each(%$RESULTSET_PATRON_ID_MAPPING)) {
491 my $rs = $schema->resultset($r)->search({ $field => $patron_id });
492 $results->{merged}->{ $patron_id }->{updated}->{$r} = $rs->count();
493 $rs->update({ $field => $self->id });
496 $patron->move_to_deleted();
506 =head3 wants_check_for_previous_checkout
508 $wants_check = $patron->wants_check_for_previous_checkout;
510 Return 1 if Koha needs to perform PrevIssue checking, else 0.
514 sub wants_check_for_previous_checkout {
516 my $syspref = C4::Context->preference("checkPrevCheckout");
519 ## Hard syspref trumps all
520 return 1 if ($syspref eq 'hardyes');
521 return 0 if ($syspref eq 'hardno');
522 ## Now, patron pref trumps all
523 return 1 if ($self->checkprevcheckout eq 'yes');
524 return 0 if ($self->checkprevcheckout eq 'no');
526 # More complex: patron inherits -> determine category preference
527 my $checkPrevCheckoutByCat = $self->category->checkprevcheckout;
528 return 1 if ($checkPrevCheckoutByCat eq 'yes');
529 return 0 if ($checkPrevCheckoutByCat eq 'no');
531 # Finally: category preference is inherit, default to 0
532 if ($syspref eq 'softyes') {
539 =head3 do_check_for_previous_checkout
541 $do_check = $patron->do_check_for_previous_checkout($item);
543 Return 1 if the bib associated with $ITEM has previously been checked out to
544 $PATRON, 0 otherwise.
548 sub do_check_for_previous_checkout {
549 my ( $self, $item ) = @_;
551 # Find all items for bib and extract item numbers.
552 my @items = Koha::Items->search({biblionumber => $item->{biblionumber}});
554 foreach my $item (@items) {
555 push @item_nos, $item->itemnumber;
558 # Create (old)issues search criteria
560 borrowernumber => $self->borrowernumber,
561 itemnumber => \@item_nos,
564 # Check current issues table
565 my $issues = Koha::Checkouts->search($criteria);
566 return 1 if $issues->count; # 0 || N
568 # Check old issues table
569 my $old_issues = Koha::Old::Checkouts->search($criteria);
570 return $old_issues->count; # 0 || N
575 my $debarment_expiration = $patron->is_debarred;
577 Returns the date a patron debarment will expire, or undef if the patron is not
585 return unless $self->debarred;
586 return $self->debarred
587 if $self->debarred =~ '^9999'
588 or dt_from_string( $self->debarred ) > dt_from_string;
594 my $is_expired = $patron->is_expired;
596 Returns 1 if the patron is expired or 0;
602 return 0 unless $self->dateexpiry;
603 return 0 if $self->dateexpiry =~ '^9999';
604 return 1 if dt_from_string( $self->dateexpiry ) < dt_from_string->truncate( to => 'day' );
608 =head3 is_going_to_expire
610 my $is_going_to_expire = $patron->is_going_to_expire;
612 Returns 1 if the patron is going to expired, depending on the NotifyBorrowerDeparture pref or 0
616 sub is_going_to_expire {
619 my $delay = C4::Context->preference('NotifyBorrowerDeparture') || 0;
621 return 0 unless $delay;
622 return 0 unless $self->dateexpiry;
623 return 0 if $self->dateexpiry =~ '^9999';
624 return 1 if dt_from_string( $self->dateexpiry )->subtract( days => $delay ) < dt_from_string->truncate( to => 'day' );
628 =head3 update_password
630 my $updated = $patron->update_password( $userid, $password );
632 Update the userid and the password of a patron.
633 If the userid already exists, returns and let DBIx::Class warns
634 This will add an entry to action_logs if BorrowersLog is set.
638 sub update_password {
639 my ( $self, $userid, $password ) = @_;
640 eval { $self->userid($userid)->store; };
641 return if $@; # Make sure the userid is not already in used by another patron
643 return 0 if $password eq '****' or $password eq '';
645 my $digest = Koha::AuthUtils::hash_password($password);
653 logaction( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
659 $patron->set_password( $plain_text_password );
661 Set the patron's password.
665 The passed string is validated against the current password enforcement policy.
666 Exceptions are thrown if the password is not good enough.
670 =item Koha::Exceptions::Password::TooShort
672 =item Koha::Exceptions::Password::WhitespaceCharacters
674 =item Koha::Exceptions::Password::TooWeak
681 my ( $self, $password ) = @_;
683 my ( $is_valid, $error ) = Koha::AuthUtils::is_password_valid( $password );
686 if ( $error eq 'too_short' ) {
687 my $min_length = C4::Context->preference('minPasswordLength');
688 $min_length = 3 if not $min_length or $min_length < 3;
690 my $password_length = length($password);
691 Koha::Exceptions::Password::TooShort->throw(
692 { length => $password_length, min_length => $min_length } );
694 elsif ( $error eq 'has_whitespaces' ) {
695 Koha::Exceptions::Password::WhitespaceCharacters->throw();
697 elsif ( $error eq 'too_weak' ) {
698 Koha::Exceptions::Password::TooWeak->throw();
702 my $digest = Koha::AuthUtils::hash_password($password);
704 { password => $digest,
709 logaction( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" )
710 if C4::Context->preference("BorrowersLog");
718 my $new_expiry_date = $patron->renew_account
720 Extending the subscription to the expiry date.
727 if ( C4::Context->preference('BorrowerRenewalPeriodBase') eq 'combination' ) {
728 $date = ( dt_from_string gt dt_from_string( $self->dateexpiry ) ) ? dt_from_string : dt_from_string( $self->dateexpiry );
731 C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry'
732 ? dt_from_string( $self->dateexpiry )
735 my $expiry_date = $self->category->get_expiry_date($date);
737 $self->dateexpiry($expiry_date);
738 $self->date_renewed( dt_from_string() );
741 $self->add_enrolment_fee_if_needed;
743 logaction( "MEMBERS", "RENEW", $self->borrowernumber, "Membership renewed" ) if C4::Context->preference("BorrowersLog");
744 return dt_from_string( $expiry_date )->truncate( to => 'day' );
749 my $has_overdues = $patron->has_overdues;
751 Returns the number of patron's overdues
757 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
758 return $self->_result->issues->search({ date_due => { '<' => $dtf->format_datetime( dt_from_string() ) } })->count;
763 $patron->track_login;
764 $patron->track_login({ force => 1 });
766 Tracks a (successful) login attempt.
767 The preference TrackLastPatronActivity must be enabled. Or you
768 should pass the force parameter.
773 my ( $self, $params ) = @_;
776 !C4::Context->preference('TrackLastPatronActivity');
777 $self->lastseen( dt_from_string() )->store;
780 =head3 move_to_deleted
782 my $is_moved = $patron->move_to_deleted;
784 Move a patron to the deletedborrowers table.
785 This can be done before deleting a patron, to make sure the data are not completely deleted.
789 sub move_to_deleted {
791 my $patron_infos = $self->unblessed;
792 delete $patron_infos->{updated_on}; #This ensures the updated_on date in deletedborrowers will be set to the current timestamp
793 return Koha::Database->new->schema->resultset('Deletedborrower')->create($patron_infos);
796 =head3 article_requests
798 my @requests = $borrower->article_requests();
799 my $requests = $borrower->article_requests();
801 Returns either a list of ArticleRequests objects,
802 or an ArtitleRequests object, depending on the
807 sub article_requests {
810 $self->{_article_requests} ||= Koha::ArticleRequests->search({ borrowernumber => $self->borrowernumber() });
812 return $self->{_article_requests};
815 =head3 article_requests_current
817 my @requests = $patron->article_requests_current
819 Returns the article requests associated with this patron that are incomplete
823 sub article_requests_current {
826 $self->{_article_requests_current} ||= Koha::ArticleRequests->search(
828 borrowernumber => $self->id(),
830 { status => Koha::ArticleRequest::Status::Pending },
831 { status => Koha::ArticleRequest::Status::Processing }
836 return $self->{_article_requests_current};
839 =head3 article_requests_finished
841 my @requests = $biblio->article_requests_finished
843 Returns the article requests associated with this patron that are completed
847 sub article_requests_finished {
848 my ( $self, $borrower ) = @_;
850 $self->{_article_requests_finished} ||= Koha::ArticleRequests->search(
852 borrowernumber => $self->id(),
854 { status => Koha::ArticleRequest::Status::Completed },
855 { status => Koha::ArticleRequest::Status::Canceled }
860 return $self->{_article_requests_finished};
863 =head3 add_enrolment_fee_if_needed
865 my $enrolment_fee = $patron->add_enrolment_fee_if_needed;
867 Add enrolment fee for a patron if needed.
871 sub add_enrolment_fee_if_needed {
873 my $enrolment_fee = $self->category->enrolmentfee;
874 if ( $enrolment_fee && $enrolment_fee > 0 ) {
875 # insert fee in patron debts
876 C4::Accounts::manualinvoice( $self->borrowernumber, '', '', 'A', $enrolment_fee );
878 return $enrolment_fee || 0;
883 my $checkouts = $patron->checkouts
889 my $checkouts = $self->_result->issues;
890 return Koha::Checkouts->_new_from_dbic( $checkouts );
893 =head3 pending_checkouts
895 my $pending_checkouts = $patron->pending_checkouts
897 This method will return the same as $self->checkouts, but with a prefetch on
898 items, biblio and biblioitems.
900 It has been introduced to replaced the C4::Members::GetPendingIssues subroutine
902 It should not be used directly, prefer to access fields you need instead of
903 retrieving all these fields in one go.
908 sub pending_checkouts {
910 my $checkouts = $self->_result->issues->search(
914 { -desc => 'me.timestamp' },
915 { -desc => 'issuedate' },
916 { -desc => 'issue_id' }, # Sort by issue_id should be enough
918 prefetch => { item => { biblio => 'biblioitems' } },
921 return Koha::Checkouts->_new_from_dbic( $checkouts );
926 my $old_checkouts = $patron->old_checkouts
932 my $old_checkouts = $self->_result->old_issues;
933 return Koha::Old::Checkouts->_new_from_dbic( $old_checkouts );
938 my $overdue_items = $patron->get_overdues
940 Return the overdue items
946 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
947 return $self->checkouts->search(
949 'me.date_due' => { '<' => $dtf->format_datetime(dt_from_string) },
952 prefetch => { item => { biblio => 'biblioitems' } },
957 =head3 get_routing_lists
959 my @routinglists = $patron->get_routing_lists
961 Returns the routing lists a patron is subscribed to.
965 sub get_routing_lists {
967 my $routing_list_rs = $self->_result->subscriptionroutinglists;
968 return Koha::Subscription::Routinglists->_new_from_dbic($routing_list_rs);
973 my $age = $patron->get_age
975 Return the age of the patron
981 my $today_str = dt_from_string->strftime("%Y-%m-%d");
982 return unless $self->dateofbirth;
983 my $dob_str = dt_from_string( $self->dateofbirth )->strftime("%Y-%m-%d");
985 my ( $dob_y, $dob_m, $dob_d ) = split /-/, $dob_str;
986 my ( $today_y, $today_m, $today_d ) = split /-/, $today_str;
988 my $age = $today_y - $dob_y;
989 if ( $dob_m . $dob_d > $today_m . $today_d ) {
998 my $account = $patron->account
1004 return Koha::Account->new( { patron_id => $self->borrowernumber } );
1009 my $holds = $patron->holds
1011 Return all the holds placed by this patron
1017 my $holds_rs = $self->_result->reserves->search( {}, { order_by => 'reservedate' } );
1018 return Koha::Holds->_new_from_dbic($holds_rs);
1023 my $old_holds = $patron->old_holds
1025 Return all the historical holds for this patron
1031 my $old_holds_rs = $self->_result->old_reserves->search( {}, { order_by => 'reservedate' } );
1032 return Koha::Old::Holds->_new_from_dbic($old_holds_rs);
1035 =head3 notice_email_address
1037 my $email = $patron->notice_email_address;
1039 Return the email address of patron used for notices.
1040 Returns the empty string if no email address.
1044 sub notice_email_address{
1047 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1048 # if syspref is set to 'first valid' (value == OFF), look up email address
1049 if ( $which_address eq 'OFF' ) {
1050 return $self->first_valid_email_address;
1053 return $self->$which_address || '';
1056 =head3 first_valid_email_address
1058 my $first_valid_email_address = $patron->first_valid_email_address
1060 Return the first valid email address for a patron.
1061 For now, the order is defined as email, emailpro, B_email.
1062 Returns the empty string if the borrower has no email addresses.
1066 sub first_valid_email_address {
1069 return $self->email() || $self->emailpro() || $self->B_email() || q{};
1072 =head3 get_club_enrollments
1076 sub get_club_enrollments {
1077 my ( $self, $return_scalar ) = @_;
1079 my $e = Koha::Club::Enrollments->search( { borrowernumber => $self->borrowernumber(), date_canceled => undef } );
1081 return $e if $return_scalar;
1083 return wantarray ? $e->as_list : $e;
1086 =head3 get_enrollable_clubs
1090 sub get_enrollable_clubs {
1091 my ( $self, $is_enrollable_from_opac, $return_scalar ) = @_;
1094 $params->{is_enrollable_from_opac} = $is_enrollable_from_opac
1095 if $is_enrollable_from_opac;
1096 $params->{is_email_required} = 0 unless $self->first_valid_email_address();
1098 $params->{borrower} = $self;
1100 my $e = Koha::Clubs->get_enrollable($params);
1102 return $e if $return_scalar;
1104 return wantarray ? $e->as_list : $e;
1107 =head3 account_locked
1109 my $is_locked = $patron->account_locked
1111 Return true if the patron has reach the maximum number of login attempts (see pref FailedLoginAttempts).
1112 Otherwise return false.
1113 If the pref is not set (empty string, null or 0), the feature is considered as disabled.
1117 sub account_locked {
1119 my $FailedLoginAttempts = C4::Context->preference('FailedLoginAttempts');
1120 return ( $FailedLoginAttempts
1121 and $self->login_attempts
1122 and $self->login_attempts >= $FailedLoginAttempts )? 1 : 0;
1125 =head3 can_see_patron_infos
1127 my $can_see = $patron->can_see_patron_infos( $patron );
1129 Return true if the patron (usually the logged in user) can see the patron's infos for a given patron
1133 sub can_see_patron_infos {
1134 my ( $self, $patron ) = @_;
1135 return $self->can_see_patrons_from( $patron->library->branchcode );
1138 =head3 can_see_patrons_from
1140 my $can_see = $patron->can_see_patrons_from( $branchcode );
1142 Return true if the patron (usually the logged in user) can see the patron's infos from a given library
1146 sub can_see_patrons_from {
1147 my ( $self, $branchcode ) = @_;
1149 if ( $self->branchcode eq $branchcode ) {
1151 } elsif ( $self->has_permission( { borrowers => 'view_borrower_infos_from_any_libraries' } ) ) {
1153 } elsif ( my $library_groups = $self->library->library_groups ) {
1154 while ( my $library_group = $library_groups->next ) {
1155 if ( $library_group->parent->has_child( $branchcode ) ) {
1164 =head3 libraries_where_can_see_patrons
1166 my $libraries = $patron-libraries_where_can_see_patrons;
1168 Return the list of branchcodes(!) of libraries the patron is allowed to see other patron's infos.
1169 The branchcodes are arbitrarily returned sorted.
1170 We are supposing here that the object is related to the logged in patron (use of C4::Context::only_my_library)
1172 An empty array means no restriction, the patron can see patron's infos from any libraries.
1176 sub libraries_where_can_see_patrons {
1178 my $userenv = C4::Context->userenv;
1180 return () unless $userenv; # For tests, but userenv should be defined in tests...
1182 my @restricted_branchcodes;
1183 if (C4::Context::only_my_library) {
1184 push @restricted_branchcodes, $self->branchcode;
1188 $self->has_permission(
1189 { borrowers => 'view_borrower_infos_from_any_libraries' }
1193 my $library_groups = $self->library->library_groups({ ft_hide_patron_info => 1 });
1194 if ( $library_groups->count )
1196 while ( my $library_group = $library_groups->next ) {
1197 my $parent = $library_group->parent;
1198 if ( $parent->has_child( $self->branchcode ) ) {
1199 push @restricted_branchcodes, $parent->children->get_column('branchcode');
1204 @restricted_branchcodes = ( $self->branchcode ) unless @restricted_branchcodes;
1208 @restricted_branchcodes = grep { defined $_ } @restricted_branchcodes;
1209 @restricted_branchcodes = uniq(@restricted_branchcodes);
1210 @restricted_branchcodes = sort(@restricted_branchcodes);
1211 return @restricted_branchcodes;
1214 sub has_permission {
1215 my ( $self, $flagsrequired ) = @_;
1216 return unless $self->userid;
1217 # TODO code from haspermission needs to be moved here!
1218 return C4::Auth::haspermission( $self->userid, $flagsrequired );
1223 my $is_adult = $patron->is_adult
1225 Return true if the patron has a category with a type Adult (A) or Organization (I)
1231 return $self->category->category_type =~ /^(A|I)$/ ? 1 : 0;
1236 my $is_child = $patron->is_child
1238 Return true if the patron has a category with a type Child (C)
1243 return $self->category->category_type eq 'C' ? 1 : 0;
1246 =head3 has_valid_userid
1248 my $patron = Koha::Patrons->find(42);
1249 $patron->userid( $new_userid );
1250 my $has_a_valid_userid = $patron->has_valid_userid
1252 my $patron = Koha::Patron->new( $params );
1253 my $has_a_valid_userid = $patron->has_valid_userid
1255 Return true if the current userid of this patron is valid/unique, otherwise false.
1257 Note that this should be done in $self->store instead and raise an exception if needed.
1261 sub has_valid_userid {
1264 return 0 unless $self->userid;
1266 return 0 if ( $self->userid eq C4::Context->config('user') ); # DB user
1268 my $already_exists = Koha::Patrons->search(
1270 userid => $self->userid,
1273 ? ( borrowernumber => { '!=' => $self->borrowernumber } )
1278 return $already_exists ? 0 : 1;
1281 =head3 generate_userid
1283 my $patron = Koha::Patron->new( $params );
1284 $patron->generate_userid
1286 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
1288 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).
1292 sub generate_userid {
1295 my $firstname = $self->firstname // q{};
1296 my $surname = $self->surname // q{};
1297 #The script will "do" the following code and increment the $offset until the generated userid is unique
1299 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1300 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1301 my $userid = lc(($firstname)? "$firstname.$surname" : $surname);
1302 $userid = unac_string('utf-8',$userid);
1303 $userid .= $offset unless $offset == 0;
1304 $self->userid( $userid );
1306 } while (! $self->has_valid_userid );
1312 =head2 Internal methods
1324 Kyle M Hall <kyle@bywatersolutions.com>
1325 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>