Bug 16011: $VERSION - Remove comments
[koha.git] / 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 Crypt::Eksblowfish::Bcrypt qw(en_base64);
23
24 use vars qw(@ISA @EXPORT);
25
26 BEGIN {
27     require Exporter;
28     @ISA = qw(Exporter);
29     push @EXPORT, qw(
30       &ValidateBorrowernumber
31       &SendPasswordRecoveryEmail
32       &GetValidLinkInfo
33       &CompletePasswordRecovery
34     );
35 }
36
37 =head1 NAME
38
39 Koha::Patron::Password::Recovery - Koha password recovery module
40
41 =head1 SYNOPSIS
42
43 use Koha::Patron::Password::Recovery;
44
45 =head1 FUNCTIONS
46
47 =head2 ValidateBorrowernumber
48
49 $alread = ValidateBorrowernumber( $borrower_number );
50
51 Check if the system already start recovery
52
53 Returns true false
54
55 =cut
56
57 sub ValidateBorrowernumber {
58     my ($borrower_number) = @_;
59     my $schema = Koha::Database->new->schema;
60
61     my $rs = $schema->resultset('BorrowerPasswordRecovery')->search(
62         {
63             borrowernumber => $borrower_number,
64             valid_until    => \'> NOW()'
65         },
66         { columns => 'borrowernumber' }
67     );
68
69     if ( $rs->next ) {
70         return 1;
71     }
72
73     return 0;
74 }
75
76 =head2 GetValidLinkInfo
77
78     Check if the link is still valid and return some info.
79
80 =cut
81
82 sub GetValidLinkInfo {
83     my ($uniqueKey) = @_;
84     my $dbh         = C4::Context->dbh;
85     my $query       = '
86     SELECT borrower_password_recovery.borrowernumber, userid
87     FROM borrower_password_recovery, borrowers
88     WHERE borrowers.borrowernumber = borrower_password_recovery.borrowernumber
89     AND NOW() < valid_until
90     AND uuid = ?
91     ';
92     my $sth = $dbh->prepare($query);
93     $sth->execute($uniqueKey);
94     return $sth->fetchrow;
95 }
96
97 =head2 SendPasswordRecoveryEmail
98
99  It creates an email using the templates and sends it to the user, using the specified email
100
101 =cut
102
103 sub SendPasswordRecoveryEmail {
104     my $borrower  = shift;    # Koha::Patron
105     my $userEmail = shift;    #to_address (the one specified in the request)
106     my $update    = shift;
107
108     my $schema = Koha::Database->new->schema;
109
110     # generate UUID
111     my $uuid_str;
112     do {
113         $uuid_str = '$2a$08$'.en_base64(Koha::AuthUtils::generate_salt('weak', 16));
114     } while ( substr ( $uuid_str, -1, 1 ) eq '.' );
115
116     # insert into database
117     my $expirydate =
118       DateTime->now( time_zone => C4::Context->tz() )->add( days => 2 );
119     if ($update) {
120         my $rs =
121           $schema->resultset('BorrowerPasswordRecovery')
122           ->search( { borrowernumber => $borrower->borrowernumber, } );
123         $rs->update(
124             { uuid => $uuid_str, valid_until => $expirydate->datetime() } );
125     }
126     else {
127         my $rs = $schema->resultset('BorrowerPasswordRecovery')->create(
128             {
129                 borrowernumber => $borrower->borrowernumber,
130                 uuid           => $uuid_str,
131                 valid_until    => $expirydate->datetime()
132             }
133         );
134     }
135
136     # create link
137     my $opacbase = C4::Context->preference('OPACBaseURL') || '';
138     my $uuidLink = $opacbase
139       . "/cgi-bin/koha/opac-password-recovery.pl?uniqueKey=$uuid_str";
140
141     # prepare the email
142     my $letter = C4::Letters::GetPreparedLetter(
143         module      => 'members',
144         letter_code => 'PASSWORD_RESET',
145         branchcode  => $borrower->branchcode,
146         substitute =>
147           { passwordreseturl => $uuidLink, user => $borrower->userid },
148     );
149
150     # define to/from emails
151     my $kohaEmail = C4::Context->preference('KohaAdminEmailAddress');    # from
152
153     C4::Letters::EnqueueLetter(
154         {
155             letter                 => $letter,
156             borrowernumber         => $borrower->borrowernumber,
157             to_address             => $userEmail,
158             from_address           => $kohaEmail,
159             message_transport_type => 'email',
160         }
161     );
162
163     return 1;
164 }
165
166 =head2 CompletePasswordRecovery
167
168     $bool = CompletePasswordRecovery($uuid);
169
170     Deletes a password recovery entry.
171
172 =cut
173
174 sub CompletePasswordRecovery {
175     my $uniqueKey = shift;
176     my $model =
177       Koha::Database->new->schema->resultset('BorrowerPasswordRecovery');
178     my $entry = $model->search(
179         { -or => [ uuid => $uniqueKey, valid_until => \'< NOW()' ] } );
180     return $entry->delete();
181 }
182
183 END { }    # module clean-up code here (global destructor)
184
185 1;