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::Log qw( logaction );
31 use Koha::ArticleRequests;
35 use Koha::CirculationRules;
36 use Koha::Club::Enrollments;
38 use Koha::DateUtils qw( dt_from_string );
40 use Koha::Exceptions::Password;
42 use Koha::Old::Checkouts;
43 use Koha::Patron::Attributes;
44 use Koha::Patron::Categories;
45 use Koha::Patron::Debarments;
46 use Koha::Patron::HouseboundProfile;
47 use Koha::Patron::HouseboundRole;
48 use Koha::Patron::Images;
49 use Koha::Patron::Messages;
50 use Koha::Patron::Modifications;
51 use Koha::Patron::Relationships;
55 use Koha::Result::Boolean;
56 use Koha::Subscription::Routinglists;
58 use Koha::Virtualshelves;
60 use base qw(Koha::Object);
62 use constant ADMINISTRATIVE_LOCKOUT => -1;
64 our $RESULTSET_PATRON_ID_MAPPING = {
65 Accountline => 'borrowernumber',
66 Aqbasketuser => 'borrowernumber',
67 Aqbudget => 'budget_owner_id',
68 Aqbudgetborrower => 'borrowernumber',
69 ArticleRequest => 'borrowernumber',
70 BorrowerDebarment => 'borrowernumber',
71 BorrowerFile => 'borrowernumber',
72 BorrowerModification => 'borrowernumber',
73 ClubEnrollment => 'borrowernumber',
74 Issue => 'borrowernumber',
75 ItemsLastBorrower => 'borrowernumber',
76 Linktracker => 'borrowernumber',
77 Message => 'borrowernumber',
78 MessageQueue => 'borrowernumber',
79 OldIssue => 'borrowernumber',
80 OldReserve => 'borrowernumber',
81 Rating => 'borrowernumber',
82 Reserve => 'borrowernumber',
83 Review => 'borrowernumber',
84 SearchHistory => 'userid',
85 Statistic => 'borrowernumber',
86 Suggestion => 'suggestedby',
87 TagAll => 'borrowernumber',
88 Virtualshelfcontent => 'borrowernumber',
89 Virtualshelfshare => 'borrowernumber',
90 Virtualshelve => 'owner',
95 Koha::Patron - Koha Patron Object class
106 my ( $class, $params ) = @_;
108 return $class->SUPER::new($params);
111 =head3 fixup_cardnumber
113 Autogenerate next cardnumber from highest value found in database
117 sub fixup_cardnumber {
120 my $max = $self->cardnumber;
121 Koha::Plugins->call( 'patron_barcode_transform', \$max );
123 $max ||= Koha::Patrons->search({
124 cardnumber => {-regexp => '^-?[0-9]+$'}
126 select => \'CAST(cardnumber AS SIGNED)',
127 as => ['cast_cardnumber']
128 })->_resultset->get_column('cast_cardnumber')->max;
129 $self->cardnumber(($max || 0) +1);
132 =head3 trim_whitespace
134 trim whitespace from data which has some non-whitespace in it.
135 Could be moved to Koha::Object if need to be reused
139 sub trim_whitespaces {
142 my $schema = Koha::Database->new->schema;
143 my @columns = $schema->source($self->_type)->columns;
145 for my $column( @columns ) {
146 my $value = $self->$column;
147 if ( defined $value ) {
148 $value =~ s/^\s*|\s*$//g;
149 $self->$column($value);
155 =head3 plain_text_password
157 $patron->plain_text_password( $password );
159 stores a copy of the unencrypted password in the object
160 for use in code before encrypting for db
164 sub plain_text_password {
165 my ( $self, $password ) = @_;
167 $self->{_plain_text_password} = $password;
170 return $self->{_plain_text_password}
171 if $self->{_plain_text_password};
178 Patron specific store method to cleanup record
179 and do other necessary things before saving
187 $self->_result->result_source->schema->txn_do(
190 C4::Context->preference("autoMemberNum")
191 and ( not defined $self->cardnumber
192 or $self->cardnumber eq '' )
195 # Warning: The caller is responsible for locking the members table in write
196 # mode, to avoid database corruption.
197 # We are in a transaction but the table is not locked
198 $self->fixup_cardnumber;
201 unless( $self->category->in_storage ) {
202 Koha::Exceptions::Object::FKConstraint->throw(
203 broken_fk => 'categorycode',
204 value => $self->categorycode,
208 $self->trim_whitespaces;
210 my $new_cardnumber = $self->cardnumber;
211 Koha::Plugins->call( 'patron_barcode_transform', \$new_cardnumber );
212 $self->cardnumber( $new_cardnumber );
214 # Set surname to uppercase if uppercasesurname is true
215 $self->surname( uc($self->surname) )
216 if C4::Context->preference("uppercasesurnames");
218 $self->relationship(undef) # We do not want to store an empty string in this field
219 if defined $self->relationship
220 and $self->relationship eq "";
222 unless ( $self->in_storage ) { #AddMember
224 # Generate a valid userid/login if needed
225 $self->generate_userid
226 if not $self->userid or not $self->has_valid_userid;
228 # Add expiration date if it isn't already there
229 unless ( $self->dateexpiry ) {
230 $self->dateexpiry( $self->category->get_expiry_date );
233 # Add enrollment date if it isn't already there
234 unless ( $self->dateenrolled ) {
235 $self->dateenrolled(dt_from_string);
238 # Set the privacy depending on the patron's category
239 my $default_privacy = $self->category->default_privacy || q{};
241 $default_privacy eq 'default' ? 1
242 : $default_privacy eq 'never' ? 2
243 : $default_privacy eq 'forever' ? 0
245 $self->privacy($default_privacy);
247 # Call any check_password plugins if password is passed
248 if ( C4::Context->config("enable_plugins") && $self->password ) {
249 my @plugins = Koha::Plugins->new()->GetPlugins({
250 method => 'check_password',
252 foreach my $plugin ( @plugins ) {
253 # This plugin hook will also be used by a plugin for the Norwegian national
254 # patron database. This is why we need to pass both the password and the
255 # borrowernumber to the plugin.
256 my $ret = $plugin->check_password(
258 password => $self->password,
259 borrowernumber => $self->borrowernumber
262 if ( $ret->{'error'} == 1 ) {
263 Koha::Exceptions::Password::Plugin->throw();
268 # Make a copy of the plain text password for later use
269 $self->plain_text_password( $self->password );
271 $self->password_expiration_date( $self->password
272 ? $self->category->get_password_expiry_date || undef
274 # Create a disabled account if no password provided
275 $self->password( $self->password
276 ? Koha::AuthUtils::hash_password( $self->password )
279 $self->borrowernumber(undef);
281 $self = $self->SUPER::store;
283 $self->add_enrolment_fee_if_needed(0);
285 logaction( "MEMBERS", "CREATE", $self->borrowernumber, "" )
286 if C4::Context->preference("BorrowersLog");
290 my $self_from_storage = $self->get_from_storage;
291 # FIXME We should not deal with that here, callers have to do this job
292 # Moved from ModMember to prevent regressions
293 unless ( $self->userid ) {
294 my $stored_userid = $self_from_storage->userid;
295 $self->userid($stored_userid);
298 # Password must be updated using $self->set_password
299 $self->password($self_from_storage->password);
301 if ( $self->category->categorycode ne
302 $self_from_storage->category->categorycode )
304 # Add enrolement fee on category change if required
305 $self->add_enrolment_fee_if_needed(1)
306 if C4::Context->preference('FeeOnChangePatronCategory');
308 # Clean up guarantors on category change if required
309 $self->guarantor_relationships->delete
310 if ( $self->category->category_type ne 'C'
311 && $self->category->category_type ne 'P' );
316 if ( C4::Context->preference("BorrowersLog") ) {
318 my $from_storage = $self_from_storage->unblessed;
319 my $from_object = $self->unblessed;
320 my @skip_fields = (qw/lastseen updated_on/);
321 for my $key ( keys %{$from_storage} ) {
322 next if any { /$key/ } @skip_fields;
325 !defined( $from_storage->{$key} )
326 && defined( $from_object->{$key} )
328 || ( defined( $from_storage->{$key} )
329 && !defined( $from_object->{$key} ) )
331 defined( $from_storage->{$key} )
332 && defined( $from_object->{$key} )
333 && ( $from_storage->{$key} ne
334 $from_object->{$key} )
339 before => $from_storage->{$key},
340 after => $from_object->{$key}
345 if ( defined($info) ) {
349 $self->borrowernumber,
352 { utf8 => 1, pretty => 1, canonical => 1 }
359 $self = $self->SUPER::store;
370 Delete patron's holds, lists and finally the patron.
372 Lists owned by the borrower are deleted, but entries from the borrower to
373 other lists are kept.
380 my $anonymous_patron = C4::Context->preference("AnonymousPatron");
381 Koha::Exceptions::Patron::FailedDeleteAnonymousPatron->throw() if $anonymous_patron && $self->id eq $anonymous_patron;
383 $self->_result->result_source->schema->txn_do(
385 # Cancel Patron's holds
386 my $holds = $self->holds;
387 while( my $hold = $holds->next ){
391 # Delete all lists and all shares of this borrower
392 # Consistent with the approach Koha uses on deleting individual lists
393 # Note that entries in virtualshelfcontents added by this borrower to
394 # lists of others will be handled by a table constraint: the borrower
395 # is set to NULL in those entries.
397 # We could handle the above deletes via a constraint too.
398 # But a new BZ report 11889 has been opened to discuss another approach.
399 # Instead of deleting we could also disown lists (based on a pref).
400 # In that way we could save shared and public lists.
401 # The current table constraints support that idea now.
402 # This pref should then govern the results of other routines/methods such as
403 # Koha::Virtualshelf->new->delete too.
404 # FIXME Could be $patron->get_lists
405 $_->delete for Koha::Virtualshelves->search( { owner => $self->borrowernumber } )->as_list;
407 # We cannot have a FK on borrower_modifications.borrowernumber, the table is also used
409 $_->delete for Koha::Patron::Modifications->search( { borrowernumber => $self->borrowernumber } )->as_list;
411 $self->SUPER::delete;
413 logaction( "MEMBERS", "DELETE", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
422 my $patron_category = $patron->category
424 Return the patron category for this patron
430 return Koha::Patron::Category->_new_from_dbic( $self->_result->categorycode );
440 return Koha::Patron::Images->find( $self->borrowernumber );
445 Returns a Koha::Library object representing the patron's home library.
451 return Koha::Library->_new_from_dbic($self->_result->branchcode);
456 Returns a Koha::SMS::Provider object representing the patron's SMS provider.
462 my $sms_provider_rs = $self->_result->sms_provider;
463 return unless $sms_provider_rs;
464 return Koha::SMS::Provider->_new_from_dbic($sms_provider_rs);
467 =head3 guarantor_relationships
469 Returns Koha::Patron::Relationships object for this patron's guarantors
471 Returns the set of relationships for the patrons that are guarantors for this patron.
473 This is returned instead of a Koha::Patron object because the guarantor
474 may not exist as a patron in Koha. If this is true, the guarantors name
475 exists in the Koha::Patron::Relationship object and will have no guarantor_id.
479 sub guarantor_relationships {
482 return Koha::Patron::Relationships->search( { guarantee_id => $self->id } );
485 =head3 guarantee_relationships
487 Returns Koha::Patron::Relationships object for this patron's guarantors
489 Returns the set of relationships for the patrons that are guarantees for this patron.
491 The method returns Koha::Patron::Relationship objects for the sake
492 of consistency with the guantors method.
493 A guarantee by definition must exist as a patron in Koha.
497 sub guarantee_relationships {
500 return Koha::Patron::Relationships->search(
501 { guarantor_id => $self->id },
503 prefetch => 'guarantee',
504 order_by => { -asc => [ 'guarantee.surname', 'guarantee.firstname' ] },
509 =head3 relationships_debt
511 Returns the amount owed by the patron's guarantors *and* the other guarantees of those guarantors
515 sub relationships_debt {
516 my ($self, $params) = @_;
518 my $include_guarantors = $params->{include_guarantors};
519 my $only_this_guarantor = $params->{only_this_guarantor};
520 my $include_this_patron = $params->{include_this_patron};
523 if ( $only_this_guarantor ) {
524 @guarantors = $self->guarantee_relationships->count ? ( $self ) : ();
525 Koha::Exceptions::BadParameter->throw( { parameter => 'only_this_guarantor' } ) unless @guarantors;
526 } elsif ( $self->guarantor_relationships->count ) {
527 # I am a guarantee, just get all my guarantors
528 @guarantors = $self->guarantor_relationships->guarantors->as_list;
530 # I am a guarantor, I need to get all the guarantors of all my guarantees
531 @guarantors = map { $_->guarantor_relationships->guarantors->as_list } $self->guarantee_relationships->guarantees->as_list;
534 my $non_issues_charges = 0;
535 my $seen = $include_this_patron ? {} : { $self->id => 1 }; # For tracking members already added to the total
536 foreach my $guarantor (@guarantors) {
537 $non_issues_charges += $guarantor->account->non_issues_charges if $include_guarantors && !$seen->{ $guarantor->id };
539 # We've added what the guarantor owes, not added in that guarantor's guarantees as well
540 my @guarantees = map { $_->guarantee } $guarantor->guarantee_relationships->as_list;
541 my $guarantees_non_issues_charges = 0;
542 foreach my $guarantee (@guarantees) {
543 next if $seen->{ $guarantee->id };
544 $guarantees_non_issues_charges += $guarantee->account->non_issues_charges;
545 # Mark this guarantee as seen so we don't double count a guarantee linked to multiple guarantors
546 $seen->{ $guarantee->id } = 1;
549 $non_issues_charges += $guarantees_non_issues_charges;
550 $seen->{ $guarantor->id } = 1;
553 return $non_issues_charges;
556 =head3 housebound_profile
558 Returns the HouseboundProfile associated with this patron.
562 sub housebound_profile {
564 my $profile = $self->_result->housebound_profile;
565 return Koha::Patron::HouseboundProfile->_new_from_dbic($profile)
570 =head3 housebound_role
572 Returns the HouseboundRole associated with this patron.
576 sub housebound_role {
579 my $role = $self->_result->housebound_role;
580 return Koha::Patron::HouseboundRole->_new_from_dbic($role) if ( $role );
586 Returns the siblings of this patron.
593 my @guarantors = $self->guarantor_relationships()->guarantors()->as_list;
595 return unless @guarantors;
598 map { $_->guarantee_relationships()->guarantees()->as_list } @guarantors;
600 return unless @siblings;
604 grep { !$seen{ $_->id }++ && ( $_->id != $self->id ) } @siblings;
606 return Koha::Patrons->search( { borrowernumber => { -in => [ map { $_->id } @siblings ] } } );
611 my $patron = Koha::Patrons->find($id);
612 $patron->merge_with( \@patron_ids );
614 This subroutine merges a list of patrons into the patron record. This is accomplished by finding
615 all related patron ids for the patrons to be merged in other tables and changing the ids to be that
616 of the keeper patron.
621 my ( $self, $patron_ids ) = @_;
623 my $anonymous_patron = C4::Context->preference("AnonymousPatron");
624 return if $anonymous_patron && $self->id eq $anonymous_patron;
626 my @patron_ids = @{ $patron_ids };
628 # Ensure the keeper isn't in the list of patrons to merge
629 @patron_ids = grep { $_ ne $self->id } @patron_ids;
631 my $schema = Koha::Database->new()->schema();
635 $self->_result->result_source->schema->txn_do( sub {
636 foreach my $patron_id (@patron_ids) {
638 next if $patron_id eq $anonymous_patron;
640 my $patron = Koha::Patrons->find( $patron_id );
644 # Unbless for safety, the patron will end up being deleted
645 $results->{merged}->{$patron_id}->{patron} = $patron->unblessed;
647 my $attributes = $patron->extended_attributes;
648 my $new_attributes = [
649 map { { code => $_->code, attribute => $_->attribute } }
652 $attributes->delete; # We need to delete before trying to merge them to prevent exception on unique and repeatable
653 for my $attribute ( @$new_attributes ) {
655 $self->add_extended_attribute($attribute);
657 # Don't block the merge if there is a non-repeatable attribute that cannot be added to the current patron.
658 unless ( $_->isa('Koha::Exceptions::Patron::Attribute::NonRepeatable') ) {
664 while (my ($r, $field) = each(%$RESULTSET_PATRON_ID_MAPPING)) {
665 my $rs = $schema->resultset($r)->search({ $field => $patron_id });
666 $results->{merged}->{ $patron_id }->{updated}->{$r} = $rs->count();
667 $rs->update({ $field => $self->id });
668 if ( $r eq 'BorrowerDebarment' ) {
669 Koha::Patron::Debarments::UpdateBorrowerDebarmentFlags($self->id);
673 $patron->move_to_deleted();
683 =head3 wants_check_for_previous_checkout
685 $wants_check = $patron->wants_check_for_previous_checkout;
687 Return 1 if Koha needs to perform PrevIssue checking, else 0.
691 sub wants_check_for_previous_checkout {
693 my $syspref = C4::Context->preference("checkPrevCheckout");
696 ## Hard syspref trumps all
697 return 1 if ($syspref eq 'hardyes');
698 return 0 if ($syspref eq 'hardno');
699 ## Now, patron pref trumps all
700 return 1 if ($self->checkprevcheckout eq 'yes');
701 return 0 if ($self->checkprevcheckout eq 'no');
703 # More complex: patron inherits -> determine category preference
704 my $checkPrevCheckoutByCat = $self->category->checkprevcheckout;
705 return 1 if ($checkPrevCheckoutByCat eq 'yes');
706 return 0 if ($checkPrevCheckoutByCat eq 'no');
708 # Finally: category preference is inherit, default to 0
709 if ($syspref eq 'softyes') {
716 =head3 do_check_for_previous_checkout
718 $do_check = $patron->do_check_for_previous_checkout($item);
720 Return 1 if the bib associated with $ITEM has previously been checked out to
721 $PATRON, 0 otherwise.
725 sub do_check_for_previous_checkout {
726 my ( $self, $item ) = @_;
729 my $biblio = Koha::Biblios->find( $item->{biblionumber} );
730 if ( $biblio->is_serial ) {
731 push @item_nos, $item->{itemnumber};
733 # Get all itemnumbers for given bibliographic record.
734 @item_nos = $biblio->items->get_column( 'itemnumber' );
737 # Create (old)issues search criteria
739 borrowernumber => $self->borrowernumber,
740 itemnumber => \@item_nos,
743 my $delay = C4::Context->preference('CheckPrevCheckoutDelay') || 0;
745 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
746 my $newer_than = dt_from_string()->subtract( days => $delay );
747 $criteria->{'returndate'} = { '>' => $dtf->format_datetime($newer_than), };
750 # Check current issues table
751 my $issues = Koha::Checkouts->search($criteria);
752 return 1 if $issues->count; # 0 || N
754 # Check old issues table
755 my $old_issues = Koha::Old::Checkouts->search($criteria);
756 return $old_issues->count; # 0 || N
761 my $debarment_expiration = $patron->is_debarred;
763 Returns the date a patron debarment will expire, or undef if the patron is not
771 return unless $self->debarred;
772 return $self->debarred
773 if $self->debarred =~ '^9999'
774 or dt_from_string( $self->debarred ) > dt_from_string;
780 my $is_expired = $patron->is_expired;
782 Returns 1 if the patron is expired or 0;
788 return 0 unless $self->dateexpiry;
789 return 0 if $self->dateexpiry =~ '^9999';
790 return 1 if dt_from_string( $self->dateexpiry ) < dt_from_string->truncate( to => 'day' );
794 =head3 password_expired
796 my $password_expired = $patron->password_expired;
798 Returns 1 if the patron's password is expired or 0;
802 sub password_expired {
804 return 0 unless $self->password_expiration_date;
805 return 1 if dt_from_string( $self->password_expiration_date ) <= dt_from_string->truncate( to => 'day' );
809 =head3 is_going_to_expire
811 my $is_going_to_expire = $patron->is_going_to_expire;
813 Returns 1 if the patron is going to expired, depending on the NotifyBorrowerDeparture pref or 0
817 sub is_going_to_expire {
820 my $delay = C4::Context->preference('NotifyBorrowerDeparture') || 0;
822 return 0 unless $delay;
823 return 0 unless $self->dateexpiry;
824 return 0 if $self->dateexpiry =~ '^9999';
825 return 1 if dt_from_string( $self->dateexpiry, undef, 'floating' )->subtract( days => $delay ) < dt_from_string(undef, undef, 'floating')->truncate( to => 'day' );
831 $patron->set_password({ password => $plain_text_password [, skip_validation => 1 ] });
833 Set the patron's password.
837 The passed string is validated against the current password enforcement policy.
838 Validation can be skipped by passing the I<skip_validation> parameter.
840 Exceptions are thrown if the password is not good enough.
844 =item Koha::Exceptions::Password::TooShort
846 =item Koha::Exceptions::Password::WhitespaceCharacters
848 =item Koha::Exceptions::Password::TooWeak
850 =item Koha::Exceptions::Password::Plugin (if a "check password" plugin is enabled)
857 my ( $self, $args ) = @_;
859 my $password = $args->{password};
861 unless ( $args->{skip_validation} ) {
862 my ( $is_valid, $error ) = Koha::AuthUtils::is_password_valid( $password, $self->category );
865 if ( $error eq 'too_short' ) {
866 my $min_length = $self->category->effective_min_password_length;
867 $min_length = 3 if not $min_length or $min_length < 3;
869 my $password_length = length($password);
870 Koha::Exceptions::Password::TooShort->throw(
871 length => $password_length, min_length => $min_length );
873 elsif ( $error eq 'has_whitespaces' ) {
874 Koha::Exceptions::Password::WhitespaceCharacters->throw();
876 elsif ( $error eq 'too_weak' ) {
877 Koha::Exceptions::Password::TooWeak->throw();
882 if ( C4::Context->config("enable_plugins") ) {
883 # Call any check_password plugins
884 my @plugins = Koha::Plugins->new()->GetPlugins({
885 method => 'check_password',
887 foreach my $plugin ( @plugins ) {
888 # This plugin hook will also be used by a plugin for the Norwegian national
889 # patron database. This is why we need to pass both the password and the
890 # borrowernumber to the plugin.
891 my $ret = $plugin->check_password(
893 password => $password,
894 borrowernumber => $self->borrowernumber
897 # This plugin hook will also be used by a plugin for the Norwegian national
898 # patron database. This is why we need to call the actual plugins and then
899 # check skip_validation afterwards.
900 if ( $ret->{'error'} == 1 && !$args->{skip_validation} ) {
901 Koha::Exceptions::Password::Plugin->throw();
906 my $digest = Koha::AuthUtils::hash_password($password);
908 $self->password_expiration_date( $self->category->get_password_expiry_date || undef );
910 # We do not want to call $self->store and retrieve password from DB
911 $self->password($digest);
912 $self->login_attempts(0);
915 logaction( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" )
916 if C4::Context->preference("BorrowersLog");
924 my $new_expiry_date = $patron->renew_account
926 Extending the subscription to the expiry date.
933 if ( C4::Context->preference('BorrowerRenewalPeriodBase') eq 'combination' ) {
934 $date = ( dt_from_string gt dt_from_string( $self->dateexpiry ) ) ? dt_from_string : dt_from_string( $self->dateexpiry );
937 C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry'
938 ? dt_from_string( $self->dateexpiry )
941 my $expiry_date = $self->category->get_expiry_date($date);
943 $self->dateexpiry($expiry_date);
944 $self->date_renewed( dt_from_string() );
947 $self->add_enrolment_fee_if_needed(1);
949 logaction( "MEMBERS", "RENEW", $self->borrowernumber, "Membership renewed" ) if C4::Context->preference("BorrowersLog");
950 return dt_from_string( $expiry_date )->truncate( to => 'day' );
955 my $has_overdues = $patron->has_overdues;
957 Returns the number of patron's overdues
963 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
964 return $self->_result->issues->search({ date_due => { '<' => $dtf->format_datetime( dt_from_string() ) } })->count;
969 $patron->track_login;
970 $patron->track_login({ force => 1 });
972 Tracks a (successful) login attempt.
973 The preference TrackLastPatronActivity must be enabled. Or you
974 should pass the force parameter.
979 my ( $self, $params ) = @_;
982 !C4::Context->preference('TrackLastPatronActivity');
983 $self->lastseen( dt_from_string() )->store;
986 =head3 move_to_deleted
988 my $is_moved = $patron->move_to_deleted;
990 Move a patron to the deletedborrowers table.
991 This can be done before deleting a patron, to make sure the data are not completely deleted.
995 sub move_to_deleted {
997 my $patron_infos = $self->unblessed;
998 delete $patron_infos->{updated_on}; #This ensures the updated_on date in deletedborrowers will be set to the current timestamp
999 return Koha::Database->new->schema->resultset('Deletedborrower')->create($patron_infos);
1002 =head3 can_request_article
1004 if ( $patron->can_request_article( $library->id ) ) { ... }
1006 Returns true if the patron can request articles. As limits apply for the patron
1007 on the same day, those completed the same day are considered as current.
1009 A I<library_id> can be passed as parameter, falling back to userenv if absent.
1013 sub can_request_article {
1014 my ($self, $library_id) = @_;
1016 $library_id //= C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
1018 my $rule = Koha::CirculationRules->get_effective_rule(
1020 branchcode => $library_id,
1021 categorycode => $self->categorycode,
1022 rule_name => 'open_article_requests_limit'
1026 my $limit = ($rule) ? $rule->rule_value : undef;
1028 return 1 unless defined $limit;
1030 my $count = Koha::ArticleRequests->search(
1031 [ { borrowernumber => $self->borrowernumber, status => [ 'REQUESTED', 'PENDING', 'PROCESSING' ] },
1032 { borrowernumber => $self->borrowernumber, status => 'COMPLETED', updated_on => { '>=' => \'CAST(NOW() AS DATE)' } },
1035 return $count < $limit ? 1 : 0;
1038 =head3 article_request_fee
1040 my $fee = $patron->article_request_fee(
1042 [ library_id => $library->id, ]
1046 Returns the fee to be charged to the patron when it places an article request.
1048 A I<library_id> can be passed as parameter, falling back to userenv if absent.
1052 sub article_request_fee {
1053 my ($self, $params) = @_;
1055 my $library_id = $params->{library_id};
1057 $library_id //= C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
1059 my $rule = Koha::CirculationRules->get_effective_rule(
1061 branchcode => $library_id,
1062 categorycode => $self->categorycode,
1063 rule_name => 'article_request_fee'
1067 my $fee = ($rule) ? $rule->rule_value + 0 : 0;
1072 =head3 add_article_request_fee_if_needed
1074 my $fee = $patron->add_article_request_fee_if_needed(
1076 [ item_id => $item->id,
1077 library_id => $library->id, ]
1081 If an article request fee needs to be charged, it adds a debit to the patron's
1084 Returns the fee line.
1086 A I<library_id> can be passed as parameter, falling back to userenv if absent.
1090 sub add_article_request_fee_if_needed {
1091 my ($self, $params) = @_;
1093 my $library_id = $params->{library_id};
1094 my $item_id = $params->{item_id};
1096 $library_id //= C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
1098 my $amount = $self->article_request_fee(
1100 library_id => $library_id,
1106 if ( $amount > 0 ) {
1107 $debit_line = $self->account->add_debit(
1110 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
1111 interface => C4::Context->interface,
1112 library_id => $library_id,
1113 type => 'ARTICLE_REQUEST',
1114 item_id => $item_id,
1122 =head3 article_requests
1124 my $article_requests = $patron->article_requests;
1126 Returns the patron article requests.
1130 sub article_requests {
1133 return Koha::ArticleRequests->_new_from_dbic( scalar $self->_result->article_requests );
1136 =head3 add_enrolment_fee_if_needed
1138 my $enrolment_fee = $patron->add_enrolment_fee_if_needed($renewal);
1140 Add enrolment fee for a patron if needed.
1142 $renewal - boolean denoting whether this is an account renewal or not
1146 sub add_enrolment_fee_if_needed {
1147 my ($self, $renewal) = @_;
1148 my $enrolment_fee = $self->category->enrolmentfee;
1149 if ( $enrolment_fee && $enrolment_fee > 0 ) {
1150 my $type = $renewal ? 'ACCOUNT_RENEW' : 'ACCOUNT';
1151 $self->account->add_debit(
1153 amount => $enrolment_fee,
1154 user_id => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
1155 interface => C4::Context->interface,
1156 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
1161 return $enrolment_fee || 0;
1166 my $checkouts = $patron->checkouts
1172 my $checkouts = $self->_result->issues;
1173 return Koha::Checkouts->_new_from_dbic( $checkouts );
1176 =head3 pending_checkouts
1178 my $pending_checkouts = $patron->pending_checkouts
1180 This method will return the same as $self->checkouts, but with a prefetch on
1181 items, biblio and biblioitems.
1183 It has been introduced to replaced the C4::Members::GetPendingIssues subroutine
1185 It should not be used directly, prefer to access fields you need instead of
1186 retrieving all these fields in one go.
1190 sub pending_checkouts {
1192 my $checkouts = $self->_result->issues->search(
1196 { -desc => 'me.timestamp' },
1197 { -desc => 'issuedate' },
1198 { -desc => 'issue_id' }, # Sort by issue_id should be enough
1200 prefetch => { item => { biblio => 'biblioitems' } },
1203 return Koha::Checkouts->_new_from_dbic( $checkouts );
1206 =head3 old_checkouts
1208 my $old_checkouts = $patron->old_checkouts
1214 my $old_checkouts = $self->_result->old_issues;
1215 return Koha::Old::Checkouts->_new_from_dbic( $old_checkouts );
1220 my $overdue_items = $patron->overdues
1222 Return the overdue items
1228 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
1229 return $self->checkouts->search(
1231 'me.date_due' => { '<' => $dtf->format_datetime(dt_from_string) },
1234 prefetch => { item => { biblio => 'biblioitems' } },
1239 =head3 get_routing_lists
1241 my $routinglists = $patron->get_routing_lists
1243 Returns the routing lists a patron is subscribed to.
1247 sub get_routing_lists {
1249 my $routing_list_rs = $self->_result->subscriptionroutinglists;
1250 return Koha::Subscription::Routinglists->_new_from_dbic($routing_list_rs);
1255 my $age = $patron->get_age
1257 Return the age of the patron
1264 return unless $self->dateofbirth;
1266 my $date_of_birth = dt_from_string( $self->dateofbirth );
1267 my $today = dt_from_string->truncate( to => 'day' );
1269 return $today->subtract_datetime( $date_of_birth )->years;
1274 my $is_valid = $patron->is_valid_age
1276 Return 1 if patron's age is between allowed limits, returns 0 if it's not.
1282 my $age = $self->get_age;
1284 my $patroncategory = $self->category;
1285 my ($low,$high) = ($patroncategory->dateofbirthrequired, $patroncategory->upperagelimit);
1287 return (defined($age) && (($high && ($age > $high)) or ($low && ($age < $low)))) ? 0 : 1;
1292 my $account = $patron->account
1298 return Koha::Account->new( { patron_id => $self->borrowernumber } );
1303 my $holds = $patron->holds
1305 Return all the holds placed by this patron
1311 my $holds_rs = $self->_result->reserves->search( {}, { order_by => 'reservedate' } );
1312 return Koha::Holds->_new_from_dbic($holds_rs);
1317 my $old_holds = $patron->old_holds
1319 Return all the historical holds for this patron
1325 my $old_holds_rs = $self->_result->old_reserves->search( {}, { order_by => 'reservedate' } );
1326 return Koha::Old::Holds->_new_from_dbic($old_holds_rs);
1329 =head3 return_claims
1331 my $return_claims = $patron->return_claims
1337 my $return_claims = $self->_result->return_claims_borrowernumbers;
1338 return Koha::Checkouts::ReturnClaims->_new_from_dbic( $return_claims );
1341 =head3 notice_email_address
1343 my $email = $patron->notice_email_address;
1345 Return the email address of patron used for notices.
1346 Returns the empty string if no email address.
1350 sub notice_email_address{
1353 my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1354 # if syspref is set to 'first valid' (value == OFF), look up email address
1355 if ( $which_address eq 'OFF' ) {
1356 return $self->first_valid_email_address;
1359 return $self->$which_address || '';
1362 =head3 first_valid_email_address
1364 my $first_valid_email_address = $patron->first_valid_email_address
1366 Return the first valid email address for a patron.
1367 For now, the order is defined as email, emailpro, B_email.
1368 Returns the empty string if the borrower has no email addresses.
1372 sub first_valid_email_address {
1375 return $self->email() || $self->emailpro() || $self->B_email() || q{};
1378 =head3 get_club_enrollments
1382 sub get_club_enrollments {
1385 return Koha::Club::Enrollments->search( { borrowernumber => $self->borrowernumber(), date_canceled => undef } );
1388 =head3 get_enrollable_clubs
1392 sub get_enrollable_clubs {
1393 my ( $self, $is_enrollable_from_opac ) = @_;
1396 $params->{is_enrollable_from_opac} = $is_enrollable_from_opac
1397 if $is_enrollable_from_opac;
1398 $params->{is_email_required} = 0 unless $self->first_valid_email_address();
1400 $params->{borrower} = $self;
1402 return Koha::Clubs->get_enrollable($params);
1405 =head3 account_locked
1407 my $is_locked = $patron->account_locked
1409 Return true if the patron has reached the maximum number of login attempts
1410 (see pref FailedLoginAttempts). If login_attempts is < 0, this is interpreted
1411 as an administrative lockout (independent of FailedLoginAttempts; see also
1412 Koha::Patron->lock).
1413 Otherwise return false.
1414 If the pref is not set (empty string, null or 0), the feature is considered as
1419 sub account_locked {
1421 my $FailedLoginAttempts = C4::Context->preference('FailedLoginAttempts');
1422 return 1 if $FailedLoginAttempts
1423 and $self->login_attempts
1424 and $self->login_attempts >= $FailedLoginAttempts;
1425 return 1 if ($self->login_attempts || 0) < 0; # administrative lockout
1429 =head3 can_see_patron_infos
1431 my $can_see = $patron->can_see_patron_infos( $patron );
1433 Return true if the patron (usually the logged in user) can see the patron's infos for a given patron
1437 sub can_see_patron_infos {
1438 my ( $self, $patron ) = @_;
1439 return unless $patron;
1440 return $self->can_see_patrons_from( $patron->branchcode );
1443 =head3 can_see_patrons_from
1445 my $can_see = $patron->can_see_patrons_from( $branchcode );
1447 Return true if the patron (usually the logged in user) can see the patron's infos from a given library
1451 sub can_see_patrons_from {
1452 my ( $self, $branchcode ) = @_;
1454 if ( $self->branchcode eq $branchcode ) {
1456 } elsif ( $self->has_permission( { borrowers => 'view_borrower_infos_from_any_libraries' } ) ) {
1458 } elsif ( my $library_groups = $self->library->library_groups ) {
1459 while ( my $library_group = $library_groups->next ) {
1460 if ( $library_group->parent->has_child( $branchcode ) ) {
1471 my $can_log_into = $patron->can_log_into( $library );
1473 Given a I<Koha::Library> object, it returns a boolean representing
1474 the fact the patron can log into a the library.
1479 my ( $self, $library ) = @_;
1483 if ( C4::Context->preference('IndependentBranches') ) {
1485 if $self->is_superlibrarian
1486 or $self->branchcode eq $library->id;
1496 =head3 libraries_where_can_see_patrons
1498 my $libraries = $patron-libraries_where_can_see_patrons;
1500 Return the list of branchcodes(!) of libraries the patron is allowed to see other patron's infos.
1501 The branchcodes are arbitrarily returned sorted.
1502 We are supposing here that the object is related to the logged in patron (use of C4::Context::only_my_library)
1504 An empty array means no restriction, the patron can see patron's infos from any libraries.
1508 sub libraries_where_can_see_patrons {
1510 my $userenv = C4::Context->userenv;
1512 return () unless $userenv; # For tests, but userenv should be defined in tests...
1514 my @restricted_branchcodes;
1515 if (C4::Context::only_my_library) {
1516 push @restricted_branchcodes, $self->branchcode;
1520 $self->has_permission(
1521 { borrowers => 'view_borrower_infos_from_any_libraries' }
1525 my $library_groups = $self->library->library_groups({ ft_hide_patron_info => 1 });
1526 if ( $library_groups->count )
1528 while ( my $library_group = $library_groups->next ) {
1529 my $parent = $library_group->parent;
1530 if ( $parent->has_child( $self->branchcode ) ) {
1531 push @restricted_branchcodes, $parent->children->get_column('branchcode');
1536 @restricted_branchcodes = ( $self->branchcode ) unless @restricted_branchcodes;
1540 @restricted_branchcodes = grep { defined $_ } @restricted_branchcodes;
1541 @restricted_branchcodes = uniq(@restricted_branchcodes);
1542 @restricted_branchcodes = sort(@restricted_branchcodes);
1543 return @restricted_branchcodes;
1546 =head3 has_permission
1548 my $permission = $patron->has_permission($required);
1550 See C4::Auth::haspermission for details of syntax for $required
1554 sub has_permission {
1555 my ( $self, $flagsrequired ) = @_;
1556 return unless $self->userid;
1557 # TODO code from haspermission needs to be moved here!
1558 return C4::Auth::haspermission( $self->userid, $flagsrequired );
1561 =head3 is_superlibrarian
1563 my $is_superlibrarian = $patron->is_superlibrarian;
1565 Return true if the patron is a superlibrarian.
1569 sub is_superlibrarian {
1571 return $self->has_permission( { superlibrarian => 1 } ) ? 1 : 0;
1576 my $is_adult = $patron->is_adult
1578 Return true if the patron has a category with a type Adult (A) or Organization (I)
1584 return $self->category->category_type =~ /^(A|I)$/ ? 1 : 0;
1589 my $is_child = $patron->is_child
1591 Return true if the patron has a category with a type Child (C)
1597 return $self->category->category_type eq 'C' ? 1 : 0;
1600 =head3 has_valid_userid
1602 my $patron = Koha::Patrons->find(42);
1603 $patron->userid( $new_userid );
1604 my $has_a_valid_userid = $patron->has_valid_userid
1606 my $patron = Koha::Patron->new( $params );
1607 my $has_a_valid_userid = $patron->has_valid_userid
1609 Return true if the current userid of this patron is valid/unique, otherwise false.
1611 Note that this should be done in $self->store instead and raise an exception if needed.
1615 sub has_valid_userid {
1618 return 0 unless $self->userid;
1620 return 0 if ( $self->userid eq C4::Context->config('user') ); # DB user
1622 my $already_exists = Koha::Patrons->search(
1624 userid => $self->userid,
1627 ? ( borrowernumber => { '!=' => $self->borrowernumber } )
1632 return $already_exists ? 0 : 1;
1635 =head3 generate_userid
1637 my $patron = Koha::Patron->new( $params );
1638 $patron->generate_userid
1640 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
1642 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).
1646 sub generate_userid {
1649 my $firstname = $self->firstname // q{};
1650 my $surname = $self->surname // q{};
1651 #The script will "do" the following code and increment the $offset until the generated userid is unique
1653 $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1654 $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1655 my $userid = lc(($firstname)? "$firstname.$surname" : $surname);
1656 $userid = NFKD( $userid );
1657 $userid =~ s/\p{NonspacingMark}//g;
1658 $userid .= $offset unless $offset == 0;
1659 $self->userid( $userid );
1661 } while (! $self->has_valid_userid );
1666 =head3 add_extended_attribute
1670 sub add_extended_attribute {
1671 my ($self, $attribute) = @_;
1673 return Koha::Patron::Attribute->new(
1676 ( borrowernumber => $self->borrowernumber ),
1682 =head3 extended_attributes
1684 Return object of Koha::Patron::Attributes type with all attributes set for this patron
1690 sub extended_attributes {
1691 my ( $self, $attributes ) = @_;
1692 if ($attributes) { # setter
1693 my $schema = $self->_result->result_source->schema;
1696 # Remove the existing one
1697 $self->extended_attributes->filter_by_branch_limitations->delete;
1699 # Insert the new ones
1701 for my $attribute (@$attributes) {
1702 $self->add_extended_attribute($attribute);
1703 $new_types->{$attribute->{code}} = 1;
1706 # Check globally mandatory types
1707 my @required_attribute_types =
1708 Koha::Patron::Attribute::Types->search(
1711 'borrower_attribute_types_branches.b_branchcode' =>
1714 { join => 'borrower_attribute_types_branches' }
1715 )->get_column('code');
1716 for my $type ( @required_attribute_types ) {
1717 Koha::Exceptions::Patron::MissingMandatoryExtendedAttribute->throw(
1719 ) if !$new_types->{$type};
1725 my $rs = $self->_result->borrower_attributes;
1726 # We call search to use the filters in Koha::Patron::Attributes->search
1727 return Koha::Patron::Attributes->_new_from_dbic($rs)->search;
1732 my $messages = $patron->messages;
1734 Return the message attached to the patron.
1740 my $messages_rs = $self->_result->messages_borrowernumbers->search;
1741 return Koha::Patron::Messages->_new_from_dbic($messages_rs);
1746 Koha::Patrons->find($id)->lock({ expire => 1, remove => 1 });
1748 Lock and optionally expire a patron account.
1749 Remove holds and article requests if remove flag set.
1750 In order to distinguish from locking by entering a wrong password, let's
1751 call this an administrative lockout.
1756 my ( $self, $params ) = @_;
1757 $self->login_attempts( ADMINISTRATIVE_LOCKOUT );
1758 if( $params->{expire} ) {
1759 $self->dateexpiry( dt_from_string->subtract(days => 1) );
1762 if( $params->{remove} ) {
1763 $self->holds->delete;
1764 $self->article_requests->delete;
1771 Koha::Patrons->find($id)->anonymize;
1773 Anonymize or clear borrower fields. Fields in BorrowerMandatoryField
1774 are randomized, other personal data is cleared too.
1775 Patrons with issues are skipped.
1781 if( $self->_result->issues->count ) {
1782 warn "Exiting anonymize: patron ".$self->borrowernumber." still has issues";
1785 # Mandatory fields come from the corresponding pref, but email fields
1786 # are removed since scrambled email addresses only generate errors
1787 my $mandatory = { map { (lc $_, 1); } grep { !/email/ }
1788 split /\s*\|\s*/, C4::Context->preference('BorrowerMandatoryField') };
1789 $mandatory->{userid} = 1; # needed since sub store does not clear field
1790 my @columns = $self->_result->result_source->columns;
1791 @columns = grep { !/borrowernumber|branchcode|categorycode|^date|password|flags|updated_on|lastseen|lang|login_attempts|anonymized|auth_method/ } @columns;
1792 push @columns, 'dateofbirth'; # add this date back in
1793 foreach my $col (@columns) {
1794 $self->_anonymize_column($col, $mandatory->{lc $col} );
1796 $self->anonymized(1)->store;
1799 sub _anonymize_column {
1800 my ( $self, $col, $mandatory ) = @_;
1801 my $col_info = $self->_result->result_source->column_info($col);
1802 my $type = $col_info->{data_type};
1803 my $nullable = $col_info->{is_nullable};
1805 if( $type =~ /char|text/ ) {
1807 ? Koha::Token->new->generate({ pattern => '\w{10}' })
1811 } elsif( $type =~ /integer|int$|float|dec|double/ ) {
1812 $val = $nullable ? undef : 0;
1813 } elsif( $type =~ /date|time/ ) {
1814 $val = $nullable ? undef : dt_from_string;
1819 =head3 add_guarantor
1821 my $relationship = $patron->add_guarantor(
1823 borrowernumber => $borrowernumber,
1824 relationships => $relationship,
1828 Adds a new guarantor to a patron.
1833 my ( $self, $params ) = @_;
1835 my $guarantor_id = $params->{guarantor_id};
1836 my $relationship = $params->{relationship};
1838 return Koha::Patron::Relationship->new(
1840 guarantee_id => $self->id,
1841 guarantor_id => $guarantor_id,
1842 relationship => $relationship
1847 =head3 get_extended_attribute
1849 my $attribute_value = $patron->get_extended_attribute( $code );
1851 Return the attribute for the code passed in parameter.
1853 It not exist it returns undef
1855 Note that this will not work for repeatable attribute types.
1857 Maybe you certainly not want to use this method, it is actually only used for SHOW_BARCODE
1858 (which should be a real patron's attribute (not extended)
1862 sub get_extended_attribute {
1863 my ( $self, $code, $value ) = @_;
1864 my $rs = $self->_result->borrower_attributes;
1866 my $attribute = $rs->search({ code => $code, ( $value ? ( attribute => $value ) : () ) });
1867 return unless $attribute->count;
1868 return $attribute->next;
1873 my $json = $patron->to_api;
1875 Overloaded method that returns a JSON representation of the Koha::Patron object,
1876 suitable for API output.
1881 my ( $self, $params ) = @_;
1883 my $json_patron = $self->SUPER::to_api( $params );
1885 $json_patron->{restricted} = ( $self->is_debarred )
1887 : Mojo::JSON->false;
1889 return $json_patron;
1892 =head3 to_api_mapping
1894 This method returns the mapping for representing a Koha::Patron object
1899 sub to_api_mapping {
1901 borrowernotes => 'staff_notes',
1902 borrowernumber => 'patron_id',
1903 branchcode => 'library_id',
1904 categorycode => 'category_id',
1905 checkprevcheckout => 'check_previous_checkout',
1906 contactfirstname => undef, # Unused
1907 contactname => undef, # Unused
1908 contactnote => 'altaddress_notes',
1909 contacttitle => undef, # Unused
1910 dateenrolled => 'date_enrolled',
1911 dateexpiry => 'expiry_date',
1912 dateofbirth => 'date_of_birth',
1913 debarred => undef, # replaced by 'restricted'
1914 debarredcomment => undef, # calculated, API consumers will use /restrictions instead
1915 emailpro => 'secondary_email',
1916 flags => undef, # permissions manipulation handled in /permissions
1917 gonenoaddress => 'incorrect_address',
1918 lastseen => 'last_seen',
1919 lost => 'patron_card_lost',
1920 opacnote => 'opac_notes',
1921 othernames => 'other_name',
1922 password => undef, # password manipulation handled in /password
1923 phonepro => 'secondary_phone',
1924 relationship => 'relationship_type',
1926 smsalertnumber => 'sms_number',
1927 sort1 => 'statistics_1',
1928 sort2 => 'statistics_2',
1929 autorenew_checkouts => 'autorenew_checkouts',
1930 streetnumber => 'street_number',
1931 streettype => 'street_type',
1932 zipcode => 'postal_code',
1933 B_address => 'altaddress_address',
1934 B_address2 => 'altaddress_address2',
1935 B_city => 'altaddress_city',
1936 B_country => 'altaddress_country',
1937 B_email => 'altaddress_email',
1938 B_phone => 'altaddress_phone',
1939 B_state => 'altaddress_state',
1940 B_streetnumber => 'altaddress_street_number',
1941 B_streettype => 'altaddress_street_type',
1942 B_zipcode => 'altaddress_postal_code',
1943 altcontactaddress1 => 'altcontact_address',
1944 altcontactaddress2 => 'altcontact_address2',
1945 altcontactaddress3 => 'altcontact_city',
1946 altcontactcountry => 'altcontact_country',
1947 altcontactfirstname => 'altcontact_firstname',
1948 altcontactphone => 'altcontact_phone',
1949 altcontactsurname => 'altcontact_surname',
1950 altcontactstate => 'altcontact_state',
1951 altcontactzipcode => 'altcontact_postal_code',
1952 password_expiration_date => undef,
1953 primary_contact_method => undef,
1955 auth_method => undef,
1961 Koha::Patrons->queue_notice({ letter_params => $letter_params, message_name => 'DUE'});
1962 Koha::Patrons->queue_notice({ letter_params => $letter_params, message_transports => \@message_transports });
1963 Koha::Patrons->queue_notice({ letter_params => $letter_params, message_transports => \@message_transports, test_mode => 1 });
1965 Queue messages to a patron. Can pass a message that is part of the message_attributes
1966 table or supply the transport to use.
1968 If passed a message name we retrieve the patrons preferences for transports
1969 Otherwise we use the supplied transport. In the case of email or sms we fall back to print if
1970 we have no address/number for sending
1972 $letter_params is a hashref of the values to be passed to GetPreparedLetter
1974 test_mode will only report which notices would be sent, but nothing will be queued
1979 my ( $self, $params ) = @_;
1980 my $letter_params = $params->{letter_params};
1981 my $test_mode = $params->{test_mode};
1983 return unless $letter_params;
1984 return unless exists $params->{message_name} xor $params->{message_transports}; # We only want one of these
1986 my $library = Koha::Libraries->find( $letter_params->{branchcode} );
1987 my $from_email_address = $library->from_email_address;
1989 my @message_transports;
1991 $letter_code = $letter_params->{letter_code};
1992 if( $params->{message_name} ){
1993 my $messaging_prefs = C4::Members::Messaging::GetMessagingPreferences( {
1994 borrowernumber => $letter_params->{borrowernumber},
1995 message_name => $params->{message_name}
1997 @message_transports = ( keys %{ $messaging_prefs->{transports} } );
1998 $letter_code = $messaging_prefs->{transports}->{$message_transports[0]} unless $letter_code;
2000 @message_transports = @{$params->{message_transports}};
2002 return unless defined $letter_code;
2003 $letter_params->{letter_code} = $letter_code;
2006 foreach my $mtt (@message_transports){
2007 next if ($mtt eq 'itiva' and C4::Context->preference('TalkingTechItivaPhoneNotification') );
2008 # Notice is handled by TalkingTech_itiva_outbound.pl
2009 if ( ( $mtt eq 'email' and not $self->notice_email_address )
2010 or ( $mtt eq 'sms' and not $self->smsalertnumber )
2011 or ( $mtt eq 'phone' and not $self->phone ) )
2013 push @{ $return{fallback} }, $mtt;
2016 next if $mtt eq 'print' && $print_sent;
2017 $letter_params->{message_transport_type} = $mtt;
2018 my $letter = C4::Letters::GetPreparedLetter( %$letter_params );
2019 C4::Letters::EnqueueLetter({
2021 borrowernumber => $self->borrowernumber,
2022 from_address => $from_email_address,
2023 message_transport_type => $mtt
2024 }) unless $test_mode;
2025 push @{$return{sent}}, $mtt;
2026 $print_sent = 1 if $mtt eq 'print';
2031 =head3 safe_to_delete
2033 my $result = $patron->safe_to_delete;
2034 if ( $result eq 'has_guarantees' ) { ... }
2035 elsif ( $result ) { ... }
2036 else { # cannot delete }
2038 This method tells if the Koha:Patron object can be deleted. Possible return values
2044 =item 'has_checkouts'
2048 =item 'has_guarantees'
2050 =item 'is_anonymous_patron'
2056 sub safe_to_delete {
2059 my $anonymous_patron = C4::Context->preference('AnonymousPatron');
2063 if ( $anonymous_patron && $self->id eq $anonymous_patron ) {
2064 $error = 'is_anonymous_patron';
2066 elsif ( $self->checkouts->count ) {
2067 $error = 'has_checkouts';
2069 elsif ( $self->account->outstanding_debits->total_outstanding > 0 ) {
2070 $error = 'has_debt';
2072 elsif ( $self->guarantee_relationships->count ) {
2073 $error = 'has_guarantees';
2077 return Koha::Result::Boolean->new(0)->add_message({ message => $error });
2080 return Koha::Result::Boolean->new(1);
2085 my $recalls = $patron->recalls;
2087 Return the patron's recalls.
2094 return Koha::Recalls->search({ patron_id => $self->borrowernumber });
2097 =head3 account_balance
2099 my $balance = $patron->account_balance
2101 Return the patron's account balance
2105 sub account_balance {
2107 return $self->account->balance;
2111 =head3 has_messaging_preference
2113 my $bool = $patron->has_messaging_preference({
2114 message_name => $message_name, # A value from message_attributes.message_name
2115 message_transport_type => $message_transport_type, # email, sms, phone, itiva, etc...
2116 wants_digest => $wants_digest, # 1 if you are looking for the digest version, don't pass if you just want either
2121 sub has_messaging_preference {
2122 my ( $self, $params ) = @_;
2124 my $message_name = $params->{message_name};
2125 my $message_transport_type = $params->{message_transport_type};
2126 my $wants_digest = $params->{wants_digest};
2128 return $self->_result->search_related_rs(
2129 'borrower_message_preferences',
2133 [ 'borrower_message_transport_preferences', 'message_attribute' ]
2138 =head3 can_patron_change_staff_only_lists
2140 $patron->can_patron_change_staff_only_lists;
2142 Return 1 if a patron has 'Superlibrarian' or 'Catalogue' permission.
2143 Otherwise, return 0.
2147 sub can_patron_change_staff_only_lists {
2148 my ( $self, $params ) = @_;
2149 return 1 if C4::Auth::haspermission( $self->userid, { 'catalogue' => 1 });
2153 =head3 encode_secret
2155 $patron->encode_secret($secret32);
2157 Secret (TwoFactorAuth expects it in base32 format) is encrypted.
2158 You still need to call ->store.
2163 my ( $self, $secret ) = @_;
2165 return $self->secret( Koha::Encryption->new->encrypt_hex($secret) );
2167 return $self->secret($secret);
2170 =head3 decoded_secret
2172 my $secret32 = $patron->decoded_secret;
2174 Decode the patron secret. We expect to get back a base32 string, but this
2175 is not checked here. Caller of encode_secret is responsible for that.
2179 sub decoded_secret {
2181 if( $self->secret ) {
2182 return Koha::Encryption->new->decrypt_hex( $self->secret );
2184 return $self->secret;
2187 =head2 Internal methods
2199 Kyle M Hall <kyle@bywatersolutions.com>
2200 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>
2201 Martin Renvoize <martin.renvoize@ptfs-europe.com>