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 if ( C4::Context->preference('FeeOnChangePatronCategory')
260 and $self->category->categorycode ne
261 $self->get_from_storage->category->categorycode )
263 $self->add_enrolment_fee_if_needed;
266 # If NorwegianPatronDBEnable is enabled, we set syncstatus to something that a
267 # cronjob will use for syncing with NL
268 if ( C4::Context->preference('NorwegianPatronDBEnable')
269 && C4::Context->preference('NorwegianPatronDBEnable') == 1 )
271 my $borrowersync = Koha::Database->new->schema->resultset('BorrowerSync')->find({
272 'synctype' => 'norwegianpatrondb',
273 'borrowernumber' => $self->borrowernumber,
275 # Do not set to "edited" if syncstatus is "new". We need to sync as new before
276 # we can sync as changed. And the "new sync" will pick up all changes since
277 # the patron was created anyway.
278 if ( $borrowersync->syncstatus ne 'new' && $borrowersync->syncstatus ne 'delete' ) {
279 $borrowersync->update( { 'syncstatus' => 'edited' } );
281 # Set the value of 'sync'
282 # FIXME THIS IS BROKEN # $borrowersync->update( { 'sync' => $data{'sync'} } );
284 # Try to do the live sync
285 Koha::NorwegianPatronDB::NLSync({ 'borrowernumber' => $self->borrowernumber });
288 my $borrowers_log = C4::Context->preference("BorrowersLog");
289 my $previous_cardnumber = $self->get_from_storage->cardnumber;
290 if ( $borrowers_log && $previous_cardnumber ne $self->cardnumber )
295 $self->borrowernumber,
298 cardnumber_replaced => {
299 previous_cardnumber => $previous_cardnumber,
300 new_cardnumber => $self->cardnumber,
303 { utf8 => 1, pretty => 1 }
308 logaction( "MEMBERS", "MODIFY", $self->borrowernumber,
309 "UPDATE (executed w/ arg: " . $self->borrowernumber . ")" )
312 $self = $self->SUPER::store;
323 Delete patron's holds, lists and finally the patron.
325 Lists owned by the borrower are deleted, but entries from the borrower to
326 other lists are kept.
334 $self->_result->result_source->schema->txn_do(
336 # Delete Patron's holds
337 $self->holds->delete;
339 # Delete all lists and all shares of this borrower
340 # Consistent with the approach Koha uses on deleting individual lists
341 # Note that entries in virtualshelfcontents added by this borrower to
342 # lists of others will be handled by a table constraint: the borrower
343 # is set to NULL in those entries.
345 # We could handle the above deletes via a constraint too.
346 # But a new BZ report 11889 has been opened to discuss another approach.
347 # Instead of deleting we could also disown lists (based on a pref).
348 # In that way we could save shared and public lists.
349 # The current table constraints support that idea now.
350 # This pref should then govern the results of other routines/methods such as
351 # Koha::Virtualshelf->new->delete too.
352 # FIXME Could be $patron->get_lists
353 $_->delete for Koha::Virtualshelves->search( { owner => $self->borrowernumber } );
355 $deleted = $self->SUPER::delete;
357 logaction( "MEMBERS", "DELETE", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
366 my $patron_category = $patron->category
368 Return the patron category for this patron
374 return Koha::Patron::Category->_new_from_dbic( $self->_result->categorycode );
379 Returns a Koha::Patron object for this patron's guarantor
386 return unless $self->guarantorid();
388 return Koha::Patrons->find( $self->guarantorid() );
394 return scalar Koha::Patron::Images->find( $self->borrowernumber );
399 return Koha::Library->_new_from_dbic($self->_result->branchcode);
404 Returns the guarantees (list of Koha::Patron) of this patron
411 return Koha::Patrons->search( { guarantorid => $self->borrowernumber } );
414 =head3 housebound_profile
416 Returns the HouseboundProfile associated with this patron.
420 sub housebound_profile {
422 my $profile = $self->_result->housebound_profile;
423 return Koha::Patron::HouseboundProfile->_new_from_dbic($profile)
428 =head3 housebound_role
430 Returns the HouseboundRole associated with this patron.
434 sub housebound_role {
437 my $role = $self->_result->housebound_role;
438 return Koha::Patron::HouseboundRole->_new_from_dbic($role) if ( $role );
444 Returns the siblings of this patron.
451 my $guarantor = $self->guarantor;
453 return unless $guarantor;
455 return Koha::Patrons->search(
459 '=' => $guarantor->id,
462 '!=' => $self->borrowernumber,
470 my $patron = Koha::Patrons->find($id);
471 $patron->merge_with( \@patron_ids );
473 This subroutine merges a list of patrons into the patron record. This is accomplished by finding
474 all related patron ids for the patrons to be merged in other tables and changing the ids to be that
475 of the keeper patron.
480 my ( $self, $patron_ids ) = @_;
482 my @patron_ids = @{ $patron_ids };
484 # Ensure the keeper isn't in the list of patrons to merge
485 @patron_ids = grep { $_ ne $self->id } @patron_ids;
487 my $schema = Koha::Database->new()->schema();
491 $self->_result->result_source->schema->txn_do( sub {
492 foreach my $patron_id (@patron_ids) {
493 my $patron = Koha::Patrons->find( $patron_id );
497 # Unbless for safety, the patron will end up being deleted
498 $results->{merged}->{$patron_id}->{patron} = $patron->unblessed;
500 while (my ($r, $field) = each(%$RESULTSET_PATRON_ID_MAPPING)) {
501 my $rs = $schema->resultset($r)->search({ $field => $patron_id });
502 $results->{merged}->{ $patron_id }->{updated}->{$r} = $rs->count();
503 $rs->update({ $field => $self->id });
506 $patron->move_to_deleted();
516 =head3 wants_check_for_previous_checkout
518 $wants_check = $patron->wants_check_for_previous_checkout;
520 Return 1 if Koha needs to perform PrevIssue checking, else 0.
524 sub wants_check_for_previous_checkout {
526 my $syspref = C4::Context->preference("checkPrevCheckout");
529 ## Hard syspref trumps all
530 return 1 if ($syspref eq 'hardyes');
531 return 0 if ($syspref eq 'hardno');
532 ## Now, patron pref trumps all
533 return 1 if ($self->checkprevcheckout eq 'yes');
534 return 0 if ($self->checkprevcheckout eq 'no');
536 # More complex: patron inherits -> determine category preference
537 my $checkPrevCheckoutByCat = $self->category->checkprevcheckout;
538 return 1 if ($checkPrevCheckoutByCat eq 'yes');
539 return 0 if ($checkPrevCheckoutByCat eq 'no');
541 # Finally: category preference is inherit, default to 0
542 if ($syspref eq 'softyes') {
549 =head3 do_check_for_previous_checkout
551 $do_check = $patron->do_check_for_previous_checkout($item);
553 Return 1 if the bib associated with $ITEM has previously been checked out to
554 $PATRON, 0 otherwise.
558 sub do_check_for_previous_checkout {
559 my ( $self, $item ) = @_;
561 # Find all items for bib and extract item numbers.
562 my @items = Koha::Items->search({biblionumber => $item->{biblionumber}});
564 foreach my $item (@items) {
565 push @item_nos, $item->itemnumber;
568 # Create (old)issues search criteria
570 borrowernumber => $self->borrowernumber,
571 itemnumber => \@item_nos,
574 # Check current issues table
575 my $issues = Koha::Checkouts->search($criteria);
576 return 1 if $issues->count; # 0 || N
578 # Check old issues table
579 my $old_issues = Koha::Old::Checkouts->search($criteria);
580 return $old_issues->count; # 0 || N
585 my $debarment_expiration = $patron->is_debarred;
587 Returns the date a patron debarment will expire, or undef if the patron is not
595 return unless $self->debarred;
596 return $self->debarred
597 if $self->debarred =~ '^9999'
598 or dt_from_string( $self->debarred ) > dt_from_string;
604 my $is_expired = $patron->is_expired;
606 Returns 1 if the patron is expired or 0;
612 return 0 unless $self->dateexpiry;
613 return 0 if $self->dateexpiry =~ '^9999';
614 return 1 if dt_from_string( $self->dateexpiry ) < dt_from_string->truncate( to => 'day' );
618 =head3 is_going_to_expire
620 my $is_going_to_expire = $patron->is_going_to_expire;
622 Returns 1 if the patron is going to expired, depending on the NotifyBorrowerDeparture pref or 0
626 sub is_going_to_expire {
629 my $delay = C4::Context->preference('NotifyBorrowerDeparture') || 0;
631 return 0 unless $delay;
632 return 0 unless $self->dateexpiry;
633 return 0 if $self->dateexpiry =~ '^9999';
634 return 1 if dt_from_string( $self->dateexpiry )->subtract( days => $delay ) < dt_from_string->truncate( to => 'day' );
638 =head3 update_password
640 my $updated = $patron->update_password( $userid, $password );
642 Update the userid and the password of a patron.
643 If the userid already exists, returns and let DBIx::Class warns
644 This will add an entry to action_logs if BorrowersLog is set.
648 sub update_password {
649 my ( $self, $userid, $password ) = @_;
650 eval { $self->userid($userid)->store; };
651 return if $@; # Make sure the userid is not already in used by another patron
654 password => $password,
658 logaction( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
664 my $new_expiry_date = $patron->renew_account
666 Extending the subscription to the expiry date.
673 if ( C4::Context->preference('BorrowerRenewalPeriodBase') eq 'combination' ) {
674 $date = ( dt_from_string gt dt_from_string( $self->dateexpiry ) ) ? dt_from_string : dt_from_string( $self->dateexpiry );
677 C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry'
678 ? dt_from_string( $self->dateexpiry )
681 my $expiry_date = $self->category->get_expiry_date($date);
683 $self->dateexpiry($expiry_date);
684 $self->date_renewed( dt_from_string() );
687 $self->add_enrolment_fee_if_needed;
689 logaction( "MEMBERS", "RENEW", $self->borrowernumber, "Membership renewed" ) if C4::Context->preference("BorrowersLog");
690 return dt_from_string( $expiry_date )->truncate( to => 'day' );
695 my $has_overdues = $patron->has_overdues;
697 Returns the number of patron's overdues
703 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
704 return $self->_result->issues->search({ date_due => { '<' => $dtf->format_datetime( dt_from_string() ) } })->count;
709 $patron->track_login;
710 $patron->track_login({ force => 1 });
712 Tracks a (successful) login attempt.
713 The preference TrackLastPatronActivity must be enabled. Or you
714 should pass the force parameter.
719 my ( $self, $params ) = @_;
722 !C4::Context->preference('TrackLastPatronActivity');
723 $self->lastseen( dt_from_string() )->store;
726 =head3 move_to_deleted
728 my $is_moved = $patron->move_to_deleted;
730 Move a patron to the deletedborrowers table.
731 This can be done before deleting a patron, to make sure the data are not completely deleted.
735 sub move_to_deleted {
737 my $patron_infos = $self->unblessed;
738 delete $patron_infos->{updated_on}; #This ensures the updated_on date in deletedborrowers will be set to the current timestamp
739 return Koha::Database->new->schema->resultset('Deletedborrower')->create($patron_infos);
742 =head3 article_requests
744 my @requests = $borrower->article_requests();
745 my $requests = $borrower->article_requests();
747 Returns either a list of ArticleRequests objects,
748 or an ArtitleRequests object, depending on the
753 sub article_requests {
756 $self->{_article_requests} ||= Koha::ArticleRequests->search({ borrowernumber => $self->borrowernumber() });
758 return $self->{_article_requests};
761 =head3 article_requests_current
763 my @requests = $patron->article_requests_current
765 Returns the article requests associated with this patron that are incomplete
769 sub article_requests_current {
772 $self->{_article_requests_current} ||= Koha::ArticleRequests->search(
774 borrowernumber => $self->id(),
776 { status => Koha::ArticleRequest::Status::Pending },
777 { status => Koha::ArticleRequest::Status::Processing }
782 return $self->{_article_requests_current};
785 =head3 article_requests_finished
787 my @requests = $biblio->article_requests_finished
789 Returns the article requests associated with this patron that are completed
793 sub article_requests_finished {
794 my ( $self, $borrower ) = @_;
796 $self->{_article_requests_finished} ||= Koha::ArticleRequests->search(
798 borrowernumber => $self->id(),
800 { status => Koha::ArticleRequest::Status::Completed },
801 { status => Koha::ArticleRequest::Status::Canceled }
806 return $self->{_article_requests_finished};
809 =head3 add_enrolment_fee_if_needed
811 my $enrolment_fee = $patron->add_enrolment_fee_if_needed;
813 Add enrolment fee for a patron if needed.
817 sub add_enrolment_fee_if_needed {
819 my $enrolment_fee = $self->category->enrolmentfee;
820 if ( $enrolment_fee && $enrolment_fee > 0 ) {
821 # insert fee in patron debts
822 C4::Accounts::manualinvoice( $self->borrowernumber, '', '', 'A', $enrolment_fee );
824 return $enrolment_fee || 0;
829 my $checkouts = $patron->checkouts
835 my $checkouts = $self->_result->issues;
836 return Koha::Checkouts->_new_from_dbic( $checkouts );
839 =head3 pending_checkouts
841 my $pending_checkouts = $patron->pending_checkouts
843 This method will return the same as $self->checkouts, but with a prefetch on
844 items, biblio and biblioitems.
846 It has been introduced to replaced the C4::Members::GetPendingIssues subroutine
848 It should not be used directly, prefer to access fields you need instead of
849 retrieving all these fields in one go.
854 sub pending_checkouts {
856 my $checkouts = $self->_result->issues->search(
860 { -desc => 'me.timestamp' },
861 { -desc => 'issuedate' },
862 { -desc => 'issue_id' }, # Sort by issue_id should be enough
864 prefetch => { item => { biblio => 'biblioitems' } },
867 return Koha::Checkouts->_new_from_dbic( $checkouts );
872 my $old_checkouts = $patron->old_checkouts
878 my $old_checkouts = $self->_result->old_issues;
879 return Koha::Old::Checkouts->_new_from_dbic( $old_checkouts );
884 my $overdue_items = $patron->get_overdues
886 Return the overdue items
892 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
893 return $self->checkouts->search(
895 'me.date_due' => { '<' => $dtf->format_datetime(dt_from_string) },
898 prefetch => { item => { biblio => 'biblioitems' } },
903 =head3 get_routing_lists
905 my @routinglists = $patron->get_routing_lists
907 Returns the routing lists a patron is subscribed to.
911 sub get_routing_lists {
913 my $routing_list_rs = $self->_result->subscriptionroutinglists;
914 return Koha::Subscription::Routinglists->_new_from_dbic($routing_list_rs);
919 my $age = $patron->get_age
921 Return the age of the patron
927 my $today_str = dt_from_string->strftime("%Y-%m-%d");
928 return unless $self->dateofbirth;
929 my $dob_str = dt_from_string( $self->dateofbirth )->strftime("%Y-%m-%d");
931 my ( $dob_y, $dob_m, $dob_d ) = split /-/, $dob_str;
932 my ( $today_y, $today_m, $today_d ) = split /-/, $today_str;
934 my $age = $today_y - $dob_y;
935 if ( $dob_m . $dob_d > $today_m . $today_d ) {
944 my $account = $patron->account
950 return Koha::Account->new( { patron_id => $self->borrowernumber } );
955 my $holds = $patron->holds
957 Return all the holds placed by this patron
963 my $holds_rs = $self->_result->reserves->search( {}, { order_by => 'reservedate' } );
964 return Koha::Holds->_new_from_dbic($holds_rs);
969 my $old_holds = $patron->old_holds
971 Return all the historical holds for this patron
977 my $old_holds_rs = $self->_result->old_reserves->search( {}, { order_by => 'reservedate' } );
978 return Koha::Old::Holds->_new_from_dbic($old_holds_rs);
981 =head3 notice_email_address
983 my $email = $patron->notice_email_address;
985 Return the email address of patron used for notices.
986 Returns the empty string if no email address.
990 sub notice_email_address{
993 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
994 # if syspref is set to 'first valid' (value == OFF), look up email address
995 if ( $which_address eq 'OFF' ) {
996 return $self->first_valid_email_address;
999 return $self->$which_address || '';
1002 =head3 first_valid_email_address
1004 my $first_valid_email_address = $patron->first_valid_email_address
1006 Return the first valid email address for a patron.
1007 For now, the order is defined as email, emailpro, B_email.
1008 Returns the empty string if the borrower has no email addresses.
1012 sub first_valid_email_address {
1015 return $self->email() || $self->emailpro() || $self->B_email() || q{};
1018 =head3 get_club_enrollments
1022 sub get_club_enrollments {
1023 my ( $self, $return_scalar ) = @_;
1025 my $e = Koha::Club::Enrollments->search( { borrowernumber => $self->borrowernumber(), date_canceled => undef } );
1027 return $e if $return_scalar;
1029 return wantarray ? $e->as_list : $e;
1032 =head3 get_enrollable_clubs
1036 sub get_enrollable_clubs {
1037 my ( $self, $is_enrollable_from_opac, $return_scalar ) = @_;
1040 $params->{is_enrollable_from_opac} = $is_enrollable_from_opac
1041 if $is_enrollable_from_opac;
1042 $params->{is_email_required} = 0 unless $self->first_valid_email_address();
1044 $params->{borrower} = $self;
1046 my $e = Koha::Clubs->get_enrollable($params);
1048 return $e if $return_scalar;
1050 return wantarray ? $e->as_list : $e;
1053 =head3 account_locked
1055 my $is_locked = $patron->account_locked
1057 Return true if the patron has reach the maximum number of login attempts (see pref FailedLoginAttempts).
1058 Otherwise return false.
1059 If the pref is not set (empty string, null or 0), the feature is considered as disabled.
1063 sub account_locked {
1065 my $FailedLoginAttempts = C4::Context->preference('FailedLoginAttempts');
1066 return ( $FailedLoginAttempts
1067 and $self->login_attempts
1068 and $self->login_attempts >= $FailedLoginAttempts )? 1 : 0;
1071 =head3 can_see_patron_infos
1073 my $can_see = $patron->can_see_patron_infos( $patron );
1075 Return true if the patron (usually the logged in user) can see the patron's infos for a given patron
1079 sub can_see_patron_infos {
1080 my ( $self, $patron ) = @_;
1081 return $self->can_see_patrons_from( $patron->library->branchcode );
1084 =head3 can_see_patrons_from
1086 my $can_see = $patron->can_see_patrons_from( $branchcode );
1088 Return true if the patron (usually the logged in user) can see the patron's infos from a given library
1092 sub can_see_patrons_from {
1093 my ( $self, $branchcode ) = @_;
1095 if ( $self->branchcode eq $branchcode ) {
1097 } elsif ( $self->has_permission( { borrowers => 'view_borrower_infos_from_any_libraries' } ) ) {
1099 } elsif ( my $library_groups = $self->library->library_groups ) {
1100 while ( my $library_group = $library_groups->next ) {
1101 if ( $library_group->parent->has_child( $branchcode ) ) {
1110 =head3 libraries_where_can_see_patrons
1112 my $libraries = $patron-libraries_where_can_see_patrons;
1114 Return the list of branchcodes(!) of libraries the patron is allowed to see other patron's infos.
1115 The branchcodes are arbitrarily returned sorted.
1116 We are supposing here that the object is related to the logged in patron (use of C4::Context::only_my_library)
1118 An empty array means no restriction, the patron can see patron's infos from any libraries.
1122 sub libraries_where_can_see_patrons {
1124 my $userenv = C4::Context->userenv;
1126 return () unless $userenv; # For tests, but userenv should be defined in tests...
1128 my @restricted_branchcodes;
1129 if (C4::Context::only_my_library) {
1130 push @restricted_branchcodes, $self->branchcode;
1134 $self->has_permission(
1135 { borrowers => 'view_borrower_infos_from_any_libraries' }
1139 my $library_groups = $self->library->library_groups({ ft_hide_patron_info => 1 });
1140 if ( $library_groups->count )
1142 while ( my $library_group = $library_groups->next ) {
1143 my $parent = $library_group->parent;
1144 if ( $parent->has_child( $self->branchcode ) ) {
1145 push @restricted_branchcodes, $parent->children->get_column('branchcode');
1150 @restricted_branchcodes = ( $self->branchcode ) unless @restricted_branchcodes;
1154 @restricted_branchcodes = grep { defined $_ } @restricted_branchcodes;
1155 @restricted_branchcodes = uniq(@restricted_branchcodes);
1156 @restricted_branchcodes = sort(@restricted_branchcodes);
1157 return @restricted_branchcodes;
1160 sub has_permission {
1161 my ( $self, $flagsrequired ) = @_;
1162 return unless $self->userid;
1163 # TODO code from haspermission needs to be moved here!
1164 return C4::Auth::haspermission( $self->userid, $flagsrequired );
1169 my $is_adult = $patron->is_adult
1171 Return true if the patron has a category with a type Adult (A) or Organization (I)
1177 return $self->category->category_type =~ /^(A|I)$/ ? 1 : 0;
1182 my $is_child = $patron->is_child
1184 Return true if the patron has a category with a type Child (C)
1189 return $self->category->category_type eq 'C' ? 1 : 0;
1192 =head3 has_valid_userid
1194 my $patron = Koha::Patrons->find(42);
1195 $patron->userid( $new_userid );
1196 my $has_a_valid_userid = $patron->has_valid_userid
1198 my $patron = Koha::Patron->new( $params );
1199 my $has_a_valid_userid = $patron->has_valid_userid
1201 Return true if the current userid of this patron is valid/unique, otherwise false.
1203 Note that this should be done in $self->store instead and raise an exception if needed.
1207 sub has_valid_userid {
1210 return 0 unless $self->userid;
1212 return 0 if ( $self->userid eq C4::Context->config('user') ); # DB user
1214 my $already_exists = Koha::Patrons->search(
1216 userid => $self->userid,
1219 ? ( borrowernumber => { '!=' => $self->borrowernumber } )
1224 return $already_exists ? 0 : 1;
1227 =head3 generate_userid
1229 my $patron = Koha::Patron->new( $params );
1230 my $userid = $patron->generate_userid
1232 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
1234 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).
1236 # TODO: Set $self->userid with the generated value
1240 sub generate_userid {
1244 my $existing_userid = $self->userid;
1245 my $firstname = $self->firstname // q{};
1246 my $surname = $self->surname // q{};
1247 #The script will "do" the following code and increment the $offset until the generated userid is unique
1249 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1250 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1251 $userid = lc(($firstname)? "$firstname.$surname" : $surname);
1252 $userid = unac_string('utf-8',$userid);
1253 $userid .= $offset unless $offset == 0;
1254 $self->userid( $userid );
1256 } while (! $self->has_valid_userid );
1258 # Resetting to the previous value as the callers do not expect
1259 # this method to modify the userid attribute
1260 # This will be done later (move of AddMember and ModMember)
1261 $self->userid( $existing_userid );
1267 =head2 Internal methods
1279 Kyle M Hall <kyle@bywatersolutions.com>
1280 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>