Skip to content
Snippets Groups Projects
class.staff.php 29.7 KiB
Newer Older
Jared Hancock's avatar
Jared Hancock committed
<?php
/*********************************************************************
    class.staff.php

    Everything about staff.

    Peter Rotich <peter@osticket.com>
    Copyright (c)  2006-2013 osTicket
Jared Hancock's avatar
Jared Hancock committed
    http://www.osticket.com

    Released under the GNU General Public License WITHOUT ANY WARRANTY.
    See LICENSE.TXT for details.

    vim: expandtab sw=4 ts=4 sts=4:
**********************************************************************/
include_once(INCLUDE_DIR.'class.ticket.php');
Jared Hancock's avatar
Jared Hancock committed
include_once(INCLUDE_DIR.'class.dept.php');
include_once(INCLUDE_DIR.'class.error.php');
Jared Hancock's avatar
Jared Hancock committed
include_once(INCLUDE_DIR.'class.team.php');
include_once(INCLUDE_DIR.'class.role.php');
Jared Hancock's avatar
Jared Hancock committed
include_once(INCLUDE_DIR.'class.group.php');
include_once(INCLUDE_DIR.'class.passwd.php');
include_once(INCLUDE_DIR.'class.user.php');
Jared Hancock's avatar
Jared Hancock committed
include_once(INCLUDE_DIR.'class.auth.php');
Jared Hancock's avatar
Jared Hancock committed
class Staff extends VerySimpleModel
implements AuthenticatedUser, EmailContact, TemplateVariable {
    static $meta = array(
        'table' => STAFF_TABLE,
        'pk' => array('staff_id'),
        'joins' => array(
            'dept' => array(
                'constraint' => array('dept_id' => 'Dept.id'),
            'role' => array(
                'constraint' => array('role_id' => 'Role.id'),
            ),
Jared Hancock's avatar
Jared Hancock committed
            'group' => array(
                'constraint' => array('group_id' => 'Group.id'),
Jared Hancock's avatar
Jared Hancock committed
            'teams' => array(
Peter Rotich's avatar
Peter Rotich committed
                'null' => true,
                'list' => true,
                'reverse' => 'TeamMember.staff',
Jared Hancock's avatar
Jared Hancock committed
            ),
Jared Hancock's avatar
Jared Hancock committed
    var $authkey;
Peter Rotich's avatar
Peter Rotich committed
    var $departments;
Jared Hancock's avatar
Jared Hancock committed
    var $stats = array();
    var $_extra;
Jared Hancock's avatar
Jared Hancock committed
    var $passwd_change;
    var $_roles = null;
Peter Rotich's avatar
Peter Rotich committed
    var $_teams = null;
Jared Hancock's avatar
Jared Hancock committed
    function __onload() {
Jared Hancock's avatar
Jared Hancock committed
        // WE have to patch info here to support upgrading from old versions.
        $time = null;
        if (isset($this->passwdreset) && $this->passwdreset)
            $time=strtotime($this->passwdreset);
        elseif (isset($this->added) && $this->added)
            $time=strtotime($this->added);

        if ($time)
Jared Hancock's avatar
Jared Hancock committed
            $this->passwd_change = time()-$time; //XXX: check timezone issues.
Peter Rotich's avatar
Peter Rotich committed
    function __toString() {
        return (string) $this->getName();
    }

    function asVar() {
Peter Rotich's avatar
Peter Rotich committed
        return $this->__toString();
    static function getVarScope() {
      return array(
        'dept' => array('class' => 'Dept', 'desc' => __('Department')),
        'email' => __('Email Address'),
        'name' => array(
          'class' => 'PersonsName', 'desc' => __('Agent name'),
        'mobile' => __('Mobile Number'),
        'phone' => __('Phone Number'),
        'signature' => __('Signature'),
        'timezone' => "Agent's configured timezone",
        'username' => 'Access username',
    function getVar($tag) {
        switch ($tag) {
        case 'mobile':
            return Format::phone($this->ht['mobile']);
        case 'phone':
            return Format::phone($this->ht['phone']);
        }
    }

    function getHashtable() {
        $base = $this->ht;
        $base['group'] = $base['group_id'];
        unset($base['teams']);
        return $base;
    function getInfo() {
        return $this->getHashtable();
    // AuthenticatedUser implementation...
    // TODO: Move to an abstract class that extends Staff
    function getUserType() {
        list($bk, ) = explode(':', $this->getAuthKey());

        // If administering a user other than yourself, fallback to the
        // agent's declared backend, if any
        if (!$bk && $this->backend)
            $bk = $this->backend;

        return StaffAuthenticationBackend::getBackend($bk);
Jared Hancock's avatar
Jared Hancock committed
    function setAuthKey($key) {
        $this->authkey = $key;
    }

    function getAuthKey() {
        return $this->authkey;
    }

    // logOut the user
    function logOut() {

        if ($bk = $this->getAuthBackend())
            return $bk->signOut($this);

        return false;
    }

Jared Hancock's avatar
Jared Hancock committed
    /*compares user password*/
    function check_passwd($password, $autoupdate=true) {
Jared Hancock's avatar
Jared Hancock committed

        /*bcrypt based password match*/
        if(Passwd::cmp($password, $this->getPasswd()))
Jared Hancock's avatar
Jared Hancock committed
            return true;

        //Fall back to MD5
        if(!$password || strcmp($this->getPasswd(), MD5($password)))
            return false;

        //Password is a MD5 hash: rehash it (if enabled) otherwise force passwd change.
Jared Hancock's avatar
Jared Hancock committed
        $this->passwd = Passwd::hash($password);
Jared Hancock's avatar
Jared Hancock committed
        if(!$autoupdate || !$this->save())
Jared Hancock's avatar
Jared Hancock committed
            $this->forcePasswdRest();

    function cmp_passwd($password) {
        return $this->check_passwd($password, false);
    function hasPassword() {
Jared Hancock's avatar
Jared Hancock committed
        return (bool) $this->passwd;
Jared Hancock's avatar
Jared Hancock committed
    function forcePasswdRest() {
Jared Hancock's avatar
Jared Hancock committed
        $this->change_passwd = 1;
        return $this->save();
Jared Hancock's avatar
Jared Hancock committed
    }

    /* check if passwd reset is due. */
    function isPasswdResetDue() {
Jared Hancock's avatar
Jared Hancock committed
        global $cfg;
        return ($cfg && $cfg->getPasswdResetPeriod()
Jared Hancock's avatar
Jared Hancock committed
                    && $this->passwd_change>($cfg->getPasswdResetPeriod()*30*24*60*60));
    function setPassword($new, $current=false) {
        // Allow the backend to update the password. This is the preferred
        // method as it allows for integration with password policies and
        // also allows for remotely updating the password where possible and
        // supported.
        if (!($bk = $this->getAuthBackend())
            || !$bk instanceof AuthBackend
        ) {
            // Fallback to osTicket authentication token udpates
            $bk = new osTicketAuthentication();
        }

        // And now for the magic
        if (!$bk->supportsPasswordChange()) {
            throw new PasswordUpdateFailed(
                __('Authentication backend does not support password updates'));
        }
        // Backend should throw PasswordUpdateFailed directly
        $rv = $bk->setPassword($this, $new, $current);

        // Successfully updated authentication tokens
        $this->change_passwd = 0;
        $this->cancelResetTokens();
        $this->passwdreset = SqlFunction::NOW();

        return $rv;
    function canAccess($something) {
        if ($something instanceof RestrictedAccess)
            return $something->checkStaffPerm($this);

        return true;
    }

Jared Hancock's avatar
Jared Hancock committed
    function isPasswdChangeDue() {
        return $this->isPasswdResetDue();
    }

    function getRefreshRate() {
Jared Hancock's avatar
Jared Hancock committed
        return $this->auto_refresh_rate;
Jared Hancock's avatar
Jared Hancock committed
    }

    function getPageLimit() {
Jared Hancock's avatar
Jared Hancock committed
        return $this->max_page_size;
    function getId() {
Jared Hancock's avatar
Jared Hancock committed
        return $this->staff_id;
    function getUserId() {
        return $this->getId();
    }
    function getEmail() {
Jared Hancock's avatar
Jared Hancock committed
        return $this->email;
    function getUserName() {
Jared Hancock's avatar
Jared Hancock committed
        return $this->username;
    function getPasswd() {
Jared Hancock's avatar
Jared Hancock committed
        return $this->passwd;
    function getName() {
        return new PersonsName(array('first' => $this->ht['firstname'], 'last' => $this->ht['lastname']));
    function getFirstName() {
Jared Hancock's avatar
Jared Hancock committed
        return $this->firstname;
    function getLastName() {
Jared Hancock's avatar
Jared Hancock committed
        return $this->lastname;
    function getSignature() {
Jared Hancock's avatar
Jared Hancock committed
        return $this->signature;
Jared Hancock's avatar
Jared Hancock committed
    }

    function getDefaultSignatureType() {
Jared Hancock's avatar
Jared Hancock committed
        return $this->default_signature_type;
    function getDefaultPaperSize() {
Jared Hancock's avatar
Jared Hancock committed
        return $this->default_paper_size;
    function forcePasswdChange() {
Jared Hancock's avatar
Jared Hancock committed
        return $this->change_passwd;
Peter Rotich's avatar
Peter Rotich committed
    function getDepartments() {
        // TODO: Cache this in the agent's session as it is unlikely to
        //       change while logged in
        if (!isset($this->departments)) {

            // Departments the staff is "allowed" to access...
            // based on the group they belong to + user's primary dept + user's managed depts.
            $sql='SELECT DISTINCT d.id FROM '.STAFF_TABLE.' s '
                .' LEFT JOIN '.GROUP_DEPT_TABLE.' g ON (s.group_id=g.group_id) '
                .' INNER JOIN '.DEPT_TABLE.' d ON (LOCATE(CONCAT("/", s.dept_id, "/"), d.path) OR d.manager_id=s.staff_id OR LOCATE(CONCAT("/", g.dept_id, "/"), d.path)) '
                .' WHERE s.staff_id='.db_input($this->getId());
            $depts = array();
            if (($res=db_query($sql)) && db_num_rows($res)) {
                while(list($id)=db_fetch_row($res))
                    $depts[] = $id;
            }

            /* ORM method — about 2.0ms slower
            $q = Q::any(array(
                'path__contains' => '/'.$this->dept_id.'/',
                'manager_id' => $this->getId(),
            ));
            // Add in group access
            foreach ($this->group->depts->values_flat('dept_id') as $row) {
                // Skip primary dept
                if ($row[0] == $this->dept_id)
                    continue;
                $q->add(new Q(array('path__contains'=>'/'.$row[0].'/')));
            }

            $dept_ids = Dept::objects()
                ->filter($q)
                ->distinct('id')
                ->values_flat('id');

            foreach ($dept_ids as $row)
                $depts[] = $row[0];
            */
            if (!$depts) { //Neptune help us! (fallback)
                $depts = array_merge($this->getGroup()->getDepartments(), array($this->getDeptId()));
            $this->departments = $depts;

        return $this->departments;
    function getDepts() {
Peter Rotich's avatar
Peter Rotich committed
        return $this->getDepartments();
    }

    function getManagedDepartments() {

        return ($depts=Dept::getDepartments(
                    array('manager' => $this->getId())
                    ))?array_keys($depts):array();
    }
Peter Rotich's avatar
Peter Rotich committed
    function getGroupId() {
Jared Hancock's avatar
Jared Hancock committed
        return $this->group_id;
Peter Rotich's avatar
Peter Rotich committed
    function getGroup() {
        return $this->group;
    function getDeptId() {
Jared Hancock's avatar
Jared Hancock committed
        return $this->dept_id;
    function getDept() {
Jared Hancock's avatar
Jared Hancock committed
        return $this->dept;
    }

    function getLanguage() {
        return (isset($this->lang)) ? $this->lang : false;
    function getTimezone() {
Jared Hancock's avatar
Jared Hancock committed
        return $this->timezone;
    }

    function getLocale() {
        //XXX: isset is required here to avoid possible crash when upgrading
        // installation where locale column doesn't exist yet.
        return isset($this->locale) ? $this->locale : 0;
    function getRole($dept=null) {
        $deptId = is_object($dept) ? $dept->getId() : $dept;
        if ($deptId && $deptId != $this->dept_id) {
            if (isset($this->_roles[$deptId]))
                return $this->_roles[$deptId];

            if (($role = $this->group->getRole($deptId)))
                return $this->_roles[$deptId] = $role;
        }
        // For the primary department, use the primary role
        return $this->role;
    function hasPerm($perm) {
        if (!isset($this->_perms)) {
            $this->_perms = array();
            foreach ($this->getDepartments() as $deptId) {
                if (($role = $this->getRole($deptId))) {
                    foreach ($role->getPermission()->getInfo() as $perm=>$v) {
                        $this->_perms[$perm] |= $v;
                    }
                }
        return @$this->_perms[$perm] ?: false;
    }

    function canManageTickets() {
        return ($this->isAdmin()
                || $this->hasPerm(TicketModel::PERM_DELETE)
                || $this->hasPerm(TicketModel::PERM_CLOSE));
    function isManager() {
Jared Hancock's avatar
Jared Hancock committed
        return (($dept=$this->getDept()) && $dept->getManagerId()==$this->getId());
    }

    function isStaff() {
Jared Hancock's avatar
Jared Hancock committed
        return TRUE;
    }

    function isGroupActive() {
        return $this->group->isEnabled();
    function isactive() {
Jared Hancock's avatar
Jared Hancock committed
        return $this->isactive;
    function isVisible() {
Jared Hancock's avatar
Jared Hancock committed
         return $this->isvisible;
    function onVacation() {
Jared Hancock's avatar
Jared Hancock committed
        return $this->onvacation;
Jared Hancock's avatar
Jared Hancock committed
    }

    function isAvailable() {
        return ($this->isactive() && $this->isGroupActive() && !$this->onVacation());
    }

    function showAssignedOnly() {
Jared Hancock's avatar
Jared Hancock committed
        return $this->assigned_only;

    function isAccessLimited() {
        return $this->showAssignedOnly();
    }
    function isAdmin() {
Jared Hancock's avatar
Jared Hancock committed
        return $this->isadmin;
Jared Hancock's avatar
Jared Hancock committed
    }

    function isTeamMember($teamId) {
        return ($teamId && in_array($teamId, $this->getTeams()));
Jared Hancock's avatar
Jared Hancock committed
    }

    function canAccessDept($deptId) {
        return ($deptId && in_array($deptId, $this->getDepts()) && !$this->isAccessLimited());
    function showAssignedTickets() {
        return $this->show_assigned_tickets;
    }

    function getTeams() {
Peter Rotich's avatar
Peter Rotich committed
        if (!isset($this->_teams)) {
            $this->_teams = array();
            foreach ($this->teams as $team)
                 $this->_teams[] = $team->team_id;
Peter Rotich's avatar
Peter Rotich committed
        return $this->_teams;
Jared Hancock's avatar
Jared Hancock committed
    }
    /* stats */

    function resetStats() {
        $this->stats = array();
    }

    /* returns staff's quick stats - used on nav menu...etc && warnings */
    function getTicketsStats() {

        if(!$this->stats['tickets'])
            $this->stats['tickets'] = Ticket::getStaffStats($this);

        return  $this->stats['tickets'];
    }

    function getNumAssignedTickets() {
        return ($stats=$this->getTicketsStats())?$stats['assigned']:0;
    }

    function getNumClosedTickets() {
        return ($stats=$this->getTicketsStats())?$stats['closed']:0;
    }

Peter Rotich's avatar
Peter Rotich committed
    function getTasksStats() {

        if (!$this->stats['tasks'])
            $this->stats['tasks'] = Task::getStaffStats($this);

        return  $this->stats['tasks'];
    }

    function getNumAssignedTasks() {
        return ($stats=$this->getTasksStats()) ? $stats['assigned'] : 0;
    }

    function getNumClosedTasks() {
        return ($stats=$this->getTasksStats()) ? $stats['closed'] : 0;
    }

    function getExtraAttr($attr=false, $default=null) {
        if (!isset($this->_extra) && isset($this->extra))
Jared Hancock's avatar
Jared Hancock committed
            $this->_extra = JsonDataParser::decode($this->extra);
        return $attr ? (@$this->_extra[$attr] ?: $default) : $this->_extra;
    }

    function setExtraAttr($attr, $value, $commit=true) {
        $this->getExtraAttr();
Jared Hancock's avatar
Jared Hancock committed
        $this->_extra[$attr] = $value;
Jared Hancock's avatar
Jared Hancock committed
            $this->extra = JsonDataEncoder::encode($this->_extra);
            $this->save();
        }
    }

    function onLogin($bk) {
        // Update last apparent language preference
        $this->setExtraAttr('browser_lang',
            Internationalization::getCurrentLanguage(),
            false);

Jared Hancock's avatar
Jared Hancock committed
        $this->lastlogin = SqlFunction::NOW();
        $this->save();
Jared Hancock's avatar
Jared Hancock committed
    //Staff profile update...unfortunately we have to separate it from admin update to avoid potential issues
    function updateProfile($vars, &$errors) {
        global $cfg;
Jared Hancock's avatar
Jared Hancock committed

        $vars['firstname']=Format::striptags($vars['firstname']);
        $vars['lastname']=Format::striptags($vars['lastname']);

Jared Hancock's avatar
Jared Hancock committed
        if (isset($this->staff_id) && $this->getId() != $vars['id'])
            $errors['err']=__('Internal error occurred');
Jared Hancock's avatar
Jared Hancock committed

        if(!$vars['firstname'])
            $errors['firstname']=__('First name is required');
Jared Hancock's avatar
Jared Hancock committed
        if(!$vars['lastname'])
            $errors['lastname']=__('Last name is required');
        if(!$vars['email'] || !Validator::is_valid_email($vars['email']))
            $errors['email']=__('Valid email is required');
Jared Hancock's avatar
Jared Hancock committed
        elseif(Email::getIdByEmail($vars['email']))
            $errors['email']=__('Already in-use as system email');
Jared Hancock's avatar
Jared Hancock committed
        elseif (($uid=static::getIdByEmail($vars['email']))
                && (!isset($this->staff_id) || $uid!=$this->getId()))
            $errors['email']=__('Email already in-use by another agent');
Jared Hancock's avatar
Jared Hancock committed

        if($vars['phone'] && !Validator::is_phone($vars['phone']))
            $errors['phone']=__('Valid phone number is required');
Jared Hancock's avatar
Jared Hancock committed

        if($vars['mobile'] && !Validator::is_phone($vars['mobile']))
            $errors['mobile']=__('Valid phone number is required');
        if($vars['passwd1'] || $vars['passwd2'] || $vars['cpasswd']) {
Jared Hancock's avatar
Jared Hancock committed

            if(!$vars['passwd1'])
                $errors['passwd1']=__('New password is required');
            elseif($vars['passwd1'] && strcmp($vars['passwd1'], $vars['passwd2']))
                $errors['passwd2']=__('Passwords do not match');
            if (($rtoken = $_SESSION['_staff']['reset-token'])) {
                $_config = new Config('pwreset');
                if ($_config->get($rtoken) != $this->getId())
                    $errors['err'] =
                        __('Invalid reset token. Logout and try again');
                elseif (!($ts = $_config->lastModified($rtoken))
                        && ($cfg->getPwResetWindow() < (time() - strtotime($ts))))
                    $errors['err'] =
                        __('Invalid reset token. Logout and try again');
            }
            elseif(!$vars['cpasswd'])
                $errors['cpasswd']=__('Current password is required');
            elseif(!$this->cmp_passwd($vars['cpasswd']))
                $errors['cpasswd']=__('Invalid current password!');
Jared Hancock's avatar
Jared Hancock committed
        }

        if($vars['default_signature_type']=='mine' && !$vars['signature'])
            $errors['default_signature_type'] = __("You don't have a signature");
        // Update the user's password if requested
        if ($vars['passwd1']) {
            try {
                $this->setPassword($vars['passwd1'], $vars['cpasswd']);
            }
            catch (BadPassword $ex) {
                $errors['passwd1'] = $ex->getMessage();
            }
            catch (PasswordUpdateFailed $ex) {
                // TODO: Add a warning banner or crash the update
            }
        }

Jared Hancock's avatar
Jared Hancock committed
        if($errors) return false;

Jared Hancock's avatar
Jared Hancock committed
        $this->firstname = $vars['firstname'];
        $this->lastname = $vars['lastname'];
        $this->email = $vars['email'];
        $this->phone = Format::phone($vars['phone']);
        $this->phone_ext = $vars['phone_ext'];
        $this->mobile = Format::phone($vars['mobile']);
        $this->signature = Format::sanitize($vars['signature']);
        $this->timezone = $vars['timezone'];
        $this->locale = $vars['locale'];
        $this->show_assigned_tickets = isset($vars['show_assigned_tickets'])?1:0;
        $this->max_page_size = $vars['max_page_size'];
        $this->auto_refresh_rate = $vars['auto_refresh_rate'];
        $this->default_signature_type = $vars['default_signature_type'];
        $this->default_paper_size = $vars['default_paper_size'];
        $this->lang = $vars['lang'];

        $_SESSION['::lang'] = null;
        TextDomain::configureForUser($this);

Jared Hancock's avatar
Jared Hancock committed
        return $this->save();
    }

    function updateTeams($team_ids) {
Peter Rotich's avatar
Peter Rotich committed

        if (is_array($team_ids)) {
            $members = TeamMember::objects()
Jared Hancock's avatar
Jared Hancock committed
                ->filter(array('staff_id' => $this->getId()));
Peter Rotich's avatar
Peter Rotich committed
            foreach ($members as $member) {
Jared Hancock's avatar
Jared Hancock committed
                if ($idx = array_search($member->team_id, $team_ids)) {
                    unset($team_ids[$idx]);
Peter Rotich's avatar
Peter Rotich committed
                } else {
Jared Hancock's avatar
Jared Hancock committed
                    $member->delete();
                }
            }
Jared Hancock's avatar
Jared Hancock committed
            foreach ($team_ids as $id) {
Peter Rotich's avatar
Peter Rotich committed
                TeamMember::create(array(
                    'staff_id'=>$this->getId(),
                    'team_id'=>$id
Jared Hancock's avatar
Jared Hancock committed
                ))->save();
Peter Rotich's avatar
Peter Rotich committed
        } else {
            TeamMember::objects()
                ->filter(array('staff_id'=>$this->getId()))
                ->delete();
Jared Hancock's avatar
Jared Hancock committed
        return true;
    }

Jared Hancock's avatar
Jared Hancock committed
    function delete() {
        global $thisstaff;
Peter Rotich's avatar
Peter Rotich committed

Jared Hancock's avatar
Jared Hancock committed
        if (!$thisstaff || $this->getId() == $thisstaff->getId())
Jared Hancock's avatar
Jared Hancock committed
            return false;

Jared Hancock's avatar
Jared Hancock committed
        if (!parent::delete())
            return false;
Peter Rotich's avatar
Peter Rotich committed
        //Update the poster and clear staff_id on ticket thread table.
        db_query('UPDATE '.THREAD_ENTRY_TABLE
                .' SET staff_id=0, poster= '.db_input($this->getName()->getOriginal())
                .' WHERE staff_id='.db_input($this->getId()));

Jared Hancock's avatar
Jared Hancock committed
        // DO SOME HOUSE CLEANING
        //Move remove any ticket assignments...TODO: send alert to Dept. manager?
        db_query('UPDATE '.TICKET_TABLE.' SET staff_id=0 WHERE staff_id='.db_input($this->getId()));
Jared Hancock's avatar
Jared Hancock committed
        //Update the poster and clear staff_id on ticket thread table.
        db_query('UPDATE '.TICKET_THREAD_TABLE
                .' SET staff_id=0, poster= '.db_input($this->getName()->getOriginal())
                .' WHERE staff_id='.db_input($this->getId()));
Jared Hancock's avatar
Jared Hancock committed
        // Cleanup Team membership table.
Peter Rotich's avatar
Peter Rotich committed
        $this->updateTeams(array());
Jared Hancock's avatar
Jared Hancock committed
        return true;
Jared Hancock's avatar
Jared Hancock committed
    }

    /**** Static functions ********/
Jared Hancock's avatar
Jared Hancock committed
    static function lookup($var) {
        if (is_array($var))
            return parent::lookup($var);
        elseif (is_numeric($var))
            return parent::lookup(array('staff_id'=>$var));
        elseif (Validator::is_email($var))
            return parent::lookup(array('email'=>$var));
        elseif (is_string($var))
            return parent::lookup(array('username'=>$var));
        else
            return null;
    }

Peter Rotich's avatar
Peter Rotich committed
    static function getStaffMembers($criteria=array()) {
Peter Rotich's avatar
Peter Rotich committed

        $members = static::objects();
Peter Rotich's avatar
Peter Rotich committed
        if (isset($criteria['available'])) {
Jared Hancock's avatar
Jared Hancock committed
            $members = $members->filter(array(
                'group__flags__hasbit' => Group::FLAG_ENABLED,
Jared Hancock's avatar
Jared Hancock committed
                'onvacation' => 0,
                'isactive' => 1,
            ));
        switch ($cfg->getDefaultNameFormat()) {
        case 'last':
        case 'lastfirst':
        case 'legal':
            $members->order_by('lastname', 'firstname');
            $members->order_by('firstname', 'lastname');
Jared Hancock's avatar
Jared Hancock committed
        $users=array();
Jared Hancock's avatar
Jared Hancock committed
        foreach ($members as $M) {
            $users[$M->getId()] = $M->getName();
    static function getAvailableStaffMembers() {
Peter Rotich's avatar
Peter Rotich committed
        return self::getStaffMembers(array('available'=>true));
Jared Hancock's avatar
Jared Hancock committed
    static function getIdByUsername($username) {
        $row = static::objects()->filter(array('username' => $username))
            ->values_flat('staff_id')->first();
        return $row ? $row[0] : 0;
    static function getIdByEmail($email) {
Jared Hancock's avatar
Jared Hancock committed
        $row = static::objects()->filter(array('email' => $email))
            ->values_flat('staff_id')->first();
        return $row ? $row[0] : 0;
Jared Hancock's avatar
Jared Hancock committed
    static function create($vars=false) {
        $staff = parent::create($vars);
        $staff->created = SqlFunction::NOW();
        return $staff;
    function cancelResetTokens() {
        // TODO: Drop password-reset tokens from the config table for
        //       this user id
        $sql = 'DELETE FROM '.CONFIG_TABLE.' WHERE `namespace`="pwreset"
            AND `value`='.db_input($this->getId());
        db_query($sql, false);
        unset($_SESSION['_staff']['reset-token']);
    }

    function sendResetEmail($template='pwreset-staff', $log=true) {
        global $ost, $cfg;

        $content = Page::lookupByType($template);
        $token = Misc::randCode(48); // 290-bits
            return new Error(/* @trans */ 'Unable to retrieve password reset email template');
        $vars = array(
            'url' => $ost->getConfig()->getBaseUrl(),
            'token' => $token,
            'recipient' => $this,
            'reset_link' => sprintf(
                "%s/scp/pwreset.php?token=%s",
                $ost->getConfig()->getBaseUrl(),
                $token),
        $vars['link'] = &$vars['reset_link'];
        if (!($email = $cfg->getAlertEmail()))
            $email = $cfg->getDefaultEmail();

        $info = array('email' => $email, 'vars' => &$vars, 'log'=>$log);
        Signal::send('auth.pwreset.email', $this, $info);

        if ($info['log'])
            $ost->logWarning(_S('Agent Password Reset'), sprintf(
             _S('Password reset was attempted for agent: %1$s<br><br>
                Requested-User-Id: %2$s<br>
                Source-Ip: %3$s<br>
                Email-Sent-To: %4$s<br>
                Email-Sent-Via: %5$s'),
                $this->getName(),
                $_POST['userid'],
                $_SERVER['REMOTE_ADDR'],
                $this->getEmail(),
                $email->getEmail()
            ), false);

Jared Hancock's avatar
Jared Hancock committed
        $lang = $this->lang ?: $this->getExtraAttr('browser_lang');
        $msg = $ost->replaceTemplateVariables(array(
            'subj' => $content->getLocalName($lang),
            'body' => $content->getLocalBody($lang),

        $_config = new Config('pwreset');
        $_config->set($vars['token'], $this->getId());
        $email->send($this->getEmail(), Format::striptags($msg['subj']),
Jared Hancock's avatar
Jared Hancock committed
    function save($refetch=false) {
        if ($this->dirty)
            $this->updated = SqlFunction::NOW();
        return parent::save($refetch || $this->dirty);
    }

    function update($vars, &$errors) {
Jared Hancock's avatar
Jared Hancock committed
        $vars['username']=Format::striptags($vars['username']);
        $vars['firstname']=Format::striptags($vars['firstname']);
        $vars['lastname']=Format::striptags($vars['lastname']);

Jared Hancock's avatar
Jared Hancock committed
        if (isset($this->staff_id) && $this->getId() != $vars['id'])
            $errors['err']=__('Internal Error');
Jared Hancock's avatar
Jared Hancock committed
        if(!$vars['firstname'])
            $errors['firstname']=__('First name required');
Jared Hancock's avatar
Jared Hancock committed
        if(!$vars['lastname'])
            $errors['lastname']=__('Last name required');
        $error = '';
        if(!$vars['username'] || !Validator::is_username($vars['username'], $error))
            $errors['username']=($error) ? $error : __('Username is required');
Jared Hancock's avatar
Jared Hancock committed
        elseif (($uid=static::getIdByUsername($vars['username']))
                && (!isset($this->staff_id) || $uid!=$this->getId()))
            $errors['username']=__('Username already in use');
Jared Hancock's avatar
Jared Hancock committed
        if(!$vars['email'] || !Validator::is_email($vars['email']))
            $errors['email']=__('Valid email is required');
Jared Hancock's avatar
Jared Hancock committed
        elseif(Email::getIdByEmail($vars['email']))
            $errors['email']=__('Already in use system email');
Jared Hancock's avatar
Jared Hancock committed
        elseif (($uid=static::getIdByEmail($vars['email']))
                && (!isset($this->staff_id) || $uid!=$this->getId()))
            $errors['email']=__('Email already in use by another agent');
Jared Hancock's avatar
Jared Hancock committed

        if($vars['phone'] && !Validator::is_phone($vars['phone']))
            $errors['phone']=__('Valid phone number is required');
Jared Hancock's avatar
Jared Hancock committed
        if($vars['mobile'] && !Validator::is_phone($vars['mobile']))
            $errors['mobile']=__('Valid phone number is required');
Peter Rotich's avatar
Peter Rotich committed
        if($vars['passwd1'] || $vars['passwd2'] || !$vars['id']) {
Jared Hancock's avatar
Jared Hancock committed
            if($vars['passwd1'] && strcmp($vars['passwd1'], $vars['passwd2'])) {
                $errors['passwd2']=__('Passwords do not match');
            elseif ($vars['backend'] != 'local' || $vars['welcome_email']) {
Jared Hancock's avatar
Jared Hancock committed
                // Password can be omitted
            }
Peter Rotich's avatar
Peter Rotich committed
            elseif(!$vars['passwd1'] && !$vars['id']) {
                $errors['passwd1']=__('Temporary password is required');
                $errors['temppasswd']=__('Required');
Jared Hancock's avatar
Jared Hancock committed
        if(!$vars['dept_id'])
            $errors['dept_id']=__('Department is required');
        if(!$vars['role_id'])
            $errors['role_id']=__('Role for primary department is required');
Jared Hancock's avatar
Jared Hancock committed
        if(!$vars['group_id'])
            $errors['group_id']=__('Group is required');
        // Ensure we will still have an administrator with access
        if ($vars['isadmin'] !== '1' || $vars['isactive'] !== '1') {
            $sql = 'select count(*), max(staff_id) from '.STAFF_TABLE
                .' WHERE isadmin=1 and isactive=1';
            if (($res = db_query($sql))
                    && (list($count, $sid) = db_fetch_row($res))) {
                if ($count == 1 && $sid == $uid) {
                    $errors['isadmin'] = __(
                        'Cowardly refusing to remove or lock out the only active administrator'
                    );
                }
            }
        }

Jared Hancock's avatar
Jared Hancock committed
        if ($errors)
            return false;
Jared Hancock's avatar
Jared Hancock committed
        $this->isadmin = $vars['isadmin'];
        $this->isactive = $vars['isactive'];
        $this->isvisible = isset($vars['isvisible'])?1:0;
        $this->onvacation = isset($vars['onvacation'])?1:0;
        $this->assigned_only = isset($vars['assigned_only'])?1:0;
        $this->dept_id = $vars['dept_id'];
        $this->role_id = $vars['role_id'];
Jared Hancock's avatar
Jared Hancock committed
        $this->group_id = $vars['group_id'];
        $this->timezone = $vars['timezone'];
        $this->username = $vars['username'];
        $this->firstname = $vars['firstname'];
        $this->lastname = $vars['lastname'];
        $this->email = $vars['email'];
        $this->backend = $vars['backend'];
        $this->phone = Format::phone($vars['phone']);
        $this->phone_ext = $vars['phone_ext'];
        $this->mobile = Format::phone($vars['mobile']);
        $this->signature = Format::sanitize($vars['signature']);
        $this->notes = Format::sanitize($vars['notes']);

        // Update the user's password if requested
Jared Hancock's avatar
Jared Hancock committed
        if ($vars['passwd1']) {
            try {
                $this->setPassword($vars['passwd1'], null);
            }
            catch (BadPassword $ex) {
                $errors['passwd1'] = $ex->getMessage();
            }
            catch (PasswordUpdateFailed $ex) {
                // TODO: Add a warning banner or crash the update
            }
Jared Hancock's avatar
Jared Hancock committed
            if (isset($vars['change_passwd']))
                $this->change_passwd = 1;
        }
        elseif (!isset($vars['change_passwd'])) {
            $this->change_passwd = 0;
Jared Hancock's avatar
Jared Hancock committed
        if ($this->save() && $this->updateTeams($vars['teams'])) {
            if ($vars['welcome_email'])
                $this->sendResetEmail('registration-staff', false);
Jared Hancock's avatar
Jared Hancock committed
            return true;
        }
Jared Hancock's avatar
Jared Hancock committed
        if (isset($this->staff_id)) {
            $errors['err']=sprintf(__('Unable to update %s.'), __('this agent'))
               .' '.__('Internal error occurred');
            $errors['err']=sprintf(__('Unable to create %s.'), __('this agent'))
               .' '.__('Internal error occurred');
Jared Hancock's avatar
Jared Hancock committed
        }
        return false;
    }
}

interface RestrictedAccess {
    function checkStaffPerm($staff);
}