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 Text::Unaccent qw( unac_string );
33 use Koha::Old::Checkouts;
34 use Koha::Patron::Categories;
35 use Koha::Patron::HouseboundProfile;
36 use Koha::Patron::HouseboundRole;
37 use Koha::Patron::Images;
39 use Koha::Virtualshelves;
40 use Koha::Club::Enrollments;
43 use base qw(Koha::Object);
45 our $RESULTSET_PATRON_ID_MAPPING = {
46 Accountline => 'borrowernumber',
47 ArticleRequest => 'borrowernumber',
48 BorrowerAttribute => 'borrowernumber',
49 BorrowerDebarment => 'borrowernumber',
50 BorrowerFile => 'borrowernumber',
51 BorrowerModification => 'borrowernumber',
52 ClubEnrollment => 'borrowernumber',
53 Issue => 'borrowernumber',
54 ItemsLastBorrower => 'borrowernumber',
55 Linktracker => 'borrowernumber',
56 Message => 'borrowernumber',
57 MessageQueue => 'borrowernumber',
58 OldIssue => 'borrowernumber',
59 OldReserve => 'borrowernumber',
60 Rating => 'borrowernumber',
61 Reserve => 'borrowernumber',
62 Review => 'borrowernumber',
63 Statistic => 'borrowernumber',
64 SearchHistory => 'userid',
65 Suggestion => 'suggestedby',
66 TagAll => 'borrowernumber',
67 Virtualshelfcontent => 'borrowernumber',
68 Virtualshelfshare => 'borrowernumber',
69 Virtualshelve => 'owner',
74 Koha::Patron - Koha Patron Object class
86 Delete patron's holds, lists and finally the patron.
88 Lists owned by the borrower are deleted, but entries from the borrower to
97 $self->_result->result_source->schema->txn_do(
99 # Delete Patron's holds
100 $self->holds->delete;
102 # Delete all lists and all shares of this borrower
103 # Consistent with the approach Koha uses on deleting individual lists
104 # Note that entries in virtualshelfcontents added by this borrower to
105 # lists of others will be handled by a table constraint: the borrower
106 # is set to NULL in those entries.
108 # We could handle the above deletes via a constraint too.
109 # But a new BZ report 11889 has been opened to discuss another approach.
110 # Instead of deleting we could also disown lists (based on a pref).
111 # In that way we could save shared and public lists.
112 # The current table constraints support that idea now.
113 # This pref should then govern the results of other routines/methods such as
114 # Koha::Virtualshelf->new->delete too.
115 # FIXME Could be $patron->get_lists
116 $_->delete for Koha::Virtualshelves->search( { owner => $self->borrowernumber } );
118 $deleted = $self->SUPER::delete;
120 logaction( "MEMBERS", "DELETE", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
129 my $patron_category = $patron->category
131 Return the patron category for this patron
137 return Koha::Patron::Category->_new_from_dbic( $self->_result->categorycode );
142 Returns a Koha::Patron object for this patron's guarantor
149 return unless $self->guarantorid();
151 return Koha::Patrons->find( $self->guarantorid() );
157 return scalar Koha::Patron::Images->find( $self->borrowernumber );
162 return Koha::Library->_new_from_dbic($self->_result->branchcode);
167 Returns the guarantees (list of Koha::Patron) of this patron
174 return Koha::Patrons->search( { guarantorid => $self->borrowernumber } );
177 =head3 housebound_profile
179 Returns the HouseboundProfile associated with this patron.
183 sub housebound_profile {
185 my $profile = $self->_result->housebound_profile;
186 return Koha::Patron::HouseboundProfile->_new_from_dbic($profile)
191 =head3 housebound_role
193 Returns the HouseboundRole associated with this patron.
197 sub housebound_role {
200 my $role = $self->_result->housebound_role;
201 return Koha::Patron::HouseboundRole->_new_from_dbic($role) if ( $role );
207 Returns the siblings of this patron.
214 my $guarantor = $self->guarantor;
216 return unless $guarantor;
218 return Koha::Patrons->search(
222 '=' => $guarantor->id,
225 '!=' => $self->borrowernumber,
233 my $patron = Koha::Patrons->find($id);
234 $patron->merge_with( \@patron_ids );
236 This subroutine merges a list of patrons into the patron record. This is accomplished by finding
237 all related patron ids for the patrons to be merged in other tables and changing the ids to be that
238 of the keeper patron.
243 my ( $self, $patron_ids ) = @_;
245 my @patron_ids = @{ $patron_ids };
247 # Ensure the keeper isn't in the list of patrons to merge
248 @patron_ids = grep { $_ ne $self->id } @patron_ids;
250 my $schema = Koha::Database->new()->schema();
254 $self->_result->result_source->schema->txn_do( sub {
255 foreach my $patron_id (@patron_ids) {
256 my $patron = Koha::Patrons->find( $patron_id );
260 # Unbless for safety, the patron will end up being deleted
261 $results->{merged}->{$patron_id}->{patron} = $patron->unblessed;
263 while (my ($r, $field) = each(%$RESULTSET_PATRON_ID_MAPPING)) {
264 my $rs = $schema->resultset($r)->search({ $field => $patron_id });
265 $results->{merged}->{ $patron_id }->{updated}->{$r} = $rs->count();
266 $rs->update({ $field => $self->id });
269 $patron->move_to_deleted();
279 =head3 wants_check_for_previous_checkout
281 $wants_check = $patron->wants_check_for_previous_checkout;
283 Return 1 if Koha needs to perform PrevIssue checking, else 0.
287 sub wants_check_for_previous_checkout {
289 my $syspref = C4::Context->preference("checkPrevCheckout");
292 ## Hard syspref trumps all
293 return 1 if ($syspref eq 'hardyes');
294 return 0 if ($syspref eq 'hardno');
295 ## Now, patron pref trumps all
296 return 1 if ($self->checkprevcheckout eq 'yes');
297 return 0 if ($self->checkprevcheckout eq 'no');
299 # More complex: patron inherits -> determine category preference
300 my $checkPrevCheckoutByCat = $self->category->checkprevcheckout;
301 return 1 if ($checkPrevCheckoutByCat eq 'yes');
302 return 0 if ($checkPrevCheckoutByCat eq 'no');
304 # Finally: category preference is inherit, default to 0
305 if ($syspref eq 'softyes') {
312 =head3 do_check_for_previous_checkout
314 $do_check = $patron->do_check_for_previous_checkout($item);
316 Return 1 if the bib associated with $ITEM has previously been checked out to
317 $PATRON, 0 otherwise.
321 sub do_check_for_previous_checkout {
322 my ( $self, $item ) = @_;
324 # Find all items for bib and extract item numbers.
325 my @items = Koha::Items->search({biblionumber => $item->{biblionumber}});
327 foreach my $item (@items) {
328 push @item_nos, $item->itemnumber;
331 # Create (old)issues search criteria
333 borrowernumber => $self->borrowernumber,
334 itemnumber => \@item_nos,
337 # Check current issues table
338 my $issues = Koha::Checkouts->search($criteria);
339 return 1 if $issues->count; # 0 || N
341 # Check old issues table
342 my $old_issues = Koha::Old::Checkouts->search($criteria);
343 return $old_issues->count; # 0 || N
348 my $debarment_expiration = $patron->is_debarred;
350 Returns the date a patron debarment will expire, or undef if the patron is not
358 return unless $self->debarred;
359 return $self->debarred
360 if $self->debarred =~ '^9999'
361 or dt_from_string( $self->debarred ) > dt_from_string;
367 my $is_expired = $patron->is_expired;
369 Returns 1 if the patron is expired or 0;
375 return 0 unless $self->dateexpiry;
376 return 0 if $self->dateexpiry =~ '^9999';
377 return 1 if dt_from_string( $self->dateexpiry ) < dt_from_string->truncate( to => 'day' );
381 =head3 is_going_to_expire
383 my $is_going_to_expire = $patron->is_going_to_expire;
385 Returns 1 if the patron is going to expired, depending on the NotifyBorrowerDeparture pref or 0
389 sub is_going_to_expire {
392 my $delay = C4::Context->preference('NotifyBorrowerDeparture') || 0;
394 return 0 unless $delay;
395 return 0 unless $self->dateexpiry;
396 return 0 if $self->dateexpiry =~ '^9999';
397 return 1 if dt_from_string( $self->dateexpiry )->subtract( days => $delay ) < dt_from_string->truncate( to => 'day' );
401 =head3 update_password
403 my $updated = $patron->update_password( $userid, $password );
405 Update the userid and the password of a patron.
406 If the userid already exists, returns and let DBIx::Class warns
407 This will add an entry to action_logs if BorrowersLog is set.
411 sub update_password {
412 my ( $self, $userid, $password ) = @_;
413 eval { $self->userid($userid)->store; };
414 return if $@; # Make sure the userid is not already in used by another patron
417 password => $password,
421 logaction( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
427 my $new_expiry_date = $patron->renew_account
429 Extending the subscription to the expiry date.
436 if ( C4::Context->preference('BorrowerRenewalPeriodBase') eq 'combination' ) {
437 $date = ( dt_from_string gt dt_from_string( $self->dateexpiry ) ) ? dt_from_string : dt_from_string( $self->dateexpiry );
440 C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry'
441 ? dt_from_string( $self->dateexpiry )
444 my $expiry_date = $self->category->get_expiry_date($date);
446 $self->dateexpiry($expiry_date);
447 $self->date_renewed( dt_from_string() );
450 $self->add_enrolment_fee_if_needed;
452 logaction( "MEMBERS", "RENEW", $self->borrowernumber, "Membership renewed" ) if C4::Context->preference("BorrowersLog");
453 return dt_from_string( $expiry_date )->truncate( to => 'day' );
458 my $has_overdues = $patron->has_overdues;
460 Returns the number of patron's overdues
466 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
467 return $self->_result->issues->search({ date_due => { '<' => $dtf->format_datetime( dt_from_string() ) } })->count;
472 $patron->track_login;
473 $patron->track_login({ force => 1 });
475 Tracks a (successful) login attempt.
476 The preference TrackLastPatronActivity must be enabled. Or you
477 should pass the force parameter.
482 my ( $self, $params ) = @_;
485 !C4::Context->preference('TrackLastPatronActivity');
486 $self->lastseen( dt_from_string() )->store;
489 =head3 move_to_deleted
491 my $is_moved = $patron->move_to_deleted;
493 Move a patron to the deletedborrowers table.
494 This can be done before deleting a patron, to make sure the data are not completely deleted.
498 sub move_to_deleted {
500 my $patron_infos = $self->unblessed;
501 delete $patron_infos->{updated_on}; #This ensures the updated_on date in deletedborrowers will be set to the current timestamp
502 return Koha::Database->new->schema->resultset('Deletedborrower')->create($patron_infos);
505 =head3 article_requests
507 my @requests = $borrower->article_requests();
508 my $requests = $borrower->article_requests();
510 Returns either a list of ArticleRequests objects,
511 or an ArtitleRequests object, depending on the
516 sub article_requests {
519 $self->{_article_requests} ||= Koha::ArticleRequests->search({ borrowernumber => $self->borrowernumber() });
521 return $self->{_article_requests};
524 =head3 article_requests_current
526 my @requests = $patron->article_requests_current
528 Returns the article requests associated with this patron that are incomplete
532 sub article_requests_current {
535 $self->{_article_requests_current} ||= Koha::ArticleRequests->search(
537 borrowernumber => $self->id(),
539 { status => Koha::ArticleRequest::Status::Pending },
540 { status => Koha::ArticleRequest::Status::Processing }
545 return $self->{_article_requests_current};
548 =head3 article_requests_finished
550 my @requests = $biblio->article_requests_finished
552 Returns the article requests associated with this patron that are completed
556 sub article_requests_finished {
557 my ( $self, $borrower ) = @_;
559 $self->{_article_requests_finished} ||= Koha::ArticleRequests->search(
561 borrowernumber => $self->id(),
563 { status => Koha::ArticleRequest::Status::Completed },
564 { status => Koha::ArticleRequest::Status::Canceled }
569 return $self->{_article_requests_finished};
572 =head3 add_enrolment_fee_if_needed
574 my $enrolment_fee = $patron->add_enrolment_fee_if_needed;
576 Add enrolment fee for a patron if needed.
580 sub add_enrolment_fee_if_needed {
582 my $enrolment_fee = $self->category->enrolmentfee;
583 if ( $enrolment_fee && $enrolment_fee > 0 ) {
584 # insert fee in patron debts
585 C4::Accounts::manualinvoice( $self->borrowernumber, '', '', 'A', $enrolment_fee );
587 return $enrolment_fee || 0;
592 my $checkouts = $patron->checkouts
598 my $checkouts = $self->_result->issues;
599 return Koha::Checkouts->_new_from_dbic( $checkouts );
602 =head3 pending_checkouts
604 my $pending_checkouts = $patron->pending_checkouts
606 This method will return the same as $self->checkouts, but with a prefetch on
607 items, biblio and biblioitems.
609 It has been introduced to replaced the C4::Members::GetPendingIssues subroutine
611 It should not be used directly, prefer to access fields you need instead of
612 retrieving all these fields in one go.
617 sub pending_checkouts {
619 my $checkouts = $self->_result->issues->search(
623 { -desc => 'me.timestamp' },
624 { -desc => 'issuedate' },
625 { -desc => 'issue_id' }, # Sort by issue_id should be enough
627 prefetch => { item => { biblio => 'biblioitems' } },
630 return Koha::Checkouts->_new_from_dbic( $checkouts );
635 my $old_checkouts = $patron->old_checkouts
641 my $old_checkouts = $self->_result->old_issues;
642 return Koha::Old::Checkouts->_new_from_dbic( $old_checkouts );
647 my $overdue_items = $patron->get_overdues
649 Return the overdued items
655 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
656 return $self->checkouts->search(
658 'me.date_due' => { '<' => $dtf->format_datetime(dt_from_string) },
661 prefetch => { item => { biblio => 'biblioitems' } },
668 my $age = $patron->get_age
670 Return the age of the patron
676 my $today_str = dt_from_string->strftime("%Y-%m-%d");
677 return unless $self->dateofbirth;
678 my $dob_str = dt_from_string( $self->dateofbirth )->strftime("%Y-%m-%d");
680 my ( $dob_y, $dob_m, $dob_d ) = split /-/, $dob_str;
681 my ( $today_y, $today_m, $today_d ) = split /-/, $today_str;
683 my $age = $today_y - $dob_y;
684 if ( $dob_m . $dob_d > $today_m . $today_d ) {
693 my $account = $patron->account
699 return Koha::Account->new( { patron_id => $self->borrowernumber } );
704 my $holds = $patron->holds
706 Return all the holds placed by this patron
712 my $holds_rs = $self->_result->reserves->search( {}, { order_by => 'reservedate' } );
713 return Koha::Holds->_new_from_dbic($holds_rs);
718 my $old_holds = $patron->old_holds
720 Return all the historical holds for this patron
726 my $old_holds_rs = $self->_result->old_reserves->search( {}, { order_by => 'reservedate' } );
727 return Koha::Old::Holds->_new_from_dbic($old_holds_rs);
730 =head3 notice_email_address
732 my $email = $patron->notice_email_address;
734 Return the email address of patron used for notices.
735 Returns the empty string if no email address.
739 sub notice_email_address{
742 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
743 # if syspref is set to 'first valid' (value == OFF), look up email address
744 if ( $which_address eq 'OFF' ) {
745 return $self->first_valid_email_address;
748 return $self->$which_address || '';
751 =head3 first_valid_email_address
753 my $first_valid_email_address = $patron->first_valid_email_address
755 Return the first valid email address for a patron.
756 For now, the order is defined as email, emailpro, B_email.
757 Returns the empty string if the borrower has no email addresses.
761 sub first_valid_email_address {
764 return $self->email() || $self->emailpro() || $self->B_email() || q{};
767 =head3 get_club_enrollments
771 sub get_club_enrollments {
772 my ( $self, $return_scalar ) = @_;
774 my $e = Koha::Club::Enrollments->search( { borrowernumber => $self->borrowernumber(), date_canceled => undef } );
776 return $e if $return_scalar;
778 return wantarray ? $e->as_list : $e;
781 =head3 get_enrollable_clubs
785 sub get_enrollable_clubs {
786 my ( $self, $is_enrollable_from_opac, $return_scalar ) = @_;
789 $params->{is_enrollable_from_opac} = $is_enrollable_from_opac
790 if $is_enrollable_from_opac;
791 $params->{is_email_required} = 0 unless $self->first_valid_email_address();
793 $params->{borrower} = $self;
795 my $e = Koha::Clubs->get_enrollable($params);
797 return $e if $return_scalar;
799 return wantarray ? $e->as_list : $e;
802 =head3 account_locked
804 my $is_locked = $patron->account_locked
806 Return true if the patron has reach the maximum number of login attempts (see pref FailedLoginAttempts).
807 Otherwise return false.
808 If the pref is not set (empty string, null or 0), the feature is considered as disabled.
814 my $FailedLoginAttempts = C4::Context->preference('FailedLoginAttempts');
815 return ( $FailedLoginAttempts
816 and $self->login_attempts
817 and $self->login_attempts >= $FailedLoginAttempts )? 1 : 0;
820 =head3 can_see_patron_infos
822 my $can_see = $patron->can_see_patron_infos( $patron );
824 Return true if the patron (usually the logged in user) can see the patron's infos for a given patron
828 sub can_see_patron_infos {
829 my ( $self, $patron ) = @_;
830 return $self->can_see_patrons_from( $patron->library->branchcode );
833 =head3 can_see_patrons_from
835 my $can_see = $patron->can_see_patrons_from( $branchcode );
837 Return true if the patron (usually the logged in user) can see the patron's infos from a given library
841 sub can_see_patrons_from {
842 my ( $self, $branchcode ) = @_;
844 if ( $self->branchcode eq $branchcode ) {
846 } elsif ( $self->has_permission( { borrowers => 'view_borrower_infos_from_any_libraries' } ) ) {
848 } elsif ( my $library_groups = $self->library->library_groups ) {
849 while ( my $library_group = $library_groups->next ) {
850 if ( $library_group->parent->has_child( $branchcode ) ) {
859 =head3 libraries_where_can_see_patrons
861 my $libraries = $patron-libraries_where_can_see_patrons;
863 Return the list of branchcodes(!) of libraries the patron is allowed to see other patron's infos.
864 The branchcodes are arbitrarily returned sorted.
865 We are supposing here that the object is related to the logged in patron (use of C4::Context::only_my_library)
867 An empty array means no restriction, the patron can see patron's infos from any libraries.
871 sub libraries_where_can_see_patrons {
873 my $userenv = C4::Context->userenv;
875 return () unless $userenv; # For tests, but userenv should be defined in tests...
877 my @restricted_branchcodes;
878 if (C4::Context::only_my_library) {
879 push @restricted_branchcodes, $self->branchcode;
883 $self->has_permission(
884 { borrowers => 'view_borrower_infos_from_any_libraries' }
888 my $library_groups = $self->library->library_groups({ ft_hide_patron_info => 1 });
889 if ( $library_groups->count )
891 while ( my $library_group = $library_groups->next ) {
892 my $parent = $library_group->parent;
893 if ( $parent->has_child( $self->branchcode ) ) {
894 push @restricted_branchcodes, $parent->children->get_column('branchcode');
899 @restricted_branchcodes = ( $self->branchcode ) unless @restricted_branchcodes;
903 @restricted_branchcodes = grep { defined $_ } @restricted_branchcodes;
904 @restricted_branchcodes = uniq(@restricted_branchcodes);
905 @restricted_branchcodes = sort(@restricted_branchcodes);
906 return @restricted_branchcodes;
910 my ( $self, $flagsrequired ) = @_;
911 return unless $self->userid;
912 # TODO code from haspermission needs to be moved here!
913 return C4::Auth::haspermission( $self->userid, $flagsrequired );
918 my $is_adult = $patron->is_adult
920 Return true if the patron has a category with a type Adult (A) or Organization (I)
926 return $self->category->category_type =~ /^(A|I)$/ ? 1 : 0;
931 my $is_child = $patron->is_child
933 Return true if the patron has a category with a type Child (C)
938 return $self->category->category_type eq 'C' ? 1 : 0;
941 =head3 has_valid_userid
943 my $patron = Koha::Patrons->find(42);
944 $patron->userid( $new_userid );
945 my $has_a_valid_userid = $patron->has_valid_userid
947 my $patron = Koha::Patron->new( $params );
948 my $has_a_valid_userid = $patron->has_valid_userid
950 Return true if the current userid of this patron is valid/unique, otherwise false.
952 Note that this should be done in $self->store instead and raise an exception if needed.
956 sub has_valid_userid {
959 return 0 unless $self->userid;
961 return 0 if ( $self->userid eq C4::Context->config('user') ); # DB user
963 my $already_exists = Koha::Patrons->search(
965 userid => $self->userid,
968 ? ( borrowernumber => { '!=' => $self->borrowernumber } )
973 return $already_exists ? 0 : 1;
976 =head3 generate_userid
978 my $patron = Koha::Patron->new( $params );
979 my $userid = $patron->generate_userid
981 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
983 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).
985 # Note: Should we set $self->userid with the generated value?
986 # Certainly yes, but we AddMember and ModMember will be rewritten
990 sub generate_userid {
994 my $existing_userid = $self->userid;
995 my $firstname = $self->firstname // q{};
996 my $surname = $self->surname // q{};
997 #The script will "do" the following code and increment the $offset until the generated userid is unique
999 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1000 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1001 $userid = lc(($firstname)? "$firstname.$surname" : $surname);
1002 $userid = unac_string('utf-8',$userid);
1003 $userid .= $offset unless $offset == 0;
1004 $self->userid( $userid );
1006 } while (! $self->has_valid_userid );
1008 # Resetting to the previous value as the callers do not expect
1009 # this method to modify the userid attribute
1010 # This will be done later (move of AddMember and ModMember)
1011 $self->userid( $existing_userid );
1017 =head2 Internal methods
1029 Kyle M Hall <kyle@bywatersolutions.com>
1030 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>