Koha/Patron.pm

   1 package Koha::Patron;
   2
   3 # Copyright ByWater Solutions 2014
   4 # Copyright PTFS Europe 2016
   5 #
   6 # This file is part of Koha.
   7 #
   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.
  12 #
  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.
  17 #
  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>.
  20
  21 use Modern::Perl;
  22
  23 use Carp;
  24 use List::MoreUtils qw( any uniq );
  25 use JSON qw( to_json );
  26 use Unicode::Normalize;
  27
  28 use C4::Context;
  29 use C4::Log;
  30 use Koha::Account;
  31 use Koha::ArticleRequests;
  32 use Koha::AuthUtils;
  33 use Koha::Checkouts;
  34 use Koha::Club::Enrollments;
  35 use Koha::Database;
  36 use Koha::DateUtils;
  37 use Koha::Exceptions::Password;
  38 use Koha::Holds;
  39 use Koha::Old::Checkouts;
  40 use Koha::Patron::Attributes;
  41 use Koha::Patron::Categories;
  42 use Koha::Patron::HouseboundProfile;
  43 use Koha::Patron::HouseboundRole;
  44 use Koha::Patron::Images;
  45 use Koha::Patron::Modifications;
  46 use Koha::Patron::Relationships;
  47 use Koha::Patrons;
  48 use Koha::Plugins;
  49 use Koha::Subscription::Routinglists;
  50 use Koha::Token;
  51 use Koha::Virtualshelves;
  52
  53 use base qw(Koha::Object);
  54
  55 use constant ADMINISTRATIVE_LOCKOUT => -1;
  56
  57 our $RESULTSET_PATRON_ID_MAPPING = {
  58     Accountline          => 'borrowernumber',
  59     Aqbasketuser         => 'borrowernumber',
  60     Aqbudget             => 'budget_owner_id',
  61     Aqbudgetborrower     => 'borrowernumber',
  62     ArticleRequest       => 'borrowernumber',
  63     BorrowerAttribute    => 'borrowernumber',
  64     BorrowerDebarment    => 'borrowernumber',
  65     BorrowerFile         => 'borrowernumber',
  66     BorrowerModification => 'borrowernumber',
  67     ClubEnrollment       => 'borrowernumber',
  68     Issue                => 'borrowernumber',
  69     ItemsLastBorrower    => 'borrowernumber',
  70     Linktracker          => 'borrowernumber',
  71     Message              => 'borrowernumber',
  72     MessageQueue         => 'borrowernumber',
  73     OldIssue             => 'borrowernumber',
  74     OldReserve           => 'borrowernumber',
  75     Rating               => 'borrowernumber',
  76     Reserve              => 'borrowernumber',
  77     Review               => 'borrowernumber',
  78     SearchHistory        => 'userid',
  79     Statistic            => 'borrowernumber',
  80     Suggestion           => 'suggestedby',
  81     TagAll               => 'borrowernumber',
  82     Virtualshelfcontent  => 'borrowernumber',
  83     Virtualshelfshare    => 'borrowernumber',
  84     Virtualshelve        => 'owner',
  85 };
  86
  87 =head1 NAME
  88
  89 Koha::Patron - Koha Patron Object class
  90
  91 =head1 API
  92
  93 =head2 Class Methods
  94
  95 =head3 new
  96
  97 =cut
  98
  99 sub new {
 100     my ( $class, $params ) = @_;
 101
 102     return $class->SUPER::new($params);
 103 }
 104
 105 =head3 fixup_cardnumber
 106
 107 Autogenerate next cardnumber from highest value found in database
 108
 109 =cut
 110
 111 sub fixup_cardnumber {
 112     my ( $self ) = @_;
 113     my $max = Koha::Patrons->search({
 114         cardnumber => {-regexp => '^-?[0-9]+$'}
 115     }, {
 116         select => \'CAST(cardnumber AS SIGNED)',
 117         as => ['cast_cardnumber']
 118     })->_resultset->get_column('cast_cardnumber')->max;
 119     $self->cardnumber(($max || 0) +1);
 120 }
 121
 122 =head3 trim_whitespace
 123
 124 trim whitespace from data which has some non-whitespace in it.
 125 Could be moved to Koha::Object if need to be reused
 126
 127 =cut
 128
 129 sub trim_whitespaces {
 130     my( $self ) = @_;
 131
 132     my $schema  = Koha::Database->new->schema;
 133     my @columns = $schema->source($self->_type)->columns;
 134
 135     for my $column( @columns ) {
 136         my $value = $self->$column;
 137         if ( defined $value ) {
 138             $value =~ s/^\s*|\s*$//g;
 139             $self->$column($value);
 140         }
 141     }
 142     return $self;
 143 }
 144
 145 =head3 plain_text_password
 146
 147 $patron->plain_text_password( $password );
 148
 149 stores a copy of the unencrypted password in the object
 150 for use in code before encrypting for db
 151
 152 =cut
 153
 154 sub plain_text_password {
 155     my ( $self, $password ) = @_;
 156     if ( $password ) {
 157         $self->{_plain_text_password} = $password;
 158         return $self;
 159     }
 160     return $self->{_plain_text_password}
 161         if $self->{_plain_text_password};
 162
 163     return;
 164 }
 165
 166 =head3 store
 167
 168 Patron specific store method to cleanup record
 169 and do other necessary things before saving
 170 to db
 171
 172 =cut
 173
 174 sub store {
 175     my ($self) = @_;
 176
 177     $self->_result->result_source->schema->txn_do(
 178         sub {
 179             if (
 180                 C4::Context->preference("autoMemberNum")
 181                 and ( not defined $self->cardnumber
 182                     or $self->cardnumber eq '' )
 183               )
 184             {
 185                 # Warning: The caller is responsible for locking the members table in write
 186                 # mode, to avoid database corruption.
 187                 # We are in a transaction but the table is not locked
 188                 $self->fixup_cardnumber;
 189             }
 190
 191             unless( $self->category->in_storage ) {
 192                 Koha::Exceptions::Object::FKConstraint->throw(
 193                     broken_fk => 'categorycode',
 194                     value     => $self->categorycode,
 195                 );
 196             }
 197
 198             $self->trim_whitespaces;
 199
 200             # Set surname to uppercase if uppercasesurname is true
 201             $self->surname( uc($self->surname) )
 202                 if C4::Context->preference("uppercasesurnames");
 203
 204             $self->relationship(undef) # We do not want to store an empty string in this field
 205               if defined $self->relationship
 206                      and $self->relationship eq "";
 207
 208             unless ( $self->in_storage ) {    #AddMember
 209
 210                 # Generate a valid userid/login if needed
 211                 $self->generate_userid
 212                   if not $self->userid or not $self->has_valid_userid;
 213
 214                 # Add expiration date if it isn't already there
 215                 unless ( $self->dateexpiry ) {
 216                     $self->dateexpiry( $self->category->get_expiry_date );
 217                 }
 218
 219                 # Add enrollment date if it isn't already there
 220                 unless ( $self->dateenrolled ) {
 221                     $self->dateenrolled(dt_from_string);
 222                 }
 223
 224                 # Set the privacy depending on the patron's category
 225                 my $default_privacy = $self->category->default_privacy || q{};
 226                 $default_privacy =
 227                     $default_privacy eq 'default' ? 1
 228                   : $default_privacy eq 'never'   ? 2
 229                   : $default_privacy eq 'forever' ? 0
 230                   :                                                   undef;
 231                 $self->privacy($default_privacy);
 232
 233                 # Call any check_password plugins if password is passed
 234                 if ( C4::Context->config("enable_plugins") && $self->password ) {
 235                     my @plugins = Koha::Plugins->new()->GetPlugins({
 236                         method => 'check_password',
 237                     });
 238                     foreach my $plugin ( @plugins ) {
 239                         # This plugin hook will also be used by a plugin for the Norwegian national
 240                         # patron database. This is why we need to pass both the password and the
 241                         # borrowernumber to the plugin.
 242                         my $ret = $plugin->check_password(
 243                             {
 244                                 password       => $self->password,
 245                                 borrowernumber => $self->borrowernumber
 246                             }
 247                         );
 248                         if ( $ret->{'error'} == 1 ) {
 249                             Koha::Exceptions::Password::Plugin->throw();
 250                         }
 251                     }
 252                 }
 253
 254                 # Make a copy of the plain text password for later use
 255                 $self->plain_text_password( $self->password );
 256
 257                 # Create a disabled account if no password provided
 258                 $self->password( $self->password
 259                     ? Koha::AuthUtils::hash_password( $self->password )
 260                     : '!' );
 261
 262                 $self->borrowernumber(undef);
 263
 264                 $self = $self->SUPER::store;
 265
 266                 $self->add_enrolment_fee_if_needed(0);
 267
 268                 logaction( "MEMBERS", "CREATE", $self->borrowernumber, "" )
 269                   if C4::Context->preference("BorrowersLog");
 270             }
 271             else {    #ModMember
 272
 273                 my $self_from_storage = $self->get_from_storage;
 274                 # FIXME We should not deal with that here, callers have to do this job
 275                 # Moved from ModMember to prevent regressions
 276                 unless ( $self->userid ) {
 277                     my $stored_userid = $self_from_storage->userid;
 278                     $self->userid($stored_userid);
 279                 }
 280
 281                 # Password must be updated using $self->set_password
 282                 $self->password($self_from_storage->password);
 283
 284                 if ( $self->category->categorycode ne
 285                     $self_from_storage->category->categorycode )
 286                 {
 287                     # Add enrolement fee on category change if required
 288                     $self->add_enrolment_fee_if_needed(1)
 289                       if C4::Context->preference('FeeOnChangePatronCategory');
 290
 291                     # Clean up guarantors on category change if required
 292                     $self->guarantor_relationships->delete
 293                       if ( $self->category->category_type ne 'C'
 294                         && $self->category->category_type ne 'P' );
 295
 296                 }
 297
 298                 # Actionlogs
 299                 if ( C4::Context->preference("BorrowersLog") ) {
 300                     my $info;
 301                     my $from_storage = $self_from_storage->unblessed;
 302                     my $from_object  = $self->unblessed;
 303                     my @skip_fields  = (qw/lastseen updated_on/);
 304                     for my $key ( keys %{$from_storage} ) {
 305                         next if any { /$key/ } @skip_fields;
 306                         if (
 307                             (
 308                                   !defined( $from_storage->{$key} )
 309                                 && defined( $from_object->{$key} )
 310                             )
 311                             || ( defined( $from_storage->{$key} )
 312                                 && !defined( $from_object->{$key} ) )
 313                             || (
 314                                    defined( $from_storage->{$key} )
 315                                 && defined( $from_object->{$key} )
 316                                 && ( $from_storage->{$key} ne
 317                                     $from_object->{$key} )
 318                             )
 319                           )
 320                         {
 321                             $info->{$key} = {
 322                                 before => $from_storage->{$key},
 323                                 after  => $from_object->{$key}
 324                             };
 325                         }
 326                     }
 327
 328                     if ( defined($info) ) {
 329                         logaction(
 330                             "MEMBERS",
 331                             "MODIFY",
 332                             $self->borrowernumber,
 333                             to_json(
 334                                 $info,
 335                                 { utf8 => 1, pretty => 1, canonical => 1 }
 336                             )
 337                         );
 338                     }
 339                 }
 340
 341                 # Final store
 342                 $self = $self->SUPER::store;
 343             }
 344         }
 345     );
 346     return $self;
 347 }
 348
 349 =head3 delete
 350
 351 $patron->delete
 352
 353 Delete patron's holds, lists and finally the patron.
 354
 355 Lists owned by the borrower are deleted, but entries from the borrower to
 356 other lists are kept.
 357
 358 =cut
 359
 360 sub delete {
 361     my ($self) = @_;
 362
 363     my $anonymous_patron = C4::Context->preference("AnonymousPatron");
 364     Koha::Exceptions::Patron::FailedDeleteAnonymousPatron->throw() if $anonymous_patron && $self->id eq $anonymous_patron;
 365
 366     $self->_result->result_source->schema->txn_do(
 367         sub {
 368             # Cancel Patron's holds
 369             my $holds = $self->holds;
 370             while( my $hold = $holds->next ){
 371                 $hold->cancel;
 372             }
 373
 374             # Delete all lists and all shares of this borrower
 375             # Consistent with the approach Koha uses on deleting individual lists
 376             # Note that entries in virtualshelfcontents added by this borrower to
 377             # lists of others will be handled by a table constraint: the borrower
 378             # is set to NULL in those entries.
 379             # NOTE:
 380             # We could handle the above deletes via a constraint too.
 381             # But a new BZ report 11889 has been opened to discuss another approach.
 382             # Instead of deleting we could also disown lists (based on a pref).
 383             # In that way we could save shared and public lists.
 384             # The current table constraints support that idea now.
 385             # This pref should then govern the results of other routines/methods such as
 386             # Koha::Virtualshelf->new->delete too.
 387             # FIXME Could be $patron->get_lists
 388             $_->delete for Koha::Virtualshelves->search( { owner => $self->borrowernumber } );
 389
 390             # We cannot have a FK on borrower_modifications.borrowernumber, the table is also used
 391             # for patron selfreg
 392             $_->delete for Koha::Patron::Modifications->search( { borrowernumber => $self->borrowernumber } );
 393
 394             $self->SUPER::delete;
 395
 396             logaction( "MEMBERS", "DELETE", $self->borrowernumber, "" ) if C4::Context->preference("BorrowersLog");
 397         }
 398     );
 399     return $self;
 400 }
 401
 402
 403 =head3 category
 404
 405 my $patron_category = $patron->category
 406
 407 Return the patron category for this patron
 408
 409 =cut
 410
 411 sub category {
 412     my ( $self ) = @_;
 413     return Koha::Patron::Category->_new_from_dbic( $self->_result->categorycode );
 414 }
 415
 416 =head3 image
 417
 418 =cut
 419
 420 sub image {
 421     my ( $self ) = @_;
 422
 423     return Koha::Patron::Images->find( $self->borrowernumber );
 424 }
 425
 426 =head3 library
 427
 428 Returns a Koha::Library object representing the patron's home library.
 429
 430 =cut
 431
 432 sub library {
 433     my ( $self ) = @_;
 434     return Koha::Library->_new_from_dbic($self->_result->branchcode);
 435 }
 436
 437 =head3 sms_provider
 438
 439 Returns a Koha::SMS::Provider object representing the patron's SMS provider.
 440
 441 =cut
 442
 443 sub sms_provider {
 444     my ( $self ) = @_;
 445     my $sms_provider_rs = $self->_result->sms_provider;
 446     return unless $sms_provider_rs;
 447     return Koha::SMS::Provider->_new_from_dbic($sms_provider_rs);
 448 }
 449
 450 =head3 guarantor_relationships
 451
 452 Returns Koha::Patron::Relationships object for this patron's guarantors
 453
 454 Returns the set of relationships for the patrons that are guarantors for this patron.
 455
 456 This is returned instead of a Koha::Patron object because the guarantor
 457 may not exist as a patron in Koha. If this is true, the guarantors name
 458 exists in the Koha::Patron::Relationship object and will have no guarantor_id.
 459
 460 =cut
 461
 462 sub guarantor_relationships {
 463     my ($self) = @_;
 464
 465     return Koha::Patron::Relationships->search( { guarantee_id => $self->id } );
 466 }
 467
 468 =head3 guarantee_relationships
 469
 470 Returns Koha::Patron::Relationships object for this patron's guarantors
 471
 472 Returns the set of relationships for the patrons that are guarantees for this patron.
 473
 474 The method returns Koha::Patron::Relationship objects for the sake
 475 of consistency with the guantors method.
 476 A guarantee by definition must exist as a patron in Koha.
 477
 478 =cut
 479
 480 sub guarantee_relationships {
 481     my ($self) = @_;
 482
 483     return Koha::Patron::Relationships->search(
 484         { guarantor_id => $self->id },
 485         {
 486             prefetch => 'guarantee',
 487             order_by => { -asc => [ 'guarantee.surname', 'guarantee.firstname' ] },
 488         }
 489     );
 490 }
 491
 492 =head3 relationships_debt
 493
 494 Returns the amount owed by the patron's guarantors *and* the other guarantees of those guarantors
 495
 496 =cut
 497
 498 sub relationships_debt {
 499     my ($self, $params) = @_;
 500
 501     my $include_guarantors  = $params->{include_guarantors};
 502     my $only_this_guarantor = $params->{only_this_guarantor};
 503     my $include_this_patron = $params->{include_this_patron};
 504
 505     my @guarantors;
 506     if ( $only_this_guarantor ) {
 507         @guarantors = $self->guarantee_relationships->count ? ( $self ) : ();
 508         Koha::Exceptions::BadParameter->throw( { parameter => 'only_this_guarantor' } ) unless @guarantors;
 509     } elsif ( $self->guarantor_relationships->count ) {
 510         # I am a guarantee, just get all my guarantors
 511         @guarantors = $self->guarantor_relationships->guarantors;
 512     } else {
 513         # I am a guarantor, I need to get all the guarantors of all my guarantees
 514         @guarantors = map { $_->guarantor_relationships->guarantors } $self->guarantee_relationships->guarantees;
 515     }
 516
 517     my $non_issues_charges = 0;
 518     my $seen = $include_this_patron ? {} : { $self->id => 1 }; # For tracking members already added to the total
 519     foreach my $guarantor (@guarantors) {
 520         $non_issues_charges += $guarantor->account->non_issues_charges if $include_guarantors && !$seen->{ $guarantor->id };
 521
 522         # We've added what the guarantor owes, not added in that guarantor's guarantees as well
 523         my @guarantees = map { $_->guarantee } $guarantor->guarantee_relationships();
 524         my $guarantees_non_issues_charges = 0;
 525         foreach my $guarantee (@guarantees) {
 526             next if $seen->{ $guarantee->id };
 527             $guarantees_non_issues_charges += $guarantee->account->non_issues_charges;
 528             # Mark this guarantee as seen so we don't double count a guarantee linked to multiple guarantors
 529             $seen->{ $guarantee->id } = 1;
 530         }
 531
 532         $non_issues_charges += $guarantees_non_issues_charges;
 533         $seen->{ $guarantor->id } = 1;
 534     }
 535
 536     return $non_issues_charges;
 537 }
 538
 539 =head3 housebound_profile
 540
 541 Returns the HouseboundProfile associated with this patron.
 542
 543 =cut
 544
 545 sub housebound_profile {
 546     my ( $self ) = @_;
 547     my $profile = $self->_result->housebound_profile;
 548     return Koha::Patron::HouseboundProfile->_new_from_dbic($profile)
 549         if ( $profile );
 550     return;
 551 }
 552
 553 =head3 housebound_role
 554
 555 Returns the HouseboundRole associated with this patron.
 556
 557 =cut
 558
 559 sub housebound_role {
 560     my ( $self ) = @_;
 561
 562     my $role = $self->_result->housebound_role;
 563     return Koha::Patron::HouseboundRole->_new_from_dbic($role) if ( $role );
 564     return;
 565 }
 566
 567 =head3 siblings
 568
 569 Returns the siblings of this patron.
 570
 571 =cut
 572
 573 sub siblings {
 574     my ($self) = @_;
 575
 576     my @guarantors = $self->guarantor_relationships()->guarantors();
 577
 578     return unless @guarantors;
 579
 580     my @siblings =
 581       map { $_->guarantee_relationships()->guarantees() } @guarantors;
 582
 583     return unless @siblings;
 584
 585     my %seen;
 586     @siblings =
 587       grep { !$seen{ $_->id }++ && ( $_->id != $self->id ) } @siblings;
 588
 589     return wantarray ? @siblings : Koha::Patrons->search( { borrowernumber => { -in => [ map { $_->id } @siblings ] } } );
 590 }
 591
 592 =head3 merge_with
 593
 594     my $patron = Koha::Patrons->find($id);
 595     $patron->merge_with( \@patron_ids );
 596
 597     This subroutine merges a list of patrons into the patron record. This is accomplished by finding
 598     all related patron ids for the patrons to be merged in other tables and changing the ids to be that
 599     of the keeper patron.
 600
 601 =cut
 602
 603 sub merge_with {
 604     my ( $self, $patron_ids ) = @_;
 605
 606     my $anonymous_patron = C4::Context->preference("AnonymousPatron");
 607     return if $anonymous_patron && $self->id eq $anonymous_patron;
 608
 609     my @patron_ids = @{ $patron_ids };
 610
 611     # Ensure the keeper isn't in the list of patrons to merge
 612     @patron_ids = grep { $_ ne $self->id } @patron_ids;
 613
 614     my $schema = Koha::Database->new()->schema();
 615
 616     my $results;
 617
 618     $self->_result->result_source->schema->txn_do( sub {
 619         foreach my $patron_id (@patron_ids) {
 620
 621             next if $patron_id eq $anonymous_patron;
 622
 623             my $patron = Koha::Patrons->find( $patron_id );
 624
 625             next unless $patron;
 626
 627             # Unbless for safety, the patron will end up being deleted
 628             $results->{merged}->{$patron_id}->{patron} = $patron->unblessed;
 629
 630             while (my ($r, $field) = each(%$RESULTSET_PATRON_ID_MAPPING)) {
 631                 my $rs = $schema->resultset($r)->search({ $field => $patron_id });
 632                 $results->{merged}->{ $patron_id }->{updated}->{$r} = $rs->count();
 633                 $rs->update({ $field => $self->id });
 634             }
 635
 636             $patron->move_to_deleted();
 637             $patron->delete();
 638         }
 639     });
 640
 641     return $results;
 642 }
 643
 644
 645
 646 =head3 wants_check_for_previous_checkout
 647
 648     $wants_check = $patron->wants_check_for_previous_checkout;
 649
 650 Return 1 if Koha needs to perform PrevIssue checking, else 0.
 651
 652 =cut
 653
 654 sub wants_check_for_previous_checkout {
 655     my ( $self ) = @_;
 656     my $syspref = C4::Context->preference("checkPrevCheckout");
 657
 658     # Simple cases
 659     ## Hard syspref trumps all
 660     return 1 if ($syspref eq 'hardyes');
 661     return 0 if ($syspref eq 'hardno');
 662     ## Now, patron pref trumps all
 663     return 1 if ($self->checkprevcheckout eq 'yes');
 664     return 0 if ($self->checkprevcheckout eq 'no');
 665
 666     # More complex: patron inherits -> determine category preference
 667     my $checkPrevCheckoutByCat = $self->category->checkprevcheckout;
 668     return 1 if ($checkPrevCheckoutByCat eq 'yes');
 669     return 0 if ($checkPrevCheckoutByCat eq 'no');
 670
 671     # Finally: category preference is inherit, default to 0
 672     if ($syspref eq 'softyes') {
 673         return 1;
 674     } else {
 675         return 0;
 676     }
 677 }
 678
 679 =head3 do_check_for_previous_checkout
 680
 681     $do_check = $patron->do_check_for_previous_checkout($item);
 682
 683 Return 1 if the bib associated with $ITEM has previously been checked out to
 684 $PATRON, 0 otherwise.
 685
 686 =cut
 687
 688 sub do_check_for_previous_checkout {
 689     my ( $self, $item ) = @_;
 690
 691     my @item_nos;
 692     my $biblio = Koha::Biblios->find( $item->{biblionumber} );
 693     if ( $biblio->is_serial ) {
 694         push @item_nos, $item->{itemnumber};
 695     } else {
 696         # Get all itemnumbers for given bibliographic record.
 697         @item_nos = $biblio->items->get_column( 'itemnumber' );
 698     }
 699
 700     # Create (old)issues search criteria
 701     my $criteria = {
 702         borrowernumber => $self->borrowernumber,
 703         itemnumber => \@item_nos,
 704     };
 705
 706     # Check current issues table
 707     my $issues = Koha::Checkouts->search($criteria);
 708     return 1 if $issues->count; # 0 || N
 709
 710     # Check old issues table
 711     my $old_issues = Koha::Old::Checkouts->search($criteria);
 712     return $old_issues->count;  # 0 || N
 713 }
 714
 715 =head3 is_debarred
 716
 717 my $debarment_expiration = $patron->is_debarred;
 718
 719 Returns the date a patron debarment will expire, or undef if the patron is not
 720 debarred
 721
 722 =cut
 723
 724 sub is_debarred {
 725     my ($self) = @_;
 726
 727     return unless $self->debarred;
 728     return $self->debarred
 729       if $self->debarred =~ '^9999'
 730       or dt_from_string( $self->debarred ) > dt_from_string;
 731     return;
 732 }
 733
 734 =head3 is_expired
 735
 736 my $is_expired = $patron->is_expired;
 737
 738 Returns 1 if the patron is expired or 0;
 739
 740 =cut
 741
 742 sub is_expired {
 743     my ($self) = @_;
 744     return 0 unless $self->dateexpiry;
 745     return 0 if $self->dateexpiry =~ '^9999';
 746     return 1 if dt_from_string( $self->dateexpiry ) < dt_from_string->truncate( to => 'day' );
 747     return 0;
 748 }
 749
 750 =head3 is_going_to_expire
 751
 752 my $is_going_to_expire = $patron->is_going_to_expire;
 753
 754 Returns 1 if the patron is going to expired, depending on the NotifyBorrowerDeparture pref or 0
 755
 756 =cut
 757
 758 sub is_going_to_expire {
 759     my ($self) = @_;
 760
 761     my $delay = C4::Context->preference('NotifyBorrowerDeparture') || 0;
 762
 763     return 0 unless $delay;
 764     return 0 unless $self->dateexpiry;
 765     return 0 if $self->dateexpiry =~ '^9999';
 766     return 1 if dt_from_string( $self->dateexpiry, undef, 'floating' )->subtract( days => $delay ) < dt_from_string(undef, undef, 'floating')->truncate( to => 'day' );
 767     return 0;
 768 }
 769
 770 =head3 set_password
 771
 772     $patron->set_password({ password => $plain_text_password [, skip_validation => 1 ] });
 773
 774 Set the patron's password.
 775
 776 =head4 Exceptions
 777
 778 The passed string is validated against the current password enforcement policy.
 779 Validation can be skipped by passing the I<skip_validation> parameter.
 780
 781 Exceptions are thrown if the password is not good enough.
 782
 783 =over 4
 784
 785 =item Koha::Exceptions::Password::TooShort
 786
 787 =item Koha::Exceptions::Password::WhitespaceCharacters
 788
 789 =item Koha::Exceptions::Password::TooWeak
 790
 791 =item Koha::Exceptions::Password::Plugin (if a "check password" plugin is enabled)
 792
 793 =back
 794
 795 =cut
 796
 797 sub set_password {
 798     my ( $self, $args ) = @_;
 799
 800     my $password = $args->{password};
 801
 802     unless ( $args->{skip_validation} ) {
 803         my ( $is_valid, $error ) = Koha::AuthUtils::is_password_valid( $password, $self->category );
 804
 805         if ( !$is_valid ) {
 806             if ( $error eq 'too_short' ) {
 807                 my $min_length = $self->category->effective_min_password_length;
 808                 $min_length = 3 if not $min_length or $min_length < 3;
 809
 810                 my $password_length = length($password);
 811                 Koha::Exceptions::Password::TooShort->throw(
 812                     length => $password_length, min_length => $min_length );
 813             }
 814             elsif ( $error eq 'has_whitespaces' ) {
 815                 Koha::Exceptions::Password::WhitespaceCharacters->throw();
 816             }
 817             elsif ( $error eq 'too_weak' ) {
 818                 Koha::Exceptions::Password::TooWeak->throw();
 819             }
 820         }
 821     }
 822
 823     if ( C4::Context->config("enable_plugins") ) {
 824         # Call any check_password plugins
 825         my @plugins = Koha::Plugins->new()->GetPlugins({
 826             method => 'check_password',
 827         });
 828         foreach my $plugin ( @plugins ) {
 829             # This plugin hook will also be used by a plugin for the Norwegian national
 830             # patron database. This is why we need to pass both the password and the
 831             # borrowernumber to the plugin.
 832             my $ret = $plugin->check_password(
 833                 {
 834                     password       => $password,
 835                     borrowernumber => $self->borrowernumber
 836                 }
 837             );
 838             # This plugin hook will also be used by a plugin for the Norwegian national
 839             # patron database. This is why we need to call the actual plugins and then
 840             # check skip_validation afterwards.
 841             if ( $ret->{'error'} == 1 && !$args->{skip_validation} ) {
 842                 Koha::Exceptions::Password::Plugin->throw();
 843             }
 844         }
 845     }
 846
 847     my $digest = Koha::AuthUtils::hash_password($password);
 848
 849     # We do not want to call $self->store and retrieve password from DB
 850     $self->password($digest);
 851     $self->login_attempts(0);
 852     $self->SUPER::store;
 853
 854     logaction( "MEMBERS", "CHANGE PASS", $self->borrowernumber, "" )
 855         if C4::Context->preference("BorrowersLog");
 856
 857     return $self;
 858 }
 859
 860
 861 =head3 renew_account
 862
 863 my $new_expiry_date = $patron->renew_account
 864
 865 Extending the subscription to the expiry date.
 866
 867 =cut
 868
 869 sub renew_account {
 870     my ($self) = @_;
 871     my $date;
 872     if ( C4::Context->preference('BorrowerRenewalPeriodBase') eq 'combination' ) {
 873         $date = ( dt_from_string gt dt_from_string( $self->dateexpiry ) ) ? dt_from_string : dt_from_string( $self->dateexpiry );
 874     } else {
 875         $date =
 876             C4::Context->preference('BorrowerRenewalPeriodBase') eq 'dateexpiry'
 877             ? dt_from_string( $self->dateexpiry )
 878             : dt_from_string;
 879     }
 880     my $expiry_date = $self->category->get_expiry_date($date);
 881
 882     $self->dateexpiry($expiry_date);
 883     $self->date_renewed( dt_from_string() );
 884     $self->store();
 885
 886     $self->add_enrolment_fee_if_needed(1);
 887
 888     logaction( "MEMBERS", "RENEW", $self->borrowernumber, "Membership renewed" ) if C4::Context->preference("BorrowersLog");
 889     return dt_from_string( $expiry_date )->truncate( to => 'day' );
 890 }
 891
 892 =head3 has_overdues
 893
 894 my $has_overdues = $patron->has_overdues;
 895
 896 Returns the number of patron's overdues
 897
 898 =cut
 899
 900 sub has_overdues {
 901     my ($self) = @_;
 902     my $dtf = Koha::Database->new->schema->storage->datetime_parser;
 903     return $self->_result->issues->search({ date_due => { '<' => $dtf->format_datetime( dt_from_string() ) } })->count;
 904 }
 905
 906 =head3 track_login
 907
 908     $patron->track_login;
 909     $patron->track_login({ force => 1 });
 910
 911     Tracks a (successful) login attempt.
 912     The preference TrackLastPatronActivity must be enabled. Or you
 913     should pass the force parameter.
 914
 915 =cut
 916
 917 sub track_login {
 918     my ( $self, $params ) = @_;
 919     return if
 920         !$params->{force} &&
 921         !C4::Context->preference('TrackLastPatronActivity');
 922     $self->lastseen( dt_from_string() )->store;
 923 }
 924
 925 =head3 move_to_deleted
 926
 927 my $is_moved = $patron->move_to_deleted;
 928
 929 Move a patron to the deletedborrowers table.
 930 This can be done before deleting a patron, to make sure the data are not completely deleted.
 931
 932 =cut
 933
 934 sub move_to_deleted {
 935     my ($self) = @_;
 936     my $patron_infos = $self->unblessed;
 937     delete $patron_infos->{updated_on}; #This ensures the updated_on date in deletedborrowers will be set to the current timestamp
 938     return Koha::Database->new->schema->resultset('Deletedborrower')->create($patron_infos);
 939 }
 940
 941 =head3 article_requests
 942
 943 my @requests = $borrower->article_requests();
 944 my $requests = $borrower->article_requests();
 945
 946 Returns either a list of ArticleRequests objects,
 947 or an ArtitleRequests object, depending on the
 948 calling context.
 949
 950 =cut
 951
 952 sub article_requests {
 953     my ( $self ) = @_;
 954
 955     $self->{_article_requests} ||= Koha::ArticleRequests->search({ borrowernumber => $self->borrowernumber() });
 956
 957     return $self->{_article_requests};
 958 }
 959
 960 =head3 article_requests_current
 961
 962 my @requests = $patron->article_requests_current
 963
 964 Returns the article requests associated with this patron that are incomplete
 965
 966 =cut
 967
 968 sub article_requests_current {
 969     my ( $self ) = @_;
 970
 971     $self->{_article_requests_current} ||= Koha::ArticleRequests->search(
 972         {
 973             borrowernumber => $self->id(),
 974             -or          => [
 975                 { status => Koha::ArticleRequest::Status::Pending },
 976                 { status => Koha::ArticleRequest::Status::Processing }
 977             ]
 978         }
 979     );
 980
 981     return $self->{_article_requests_current};
 982 }
 983
 984 =head3 article_requests_finished
 985
 986 my @requests = $biblio->article_requests_finished
 987
 988 Returns the article requests associated with this patron that are completed
 989
 990 =cut
 991
 992 sub article_requests_finished {
 993     my ( $self, $borrower ) = @_;
 994
 995     $self->{_article_requests_finished} ||= Koha::ArticleRequests->search(
 996         {
 997             borrowernumber => $self->id(),
 998             -or          => [
 999                 { status => Koha::ArticleRequest::Status::Completed },
1000                 { status => Koha::ArticleRequest::Status::Canceled }
1001             ]
1002         }
1003     );
1004
1005     return $self->{_article_requests_finished};
1006 }
1007
1008 =head3 add_enrolment_fee_if_needed
1009
1010 my $enrolment_fee = $patron->add_enrolment_fee_if_needed($renewal);
1011
1012 Add enrolment fee for a patron if needed.
1013
1014 $renewal - boolean denoting whether this is an account renewal or not
1015
1016 =cut
1017
1018 sub add_enrolment_fee_if_needed {
1019     my ($self, $renewal) = @_;
1020     my $enrolment_fee = $self->category->enrolmentfee;
1021     if ( $enrolment_fee && $enrolment_fee > 0 ) {
1022         my $type = $renewal ? 'ACCOUNT_RENEW' : 'ACCOUNT';
1023         $self->account->add_debit(
1024             {
1025                 amount     => $enrolment_fee,
1026                 user_id    => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
1027                 interface  => C4::Context->interface,
1028                 library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
1029                 type       => $type
1030             }
1031         );
1032     }
1033     return $enrolment_fee || 0;
1034 }
1035
1036 =head3 checkouts
1037
1038 my $checkouts = $patron->checkouts
1039
1040 =cut
1041
1042 sub checkouts {
1043     my ($self) = @_;
1044     my $checkouts = $self->_result->issues;
1045     return Koha::Checkouts->_new_from_dbic( $checkouts );
1046 }
1047
1048 =head3 pending_checkouts
1049
1050 my $pending_checkouts = $patron->pending_checkouts
1051
1052 This method will return the same as $self->checkouts, but with a prefetch on
1053 items, biblio and biblioitems.
1054
1055 It has been introduced to replaced the C4::Members::GetPendingIssues subroutine
1056
1057 It should not be used directly, prefer to access fields you need instead of
1058 retrieving all these fields in one go.
1059
1060 =cut
1061
1062 sub pending_checkouts {
1063     my( $self ) = @_;
1064     my $checkouts = $self->_result->issues->search(
1065         {},
1066         {
1067             order_by => [
1068                 { -desc => 'me.timestamp' },
1069                 { -desc => 'issuedate' },
1070                 { -desc => 'issue_id' }, # Sort by issue_id should be enough
1071             ],
1072             prefetch => { item => { biblio => 'biblioitems' } },
1073         }
1074     );
1075     return Koha::Checkouts->_new_from_dbic( $checkouts );
1076 }
1077
1078 =head3 old_checkouts
1079
1080 my $old_checkouts = $patron->old_checkouts
1081
1082 =cut
1083
1084 sub old_checkouts {
1085     my ($self) = @_;
1086     my $old_checkouts = $self->_result->old_issues;
1087     return Koha::Old::Checkouts->_new_from_dbic( $old_checkouts );
1088 }
1089
1090 =head3 get_overdues
1091
1092 my $overdue_items = $patron->get_overdues
1093
1094 Return the overdue items
1095
1096 =cut
1097
1098 sub get_overdues {
1099     my ($self) = @_;
1100     my $dtf = Koha::Database->new->schema->storage->datetime_parser;
1101     return $self->checkouts->search(
1102         {
1103             'me.date_due' => { '<' => $dtf->format_datetime(dt_from_string) },
1104         },
1105         {
1106             prefetch => { item => { biblio => 'biblioitems' } },
1107         }
1108     );
1109 }
1110
1111 =head3 get_routing_lists
1112
1113 my @routinglists = $patron->get_routing_lists
1114
1115 Returns the routing lists a patron is subscribed to.
1116
1117 =cut
1118
1119 sub get_routing_lists {
1120     my ($self) = @_;
1121     my $routing_list_rs = $self->_result->subscriptionroutinglists;
1122     return Koha::Subscription::Routinglists->_new_from_dbic($routing_list_rs);
1123 }
1124
1125 =head3 get_age
1126
1127 my $age = $patron->get_age
1128
1129 Return the age of the patron
1130
1131 =cut
1132
1133 sub get_age {
1134     my ($self)    = @_;
1135     my $today_str = dt_from_string->strftime("%Y-%m-%d");
1136     return unless $self->dateofbirth;
1137     my $dob_str   = dt_from_string( $self->dateofbirth )->strftime("%Y-%m-%d");
1138
1139     my ( $dob_y,   $dob_m,   $dob_d )   = split /-/, $dob_str;
1140     my ( $today_y, $today_m, $today_d ) = split /-/, $today_str;
1141
1142     my $age = $today_y - $dob_y;
1143     if ( $dob_m . $dob_d > $today_m . $today_d ) {
1144         $age--;
1145     }
1146
1147     return $age;
1148 }
1149
1150 =head3 is_valid_age
1151
1152 my $is_valid = $patron->is_valid_age
1153
1154 Return 1 if patron's age is between allowed limits, returns 0 if it's not.
1155
1156 =cut
1157
1158 sub is_valid_age {
1159     my ($self) = @_;
1160     my $age = $self->get_age;
1161
1162     my $patroncategory = $self->category;
1163     my ($low,$high) = ($patroncategory->dateofbirthrequired, $patroncategory->upperagelimit);
1164
1165     return (defined($age) && (($high && ($age > $high)) or ($age < $low))) ? 0 : 1;
1166 }
1167
1168 =head3 account
1169
1170 my $account = $patron->account
1171
1172 =cut
1173
1174 sub account {
1175     my ($self) = @_;
1176     return Koha::Account->new( { patron_id => $self->borrowernumber } );
1177 }
1178
1179 =head3 holds
1180
1181 my $holds = $patron->holds
1182
1183 Return all the holds placed by this patron
1184
1185 =cut
1186
1187 sub holds {
1188     my ($self) = @_;
1189     my $holds_rs = $self->_result->reserves->search( {}, { order_by => 'reservedate' } );
1190     return Koha::Holds->_new_from_dbic($holds_rs);
1191 }
1192
1193 =head3 old_holds
1194
1195 my $old_holds = $patron->old_holds
1196
1197 Return all the historical holds for this patron
1198
1199 =cut
1200
1201 sub old_holds {
1202     my ($self) = @_;
1203     my $old_holds_rs = $self->_result->old_reserves->search( {}, { order_by => 'reservedate' } );
1204     return Koha::Old::Holds->_new_from_dbic($old_holds_rs);
1205 }
1206
1207 =head3 return_claims
1208
1209 my $return_claims = $patron->return_claims
1210
1211 =cut
1212
1213 sub return_claims {
1214     my ($self) = @_;
1215     my $return_claims = $self->_result->return_claims_borrowernumbers;
1216     return Koha::Checkouts::ReturnClaims->_new_from_dbic( $return_claims );
1217 }
1218
1219 =head3 notice_email_address
1220
1221   my $email = $patron->notice_email_address;
1222
1223 Return the email address of patron used for notices.
1224 Returns the empty string if no email address.
1225
1226 =cut
1227
1228 sub notice_email_address{
1229     my ( $self ) = @_;
1230
1231     my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
1232     # if syspref is set to 'first valid' (value == OFF), look up email address
1233     if ( $which_address eq 'OFF' ) {
1234         return $self->first_valid_email_address;
1235     }
1236
1237     return $self->$which_address || '';
1238 }
1239
1240 =head3 first_valid_email_address
1241
1242 my $first_valid_email_address = $patron->first_valid_email_address
1243
1244 Return the first valid email address for a patron.
1245 For now, the order  is defined as email, emailpro, B_email.
1246 Returns the empty string if the borrower has no email addresses.
1247
1248 =cut
1249
1250 sub first_valid_email_address {
1251     my ($self) = @_;
1252
1253     return $self->email() || $self->emailpro() || $self->B_email() || q{};
1254 }
1255
1256 =head3 get_club_enrollments
1257
1258 =cut
1259
1260 sub get_club_enrollments {
1261     my ( $self, $return_scalar ) = @_;
1262
1263     my $e = Koha::Club::Enrollments->search( { borrowernumber => $self->borrowernumber(), date_canceled => undef } );
1264
1265     return $e if $return_scalar;
1266
1267     return wantarray ? $e->as_list : $e;
1268 }
1269
1270 =head3 get_enrollable_clubs
1271
1272 =cut
1273
1274 sub get_enrollable_clubs {
1275     my ( $self, $is_enrollable_from_opac, $return_scalar ) = @_;
1276
1277     my $params;
1278     $params->{is_enrollable_from_opac} = $is_enrollable_from_opac
1279       if $is_enrollable_from_opac;
1280     $params->{is_email_required} = 0 unless $self->first_valid_email_address();
1281
1282     $params->{borrower} = $self;
1283
1284     my $e = Koha::Clubs->get_enrollable($params);
1285
1286     return $e if $return_scalar;
1287
1288     return wantarray ? $e->as_list : $e;
1289 }
1290
1291 =head3 account_locked
1292
1293 my $is_locked = $patron->account_locked
1294
1295 Return true if the patron has reached the maximum number of login attempts
1296 (see pref FailedLoginAttempts). If login_attempts is < 0, this is interpreted
1297 as an administrative lockout (independent of FailedLoginAttempts; see also
1298 Koha::Patron->lock).
1299 Otherwise return false.
1300 If the pref is not set (empty string, null or 0), the feature is considered as
1301 disabled.
1302
1303 =cut
1304
1305 sub account_locked {
1306     my ($self) = @_;
1307     my $FailedLoginAttempts = C4::Context->preference('FailedLoginAttempts');
1308     return 1 if $FailedLoginAttempts
1309           and $self->login_attempts
1310           and $self->login_attempts >= $FailedLoginAttempts;
1311     return 1 if ($self->login_attempts || 0) < 0; # administrative lockout
1312     return 0;
1313 }
1314
1315 =head3 can_see_patron_infos
1316
1317 my $can_see = $patron->can_see_patron_infos( $patron );
1318
1319 Return true if the patron (usually the logged in user) can see the patron's infos for a given patron
1320
1321 =cut
1322
1323 sub can_see_patron_infos {
1324     my ( $self, $patron ) = @_;
1325     return unless $patron;
1326     return $self->can_see_patrons_from( $patron->library->branchcode );
1327 }
1328
1329 =head3 can_see_patrons_from
1330
1331 my $can_see = $patron->can_see_patrons_from( $branchcode );
1332
1333 Return true if the patron (usually the logged in user) can see the patron's infos from a given library
1334
1335 =cut
1336
1337 sub can_see_patrons_from {
1338     my ( $self, $branchcode ) = @_;
1339     my $can = 0;
1340     if ( $self->branchcode eq $branchcode ) {
1341         $can = 1;
1342     } elsif ( $self->has_permission( { borrowers => 'view_borrower_infos_from_any_libraries' } ) ) {
1343         $can = 1;
1344     } elsif ( my $library_groups = $self->library->library_groups ) {
1345         while ( my $library_group = $library_groups->next ) {
1346             if ( $library_group->parent->has_child( $branchcode ) ) {
1347                 $can = 1;
1348                 last;
1349             }
1350         }
1351     }
1352     return $can;
1353 }
1354
1355 =head3 libraries_where_can_see_patrons
1356
1357 my $libraries = $patron-libraries_where_can_see_patrons;
1358
1359 Return the list of branchcodes(!) of libraries the patron is allowed to see other patron's infos.
1360 The branchcodes are arbitrarily returned sorted.
1361 We are supposing here that the object is related to the logged in patron (use of C4::Context::only_my_library)
1362
1363 An empty array means no restriction, the patron can see patron's infos from any libraries.
1364
1365 =cut
1366
1367 sub libraries_where_can_see_patrons {
1368     my ( $self ) = @_;
1369     my $userenv = C4::Context->userenv;
1370
1371     return () unless $userenv; # For tests, but userenv should be defined in tests...
1372
1373     my @restricted_branchcodes;
1374     if (C4::Context::only_my_library) {
1375         push @restricted_branchcodes, $self->branchcode;
1376     }
1377     else {
1378         unless (
1379             $self->has_permission(
1380                 { borrowers => 'view_borrower_infos_from_any_libraries' }
1381             )
1382           )
1383         {
1384             my $library_groups = $self->library->library_groups({ ft_hide_patron_info => 1 });
1385             if ( $library_groups->count )
1386             {
1387                 while ( my $library_group = $library_groups->next ) {
1388                     my $parent = $library_group->parent;
1389                     if ( $parent->has_child( $self->branchcode ) ) {
1390                         push @restricted_branchcodes, $parent->children->get_column('branchcode');
1391                     }
1392                 }
1393             }
1394
1395             @restricted_branchcodes = ( $self->branchcode ) unless @restricted_branchcodes;
1396         }
1397     }
1398
1399     @restricted_branchcodes = grep { defined $_ } @restricted_branchcodes;
1400     @restricted_branchcodes = uniq(@restricted_branchcodes);
1401     @restricted_branchcodes = sort(@restricted_branchcodes);
1402     return @restricted_branchcodes;
1403 }
1404
1405 =head3 has_permission
1406
1407 my $permission = $patron->has_permission($required);
1408
1409 See C4::Auth::haspermission for details of syntax for $required
1410
1411 =cut
1412
1413 sub has_permission {
1414     my ( $self, $flagsrequired ) = @_;
1415     return unless $self->userid;
1416     # TODO code from haspermission needs to be moved here!
1417     return C4::Auth::haspermission( $self->userid, $flagsrequired );
1418 }
1419
1420 =head3 is_superlibrarian
1421
1422   my $is_superlibrarian = $patron->is_superlibrarian;
1423
1424 Return true if the patron is a superlibrarian.
1425
1426 =cut
1427
1428 sub is_superlibrarian {
1429     my ($self) = @_;
1430     return $self->has_permission( { superlibrarian => 1 } ) ? 1 : 0;
1431 }
1432
1433 =head3 is_adult
1434
1435 my $is_adult = $patron->is_adult
1436
1437 Return true if the patron has a category with a type Adult (A) or Organization (I)
1438
1439 =cut
1440
1441 sub is_adult {
1442     my ( $self ) = @_;
1443     return $self->category->category_type =~ /^(A|I)$/ ? 1 : 0;
1444 }
1445
1446 =head3 is_child
1447
1448 my $is_child = $patron->is_child
1449
1450 Return true if the patron has a category with a type Child (C)
1451
1452 =cut
1453
1454 sub is_child {
1455     my( $self ) = @_;
1456     return $self->category->category_type eq 'C' ? 1 : 0;
1457 }
1458
1459 =head3 has_valid_userid
1460
1461 my $patron = Koha::Patrons->find(42);
1462 $patron->userid( $new_userid );
1463 my $has_a_valid_userid = $patron->has_valid_userid
1464
1465 my $patron = Koha::Patron->new( $params );
1466 my $has_a_valid_userid = $patron->has_valid_userid
1467
1468 Return true if the current userid of this patron is valid/unique, otherwise false.
1469
1470 Note that this should be done in $self->store instead and raise an exception if needed.
1471
1472 =cut
1473
1474 sub has_valid_userid {
1475     my ($self) = @_;
1476
1477     return 0 unless $self->userid;
1478
1479     return 0 if ( $self->userid eq C4::Context->config('user') );    # DB user
1480
1481     my $already_exists = Koha::Patrons->search(
1482         {
1483             userid => $self->userid,
1484             (
1485                 $self->in_storage
1486                 ? ( borrowernumber => { '!=' => $self->borrowernumber } )
1487                 : ()
1488             ),
1489         }
1490     )->count;
1491     return $already_exists ? 0 : 1;
1492 }
1493
1494 =head3 generate_userid
1495
1496 my $patron = Koha::Patron->new( $params );
1497 $patron->generate_userid
1498
1499 Generate a userid using the $surname and the $firstname (if there is a value in $firstname).
1500
1501 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).
1502
1503 =cut
1504
1505 sub generate_userid {
1506     my ($self) = @_;
1507     my $offset = 0;
1508     my $firstname = $self->firstname // q{};
1509     my $surname = $self->surname // q{};
1510     #The script will "do" the following code and increment the $offset until the generated userid is unique
1511     do {
1512       $firstname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1513       $surname =~ s/[[:digit:][:space:][:blank:][:punct:][:cntrl:]]//g;
1514       my $userid = lc(($firstname)? "$firstname.$surname" : $surname);
1515       $userid = NFKD( $userid );
1516       $userid =~ s/\p{NonspacingMark}//g;
1517       $userid .= $offset unless $offset == 0;
1518       $self->userid( $userid );
1519       $offset++;
1520      } while (! $self->has_valid_userid );
1521
1522      return $self;
1523 }
1524
1525 =head3 add_extended_attribute
1526
1527 =cut
1528
1529 sub add_extended_attribute {
1530     my ($self, $attribute) = @_;
1531     $attribute->{borrowernumber} = $self->borrowernumber;
1532     return Koha::Patron::Attribute->new($attribute)->store;
1533 }
1534
1535 =head3 extended_attributes
1536
1537 Return object of Koha::Patron::Attributes type with all attributes set for this patron
1538
1539 Or setter FIXME
1540
1541 =cut
1542
1543 sub extended_attributes {
1544     my ( $self, $attributes ) = @_;
1545     if ($attributes) {    # setter
1546         my $schema = $self->_result->result_source->schema;
1547         $schema->txn_do(
1548             sub {
1549                 # Remove the existing one
1550                 $self->extended_attributes->filter_by_branch_limitations->delete;
1551
1552                 # Insert the new ones
1553                 for my $attribute (@$attributes) {
1554                     eval {
1555                         $self->_result->create_related('borrower_attributes', $attribute);
1556                     };
1557                     # FIXME We should:
1558                     # 1 - Raise an exception
1559                     # 2 - Execute in a transaction and don't save
1560                     #  or Insert anyway but display a message on the UI
1561                     warn $@ if $@;
1562                 }
1563             }
1564         );
1565     }
1566
1567     my $rs = $self->_result->borrower_attributes;
1568     # We call search to use the filters in Koha::Patron::Attributes->search
1569     return Koha::Patron::Attributes->_new_from_dbic($rs)->search;
1570 }
1571
1572 =head3 lock
1573
1574     Koha::Patrons->find($id)->lock({ expire => 1, remove => 1 });
1575
1576     Lock and optionally expire a patron account.
1577     Remove holds and article requests if remove flag set.
1578     In order to distinguish from locking by entering a wrong password, let's
1579     call this an administrative lockout.
1580
1581 =cut
1582
1583 sub lock {
1584     my ( $self, $params ) = @_;
1585     $self->login_attempts( ADMINISTRATIVE_LOCKOUT );
1586     if( $params->{expire} ) {
1587         $self->dateexpiry( dt_from_string->subtract(days => 1) );
1588     }
1589     $self->store;
1590     if( $params->{remove} ) {
1591         $self->holds->delete;
1592         $self->article_requests->delete;
1593     }
1594     return $self;
1595 }
1596
1597 =head3 anonymize
1598
1599     Koha::Patrons->find($id)->anonymize;
1600
1601     Anonymize or clear borrower fields. Fields in BorrowerMandatoryField
1602     are randomized, other personal data is cleared too.
1603     Patrons with issues are skipped.
1604
1605 =cut
1606
1607 sub anonymize {
1608     my ( $self ) = @_;
1609     if( $self->_result->issues->count ) {
1610         warn "Exiting anonymize: patron ".$self->borrowernumber." still has issues";
1611         return;
1612     }
1613     # Mandatory fields come from the corresponding pref, but email fields
1614     # are removed since scrambled email addresses only generate errors
1615     my $mandatory = { map { (lc $_, 1); } grep { !/email/ }
1616         split /\s*\|\s*/, C4::Context->preference('BorrowerMandatoryField') };
1617     $mandatory->{userid} = 1; # needed since sub store does not clear field
1618     my @columns = $self->_result->result_source->columns;
1619     @columns = grep { !/borrowernumber|branchcode|categorycode|^date|password|flags|updated_on|lastseen|lang|login_attempts|anonymized/ } @columns;
1620     push @columns, 'dateofbirth'; # add this date back in
1621     foreach my $col (@columns) {
1622         $self->_anonymize_column($col, $mandatory->{lc $col} );
1623     }
1624     $self->anonymized(1)->store;
1625 }
1626
1627 sub _anonymize_column {
1628     my ( $self, $col, $mandatory ) = @_;
1629     my $col_info = $self->_result->result_source->column_info($col);
1630     my $type = $col_info->{data_type};
1631     my $nullable = $col_info->{is_nullable};
1632     my $val;
1633     if( $type =~ /char|text/ ) {
1634         $val = $mandatory
1635             ? Koha::Token->new->generate({ pattern => '\w{10}' })
1636             : $nullable
1637             ? undef
1638             : q{};
1639     } elsif( $type =~ /integer|int$|float|dec|double/ ) {
1640         $val = $nullable ? undef : 0;
1641     } elsif( $type =~ /date|time/ ) {
1642         $val = $nullable ? undef : dt_from_string;
1643     }
1644     $self->$col($val);
1645 }
1646
1647 =head3 add_guarantor
1648
1649     my @relationships = $patron->add_guarantor(
1650         {
1651             borrowernumber => $borrowernumber,
1652             relationships  => $relationship,
1653         }
1654     );
1655
1656     Adds a new guarantor to a patron.
1657
1658 =cut
1659
1660 sub add_guarantor {
1661     my ( $self, $params ) = @_;
1662
1663     my $guarantor_id = $params->{guarantor_id};
1664     my $relationship = $params->{relationship};
1665
1666     return Koha::Patron::Relationship->new(
1667         {
1668             guarantee_id => $self->id,
1669             guarantor_id => $guarantor_id,
1670             relationship => $relationship
1671         }
1672     )->store();
1673 }
1674
1675 =head3 get_extended_attribute
1676
1677 my $attribute_value = $patron->get_extended_attribute( $code );
1678
1679 Return the attribute for the code passed in parameter.
1680
1681 It not exist it returns undef
1682
1683 Note that this will not work for repeatable attribute types.
1684
1685 Maybe you certainly not want to use this method, it is actually only used for SHOW_BARCODE
1686 (which should be a real patron's attribute (not extended)
1687
1688 =cut
1689
1690 sub get_extended_attribute {
1691     my ( $self, $code, $value ) = @_;
1692     my $rs = $self->_result->borrower_attributes;
1693     return unless $rs;
1694     my $attribute = $rs->search({ code => $code, ( $value ? ( attribute => $value ) : () ) });
1695     return unless $attribute->count;
1696     return $attribute->next;
1697 }
1698
1699 =head3 to_api
1700
1701     my $json = $patron->to_api;
1702
1703 Overloaded method that returns a JSON representation of the Koha::Patron object,
1704 suitable for API output.
1705
1706 =cut
1707
1708 sub to_api {
1709     my ( $self, $params ) = @_;
1710
1711     my $json_patron = $self->SUPER::to_api( $params );
1712
1713     $json_patron->{restricted} = ( $self->is_debarred )
1714                                     ? Mojo::JSON->true
1715                                     : Mojo::JSON->false;
1716
1717     return $json_patron;
1718 }
1719
1720 =head3 to_api_mapping
1721
1722 This method returns the mapping for representing a Koha::Patron object
1723 on the API.
1724
1725 =cut
1726
1727 sub to_api_mapping {
1728     return {
1729         borrowernotes       => 'staff_notes',
1730         borrowernumber      => 'patron_id',
1731         branchcode          => 'library_id',
1732         categorycode        => 'category_id',
1733         checkprevcheckout   => 'check_previous_checkout',
1734         contactfirstname    => undef,                     # Unused
1735         contactname         => undef,                     # Unused
1736         contactnote         => 'altaddress_notes',
1737         contacttitle        => undef,                     # Unused
1738         dateenrolled        => 'date_enrolled',
1739         dateexpiry          => 'expiry_date',
1740         dateofbirth         => 'date_of_birth',
1741         debarred            => undef,                     # replaced by 'restricted'
1742         debarredcomment     => undef,    # calculated, API consumers will use /restrictions instead
1743         emailpro            => 'secondary_email',
1744         flags               => undef,    # permissions manipulation handled in /permissions
1745         gonenoaddress       => 'incorrect_address',
1746         guarantorid         => 'guarantor_id',
1747         lastseen            => 'last_seen',
1748         lost                => 'patron_card_lost',
1749         opacnote            => 'opac_notes',
1750         othernames          => 'other_name',
1751         password            => undef,            # password manipulation handled in /password
1752         phonepro            => 'secondary_phone',
1753         relationship        => 'relationship_type',
1754         sex                 => 'gender',
1755         smsalertnumber      => 'sms_number',
1756         sort1               => 'statistics_1',
1757         sort2               => 'statistics_2',
1758         autorenew_checkouts => 'autorenew_checkouts',
1759         streetnumber        => 'street_number',
1760         streettype          => 'street_type',
1761         zipcode             => 'postal_code',
1762         B_address           => 'altaddress_address',
1763         B_address2          => 'altaddress_address2',
1764         B_city              => 'altaddress_city',
1765         B_country           => 'altaddress_country',
1766         B_email             => 'altaddress_email',
1767         B_phone             => 'altaddress_phone',
1768         B_state             => 'altaddress_state',
1769         B_streetnumber      => 'altaddress_street_number',
1770         B_streettype        => 'altaddress_street_type',
1771         B_zipcode           => 'altaddress_postal_code',
1772         altcontactaddress1  => 'altcontact_address',
1773         altcontactaddress2  => 'altcontact_address2',
1774         altcontactaddress3  => 'altcontact_city',
1775         altcontactcountry   => 'altcontact_country',
1776         altcontactfirstname => 'altcontact_firstname',
1777         altcontactphone     => 'altcontact_phone',
1778         altcontactsurname   => 'altcontact_surname',
1779         altcontactstate     => 'altcontact_state',
1780         altcontactzipcode   => 'altcontact_postal_code'
1781     };
1782 }
1783
1784 =head2 Internal methods
1785
1786 =head3 _type
1787
1788 =cut
1789
1790 sub _type {
1791     return 'Borrower';
1792 }
1793
1794 =head1 AUTHORS
1795
1796 Kyle M Hall <kyle@bywatersolutions.com>
1797 Alex Sassmannshausen <alex.sassmannshausen@ptfs-europe.com>
1798 Martin Renvoize <martin.renvoize@ptfs-europe.com>
1799
1800 =cut
1801
1802 1;