Koha/C4/Passwordrecovery.pm
Kyle M Hall 77e1e7c4ef Bug 15548 [QA Followup] - More new uses of Koha::Borrower
Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>

Signed-off-by: Jesse Weaver <jweaver@bywatersolutions.com>
2016-03-03 14:39:00 -07:00

184 lines
4.8 KiB
Perl

package C4::Passwordrecovery;
# Copyright 2014 Solutions InLibro inc.
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Koha; if not, see <http://www.gnu.org/licenses>.
use Modern::Perl;
use C4::Context;
use Crypt::Eksblowfish::Bcrypt qw(en_base64);
use vars qw($VERSION @ISA @EXPORT);
BEGIN {
# set the version for version checking
$VERSION = 3.07.00.049;
require Exporter;
@ISA = qw(Exporter);
push @EXPORT, qw(
&ValidateBorrowernumber
&SendPasswordRecoveryEmail
&GetValidLinkInfo
&CompletePasswordRecovery
);
}
=head1 NAME
C4::Passwordrecovery - Koha password recovery module
=head1 SYNOPSIS
use C4::Passwordrecovery;
=head1 FUNCTIONS
=head2 ValidateBorrowernumber
$alread = ValidateBorrowernumber( $borrower_number );
Check if the system already start recovery
Returns true false
=cut
sub ValidateBorrowernumber {
my ($borrower_number) = @_;
my $schema = Koha::Database->new->schema;
my $rs = $schema->resultset('BorrowerPasswordRecovery')->search(
{
borrowernumber => $borrower_number,
valid_until => \'> NOW()'
},
{ columns => 'borrowernumber' }
);
if ( $rs->next ) {
return 1;
}
return 0;
}
=head2 GetValidLinkInfo
Check if the link is still valid and return some info.
=cut
sub GetValidLinkInfo {
my ($uniqueKey) = @_;
my $dbh = C4::Context->dbh;
my $query = '
SELECT borrower_password_recovery.borrowernumber, userid
FROM borrower_password_recovery, borrowers
WHERE borrowers.borrowernumber = borrower_password_recovery.borrowernumber
AND NOW() < valid_until
AND uuid = ?
';
my $sth = $dbh->prepare($query);
$sth->execute($uniqueKey);
return $sth->fetchrow;
}
=head2 SendPasswordRecoveryEmail
It creates an email using the templates and sends it to the user, using the specified email
=cut
sub SendPasswordRecoveryEmail {
my $borrower = shift; # Koha::Patron
my $userEmail = shift; #to_address (the one specified in the request)
my $update = shift;
my $schema = Koha::Database->new->schema;
# generate UUID
my @chars = ( "A" .. "Z", "a" .. "z", "0" .. "9" );
my $uuid_str = '$2a$08$'.en_base64(Koha::AuthUtils::generate_salt('weak', 16));
# insert into database
my $expirydate =
DateTime->now( time_zone => C4::Context->tz() )->add( days => 2 );
if ($update) {
my $rs =
$schema->resultset('BorrowerPasswordRecovery')
->search( { borrowernumber => $borrower->borrowernumber, } );
$rs->update(
{ uuid => $uuid_str, valid_until => $expirydate->datetime() } );
}
else {
my $rs = $schema->resultset('BorrowerPasswordRecovery')->create(
{
borrowernumber => $borrower->borrowernumber,
uuid => $uuid_str,
valid_until => $expirydate->datetime()
}
);
}
# create link
my $uuidLink = C4::Context->preference('OPACBaseURL')
. "/cgi-bin/koha/opac-password-recovery.pl?uniqueKey=$uuid_str";
# prepare the email
my $letter = C4::Letters::GetPreparedLetter(
module => 'members',
letter_code => 'PASSWORD_RESET',
branchcode => $borrower->branchcode,
substitute =>
{ passwordreseturl => $uuidLink, user => $borrower->userid },
);
# define to/from emails
my $kohaEmail = C4::Context->preference('KohaAdminEmailAddress'); # from
C4::Letters::EnqueueLetter(
{
letter => $letter,
borrowernumber => $borrower->borrowernumber,
to_address => $userEmail,
from_address => $kohaEmail,
message_transport_type => 'email',
}
);
return 1;
}
=head2 CompletePasswordRecovery
$bool = CompletePasswordRecovery($uuid);
Deletes a password recovery entry.
=cut
sub CompletePasswordRecovery {
my $uniqueKey = shift;
my $model =
Koha::Database->new->schema->resultset('BorrowerPasswordRecovery');
my $entry = $model->search(
{ -or => [ uuid => $uniqueKey, valid_until => \'< NOW()' ] } );
return $entry->delete();
}
END { } # module clean-up code here (global destructor)
1;