Bug 19531: When saving patron record do not redirect to circ if not authorised
[koha.git] / Koha / Patron.pm
blobdaa972c85bdd7a644cb9d14c9376fdceb0554e90
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;
25 use C4::Context;
26 use C4::Log;
27 use Koha::Checkouts;
28 use Koha::Database;
29 use Koha::DateUtils;
30 use Koha::Holds;
31 use Koha::Old::Checkouts;
32 use Koha::Patron::Categories;
33 use Koha::Patron::HouseboundProfile;
34 use Koha::Patron::HouseboundRole;
35 use Koha::Patron::Images;
36 use Koha::Patrons;
37 use Koha::Virtualshelves;
38 use Koha::Club::Enrollments;
39 use Koha::Account;
41 use base qw(Koha::Object);
43 =head1 NAME
45 Koha::Patron - Koha Patron Object class
47 =head1 API
49 =head2 Class Methods
51 =cut
53 =head3 delete
55 $patron->delete
57 Delete patron's holds, lists and finally the patron.
59 Lists owned by the borrower are deleted, but entries from the borrower to
60 other lists are kept.
62 =cut
64 sub delete {
65 my ($self) = @_;
67 my $deleted;
68 $self->_result->result_source->schema->txn_do(
69 sub {
70 # Delete Patron's holds
71 $self->holds->delete;
73 # Delete all lists and all shares of this borrower
74 # Consistent with the approach Koha uses on deleting individual lists
75 # Note that entries in virtualshelfcontents added by this borrower to
76 # lists of others will be handled by a table constraint: the borrower
77 # is set to NULL in those entries.
78 # NOTE:
79 # We could handle the above deletes via a constraint too.
80 # But a new BZ report 11889 has been opened to discuss another approach.
81 # Instead of deleting we could also disown lists (based on a pref).
82 # In that way we could save shared and public lists.
83 # The current table constraints support that idea now.
84 # This pref should then govern the results of other routines/methods such as
85 # Koha::Virtualshelf->new->delete too.
86 # FIXME Could be $patron->get_lists
87 $_->delete for Koha::Virtualshelves->search( { owner => $self->borrowernumber } );
89 $deleted = $self->SUPER::delete;
91 logaction( "MEMBERS", "DELETE", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
94 return $deleted;
98 =head3 category
100 my $patron_category = $patron->category
102 Return the patron category for this patron
104 =cut
106 sub category {
107 my ( $self ) = @_;
108 return Koha::Patron::Category->_new_from_dbic( $self->_result->categorycode );
111 =head3 guarantor
113 Returns a Koha::Patron object for this patron's guarantor
115 =cut
117 sub guarantor {
118 my ( $self ) = @_;
120 return unless $self->guarantorid();
122 return Koha::Patrons->find( $self->guarantorid() );
125 sub image {
126 my ( $self ) = @_;
128 return Koha::Patron::Images->find( $self->borrowernumber );
131 sub library {
132 my ( $self ) = @_;
133 return Koha::Library->_new_from_dbic($self->_result->branchcode);
136 =head3 guarantees
138 Returns the guarantees (list of Koha::Patron) of this patron
140 =cut
142 sub guarantees {
143 my ( $self ) = @_;
145 return Koha::Patrons->search( { guarantorid => $self->borrowernumber } );
148 =head3 housebound_profile
150 Returns the HouseboundProfile associated with this patron.
152 =cut
154 sub housebound_profile {
155 my ( $self ) = @_;
156 my $profile = $self->_result->housebound_profile;
157 return Koha::Patron::HouseboundProfile->_new_from_dbic($profile)
158 if ( $profile );
159 return;
162 =head3 housebound_role
164 Returns the HouseboundRole associated with this patron.
166 =cut
168 sub housebound_role {
169 my ( $self ) = @_;
171 my $role = $self->_result->housebound_role;
172 return Koha::Patron::HouseboundRole->_new_from_dbic($role) if ( $role );
173 return;
176 =head3 siblings
178 Returns the siblings of this patron.
180 =cut
182 sub siblings {
183 my ( $self ) = @_;
185 my $guarantor = $self->guarantor;
187 return unless $guarantor;
189 return Koha::Patrons->search(
191 guarantorid => {
192 '!=' => undef,
193 '=' => $guarantor->id,
195 borrowernumber => {
196 '!=' => $self->borrowernumber,
202 =head3 wants_check_for_previous_checkout
204 $wants_check = $patron->wants_check_for_previous_checkout;
206 Return 1 if Koha needs to perform PrevIssue checking, else 0.
208 =cut
210 sub wants_check_for_previous_checkout {
211 my ( $self ) = @_;
212 my $syspref = C4::Context->preference("checkPrevCheckout");
214 # Simple cases
215 ## Hard syspref trumps all
216 return 1 if ($syspref eq 'hardyes');
217 return 0 if ($syspref eq 'hardno');
218 ## Now, patron pref trumps all
219 return 1 if ($self->checkprevcheckout eq 'yes');
220 return 0 if ($self->checkprevcheckout eq 'no');
222 # More complex: patron inherits -> determine category preference
223 my $checkPrevCheckoutByCat = $self->category->checkprevcheckout;
224 return 1 if ($checkPrevCheckoutByCat eq 'yes');
225 return 0 if ($checkPrevCheckoutByCat eq 'no');
227 # Finally: category preference is inherit, default to 0
228 if ($syspref eq 'softyes') {
229 return 1;
230 } else {
231 return 0;
235 =head3 do_check_for_previous_checkout
237 $do_check = $patron->do_check_for_previous_checkout($item);
239 Return 1 if the bib associated with $ITEM has previously been checked out to
240 $PATRON, 0 otherwise.
242 =cut
244 sub do_check_for_previous_checkout {
245 my ( $self, $item ) = @_;
247 # Find all items for bib and extract item numbers.
248 my @items = Koha::Items->search({biblionumber => $item->{biblionumber}});
249 my @item_nos;
250 foreach my $item (@items) {
251 push @item_nos, $item->itemnumber;
254 # Create (old)issues search criteria
255 my $criteria = {
256 borrowernumber => $self->borrowernumber,
257 itemnumber => \@item_nos,
260 # Check current issues table
261 my $issues = Koha::Checkouts->search($criteria);
262 return 1 if $issues->count; # 0 || N
264 # Check old issues table
265 my $old_issues = Koha::Old::Checkouts->search($criteria);
266 return $old_issues->count; # 0 || N
269 =head3 is_debarred
271 my $debarment_expiration = $patron->is_debarred;
273 Returns the date a patron debarment will expire, or undef if the patron is not
274 debarred
276 =cut
278 sub is_debarred {
279 my ($self) = @_;
281 return unless $self->debarred;
282 return $self->debarred
283 if $self->debarred =~ '^9999'
284 or dt_from_string( $self->debarred ) > dt_from_string;
285 return;
288 =head3 is_expired
290 my $is_expired = $patron->is_expired;
292 Returns 1 if the patron is expired or 0;
294 =cut
296 sub is_expired {
297 my ($self) = @_;
298 return 0 unless $self->dateexpiry;
299 return 0 if $self->dateexpiry eq '0000-00-00';
300 return 1 if dt_from_string( $self->dateexpiry ) < dt_from_string->truncate( to => 'day' );
301 return 0;
304 =head3 is_going_to_expire
306 my $is_going_to_expire = $patron->is_going_to_expire;
308 Returns 1 if the patron is going to expired, depending on the NotifyBorrowerDeparture pref or 0
310 =cut
312 sub is_going_to_expire {
313 my ($self) = @_;
315 my $delay = C4::Context->preference('NotifyBorrowerDeparture') || 0;
317 return 0 unless $delay;
318 return 0 unless $self->dateexpiry;
319 return 0 if $self->dateexpiry eq '0000-00-00';
320 return 1 if dt_from_string( $self->dateexpiry )->subtract( days => $delay ) < dt_from_string->truncate( to => 'day' );
321 return 0;
324 =head3 update_password
326 my $updated = $patron->update_password( $userid, $password );
328 Update the userid and the password of a patron.
329 If the userid already exists, returns and let DBIx::Class warns
330 This will add an entry to action_logs if BorrowersLog is set.
332 =cut
334 sub update_password {
335 my ( $self, $userid, $password ) = @_;
336 eval { $self->userid($userid)->store; };
337 return if $@; # Make sure the userid is not already in used by another patron
338 $self->update(
340 password => $password,
341 login_attempts => 0,
344 logaction( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
345 return 1;
348 =head3 renew_account
350 my $new_expiry_date = $patron->renew_account
352 Extending the subscription to the expiry date.
354 =cut
356 sub renew_account {
357 my ($self) = @_;
358 my $date;
359 if ( C4::Context->preference('BorrowerRenewalPeriodBase') eq 'combination' ) {
360 $date = ( dt_from_string gt dt_from_string( $self->dateexpiry ) ) ? dt_from_string : dt_from_string( $self->dateexpiry );
361 } else {
362 $date =
363 C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry'
364 ? dt_from_string( $self->dateexpiry )
365 : dt_from_string;
367 my $expiry_date = $self->category->get_expiry_date($date);
369 $self->dateexpiry($expiry_date);
370 $self->date_renewed( dt_from_string() );
371 $self->store();
373 $self->add_enrolment_fee_if_needed;
375 logaction( "MEMBERS", "RENEW", $self->borrowernumber, "Membership renewed" ) if C4::Context->preference("BorrowersLog");
376 return dt_from_string( $expiry_date )->truncate( to => 'day' );
379 =head3 has_overdues
381 my $has_overdues = $patron->has_overdues;
383 Returns the number of patron's overdues
385 =cut
387 sub has_overdues {
388 my ($self) = @_;
389 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
390 return $self->_result->issues->search({ date_due => { '<' => $dtf->format_datetime( dt_from_string() ) } })->count;
393 =head3 track_login
395 $patron->track_login;
396 $patron->track_login({ force => 1 });
398 Tracks a (successful) login attempt.
399 The preference TrackLastPatronActivity must be enabled. Or you
400 should pass the force parameter.
402 =cut
404 sub track_login {
405 my ( $self, $params ) = @_;
406 return if
407 !$params->{force} &&
408 !C4::Context->preference('TrackLastPatronActivity');
409 $self->lastseen( dt_from_string() )->store;
412 =head3 move_to_deleted
414 my $is_moved = $patron->move_to_deleted;
416 Move a patron to the deletedborrowers table.
417 This can be done before deleting a patron, to make sure the data are not completely deleted.
419 =cut
421 sub move_to_deleted {
422 my ($self) = @_;
423 my $patron_infos = $self->unblessed;
424 delete $patron_infos->{updated_on}; #This ensures the updated_on date in deletedborrowers will be set to the current timestamp
425 return Koha::Database->new->schema->resultset('Deletedborrower')->create($patron_infos);
428 =head3 article_requests
430 my @requests = $borrower->article_requests();
431 my $requests = $borrower->article_requests();
433 Returns either a list of ArticleRequests objects,
434 or an ArtitleRequests object, depending on the
435 calling context.
437 =cut
439 sub article_requests {
440 my ( $self ) = @_;
442 $self->{_article_requests} ||= Koha::ArticleRequests->search({ borrowernumber => $self->borrowernumber() });
444 return $self->{_article_requests};
447 =head3 article_requests_current
449 my @requests = $patron->article_requests_current
451 Returns the article requests associated with this patron that are incomplete
453 =cut
455 sub article_requests_current {
456 my ( $self ) = @_;
458 $self->{_article_requests_current} ||= Koha::ArticleRequests->search(
460 borrowernumber => $self->id(),
461 -or => [
462 { status => Koha::ArticleRequest::Status::Pending },
463 { status => Koha::ArticleRequest::Status::Processing }
468 return $self->{_article_requests_current};
471 =head3 article_requests_finished
473 my @requests = $biblio->article_requests_finished
475 Returns the article requests associated with this patron that are completed
477 =cut
479 sub article_requests_finished {
480 my ( $self, $borrower ) = @_;
482 $self->{_article_requests_finished} ||= Koha::ArticleRequests->search(
484 borrowernumber => $self->id(),
485 -or => [
486 { status => Koha::ArticleRequest::Status::Completed },
487 { status => Koha::ArticleRequest::Status::Canceled }
492 return $self->{_article_requests_finished};
495 =head3 add_enrolment_fee_if_needed
497 my $enrolment_fee = $patron->add_enrolment_fee_if_needed;
499 Add enrolment fee for a patron if needed.
501 =cut
503 sub add_enrolment_fee_if_needed {
504 my ($self) = @_;
505 my $enrolment_fee = $self->category->enrolmentfee;
506 if ( $enrolment_fee && $enrolment_fee > 0 ) {
507 # insert fee in patron debts
508 C4::Accounts::manualinvoice( $self->borrowernumber, '', '', 'A', $enrolment_fee );
510 return $enrolment_fee || 0;
513 =head3 checkouts
515 my $issues = $patron->checkouts
517 =cut
519 sub checkouts {
520 my ($self) = @_;
521 my $issues = $self->_result->issues;
522 return Koha::Checkouts->_new_from_dbic( $issues );
525 =head3 get_overdues
527 my $overdue_items = $patron->get_overdues
529 Return the overdued items
531 =cut
533 sub get_overdues {
534 my ($self) = @_;
535 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
536 return $self->checkouts->search(
538 'me.date_due' => { '<' => $dtf->format_datetime(dt_from_string) },
541 prefetch => { item => { biblio => 'biblioitems' } },
546 =head3 get_age
548 my $age = $patron->get_age
550 Return the age of the patron
552 =cut
554 sub get_age {
555 my ($self) = @_;
556 my $today_str = dt_from_string->strftime("%Y-%m-%d");
557 return unless $self->dateofbirth;
558 my $dob_str = dt_from_string( $self->dateofbirth )->strftime("%Y-%m-%d");
560 my ( $dob_y, $dob_m, $dob_d ) = split /-/, $dob_str;
561 my ( $today_y, $today_m, $today_d ) = split /-/, $today_str;
563 my $age = $today_y - $dob_y;
564 if ( $dob_m . $dob_d > $today_m . $today_d ) {
565 $age--;
568 return $age;
571 =head3 account
573 my $account = $patron->account
575 =cut
577 sub account {
578 my ($self) = @_;
579 return Koha::Account->new( { patron_id => $self->borrowernumber } );
582 =head3 holds
584 my $holds = $patron->holds
586 Return all the holds placed by this patron
588 =cut
590 sub holds {
591 my ($self) = @_;
592 my $holds_rs = $self->_result->reserves->search( {}, { order_by => 'reservedate' } );
593 return Koha::Holds->_new_from_dbic($holds_rs);
596 =head3 first_valid_email_address
598 =cut
600 sub first_valid_email_address {
601 my ($self) = @_;
603 return $self->email() || $self->emailpro() || $self->B_email() || q{};
606 =head3 get_club_enrollments
608 =cut
610 sub get_club_enrollments {
611 my ( $self, $return_scalar ) = @_;
613 my $e = Koha::Club::Enrollments->search( { borrowernumber => $self->borrowernumber(), date_canceled => undef } );
615 return $e if $return_scalar;
617 return wantarray ? $e->as_list : $e;
620 =head3 get_enrollable_clubs
622 =cut
624 sub get_enrollable_clubs {
625 my ( $self, $is_enrollable_from_opac, $return_scalar ) = @_;
627 my $params;
628 $params->{is_enrollable_from_opac} = $is_enrollable_from_opac
629 if $is_enrollable_from_opac;
630 $params->{is_email_required} = 0 unless $self->first_valid_email_address();
632 $params->{borrower} = $self;
634 my $e = Koha::Clubs->get_enrollable($params);
636 return $e if $return_scalar;
638 return wantarray ? $e->as_list : $e;
641 =head3 account_locked
643 my $is_locked = $patron->account_locked
645 Return true if the patron has reach the maximum number of login attempts (see pref FailedLoginAttempts).
646 Otherwise return false.
647 If the pref is not set (empty string, null or 0), the feature is considered as disabled.
649 =cut
651 sub account_locked {
652 my ($self) = @_;
653 my $FailedLoginAttempts = C4::Context->preference('FailedLoginAttempts');
654 return ( $FailedLoginAttempts
655 and $self->login_attempts
656 and $self->login_attempts >= $FailedLoginAttempts )? 1 : 0;
659 =head3 type
661 =cut
663 sub _type {
664 return 'Borrower';
667 =head1 AUTHOR
669 Kyle M Hall <kyle@bywatersolutions.com>
670 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>
672 =cut