File Source for user

<?php
/**
* User class.
* This file contains the user class.
* @package HRDIODB
*/
/**
* This file is part of HRDIODB.
*
* HRDIODB 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 2 of the License, or
* (at your option) any later version.
*
* HRDIODB 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 HRDIODB; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/**
* HRDI user class.
* The HRDI user class is responsible for tracking and maintaining user
* information.
* @package HRDIODB
*/
class user {
/**
* Regular expression for e-mail verification. Taken from:
* {@link http://www.developer.com/lang/php/article.php/3290141}
* @var string
*/
var $email_regexp = '^([_a-z0-9-]+)(\.[_a-z0-9-]+)*@([a-z0-9-]+)(\.[a-z0-9-]+)*(\.[a-z]{2,4})$';
/**
* Any error that gets generated.
* @var string
*/
var $error;
/**
* User data.
* @var array
*/
var $data = array();
/**
* Constructor.
* The user class constructor.
* @param hrdi_db $hdb A hrdi_db instance
* @param session $session A session instance.
* the command line tools.
*/
function user(&$hdb, $session=FALSE) {
$this->hdb = $hdb;
if (is_object($session)) {
$this->session = $session;
$this->data = $this->session->get_var("user_data");
}
}
/**
* Checks if the user is authenticated.
* Returns TRUE if the user is authenticated, FALSE otherwise.
* @return TRUE|FALSE
*/
function authenticated() {
return $this->session->get_var("authenticated");
}
/**
* Authenticates a HRDI admin.
* A method that authenticates a user against the HRDI_Users table.
* @param string $email The user's e-mail
* @param string $password The user's password
* @return TRUE|FALSEStatus of the authentication attempt
*/
function authenticate($email, $password) {
$email = trim(strtolower($email));
$password = trim(stripslashes($password));
// Verify the e-mail format
if (!$this->verify_email($email)) {
$this->error = "E-mail address is not valid";
return FALSE;
}
$sql = "SELECT *
FROM HRDI_Users
WHERE Email='$email'
AND Password=MD5('$password')";
if ($data = $this->hdb->get_row($sql)) {
// Authentication successful
$this->session->set_var('authenticated', TRUE);
$this->session->set_var("user_data", $data);
return TRUE;
} else {
// Authentication failed
$this->error = "Invalid email or password";
return FALSE;
}
}
/**
* Registers a new user.
* This function is responsible for registering a new user. It adds an entry
* to the HRDI_Users table.
* @param array $data New user data
* @return TRUE|FALSE
*/
function register($data) {
// Clean and verify the user data
if (!$this->clean_and_verify($data, "register")) {
return FALSE;
}
$data["Password"] = md5($data["Password"]);
unset($data["Password2"]);
return $this->hdb->add($data, "HRDI_Users");
}
/**
* Checks validity of an e-mail.
* This function checks the validity of an e-mail address by using a
* regular expression.
* @param string E-mail address
* @return TRUE|FALSETRUE if e-mail is valid, FALSE otherwise
*/
function verify_email($email) {
return preg_match("/{$this->email_regexp}/", $email);
}
/**
* Updates the current user's data.
* This function is responsible for updating the current user's data.
* @param array $data New user data
* @return TRUE|FALSE
*/
function update($data) {
// Clean and verify user data
if (!$this->clean_and_verify($data, "update")) {
return FALSE;
}
unset($data["Email"]);
unset($data["Password2"]);
if (!strlen($data["Password"])) {
unset($data["Password"]);
} else {
$data["Password"] = md5($data["Password"]);
}
if ($this->hdb->update($data, "HRDI_Users", "ID")) {
/* If the update succeeds, we need to update the data that stored in
* the session variable as well. This way, we don't need to log out
* and log back in for the changes to take place.
*/
$d = $this->session->get_var("user_data");
foreach ($data as $k => $v) {
$d[$k] = $v;
}
// Set the updated data, but only the keys that were there before
$this->session->set_var("user_data", $d);
return TRUE;
} else {
return FALSE;
}
}
/**
* Cleans and verifies user data.
* This function cleans and verifies user data for new or current users.
* @param array $data User data
* @param string $type Type of verification, one of "register" or "update"
* @return TRUE|FALSE
*/
function clean_and_verify(&$data, $type) {
global $check_dns;
if ($type == "register") {
// If we're registering, clean the e-mail
$data['Email'] = trim(strtolower($data['Email']));
$sql = "SELECT *
FROM HRDI_Users
WHERE Email='{$data['Email']}'";
if ($exists = $this->hdb->get_row($sql)) {
$this->error = "The e-mail address is already registered";
return FALSE;
}
}
// Clean the first name, last name, password 1 and 2
$data['Firstname'] = trim(stripslashes($data['Firstname']));
$data['Lastname'] = trim(stripslashes($data['Lastname']));
$data['Password'] = trim(stripslashes($data['Password']));
$data['Password2'] = trim(stripslashes($data['Password2']));
if ($type == "register") {
// If we're registering, verify the e-mail format
if (!$this->verify_email($data['Email'])) {
$this->error = "E-mail address is not valid";
return FALSE;
}
if ($check_dns) {
// If we're checking DNS, extract the domain from the e-mail
list($uname, $domain) = split('@', $data['Email']);
// Look up the domain in DNS
if (!checkdnsrr($domain)) {
$this->error = "DNS lookup failed for the domain $domain";
return FALSE;
}
}
}
// Make sure we have a first name
if (!strlen($data['Firstname'])) {
$this->error = "First name cannot be empty";
return FALSE;
}
// Make sure we have a last name
if (!strlen($data['Lastname'])) {
$this->error = "Last name cannot be empty";
return FALSE;
}
if ($type == "register") {
// If we're registering, we better have a password
if (!strlen($data['Password'])) {
$this->error = "Password cannot be empty";
return FALSE;
}
}
// Verify that the passwords are the same
if ($data['Password'] != $data['Password2']) {
$this->error = "Passwords do not match";
return FALSE;
}
return TRUE;
}
/**
* Resets a user's password.
* This function verifies that the e-mail exists in the database and resets
* the password to a random one. It then e-mails the user with the new
* password.
* @param array $data Data array containing the e-mail address
* @return TRUE|FALSE
*/
function reset_password($data) {
global $hrdi_admin, $pass_length, $mail_from, $mail_subject, $mail_message;
// Clean the e-mail for the database lookup
$data['Email'] = trim(strtolower($data['Email']));
// Verify the e-mail format
if (!$this->verify_email($data['Email'])) {
$this->error = "E-mail address is not valid";
return FALSE;
}
$sql = "SELECT ID,Email
FROM HRDI_Users
WHERE Email='{$data['Email']}'
LIMIT 1";
if ($info = $this->hdb->get_row($sql)) {
// We found the e-mail, all is well. Now let's generate a new password.
$password = $this->generate_password($pass_length);
$data['ID'] = $info['ID'];
$data['Password'] = md5($password);
// Update the database with the new password
if (!$this->hdb->update($data, "HRDI_Users", "ID")) {
return FALSE;
}
// Place the generated password in the e-mail body
$mail_message = str_replace("RANDOM_PASS", $password, $mail_message);
// Add the e-mail headers
$headers = "From: $mail_from\r\n";
// Send out the e-mail
if (mail($info['Email'], $mail_subject, $mail_message, $headers)) {
return TRUE;
} else {
$this->error = "The e-mail failed to send. Please contact
<a href=\"mailto:$hrdi_admin\">$hrdi_admin</a>
to report the problem.";
return FALSE;
}
} else {
$this->error = "That e-mail is not registered";
return FALSE;
}
}
/**
* Generates a random password.
* This function generates a random password $length characters in length.
* It generates the password from the set of valid letters and numbers.
* @param string $length Desired length of the random password
* @return string The random password
*/
function generate_password($length) {
// Valid numbers
$numbers = "1234567890";
// Valid letters
$letters = "abcdefghijklmnopqrstuvwxyz";
$password = "";
// Generate the random password of length $length
for ($i = 0; $i < $length; $i++) {
if ($i % 4) {
// Insert a number every 4th letter. This can be changed.
$rn = mt_rand(0, (strlen($letters) - 1));
$password .= substr($letters, $rn, 1);
} else {
// Insert a letter
$rn = mt_rand(0, (strlen($numbers) - 1));
$password .= substr($numbers, $rn, 1);
}
}
// Shuffle the characters arround and return the password
return str_shuffle($password);
}
/**
* Getter for the user id.
* This function returns the user id of the authenticated user.
* @return integer User id
*/
function get_user_id() {
return $this->data['ID'];
}
/**
* Checks if the user is an admin.
* This function returns TRUE if the user has admin privileges.
* @return TRUE|FALSE
*/
function is_admin() {
return $this->data["Admin"];
}
/**
* Logs the user out.
* This function logs the user out by destroying the session.
*/
function logout() {
session_destroy();
}
}

Source for file user_class.php