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;
199 # Set default values if not set
200 $self->sms_provider_id(undef) unless $self->sms_provider_id;
201 $self->guarantorid(undef) unless $self->guarantorid;
203 unless ( $self->in_storage ) { #AddMember
205 # Generate a valid userid/login if needed
206 $self->generate_userid
207 if not $self->userid or not $self->has_valid_userid;
209 # Add expiration date if it isn't already there
210 unless ( $self->dateexpiry ) {
211 $self->dateexpiry( $self->category->get_expiry_date );
214 # Add enrollment date if it isn't already there
215 unless ( $self->dateenrolled ) {
216 $self->dateenrolled(dt_from_string);
219 # Set the privacy depending on the patron's category
220 my $default_privacy = $self->category->default_privacy || q{};
222 $default_privacy eq 'default' ? 1
223 : $default_privacy eq 'never' ? 2
224 : $default_privacy eq 'forever' ? 0
226 $self->privacy($default_privacy);
228 unless ( defined $self->privacy_guarantor_checkouts ) {
229 $self->privacy_guarantor_checkouts(0);
232 # Make a copy of the plain text password for later use
233 $self->plain_text_password( $self->password );
235 # Create a disabled account if no password provided
236 $self->password( $self->password
237 ? Koha::AuthUtils::hash_password( $self->password )
240 $self->borrowernumber(undef);
242 $self = $self->SUPER::store;
244 $self->add_enrolment_fee_if_needed;
246 logaction( "MEMBERS", "CREATE", $self->borrowernumber, "" )
247 if C4::Context->preference("BorrowersLog");
251 # Come from ModMember, but should not be possible (?)
252 $self->dateenrolled(undef) unless $self->dateenrolled;
253 $self->dateexpiry(undef) unless $self->dateexpiry;
256 my $self_from_storage = $self->get_from_storage;
257 # FIXME We should not deal with that here, callers have to do this job
258 # Moved from ModMember to prevent regressions
259 unless ( $self->userid ) {
260 my $stored_userid = $self_from_storage->userid;
261 $self->userid($stored_userid);
264 # Password must be updated using $self->update_password
265 $self->password($self_from_storage->password);
267 if ( C4::Context->preference('FeeOnChangePatronCategory')
268 and $self->category->categorycode ne
269 $self_from_storage->category->categorycode )
271 $self->add_enrolment_fee_if_needed;
274 my $borrowers_log = C4::Context->preference("BorrowersLog");
275 my $previous_cardnumber = $self_from_storage->cardnumber;
277 && ( !defined $previous_cardnumber
278 || $previous_cardnumber ne $self->cardnumber )
284 $self->borrowernumber,
287 cardnumber_replaced => {
288 previous_cardnumber => $previous_cardnumber,
289 new_cardnumber => $self->cardnumber,
292 { utf8 => 1, pretty => 1 }
297 logaction( "MEMBERS", "MODIFY", $self->borrowernumber,
298 "UPDATE (executed w/ arg: " . $self->borrowernumber . ")" )
301 $self = $self->SUPER::store;
312 Delete patron's holds, lists and finally the patron.
314 Lists owned by the borrower are deleted, but entries from the borrower to
315 other lists are kept.
323 $self->_result->result_source->schema->txn_do(
325 # Delete Patron's holds
326 $self->holds->delete;
328 # Delete all lists and all shares of this borrower
329 # Consistent with the approach Koha uses on deleting individual lists
330 # Note that entries in virtualshelfcontents added by this borrower to
331 # lists of others will be handled by a table constraint: the borrower
332 # is set to NULL in those entries.
334 # We could handle the above deletes via a constraint too.
335 # But a new BZ report 11889 has been opened to discuss another approach.
336 # Instead of deleting we could also disown lists (based on a pref).
337 # In that way we could save shared and public lists.
338 # The current table constraints support that idea now.
339 # This pref should then govern the results of other routines/methods such as
340 # Koha::Virtualshelf->new->delete too.
341 # FIXME Could be $patron->get_lists
342 $_->delete for Koha::Virtualshelves->search( { owner => $self->borrowernumber } );
344 $deleted = $self->SUPER::delete;
346 logaction( "MEMBERS", "DELETE", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
355 my $patron_category = $patron->category
357 Return the patron category for this patron
363 return Koha::Patron::Category->_new_from_dbic( $self->_result->categorycode );
368 Returns a Koha::Patron object for this patron's guarantor
375 return unless $self->guarantorid();
377 return Koha::Patrons->find( $self->guarantorid() );
383 return scalar Koha::Patron::Images->find( $self->borrowernumber );
388 return Koha::Library->_new_from_dbic($self->_result->branchcode);
393 Returns the guarantees (list of Koha::Patron) of this patron
400 return Koha::Patrons->search( { guarantorid => $self->borrowernumber }, { order_by => { -asc => ['surname','firstname'] } } );
403 =head3 housebound_profile
405 Returns the HouseboundProfile associated with this patron.
409 sub housebound_profile {
411 my $profile = $self->_result->housebound_profile;
412 return Koha::Patron::HouseboundProfile->_new_from_dbic($profile)
417 =head3 housebound_role
419 Returns the HouseboundRole associated with this patron.
423 sub housebound_role {
426 my $role = $self->_result->housebound_role;
427 return Koha::Patron::HouseboundRole->_new_from_dbic($role) if ( $role );
433 Returns the siblings of this patron.
440 my $guarantor = $self->guarantor;
442 return unless $guarantor;
444 return Koha::Patrons->search(
448 '=' => $guarantor->id,
451 '!=' => $self->borrowernumber,
459 my $patron = Koha::Patrons->find($id);
460 $patron->merge_with( \@patron_ids );
462 This subroutine merges a list of patrons into the patron record. This is accomplished by finding
463 all related patron ids for the patrons to be merged in other tables and changing the ids to be that
464 of the keeper patron.
469 my ( $self, $patron_ids ) = @_;
471 my @patron_ids = @{ $patron_ids };
473 # Ensure the keeper isn't in the list of patrons to merge
474 @patron_ids = grep { $_ ne $self->id } @patron_ids;
476 my $schema = Koha::Database->new()->schema();
480 $self->_result->result_source->schema->txn_do( sub {
481 foreach my $patron_id (@patron_ids) {
482 my $patron = Koha::Patrons->find( $patron_id );
486 # Unbless for safety, the patron will end up being deleted
487 $results->{merged}->{$patron_id}->{patron} = $patron->unblessed;
489 while (my ($r, $field) = each(%$RESULTSET_PATRON_ID_MAPPING)) {
490 my $rs = $schema->resultset($r)->search({ $field => $patron_id });
491 $results->{merged}->{ $patron_id }->{updated}->{$r} = $rs->count();
492 $rs->update({ $field => $self->id });
495 $patron->move_to_deleted();
505 =head3 wants_check_for_previous_checkout
507 $wants_check = $patron->wants_check_for_previous_checkout;
509 Return 1 if Koha needs to perform PrevIssue checking, else 0.
513 sub wants_check_for_previous_checkout {
515 my $syspref = C4::Context->preference("checkPrevCheckout");
518 ## Hard syspref trumps all
519 return 1 if ($syspref eq 'hardyes');
520 return 0 if ($syspref eq 'hardno');
521 ## Now, patron pref trumps all
522 return 1 if ($self->checkprevcheckout eq 'yes');
523 return 0 if ($self->checkprevcheckout eq 'no');
525 # More complex: patron inherits -> determine category preference
526 my $checkPrevCheckoutByCat = $self->category->checkprevcheckout;
527 return 1 if ($checkPrevCheckoutByCat eq 'yes');
528 return 0 if ($checkPrevCheckoutByCat eq 'no');
530 # Finally: category preference is inherit, default to 0
531 if ($syspref eq 'softyes') {
538 =head3 do_check_for_previous_checkout
540 $do_check = $patron->do_check_for_previous_checkout($item);
542 Return 1 if the bib associated with $ITEM has previously been checked out to
543 $PATRON, 0 otherwise.
547 sub do_check_for_previous_checkout {
548 my ( $self, $item ) = @_;
550 # Find all items for bib and extract item numbers.
551 my @items = Koha::Items->search({biblionumber => $item->{biblionumber}});
553 foreach my $item (@items) {
554 push @item_nos, $item->itemnumber;
557 # Create (old)issues search criteria
559 borrowernumber => $self->borrowernumber,
560 itemnumber => \@item_nos,
563 # Check current issues table
564 my $issues = Koha::Checkouts->search($criteria);
565 return 1 if $issues->count; # 0 || N
567 # Check old issues table
568 my $old_issues = Koha::Old::Checkouts->search($criteria);
569 return $old_issues->count; # 0 || N
574 my $debarment_expiration = $patron->is_debarred;
576 Returns the date a patron debarment will expire, or undef if the patron is not
584 return unless $self->debarred;
585 return $self->debarred
586 if $self->debarred =~ '^9999'
587 or dt_from_string( $self->debarred ) > dt_from_string;
593 my $is_expired = $patron->is_expired;
595 Returns 1 if the patron is expired or 0;
601 return 0 unless $self->dateexpiry;
602 return 0 if $self->dateexpiry =~ '^9999';
603 return 1 if dt_from_string( $self->dateexpiry ) < dt_from_string->truncate( to => 'day' );
607 =head3 is_going_to_expire
609 my $is_going_to_expire = $patron->is_going_to_expire;
611 Returns 1 if the patron is going to expired, depending on the NotifyBorrowerDeparture pref or 0
615 sub is_going_to_expire {
618 my $delay = C4::Context->preference('NotifyBorrowerDeparture') || 0;
620 return 0 unless $delay;
621 return 0 unless $self->dateexpiry;
622 return 0 if $self->dateexpiry =~ '^9999';
623 return 1 if dt_from_string( $self->dateexpiry )->subtract( days => $delay ) < dt_from_string->truncate( to => 'day' );
627 =head3 update_password
629 my $updated = $patron->update_password( $userid, $password );
631 Update the userid and the password of a patron.
632 If the userid already exists, returns and let DBIx::Class warns
633 This will add an entry to action_logs if BorrowersLog is set.
637 sub update_password {
638 my ( $self, $userid, $password ) = @_;
639 eval { $self->userid($userid)->store; };
640 return if $@; # Make sure the userid is not already in used by another patron
642 return 0 if $password eq '****' or $password eq '';
644 my $digest = Koha::AuthUtils::hash_password($password);
652 logaction( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
658 $patron->set_password( $plain_text_password );
660 Set the patron's password.
664 The passed string is validated against the current password enforcement policy.
665 Exceptions are thrown if the password is not good enough.
669 =item Koha::Exceptions::Password::TooShort
671 =item Koha::Exceptions::Password::WhitespaceCharacters
673 =item Koha::Exceptions::Password::TooWeak
680 my ( $self, $password ) = @_;
682 my ( $is_valid, $error ) = Koha::AuthUtils::is_password_valid( $password );
685 if ( $error eq 'too_short' ) {
686 my $min_length = C4::Context->preference('minPasswordLength');
687 $min_length = 3 if not $min_length or $min_length < 3;
689 my $password_length = length($password);
690 Koha::Exceptions::Password::TooShort->throw(
691 { length => $password_length, min_length => $min_length } );
693 elsif ( $error eq 'has_whitespaces' ) {
694 Koha::Exceptions::Password::WhitespaceCharacters->throw();
696 elsif ( $error eq 'too_weak' ) {
697 Koha::Exceptions::Password::TooWeak->throw();
701 my $digest = Koha::AuthUtils::hash_password($password);
703 { password => $digest,
708 logaction( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" )
709 if C4::Context->preference("BorrowersLog");
717 my $new_expiry_date = $patron->renew_account
719 Extending the subscription to the expiry date.
726 if ( C4::Context->preference('BorrowerRenewalPeriodBase') eq 'combination' ) {
727 $date = ( dt_from_string gt dt_from_string( $self->dateexpiry ) ) ? dt_from_string : dt_from_string( $self->dateexpiry );
730 C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry'
731 ? dt_from_string( $self->dateexpiry )
734 my $expiry_date = $self->category->get_expiry_date($date);
736 $self->dateexpiry($expiry_date);
737 $self->date_renewed( dt_from_string() );
740 $self->add_enrolment_fee_if_needed;
742 logaction( "MEMBERS", "RENEW", $self->borrowernumber, "Membership renewed" ) if C4::Context->preference("BorrowersLog");
743 return dt_from_string( $expiry_date )->truncate( to => 'day' );
748 my $has_overdues = $patron->has_overdues;
750 Returns the number of patron's overdues
756 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
757 return $self->_result->issues->search({ date_due => { '<' => $dtf->format_datetime( dt_from_string() ) } })->count;
762 $patron->track_login;
763 $patron->track_login({ force => 1 });
765 Tracks a (successful) login attempt.
766 The preference TrackLastPatronActivity must be enabled. Or you
767 should pass the force parameter.
772 my ( $self, $params ) = @_;
775 !C4::Context->preference('TrackLastPatronActivity');
776 $self->lastseen( dt_from_string() )->store;
779 =head3 move_to_deleted
781 my $is_moved = $patron->move_to_deleted;
783 Move a patron to the deletedborrowers table.
784 This can be done before deleting a patron, to make sure the data are not completely deleted.
788 sub move_to_deleted {
790 my $patron_infos = $self->unblessed;
791 delete $patron_infos->{updated_on}; #This ensures the updated_on date in deletedborrowers will be set to the current timestamp
792 return Koha::Database->new->schema->resultset('Deletedborrower')->create($patron_infos);
795 =head3 article_requests
797 my @requests = $borrower->article_requests();
798 my $requests = $borrower->article_requests();
800 Returns either a list of ArticleRequests objects,
801 or an ArtitleRequests object, depending on the
806 sub article_requests {
809 $self->{_article_requests} ||= Koha::ArticleRequests->search({ borrowernumber => $self->borrowernumber() });
811 return $self->{_article_requests};
814 =head3 article_requests_current
816 my @requests = $patron->article_requests_current
818 Returns the article requests associated with this patron that are incomplete
822 sub article_requests_current {
825 $self->{_article_requests_current} ||= Koha::ArticleRequests->search(
827 borrowernumber => $self->id(),
829 { status => Koha::ArticleRequest::Status::Pending },
830 { status => Koha::ArticleRequest::Status::Processing }
835 return $self->{_article_requests_current};
838 =head3 article_requests_finished
840 my @requests = $biblio->article_requests_finished
842 Returns the article requests associated with this patron that are completed
846 sub article_requests_finished {
847 my ( $self, $borrower ) = @_;
849 $self->{_article_requests_finished} ||= Koha::ArticleRequests->search(
851 borrowernumber => $self->id(),
853 { status => Koha::ArticleRequest::Status::Completed },
854 { status => Koha::ArticleRequest::Status::Canceled }
859 return $self->{_article_requests_finished};
862 =head3 add_enrolment_fee_if_needed
864 my $enrolment_fee = $patron->add_enrolment_fee_if_needed;
866 Add enrolment fee for a patron if needed.
870 sub add_enrolment_fee_if_needed {
872 my $enrolment_fee = $self->category->enrolmentfee;
873 if ( $enrolment_fee && $enrolment_fee > 0 ) {
874 # insert fee in patron debts
875 C4::Accounts::manualinvoice( $self->borrowernumber, '', '', 'A', $enrolment_fee );
877 return $enrolment_fee || 0;
882 my $checkouts = $patron->checkouts
888 my $checkouts = $self->_result->issues;
889 return Koha::Checkouts->_new_from_dbic( $checkouts );
892 =head3 pending_checkouts
894 my $pending_checkouts = $patron->pending_checkouts
896 This method will return the same as $self->checkouts, but with a prefetch on
897 items, biblio and biblioitems.
899 It has been introduced to replaced the C4::Members::GetPendingIssues subroutine
901 It should not be used directly, prefer to access fields you need instead of
902 retrieving all these fields in one go.
907 sub pending_checkouts {
909 my $checkouts = $self->_result->issues->search(
913 { -desc => 'me.timestamp' },
914 { -desc => 'issuedate' },
915 { -desc => 'issue_id' }, # Sort by issue_id should be enough
917 prefetch => { item => { biblio => 'biblioitems' } },
920 return Koha::Checkouts->_new_from_dbic( $checkouts );
925 my $old_checkouts = $patron->old_checkouts
931 my $old_checkouts = $self->_result->old_issues;
932 return Koha::Old::Checkouts->_new_from_dbic( $old_checkouts );
937 my $overdue_items = $patron->get_overdues
939 Return the overdue items
945 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
946 return $self->checkouts->search(
948 'me.date_due' => { '<' => $dtf->format_datetime(dt_from_string) },
951 prefetch => { item => { biblio => 'biblioitems' } },
956 =head3 get_routing_lists
958 my @routinglists = $patron->get_routing_lists
960 Returns the routing lists a patron is subscribed to.
964 sub get_routing_lists {
966 my $routing_list_rs = $self->_result->subscriptionroutinglists;
967 return Koha::Subscription::Routinglists->_new_from_dbic($routing_list_rs);
972 my $age = $patron->get_age
974 Return the age of the patron
980 my $today_str = dt_from_string->strftime("%Y-%m-%d");
981 return unless $self->dateofbirth;
982 my $dob_str = dt_from_string( $self->dateofbirth )->strftime("%Y-%m-%d");
984 my ( $dob_y, $dob_m, $dob_d ) = split /-/, $dob_str;
985 my ( $today_y, $today_m, $today_d ) = split /-/, $today_str;
987 my $age = $today_y - $dob_y;
988 if ( $dob_m . $dob_d > $today_m . $today_d ) {
997 my $account = $patron->account
1003 return Koha::Account->new( { patron_id => $self->borrowernumber } );
1008 my $holds = $patron->holds
1010 Return all the holds placed by this patron
1016 my $holds_rs = $self->_result->reserves->search( {}, { order_by => 'reservedate' } );
1017 return Koha::Holds->_new_from_dbic($holds_rs);
1022 my $old_holds = $patron->old_holds
1024 Return all the historical holds for this patron
1030 my $old_holds_rs = $self->_result->old_reserves->search( {}, { order_by => 'reservedate' } );
1031 return Koha::Old::Holds->_new_from_dbic($old_holds_rs);
1034 =head3 notice_email_address
1036 my $email = $patron->notice_email_address;
1038 Return the email address of patron used for notices.
1039 Returns the empty string if no email address.
1043 sub notice_email_address{
1046 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1047 # if syspref is set to 'first valid' (value == OFF), look up email address
1048 if ( $which_address eq 'OFF' ) {
1049 return $self->first_valid_email_address;
1052 return $self->$which_address || '';
1055 =head3 first_valid_email_address
1057 my $first_valid_email_address = $patron->first_valid_email_address
1059 Return the first valid email address for a patron.
1060 For now, the order is defined as email, emailpro, B_email.
1061 Returns the empty string if the borrower has no email addresses.
1065 sub first_valid_email_address {
1068 return $self->email() || $self->emailpro() || $self->B_email() || q{};
1071 =head3 get_club_enrollments
1075 sub get_club_enrollments {
1076 my ( $self, $return_scalar ) = @_;
1078 my $e = Koha::Club::Enrollments->search( { borrowernumber => $self->borrowernumber(), date_canceled => undef } );
1080 return $e if $return_scalar;
1082 return wantarray ? $e->as_list : $e;
1085 =head3 get_enrollable_clubs
1089 sub get_enrollable_clubs {
1090 my ( $self, $is_enrollable_from_opac, $return_scalar ) = @_;
1093 $params->{is_enrollable_from_opac} = $is_enrollable_from_opac
1094 if $is_enrollable_from_opac;
1095 $params->{is_email_required} = 0 unless $self->first_valid_email_address();
1097 $params->{borrower} = $self;
1099 my $e = Koha::Clubs->get_enrollable($params);
1101 return $e if $return_scalar;
1103 return wantarray ? $e->as_list : $e;
1106 =head3 account_locked
1108 my $is_locked = $patron->account_locked
1110 Return true if the patron has reach the maximum number of login attempts (see pref FailedLoginAttempts).
1111 Otherwise return false.
1112 If the pref is not set (empty string, null or 0), the feature is considered as disabled.
1116 sub account_locked {
1118 my $FailedLoginAttempts = C4::Context->preference('FailedLoginAttempts');
1119 return ( $FailedLoginAttempts
1120 and $self->login_attempts
1121 and $self->login_attempts >= $FailedLoginAttempts )? 1 : 0;
1124 =head3 can_see_patron_infos
1126 my $can_see = $patron->can_see_patron_infos( $patron );
1128 Return true if the patron (usually the logged in user) can see the patron's infos for a given patron
1132 sub can_see_patron_infos {
1133 my ( $self, $patron ) = @_;
1134 return $self->can_see_patrons_from( $patron->library->branchcode );
1137 =head3 can_see_patrons_from
1139 my $can_see = $patron->can_see_patrons_from( $branchcode );
1141 Return true if the patron (usually the logged in user) can see the patron's infos from a given library
1145 sub can_see_patrons_from {
1146 my ( $self, $branchcode ) = @_;
1148 if ( $self->branchcode eq $branchcode ) {
1150 } elsif ( $self->has_permission( { borrowers => 'view_borrower_infos_from_any_libraries' } ) ) {
1152 } elsif ( my $library_groups = $self->library->library_groups ) {
1153 while ( my $library_group = $library_groups->next ) {
1154 if ( $library_group->parent->has_child( $branchcode ) ) {
1163 =head3 libraries_where_can_see_patrons
1165 my $libraries = $patron-libraries_where_can_see_patrons;
1167 Return the list of branchcodes(!) of libraries the patron is allowed to see other patron's infos.
1168 The branchcodes are arbitrarily returned sorted.
1169 We are supposing here that the object is related to the logged in patron (use of C4::Context::only_my_library)
1171 An empty array means no restriction, the patron can see patron's infos from any libraries.
1175 sub libraries_where_can_see_patrons {
1177 my $userenv = C4::Context->userenv;
1179 return () unless $userenv; # For tests, but userenv should be defined in tests...
1181 my @restricted_branchcodes;
1182 if (C4::Context::only_my_library) {
1183 push @restricted_branchcodes, $self->branchcode;
1187 $self->has_permission(
1188 { borrowers => 'view_borrower_infos_from_any_libraries' }
1192 my $library_groups = $self->library->library_groups({ ft_hide_patron_info => 1 });
1193 if ( $library_groups->count )
1195 while ( my $library_group = $library_groups->next ) {
1196 my $parent = $library_group->parent;
1197 if ( $parent->has_child( $self->branchcode ) ) {
1198 push @restricted_branchcodes, $parent->children->get_column('branchcode');
1203 @restricted_branchcodes = ( $self->branchcode ) unless @restricted_branchcodes;
1207 @restricted_branchcodes = grep { defined $_ } @restricted_branchcodes;
1208 @restricted_branchcodes = uniq(@restricted_branchcodes);
1209 @restricted_branchcodes = sort(@restricted_branchcodes);
1210 return @restricted_branchcodes;
1213 sub has_permission {
1214 my ( $self, $flagsrequired ) = @_;
1215 return unless $self->userid;
1216 # TODO code from haspermission needs to be moved here!
1217 return C4::Auth::haspermission( $self->userid, $flagsrequired );
1222 my $is_adult = $patron->is_adult
1224 Return true if the patron has a category with a type Adult (A) or Organization (I)
1230 return $self->category->category_type =~ /^(A|I)$/ ? 1 : 0;
1235 my $is_child = $patron->is_child
1237 Return true if the patron has a category with a type Child (C)
1242 return $self->category->category_type eq 'C' ? 1 : 0;
1245 =head3 has_valid_userid
1247 my $patron = Koha::Patrons->find(42);
1248 $patron->userid( $new_userid );
1249 my $has_a_valid_userid = $patron->has_valid_userid
1251 my $patron = Koha::Patron->new( $params );
1252 my $has_a_valid_userid = $patron->has_valid_userid
1254 Return true if the current userid of this patron is valid/unique, otherwise false.
1256 Note that this should be done in $self->store instead and raise an exception if needed.
1260 sub has_valid_userid {
1263 return 0 unless $self->userid;
1265 return 0 if ( $self->userid eq C4::Context->config('user') ); # DB user
1267 my $already_exists = Koha::Patrons->search(
1269 userid => $self->userid,
1272 ? ( borrowernumber => { '!=' => $self->borrowernumber } )
1277 return $already_exists ? 0 : 1;
1280 =head3 generate_userid
1282 my $patron = Koha::Patron->new( $params );
1283 $patron->generate_userid
1285 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
1287 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).
1291 sub generate_userid {
1294 my $firstname = $self->firstname // q{};
1295 my $surname = $self->surname // q{};
1296 #The script will "do" the following code and increment the $offset until the generated userid is unique
1298 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1299 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1300 my $userid = lc(($firstname)? "$firstname.$surname" : $surname);
1301 $userid = unac_string('utf-8',$userid);
1302 $userid .= $offset unless $offset == 0;
1303 $self->userid( $userid );
1305 } while (! $self->has_valid_userid );
1311 =head2 Internal methods
1323 Kyle M Hall <kyle@bywatersolutions.com>
1324 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>