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 Module::Load::Conditional qw( can_load );
27 use Text::Unaccent qw( unac_string );
35 use Koha::Old::Checkouts;
36 use Koha::Patron::Categories;
37 use Koha::Patron::HouseboundProfile;
38 use Koha::Patron::HouseboundRole;
39 use Koha::Patron::Images;
41 use Koha::Virtualshelves;
42 use Koha::Club::Enrollments;
44 use Koha::Subscription::Routinglists;
46 if ( ! can_load( modules => { 'Koha::NorwegianPatronDB' => undef } ) ) {
47 warn "Unable to load Koha::NorwegianPatronDB";
50 use base qw(Koha::Object);
52 our $RESULTSET_PATRON_ID_MAPPING = {
53 Accountline => 'borrowernumber',
54 Aqbasketuser => 'borrowernumber',
55 Aqbudget => 'budget_owner_id',
56 Aqbudgetborrower => 'borrowernumber',
57 ArticleRequest => 'borrowernumber',
58 BorrowerAttribute => 'borrowernumber',
59 BorrowerDebarment => 'borrowernumber',
60 BorrowerFile => 'borrowernumber',
61 BorrowerModification => 'borrowernumber',
62 ClubEnrollment => 'borrowernumber',
63 Issue => 'borrowernumber',
64 ItemsLastBorrower => 'borrowernumber',
65 Linktracker => 'borrowernumber',
66 Message => 'borrowernumber',
67 MessageQueue => 'borrowernumber',
68 OldIssue => 'borrowernumber',
69 OldReserve => 'borrowernumber',
70 Rating => 'borrowernumber',
71 Reserve => 'borrowernumber',
72 Review => 'borrowernumber',
73 SearchHistory => 'userid',
74 Statistic => 'borrowernumber',
75 Suggestion => 'suggestedby',
76 TagAll => 'borrowernumber',
77 Virtualshelfcontent => 'borrowernumber',
78 Virtualshelfshare => 'borrowernumber',
79 Virtualshelve => 'owner',
84 Koha::Patron - Koha Patron Object class
97 my ( $class, $params ) = @_;
99 return $class->SUPER::new($params);
102 sub fixup_cardnumber {
104 my $max = Koha::Patrons->search({
105 cardnumber => {-regexp => '^-?[0-9]+$'}
107 select => \'CAST(cardnumber AS SIGNED)',
108 as => ['cast_cardnumber']
109 })->_resultset->get_column('cast_cardnumber')->max;
110 $self->cardnumber(($max || 0) +1);
113 # trim whitespace from data which has some non-whitespace in it.
114 # Could be moved to Koha::Object if need to be reused
115 sub trim_whitespaces {
118 my $schema = Koha::Database->new->schema;
119 my @columns = $schema->source($self->_type)->columns;
121 for my $column( @columns ) {
122 my $value = $self->$column;
123 if ( defined $value ) {
124 $value =~ s/^\s*|\s*$//g;
125 $self->$column($value);
131 sub plain_text_password {
132 my ( $self, $password ) = @_;
134 $self->{_plain_text_password} = $password;
137 return $self->{_plain_text_password}
138 if $self->{_plain_text_password};
146 $self->_result->result_source->schema->txn_do(
149 C4::Context->preference("autoMemberNum")
150 and ( not defined $self->cardnumber
151 or $self->cardnumber eq '' )
154 # Warning: The caller is responsible for locking the members table in write
155 # mode, to avoid database corruption.
156 # We are in a transaction but the table is not locked
157 $self->fixup_cardnumber;
160 unless( $self->category->in_storage ) {
161 Koha::Exceptions::Object::FKConstraint->throw(
162 broken_fk => 'categorycode',
163 value => $self->categorycode,
167 $self->trim_whitespaces;
169 # We don't want invalid dates in the db (mysql has a bad habit of inserting 0000-00-00)
170 $self->dateofbirth(undef) unless $self->dateofbirth;
171 $self->debarred(undef) unless $self->debarred;
173 # Set default values if not set
174 $self->sms_provider_id(undef) unless $self->sms_provider_id;
175 $self->guarantorid(undef) unless $self->guarantorid;
177 unless ( $self->in_storage ) { #AddMember
179 # Generate a valid userid/login if needed
180 $self->userid($self->generate_userid)
181 if not $self->userid or not $self->has_valid_userid;
183 # Add expiration date if it isn't already there
184 unless ( $self->dateexpiry ) {
185 $self->dateexpiry( $self->category->get_expiry_date );
188 # Add enrollment date if it isn't already there
189 unless ( $self->dateenrolled ) {
190 $self->dateenrolled(dt_from_string);
193 # Set the privacy depending on the patron's category
194 my $default_privacy = $self->category->default_privacy || q{};
196 $default_privacy eq 'default' ? 1
197 : $default_privacy eq 'never' ? 2
198 : $default_privacy eq 'forever' ? 0
200 $self->privacy($default_privacy);
202 unless ( defined $self->privacy_guarantor_checkouts ) {
203 $self->privacy_guarantor_checkouts(0);
206 # Make a copy of the plain text password for later use
207 $self->plain_text_password( $self->password );
209 # Create a disabled account if no password provided
210 $self->password( $self->password
211 ? Koha::AuthUtils::hash_password( $self->password )
214 $self->borrowernumber(undef);
216 $self = $self->SUPER::store;
218 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
219 # cronjob will use for syncing with NL
220 if ( C4::Context->preference('NorwegianPatronDBEnable')
221 && C4::Context->preference('NorwegianPatronDBEnable') == 1 )
223 Koha::Database->new->schema->resultset('BorrowerSync')
226 'borrowernumber' => $self->borrowernumber,
227 'synctype' => 'norwegianpatrondb',
229 'syncstatus' => 'new',
231 Koha::NorwegianPatronDB::NLEncryptPIN($self->plain_text_password),
236 $self->add_enrolment_fee_if_needed;
238 logaction( "MEMBERS", "CREATE", $self->borrowernumber, "" )
239 if C4::Context->preference("BorrowersLog");
242 # test to know if you must update or not the borrower password
243 if ( defined $self->password ) {
244 if ( $self->password eq '****' or $self->password eq '' ) {
245 $self->password(undef);
247 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
248 # Update the hashed PIN in borrower_sync.hashed_pin, before Koha hashes it
249 Koha::NorwegianPatronDB::NLUpdateHashedPIN( $self->borrowernumber, $self->password );
251 $self->password(Koha::AuthUtils::hash_password($self->password));
255 # Come from ModMember, but should not be possible (?)
256 $self->dateenrolled(undef) unless $self->dateenrolled;
257 $self->dateexpiry(undef) unless $self->dateexpiry;
259 # FIXME We should not deal with that here, callers have to do this job
260 # Moved from ModMember to prevent regressions
261 unless ( $self->userid ) {
262 my $stored_userid = $self->get_from_storage->userid;
263 $self->userid($stored_userid);
266 if ( C4::Context->preference('FeeOnChangePatronCategory')
267 and $self->category->categorycode ne
268 $self->get_from_storage->category->categorycode )
270 $self->add_enrolment_fee_if_needed;
273 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
274 # cronjob will use for syncing with NL
275 if ( C4::Context->preference('NorwegianPatronDBEnable')
276 && C4::Context->preference('NorwegianPatronDBEnable') == 1 )
278 my $borrowersync = Koha::Database->new->schema->resultset('BorrowerSync')->find({
279 'synctype' => 'norwegianpatrondb',
280 'borrowernumber' => $self->borrowernumber,
282 # Do not set to "edited" if syncstatus is "new". We need to sync as new before
283 # we can sync as changed. And the "new sync" will pick up all changes since
284 # the patron was created anyway.
285 if ( $borrowersync->syncstatus ne 'new' && $borrowersync->syncstatus ne 'delete' ) {
286 $borrowersync->update( { 'syncstatus' => 'edited' } );
288 # Set the value of 'sync'
289 # FIXME THIS IS BROKEN # $borrowersync->update( { 'sync' => $data{'sync'} } );
291 # Try to do the live sync
292 Koha::NorwegianPatronDB::NLSync({ 'borrowernumber' => $self->borrowernumber });
295 my $borrowers_log = C4::Context->preference("BorrowersLog");
296 my $previous_cardnumber = $self->get_from_storage->cardnumber;
297 if ( $borrowers_log && $previous_cardnumber ne $self->cardnumber )
302 $self->borrowernumber,
305 cardnumber_replaced => {
306 previous_cardnumber => $previous_cardnumber,
307 new_cardnumber => $self->cardnumber,
310 { utf8 => 1, pretty => 1 }
315 logaction( "MEMBERS", "MODIFY", $self->borrowernumber,
316 "UPDATE (executed w/ arg: " . $self->borrowernumber . ")" )
319 $self = $self->SUPER::store;
330 Delete patron's holds, lists and finally the patron.
332 Lists owned by the borrower are deleted, but entries from the borrower to
333 other lists are kept.
341 $self->_result->result_source->schema->txn_do(
343 # Delete Patron's holds
344 $self->holds->delete;
346 # Delete all lists and all shares of this borrower
347 # Consistent with the approach Koha uses on deleting individual lists
348 # Note that entries in virtualshelfcontents added by this borrower to
349 # lists of others will be handled by a table constraint: the borrower
350 # is set to NULL in those entries.
352 # We could handle the above deletes via a constraint too.
353 # But a new BZ report 11889 has been opened to discuss another approach.
354 # Instead of deleting we could also disown lists (based on a pref).
355 # In that way we could save shared and public lists.
356 # The current table constraints support that idea now.
357 # This pref should then govern the results of other routines/methods such as
358 # Koha::Virtualshelf->new->delete too.
359 # FIXME Could be $patron->get_lists
360 $_->delete for Koha::Virtualshelves->search( { owner => $self->borrowernumber } );
362 $deleted = $self->SUPER::delete;
364 logaction( "MEMBERS", "DELETE", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
373 my $patron_category = $patron->category
375 Return the patron category for this patron
381 return Koha::Patron::Category->_new_from_dbic( $self->_result->categorycode );
386 Returns a Koha::Patron object for this patron's guarantor
393 return unless $self->guarantorid();
395 return Koha::Patrons->find( $self->guarantorid() );
401 return scalar Koha::Patron::Images->find( $self->borrowernumber );
406 return Koha::Library->_new_from_dbic($self->_result->branchcode);
411 Returns the guarantees (list of Koha::Patron) of this patron
418 return Koha::Patrons->search( { guarantorid => $self->borrowernumber } );
421 =head3 housebound_profile
423 Returns the HouseboundProfile associated with this patron.
427 sub housebound_profile {
429 my $profile = $self->_result->housebound_profile;
430 return Koha::Patron::HouseboundProfile->_new_from_dbic($profile)
435 =head3 housebound_role
437 Returns the HouseboundRole associated with this patron.
441 sub housebound_role {
444 my $role = $self->_result->housebound_role;
445 return Koha::Patron::HouseboundRole->_new_from_dbic($role) if ( $role );
451 Returns the siblings of this patron.
458 my $guarantor = $self->guarantor;
460 return unless $guarantor;
462 return Koha::Patrons->search(
466 '=' => $guarantor->id,
469 '!=' => $self->borrowernumber,
477 my $patron = Koha::Patrons->find($id);
478 $patron->merge_with( \@patron_ids );
480 This subroutine merges a list of patrons into the patron record. This is accomplished by finding
481 all related patron ids for the patrons to be merged in other tables and changing the ids to be that
482 of the keeper patron.
487 my ( $self, $patron_ids ) = @_;
489 my @patron_ids = @{ $patron_ids };
491 # Ensure the keeper isn't in the list of patrons to merge
492 @patron_ids = grep { $_ ne $self->id } @patron_ids;
494 my $schema = Koha::Database->new()->schema();
498 $self->_result->result_source->schema->txn_do( sub {
499 foreach my $patron_id (@patron_ids) {
500 my $patron = Koha::Patrons->find( $patron_id );
504 # Unbless for safety, the patron will end up being deleted
505 $results->{merged}->{$patron_id}->{patron} = $patron->unblessed;
507 while (my ($r, $field) = each(%$RESULTSET_PATRON_ID_MAPPING)) {
508 my $rs = $schema->resultset($r)->search({ $field => $patron_id });
509 $results->{merged}->{ $patron_id }->{updated}->{$r} = $rs->count();
510 $rs->update({ $field => $self->id });
513 $patron->move_to_deleted();
523 =head3 wants_check_for_previous_checkout
525 $wants_check = $patron->wants_check_for_previous_checkout;
527 Return 1 if Koha needs to perform PrevIssue checking, else 0.
531 sub wants_check_for_previous_checkout {
533 my $syspref = C4::Context->preference("checkPrevCheckout");
536 ## Hard syspref trumps all
537 return 1 if ($syspref eq 'hardyes');
538 return 0 if ($syspref eq 'hardno');
539 ## Now, patron pref trumps all
540 return 1 if ($self->checkprevcheckout eq 'yes');
541 return 0 if ($self->checkprevcheckout eq 'no');
543 # More complex: patron inherits -> determine category preference
544 my $checkPrevCheckoutByCat = $self->category->checkprevcheckout;
545 return 1 if ($checkPrevCheckoutByCat eq 'yes');
546 return 0 if ($checkPrevCheckoutByCat eq 'no');
548 # Finally: category preference is inherit, default to 0
549 if ($syspref eq 'softyes') {
556 =head3 do_check_for_previous_checkout
558 $do_check = $patron->do_check_for_previous_checkout($item);
560 Return 1 if the bib associated with $ITEM has previously been checked out to
561 $PATRON, 0 otherwise.
565 sub do_check_for_previous_checkout {
566 my ( $self, $item ) = @_;
568 # Find all items for bib and extract item numbers.
569 my @items = Koha::Items->search({biblionumber => $item->{biblionumber}});
571 foreach my $item (@items) {
572 push @item_nos, $item->itemnumber;
575 # Create (old)issues search criteria
577 borrowernumber => $self->borrowernumber,
578 itemnumber => \@item_nos,
581 # Check current issues table
582 my $issues = Koha::Checkouts->search($criteria);
583 return 1 if $issues->count; # 0 || N
585 # Check old issues table
586 my $old_issues = Koha::Old::Checkouts->search($criteria);
587 return $old_issues->count; # 0 || N
592 my $debarment_expiration = $patron->is_debarred;
594 Returns the date a patron debarment will expire, or undef if the patron is not
602 return unless $self->debarred;
603 return $self->debarred
604 if $self->debarred =~ '^9999'
605 or dt_from_string( $self->debarred ) > dt_from_string;
611 my $is_expired = $patron->is_expired;
613 Returns 1 if the patron is expired or 0;
619 return 0 unless $self->dateexpiry;
620 return 0 if $self->dateexpiry =~ '^9999';
621 return 1 if dt_from_string( $self->dateexpiry ) < dt_from_string->truncate( to => 'day' );
625 =head3 is_going_to_expire
627 my $is_going_to_expire = $patron->is_going_to_expire;
629 Returns 1 if the patron is going to expired, depending on the NotifyBorrowerDeparture pref or 0
633 sub is_going_to_expire {
636 my $delay = C4::Context->preference('NotifyBorrowerDeparture') || 0;
638 return 0 unless $delay;
639 return 0 unless $self->dateexpiry;
640 return 0 if $self->dateexpiry =~ '^9999';
641 return 1 if dt_from_string( $self->dateexpiry )->subtract( days => $delay ) < dt_from_string->truncate( to => 'day' );
645 =head3 update_password
647 my $updated = $patron->update_password( $userid, $password );
649 Update the userid and the password of a patron.
650 If the userid already exists, returns and let DBIx::Class warns
651 This will add an entry to action_logs if BorrowersLog is set.
655 sub update_password {
656 my ( $self, $userid, $password ) = @_;
657 eval { $self->userid($userid)->store; };
658 return if $@; # Make sure the userid is not already in used by another patron
661 password => $password,
665 logaction( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
671 my $new_expiry_date = $patron->renew_account
673 Extending the subscription to the expiry date.
680 if ( C4::Context->preference('BorrowerRenewalPeriodBase') eq 'combination' ) {
681 $date = ( dt_from_string gt dt_from_string( $self->dateexpiry ) ) ? dt_from_string : dt_from_string( $self->dateexpiry );
684 C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry'
685 ? dt_from_string( $self->dateexpiry )
688 my $expiry_date = $self->category->get_expiry_date($date);
690 $self->dateexpiry($expiry_date);
691 $self->date_renewed( dt_from_string() );
694 $self->add_enrolment_fee_if_needed;
696 logaction( "MEMBERS", "RENEW", $self->borrowernumber, "Membership renewed" ) if C4::Context->preference("BorrowersLog");
697 return dt_from_string( $expiry_date )->truncate( to => 'day' );
702 my $has_overdues = $patron->has_overdues;
704 Returns the number of patron's overdues
710 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
711 return $self->_result->issues->search({ date_due => { '<' => $dtf->format_datetime( dt_from_string() ) } })->count;
716 $patron->track_login;
717 $patron->track_login({ force => 1 });
719 Tracks a (successful) login attempt.
720 The preference TrackLastPatronActivity must be enabled. Or you
721 should pass the force parameter.
726 my ( $self, $params ) = @_;
729 !C4::Context->preference('TrackLastPatronActivity');
730 $self->lastseen( dt_from_string() )->store;
733 =head3 move_to_deleted
735 my $is_moved = $patron->move_to_deleted;
737 Move a patron to the deletedborrowers table.
738 This can be done before deleting a patron, to make sure the data are not completely deleted.
742 sub move_to_deleted {
744 my $patron_infos = $self->unblessed;
745 delete $patron_infos->{updated_on}; #This ensures the updated_on date in deletedborrowers will be set to the current timestamp
746 return Koha::Database->new->schema->resultset('Deletedborrower')->create($patron_infos);
749 =head3 article_requests
751 my @requests = $borrower->article_requests();
752 my $requests = $borrower->article_requests();
754 Returns either a list of ArticleRequests objects,
755 or an ArtitleRequests object, depending on the
760 sub article_requests {
763 $self->{_article_requests} ||= Koha::ArticleRequests->search({ borrowernumber => $self->borrowernumber() });
765 return $self->{_article_requests};
768 =head3 article_requests_current
770 my @requests = $patron->article_requests_current
772 Returns the article requests associated with this patron that are incomplete
776 sub article_requests_current {
779 $self->{_article_requests_current} ||= Koha::ArticleRequests->search(
781 borrowernumber => $self->id(),
783 { status => Koha::ArticleRequest::Status::Pending },
784 { status => Koha::ArticleRequest::Status::Processing }
789 return $self->{_article_requests_current};
792 =head3 article_requests_finished
794 my @requests = $biblio->article_requests_finished
796 Returns the article requests associated with this patron that are completed
800 sub article_requests_finished {
801 my ( $self, $borrower ) = @_;
803 $self->{_article_requests_finished} ||= Koha::ArticleRequests->search(
805 borrowernumber => $self->id(),
807 { status => Koha::ArticleRequest::Status::Completed },
808 { status => Koha::ArticleRequest::Status::Canceled }
813 return $self->{_article_requests_finished};
816 =head3 add_enrolment_fee_if_needed
818 my $enrolment_fee = $patron->add_enrolment_fee_if_needed;
820 Add enrolment fee for a patron if needed.
824 sub add_enrolment_fee_if_needed {
826 my $enrolment_fee = $self->category->enrolmentfee;
827 if ( $enrolment_fee && $enrolment_fee > 0 ) {
828 # insert fee in patron debts
829 C4::Accounts::manualinvoice( $self->borrowernumber, '', '', 'A', $enrolment_fee );
831 return $enrolment_fee || 0;
836 my $checkouts = $patron->checkouts
842 my $checkouts = $self->_result->issues;
843 return Koha::Checkouts->_new_from_dbic( $checkouts );
846 =head3 pending_checkouts
848 my $pending_checkouts = $patron->pending_checkouts
850 This method will return the same as $self->checkouts, but with a prefetch on
851 items, biblio and biblioitems.
853 It has been introduced to replaced the C4::Members::GetPendingIssues subroutine
855 It should not be used directly, prefer to access fields you need instead of
856 retrieving all these fields in one go.
861 sub pending_checkouts {
863 my $checkouts = $self->_result->issues->search(
867 { -desc => 'me.timestamp' },
868 { -desc => 'issuedate' },
869 { -desc => 'issue_id' }, # Sort by issue_id should be enough
871 prefetch => { item => { biblio => 'biblioitems' } },
874 return Koha::Checkouts->_new_from_dbic( $checkouts );
879 my $old_checkouts = $patron->old_checkouts
885 my $old_checkouts = $self->_result->old_issues;
886 return Koha::Old::Checkouts->_new_from_dbic( $old_checkouts );
891 my $overdue_items = $patron->get_overdues
893 Return the overdue items
899 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
900 return $self->checkouts->search(
902 'me.date_due' => { '<' => $dtf->format_datetime(dt_from_string) },
905 prefetch => { item => { biblio => 'biblioitems' } },
910 =head3 get_routing_lists
912 my @routinglists = $patron->get_routing_lists
914 Returns the routing lists a patron is subscribed to.
918 sub get_routing_lists {
920 my $routing_list_rs = $self->_result->subscriptionroutinglists;
921 return Koha::Subscription::Routinglists->_new_from_dbic($routing_list_rs);
926 my $age = $patron->get_age
928 Return the age of the patron
934 my $today_str = dt_from_string->strftime("%Y-%m-%d");
935 return unless $self->dateofbirth;
936 my $dob_str = dt_from_string( $self->dateofbirth )->strftime("%Y-%m-%d");
938 my ( $dob_y, $dob_m, $dob_d ) = split /-/, $dob_str;
939 my ( $today_y, $today_m, $today_d ) = split /-/, $today_str;
941 my $age = $today_y - $dob_y;
942 if ( $dob_m . $dob_d > $today_m . $today_d ) {
951 my $account = $patron->account
957 return Koha::Account->new( { patron_id => $self->borrowernumber } );
962 my $holds = $patron->holds
964 Return all the holds placed by this patron
970 my $holds_rs = $self->_result->reserves->search( {}, { order_by => 'reservedate' } );
971 return Koha::Holds->_new_from_dbic($holds_rs);
976 my $old_holds = $patron->old_holds
978 Return all the historical holds for this patron
984 my $old_holds_rs = $self->_result->old_reserves->search( {}, { order_by => 'reservedate' } );
985 return Koha::Old::Holds->_new_from_dbic($old_holds_rs);
988 =head3 notice_email_address
990 my $email = $patron->notice_email_address;
992 Return the email address of patron used for notices.
993 Returns the empty string if no email address.
997 sub notice_email_address{
1000 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1001 # if syspref is set to 'first valid' (value == OFF), look up email address
1002 if ( $which_address eq 'OFF' ) {
1003 return $self->first_valid_email_address;
1006 return $self->$which_address || '';
1009 =head3 first_valid_email_address
1011 my $first_valid_email_address = $patron->first_valid_email_address
1013 Return the first valid email address for a patron.
1014 For now, the order is defined as email, emailpro, B_email.
1015 Returns the empty string if the borrower has no email addresses.
1019 sub first_valid_email_address {
1022 return $self->email() || $self->emailpro() || $self->B_email() || q{};
1025 =head3 get_club_enrollments
1029 sub get_club_enrollments {
1030 my ( $self, $return_scalar ) = @_;
1032 my $e = Koha::Club::Enrollments->search( { borrowernumber => $self->borrowernumber(), date_canceled => undef } );
1034 return $e if $return_scalar;
1036 return wantarray ? $e->as_list : $e;
1039 =head3 get_enrollable_clubs
1043 sub get_enrollable_clubs {
1044 my ( $self, $is_enrollable_from_opac, $return_scalar ) = @_;
1047 $params->{is_enrollable_from_opac} = $is_enrollable_from_opac
1048 if $is_enrollable_from_opac;
1049 $params->{is_email_required} = 0 unless $self->first_valid_email_address();
1051 $params->{borrower} = $self;
1053 my $e = Koha::Clubs->get_enrollable($params);
1055 return $e if $return_scalar;
1057 return wantarray ? $e->as_list : $e;
1060 =head3 account_locked
1062 my $is_locked = $patron->account_locked
1064 Return true if the patron has reach the maximum number of login attempts (see pref FailedLoginAttempts).
1065 Otherwise return false.
1066 If the pref is not set (empty string, null or 0), the feature is considered as disabled.
1070 sub account_locked {
1072 my $FailedLoginAttempts = C4::Context->preference('FailedLoginAttempts');
1073 return ( $FailedLoginAttempts
1074 and $self->login_attempts
1075 and $self->login_attempts >= $FailedLoginAttempts )? 1 : 0;
1078 =head3 can_see_patron_infos
1080 my $can_see = $patron->can_see_patron_infos( $patron );
1082 Return true if the patron (usually the logged in user) can see the patron's infos for a given patron
1086 sub can_see_patron_infos {
1087 my ( $self, $patron ) = @_;
1088 return $self->can_see_patrons_from( $patron->library->branchcode );
1091 =head3 can_see_patrons_from
1093 my $can_see = $patron->can_see_patrons_from( $branchcode );
1095 Return true if the patron (usually the logged in user) can see the patron's infos from a given library
1099 sub can_see_patrons_from {
1100 my ( $self, $branchcode ) = @_;
1102 if ( $self->branchcode eq $branchcode ) {
1104 } elsif ( $self->has_permission( { borrowers => 'view_borrower_infos_from_any_libraries' } ) ) {
1106 } elsif ( my $library_groups = $self->library->library_groups ) {
1107 while ( my $library_group = $library_groups->next ) {
1108 if ( $library_group->parent->has_child( $branchcode ) ) {
1117 =head3 libraries_where_can_see_patrons
1119 my $libraries = $patron-libraries_where_can_see_patrons;
1121 Return the list of branchcodes(!) of libraries the patron is allowed to see other patron's infos.
1122 The branchcodes are arbitrarily returned sorted.
1123 We are supposing here that the object is related to the logged in patron (use of C4::Context::only_my_library)
1125 An empty array means no restriction, the patron can see patron's infos from any libraries.
1129 sub libraries_where_can_see_patrons {
1131 my $userenv = C4::Context->userenv;
1133 return () unless $userenv; # For tests, but userenv should be defined in tests...
1135 my @restricted_branchcodes;
1136 if (C4::Context::only_my_library) {
1137 push @restricted_branchcodes, $self->branchcode;
1141 $self->has_permission(
1142 { borrowers => 'view_borrower_infos_from_any_libraries' }
1146 my $library_groups = $self->library->library_groups({ ft_hide_patron_info => 1 });
1147 if ( $library_groups->count )
1149 while ( my $library_group = $library_groups->next ) {
1150 my $parent = $library_group->parent;
1151 if ( $parent->has_child( $self->branchcode ) ) {
1152 push @restricted_branchcodes, $parent->children->get_column('branchcode');
1157 @restricted_branchcodes = ( $self->branchcode ) unless @restricted_branchcodes;
1161 @restricted_branchcodes = grep { defined $_ } @restricted_branchcodes;
1162 @restricted_branchcodes = uniq(@restricted_branchcodes);
1163 @restricted_branchcodes = sort(@restricted_branchcodes);
1164 return @restricted_branchcodes;
1167 sub has_permission {
1168 my ( $self, $flagsrequired ) = @_;
1169 return unless $self->userid;
1170 # TODO code from haspermission needs to be moved here!
1171 return C4::Auth::haspermission( $self->userid, $flagsrequired );
1176 my $is_adult = $patron->is_adult
1178 Return true if the patron has a category with a type Adult (A) or Organization (I)
1184 return $self->category->category_type =~ /^(A|I)$/ ? 1 : 0;
1189 my $is_child = $patron->is_child
1191 Return true if the patron has a category with a type Child (C)
1196 return $self->category->category_type eq 'C' ? 1 : 0;
1199 =head3 has_valid_userid
1201 my $patron = Koha::Patrons->find(42);
1202 $patron->userid( $new_userid );
1203 my $has_a_valid_userid = $patron->has_valid_userid
1205 my $patron = Koha::Patron->new( $params );
1206 my $has_a_valid_userid = $patron->has_valid_userid
1208 Return true if the current userid of this patron is valid/unique, otherwise false.
1210 Note that this should be done in $self->store instead and raise an exception if needed.
1214 sub has_valid_userid {
1217 return 0 unless $self->userid;
1219 return 0 if ( $self->userid eq C4::Context->config('user') ); # DB user
1221 my $already_exists = Koha::Patrons->search(
1223 userid => $self->userid,
1226 ? ( borrowernumber => { '!=' => $self->borrowernumber } )
1231 return $already_exists ? 0 : 1;
1234 =head3 generate_userid
1236 my $patron = Koha::Patron->new( $params );
1237 my $userid = $patron->generate_userid
1239 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
1241 Return the generate 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).
1243 # TODO: Set $self->userid with the generated value
1247 sub generate_userid {
1251 my $existing_userid = $self->userid;
1252 my $firstname = $self->firstname // q{};
1253 my $surname = $self->surname // q{};
1254 #The script will "do" the following code and increment the $offset until the generated userid is unique
1256 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1257 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1258 $userid = lc(($firstname)? "$firstname.$surname" : $surname);
1259 $userid = unac_string('utf-8',$userid);
1260 $userid .= $offset unless $offset == 0;
1261 $self->userid( $userid );
1263 } while (! $self->has_valid_userid );
1265 # Resetting to the previous value as the callers do not expect
1266 # this method to modify the userid attribute
1267 # This will be done later (move of AddMember and ModMember)
1268 $self->userid( $existing_userid );
1274 =head2 Internal methods
1286 Kyle M Hall <kyle@bywatersolutions.com>
1287 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>