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
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use List::MoreUtils qw( any uniq );
24 use JSON qw( to_json );
25 use Unicode::Normalize qw( NFKD );
29 use C4::Auth qw( checkpw_hash );
30 use C4::Log qw( logaction );
32 use Koha::ArticleRequests;
33 use C4::Letters qw( GetPreparedLetter EnqueueLetter SendQueuedMessages );
36 use Koha::CirculationRules;
37 use Koha::Club::Enrollments;
39 use Koha::DateUtils qw( dt_from_string );
41 use Koha::Exceptions::Password;
43 use Koha::CurbsidePickups;
44 use Koha::Old::Checkouts;
45 use Koha::Patron::Attributes;
46 use Koha::Patron::Categories;
47 use Koha::Patron::Debarments;
48 use Koha::Patron::HouseboundProfile;
49 use Koha::Patron::HouseboundRole;
50 use Koha::Patron::Images;
51 use Koha::Patron::Messages;
52 use Koha::Patron::Modifications;
53 use Koha::Patron::Relationships;
54 use Koha::Patron::Restrictions;
58 use Koha::Result::Boolean;
59 use Koha::Subscription::Routinglists;
61 use Koha::Virtualshelves;
63 use base qw(Koha::Object);
65 use constant ADMINISTRATIVE_LOCKOUT => -1;
67 our $RESULTSET_PATRON_ID_MAPPING = {
68 Accountline => 'borrowernumber',
69 Aqbasketuser => 'borrowernumber',
70 Aqbudget => 'budget_owner_id',
71 Aqbudgetborrower => 'borrowernumber',
72 ArticleRequest => 'borrowernumber',
73 BorrowerDebarment => 'borrowernumber',
74 BorrowerFile => 'borrowernumber',
75 BorrowerModification => 'borrowernumber',
76 ClubEnrollment => 'borrowernumber',
77 Issue => 'borrowernumber',
78 ItemsLastBorrower => 'borrowernumber',
79 Linktracker => 'borrowernumber',
80 Message => 'borrowernumber',
81 MessageQueue => 'borrowernumber',
82 OldIssue => 'borrowernumber',
83 OldReserve => 'borrowernumber',
84 Rating => 'borrowernumber',
85 Reserve => 'borrowernumber',
86 Review => 'borrowernumber',
87 SearchHistory => 'userid',
88 Statistic => 'borrowernumber',
89 Suggestion => 'suggestedby',
90 TagAll => 'borrowernumber',
91 Virtualshelfcontent => 'borrowernumber',
92 Virtualshelfshare => 'borrowernumber',
93 Virtualshelve => 'owner',
98 Koha::Patron - Koha Patron Object class
109 my ( $class, $params ) = @_;
111 return $class->SUPER::new($params);
114 =head3 fixup_cardnumber
116 Autogenerate next cardnumber from highest value found in database
120 sub fixup_cardnumber {
123 my $max = $self->cardnumber;
124 Koha::Plugins->call( 'patron_barcode_transform', \$max );
126 $max ||= Koha::Patrons->search({
127 cardnumber => {-regexp => '^-?[0-9]+$'}
129 select => \'CAST(cardnumber AS SIGNED)',
130 as => ['cast_cardnumber']
131 })->_resultset->get_column('cast_cardnumber')->max;
132 $self->cardnumber(($max || 0) +1);
135 =head3 trim_whitespace
137 trim whitespace from data which has some non-whitespace in it.
138 Could be moved to Koha::Object if need to be reused
142 sub trim_whitespaces {
145 my $schema = Koha::Database->new->schema;
146 my @columns = $schema->source($self->_type)->columns;
148 for my $column( @columns ) {
149 my $value = $self->$column;
150 if ( defined $value ) {
151 $value =~ s/^\s*|\s*$//g;
152 $self->$column($value);
158 =head3 plain_text_password
160 $patron->plain_text_password( $password );
162 stores a copy of the unencrypted password in the object
163 for use in code before encrypting for db
167 sub plain_text_password {
168 my ( $self, $password ) = @_;
170 $self->{_plain_text_password} = $password;
173 return $self->{_plain_text_password}
174 if $self->{_plain_text_password};
181 Patron specific store method to cleanup record
182 and do other necessary things before saving
190 $self->_result->result_source->schema->txn_do(
193 C4::Context->preference("autoMemberNum")
194 and ( not defined $self->cardnumber
195 or $self->cardnumber eq '' )
198 # Warning: The caller is responsible for locking the members table in write
199 # mode, to avoid database corruption.
200 # We are in a transaction but the table is not locked
201 $self->fixup_cardnumber;
204 unless( $self->category->in_storage ) {
205 Koha::Exceptions::Object::FKConstraint->throw(
206 broken_fk => 'categorycode',
207 value => $self->categorycode,
211 $self->trim_whitespaces;
213 my $new_cardnumber = $self->cardnumber;
214 Koha::Plugins->call( 'patron_barcode_transform', \$new_cardnumber );
215 $self->cardnumber( $new_cardnumber );
217 # Set surname to uppercase if uppercasesurname is true
218 $self->surname( uc($self->surname) )
219 if C4::Context->preference("uppercasesurnames");
221 $self->relationship(undef) # We do not want to store an empty string in this field
222 if defined $self->relationship
223 and $self->relationship eq "";
225 unless ( $self->in_storage ) { #AddMember
227 # Generate a valid userid/login if needed
228 $self->generate_userid
229 if not $self->userid or not $self->has_valid_userid;
231 # Add expiration date if it isn't already there
232 unless ( $self->dateexpiry ) {
233 $self->dateexpiry( $self->category->get_expiry_date );
236 # Add enrollment date if it isn't already there
237 unless ( $self->dateenrolled ) {
238 $self->dateenrolled(dt_from_string);
241 # Set the privacy depending on the patron's category
242 my $default_privacy = $self->category->default_privacy || q{};
244 $default_privacy eq 'default' ? 1
245 : $default_privacy eq 'never' ? 2
246 : $default_privacy eq 'forever' ? 0
248 $self->privacy($default_privacy);
250 # Call any check_password plugins if password is passed
251 if ( C4::Context->config("enable_plugins") && $self->password ) {
252 my @plugins = Koha::Plugins->new()->GetPlugins({
253 method => 'check_password',
255 foreach my $plugin ( @plugins ) {
256 # This plugin hook will also be used by a plugin for the Norwegian national
257 # patron database. This is why we need to pass both the password and the
258 # borrowernumber to the plugin.
259 my $ret = $plugin->check_password(
261 password => $self->password,
262 borrowernumber => $self->borrowernumber
265 if ( $ret->{'error'} == 1 ) {
266 Koha::Exceptions::Password::Plugin->throw();
271 # Make a copy of the plain text password for later use
272 $self->plain_text_password( $self->password );
274 $self->password_expiration_date( $self->password
275 ? $self->category->get_password_expiry_date || undef
277 # Create a disabled account if no password provided
278 $self->password( $self->password
279 ? Koha::AuthUtils::hash_password( $self->password )
282 $self->borrowernumber(undef);
284 $self = $self->SUPER::store;
286 $self->add_enrolment_fee_if_needed(0);
288 logaction( "MEMBERS", "CREATE", $self->borrowernumber, "" )
289 if C4::Context->preference("BorrowersLog");
293 my $self_from_storage = $self->get_from_storage;
294 # FIXME We should not deal with that here, callers have to do this job
295 # Moved from ModMember to prevent regressions
296 unless ( $self->userid ) {
297 my $stored_userid = $self_from_storage->userid;
298 $self->userid($stored_userid);
301 # Password must be updated using $self->set_password
302 $self->password($self_from_storage->password);
304 if ( $self->category->categorycode ne
305 $self_from_storage->category->categorycode )
307 # Add enrolement fee on category change if required
308 $self->add_enrolment_fee_if_needed(1)
309 if C4::Context->preference('FeeOnChangePatronCategory');
311 # Clean up guarantors on category change if required
312 $self->guarantor_relationships->delete
313 unless ( $self->category->can_be_guarantee );
318 if ( C4::Context->preference("BorrowersLog") ) {
320 my $from_storage = $self_from_storage->unblessed;
321 my $from_object = $self->unblessed;
322 my @skip_fields = (qw/lastseen updated_on/);
323 for my $key ( keys %{$from_storage} ) {
324 next if any { /$key/ } @skip_fields;
327 !defined( $from_storage->{$key} )
328 && defined( $from_object->{$key} )
330 || ( defined( $from_storage->{$key} )
331 && !defined( $from_object->{$key} ) )
333 defined( $from_storage->{$key} )
334 && defined( $from_object->{$key} )
335 && ( $from_storage->{$key} ne
336 $from_object->{$key} )
341 before => $from_storage->{$key},
342 after => $from_object->{$key}
347 if ( defined($info) ) {
351 $self->borrowernumber,
354 { utf8 => 1, pretty => 1, canonical => 1 }
361 $self = $self->SUPER::store;
372 Delete patron's holds, lists and finally the patron.
374 Lists owned by the borrower are deleted or ownership is transferred depending on the
375 ListOwnershipUponPatronDeletion pref, but entries from the borrower to other lists are kept.
382 my $anonymous_patron = C4::Context->preference("AnonymousPatron");
383 Koha::Exceptions::Patron::FailedDeleteAnonymousPatron->throw() if $anonymous_patron && $self->id eq $anonymous_patron;
385 $self->_result->result_source->schema->txn_do(
387 # Cancel Patron's holds
388 my $holds = $self->holds;
389 while( my $hold = $holds->next ){
393 # Handle lists (virtualshelves)
394 $self->virtualshelves->disown_or_delete;
396 # We cannot have a FK on borrower_modifications.borrowernumber, the table is also used
398 $_->delete for Koha::Patron::Modifications->search( { borrowernumber => $self->borrowernumber } )->as_list;
400 $self->SUPER::delete;
402 logaction( "MEMBERS", "DELETE", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
410 my $patron_category = $patron->category
412 Return the patron category for this patron
418 return Koha::Patron::Category->_new_from_dbic( $self->_result->categorycode );
428 return Koha::Patron::Images->find( $self->borrowernumber );
433 Returns a Koha::Library object representing the patron's home library.
439 return Koha::Library->_new_from_dbic($self->_result->branchcode);
444 Returns a Koha::SMS::Provider object representing the patron's SMS provider.
450 my $sms_provider_rs = $self->_result->sms_provider;
451 return unless $sms_provider_rs;
452 return Koha::SMS::Provider->_new_from_dbic($sms_provider_rs);
455 =head3 guarantor_relationships
457 Returns Koha::Patron::Relationships object for this patron's guarantors
459 Returns the set of relationships for the patrons that are guarantors for this patron.
461 This is returned instead of a Koha::Patron object because the guarantor
462 may not exist as a patron in Koha. If this is true, the guarantors name
463 exists in the Koha::Patron::Relationship object and will have no guarantor_id.
467 sub guarantor_relationships {
470 return Koha::Patron::Relationships->search( { guarantee_id => $self->id } );
473 =head3 guarantee_relationships
475 Returns Koha::Patron::Relationships object for this patron's guarantors
477 Returns the set of relationships for the patrons that are guarantees for this patron.
479 The method returns Koha::Patron::Relationship objects for the sake
480 of consistency with the guantors method.
481 A guarantee by definition must exist as a patron in Koha.
485 sub guarantee_relationships {
488 return Koha::Patron::Relationships->search(
489 { guarantor_id => $self->id },
491 prefetch => 'guarantee',
492 order_by => { -asc => [ 'guarantee.surname', 'guarantee.firstname' ] },
497 =head3 relationships_debt
499 Returns the amount owed by the patron's guarantors *and* the other guarantees of those guarantors
503 sub relationships_debt {
504 my ($self, $params) = @_;
506 my $include_guarantors = $params->{include_guarantors};
507 my $only_this_guarantor = $params->{only_this_guarantor};
508 my $include_this_patron = $params->{include_this_patron};
511 if ( $only_this_guarantor ) {
512 @guarantors = $self->guarantee_relationships->count ? ( $self ) : ();
513 Koha::Exceptions::BadParameter->throw( { parameter => 'only_this_guarantor' } ) unless @guarantors;
514 } elsif ( $self->guarantor_relationships->count ) {
515 # I am a guarantee, just get all my guarantors
516 @guarantors = $self->guarantor_relationships->guarantors->as_list;
518 # I am a guarantor, I need to get all the guarantors of all my guarantees
519 @guarantors = map { $_->guarantor_relationships->guarantors->as_list } $self->guarantee_relationships->guarantees->as_list;
522 my $non_issues_charges = 0;
523 my $seen = $include_this_patron ? {} : { $self->id => 1 }; # For tracking members already added to the total
524 foreach my $guarantor (@guarantors) {
525 $non_issues_charges += $guarantor->account->non_issues_charges if $include_guarantors && !$seen->{ $guarantor->id };
527 # We've added what the guarantor owes, not added in that guarantor's guarantees as well
528 my @guarantees = map { $_->guarantee } $guarantor->guarantee_relationships->as_list;
529 my $guarantees_non_issues_charges = 0;
530 foreach my $guarantee (@guarantees) {
531 next if $seen->{ $guarantee->id };
532 $guarantees_non_issues_charges += $guarantee->account->non_issues_charges;
533 # Mark this guarantee as seen so we don't double count a guarantee linked to multiple guarantors
534 $seen->{ $guarantee->id } = 1;
537 $non_issues_charges += $guarantees_non_issues_charges;
538 $seen->{ $guarantor->id } = 1;
541 return $non_issues_charges;
544 =head3 housebound_profile
546 Returns the HouseboundProfile associated with this patron.
550 sub housebound_profile {
552 my $profile = $self->_result->housebound_profile;
553 return Koha::Patron::HouseboundProfile->_new_from_dbic($profile)
558 =head3 housebound_role
560 Returns the HouseboundRole associated with this patron.
564 sub housebound_role {
567 my $role = $self->_result->housebound_role;
568 return Koha::Patron::HouseboundRole->_new_from_dbic($role) if ( $role );
574 Returns the siblings of this patron.
581 my @guarantors = $self->guarantor_relationships()->guarantors()->as_list;
583 return unless @guarantors;
586 map { $_->guarantee_relationships()->guarantees()->as_list } @guarantors;
588 return unless @siblings;
592 grep { !$seen{ $_->id }++ && ( $_->id != $self->id ) } @siblings;
594 return Koha::Patrons->search( { borrowernumber => { -in => [ map { $_->id } @siblings ] } } );
599 my $patron = Koha::Patrons->find($id);
600 $patron->merge_with( \@patron_ids );
602 This subroutine merges a list of patrons into the patron record. This is accomplished by finding
603 all related patron ids for the patrons to be merged in other tables and changing the ids to be that
604 of the keeper patron.
609 my ( $self, $patron_ids ) = @_;
611 my $anonymous_patron = C4::Context->preference("AnonymousPatron");
612 return if $anonymous_patron && $self->id eq $anonymous_patron;
614 my @patron_ids = @{ $patron_ids };
616 # Ensure the keeper isn't in the list of patrons to merge
617 @patron_ids = grep { $_ ne $self->id } @patron_ids;
619 my $schema = Koha::Database->new()->schema();
623 $self->_result->result_source->schema->txn_do( sub {
624 foreach my $patron_id (@patron_ids) {
626 next if $patron_id eq $anonymous_patron;
628 my $patron = Koha::Patrons->find( $patron_id );
632 # Unbless for safety, the patron will end up being deleted
633 $results->{merged}->{$patron_id}->{patron} = $patron->unblessed;
635 my $attributes = $patron->extended_attributes;
636 my $new_attributes = [
637 map { { code => $_->code, attribute => $_->attribute } }
640 $attributes->delete; # We need to delete before trying to merge them to prevent exception on unique and repeatable
641 for my $attribute ( @$new_attributes ) {
643 $self->add_extended_attribute($attribute);
645 # Don't block the merge if there is a non-repeatable attribute that cannot be added to the current patron.
646 unless ( $_->isa('Koha::Exceptions::Patron::Attribute::NonRepeatable') ) {
652 while (my ($r, $field) = each(%$RESULTSET_PATRON_ID_MAPPING)) {
653 my $rs = $schema->resultset($r)->search({ $field => $patron_id });
654 $results->{merged}->{ $patron_id }->{updated}->{$r} = $rs->count();
655 $rs->update({ $field => $self->id });
656 if ( $r eq 'BorrowerDebarment' ) {
657 Koha::Patron::Debarments::UpdateBorrowerDebarmentFlags($self->id);
661 $patron->move_to_deleted();
671 =head3 wants_check_for_previous_checkout
673 $wants_check = $patron->wants_check_for_previous_checkout;
675 Return 1 if Koha needs to perform PrevIssue checking, else 0.
679 sub wants_check_for_previous_checkout {
681 my $syspref = C4::Context->preference("checkPrevCheckout");
684 ## Hard syspref trumps all
685 return 1 if ($syspref eq 'hardyes');
686 return 0 if ($syspref eq 'hardno');
687 ## Now, patron pref trumps all
688 return 1 if ($self->checkprevcheckout eq 'yes');
689 return 0 if ($self->checkprevcheckout eq 'no');
691 # More complex: patron inherits -> determine category preference
692 my $checkPrevCheckoutByCat = $self->category->checkprevcheckout;
693 return 1 if ($checkPrevCheckoutByCat eq 'yes');
694 return 0 if ($checkPrevCheckoutByCat eq 'no');
696 # Finally: category preference is inherit, default to 0
697 if ($syspref eq 'softyes') {
704 =head3 do_check_for_previous_checkout
706 $do_check = $patron->do_check_for_previous_checkout($item);
708 Return 1 if the bib associated with $ITEM has previously been checked out to
709 $PATRON, 0 otherwise.
713 sub do_check_for_previous_checkout {
714 my ( $self, $item ) = @_;
717 my $biblio = Koha::Biblios->find( $item->{biblionumber} );
718 if ( $biblio->is_serial ) {
719 push @item_nos, $item->{itemnumber};
721 # Get all itemnumbers for given bibliographic record.
722 @item_nos = $biblio->items->get_column( 'itemnumber' );
725 # Create (old)issues search criteria
727 borrowernumber => $self->borrowernumber,
728 itemnumber => \@item_nos,
731 my $delay = C4::Context->preference('CheckPrevCheckoutDelay') || 0;
733 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
734 my $newer_than = dt_from_string()->subtract( days => $delay );
735 $criteria->{'returndate'} = { '>' => $dtf->format_datetime($newer_than), };
738 # Check current issues table
739 my $issues = Koha::Checkouts->search($criteria);
740 return 1 if $issues->count; # 0 || N
742 # Check old issues table
743 my $old_issues = Koha::Old::Checkouts->search($criteria);
744 return $old_issues->count; # 0 || N
749 my $debarment_expiration = $patron->is_debarred;
751 Returns the date a patron debarment will expire, or undef if the patron is not
759 return unless $self->debarred;
760 return $self->debarred
761 if $self->debarred =~ '^9999'
762 or dt_from_string( $self->debarred ) > dt_from_string;
768 my $is_expired = $patron->is_expired;
770 Returns 1 if the patron is expired or 0;
776 return 0 unless $self->dateexpiry;
777 return 0 if $self->dateexpiry =~ '^9999';
778 return 1 if dt_from_string( $self->dateexpiry ) < dt_from_string->truncate( to => 'day' );
782 =head3 password_expired
784 my $password_expired = $patron->password_expired;
786 Returns 1 if the patron's password is expired or 0;
790 sub password_expired {
792 return 0 unless $self->password_expiration_date;
793 return 1 if dt_from_string( $self->password_expiration_date ) <= dt_from_string->truncate( to => 'day' );
797 =head3 is_going_to_expire
799 my $is_going_to_expire = $patron->is_going_to_expire;
801 Returns 1 if the patron is going to expired, depending on the NotifyBorrowerDeparture pref or 0
805 sub is_going_to_expire {
808 my $delay = C4::Context->preference('NotifyBorrowerDeparture') || 0;
810 return 0 unless $delay;
811 return 0 unless $self->dateexpiry;
812 return 0 if $self->dateexpiry =~ '^9999';
813 return 1 if dt_from_string( $self->dateexpiry, undef, 'floating' )->subtract( days => $delay ) < dt_from_string(undef, undef, 'floating')->truncate( to => 'day' );
819 $patron->set_password({ password => $plain_text_password [, skip_validation => 1 ] });
821 Set the patron's password.
825 The passed string is validated against the current password enforcement policy.
826 Validation can be skipped by passing the I<skip_validation> parameter.
828 Exceptions are thrown if the password is not good enough.
832 =item Koha::Exceptions::Password::TooShort
834 =item Koha::Exceptions::Password::WhitespaceCharacters
836 =item Koha::Exceptions::Password::TooWeak
838 =item Koha::Exceptions::Password::Plugin (if a "check password" plugin is enabled)
845 my ( $self, $args ) = @_;
847 my $password = $args->{password};
849 unless ( $args->{skip_validation} ) {
850 my ( $is_valid, $error ) = Koha::AuthUtils::is_password_valid( $password, $self->category );
853 if ( $error eq 'too_short' ) {
854 my $min_length = $self->category->effective_min_password_length;
855 $min_length = 3 if not $min_length or $min_length < 3;
857 my $password_length = length($password);
858 Koha::Exceptions::Password::TooShort->throw(
859 length => $password_length, min_length => $min_length );
861 elsif ( $error eq 'has_whitespaces' ) {
862 Koha::Exceptions::Password::WhitespaceCharacters->throw();
864 elsif ( $error eq 'too_weak' ) {
865 Koha::Exceptions::Password::TooWeak->throw();
870 if ( C4::Context->config("enable_plugins") ) {
871 # Call any check_password plugins
872 my @plugins = Koha::Plugins->new()->GetPlugins({
873 method => 'check_password',
875 foreach my $plugin ( @plugins ) {
876 # This plugin hook will also be used by a plugin for the Norwegian national
877 # patron database. This is why we need to pass both the password and the
878 # borrowernumber to the plugin.
879 my $ret = $plugin->check_password(
881 password => $password,
882 borrowernumber => $self->borrowernumber
885 # This plugin hook will also be used by a plugin for the Norwegian national
886 # patron database. This is why we need to call the actual plugins and then
887 # check skip_validation afterwards.
888 if ( $ret->{'error'} == 1 && !$args->{skip_validation} ) {
889 Koha::Exceptions::Password::Plugin->throw();
894 if ( C4::Context->preference('NotifyPasswordChange') ) {
895 my $self_from_storage = $self->get_from_storage;
896 if ( !C4::Auth::checkpw_hash( $password, $self_from_storage->password ) ) {
897 my $emailaddr = $self_from_storage->notice_email_address;
899 # if we manage to find a valid email address, send notice
901 my $letter = C4::Letters::GetPreparedLetter(
903 letter_code => 'PASSWORD_CHANGE',
904 branchcode => $self_from_storage->branchcode,
906 lang => $self_from_storage->lang || 'default',
908 'branches' => $self_from_storage->branchcode,
909 'borrowers' => $self_from_storage->borrowernumber,
914 my $message_id = C4::Letters::EnqueueLetter(
917 borrowernumber => $self_from_storage->id,
918 to_address => $emailaddr,
919 message_transport_type => 'email'
922 C4::Letters::SendQueuedMessages( { message_id => $message_id } );
927 my $digest = Koha::AuthUtils::hash_password($password);
929 $self->password_expiration_date( $self->category->get_password_expiry_date || undef );
931 # We do not want to call $self->store and retrieve password from DB
932 $self->password($digest);
933 $self->login_attempts(0);
936 logaction( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" )
937 if C4::Context->preference("BorrowersLog");
945 my $new_expiry_date = $patron->renew_account
947 Extending the subscription to the expiry date.
954 if ( C4::Context->preference('BorrowerRenewalPeriodBase') eq 'combination' ) {
955 $date = ( dt_from_string gt dt_from_string( $self->dateexpiry ) ) ? dt_from_string : dt_from_string( $self->dateexpiry );
958 C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry'
959 ? dt_from_string( $self->dateexpiry )
962 my $expiry_date = $self->category->get_expiry_date($date);
964 $self->dateexpiry($expiry_date);
965 $self->date_renewed( dt_from_string() );
968 $self->add_enrolment_fee_if_needed(1);
970 logaction( "MEMBERS", "RENEW", $self->borrowernumber, "Membership renewed" ) if C4::Context->preference("BorrowersLog");
971 return dt_from_string( $expiry_date )->truncate( to => 'day' );
976 my $has_overdues = $patron->has_overdues;
978 Returns the number of patron's overdues
984 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
985 return $self->_result->issues->search({ date_due => { '<' => $dtf->format_datetime( dt_from_string() ) } })->count;
990 $patron->track_login;
991 $patron->track_login({ force => 1 });
993 Tracks a (successful) login attempt.
994 The preference TrackLastPatronActivity must be enabled. Or you
995 should pass the force parameter.
1000 my ( $self, $params ) = @_;
1002 !$params->{force} &&
1003 !C4::Context->preference('TrackLastPatronActivity');
1004 $self->lastseen( dt_from_string() )->store;
1007 =head3 move_to_deleted
1009 my $is_moved = $patron->move_to_deleted;
1011 Move a patron to the deletedborrowers table.
1012 This can be done before deleting a patron, to make sure the data are not completely deleted.
1016 sub move_to_deleted {
1018 my $patron_infos = $self->unblessed;
1019 delete $patron_infos->{updated_on}; #This ensures the updated_on date in deletedborrowers will be set to the current timestamp
1020 return Koha::Database->new->schema->resultset('Deletedborrower')->create($patron_infos);
1023 =head3 can_request_article
1025 if ( $patron->can_request_article( $library->id ) ) { ... }
1027 Returns true if the patron can request articles. As limits apply for the patron
1028 on the same day, those completed the same day are considered as current.
1030 A I<library_id> can be passed as parameter, falling back to userenv if absent.
1034 sub can_request_article {
1035 my ($self, $library_id) = @_;
1037 $library_id //= C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
1039 my $rule = Koha::CirculationRules->get_effective_rule(
1041 branchcode => $library_id,
1042 categorycode => $self->categorycode,
1043 rule_name => 'open_article_requests_limit'
1047 my $limit = ($rule) ? $rule->rule_value : undef;
1049 return 1 unless defined $limit;
1051 my $count = Koha::ArticleRequests->search(
1052 [ { borrowernumber => $self->borrowernumber, status => [ 'REQUESTED', 'PENDING', 'PROCESSING' ] },
1053 { borrowernumber => $self->borrowernumber, status => 'COMPLETED', updated_on => { '>=' => \'CAST(NOW() AS DATE)' } },
1056 return $count < $limit ? 1 : 0;
1059 =head3 article_request_fee
1061 my $fee = $patron->article_request_fee(
1063 [ library_id => $library->id, ]
1067 Returns the fee to be charged to the patron when it places an article request.
1069 A I<library_id> can be passed as parameter, falling back to userenv if absent.
1073 sub article_request_fee {
1074 my ($self, $params) = @_;
1076 my $library_id = $params->{library_id};
1078 $library_id //= C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
1080 my $rule = Koha::CirculationRules->get_effective_rule(
1082 branchcode => $library_id,
1083 categorycode => $self->categorycode,
1084 rule_name => 'article_request_fee'
1088 my $fee = ($rule) ? $rule->rule_value + 0 : 0;
1093 =head3 add_article_request_fee_if_needed
1095 my $fee = $patron->add_article_request_fee_if_needed(
1097 [ item_id => $item->id,
1098 library_id => $library->id, ]
1102 If an article request fee needs to be charged, it adds a debit to the patron's
1105 Returns the fee line.
1107 A I<library_id> can be passed as parameter, falling back to userenv if absent.
1111 sub add_article_request_fee_if_needed {
1112 my ($self, $params) = @_;
1114 my $library_id = $params->{library_id};
1115 my $item_id = $params->{item_id};
1117 $library_id //= C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
1119 my $amount = $self->article_request_fee(
1121 library_id => $library_id,
1127 if ( $amount > 0 ) {
1128 $debit_line = $self->account->add_debit(
1131 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
1132 interface => C4::Context->interface,
1133 library_id => $library_id,
1134 type => 'ARTICLE_REQUEST',
1135 item_id => $item_id,
1143 =head3 article_requests
1145 my $article_requests = $patron->article_requests;
1147 Returns the patron article requests.
1151 sub article_requests {
1154 return Koha::ArticleRequests->_new_from_dbic( scalar $self->_result->article_requests );
1157 =head3 add_enrolment_fee_if_needed
1159 my $enrolment_fee = $patron->add_enrolment_fee_if_needed($renewal);
1161 Add enrolment fee for a patron if needed.
1163 $renewal - boolean denoting whether this is an account renewal or not
1167 sub add_enrolment_fee_if_needed {
1168 my ($self, $renewal) = @_;
1169 my $enrolment_fee = $self->category->enrolmentfee;
1170 if ( $enrolment_fee && $enrolment_fee > 0 ) {
1171 my $type = $renewal ? 'ACCOUNT_RENEW' : 'ACCOUNT';
1172 $self->account->add_debit(
1174 amount => $enrolment_fee,
1175 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
1176 interface => C4::Context->interface,
1177 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
1182 return $enrolment_fee || 0;
1187 my $checkouts = $patron->checkouts
1193 my $checkouts = $self->_result->issues;
1194 return Koha::Checkouts->_new_from_dbic( $checkouts );
1197 =head3 pending_checkouts
1199 my $pending_checkouts = $patron->pending_checkouts
1201 This method will return the same as $self->checkouts, but with a prefetch on
1202 items, biblio and biblioitems.
1204 It has been introduced to replaced the C4::Members::GetPendingIssues subroutine
1206 It should not be used directly, prefer to access fields you need instead of
1207 retrieving all these fields in one go.
1211 sub pending_checkouts {
1213 my $checkouts = $self->_result->issues->search(
1217 { -desc => 'me.timestamp' },
1218 { -desc => 'issuedate' },
1219 { -desc => 'issue_id' }, # Sort by issue_id should be enough
1221 prefetch => { item => { biblio => 'biblioitems' } },
1224 return Koha::Checkouts->_new_from_dbic( $checkouts );
1227 =head3 old_checkouts
1229 my $old_checkouts = $patron->old_checkouts
1235 my $old_checkouts = $self->_result->old_issues;
1236 return Koha::Old::Checkouts->_new_from_dbic( $old_checkouts );
1241 my $overdue_items = $patron->overdues
1243 Return the overdue items
1249 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
1250 return $self->checkouts->search(
1252 'me.date_due' => { '<' => $dtf->format_datetime(dt_from_string) },
1255 prefetch => { item => { biblio => 'biblioitems' } },
1263 my $restrictions = $patron->restrictions;
1265 Returns the patron restrictions.
1271 my $restrictions_rs = $self->_result->restrictions;
1272 return Koha::Patron::Restrictions->_new_from_dbic($restrictions_rs);
1275 =head3 get_routing_lists
1277 my $routinglists = $patron->get_routing_lists
1279 Returns the routing lists a patron is subscribed to.
1283 sub get_routing_lists {
1285 my $routing_list_rs = $self->_result->subscriptionroutinglists;
1286 return Koha::Subscription::Routinglists->_new_from_dbic($routing_list_rs);
1291 my $age = $patron->get_age
1293 Return the age of the patron
1300 return unless $self->dateofbirth;
1302 my $date_of_birth = dt_from_string( $self->dateofbirth );
1303 my $today = dt_from_string->truncate( to => 'day' );
1305 return $today->subtract_datetime( $date_of_birth )->years;
1310 my $is_valid = $patron->is_valid_age
1312 Return 1 if patron's age is between allowed limits, returns 0 if it's not.
1318 my $age = $self->get_age;
1320 my $patroncategory = $self->category;
1321 my ($low,$high) = ($patroncategory->dateofbirthrequired, $patroncategory->upperagelimit);
1323 return (defined($age) && (($high && ($age > $high)) or ($low && ($age < $low)))) ? 0 : 1;
1328 my $account = $patron->account
1334 return Koha::Account->new( { patron_id => $self->borrowernumber } );
1339 my $holds = $patron->holds
1341 Return all the holds placed by this patron
1347 my $holds_rs = $self->_result->reserves->search( {}, { order_by => 'reservedate' } );
1348 return Koha::Holds->_new_from_dbic($holds_rs);
1353 my $old_holds = $patron->old_holds
1355 Return all the historical holds for this patron
1361 my $old_holds_rs = $self->_result->old_reserves->search( {}, { order_by => 'reservedate' } );
1362 return Koha::Old::Holds->_new_from_dbic($old_holds_rs);
1365 =head3 curbside_pickups
1367 my $curbside_pickups = $patron->curbside_pickups;
1369 Return all the curbside pickups for this patron
1373 sub curbside_pickups {
1375 my $curbside_pickups_rs = $self->_result->curbside_pickups_borrowernumbers->search;
1376 return Koha::CurbsidePickups->_new_from_dbic($curbside_pickups_rs);
1379 =head3 return_claims
1381 my $return_claims = $patron->return_claims
1387 my $return_claims = $self->_result->return_claims_borrowernumbers;
1388 return Koha::Checkouts::ReturnClaims->_new_from_dbic( $return_claims );
1391 =head3 notice_email_address
1393 my $email = $patron->notice_email_address;
1395 Return the email address of patron used for notices.
1396 Returns the empty string if no email address.
1400 sub notice_email_address{
1403 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1404 # if syspref is set to 'first valid' (value == OFF), look up email address
1405 if ( $which_address eq 'OFF' ) {
1406 return $self->first_valid_email_address;
1409 return $self->$which_address || '';
1412 =head3 first_valid_email_address
1414 my $first_valid_email_address = $patron->first_valid_email_address
1416 Return the first valid email address for a patron.
1417 For now, the order is defined as email, emailpro, B_email.
1418 Returns the empty string if the borrower has no email addresses.
1422 sub first_valid_email_address {
1425 return $self->email() || $self->emailpro() || $self->B_email() || q{};
1428 =head3 get_club_enrollments
1432 sub get_club_enrollments {
1435 return Koha::Club::Enrollments->search( { borrowernumber => $self->borrowernumber(), date_canceled => undef } );
1438 =head3 get_enrollable_clubs
1442 sub get_enrollable_clubs {
1443 my ( $self, $is_enrollable_from_opac ) = @_;
1446 $params->{is_enrollable_from_opac} = $is_enrollable_from_opac
1447 if $is_enrollable_from_opac;
1448 $params->{is_email_required} = 0 unless $self->first_valid_email_address();
1450 $params->{borrower} = $self;
1452 return Koha::Clubs->get_enrollable($params);
1455 =head3 account_locked
1457 my $is_locked = $patron->account_locked
1459 Return true if the patron has reached the maximum number of login attempts
1460 (see pref FailedLoginAttempts). If login_attempts is < 0, this is interpreted
1461 as an administrative lockout (independent of FailedLoginAttempts; see also
1462 Koha::Patron->lock).
1463 Otherwise return false.
1464 If the pref is not set (empty string, null or 0), the feature is considered as
1469 sub account_locked {
1471 my $FailedLoginAttempts = C4::Context->preference('FailedLoginAttempts');
1472 return 1 if $FailedLoginAttempts
1473 and $self->login_attempts
1474 and $self->login_attempts >= $FailedLoginAttempts;
1475 return 1 if ($self->login_attempts || 0) < 0; # administrative lockout
1479 =head3 can_see_patron_infos
1481 my $can_see = $patron->can_see_patron_infos( $patron );
1483 Return true if the patron (usually the logged in user) can see the patron's infos for a given patron
1487 sub can_see_patron_infos {
1488 my ( $self, $patron ) = @_;
1489 return unless $patron;
1490 return $self->can_see_patrons_from( $patron->branchcode );
1493 =head3 can_see_patrons_from
1495 my $can_see = $patron->can_see_patrons_from( $branchcode );
1497 Return true if the patron (usually the logged in user) can see the patron's infos from a given library
1501 sub can_see_patrons_from {
1502 my ( $self, $branchcode ) = @_;
1504 return $self->can_see_things_from(
1506 branchcode => $branchcode,
1507 permission => 'borrowers',
1508 subpermission => 'view_borrower_infos_from_any_libraries',
1513 =head3 can_edit_items_from
1515 my $can_edit = $patron->can_edit_items_from( $branchcode );
1517 Return true if the I<Koha::Patron> can edit items from the given branchcode
1521 sub can_edit_items_from {
1522 my ( $self, $branchcode ) = @_;
1524 return 1 if C4::Context->IsSuperLibrarian();
1526 my $userenv = C4::Context->userenv();
1527 if ( $userenv && C4::Context->preference('IndependentBranches') ) {
1528 return $userenv->{branch} eq $branchcode;
1531 return $self->can_see_things_from(
1533 branchcode => $branchcode,
1534 permission => 'editcatalogue',
1535 subpermission => 'edit_any_item',
1540 =head3 libraries_where_can_edit_items
1542 my $libraries = $patron->libraries_where_can_edit_items;
1544 Return the list of branchcodes(!) of libraries the patron is allowed to items for.
1545 The branchcodes are arbitrarily returned sorted.
1546 We are supposing here that the object is related to the logged in patron (use of C4::Context::only_my_library)
1548 An empty array means no restriction, the user can edit any item.
1552 sub libraries_where_can_edit_items {
1555 return $self->libraries_where_can_see_things(
1557 permission => 'editcatalogue',
1558 subpermission => 'edit_any_item',
1559 group_feature => 'ft_limit_item_editing',
1564 =head3 libraries_where_can_see_patrons
1566 my $libraries = $patron->libraries_where_can_see_patrons;
1568 Return the list of branchcodes(!) of libraries the patron is allowed to see other patron's infos.
1569 The branchcodes are arbitrarily returned sorted.
1570 We are supposing here that the object is related to the logged in patron (use of C4::Context::only_my_library)
1572 An empty array means no restriction, the patron can see patron's infos from any libraries.
1576 sub libraries_where_can_see_patrons {
1579 return $self->libraries_where_can_see_things(
1581 permission => 'borrowers',
1582 subpermission => 'view_borrower_infos_from_any_libraries',
1583 group_feature => 'ft_hide_patron_info',
1588 =head3 can_see_things_from
1590 my $can_see = $patron->can_see_things_from( $branchcode );
1592 Return true if the I<Koha::Patron> can perform some action on the given thing
1596 sub can_see_things_from {
1597 my ( $self, $params ) = @_;
1599 my $branchcode = $params->{branchcode};
1600 my $permission = $params->{permission};
1601 my $subpermission = $params->{subpermission};
1603 return 1 if C4::Context->IsSuperLibrarian();
1606 if ( $self->branchcode eq $branchcode ) {
1608 } elsif ( $self->has_permission( { $permission => $subpermission } ) ) {
1610 } elsif ( my $library_groups = $self->library->library_groups ) {
1611 while ( my $library_group = $library_groups->next ) {
1612 if ( $library_group->parent->has_child( $branchcode ) ) {
1623 my $can_log_into = $patron->can_log_into( $library );
1625 Given a I<Koha::Library> object, it returns a boolean representing
1626 the fact the patron can log into a the library.
1631 my ( $self, $library ) = @_;
1635 if ( C4::Context->preference('IndependentBranches') ) {
1637 if $self->is_superlibrarian
1638 or $self->branchcode eq $library->id;
1648 =head3 libraries_where_can_see_things
1650 my $libraries = $patron->libraries_where_can_see_things;
1652 Returns a list of libraries where an aribitarary action is allowed to be taken by the logged in librarian
1653 against an object based on some branchcode related to the object ( patron branchcode, item homebranch, etc ).
1655 We are supposing here that the object is related to the logged in librarian (use of C4::Context::only_my_library)
1657 An empty array means no restriction, the thing can see thing's infos from any libraries.
1661 sub libraries_where_can_see_things {
1662 my ( $self, $params ) = @_;
1663 my $permission = $params->{permission};
1664 my $subpermission = $params->{subpermission};
1665 my $group_feature = $params->{group_feature};
1667 my $userenv = C4::Context->userenv;
1669 return () unless $userenv; # For tests, but userenv should be defined in tests...
1671 my @restricted_branchcodes;
1672 if (C4::Context::only_my_library) {
1673 push @restricted_branchcodes, $self->branchcode;
1677 $self->has_permission(
1678 { $permission => $subpermission }
1682 my $library_groups = $self->library->library_groups({ $group_feature => 1 });
1683 if ( $library_groups->count )
1685 while ( my $library_group = $library_groups->next ) {
1686 my $parent = $library_group->parent;
1687 if ( $parent->has_child( $self->branchcode ) ) {
1688 push @restricted_branchcodes, $parent->children->get_column('branchcode');
1693 @restricted_branchcodes = ( $self->branchcode ) unless @restricted_branchcodes;
1697 @restricted_branchcodes = grep { defined $_ } @restricted_branchcodes;
1698 @restricted_branchcodes = uniq(@restricted_branchcodes);
1699 @restricted_branchcodes = sort(@restricted_branchcodes);
1700 return @restricted_branchcodes;
1703 =head3 has_permission
1705 my $permission = $patron->has_permission($required);
1707 See C4::Auth::haspermission for details of syntax for $required
1711 sub has_permission {
1712 my ( $self, $flagsrequired ) = @_;
1713 return unless $self->userid;
1714 # TODO code from haspermission needs to be moved here!
1715 return C4::Auth::haspermission( $self->userid, $flagsrequired );
1718 =head3 is_superlibrarian
1720 my $is_superlibrarian = $patron->is_superlibrarian;
1722 Return true if the patron is a superlibrarian.
1726 sub is_superlibrarian {
1728 return $self->has_permission( { superlibrarian => 1 } ) ? 1 : 0;
1733 my $is_adult = $patron->is_adult
1735 Return true if the patron has a category with a type Adult (A) or Organization (I)
1741 return $self->category->category_type =~ /^(A|I)$/ ? 1 : 0;
1746 my $is_child = $patron->is_child
1748 Return true if the patron has a category with a type Child (C)
1754 return $self->category->category_type eq 'C' ? 1 : 0;
1757 =head3 has_valid_userid
1759 my $patron = Koha::Patrons->find(42);
1760 $patron->userid( $new_userid );
1761 my $has_a_valid_userid = $patron->has_valid_userid
1763 my $patron = Koha::Patron->new( $params );
1764 my $has_a_valid_userid = $patron->has_valid_userid
1766 Return true if the current userid of this patron is valid/unique, otherwise false.
1768 Note that this should be done in $self->store instead and raise an exception if needed.
1772 sub has_valid_userid {
1775 return 0 unless $self->userid;
1777 return 0 if ( $self->userid eq C4::Context->config('user') ); # DB user
1779 my $already_exists = Koha::Patrons->search(
1781 userid => $self->userid,
1784 ? ( borrowernumber => { '!=' => $self->borrowernumber } )
1789 return $already_exists ? 0 : 1;
1792 =head3 generate_userid
1794 my $patron = Koha::Patron->new( $params );
1795 $patron->generate_userid
1797 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
1799 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).
1803 sub generate_userid {
1806 my $firstname = $self->firstname // q{};
1807 my $surname = $self->surname // q{};
1808 #The script will "do" the following code and increment the $offset until the generated userid is unique
1810 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1811 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1812 my $userid = lc(($firstname)? "$firstname.$surname" : $surname);
1813 $userid = NFKD( $userid );
1814 $userid =~ s/\p{NonspacingMark}//g;
1815 $userid .= $offset unless $offset == 0;
1816 $self->userid( $userid );
1818 } while (! $self->has_valid_userid );
1823 =head3 add_extended_attribute
1827 sub add_extended_attribute {
1828 my ($self, $attribute) = @_;
1830 return Koha::Patron::Attribute->new(
1833 ( borrowernumber => $self->borrowernumber ),
1839 =head3 extended_attributes
1841 Return object of Koha::Patron::Attributes type with all attributes set for this patron
1847 sub extended_attributes {
1848 my ( $self, $attributes ) = @_;
1849 if ($attributes) { # setter
1850 my $schema = $self->_result->result_source->schema;
1853 # Remove the existing one
1854 $self->extended_attributes->filter_by_branch_limitations->delete;
1856 # Insert the new ones
1858 for my $attribute (@$attributes) {
1859 $self->add_extended_attribute($attribute);
1860 $new_types->{$attribute->{code}} = 1;
1863 # Check globally mandatory types
1864 my @required_attribute_types =
1865 Koha::Patron::Attribute::Types->search(
1868 category_code => [ undef, $self->categorycode ],
1869 'borrower_attribute_types_branches.b_branchcode' =>
1872 { join => 'borrower_attribute_types_branches' }
1873 )->get_column('code');
1874 for my $type ( @required_attribute_types ) {
1875 Koha::Exceptions::Patron::MissingMandatoryExtendedAttribute->throw(
1877 ) if !$new_types->{$type};
1883 my $rs = $self->_result->borrower_attributes;
1884 # We call search to use the filters in Koha::Patron::Attributes->search
1885 return Koha::Patron::Attributes->_new_from_dbic($rs)->search;
1890 my $messages = $patron->messages;
1892 Return the message attached to the patron.
1898 my $messages_rs = $self->_result->messages_borrowernumbers->search;
1899 return Koha::Patron::Messages->_new_from_dbic($messages_rs);
1904 Koha::Patrons->find($id)->lock({ expire => 1, remove => 1 });
1906 Lock and optionally expire a patron account.
1907 Remove holds and article requests if remove flag set.
1908 In order to distinguish from locking by entering a wrong password, let's
1909 call this an administrative lockout.
1914 my ( $self, $params ) = @_;
1915 $self->login_attempts( ADMINISTRATIVE_LOCKOUT );
1916 if( $params->{expire} ) {
1917 $self->dateexpiry( dt_from_string->subtract(days => 1) );
1920 if( $params->{remove} ) {
1921 $self->holds->delete;
1922 $self->article_requests->delete;
1929 Koha::Patrons->find($id)->anonymize;
1931 Anonymize or clear borrower fields. Fields in BorrowerMandatoryField
1932 are randomized, other personal data is cleared too.
1933 Patrons with issues are skipped.
1939 if( $self->_result->issues->count ) {
1940 warn "Exiting anonymize: patron ".$self->borrowernumber." still has issues";
1943 # Mandatory fields come from the corresponding pref, but email fields
1944 # are removed since scrambled email addresses only generate errors
1945 my $mandatory = { map { (lc $_, 1); } grep { !/email/ }
1946 split /\s*\|\s*/, C4::Context->preference('BorrowerMandatoryField') };
1947 $mandatory->{userid} = 1; # needed since sub store does not clear field
1948 my @columns = $self->_result->result_source->columns;
1949 @columns = grep { !/borrowernumber|branchcode|categorycode|^date|password|flags|updated_on|lastseen|lang|login_attempts|anonymized|auth_method/ } @columns;
1950 push @columns, 'dateofbirth'; # add this date back in
1951 foreach my $col (@columns) {
1952 $self->_anonymize_column($col, $mandatory->{lc $col} );
1954 $self->anonymized(1)->store;
1957 sub _anonymize_column {
1958 my ( $self, $col, $mandatory ) = @_;
1959 my $col_info = $self->_result->result_source->column_info($col);
1960 my $type = $col_info->{data_type};
1961 my $nullable = $col_info->{is_nullable};
1963 if( $type =~ /char|text/ ) {
1965 ? Koha::Token->new->generate({ pattern => '\w{10}' })
1969 } elsif( $type =~ /integer|int$|float|dec|double/ ) {
1970 $val = $nullable ? undef : 0;
1971 } elsif( $type =~ /date|time/ ) {
1972 $val = $nullable ? undef : dt_from_string;
1977 =head3 add_guarantor
1979 my $relationship = $patron->add_guarantor(
1981 borrowernumber => $borrowernumber,
1982 relationships => $relationship,
1986 Adds a new guarantor to a patron.
1991 my ( $self, $params ) = @_;
1993 my $guarantor_id = $params->{guarantor_id};
1994 my $relationship = $params->{relationship};
1996 return Koha::Patron::Relationship->new(
1998 guarantee_id => $self->id,
1999 guarantor_id => $guarantor_id,
2000 relationship => $relationship
2005 =head3 get_extended_attribute
2007 my $attribute_value = $patron->get_extended_attribute( $code );
2009 Return the attribute for the code passed in parameter.
2011 It not exist it returns undef
2013 Note that this will not work for repeatable attribute types.
2015 Maybe you certainly not want to use this method, it is actually only used for SHOW_BARCODE
2016 (which should be a real patron's attribute (not extended)
2020 sub get_extended_attribute {
2021 my ( $self, $code, $value ) = @_;
2022 my $rs = $self->_result->borrower_attributes;
2024 my $attribute = $rs->search({ code => $code, ( $value ? ( attribute => $value ) : () ) });
2025 return unless $attribute->count;
2026 return $attribute->next;
2031 my $json = $patron->to_api;
2033 Overloaded method that returns a JSON representation of the Koha::Patron object,
2034 suitable for API output.
2039 my ( $self, $params ) = @_;
2041 my $json_patron = $self->SUPER::to_api( $params );
2043 $json_patron->{restricted} = ( $self->is_debarred )
2045 : Mojo::JSON->false;
2047 return $json_patron;
2050 =head3 to_api_mapping
2052 This method returns the mapping for representing a Koha::Patron object
2057 sub to_api_mapping {
2059 borrowernotes => 'staff_notes',
2060 borrowernumber => 'patron_id',
2061 branchcode => 'library_id',
2062 categorycode => 'category_id',
2063 checkprevcheckout => 'check_previous_checkout',
2064 contactfirstname => undef, # Unused
2065 contactname => undef, # Unused
2066 contactnote => 'altaddress_notes',
2067 contacttitle => undef, # Unused
2068 dateenrolled => 'date_enrolled',
2069 dateexpiry => 'expiry_date',
2070 dateofbirth => 'date_of_birth',
2071 debarred => undef, # replaced by 'restricted'
2072 debarredcomment => undef, # calculated, API consumers will use /restrictions instead
2073 emailpro => 'secondary_email',
2074 flags => undef, # permissions manipulation handled in /permissions
2075 gonenoaddress => 'incorrect_address',
2076 lastseen => 'last_seen',
2077 lost => 'patron_card_lost',
2078 opacnote => 'opac_notes',
2079 othernames => 'other_name',
2080 password => undef, # password manipulation handled in /password
2081 phonepro => 'secondary_phone',
2082 relationship => 'relationship_type',
2084 smsalertnumber => 'sms_number',
2085 sort1 => 'statistics_1',
2086 sort2 => 'statistics_2',
2087 autorenew_checkouts => 'autorenew_checkouts',
2088 streetnumber => 'street_number',
2089 streettype => 'street_type',
2090 zipcode => 'postal_code',
2091 B_address => 'altaddress_address',
2092 B_address2 => 'altaddress_address2',
2093 B_city => 'altaddress_city',
2094 B_country => 'altaddress_country',
2095 B_email => 'altaddress_email',
2096 B_phone => 'altaddress_phone',
2097 B_state => 'altaddress_state',
2098 B_streetnumber => 'altaddress_street_number',
2099 B_streettype => 'altaddress_street_type',
2100 B_zipcode => 'altaddress_postal_code',
2101 altcontactaddress1 => 'altcontact_address',
2102 altcontactaddress2 => 'altcontact_address2',
2103 altcontactaddress3 => 'altcontact_city',
2104 altcontactcountry => 'altcontact_country',
2105 altcontactfirstname => 'altcontact_firstname',
2106 altcontactphone => 'altcontact_phone',
2107 altcontactsurname => 'altcontact_surname',
2108 altcontactstate => 'altcontact_state',
2109 altcontactzipcode => 'altcontact_postal_code',
2110 password_expiration_date => undef,
2111 primary_contact_method => undef,
2113 auth_method => undef,
2119 Koha::Patrons->queue_notice({ letter_params => $letter_params, message_name => 'DUE'});
2120 Koha::Patrons->queue_notice({ letter_params => $letter_params, message_transports => \@message_transports });
2121 Koha::Patrons->queue_notice({ letter_params => $letter_params, message_transports => \@message_transports, test_mode => 1 });
2123 Queue messages to a patron. Can pass a message that is part of the message_attributes
2124 table or supply the transport to use.
2126 If passed a message name we retrieve the patrons preferences for transports
2127 Otherwise we use the supplied transport. In the case of email or sms we fall back to print if
2128 we have no address/number for sending
2130 $letter_params is a hashref of the values to be passed to GetPreparedLetter
2132 test_mode will only report which notices would be sent, but nothing will be queued
2137 my ( $self, $params ) = @_;
2138 my $letter_params = $params->{letter_params};
2139 my $test_mode = $params->{test_mode};
2141 return unless $letter_params;
2142 return unless exists $params->{message_name} xor $params->{message_transports}; # We only want one of these
2144 my $library = Koha::Libraries->find( $letter_params->{branchcode} );
2145 my $from_email_address = $library->from_email_address;
2147 my @message_transports;
2149 $letter_code = $letter_params->{letter_code};
2150 if( $params->{message_name} ){
2151 my $messaging_prefs = C4::Members::Messaging::GetMessagingPreferences( {
2152 borrowernumber => $letter_params->{borrowernumber},
2153 message_name => $params->{message_name}
2155 @message_transports = ( keys %{ $messaging_prefs->{transports} } );
2156 $letter_code = $messaging_prefs->{transports}->{$message_transports[0]} unless $letter_code;
2158 @message_transports = @{$params->{message_transports}};
2160 return unless defined $letter_code;
2161 $letter_params->{letter_code} = $letter_code;
2164 foreach my $mtt (@message_transports){
2165 next if ($mtt eq 'itiva' and C4::Context->preference('TalkingTechItivaPhoneNotification') );
2166 # Notice is handled by TalkingTech_itiva_outbound.pl
2167 if ( ( $mtt eq 'email' and not $self->notice_email_address )
2168 or ( $mtt eq 'sms' and not $self->smsalertnumber )
2169 or ( $mtt eq 'phone' and not $self->phone ) )
2171 push @{ $return{fallback} }, $mtt;
2174 next if $mtt eq 'print' && $print_sent;
2175 $letter_params->{message_transport_type} = $mtt;
2176 my $letter = C4::Letters::GetPreparedLetter( %$letter_params );
2177 C4::Letters::EnqueueLetter({
2179 borrowernumber => $self->borrowernumber,
2180 from_address => $from_email_address,
2181 message_transport_type => $mtt
2182 }) unless $test_mode;
2183 push @{$return{sent}}, $mtt;
2184 $print_sent = 1 if $mtt eq 'print';
2189 =head3 safe_to_delete
2191 my $result = $patron->safe_to_delete;
2192 if ( $result eq 'has_guarantees' ) { ... }
2193 elsif ( $result ) { ... }
2194 else { # cannot delete }
2196 This method tells if the Koha:Patron object can be deleted. Possible return values
2202 =item 'has_checkouts'
2206 =item 'has_guarantees'
2208 =item 'is_anonymous_patron'
2214 sub safe_to_delete {
2217 my $anonymous_patron = C4::Context->preference('AnonymousPatron');
2221 if ( $anonymous_patron && $self->id eq $anonymous_patron ) {
2222 $error = 'is_anonymous_patron';
2224 elsif ( $self->checkouts->count ) {
2225 $error = 'has_checkouts';
2227 elsif ( $self->account->outstanding_debits->total_outstanding > 0 ) {
2228 $error = 'has_debt';
2230 elsif ( $self->guarantee_relationships->count ) {
2231 $error = 'has_guarantees';
2235 return Koha::Result::Boolean->new(0)->add_message({ message => $error });
2238 return Koha::Result::Boolean->new(1);
2243 my $recalls = $patron->recalls;
2245 Return the patron's recalls.
2252 return Koha::Recalls->search({ patron_id => $self->borrowernumber });
2255 =head3 account_balance
2257 my $balance = $patron->account_balance
2259 Return the patron's account balance
2263 sub account_balance {
2265 return $self->account->balance;
2268 =head3 notify_library_of_registration
2270 $patron->notify_library_of_registration( $email_patron_registrations );
2272 Send patron registration email to library if EmailPatronRegistrations system preference is enabled.
2276 sub notify_library_of_registration {
2277 my ( $self, $email_patron_registrations ) = @_;
2280 my $letter = C4::Letters::GetPreparedLetter(
2281 module => 'members',
2282 letter_code => 'OPAC_REG',
2283 branchcode => $self->branchcode,
2284 lang => $self->lang || 'default',
2286 'borrowers' => $self->borrowernumber
2291 if ( $email_patron_registrations eq "BranchEmailAddress" ) {
2292 my $library = Koha::Libraries->find( $self->branchcode );
2293 $to_address = $library->inbound_email_address;
2295 elsif ( $email_patron_registrations eq "KohaAdminEmailAddress" ) {
2296 $to_address = C4::Context->preference('ReplytoDefault')
2297 || C4::Context->preference('KohaAdminEmailAddress');
2301 C4::Context->preference('EmailAddressForPatronRegistrations')
2302 || C4::Context->preference('ReplytoDefault')
2303 || C4::Context->preference('KohaAdminEmailAddress');
2306 my $message_id = C4::Letters::EnqueueLetter(
2309 borrowernumber => $self->borrowernumber,
2310 to_address => $to_address,
2311 message_transport_type => 'email'
2313 ) or warn "can't enqueue letter $letter";
2314 if ( $message_id ) {
2320 =head3 has_messaging_preference
2322 my $bool = $patron->has_messaging_preference({
2323 message_name => $message_name, # A value from message_attributes.message_name
2324 message_transport_type => $message_transport_type, # email, sms, phone, itiva, etc...
2325 wants_digest => $wants_digest, # 1 if you are looking for the digest version, don't pass if you just want either
2330 sub has_messaging_preference {
2331 my ( $self, $params ) = @_;
2333 my $message_name = $params->{message_name};
2334 my $message_transport_type = $params->{message_transport_type};
2335 my $wants_digest = $params->{wants_digest};
2337 return $self->_result->search_related_rs(
2338 'borrower_message_preferences',
2342 [ 'borrower_message_transport_preferences', 'message_attribute' ]
2347 =head3 can_patron_change_staff_only_lists
2349 $patron->can_patron_change_staff_only_lists;
2351 Return 1 if a patron has 'Superlibrarian' or 'Catalogue' permission.
2352 Otherwise, return 0.
2356 sub can_patron_change_staff_only_lists {
2357 my ( $self, $params ) = @_;
2358 return 1 if C4::Auth::haspermission( $self->userid, { 'catalogue' => 1 });
2362 =head3 encode_secret
2364 $patron->encode_secret($secret32);
2366 Secret (TwoFactorAuth expects it in base32 format) is encrypted.
2367 You still need to call ->store.
2372 my ( $self, $secret ) = @_;
2374 return $self->secret( Koha::Encryption->new->encrypt_hex($secret) );
2376 return $self->secret($secret);
2379 =head3 decoded_secret
2381 my $secret32 = $patron->decoded_secret;
2383 Decode the patron secret. We expect to get back a base32 string, but this
2384 is not checked here. Caller of encode_secret is responsible for that.
2388 sub decoded_secret {
2390 if( $self->secret ) {
2391 return Koha::Encryption->new->decrypt_hex( $self->secret );
2393 return $self->secret;
2396 =head3 virtualshelves
2398 my $shelves = $patron->virtualshelves;
2402 sub virtualshelves {
2404 return Koha::Virtualshelves->_new_from_dbic( scalar $self->_result->virtualshelves );
2409 my $savings = $patron->get_savings;
2411 Use the replacement price of patron's old and current issues to calculate how much they have 'saved' by using the library.
2418 my @itemnumbers = grep { defined $_ } ( $self->old_checkouts->get_column('itemnumber'), $self->checkouts->get_column('itemnumber') );
2420 return Koha::Items->search(
2421 { itemnumber => { -in => \@itemnumbers } },
2422 { select => [ { sum => 'me.replacementprice' } ],
2423 as => ['total_savings']
2425 )->next->get_column('total_savings') // 0;
2428 =head2 Internal methods
2440 Kyle M Hall <kyle@bywatersolutions.com>
2441 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>
2442 Martin Renvoize <martin.renvoize@ptfs-europe.com>