/application/admin/models/User.php

<?php

/**

 * Digitalus CMS

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://digitalus-media.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to info@digitalus-media.com so we can send you a copy immediately.

 *

 * @category    Digitalus CMS

 * @package     Digitalus_CMS_Models

 * @copyright   Copyright (c) 2007 - 2010,  Digitalus Media USA (digitalus-media.com)

 * @license     http://digitalus-media.com/license/new-bsd     New BSD License

 * @version     $Id: User.php Mon Dec 24 20:38:38 EST 2007 20:38:38 forrest lyman $

 * @link        http://www.digitaluscms.com

 * @since       Release 1.5

 */



/**

 * @see Digitalus_Db_Table

 */

require_once 'Digitalus/Db/Table.php';



/**

 * User model

 *

 * @copyright   Copyright (c) 2007 - 2010,  Digitalus Media USA (digitalus-media.com)

 * @license     http://digitalus-media.com/license/new-bsd     New BSD License

 * @version     Release: @package_version@

 * @link        http://www.digitaluscms.com

 * @since       Release 1.5

 */

class Model_User extends Digitalus_Db_Table

{

    /**

     * The role of the superuser

     */

    const SUPERUSER_ROLE = 'superadmin';



    /**

     * the maximum lenght for user names (must correspond to length in database)

     */

    const USERNAME_LENGTH = 30;

    /**

     * the regex that the userName will be checked against

     */

    const USERNAME_REGEX = '/^[0-9\p{L}`\'´ ]*$/u';

    /**

     * this is the error message that will be displayed if the userName doesn't match the regex

     */

    const USERNAME_REGEX_NOTMATCH = 'Please only use alphanumeric characters, `\'´ and empty space!';



    /**

     * table name

     *

     * @var string

     */

    protected $_name = 'users';



    protected $_primary = 'name';



    public function createUser($userName, $firstName, $lastName, $email, $password, $active = 0, $role = Model_Group::GUEST_ROLE)

    {

        $data = array(

            'active'     => $active,

            'name'       => $userName,

            'first_name' => $firstName,

            'last_name'  => $lastName,

            'email'      => $email,

            'password'   => md5($password),

            'role'       => $role,

        );

        if (!$this->userExists($userName)) {

            return $this->insert($data);

        }

        return false;

    }



    public function updatePassword($userName, $password, $confirmationRequire = true, $confirmation = null)

    {

        $person = $this->find($userName)->current();

        if ($person) {

            if ($confirmationRequire == true) {

                if ($confirmation != $password) {

                    return false;

                }

            }

            $person->password = md5($password);



            $result = $person->save();

            return $result;

        }

        return false;

    }



    public function updateAclResources($userName, $resourceArray)

    {

        $data['acl_resources'] = serialize($resourceArray);

        $where[] = $this->_db->quoteInto('name = ?', $userName);

        return $this->update($data, $where);

    }



    public function getAclResources($userRowset)

    {

        $role = Model_Group::GUEST_ROLE;

        if (isset($userRowset->role) && !empty($userRowset->role)) {

            $role = $userRowset->role;

        }

        $mdlGroup = new Model_Group();

        return $mdlGroup->getAclResources($role);

    }



    /**

     * returns the complete user row for the currently logged in user

     * @return Zend_Db_Row

     */

    public function getCurrentUser()

    {

        $currentUser = Digitalus_Auth::getIdentity();

        if (!empty($currentUser) && isset($currentUser->name) && Model_Group::GUEST_ROLE != $currentUser->name) {

            return $this->find($currentUser->name)->current();

        } else {

            return $currentUser;

        }

    }



    public function getCurrentUsersAclResources()

    {

        $currentUser = $this->getCurrentUser();

        if (!empty($currentUser)) {

            return $this->getAclResources($currentUser);

        }

    }



    public function getCurrentUsersModules()

    {

        return $this->getUsersModules($this->getCurrentUser());

    }



    public function getUsersModules($userRowset)

    {

        $modules = null;

        $user = $this->getCurrentUser();

        if ($user->role == Model_User::SUPERUSER_ROLE) {

            //the superadmin has access to all of the modules

            $front = Zend_Controller_Front::getInstance();

            $ctlPaths = $front->getControllerDirectory();

            foreach ($ctlPaths as $module => $path) {

                if (substr($module, 0, 4) == 'mod_') {

                    $modules[] = str_replace('mod_', '', $module);

                }

            }

        } else {

            $resources = $this->getAclResources($userRowset);

            if (is_array($resources)) {

                foreach ($resources as $k => $v) {

                    if (1 == $v ) {

                        $parts = explode('_', $k);

                        if ('mod' == $parts[0]) {

                            $key = $parts[1];

                            $modules[$key] = $key;

                        }

                    }

                }

            }

        }

        if (is_array($modules)) {

            return $modules;

        }

    }



    /**

     * this function queries a users permissions

     *

     * the resource should be in the module_controller_action format

     *

     * if strict = true then this requires an exact match

     * example: news_article != news_article_edit

     *

     * if strict = false then it will add wildcards

     * example: news_article == news_article_edit

     *

     * if user is not set then the query will be run on the current user

     *

     * @param string $resource

     * @param boolean $strict

     * @param integer $user

     * @return boolean

     */

    public function queryPermissions($resource, $strict = false, $userName = null)

    {

        if ($userName !== null) {

            $user = $this->find($userName)->current();

            if (!$user) {

                return false;

            }

            $resources = $this->getAclResources($user);

        } else {

            $resources = $this->getCurrentUsersAclResources();

        }



        if (is_array($resources)) {

            if ($strict) {

                if (array_key_exists($resource, $resources) && 1 == $resources[$resource]) {

                    return true;

                }

            } else {

                $len = strlen($resource);

                foreach ($resources as $r => $v) {

                    if (1 == $v && $resource == substr($r, 0, $len)) {

                        return true;

                    }

                }

            }

        }

        return false;

    }



    public function getUserFullNameByUsername($userName, $format = null)

    {

        $user = $this->getUserByUsername($userName);

        switch ((string)strtolower($format)) {

            case 'firstname':

                return $user->first_name;

            case 'lastname':

                return $user->last_name;

            default:

                return $user->first_name . ' ' . $user->last_name;

        }

    }



    public function getGroupByUsername($userName)

    {

        if (Model_Group::GUEST_ROLE == $userName) {

            return Model_Group::GUEST_ROLE;

        }

        $select = $this->select();

        $select->from($this->_name, array('name', 'role'))

               ->where($this->_db->quoteInto('name = ?', $userName));

        $user = $this->fetchRow($select);

        return $user->role;

    }



    public function getUserByUsername($userName)

    {

        $where[] = $this->_db->quoteInto('name = ?', $userName);

        return $this->fetchRow($where);

    }



    public function getUserByEmail($email)

    {

        $where[] = $this->_db->quoteInto('email = ?', $userName);

        return $this->fetchRow($where);

    }



    public function getUserByOpenId($openId)

    {

        $where[] = $this->_db->quoteInto('openid = ?', $openId);

        return $this->fetchRow($where);

    }



    /**

     * @since 0.8.7

     *

     * returns a hash of the current users

     * their name is the key and their first_name . ' ' . last_name is the value

     *

     */

    public function getUserNamesArray()

    {

        $select = $this->select();

        $select->from($this->_name, array('name', 'first_name', 'last_name'));

        $users = $this->fetchAll($select);

        foreach ($users as $user) {

            $usersArray[$user->name] = $user->first_name . ' ' . $user->last_name;

        }

        return $usersArray;

    }



    /**

     * @since 1.10.0

     *

     * returns the current users

     *

     */

    public function getUsers($selectItems = null)

    {

        $select = $this->select();

        $select->from($this->_name, array_map('trim', explode(',', $selectItems)))

               ->order('name ASC');

        $users = $this->fetchAll($select);

        return $users;

    }



    public function copyPermissions($from, $to)

    {

        $fromUser = $this->find($from)->current();

        $toUser = $this->find($to)->current();

        $toUser->acl_resources = $fromUser->acl_resources;

        return $toUser->save();

    }



    /**

     * This function checks if a user already exists

     *

     * @param  string  $userName  The name to check for

     * @param  string  $exclude   Usernames to exclude from check

     * @return boolean

     */

    public function userExists($userName, $exclude = null)

    {

        $userName = strtolower($userName);

        if (!is_array($exclude)) {

            $exclude = array($exclude);

        }



        $where[] = $this->_db->quoteInto('LOWER(name) = ?', $userName);

        foreach ($exclude as $exclusion) {

            $exclusion = trim($exclusion);

            if (isset($exclusion) && !empty($exclusion) && '' != $exclusion) {

                $where[] = $this->_db->quoteInto('LOWER(name) != ?', $exclusion);

            }

        }

        $result = $this->fetchAll($where, null, 1);

        if ($result->count() > 0) {

            return true;

        }

        return false;

    }



    /**

     * This function checks if a specified openId already exists

     *

     * @param  string  $openId  The openId to check for

     * @return boolean

     */

    public function openIdExists($openId)

    {

        $openId = strtolower($openId);



        $where[] = $this->_db->quoteInto('LOWER(openid) = ?', $openId);

        $result = $this->fetchAll($where, null, 1);

        if ($result->count() > 0) {

            return true;

        }

        return false;

    }



    /**

     * This function checks if a specified email belongs to a given user name

     *

     * @param  string  $userName The user name

     * @param  string  $email    The email address

     * @return boolean

     */

    public function userEmailExists($userName, $email)

    {

        $userName = strtolower($userName);

        $email    = strtolower($email);



        $where[] = $this->_db->quoteInto('LOWER(name)  = ?', $userName);

        $where[] = $this->_db->quoteInto('LOWER(email) = ?', $email);

        $result = $this->fetchAll($where, null, 1);

        if ($result->count() > 0) {

            return true;

        }

        return false;

    }



    /**

     * This function checks if a user has already been activated

     *

     * @param  int $userName The name to check

     * @return boolean

     */

    public function isActive($userName)

    {

        $where[] = $this->_db->quoteInto('name = ?', $userName);

        $where[] = $this->_db->quoteInto('active = ?', 1, 'TINYINT');

        $result = $this->fetchAll($where, null, 1);

        if ($result->count() > 0) {

            return true;

        }

        return false;

    }



    /**

     * This function activates a user

     *

     * @param  int $userName The name to activate

     * @return int Number of rows updated

     */

    public function activate($userName)

    {

        $data['active'] = 1;

        $where[] = $this->_db->quoteInto('name = ?', $userName);

        if ($this->isActive($userName) || $this->update($data, $where)) {

            return true;

        }

        return false;

    }



    /**

     * This function deactivates a user

     *

     * @param  int $userName The name to deactivate

     * @return int Number of rows updated

     */

    public function deactivate($userName)

    {

        $data['active'] = 0;

        $where[] = $this->_db->quoteInto('name = ?', $userName);

        if (!$this->isActive($userName) || $this->update($data, $where)) {

            return true;

        }

        return false;

    }

}