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 );
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 if ( ! can_load( modules => { 'Koha::NorwegianPatronDB' => undef } ) ) {
49 warn "Unable to load Koha::NorwegianPatronDB";
52 use base qw(Koha::Object);
54 our $RESULTSET_PATRON_ID_MAPPING = {
55 Accountline => 'borrowernumber',
56 Aqbasketuser => 'borrowernumber',
57 Aqbudget => 'budget_owner_id',
58 Aqbudgetborrower => 'borrowernumber',
59 ArticleRequest => 'borrowernumber',
60 BorrowerAttribute => 'borrowernumber',
61 BorrowerDebarment => 'borrowernumber',
62 BorrowerFile => 'borrowernumber',
63 BorrowerModification => 'borrowernumber',
64 ClubEnrollment => 'borrowernumber',
65 Issue => 'borrowernumber',
66 ItemsLastBorrower => 'borrowernumber',
67 Linktracker => 'borrowernumber',
68 Message => 'borrowernumber',
69 MessageQueue => 'borrowernumber',
70 OldIssue => 'borrowernumber',
71 OldReserve => 'borrowernumber',
72 Rating => 'borrowernumber',
73 Reserve => 'borrowernumber',
74 Review => 'borrowernumber',
75 SearchHistory => 'userid',
76 Statistic => 'borrowernumber',
77 Suggestion => 'suggestedby',
78 TagAll => 'borrowernumber',
79 Virtualshelfcontent => 'borrowernumber',
80 Virtualshelfshare => 'borrowernumber',
81 Virtualshelve => 'owner',
86 Koha::Patron - Koha Patron Object class
99 my ( $class, $params ) = @_;
101 return $class->SUPER::new($params);
104 =head3 fixup_cardnumber
106 Autogenerate next cardnumber from highest value found in database
110 sub fixup_cardnumber {
112 my $max = Koha::Patrons->search({
113 cardnumber => {-regexp => '^-?[0-9]+$'}
115 select => \'CAST(cardnumber AS SIGNED)',
116 as => ['cast_cardnumber']
117 })->_resultset->get_column('cast_cardnumber')->max;
118 $self->cardnumber(($max || 0) +1);
121 =head3 trim_whitespace
123 trim whitespace from data which has some non-whitespace in it.
124 Could be moved to Koha::Object if need to be reused
128 sub trim_whitespaces {
131 my $schema = Koha::Database->new->schema;
132 my @columns = $schema->source($self->_type)->columns;
134 for my $column( @columns ) {
135 my $value = $self->$column;
136 if ( defined $value ) {
137 $value =~ s/^\s*|\s*$//g;
138 $self->$column($value);
144 =head3 plain_text_password
146 $patron->plain_text_password( $password );
148 stores a copy of the unencrypted password in the object
149 for use in code before encrypting for db
153 sub plain_text_password {
154 my ( $self, $password ) = @_;
156 $self->{_plain_text_password} = $password;
159 return $self->{_plain_text_password}
160 if $self->{_plain_text_password};
167 Patron specific store method to cleanup record
168 and do other necessary things before saving
176 $self->_result->result_source->schema->txn_do(
179 C4::Context->preference("autoMemberNum")
180 and ( not defined $self->cardnumber
181 or $self->cardnumber eq '' )
184 # Warning: The caller is responsible for locking the members table in write
185 # mode, to avoid database corruption.
186 # We are in a transaction but the table is not locked
187 $self->fixup_cardnumber;
190 unless( $self->category->in_storage ) {
191 Koha::Exceptions::Object::FKConstraint->throw(
192 broken_fk => 'categorycode',
193 value => $self->categorycode,
197 $self->trim_whitespaces;
199 # We don't want invalid dates in the db (mysql has a bad habit of inserting 0000-00-00)
200 $self->dateofbirth(undef) unless $self->dateofbirth;
201 $self->debarred(undef) unless $self->debarred;
203 # Set default values if not set
204 $self->sms_provider_id(undef) unless $self->sms_provider_id;
205 $self->guarantorid(undef) unless $self->guarantorid;
207 unless ( $self->in_storage ) { #AddMember
209 # Generate a valid userid/login if needed
210 $self->generate_userid
211 if not $self->userid or not $self->has_valid_userid;
213 # Add expiration date if it isn't already there
214 unless ( $self->dateexpiry ) {
215 $self->dateexpiry( $self->category->get_expiry_date );
218 # Add enrollment date if it isn't already there
219 unless ( $self->dateenrolled ) {
220 $self->dateenrolled(dt_from_string);
223 # Set the privacy depending on the patron's category
224 my $default_privacy = $self->category->default_privacy || q{};
226 $default_privacy eq 'default' ? 1
227 : $default_privacy eq 'never' ? 2
228 : $default_privacy eq 'forever' ? 0
230 $self->privacy($default_privacy);
232 unless ( defined $self->privacy_guarantor_checkouts ) {
233 $self->privacy_guarantor_checkouts(0);
236 # Make a copy of the plain text password for later use
237 $self->plain_text_password( $self->password );
239 # Create a disabled account if no password provided
240 $self->password( $self->password
241 ? Koha::AuthUtils::hash_password( $self->password )
244 $self->borrowernumber(undef);
246 $self = $self->SUPER::store;
248 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
249 # cronjob will use for syncing with NL
250 if ( C4::Context->preference('NorwegianPatronDBEnable')
251 && C4::Context->preference('NorwegianPatronDBEnable') == 1 )
253 Koha::Database->new->schema->resultset('BorrowerSync')
256 'borrowernumber' => $self->borrowernumber,
257 'synctype' => 'norwegianpatrondb',
259 'syncstatus' => 'new',
261 Koha::NorwegianPatronDB::NLEncryptPIN($self->plain_text_password),
266 $self->add_enrolment_fee_if_needed;
268 logaction( "MEMBERS", "CREATE", $self->borrowernumber, "" )
269 if C4::Context->preference("BorrowersLog");
273 # Come from ModMember, but should not be possible (?)
274 $self->dateenrolled(undef) unless $self->dateenrolled;
275 $self->dateexpiry(undef) unless $self->dateexpiry;
278 my $self_from_storage = $self->get_from_storage;
279 # FIXME We should not deal with that here, callers have to do this job
280 # Moved from ModMember to prevent regressions
281 unless ( $self->userid ) {
282 my $stored_userid = $self_from_storage->userid;
283 $self->userid($stored_userid);
286 # Password must be updated using $self->update_password
287 $self->password($self_from_storage->password);
289 if ( C4::Context->preference('FeeOnChangePatronCategory')
290 and $self->category->categorycode ne
291 $self_from_storage->category->categorycode )
293 $self->add_enrolment_fee_if_needed;
296 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
297 # cronjob will use for syncing with NL
298 if ( C4::Context->preference('NorwegianPatronDBEnable')
299 && C4::Context->preference('NorwegianPatronDBEnable') == 1 )
301 my $borrowersync = Koha::Database->new->schema->resultset('BorrowerSync')->find({
302 'synctype' => 'norwegianpatrondb',
303 'borrowernumber' => $self->borrowernumber,
305 # Do not set to "edited" if syncstatus is "new". We need to sync as new before
306 # we can sync as changed. And the "new sync" will pick up all changes since
307 # the patron was created anyway.
308 if ( $borrowersync->syncstatus ne 'new' && $borrowersync->syncstatus ne 'delete' ) {
309 $borrowersync->update( { 'syncstatus' => 'edited' } );
311 # Set the value of 'sync'
312 # FIXME THIS IS BROKEN # $borrowersync->update( { 'sync' => $data{'sync'} } );
314 # Try to do the live sync
315 Koha::NorwegianPatronDB::NLSync({ 'borrowernumber' => $self->borrowernumber });
318 my $borrowers_log = C4::Context->preference("BorrowersLog");
319 my $previous_cardnumber = $self_from_storage->cardnumber;
321 && ( !defined $previous_cardnumber
322 || $previous_cardnumber ne $self->cardnumber )
328 $self->borrowernumber,
331 cardnumber_replaced => {
332 previous_cardnumber => $previous_cardnumber,
333 new_cardnumber => $self->cardnumber,
336 { utf8 => 1, pretty => 1 }
341 logaction( "MEMBERS", "MODIFY", $self->borrowernumber,
342 "UPDATE (executed w/ arg: " . $self->borrowernumber . ")" )
345 $self = $self->SUPER::store;
356 Delete patron's holds, lists and finally the patron.
358 Lists owned by the borrower are deleted, but entries from the borrower to
359 other lists are kept.
367 $self->_result->result_source->schema->txn_do(
369 # Delete Patron's holds
370 $self->holds->delete;
372 # Delete all lists and all shares of this borrower
373 # Consistent with the approach Koha uses on deleting individual lists
374 # Note that entries in virtualshelfcontents added by this borrower to
375 # lists of others will be handled by a table constraint: the borrower
376 # is set to NULL in those entries.
378 # We could handle the above deletes via a constraint too.
379 # But a new BZ report 11889 has been opened to discuss another approach.
380 # Instead of deleting we could also disown lists (based on a pref).
381 # In that way we could save shared and public lists.
382 # The current table constraints support that idea now.
383 # This pref should then govern the results of other routines/methods such as
384 # Koha::Virtualshelf->new->delete too.
385 # FIXME Could be $patron->get_lists
386 $_->delete for Koha::Virtualshelves->search( { owner => $self->borrowernumber } );
388 $deleted = $self->SUPER::delete;
390 logaction( "MEMBERS", "DELETE", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
399 my $patron_category = $patron->category
401 Return the patron category for this patron
407 return Koha::Patron::Category->_new_from_dbic( $self->_result->categorycode );
412 Returns a Koha::Patron object for this patron's guarantor
419 return unless $self->guarantorid();
421 return Koha::Patrons->find( $self->guarantorid() );
427 return scalar Koha::Patron::Images->find( $self->borrowernumber );
432 return Koha::Library->_new_from_dbic($self->_result->branchcode);
437 Returns the guarantees (list of Koha::Patron) of this patron
444 return Koha::Patrons->search( { guarantorid => $self->borrowernumber }, { order_by => { -asc => ['surname','firstname'] } } );
447 =head3 housebound_profile
449 Returns the HouseboundProfile associated with this patron.
453 sub housebound_profile {
455 my $profile = $self->_result->housebound_profile;
456 return Koha::Patron::HouseboundProfile->_new_from_dbic($profile)
461 =head3 housebound_role
463 Returns the HouseboundRole associated with this patron.
467 sub housebound_role {
470 my $role = $self->_result->housebound_role;
471 return Koha::Patron::HouseboundRole->_new_from_dbic($role) if ( $role );
477 Returns the siblings of this patron.
484 my $guarantor = $self->guarantor;
486 return unless $guarantor;
488 return Koha::Patrons->search(
492 '=' => $guarantor->id,
495 '!=' => $self->borrowernumber,
503 my $patron = Koha::Patrons->find($id);
504 $patron->merge_with( \@patron_ids );
506 This subroutine merges a list of patrons into the patron record. This is accomplished by finding
507 all related patron ids for the patrons to be merged in other tables and changing the ids to be that
508 of the keeper patron.
513 my ( $self, $patron_ids ) = @_;
515 my @patron_ids = @{ $patron_ids };
517 # Ensure the keeper isn't in the list of patrons to merge
518 @patron_ids = grep { $_ ne $self->id } @patron_ids;
520 my $schema = Koha::Database->new()->schema();
524 $self->_result->result_source->schema->txn_do( sub {
525 foreach my $patron_id (@patron_ids) {
526 my $patron = Koha::Patrons->find( $patron_id );
530 # Unbless for safety, the patron will end up being deleted
531 $results->{merged}->{$patron_id}->{patron} = $patron->unblessed;
533 while (my ($r, $field) = each(%$RESULTSET_PATRON_ID_MAPPING)) {
534 my $rs = $schema->resultset($r)->search({ $field => $patron_id });
535 $results->{merged}->{ $patron_id }->{updated}->{$r} = $rs->count();
536 $rs->update({ $field => $self->id });
539 $patron->move_to_deleted();
549 =head3 wants_check_for_previous_checkout
551 $wants_check = $patron->wants_check_for_previous_checkout;
553 Return 1 if Koha needs to perform PrevIssue checking, else 0.
557 sub wants_check_for_previous_checkout {
559 my $syspref = C4::Context->preference("checkPrevCheckout");
562 ## Hard syspref trumps all
563 return 1 if ($syspref eq 'hardyes');
564 return 0 if ($syspref eq 'hardno');
565 ## Now, patron pref trumps all
566 return 1 if ($self->checkprevcheckout eq 'yes');
567 return 0 if ($self->checkprevcheckout eq 'no');
569 # More complex: patron inherits -> determine category preference
570 my $checkPrevCheckoutByCat = $self->category->checkprevcheckout;
571 return 1 if ($checkPrevCheckoutByCat eq 'yes');
572 return 0 if ($checkPrevCheckoutByCat eq 'no');
574 # Finally: category preference is inherit, default to 0
575 if ($syspref eq 'softyes') {
582 =head3 do_check_for_previous_checkout
584 $do_check = $patron->do_check_for_previous_checkout($item);
586 Return 1 if the bib associated with $ITEM has previously been checked out to
587 $PATRON, 0 otherwise.
591 sub do_check_for_previous_checkout {
592 my ( $self, $item ) = @_;
594 # Find all items for bib and extract item numbers.
595 my @items = Koha::Items->search({biblionumber => $item->{biblionumber}});
597 foreach my $item (@items) {
598 push @item_nos, $item->itemnumber;
601 # Create (old)issues search criteria
603 borrowernumber => $self->borrowernumber,
604 itemnumber => \@item_nos,
607 # Check current issues table
608 my $issues = Koha::Checkouts->search($criteria);
609 return 1 if $issues->count; # 0 || N
611 # Check old issues table
612 my $old_issues = Koha::Old::Checkouts->search($criteria);
613 return $old_issues->count; # 0 || N
618 my $debarment_expiration = $patron->is_debarred;
620 Returns the date a patron debarment will expire, or undef if the patron is not
628 return unless $self->debarred;
629 return $self->debarred
630 if $self->debarred =~ '^9999'
631 or dt_from_string( $self->debarred ) > dt_from_string;
637 my $is_expired = $patron->is_expired;
639 Returns 1 if the patron is expired or 0;
645 return 0 unless $self->dateexpiry;
646 return 0 if $self->dateexpiry =~ '^9999';
647 return 1 if dt_from_string( $self->dateexpiry ) < dt_from_string->truncate( to => 'day' );
651 =head3 is_going_to_expire
653 my $is_going_to_expire = $patron->is_going_to_expire;
655 Returns 1 if the patron is going to expired, depending on the NotifyBorrowerDeparture pref or 0
659 sub is_going_to_expire {
662 my $delay = C4::Context->preference('NotifyBorrowerDeparture') || 0;
664 return 0 unless $delay;
665 return 0 unless $self->dateexpiry;
666 return 0 if $self->dateexpiry =~ '^9999';
667 return 1 if dt_from_string( $self->dateexpiry )->subtract( days => $delay ) < dt_from_string->truncate( to => 'day' );
671 =head3 update_password
673 my $updated = $patron->update_password( $userid, $password );
675 Update the userid and the password of a patron.
676 If the userid already exists, returns and let DBIx::Class warns
677 This will add an entry to action_logs if BorrowersLog is set.
681 sub update_password {
682 my ( $self, $userid, $password ) = @_;
683 eval { $self->userid($userid)->store; };
684 return if $@; # Make sure the userid is not already in used by another patron
686 return 0 if $password eq '****' or $password eq '';
688 if ( C4::Context->preference('NorwegianPatronDBEnable') && C4::Context->preference('NorwegianPatronDBEnable') == 1 ) {
689 # Update the hashed PIN in borrower_sync.hashed_pin, before Koha hashes it
690 Koha::NorwegianPatronDB::NLUpdateHashedPIN( $self->borrowernumber, $password );
693 my $digest = Koha::AuthUtils::hash_password($password);
701 logaction( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
707 my $new_expiry_date = $patron->renew_account
709 Extending the subscription to the expiry date.
716 if ( C4::Context->preference('BorrowerRenewalPeriodBase') eq 'combination' ) {
717 $date = ( dt_from_string gt dt_from_string( $self->dateexpiry ) ) ? dt_from_string : dt_from_string( $self->dateexpiry );
720 C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry'
721 ? dt_from_string( $self->dateexpiry )
724 my $expiry_date = $self->category->get_expiry_date($date);
726 $self->dateexpiry($expiry_date);
727 $self->date_renewed( dt_from_string() );
730 $self->add_enrolment_fee_if_needed;
732 logaction( "MEMBERS", "RENEW", $self->borrowernumber, "Membership renewed" ) if C4::Context->preference("BorrowersLog");
733 return dt_from_string( $expiry_date )->truncate( to => 'day' );
738 my $has_overdues = $patron->has_overdues;
740 Returns the number of patron's overdues
746 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
747 return $self->_result->issues->search({ date_due => { '<' => $dtf->format_datetime( dt_from_string() ) } })->count;
752 $patron->track_login;
753 $patron->track_login({ force => 1 });
755 Tracks a (successful) login attempt.
756 The preference TrackLastPatronActivity must be enabled. Or you
757 should pass the force parameter.
762 my ( $self, $params ) = @_;
765 !C4::Context->preference('TrackLastPatronActivity');
766 $self->lastseen( dt_from_string() )->store;
769 =head3 move_to_deleted
771 my $is_moved = $patron->move_to_deleted;
773 Move a patron to the deletedborrowers table.
774 This can be done before deleting a patron, to make sure the data are not completely deleted.
778 sub move_to_deleted {
780 my $patron_infos = $self->unblessed;
781 delete $patron_infos->{updated_on}; #This ensures the updated_on date in deletedborrowers will be set to the current timestamp
782 return Koha::Database->new->schema->resultset('Deletedborrower')->create($patron_infos);
785 =head3 article_requests
787 my @requests = $borrower->article_requests();
788 my $requests = $borrower->article_requests();
790 Returns either a list of ArticleRequests objects,
791 or an ArtitleRequests object, depending on the
796 sub article_requests {
799 $self->{_article_requests} ||= Koha::ArticleRequests->search({ borrowernumber => $self->borrowernumber() });
801 return $self->{_article_requests};
804 =head3 article_requests_current
806 my @requests = $patron->article_requests_current
808 Returns the article requests associated with this patron that are incomplete
812 sub article_requests_current {
815 $self->{_article_requests_current} ||= Koha::ArticleRequests->search(
817 borrowernumber => $self->id(),
819 { status => Koha::ArticleRequest::Status::Pending },
820 { status => Koha::ArticleRequest::Status::Processing }
825 return $self->{_article_requests_current};
828 =head3 article_requests_finished
830 my @requests = $biblio->article_requests_finished
832 Returns the article requests associated with this patron that are completed
836 sub article_requests_finished {
837 my ( $self, $borrower ) = @_;
839 $self->{_article_requests_finished} ||= Koha::ArticleRequests->search(
841 borrowernumber => $self->id(),
843 { status => Koha::ArticleRequest::Status::Completed },
844 { status => Koha::ArticleRequest::Status::Canceled }
849 return $self->{_article_requests_finished};
852 =head3 add_enrolment_fee_if_needed
854 my $enrolment_fee = $patron->add_enrolment_fee_if_needed;
856 Add enrolment fee for a patron if needed.
860 sub add_enrolment_fee_if_needed {
862 my $enrolment_fee = $self->category->enrolmentfee;
863 if ( $enrolment_fee && $enrolment_fee > 0 ) {
864 # insert fee in patron debts
865 C4::Accounts::manualinvoice( $self->borrowernumber, '', '', 'A', $enrolment_fee );
867 return $enrolment_fee || 0;
872 my $checkouts = $patron->checkouts
878 my $checkouts = $self->_result->issues;
879 return Koha::Checkouts->_new_from_dbic( $checkouts );
882 =head3 pending_checkouts
884 my $pending_checkouts = $patron->pending_checkouts
886 This method will return the same as $self->checkouts, but with a prefetch on
887 items, biblio and biblioitems.
889 It has been introduced to replaced the C4::Members::GetPendingIssues subroutine
891 It should not be used directly, prefer to access fields you need instead of
892 retrieving all these fields in one go.
897 sub pending_checkouts {
899 my $checkouts = $self->_result->issues->search(
903 { -desc => 'me.timestamp' },
904 { -desc => 'issuedate' },
905 { -desc => 'issue_id' }, # Sort by issue_id should be enough
907 prefetch => { item => { biblio => 'biblioitems' } },
910 return Koha::Checkouts->_new_from_dbic( $checkouts );
915 my $old_checkouts = $patron->old_checkouts
921 my $old_checkouts = $self->_result->old_issues;
922 return Koha::Old::Checkouts->_new_from_dbic( $old_checkouts );
927 my $overdue_items = $patron->get_overdues
929 Return the overdue items
935 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
936 return $self->checkouts->search(
938 'me.date_due' => { '<' => $dtf->format_datetime(dt_from_string) },
941 prefetch => { item => { biblio => 'biblioitems' } },
946 =head3 get_routing_lists
948 my @routinglists = $patron->get_routing_lists
950 Returns the routing lists a patron is subscribed to.
954 sub get_routing_lists {
956 my $routing_list_rs = $self->_result->subscriptionroutinglists;
957 return Koha::Subscription::Routinglists->_new_from_dbic($routing_list_rs);
962 my $age = $patron->get_age
964 Return the age of the patron
970 my $today_str = dt_from_string->strftime("%Y-%m-%d");
971 return unless $self->dateofbirth;
972 my $dob_str = dt_from_string( $self->dateofbirth )->strftime("%Y-%m-%d");
974 my ( $dob_y, $dob_m, $dob_d ) = split /-/, $dob_str;
975 my ( $today_y, $today_m, $today_d ) = split /-/, $today_str;
977 my $age = $today_y - $dob_y;
978 if ( $dob_m . $dob_d > $today_m . $today_d ) {
987 my $account = $patron->account
993 return Koha::Account->new( { patron_id => $self->borrowernumber } );
998 my $holds = $patron->holds
1000 Return all the holds placed by this patron
1006 my $holds_rs = $self->_result->reserves->search( {}, { order_by => 'reservedate' } );
1007 return Koha::Holds->_new_from_dbic($holds_rs);
1012 my $old_holds = $patron->old_holds
1014 Return all the historical holds for this patron
1020 my $old_holds_rs = $self->_result->old_reserves->search( {}, { order_by => 'reservedate' } );
1021 return Koha::Old::Holds->_new_from_dbic($old_holds_rs);
1024 =head3 notice_email_address
1026 my $email = $patron->notice_email_address;
1028 Return the email address of patron used for notices.
1029 Returns the empty string if no email address.
1033 sub notice_email_address{
1036 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1037 # if syspref is set to 'first valid' (value == OFF), look up email address
1038 if ( $which_address eq 'OFF' ) {
1039 return $self->first_valid_email_address;
1042 return $self->$which_address || '';
1045 =head3 first_valid_email_address
1047 my $first_valid_email_address = $patron->first_valid_email_address
1049 Return the first valid email address for a patron.
1050 For now, the order is defined as email, emailpro, B_email.
1051 Returns the empty string if the borrower has no email addresses.
1055 sub first_valid_email_address {
1058 return $self->email() || $self->emailpro() || $self->B_email() || q{};
1061 =head3 get_club_enrollments
1065 sub get_club_enrollments {
1066 my ( $self, $return_scalar ) = @_;
1068 my $e = Koha::Club::Enrollments->search( { borrowernumber => $self->borrowernumber(), date_canceled => undef } );
1070 return $e if $return_scalar;
1072 return wantarray ? $e->as_list : $e;
1075 =head3 get_enrollable_clubs
1079 sub get_enrollable_clubs {
1080 my ( $self, $is_enrollable_from_opac, $return_scalar ) = @_;
1083 $params->{is_enrollable_from_opac} = $is_enrollable_from_opac
1084 if $is_enrollable_from_opac;
1085 $params->{is_email_required} = 0 unless $self->first_valid_email_address();
1087 $params->{borrower} = $self;
1089 my $e = Koha::Clubs->get_enrollable($params);
1091 return $e if $return_scalar;
1093 return wantarray ? $e->as_list : $e;
1096 =head3 account_locked
1098 my $is_locked = $patron->account_locked
1100 Return true if the patron has reach the maximum number of login attempts (see pref FailedLoginAttempts).
1101 Otherwise return false.
1102 If the pref is not set (empty string, null or 0), the feature is considered as disabled.
1106 sub account_locked {
1108 my $FailedLoginAttempts = C4::Context->preference('FailedLoginAttempts');
1109 return ( $FailedLoginAttempts
1110 and $self->login_attempts
1111 and $self->login_attempts >= $FailedLoginAttempts )? 1 : 0;
1114 =head3 can_see_patron_infos
1116 my $can_see = $patron->can_see_patron_infos( $patron );
1118 Return true if the patron (usually the logged in user) can see the patron's infos for a given patron
1122 sub can_see_patron_infos {
1123 my ( $self, $patron ) = @_;
1124 return $self->can_see_patrons_from( $patron->library->branchcode );
1127 =head3 can_see_patrons_from
1129 my $can_see = $patron->can_see_patrons_from( $branchcode );
1131 Return true if the patron (usually the logged in user) can see the patron's infos from a given library
1135 sub can_see_patrons_from {
1136 my ( $self, $branchcode ) = @_;
1138 if ( $self->branchcode eq $branchcode ) {
1140 } elsif ( $self->has_permission( { borrowers => 'view_borrower_infos_from_any_libraries' } ) ) {
1142 } elsif ( my $library_groups = $self->library->library_groups ) {
1143 while ( my $library_group = $library_groups->next ) {
1144 if ( $library_group->parent->has_child( $branchcode ) ) {
1153 =head3 libraries_where_can_see_patrons
1155 my $libraries = $patron-libraries_where_can_see_patrons;
1157 Return the list of branchcodes(!) of libraries the patron is allowed to see other patron's infos.
1158 The branchcodes are arbitrarily returned sorted.
1159 We are supposing here that the object is related to the logged in patron (use of C4::Context::only_my_library)
1161 An empty array means no restriction, the patron can see patron's infos from any libraries.
1165 sub libraries_where_can_see_patrons {
1167 my $userenv = C4::Context->userenv;
1169 return () unless $userenv; # For tests, but userenv should be defined in tests...
1171 my @restricted_branchcodes;
1172 if (C4::Context::only_my_library) {
1173 push @restricted_branchcodes, $self->branchcode;
1177 $self->has_permission(
1178 { borrowers => 'view_borrower_infos_from_any_libraries' }
1182 my $library_groups = $self->library->library_groups({ ft_hide_patron_info => 1 });
1183 if ( $library_groups->count )
1185 while ( my $library_group = $library_groups->next ) {
1186 my $parent = $library_group->parent;
1187 if ( $parent->has_child( $self->branchcode ) ) {
1188 push @restricted_branchcodes, $parent->children->get_column('branchcode');
1193 @restricted_branchcodes = ( $self->branchcode ) unless @restricted_branchcodes;
1197 @restricted_branchcodes = grep { defined $_ } @restricted_branchcodes;
1198 @restricted_branchcodes = uniq(@restricted_branchcodes);
1199 @restricted_branchcodes = sort(@restricted_branchcodes);
1200 return @restricted_branchcodes;
1203 sub has_permission {
1204 my ( $self, $flagsrequired ) = @_;
1205 return unless $self->userid;
1206 # TODO code from haspermission needs to be moved here!
1207 return C4::Auth::haspermission( $self->userid, $flagsrequired );
1212 my $is_adult = $patron->is_adult
1214 Return true if the patron has a category with a type Adult (A) or Organization (I)
1220 return $self->category->category_type =~ /^(A|I)$/ ? 1 : 0;
1225 my $is_child = $patron->is_child
1227 Return true if the patron has a category with a type Child (C)
1232 return $self->category->category_type eq 'C' ? 1 : 0;
1235 =head3 has_valid_userid
1237 my $patron = Koha::Patrons->find(42);
1238 $patron->userid( $new_userid );
1239 my $has_a_valid_userid = $patron->has_valid_userid
1241 my $patron = Koha::Patron->new( $params );
1242 my $has_a_valid_userid = $patron->has_valid_userid
1244 Return true if the current userid of this patron is valid/unique, otherwise false.
1246 Note that this should be done in $self->store instead and raise an exception if needed.
1250 sub has_valid_userid {
1253 return 0 unless $self->userid;
1255 return 0 if ( $self->userid eq C4::Context->config('user') ); # DB user
1257 my $already_exists = Koha::Patrons->search(
1259 userid => $self->userid,
1262 ? ( borrowernumber => { '!=' => $self->borrowernumber } )
1267 return $already_exists ? 0 : 1;
1270 =head3 generate_userid
1272 my $patron = Koha::Patron->new( $params );
1273 $patron->generate_userid
1275 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
1277 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).
1281 sub generate_userid {
1284 my $firstname = $self->firstname // q{};
1285 my $surname = $self->surname // q{};
1286 #The script will "do" the following code and increment the $offset until the generated userid is unique
1288 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1289 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1290 my $userid = lc(($firstname)? "$firstname.$surname" : $surname);
1291 $userid = unac_string('utf-8',$userid);
1292 $userid .= $offset unless $offset == 0;
1293 $self->userid( $userid );
1295 } while (! $self->has_valid_userid );
1301 =head2 Internal methods
1313 Kyle M Hall <kyle@bywatersolutions.com>
1314 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>