Bug 19804: Fix test in maxsuspensiondays.t
[koha.git] / Koha / Patron.pm
blob23221317139d5bd6b3e3117a2dd69e39f6fcfc6d
1 package Koha::Patron;
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
11 # version.
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.
21 use Modern::Perl;
23 use Carp;
24 use List::MoreUtils qw( uniq );
26 use C4::Context;
27 use C4::Log;
28 use Koha::Checkouts;
29 use Koha::Database;
30 use Koha::DateUtils;
31 use Koha::Holds;
32 use Koha::Old::Checkouts;
33 use Koha::Patron::Categories;
34 use Koha::Patron::HouseboundProfile;
35 use Koha::Patron::HouseboundRole;
36 use Koha::Patron::Images;
37 use Koha::Patrons;
38 use Koha::Virtualshelves;
39 use Koha::Club::Enrollments;
40 use Koha::Account;
42 use base qw(Koha::Object);
44 =head1 NAME
46 Koha::Patron - Koha Patron Object class
48 =head1 API
50 =head2 Class Methods
52 =cut
54 =head3 delete
56 $patron->delete
58 Delete patron's holds, lists and finally the patron.
60 Lists owned by the borrower are deleted, but entries from the borrower to
61 other lists are kept.
63 =cut
65 sub delete {
66 my ($self) = @_;
68 my $deleted;
69 $self->_result->result_source->schema->txn_do(
70 sub {
71 # Delete Patron's holds
72 $self->holds->delete;
74 # Delete all lists and all shares of this borrower
75 # Consistent with the approach Koha uses on deleting individual lists
76 # Note that entries in virtualshelfcontents added by this borrower to
77 # lists of others will be handled by a table constraint: the borrower
78 # is set to NULL in those entries.
79 # NOTE:
80 # We could handle the above deletes via a constraint too.
81 # But a new BZ report 11889 has been opened to discuss another approach.
82 # Instead of deleting we could also disown lists (based on a pref).
83 # In that way we could save shared and public lists.
84 # The current table constraints support that idea now.
85 # This pref should then govern the results of other routines/methods such as
86 # Koha::Virtualshelf->new->delete too.
87 # FIXME Could be $patron->get_lists
88 $_->delete for Koha::Virtualshelves->search( { owner => $self->borrowernumber } );
90 $deleted = $self->SUPER::delete;
92 logaction( "MEMBERS", "DELETE", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
95 return $deleted;
99 =head3 category
101 my $patron_category = $patron->category
103 Return the patron category for this patron
105 =cut
107 sub category {
108 my ( $self ) = @_;
109 return Koha::Patron::Category->_new_from_dbic( $self->_result->categorycode );
112 =head3 guarantor
114 Returns a Koha::Patron object for this patron's guarantor
116 =cut
118 sub guarantor {
119 my ( $self ) = @_;
121 return unless $self->guarantorid();
123 return Koha::Patrons->find( $self->guarantorid() );
126 sub image {
127 my ( $self ) = @_;
129 return scalar Koha::Patron::Images->find( $self->borrowernumber );
132 sub library {
133 my ( $self ) = @_;
134 return Koha::Library->_new_from_dbic($self->_result->branchcode);
137 =head3 guarantees
139 Returns the guarantees (list of Koha::Patron) of this patron
141 =cut
143 sub guarantees {
144 my ( $self ) = @_;
146 return Koha::Patrons->search( { guarantorid => $self->borrowernumber } );
149 =head3 housebound_profile
151 Returns the HouseboundProfile associated with this patron.
153 =cut
155 sub housebound_profile {
156 my ( $self ) = @_;
157 my $profile = $self->_result->housebound_profile;
158 return Koha::Patron::HouseboundProfile->_new_from_dbic($profile)
159 if ( $profile );
160 return;
163 =head3 housebound_role
165 Returns the HouseboundRole associated with this patron.
167 =cut
169 sub housebound_role {
170 my ( $self ) = @_;
172 my $role = $self->_result->housebound_role;
173 return Koha::Patron::HouseboundRole->_new_from_dbic($role) if ( $role );
174 return;
177 =head3 siblings
179 Returns the siblings of this patron.
181 =cut
183 sub siblings {
184 my ( $self ) = @_;
186 my $guarantor = $self->guarantor;
188 return unless $guarantor;
190 return Koha::Patrons->search(
192 guarantorid => {
193 '!=' => undef,
194 '=' => $guarantor->id,
196 borrowernumber => {
197 '!=' => $self->borrowernumber,
203 =head3 wants_check_for_previous_checkout
205 $wants_check = $patron->wants_check_for_previous_checkout;
207 Return 1 if Koha needs to perform PrevIssue checking, else 0.
209 =cut
211 sub wants_check_for_previous_checkout {
212 my ( $self ) = @_;
213 my $syspref = C4::Context->preference("checkPrevCheckout");
215 # Simple cases
216 ## Hard syspref trumps all
217 return 1 if ($syspref eq 'hardyes');
218 return 0 if ($syspref eq 'hardno');
219 ## Now, patron pref trumps all
220 return 1 if ($self->checkprevcheckout eq 'yes');
221 return 0 if ($self->checkprevcheckout eq 'no');
223 # More complex: patron inherits -> determine category preference
224 my $checkPrevCheckoutByCat = $self->category->checkprevcheckout;
225 return 1 if ($checkPrevCheckoutByCat eq 'yes');
226 return 0 if ($checkPrevCheckoutByCat eq 'no');
228 # Finally: category preference is inherit, default to 0
229 if ($syspref eq 'softyes') {
230 return 1;
231 } else {
232 return 0;
236 =head3 do_check_for_previous_checkout
238 $do_check = $patron->do_check_for_previous_checkout($item);
240 Return 1 if the bib associated with $ITEM has previously been checked out to
241 $PATRON, 0 otherwise.
243 =cut
245 sub do_check_for_previous_checkout {
246 my ( $self, $item ) = @_;
248 # Find all items for bib and extract item numbers.
249 my @items = Koha::Items->search({biblionumber => $item->{biblionumber}});
250 my @item_nos;
251 foreach my $item (@items) {
252 push @item_nos, $item->itemnumber;
255 # Create (old)issues search criteria
256 my $criteria = {
257 borrowernumber => $self->borrowernumber,
258 itemnumber => \@item_nos,
261 # Check current issues table
262 my $issues = Koha::Checkouts->search($criteria);
263 return 1 if $issues->count; # 0 || N
265 # Check old issues table
266 my $old_issues = Koha::Old::Checkouts->search($criteria);
267 return $old_issues->count; # 0 || N
270 =head3 is_debarred
272 my $debarment_expiration = $patron->is_debarred;
274 Returns the date a patron debarment will expire, or undef if the patron is not
275 debarred
277 =cut
279 sub is_debarred {
280 my ($self) = @_;
282 return unless $self->debarred;
283 return $self->debarred
284 if $self->debarred =~ '^9999'
285 or dt_from_string( $self->debarred ) > dt_from_string;
286 return;
289 =head3 is_expired
291 my $is_expired = $patron->is_expired;
293 Returns 1 if the patron is expired or 0;
295 =cut
297 sub is_expired {
298 my ($self) = @_;
299 return 0 unless $self->dateexpiry;
300 return 0 if $self->dateexpiry =~ '^9999';
301 return 1 if dt_from_string( $self->dateexpiry ) < dt_from_string->truncate( to => 'day' );
302 return 0;
305 =head3 is_going_to_expire
307 my $is_going_to_expire = $patron->is_going_to_expire;
309 Returns 1 if the patron is going to expired, depending on the NotifyBorrowerDeparture pref or 0
311 =cut
313 sub is_going_to_expire {
314 my ($self) = @_;
316 my $delay = C4::Context->preference('NotifyBorrowerDeparture') || 0;
318 return 0 unless $delay;
319 return 0 unless $self->dateexpiry;
320 return 0 if $self->dateexpiry =~ '^9999';
321 return 1 if dt_from_string( $self->dateexpiry )->subtract( days => $delay ) < dt_from_string->truncate( to => 'day' );
322 return 0;
325 =head3 update_password
327 my $updated = $patron->update_password( $userid, $password );
329 Update the userid and the password of a patron.
330 If the userid already exists, returns and let DBIx::Class warns
331 This will add an entry to action_logs if BorrowersLog is set.
333 =cut
335 sub update_password {
336 my ( $self, $userid, $password ) = @_;
337 eval { $self->userid($userid)->store; };
338 return if $@; # Make sure the userid is not already in used by another patron
339 $self->update(
341 password => $password,
342 login_attempts => 0,
345 logaction( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
346 return 1;
349 =head3 renew_account
351 my $new_expiry_date = $patron->renew_account
353 Extending the subscription to the expiry date.
355 =cut
357 sub renew_account {
358 my ($self) = @_;
359 my $date;
360 if ( C4::Context->preference('BorrowerRenewalPeriodBase') eq 'combination' ) {
361 $date = ( dt_from_string gt dt_from_string( $self->dateexpiry ) ) ? dt_from_string : dt_from_string( $self->dateexpiry );
362 } else {
363 $date =
364 C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry'
365 ? dt_from_string( $self->dateexpiry )
366 : dt_from_string;
368 my $expiry_date = $self->category->get_expiry_date($date);
370 $self->dateexpiry($expiry_date);
371 $self->date_renewed( dt_from_string() );
372 $self->store();
374 $self->add_enrolment_fee_if_needed;
376 logaction( "MEMBERS", "RENEW", $self->borrowernumber, "Membership renewed" ) if C4::Context->preference("BorrowersLog");
377 return dt_from_string( $expiry_date )->truncate( to => 'day' );
380 =head3 has_overdues
382 my $has_overdues = $patron->has_overdues;
384 Returns the number of patron's overdues
386 =cut
388 sub has_overdues {
389 my ($self) = @_;
390 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
391 return $self->_result->issues->search({ date_due => { '<' => $dtf->format_datetime( dt_from_string() ) } })->count;
394 =head3 track_login
396 $patron->track_login;
397 $patron->track_login({ force => 1 });
399 Tracks a (successful) login attempt.
400 The preference TrackLastPatronActivity must be enabled. Or you
401 should pass the force parameter.
403 =cut
405 sub track_login {
406 my ( $self, $params ) = @_;
407 return if
408 !$params->{force} &&
409 !C4::Context->preference('TrackLastPatronActivity');
410 $self->lastseen( dt_from_string() )->store;
413 =head3 move_to_deleted
415 my $is_moved = $patron->move_to_deleted;
417 Move a patron to the deletedborrowers table.
418 This can be done before deleting a patron, to make sure the data are not completely deleted.
420 =cut
422 sub move_to_deleted {
423 my ($self) = @_;
424 my $patron_infos = $self->unblessed;
425 delete $patron_infos->{updated_on}; #This ensures the updated_on date in deletedborrowers will be set to the current timestamp
426 return Koha::Database->new->schema->resultset('Deletedborrower')->create($patron_infos);
429 =head3 article_requests
431 my @requests = $borrower->article_requests();
432 my $requests = $borrower->article_requests();
434 Returns either a list of ArticleRequests objects,
435 or an ArtitleRequests object, depending on the
436 calling context.
438 =cut
440 sub article_requests {
441 my ( $self ) = @_;
443 $self->{_article_requests} ||= Koha::ArticleRequests->search({ borrowernumber => $self->borrowernumber() });
445 return $self->{_article_requests};
448 =head3 article_requests_current
450 my @requests = $patron->article_requests_current
452 Returns the article requests associated with this patron that are incomplete
454 =cut
456 sub article_requests_current {
457 my ( $self ) = @_;
459 $self->{_article_requests_current} ||= Koha::ArticleRequests->search(
461 borrowernumber => $self->id(),
462 -or => [
463 { status => Koha::ArticleRequest::Status::Pending },
464 { status => Koha::ArticleRequest::Status::Processing }
469 return $self->{_article_requests_current};
472 =head3 article_requests_finished
474 my @requests = $biblio->article_requests_finished
476 Returns the article requests associated with this patron that are completed
478 =cut
480 sub article_requests_finished {
481 my ( $self, $borrower ) = @_;
483 $self->{_article_requests_finished} ||= Koha::ArticleRequests->search(
485 borrowernumber => $self->id(),
486 -or => [
487 { status => Koha::ArticleRequest::Status::Completed },
488 { status => Koha::ArticleRequest::Status::Canceled }
493 return $self->{_article_requests_finished};
496 =head3 add_enrolment_fee_if_needed
498 my $enrolment_fee = $patron->add_enrolment_fee_if_needed;
500 Add enrolment fee for a patron if needed.
502 =cut
504 sub add_enrolment_fee_if_needed {
505 my ($self) = @_;
506 my $enrolment_fee = $self->category->enrolmentfee;
507 if ( $enrolment_fee && $enrolment_fee > 0 ) {
508 # insert fee in patron debts
509 C4::Accounts::manualinvoice( $self->borrowernumber, '', '', 'A', $enrolment_fee );
511 return $enrolment_fee || 0;
514 =head3 checkouts
516 my $checkouts = $patron->checkouts
518 =cut
520 sub checkouts {
521 my ($self) = @_;
522 my $checkouts = $self->_result->issues;
523 return Koha::Checkouts->_new_from_dbic( $checkouts );
526 =head3 pending_checkouts
528 my $pending_checkouts = $patron->pending_checkouts
530 This method will return the same as $self->checkouts, but with a prefetch on
531 items, biblio and biblioitems.
533 It has been introduced to replaced the C4::Members::GetPendingIssues subroutine
535 It should not be used directly, prefer to access fields you need instead of
536 retrieving all these fields in one go.
539 =cut
541 sub pending_checkouts {
542 my( $self ) = @_;
543 my $checkouts = $self->_result->issues->search(
546 order_by => [
547 { -desc => 'me.timestamp' },
548 { -desc => 'issuedate' },
549 { -desc => 'issue_id' }, # Sort by issue_id should be enough
551 prefetch => { item => { biblio => 'biblioitems' } },
554 return Koha::Checkouts->_new_from_dbic( $checkouts );
557 =head3 old_checkouts
559 my $old_checkouts = $patron->old_checkouts
561 =cut
563 sub old_checkouts {
564 my ($self) = @_;
565 my $old_checkouts = $self->_result->old_issues;
566 return Koha::Old::Checkouts->_new_from_dbic( $old_checkouts );
569 =head3 get_overdues
571 my $overdue_items = $patron->get_overdues
573 Return the overdued items
575 =cut
577 sub get_overdues {
578 my ($self) = @_;
579 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
580 return $self->checkouts->search(
582 'me.date_due' => { '<' => $dtf->format_datetime(dt_from_string) },
585 prefetch => { item => { biblio => 'biblioitems' } },
590 =head3 get_age
592 my $age = $patron->get_age
594 Return the age of the patron
596 =cut
598 sub get_age {
599 my ($self) = @_;
600 my $today_str = dt_from_string->strftime("%Y-%m-%d");
601 return unless $self->dateofbirth;
602 my $dob_str = dt_from_string( $self->dateofbirth )->strftime("%Y-%m-%d");
604 my ( $dob_y, $dob_m, $dob_d ) = split /-/, $dob_str;
605 my ( $today_y, $today_m, $today_d ) = split /-/, $today_str;
607 my $age = $today_y - $dob_y;
608 if ( $dob_m . $dob_d > $today_m . $today_d ) {
609 $age--;
612 return $age;
615 =head3 account
617 my $account = $patron->account
619 =cut
621 sub account {
622 my ($self) = @_;
623 return Koha::Account->new( { patron_id => $self->borrowernumber } );
626 =head3 holds
628 my $holds = $patron->holds
630 Return all the holds placed by this patron
632 =cut
634 sub holds {
635 my ($self) = @_;
636 my $holds_rs = $self->_result->reserves->search( {}, { order_by => 'reservedate' } );
637 return Koha::Holds->_new_from_dbic($holds_rs);
640 =head3 old_holds
642 my $old_holds = $patron->old_holds
644 Return all the historical holds for this patron
646 =cut
648 sub old_holds {
649 my ($self) = @_;
650 my $old_holds_rs = $self->_result->old_reserves->search( {}, { order_by => 'reservedate' } );
651 return Koha::Old::Holds->_new_from_dbic($old_holds_rs);
654 =head3 notice_email_address
656 my $email = $patron->notice_email_address;
658 Return the email address of patron used for notices.
659 Returns the empty string if no email address.
661 =cut
663 sub notice_email_address{
664 my ( $self ) = @_;
666 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
667 # if syspref is set to 'first valid' (value == OFF), look up email address
668 if ( $which_address eq 'OFF' ) {
669 return $self->first_valid_email_address;
672 return $self->$which_address || '';
675 =head3 first_valid_email_address
677 my $first_valid_email_address = $patron->first_valid_email_address
679 Return the first valid email address for a patron.
680 For now, the order is defined as email, emailpro, B_email.
681 Returns the empty string if the borrower has no email addresses.
683 =cut
685 sub first_valid_email_address {
686 my ($self) = @_;
688 return $self->email() || $self->emailpro() || $self->B_email() || q{};
691 =head3 get_club_enrollments
693 =cut
695 sub get_club_enrollments {
696 my ( $self, $return_scalar ) = @_;
698 my $e = Koha::Club::Enrollments->search( { borrowernumber => $self->borrowernumber(), date_canceled => undef } );
700 return $e if $return_scalar;
702 return wantarray ? $e->as_list : $e;
705 =head3 get_enrollable_clubs
707 =cut
709 sub get_enrollable_clubs {
710 my ( $self, $is_enrollable_from_opac, $return_scalar ) = @_;
712 my $params;
713 $params->{is_enrollable_from_opac} = $is_enrollable_from_opac
714 if $is_enrollable_from_opac;
715 $params->{is_email_required} = 0 unless $self->first_valid_email_address();
717 $params->{borrower} = $self;
719 my $e = Koha::Clubs->get_enrollable($params);
721 return $e if $return_scalar;
723 return wantarray ? $e->as_list : $e;
726 =head3 account_locked
728 my $is_locked = $patron->account_locked
730 Return true if the patron has reach the maximum number of login attempts (see pref FailedLoginAttempts).
731 Otherwise return false.
732 If the pref is not set (empty string, null or 0), the feature is considered as disabled.
734 =cut
736 sub account_locked {
737 my ($self) = @_;
738 my $FailedLoginAttempts = C4::Context->preference('FailedLoginAttempts');
739 return ( $FailedLoginAttempts
740 and $self->login_attempts
741 and $self->login_attempts >= $FailedLoginAttempts )? 1 : 0;
744 =head3 can_see_patron_infos
746 my $can_see = $patron->can_see_patron_infos( $patron );
748 Return true if the patron (usually the logged in user) can see the patron's infos for a given patron
750 =cut
752 sub can_see_patron_infos {
753 my ( $self, $patron ) = @_;
754 return $self->can_see_patrons_from( $patron->library->branchcode );
757 =head3 can_see_patrons_from
759 my $can_see = $patron->can_see_patrons_from( $branchcode );
761 Return true if the patron (usually the logged in user) can see the patron's infos from a given library
763 =cut
765 sub can_see_patrons_from {
766 my ( $self, $branchcode ) = @_;
767 my $can = 0;
768 if ( $self->branchcode eq $branchcode ) {
769 $can = 1;
770 } elsif ( $self->has_permission( { borrowers => 'view_borrower_infos_from_any_libraries' } ) ) {
771 $can = 1;
772 } elsif ( my $library_groups = $self->library->library_groups ) {
773 while ( my $library_group = $library_groups->next ) {
774 if ( $library_group->parent->has_child( $branchcode ) ) {
775 $can = 1;
776 last;
780 return $can;
783 =head3 libraries_where_can_see_patrons
785 my $libraries = $patron-libraries_where_can_see_patrons;
787 Return the list of branchcodes(!) of libraries the patron is allowed to see other patron's infos.
788 The branchcodes are arbitrarily returned sorted.
789 We are supposing here that the object is related to the logged in patron (use of C4::Context::only_my_library)
791 An empty array means no restriction, the patron can see patron's infos from any libraries.
793 =cut
795 sub libraries_where_can_see_patrons {
796 my ( $self ) = @_;
797 my $userenv = C4::Context->userenv;
799 return () unless $userenv; # For tests, but userenv should be defined in tests...
801 my @restricted_branchcodes;
802 if (C4::Context::only_my_library) {
803 push @restricted_branchcodes, $self->branchcode;
805 else {
806 unless (
807 $self->has_permission(
808 { borrowers => 'view_borrower_infos_from_any_libraries' }
812 my $library_groups = $self->library->library_groups({ ft_hide_patron_info => 1 });
813 if ( $library_groups->count )
815 while ( my $library_group = $library_groups->next ) {
816 my $parent = $library_group->parent;
817 if ( $parent->has_child( $self->branchcode ) ) {
818 push @restricted_branchcodes, $parent->children->get_column('branchcode');
823 @restricted_branchcodes = ( $self->branchcode ) unless @restricted_branchcodes;
827 @restricted_branchcodes = grep { defined $_ } @restricted_branchcodes;
828 @restricted_branchcodes = uniq(@restricted_branchcodes);
829 @restricted_branchcodes = sort(@restricted_branchcodes);
830 return @restricted_branchcodes;
833 sub has_permission {
834 my ( $self, $flagsrequired ) = @_;
835 return unless $self->userid;
836 # TODO code from haspermission needs to be moved here!
837 return C4::Auth::haspermission( $self->userid, $flagsrequired );
840 =head3 is_adult
842 my $is_adult = $patron->is_adult
844 Return true if the patron has a category with a type Adult (A) or Organization (I)
846 =cut
848 sub is_adult {
849 my ( $self ) = @_;
850 return $self->category->category_type =~ /^(A|I)$/ ? 1 : 0;
853 =head3 is_child
855 my $is_child = $patron->is_child
857 Return true if the patron has a category with a type Child (C)
859 =cut
860 sub is_child {
861 my( $self ) = @_;
862 return $self->category->category_type eq 'C' ? 1 : 0;
865 =head2 Internal methods
867 =head3 _type
869 =cut
871 sub _type {
872 return 'Borrower';
875 =head1 AUTHOR
877 Kyle M Hall <kyle@bywatersolutions.com>
878 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>
880 =cut