classes/user/UserDAO.inc.php

<?php

// $Id: UserDAO.inc.php,v 1.46 2008/07/01 01:16:11 asmecher Exp $


import('user.User');

/* These constants are used user-selectable search fields. */
define('USER_FIELD_USERID', 'user_id');
define('USER_FIELD_FIRSTNAME', 'first_name');
define('USER_FIELD_LASTNAME', 'last_name');
define('USER_FIELD_USERNAME', 'username');
define('USER_FIELD_EMAIL', 'email');
define('USER_FIELD_URL', 'url');
define('USER_FIELD_INTERESTS', 'interests');
define('USER_FIELD_INITIAL', 'initial');
define('USER_FIELD_NONE', null);

class UserDAO extends DAO {
   function &getUser($userId, $allowDisabled = true) {
      $result = &$this->retrieve(
         'SELECT * FROM users WHERE user_id = ?' . ($allowDisabled?'':' AND disabled = 0'), $userId
      );

      $user = null;
      if ($result->RecordCount() != 0) {
         $user = &$this->_returnUserFromRowWithData($result->GetRowAssoc(false));
      }
      $result->Close();
      unset($result);
      return $user;
   }

   function &getUserByUsername($username, $allowDisabled = true) {
      $result = &$this->retrieve(
         'SELECT * FROM users WHERE username = ?' . ($allowDisabled?'':' AND disabled = 0'), $username
      );

      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = &$this->_returnUserFromRowWithData($result->GetRowAssoc(false));
      }
      $result->Close();
      unset($result);
      return $returner;
   }

   function &getUserByAuthStr($authstr, $allowDisabled = true) {
      $result = &$this->retrieve(
         'SELECT * FROM users WHERE auth_str = ?' . ($allowDisabled?'':' AND disabled = 0'), $authstr
      );

      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = &$this->_returnUserFromRowWithData($result->GetRowAssoc(false));
      }
      $result->Close();
      unset($result);
      return $returner;
   }

   function &getUserByEmail($email, $allowDisabled = true) {
      $result = &$this->retrieve(
         'SELECT * FROM users WHERE email = ?' . ($allowDisabled?'':' AND disabled = 0'), $email
      );

      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = &$this->_returnUserFromRowWithData($result->GetRowAssoc(false));
      }
      $result->Close();
      unset($result);
      return $returner;
   }

   function &getUserByCredentials($username, $password, $allowDisabled = true) {
      $result = &$this->retrieve(
         'SELECT * FROM users WHERE username = ? AND password = ?' . ($allowDisabled?'':' AND disabled = 0'), array($username, $password)
      );

      $returner = null;
      if ($result->RecordCount() != 0) {
         $returner = &$this->_returnUserFromRowWithData($result->GetRowAssoc(false));
      }
      $result->Close();
      unset($result);
      return $returner;
   }

   function &_returnUserFromRowWithData(&$row) {
      $user =& $this->_returnUserFromRow($row, false);
      $this->getDataObjectSettings('user_settings', 'user_id', $row['user_id'], $user);

      HookRegistry::call('UserDAO::_returnUserFromRowWithData', array(&$user, &$row));

      return $user;
   }

   function &_returnUserFromRow(&$row, $callHook = true) {
      $user = &new User();
      $user->setUserId($row['user_id']);
      $user->setUsername($row['username']);
      $user->setPassword($row['password']);
      $user->setSalutation($row['salutation']);
      $user->setFirstName($row['first_name']);
      $user->setMiddleName($row['middle_name']);
      $user->setInitials($row['initials']);
      $user->setLastName($row['last_name']);
      $user->setGender($row['gender']);
      $user->setAffiliation($row['affiliation']);
      $user->setEmail($row['email']);
      $user->setUrl($row['url']);
      $user->setPhone($row['phone']);
      $user->setFax($row['fax']);
      $user->setMailingAddress($row['mailing_address']);
      $user->setCountry($row['country']);
      $user->setLocales(isset($row['locales']) && !empty($row['locales']) ? explode(':', $row['locales']) : array());
      $user->setDateLastEmail($this->datetimeFromDB($row['date_last_email']));
      $user->setDateRegistered($this->datetimeFromDB($row['date_registered']));
      $user->setDateValidated($this->datetimeFromDB($row['date_validated']));
      $user->setDateLastLogin($this->datetimeFromDB($row['date_last_login']));
      $user->setDateEndMembership($this->datetimeFromDB($row['date_end_membership']));
      $user->setMustChangePassword($row['must_change_password']);
      $user->setDisabled($row['disabled']);
      $user->setDisabledReason($row['disabled_reason']);
      $user->setAuthId($row['auth_id']);
      $user->setAuthStr($row['auth_str']);

      if ($callHook) HookRegistry::call('UserDAO::_returnUserFromRow', array(&$user, &$row));

      return $user;
   }

   function insertUser(&$user) {
      if ($user->getDateRegistered() == null) {
         $user->setDateRegistered(Core::getCurrentDate());
      }
      if ($user->getDateLastLogin() == null) {
         $user->setDateLastLogin(Core::getCurrentDate());
      }
      $this->update(
         sprintf('INSERT INTO users
            (username, password, salutation, first_name, middle_name, initials, last_name, gender, affiliation, email, url, phone, fax, mailing_address, country, locales, date_last_email, date_registered, date_validated, date_last_login, date_end_membership, must_change_password, disabled, disabled_reason, auth_id, auth_str)
            VALUES
            (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, %s, %s, %s, %s, %s, ?, ?, ?, ?, ?)',
            $this->datetimeToDB($user->getDateLastEmail()), $this->datetimeToDB($user->getDateRegistered()), $this->datetimeToDB($user->getDateValidated()), $this->datetimeToDB($user->getDateLastLogin()), $this->datetimeToDB($user->getDateEndMembership())),
         array(
            $user->getUsername(),
            $user->getPassword(),
            $user->getSalutation(),
            $user->getFirstName(),
            $user->getMiddleName(),
            $user->getInitials(),
            $user->getLastName(),
            $user->getGender(),
            $user->getAffiliation(),
            $user->getEmail(),
            $user->getUrl(),
            $user->getPhone(),
            $user->getFax(),
            $user->getMailingAddress(),
            $user->getCountry(),
            join(':', $user->getLocales()),
            $user->getMustChangePassword(),
            $user->getDisabled() ? 1 : 0,
            $user->getDisabledReason(),
            $user->getAuthId(),
            $user->getAuthStr()
         )
      );

      $user->setUserId($this->getInsertUserId());
      $this->updateLocaleFields($user);
      return $user->getUserId();
   }

   function getLocaleFieldNames() {
      return array('biography', 'signature', 'interests');
   }

   function updateLocaleFields(&$user) {
      $this->updateDataObjectSettings('user_settings', $user, array(
         'user_id' => $user->getUserId()
      ));
   }

   function updateUser(&$user) {          
      if ($user->getDateLastLogin() == null) {
         $user->setDateLastLogin(Core::getCurrentDate());
      }

      $this->updateLocaleFields($user);

      return $this->update(
         sprintf('UPDATE users
            SET
               username = ?,
               password = ?,
               salutation = ?,
               first_name = ?,
               middle_name = ?,
               initials = ?,
               last_name = ?,
               gender = ?,
               affiliation = ?,
               email = ?,
               url = ?,
               phone = ?,
               fax = ?,
               mailing_address = ?,
               country = ?,
               locales = ?,
               date_last_email = %s,
               date_validated = %s,
               date_last_login = %s,
               date_end_membership = %s,     
               must_change_password = ?,
               disabled = ?,
               disabled_reason = ?,
               auth_id = ?, 
               auth_str = ?
            WHERE user_id = ?',
            $this->datetimeToDB($user->getDateLastEmail()), $this->datetimeToDB($user->getDateValidated()), $this->datetimeToDB($user->getDateLastLogin()), $this->dateToDB($user->getDateEndMembership())),
         array(
            $user->getUsername(),
            $user->getPassword(),
            $user->getSalutation(),
            $user->getFirstName(),
            $user->getMiddleName(),
            $user->getInitials(),
            $user->getLastName(),
            $user->getGender(),
            $user->getAffiliation(),
            $user->getEmail(),
            $user->getUrl(),
            $user->getPhone(),
            $user->getFax(),
            $user->getMailingAddress(),
            $user->getCountry(),
            join(':', $user->getLocales()),
            $user->getMustChangePassword(),
            $user->getDisabled()?1:0,
            $user->getDisabledReason(),
            $user->getAuthId(),
            $user->getAuthStr(),
            $user->getUserId(),
         )
      );
   }

   function renewMembership(&$user){
      $dateEnd = ($user->getDateEndMembership())?strtotime($user->getDateEndMembership()):0;
      
      // if the membership is expired, extend it to today + 1 year
      $time = time();
      if ($dateEnd < $time ) $dateEnd = $time;

      $user->setDateEndMembership(mktime(23, 59, 59, date("m", $dateEnd), date("d", $dateEnd), date("Y", $dateEnd)+1));
      $this->updateUser($user);
   }

   function deleteUser(&$user) {
      return $this->deleteUserById($user->getUserId());
   }

   function deleteUserById($userId) {
      $this->update('DELETE FROM user_settings WHERE user_id = ?', $userId);
      return $this->update('DELETE FROM users WHERE user_id = ?', $userId);
   }

   function getUserFullName($userId, $allowDisabled = true) {
      $result = &$this->retrieve(
         'SELECT first_name, middle_name, last_name FROM users WHERE user_id = ?' . ($allowDisabled?'':' AND disabled = 0'),
         $userId
      );

      if($result->RecordCount() == 0) {
         $returner = false;
      } else {
         $returner = $result->fields[0] . ' ' . (empty($result->fields[1]) ? '' : $result->fields[1] . ' ') . $result->fields[2];
      }

      $result->Close();
      unset($result);

      return $returner;
   }

   function getUserEmail($userId, $allowDisabled = true) {
      $result = &$this->retrieve(
         'SELECT email FROM users WHERE user_id = ?' . ($allowDisabled?'':' AND disabled = 0'),
         $userId
      );

      if($result->RecordCount() == 0) {
         $returner = false;
      } else {
         $returner = $result->fields[0];
      }

      $result->Close();
      unset($result);

      return $returner;
   }

   function &getUsersByField($field = USER_FIELD_NONE, $match = null, $value = null, $allowDisabled = true, $dbResultRange = null) {
      $sql = 'SELECT * FROM users u';
      switch ($field) {
         case USER_FIELD_USERID:
            $sql .= ' WHERE u.user_id = ?';
            $var = $value;
            break;
         case USER_FIELD_USERNAME:
            $sql .= ' WHERE LOWER(u.username) ' . ($match == 'is' ? '=' : 'LIKE') . ' LOWER(?)';
            $var = $match == 'is' ? $value : "%$value%";
            break;
         case USER_FIELD_INITIAL:
            $sql .= ' WHERE LOWER(u.last_name) LIKE LOWER(?)';
            $var = "$value%";
            break;
         case USER_FIELD_INTERESTS:
            $sql .= ', user_settings us WHERE us.user_id = u.user_id AND u.setting_name = \'interests\' AND LOWER(us.setting_value) ' . ($match == 'is' ? '=' : 'LIKE') . ' LOWER(?)';
            $var = $match == 'is' ? $value : "%$value%";
            break;
         case USER_FIELD_EMAIL:
            $sql .= ' WHERE LOWER(u.email) ' . ($match == 'is' ? '=' : 'LIKE') . ' LOWER(?)';
            $var = $match == 'is' ? $value : "%$value%";
            break;
         case USER_FIELD_URL:
            $sql .= ' WHERE LOWER(u.url) ' . ($match == 'is' ? '=' : 'LIKE') . ' LOWER(?)';
            $var = $match == 'is' ? $value : "%$value%";
            break;
         case USER_FIELD_FIRSTNAME:
            $sql .= ' WHERE LOWER(u.first_name) ' . ($match == 'is' ? '=' : 'LIKE') . ' LOWER(?)';
            $var = $match == 'is' ? $value : "%$value%";
            break;
         case USER_FIELD_LASTNAME:
            $sql .= ' WHERE LOWER(u.last_name) ' . ($match == 'is' ? '=' : 'LIKE') . ' LOWER(?)';
            $var = $match == 'is' ? $value : "%$value%";
            break;
      }

      $orderSql = ' ORDER BY u.last_name, u.first_name'; // FIXME Add "sort field" parameter?

      if ($field != USER_FIELD_NONE) $result = &$this->retrieveRange($sql . ($allowDisabled?'':' AND u.disabled = 0') . $orderSql, $var, $dbResultRange);
      else $result = &$this->retrieveRange($sql . ($allowDisabled?'':' WHERE u.disabled = 0') . $orderSql, false, $dbResultRange);

      $returner = &new DAOResultFactory($result, $this, '_returnUserFromRowWithData');
      return $returner;
   }

   function userExistsById($userId, $allowDisabled = true) {
      $result = &$this->retrieve(
         'SELECT COUNT(*) FROM users WHERE user_id = ?' . ($allowDisabled?'':' AND disabled = 0'), $userId
      );
      $returner = isset($result->fields[0]) && $result->fields[0] != 0 ? true : false;

      $result->Close();
      unset($result);

      return $returner;
   }

   function userExistsByUsername($username, $userId = null, $allowDisabled = true) {
      $result = &$this->retrieve(
         'SELECT COUNT(*) FROM users WHERE username = ?' . (isset($userId) ? ' AND user_id != ?' : '') . ($allowDisabled?'':' AND disabled = 0'),
         isset($userId) ? array($username, $userId) : $username
      );
      $returner = isset($result->fields[0]) && $result->fields[0] == 1 ? true : false;

      $result->Close();
      unset($result);

      return $returner;
   }

   function userExistsByEmail($email, $userId = null, $allowDisabled = true) {
      $result = &$this->retrieve(
         'SELECT COUNT(*) FROM users WHERE email = ?' . (isset($userId) ? ' AND user_id != ?' : '') . ($allowDisabled?'':' AND disabled = 0'),
         isset($userId) ? array($email, $userId) : $email
      );
      $returner = isset($result->fields[0]) && $result->fields[0] == 1 ? true : false;

      $result->Close();
      unset($result);

      return $returner;
   }

   function getInsertUserId() {
      return $this->getInsertId('users', 'user_id');
   }
}

?>

---