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 # Set surname to uppercase if uppercasesurname is true
196 $self->surname( uc($self->surname) )
197 if C4::Context->preference("uppercasesurname");
199 unless ( $self->in_storage ) { #AddMember
201 # Generate a valid userid/login if needed
202 $self->generate_userid
203 if not $self->userid or not $self->has_valid_userid;
205 # Add expiration date if it isn't already there
206 unless ( $self->dateexpiry ) {
207 $self->dateexpiry( $self->category->get_expiry_date );
210 # Add enrollment date if it isn't already there
211 unless ( $self->dateenrolled ) {
212 $self->dateenrolled(dt_from_string
);
215 # Set the privacy depending on the patron's category
216 my $default_privacy = $self->category->default_privacy || q{};
218 $default_privacy eq 'default' ?
1
219 : $default_privacy eq 'never' ?
2
220 : $default_privacy eq 'forever' ?
0
222 $self->privacy($default_privacy);
225 # Make a copy of the plain text password for later use
226 $self->plain_text_password( $self->password );
228 # Create a disabled account if no password provided
229 $self->password( $self->password
230 ? Koha
::AuthUtils
::hash_password
( $self->password )
233 $self->borrowernumber(undef);
235 $self = $self->SUPER::store
;
237 $self->add_enrolment_fee_if_needed;
239 logaction
( "MEMBERS", "CREATE", $self->borrowernumber, "" )
240 if C4
::Context
->preference("BorrowersLog");
244 my $self_from_storage = $self->get_from_storage;
245 # FIXME We should not deal with that here, callers have to do this job
246 # Moved from ModMember to prevent regressions
247 unless ( $self->userid ) {
248 my $stored_userid = $self_from_storage->userid;
249 $self->userid($stored_userid);
252 # Password must be updated using $self->update_password
253 $self->password($self_from_storage->password);
255 if ( C4
::Context
->preference('FeeOnChangePatronCategory')
256 and $self->category->categorycode ne
257 $self_from_storage->category->categorycode )
259 $self->add_enrolment_fee_if_needed;
262 my $borrowers_log = C4
::Context
->preference("BorrowersLog");
263 my $previous_cardnumber = $self_from_storage->cardnumber;
265 && ( !defined $previous_cardnumber
266 || $previous_cardnumber ne $self->cardnumber )
272 $self->borrowernumber,
275 cardnumber_replaced
=> {
276 previous_cardnumber
=> $previous_cardnumber,
277 new_cardnumber
=> $self->cardnumber,
280 { utf8
=> 1, pretty
=> 1 }
285 logaction
( "MEMBERS", "MODIFY", $self->borrowernumber,
286 "UPDATE (executed w/ arg: " . $self->borrowernumber . ")" )
289 $self = $self->SUPER::store
;
300 Delete patron's holds, lists and finally the patron.
302 Lists owned by the borrower are deleted, but entries from the borrower to
303 other lists are kept.
311 $self->_result->result_source->schema->txn_do(
313 # Delete Patron's holds
314 $self->holds->delete;
316 # Delete all lists and all shares of this borrower
317 # Consistent with the approach Koha uses on deleting individual lists
318 # Note that entries in virtualshelfcontents added by this borrower to
319 # lists of others will be handled by a table constraint: the borrower
320 # is set to NULL in those entries.
322 # We could handle the above deletes via a constraint too.
323 # But a new BZ report 11889 has been opened to discuss another approach.
324 # Instead of deleting we could also disown lists (based on a pref).
325 # In that way we could save shared and public lists.
326 # The current table constraints support that idea now.
327 # This pref should then govern the results of other routines/methods such as
328 # Koha::Virtualshelf->new->delete too.
329 # FIXME Could be $patron->get_lists
330 $_->delete for Koha
::Virtualshelves
->search( { owner
=> $self->borrowernumber } );
332 $deleted = $self->SUPER::delete;
334 logaction
( "MEMBERS", "DELETE", $self->borrowernumber, "" ) if C4
::Context
->preference("BorrowersLog");
343 my $patron_category = $patron->category
345 Return the patron category for this patron
351 return Koha
::Patron
::Category
->_new_from_dbic( $self->_result->categorycode );
356 Returns a Koha::Patron object for this patron's guarantor
363 return unless $self->guarantorid();
365 return Koha
::Patrons
->find( $self->guarantorid() );
371 return scalar Koha
::Patron
::Images
->find( $self->borrowernumber );
376 return Koha
::Library
->_new_from_dbic($self->_result->branchcode);
381 Returns the guarantees (list of Koha::Patron) of this patron
388 return Koha
::Patrons
->search( { guarantorid
=> $self->borrowernumber }, { order_by
=> { -asc
=> ['surname','firstname'] } } );
391 =head3 housebound_profile
393 Returns the HouseboundProfile associated with this patron.
397 sub housebound_profile
{
399 my $profile = $self->_result->housebound_profile;
400 return Koha
::Patron
::HouseboundProfile
->_new_from_dbic($profile)
405 =head3 housebound_role
407 Returns the HouseboundRole associated with this patron.
411 sub housebound_role
{
414 my $role = $self->_result->housebound_role;
415 return Koha
::Patron
::HouseboundRole
->_new_from_dbic($role) if ( $role );
421 Returns the siblings of this patron.
428 my $guarantor = $self->guarantor;
430 return unless $guarantor;
432 return Koha
::Patrons
->search(
436 '=' => $guarantor->id,
439 '!=' => $self->borrowernumber,
447 my $patron = Koha::Patrons->find($id);
448 $patron->merge_with( \@patron_ids );
450 This subroutine merges a list of patrons into the patron record. This is accomplished by finding
451 all related patron ids for the patrons to be merged in other tables and changing the ids to be that
452 of the keeper patron.
457 my ( $self, $patron_ids ) = @_;
459 my @patron_ids = @
{ $patron_ids };
461 # Ensure the keeper isn't in the list of patrons to merge
462 @patron_ids = grep { $_ ne $self->id } @patron_ids;
464 my $schema = Koha
::Database
->new()->schema();
468 $self->_result->result_source->schema->txn_do( sub {
469 foreach my $patron_id (@patron_ids) {
470 my $patron = Koha
::Patrons
->find( $patron_id );
474 # Unbless for safety, the patron will end up being deleted
475 $results->{merged
}->{$patron_id}->{patron
} = $patron->unblessed;
477 while (my ($r, $field) = each(%$RESULTSET_PATRON_ID_MAPPING)) {
478 my $rs = $schema->resultset($r)->search({ $field => $patron_id });
479 $results->{merged
}->{ $patron_id }->{updated
}->{$r} = $rs->count();
480 $rs->update({ $field => $self->id });
483 $patron->move_to_deleted();
493 =head3 wants_check_for_previous_checkout
495 $wants_check = $patron->wants_check_for_previous_checkout;
497 Return 1 if Koha needs to perform PrevIssue checking, else 0.
501 sub wants_check_for_previous_checkout
{
503 my $syspref = C4
::Context
->preference("checkPrevCheckout");
506 ## Hard syspref trumps all
507 return 1 if ($syspref eq 'hardyes');
508 return 0 if ($syspref eq 'hardno');
509 ## Now, patron pref trumps all
510 return 1 if ($self->checkprevcheckout eq 'yes');
511 return 0 if ($self->checkprevcheckout eq 'no');
513 # More complex: patron inherits -> determine category preference
514 my $checkPrevCheckoutByCat = $self->category->checkprevcheckout;
515 return 1 if ($checkPrevCheckoutByCat eq 'yes');
516 return 0 if ($checkPrevCheckoutByCat eq 'no');
518 # Finally: category preference is inherit, default to 0
519 if ($syspref eq 'softyes') {
526 =head3 do_check_for_previous_checkout
528 $do_check = $patron->do_check_for_previous_checkout($item);
530 Return 1 if the bib associated with $ITEM has previously been checked out to
531 $PATRON, 0 otherwise.
535 sub do_check_for_previous_checkout
{
536 my ( $self, $item ) = @_;
538 # Find all items for bib and extract item numbers.
539 my @items = Koha
::Items
->search({biblionumber
=> $item->{biblionumber
}});
541 foreach my $item (@items) {
542 push @item_nos, $item->itemnumber;
545 # Create (old)issues search criteria
547 borrowernumber
=> $self->borrowernumber,
548 itemnumber
=> \
@item_nos,
551 # Check current issues table
552 my $issues = Koha
::Checkouts
->search($criteria);
553 return 1 if $issues->count; # 0 || N
555 # Check old issues table
556 my $old_issues = Koha
::Old
::Checkouts
->search($criteria);
557 return $old_issues->count; # 0 || N
562 my $debarment_expiration = $patron->is_debarred;
564 Returns the date a patron debarment will expire, or undef if the patron is not
572 return unless $self->debarred;
573 return $self->debarred
574 if $self->debarred =~ '^9999'
575 or dt_from_string
( $self->debarred ) > dt_from_string
;
581 my $is_expired = $patron->is_expired;
583 Returns 1 if the patron is expired or 0;
589 return 0 unless $self->dateexpiry;
590 return 0 if $self->dateexpiry =~ '^9999';
591 return 1 if dt_from_string
( $self->dateexpiry ) < dt_from_string
->truncate( to
=> 'day' );
595 =head3 is_going_to_expire
597 my $is_going_to_expire = $patron->is_going_to_expire;
599 Returns 1 if the patron is going to expired, depending on the NotifyBorrowerDeparture pref or 0
603 sub is_going_to_expire
{
606 my $delay = C4
::Context
->preference('NotifyBorrowerDeparture') || 0;
608 return 0 unless $delay;
609 return 0 unless $self->dateexpiry;
610 return 0 if $self->dateexpiry =~ '^9999';
611 return 1 if dt_from_string
( $self->dateexpiry )->subtract( days
=> $delay ) < dt_from_string
->truncate( to
=> 'day' );
615 =head3 update_password
617 my $updated = $patron->update_password( $userid, $password );
619 Update the userid and the password of a patron.
620 If the userid already exists, returns and let DBIx::Class warns
621 This will add an entry to action_logs if BorrowersLog is set.
625 sub update_password
{
626 my ( $self, $userid, $password ) = @_;
627 eval { $self->userid($userid)->store; };
628 return if $@
; # Make sure the userid is not already in used by another patron
630 return 0 if $password eq '****' or $password eq '';
632 my $digest = Koha
::AuthUtils
::hash_password
($password);
640 logaction
( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" ) if C4
::Context
->preference("BorrowersLog");
646 $patron->set_password({ password => $plain_text_password [, skip_validation => 1 ] });
648 Set the patron's password.
652 The passed string is validated against the current password enforcement policy.
653 Validation can be skipped by passing the I<skip_validation> parameter.
655 Exceptions are thrown if the password is not good enough.
659 =item Koha::Exceptions::Password::TooShort
661 =item Koha::Exceptions::Password::WhitespaceCharacters
663 =item Koha::Exceptions::Password::TooWeak
670 my ( $self, $args ) = @_;
672 my $password = $args->{password
};
674 unless ( $args->{skip_validation
} ) {
675 my ( $is_valid, $error ) = Koha
::AuthUtils
::is_password_valid
( $password );
678 if ( $error eq 'too_short' ) {
679 my $min_length = C4
::Context
->preference('minPasswordLength');
680 $min_length = 3 if not $min_length or $min_length < 3;
682 my $password_length = length($password);
683 Koha
::Exceptions
::Password
::TooShort
->throw(
684 length => $password_length, min_length
=> $min_length );
686 elsif ( $error eq 'has_whitespaces' ) {
687 Koha
::Exceptions
::Password
::WhitespaceCharacters
->throw();
689 elsif ( $error eq 'too_weak' ) {
690 Koha
::Exceptions
::Password
::TooWeak
->throw();
695 my $digest = Koha
::AuthUtils
::hash_password
($password);
697 { password
=> $digest,
702 logaction
( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" )
703 if C4
::Context
->preference("BorrowersLog");
711 my $new_expiry_date = $patron->renew_account
713 Extending the subscription to the expiry date.
720 if ( C4
::Context
->preference('BorrowerRenewalPeriodBase') eq 'combination' ) {
721 $date = ( dt_from_string
gt dt_from_string
( $self->dateexpiry ) ) ? dt_from_string
: dt_from_string
( $self->dateexpiry );
724 C4
::Context
->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry'
725 ? dt_from_string
( $self->dateexpiry )
728 my $expiry_date = $self->category->get_expiry_date($date);
730 $self->dateexpiry($expiry_date);
731 $self->date_renewed( dt_from_string
() );
734 $self->add_enrolment_fee_if_needed;
736 logaction
( "MEMBERS", "RENEW", $self->borrowernumber, "Membership renewed" ) if C4
::Context
->preference("BorrowersLog");
737 return dt_from_string
( $expiry_date )->truncate( to
=> 'day' );
742 my $has_overdues = $patron->has_overdues;
744 Returns the number of patron's overdues
750 my $dtf = Koha
::Database
->new->schema->storage->datetime_parser;
751 return $self->_result->issues->search({ date_due
=> { '<' => $dtf->format_datetime( dt_from_string
() ) } })->count;
756 $patron->track_login;
757 $patron->track_login({ force => 1 });
759 Tracks a (successful) login attempt.
760 The preference TrackLastPatronActivity must be enabled. Or you
761 should pass the force parameter.
766 my ( $self, $params ) = @_;
769 !C4
::Context
->preference('TrackLastPatronActivity');
770 $self->lastseen( dt_from_string
() )->store;
773 =head3 move_to_deleted
775 my $is_moved = $patron->move_to_deleted;
777 Move a patron to the deletedborrowers table.
778 This can be done before deleting a patron, to make sure the data are not completely deleted.
782 sub move_to_deleted
{
784 my $patron_infos = $self->unblessed;
785 delete $patron_infos->{updated_on
}; #This ensures the updated_on date in deletedborrowers will be set to the current timestamp
786 return Koha
::Database
->new->schema->resultset('Deletedborrower')->create($patron_infos);
789 =head3 article_requests
791 my @requests = $borrower->article_requests();
792 my $requests = $borrower->article_requests();
794 Returns either a list of ArticleRequests objects,
795 or an ArtitleRequests object, depending on the
800 sub article_requests
{
803 $self->{_article_requests
} ||= Koha
::ArticleRequests
->search({ borrowernumber
=> $self->borrowernumber() });
805 return $self->{_article_requests
};
808 =head3 article_requests_current
810 my @requests = $patron->article_requests_current
812 Returns the article requests associated with this patron that are incomplete
816 sub article_requests_current
{
819 $self->{_article_requests_current
} ||= Koha
::ArticleRequests
->search(
821 borrowernumber
=> $self->id(),
823 { status
=> Koha
::ArticleRequest
::Status
::Pending
},
824 { status
=> Koha
::ArticleRequest
::Status
::Processing
}
829 return $self->{_article_requests_current
};
832 =head3 article_requests_finished
834 my @requests = $biblio->article_requests_finished
836 Returns the article requests associated with this patron that are completed
840 sub article_requests_finished
{
841 my ( $self, $borrower ) = @_;
843 $self->{_article_requests_finished
} ||= Koha
::ArticleRequests
->search(
845 borrowernumber
=> $self->id(),
847 { status
=> Koha
::ArticleRequest
::Status
::Completed
},
848 { status
=> Koha
::ArticleRequest
::Status
::Canceled
}
853 return $self->{_article_requests_finished
};
856 =head3 add_enrolment_fee_if_needed
858 my $enrolment_fee = $patron->add_enrolment_fee_if_needed;
860 Add enrolment fee for a patron if needed.
864 sub add_enrolment_fee_if_needed
{
866 my $enrolment_fee = $self->category->enrolmentfee;
867 if ( $enrolment_fee && $enrolment_fee > 0 ) {
868 # insert fee in patron debts
869 C4
::Accounts
::manualinvoice
( $self->borrowernumber, '', '', 'A', $enrolment_fee );
871 return $enrolment_fee || 0;
876 my $checkouts = $patron->checkouts
882 my $checkouts = $self->_result->issues;
883 return Koha
::Checkouts
->_new_from_dbic( $checkouts );
886 =head3 pending_checkouts
888 my $pending_checkouts = $patron->pending_checkouts
890 This method will return the same as $self->checkouts, but with a prefetch on
891 items, biblio and biblioitems.
893 It has been introduced to replaced the C4::Members::GetPendingIssues subroutine
895 It should not be used directly, prefer to access fields you need instead of
896 retrieving all these fields in one go.
901 sub pending_checkouts
{
903 my $checkouts = $self->_result->issues->search(
907 { -desc
=> 'me.timestamp' },
908 { -desc
=> 'issuedate' },
909 { -desc
=> 'issue_id' }, # Sort by issue_id should be enough
911 prefetch
=> { item
=> { biblio
=> 'biblioitems' } },
914 return Koha
::Checkouts
->_new_from_dbic( $checkouts );
919 my $old_checkouts = $patron->old_checkouts
925 my $old_checkouts = $self->_result->old_issues;
926 return Koha
::Old
::Checkouts
->_new_from_dbic( $old_checkouts );
931 my $overdue_items = $patron->get_overdues
933 Return the overdue items
939 my $dtf = Koha
::Database
->new->schema->storage->datetime_parser;
940 return $self->checkouts->search(
942 'me.date_due' => { '<' => $dtf->format_datetime(dt_from_string
) },
945 prefetch
=> { item
=> { biblio
=> 'biblioitems' } },
950 =head3 get_routing_lists
952 my @routinglists = $patron->get_routing_lists
954 Returns the routing lists a patron is subscribed to.
958 sub get_routing_lists
{
960 my $routing_list_rs = $self->_result->subscriptionroutinglists;
961 return Koha
::Subscription
::Routinglists
->_new_from_dbic($routing_list_rs);
966 my $age = $patron->get_age
968 Return the age of the patron
974 my $today_str = dt_from_string
->strftime("%Y-%m-%d");
975 return unless $self->dateofbirth;
976 my $dob_str = dt_from_string
( $self->dateofbirth )->strftime("%Y-%m-%d");
978 my ( $dob_y, $dob_m, $dob_d ) = split /-/, $dob_str;
979 my ( $today_y, $today_m, $today_d ) = split /-/, $today_str;
981 my $age = $today_y - $dob_y;
982 if ( $dob_m . $dob_d > $today_m . $today_d ) {
991 my $account = $patron->account
997 return Koha
::Account
->new( { patron_id
=> $self->borrowernumber } );
1002 my $holds = $patron->holds
1004 Return all the holds placed by this patron
1010 my $holds_rs = $self->_result->reserves->search( {}, { order_by
=> 'reservedate' } );
1011 return Koha
::Holds
->_new_from_dbic($holds_rs);
1016 my $old_holds = $patron->old_holds
1018 Return all the historical holds for this patron
1024 my $old_holds_rs = $self->_result->old_reserves->search( {}, { order_by
=> 'reservedate' } );
1025 return Koha
::Old
::Holds
->_new_from_dbic($old_holds_rs);
1028 =head3 notice_email_address
1030 my $email = $patron->notice_email_address;
1032 Return the email address of patron used for notices.
1033 Returns the empty string if no email address.
1037 sub notice_email_address
{
1040 my $which_address = C4
::Context
->preference("AutoEmailPrimaryAddress");
1041 # if syspref is set to 'first valid' (value == OFF), look up email address
1042 if ( $which_address eq 'OFF' ) {
1043 return $self->first_valid_email_address;
1046 return $self->$which_address || '';
1049 =head3 first_valid_email_address
1051 my $first_valid_email_address = $patron->first_valid_email_address
1053 Return the first valid email address for a patron.
1054 For now, the order is defined as email, emailpro, B_email.
1055 Returns the empty string if the borrower has no email addresses.
1059 sub first_valid_email_address
{
1062 return $self->email() || $self->emailpro() || $self->B_email() || q{};
1065 =head3 get_club_enrollments
1069 sub get_club_enrollments
{
1070 my ( $self, $return_scalar ) = @_;
1072 my $e = Koha
::Club
::Enrollments
->search( { borrowernumber
=> $self->borrowernumber(), date_canceled
=> undef } );
1074 return $e if $return_scalar;
1076 return wantarray ?
$e->as_list : $e;
1079 =head3 get_enrollable_clubs
1083 sub get_enrollable_clubs
{
1084 my ( $self, $is_enrollable_from_opac, $return_scalar ) = @_;
1087 $params->{is_enrollable_from_opac
} = $is_enrollable_from_opac
1088 if $is_enrollable_from_opac;
1089 $params->{is_email_required
} = 0 unless $self->first_valid_email_address();
1091 $params->{borrower
} = $self;
1093 my $e = Koha
::Clubs
->get_enrollable($params);
1095 return $e if $return_scalar;
1097 return wantarray ?
$e->as_list : $e;
1100 =head3 account_locked
1102 my $is_locked = $patron->account_locked
1104 Return true if the patron has reach the maximum number of login attempts (see pref FailedLoginAttempts).
1105 Otherwise return false.
1106 If the pref is not set (empty string, null or 0), the feature is considered as disabled.
1110 sub account_locked
{
1112 my $FailedLoginAttempts = C4
::Context
->preference('FailedLoginAttempts');
1113 return ( $FailedLoginAttempts
1114 and $self->login_attempts
1115 and $self->login_attempts >= $FailedLoginAttempts )?
1 : 0;
1118 =head3 can_see_patron_infos
1120 my $can_see = $patron->can_see_patron_infos( $patron );
1122 Return true if the patron (usually the logged in user) can see the patron's infos for a given patron
1126 sub can_see_patron_infos
{
1127 my ( $self, $patron ) = @_;
1128 return unless $patron;
1129 return $self->can_see_patrons_from( $patron->library->branchcode );
1132 =head3 can_see_patrons_from
1134 my $can_see = $patron->can_see_patrons_from( $branchcode );
1136 Return true if the patron (usually the logged in user) can see the patron's infos from a given library
1140 sub can_see_patrons_from
{
1141 my ( $self, $branchcode ) = @_;
1143 if ( $self->branchcode eq $branchcode ) {
1145 } elsif ( $self->has_permission( { borrowers
=> 'view_borrower_infos_from_any_libraries' } ) ) {
1147 } elsif ( my $library_groups = $self->library->library_groups ) {
1148 while ( my $library_group = $library_groups->next ) {
1149 if ( $library_group->parent->has_child( $branchcode ) ) {
1158 =head3 libraries_where_can_see_patrons
1160 my $libraries = $patron-libraries_where_can_see_patrons;
1162 Return the list of branchcodes(!) of libraries the patron is allowed to see other patron's infos.
1163 The branchcodes are arbitrarily returned sorted.
1164 We are supposing here that the object is related to the logged in patron (use of C4::Context::only_my_library)
1166 An empty array means no restriction, the patron can see patron's infos from any libraries.
1170 sub libraries_where_can_see_patrons
{
1172 my $userenv = C4
::Context
->userenv;
1174 return () unless $userenv; # For tests, but userenv should be defined in tests...
1176 my @restricted_branchcodes;
1177 if (C4
::Context
::only_my_library
) {
1178 push @restricted_branchcodes, $self->branchcode;
1182 $self->has_permission(
1183 { borrowers
=> 'view_borrower_infos_from_any_libraries' }
1187 my $library_groups = $self->library->library_groups({ ft_hide_patron_info
=> 1 });
1188 if ( $library_groups->count )
1190 while ( my $library_group = $library_groups->next ) {
1191 my $parent = $library_group->parent;
1192 if ( $parent->has_child( $self->branchcode ) ) {
1193 push @restricted_branchcodes, $parent->children->get_column('branchcode');
1198 @restricted_branchcodes = ( $self->branchcode ) unless @restricted_branchcodes;
1202 @restricted_branchcodes = grep { defined $_ } @restricted_branchcodes;
1203 @restricted_branchcodes = uniq
(@restricted_branchcodes);
1204 @restricted_branchcodes = sort(@restricted_branchcodes);
1205 return @restricted_branchcodes;
1208 sub has_permission
{
1209 my ( $self, $flagsrequired ) = @_;
1210 return unless $self->userid;
1211 # TODO code from haspermission needs to be moved here!
1212 return C4
::Auth
::haspermission
( $self->userid, $flagsrequired );
1217 my $is_adult = $patron->is_adult
1219 Return true if the patron has a category with a type Adult (A) or Organization (I)
1225 return $self->category->category_type =~ /^(A|I)$/ ?
1 : 0;
1230 my $is_child = $patron->is_child
1232 Return true if the patron has a category with a type Child (C)
1237 return $self->category->category_type eq 'C' ?
1 : 0;
1240 =head3 has_valid_userid
1242 my $patron = Koha::Patrons->find(42);
1243 $patron->userid( $new_userid );
1244 my $has_a_valid_userid = $patron->has_valid_userid
1246 my $patron = Koha::Patron->new( $params );
1247 my $has_a_valid_userid = $patron->has_valid_userid
1249 Return true if the current userid of this patron is valid/unique, otherwise false.
1251 Note that this should be done in $self->store instead and raise an exception if needed.
1255 sub has_valid_userid
{
1258 return 0 unless $self->userid;
1260 return 0 if ( $self->userid eq C4
::Context
->config('user') ); # DB user
1262 my $already_exists = Koha
::Patrons
->search(
1264 userid
=> $self->userid,
1267 ?
( borrowernumber
=> { '!=' => $self->borrowernumber } )
1272 return $already_exists ?
0 : 1;
1275 =head3 generate_userid
1277 my $patron = Koha::Patron->new( $params );
1278 $patron->generate_userid
1280 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
1282 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).
1286 sub generate_userid
{
1289 my $firstname = $self->firstname // q{};
1290 my $surname = $self->surname // q{};
1291 #The script will "do" the following code and increment the $offset until the generated userid is unique
1293 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1294 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1295 my $userid = lc(($firstname)?
"$firstname.$surname" : $surname);
1296 $userid = unac_string
('utf-8',$userid);
1297 $userid .= $offset unless $offset == 0;
1298 $self->userid( $userid );
1300 } while (! $self->has_valid_userid );
1306 =head2 Internal methods
1318 Kyle M Hall <kyle@bywatersolutions.com>
1319 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>