Koha/Patron/Password/Recovery.pm

   1 package Koha::Patron::Password::Recovery;
   2
   3 # Copyright 2014 Solutions InLibro inc.
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use Modern::Perl;
  21 use C4::Context;
  22 use C4::Letters;
  23 use Crypt::Eksblowfish::Bcrypt qw(en_base64);
  24 use Koha::DateUtils;
  25
  26 use vars qw(@ISA @EXPORT);
  27
  28 BEGIN {
  29     require Exporter;
  30     @ISA = qw(Exporter);
  31     push @EXPORT, qw(
  32       &ValidateBorrowernumber
  33       &SendPasswordRecoveryEmail
  34       &GetValidLinkInfo
  35       &CompletePasswordRecovery
  36       &DeleteExpiredPasswordRecovery
  37     );
  38 }
  39
  40 =head1 NAME
  41
  42 Koha::Patron::Password::Recovery - Koha password recovery module
  43
  44 =head1 SYNOPSIS
  45
  46 use Koha::Patron::Password::Recovery;
  47
  48 =head1 FUNCTIONS
  49
  50 =head2 ValidateBorrowernumber
  51
  52 $alread = ValidateBorrowernumber( $borrower_number );
  53
  54 Check if the system already start recovery
  55
  56 Returns true false
  57
  58 =cut
  59
  60 sub ValidateBorrowernumber {
  61     my ($borrower_number) = @_;
  62     my $schema = Koha::Database->new->schema;
  63
  64     my $rs = $schema->resultset('BorrowerPasswordRecovery')->search(
  65         {
  66             borrowernumber => $borrower_number,
  67             valid_until    => \'> NOW()'
  68         },
  69         { columns => 'borrowernumber' }
  70     );
  71     if ( $rs->next ) {
  72         return 1;
  73     }
  74     return 0;
  75 }
  76
  77 =head2 GetValidLinkInfo
  78
  79     Check if the link is still valid and return some info.
  80
  81 =cut
  82
  83 sub GetValidLinkInfo {
  84     my ($uniqueKey) = @_;
  85     my $dbh         = C4::Context->dbh;
  86     my $query       = '
  87     SELECT borrower_password_recovery.borrowernumber, userid
  88     FROM borrower_password_recovery, borrowers
  89     WHERE borrowers.borrowernumber = borrower_password_recovery.borrowernumber
  90     AND NOW() < valid_until
  91     AND uuid = ?
  92     ';
  93     my $sth = $dbh->prepare($query);
  94     $sth->execute($uniqueKey);
  95     return $sth->fetchrow;
  96 }
  97
  98 =head2 SendPasswordRecoveryEmail
  99
 100  It creates an email using the templates and sends it to the user, using the specified email
 101
 102 =cut
 103
 104 sub SendPasswordRecoveryEmail {
 105     my $borrower  = shift;    # Koha::Patron
 106     my $userEmail = shift;    #to_address (the one specified in the request)
 107     my $update    = shift;
 108
 109     my $schema = Koha::Database->new->schema;
 110
 111     # generate UUID
 112     my $uuid_str;
 113     do {
 114         $uuid_str = '$2a$08$'.en_base64(Koha::AuthUtils::generate_salt('weak', 16));
 115     } while ( substr ( $uuid_str, -1, 1 ) eq '.' );
 116
 117     # insert into database
 118     my $expirydate =
 119       dt_from_string()->add( days => 2 );
 120     if ($update) {
 121         my $rs =
 122           $schema->resultset('BorrowerPasswordRecovery')
 123           ->search( { borrowernumber => $borrower->borrowernumber, } );
 124         $rs->update(
 125             { uuid => $uuid_str, valid_until => $expirydate->datetime() } );
 126     }
 127     else {
 128         my $rs = $schema->resultset('BorrowerPasswordRecovery')->create(
 129             {
 130                 borrowernumber => $borrower->borrowernumber,
 131                 uuid           => $uuid_str,
 132                 valid_until    => $expirydate->datetime()
 133             }
 134         );
 135     }
 136
 137     # create link
 138     my $opacbase = C4::Context->preference('OPACBaseURL') || '';
 139     my $uuidLink = $opacbase
 140       . "/cgi-bin/koha/opac-password-recovery.pl?uniqueKey=$uuid_str";
 141
 142     # prepare the email
 143     my $letter = C4::Letters::GetPreparedLetter(
 144         module      => 'members',
 145         letter_code => 'PASSWORD_RESET',
 146         branchcode  => $borrower->branchcode,
 147         lang        => $borrower->lang,
 148         substitute =>
 149           { passwordreseturl => $uuidLink, user => $borrower->userid },
 150     );
 151
 152     # define from emails
 153     my $library = $borrower->library;
 154     my $kohaEmail = $library->from_email_address; # send from patron's branch or Koha Admin
 155
 156     my $message_id = C4::Letters::EnqueueLetter(
 157         {
 158             letter                 => $letter,
 159             borrowernumber         => $borrower->borrowernumber,
 160             to_address             => $userEmail,
 161             from_address           => $kohaEmail,
 162             message_transport_type => 'email',
 163         }
 164     );
 165
 166     my $num_letters_attempted =
 167       C4::Letters::SendQueuedMessages( { message_id => $message_id } );
 168
 169     return ($num_letters_attempted > 0);
 170 }
 171
 172 =head2 CompletePasswordRecovery
 173
 174     $bool = CompletePasswordRecovery($uuid);
 175
 176     Deletes a password recovery entry.
 177
 178 =cut
 179
 180 sub CompletePasswordRecovery {
 181     my $uniqueKey = shift;
 182     my $model =
 183       Koha::Database->new->schema->resultset('BorrowerPasswordRecovery');
 184     my $entry = $model->search(
 185         { -or => [ uuid => $uniqueKey, valid_until => \'< NOW()' ] } );
 186     return $entry->delete();
 187 }
 188
 189 =head2 DeleteExpiredPasswordRecovery
 190
 191     $bool = DeleteExpiredPasswordRecovery($borrowernumber)
 192
 193     Deletes an expired password recovery entry.
 194
 195 =cut
 196
 197 sub DeleteExpiredPasswordRecovery {
 198     my $borrower_number = shift;
 199     my $model =
 200       Koha::Database->new->schema->resultset('BorrowerPasswordRecovery');
 201     my $entry = $model->search(
 202         { borrowernumber => $borrower_number } );
 203     return $entry->delete();
 204 }
 205
 206
 207 END { }    # module clean-up code here (global destructor)
 208
 209 1;