Auth\User

Complexity

Total Complexity

93

Size/Duplication

Total Lines	782
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	6
Bugs	2	Features	1

53 Methods

Rating	Name	Duplication	Size	Complexity
A	isInGroupNamed()	0	4	1
A	getDisplayName()	0	4	1
A	getGivenName()	0	4	1
A	getEmail()	0	4	1
A	getUid()	0	4	1
A	getPhoto()	0	4	1
A	getPhoneNumber()	0	4	1
A	getOrganization()	0	4	1
A	getTitles()	0	4	1
B	getTitleNames()	0	30	6
A	getState()	0	4	1
A	getCity()	0	4	1
A	getLastName()	0	4	1
A	getNickName()	0	4	1
A	getAddress()	0	4	1
A	getPostalCode()	0	4	1
A	getCountry()	0	4	1
A	getOrganizationUnits()	0	4	1
A	getLoginProviders()	0	4	1
A	addLoginProvider()	0	4	1
A	canLoginWith()	0	11	4
A	setPass()	0	4	1
B	isProfileComplete()	0	10	7
A	validate_password()	0	4	1
A	validate_reset_hash()	0	4	1
B	change_pass()	0	16	6
A	setDisplayName()	0	4	1
A	setEmail()	0	4	1
A	setUid()	0	4	1
A	setPhoto()	0	4	1
A	setPhoneNumber()	0	4	1
A	setOrganization()	0	4	1
A	setTitles()	0	4	1
A	setState()	0	4	1
A	setCity()	0	4	1
A	setLastName()	0	4	1
A	setNickName()	0	4	1
A	setAddress()	0	4	1
A	setPostalCode()	0	4	1
A	setCountry()	0	4	1
A	setOrganizationUnits()	0	4	1
A	setGivenName()	0	4	1
A	getGroups()	0	4	1
A	enableReadWrite()	0	7	1
A	editUserPassword()	0	17	4
B	editNames()	0	23	5
B	checkForUnsettableElements()	0	19	5
B	editAddressElements()	0	28	6
A	editOrganizationElements()	0	18	4
A	editUser()	0	21	3
A	getPasswordResetHash()	0	4	1
B	jsonSerialize()	0	24	1
A	getVcard()	0	12	1

<?php
/**
 * User class
 *
 * This file describes the User classes
 *
 * PHP version 5 and 7
 *
 * @author Patrick Boyd / problem@burningflipside.com
 * @copyright Copyright (c) 2015, Austin Artistic Reconstruction
 * @license http://www.apache.org/licenses/ Apache 2.0 License
 */

namespace Auth;

/**
 * A class to abstract access to Users regardless of the Authentication type used.
 *
 * This class is the primary method to access user information.
 */
class User extends \SerializableObject
{
    /**
     * An array to cache the title to string mappings so that they don't need to be pulled from the database
     * everytime
     */ 
    public static $titlenames = null;

    /**
     * Is this user in the Group or a child of that group?
     *
     * @param string $name The name of the group to check if the user is in
     *
     * @return true|false True if the user is in the group, false otherwise
     */
    public function isInGroupNamed($name)
    {
        return false;
    }

    /**
     * The name the user should be displayed as
     *
     * @return string The name the user should be displayed as
     */
    public function getDisplayName()
    {
        return $this->getNickName();
    }

    /**
     * The given (or first) name for the user
     *
     * @return string The user's first name
     */
    public function getGivenName()
    {
        return $this->getUid();
    }

    /**
     * The email address for the user
     *
     * @return string The user's email address
     */
    public function getEmail()
    {
        return false;
    }

    /**
     * The user ID for the user
     *
     * @return string The user's ID or username
     */
    public function getUid()
    {
        return $this->getEmail();
    }

    /**
     * The photo for the user
     *
     * @return string The user's photo as a binary string
     */ 
    public function getPhoto()
    {
        return false;
    }

    /**
     * The phone number for the user
     *
     * @return false|string The user's phone number
     */
    public function getPhoneNumber()
    {
        return false;
    }

    /**
     * The organziation for the user
     *
     * @return false|string The user's organization
     */
    public function getOrganization()
    {
        return false;
    }

    /**
     * The list of titles for the user
     *
     * @return array The user's title(s) in short format
     */
    public function getTitles()
    {
        return false;
    }

    /**
     * The list of titles for the user
     *
     * @return array The user's title(s) in user friendly strings
     *
     * @SuppressWarnings("StaticAccess")
     */
    public function getTitleNames()
    {
        $titles = $this->getTitles();
        if($titles === false)
        {
            return false;
        }
        if(self::$titlenames === null)
        {
            $dataSet = \DataSetFactory::getDataSetByName('profiles');
            $dataTable = $dataSet['position'];
            $titlenames = $dataTable->read();
            self::$titlenames = array();
            $count = count($titlenames);
            for($i = 0; $i < $count; $i++)
            {
                self::$titlenames[$titlenames[$i]['short_name']] = $titlenames[$i];
            }
        }
        $count = count($titles);
        for($i = 0; $i < $count; $i++)
        {
            if(isset(self::$titlenames[$titles[$i]]))
            {
                $title = self::$titlenames[$titles[$i]];
                $titles[$i] = $title['name'];
            }
        }
        return $titles;
    }

    /**
     * The state the user's mailing address is in
     *
     * @return string The user's state from their mailing address
     */
    public function getState()
    {
        return false;
    }

    /**
     * The city the user's mailing address is in
     *
     * @return string The user's city from their mailing address
     */
    public function getCity()
    {
        return false;
    }

    /**
     * The last name for the user
     *
     * @return string The user's last name
     */
    public function getLastName()
    {
        return false;
    }

    /**
     * The nick name for the user
     *
     * @return string The user's nick name
     */
    public function getNickName()
    {
        return $this->getUid();
    }

    /**
     * The street address for the user
     *
     * @return string The user's street address
     */
    public function getAddress()
    {
        return false;
    }

    /**
     * The postal (zip) code for the user's mailing address
     *
     * @return string The user's postal code
     */
    public function getPostalCode()
    {
        return false;
    }

    /**
     * The country the user's mailing address is in
     *
     * @return string The user's country from their mailing address
     */
    public function getCountry()
    {
        return false;
    }

    /**
     * The organizational units the user is in
     *
     * This is the same as Areas in Flipside speak. 
     *
     * @return array The user's orgnaiational units
     */
    public function getOrganizationUnits()
    {
        return false;
    }

    /**
     * The supplemental login types that the user can use to login
     *
     * @return array The user's login providers
     */
    public function getLoginProviders()
    {
        return false;
    }

    /**
     * The groups the user is a part of
     *
     * @return false|array The user's Auth\Group structures
     */
    public function getGroups()
    {
        return false;
    }

    /**
     * Add a supplemental login type that the user can use to login
     *
     * @param string $provider The hostname for the provider
     *
     * @return true|false true if the addition worked, false otherwise
     */
    public function addLoginProvider($provider)
    {
        throw new \Exception('Cannot add provider for this login type!');
    }

    /**
     * Can the user login with this provider?
     *
     * @param string $provider The hostname for the provider
     *
     * @return true|false true if they can login with the provider, false otherwise
     */
    public function canLoginWith($provider)
    {
        $hosts = $this->getLoginProviders();
        if($hosts === false) return false;
        $count = count($hosts);
        for($i = 0; $i < $count; $i++)
        {
            if(strcasecmp($hosts[$i], $provider) === 0) return true;
        }
        return false;
    }

    /**
     * Set the user's password without verifying the current password
     *
     * @param string $password The new user password
     *
     * @return true|false true if the user's password was changed, false otherwise
     */
    protected function setPass($password)
    {
        return false;
    }

    /**
     * Has the user completely filled out their user profile?
     *
     * @return true|false true if the user's profile is complete, false otherwise
     */
    public function isProfileComplete()
    {
        if($this->getCountry() === false    || $this->getAddress() === false ||
           $this->getPostalCode() === false || $this->getCity() === false ||
           $this->getState() === false      || $this->getPhoneNumber() === false)
        {
            return false;
        }
        return true;
    }

    /**
     * Validate that the user's password is the specified password
     *
     * @param string $password The user's current password
     *
     * @return true|false true if the user's password is correct, false otherwise
     *
     * @SuppressWarnings("UnusedFormalParameter")
     */
    public function validate_password($password)
    {
        return false;
    }

    /**
     * Validate that the user's reset hash is the sepcified hash
     *
     * @param string $hash The user's reset hash
     *
     * @return true|false true if the user's hash is correct, false otherwise
     *
     * @SuppressWarnings("UnusedFormalParameter")
     */
    public function validate_reset_hash($hash)
    {
        return false;
    }

    /**
     * Change the user's password, validating the old password or reset hash
     *
     * @param string $oldpass The user's original password or reset hash if $isHash is true
     * @param string $newpass The user's new password
     * @param boolean $isHash Is $old_pass a password or a hash
     *
     * @return true|false true if the user's password was changed, false otherwise
     */
    public function change_pass($oldpass, $newpass, $isHash=false)
    {
        if($isHash === false && $this->validate_password($oldpass) === false)
        {
            throw new \Exception('Invalid Password!', 3);
        }
        if($isHash === true && $this->validate_reset_hash($oldpass) === false)
        {
            throw new \Exception('Invalid Reset Hash!', 3);
        }
        if($this->setPass($newpass) === false)
        {
            throw new \Exception('Unable to set password!', 6);
        }
        return true;
    }

    /**
     * Set the user's display name
     *
     * @param string $name The user's new display name
     *
     * @return true|false true if the user's display name was changed, false otherwise
     */
    public function setDisplayName($name)
    {
        return $this->setNickName($name);
    }

    /**
     * Set the user's given (first) name
     *
     * @param string $name The user's new given name
     *
     * @return true|false true if the user's given name was changed, false otherwise
     */
    public function setGivenName($name)
    {
        return $this->setUid($name);
    }

    /**
     * Set the user's email address
     *
     * @param string $email The user's new email address
     *
     * @return true|false true if the user's email address was changed, false otherwise
     *
     * @SuppressWarnings("UnusedFormalParameter")
     */
    public function setEmail($email)
    {
        return false;
    }

    /**
     * Set the user's user ID or user name
     *
     * @param string $uid The user's new user ID
     *
     * @return true|false true if the user's ID was changed, false otherwise
     *
     * @SuppressWarnings("UnusedFormalParameter")
     */
    public function setUid($uid)
    {
        return false;
    }

    /**
     * Set the user's photo
     *
     * @param string $photo The user's new photo as a binary string
     *
     * @return true|false true if the user's photo was changed, false otherwise
     *
     * @SuppressWarnings("UnusedFormalParameter")
     */
    public function setPhoto($photo)
    {
        return false;
    }

    /**
     * Set the user's phone number
     *
     * @param string $phone The user's new phonew number
     *
     * @return true|false true if the user's phone number was changed, false otherwise
     *
     * @SuppressWarnings("UnusedFormalParameter")
     */
    public function setPhoneNumber($phone)
    {
        return false;
    }

    /**
     * Set the user's organization
     *
     * @param string $org The user's new organization
     *
     * @return true|false true if the user's organization was changed, false otherwise
     *
     * @SuppressWarnings("UnusedFormalParameter")
     */
    public function setOrganization($org)

The parameter $org is not used and could be removed.

    {
        return false;
    }

    /**
     * Set the user's titles
     *
     * @param string $titles The user's new titles
     *
     * @return true|false true if the user's titles were changed, false otherwise
     *
     * @SuppressWarnings("UnusedFormalParameter")
     */
    public function setTitles($titles)
    {
        return false;
    }

    /**
     * Set the user's state
     *
     * @param string $state The user's new state
     *
     * @return true|false true if the user's state was changed, false otherwise
     *
     * @SuppressWarnings("UnusedFormalParameter")
     */
    public function setState($state)
    {
        return false;
    }

    /**
     * Set the user's city
     *
     * @param string $city The user's new city
     *
     * @return true|false true if the user's city was changed, false otherwise
     *
     * @SuppressWarnings("UnusedFormalParameter")
     */
    public function setCity($city)
    {
        return false;
    }

    /**
     * Set the user's last name
     *
     * @param string $sn The user's new last name
     *
     * @return true|false true if the user's last name was changed, false otherwise
     *
     * @SuppressWarnings("UnusedFormalParameter")
     */
    public function setLastName($sn)
    {
        return false;
    }

    /**
     * Set the user's nick name
     *
     * @param string $displayName The user's new nick name
     *
     * @return true|false true if the user's nick name was changed, false otherwise
     */
    public function setNickName($displayName)
    {
        return $this->setUid($displayName);
    }

    /**
     * Set the user's mailing address
     *
     * @param string $address The user's new mailing address
     *
     * @return true|false true if the user's mailing address was changed, false otherwise
     *
     * @SuppressWarnings("UnusedFormalParameter")
     */
    public function setAddress($address)
    {
        return false;
    }

    /**
     * Set the user's postal or zip code
     *
     * @param string $postalcode The user's new postal code
     *
     * @return true|false true if the user's postal code was changed, false otherwise
     *
     * @SuppressWarnings("UnusedFormalParameter")
     */
    public function setPostalCode($postalcode)
    {
        return false;
    }

    /**
     * Set the user's country
     *
     * @param string $country The user's new country
     *
     * @return true|false true if the user's country was changed, false otherwise
     *
     * @SuppressWarnings("UnusedFormalParameter")
     */
    public function setCountry($country)
    {
        return false;
    }

    /**
     * Set the user's organizations
     *
     * @param string $ous The user's new organizations
     *
     * @return true|false true if the user's organizations was changed, false otherwise
     *
     * @SuppressWarnings("UnusedFormalParameter")
     */
    public function setOrganizationUnits($ous)
    {
        return false;
    }

    /**
     * Allow write for the user
     */
    protected function enableReadWrite()
    {
        //Make sure we are bound in write mode
        $auth = \AuthProvider::getInstance();
        $ldap = $auth->getAuthenticator('Auth\LDAPAuthenticator');
        $ldap->get_and_bind_server(true);
    }

    /**
     * Update the user password if required
     */
    private function editUserPassword($data)
    {
        if(isset($data->password))
        {
            if(isset($data->oldpass))
            {
                $this->change_pass($data->oldpass, $data->password);
                unset($data->oldpass);
            }
            else if(isset($data->hash))
            {
                $this->change_pass($data->hash, $data->password, true);
                unset($data->hash);
            }
            unset($data->password);
        }
    }

    private function editNames($data)
    {
        if(isset($data->displayName))
        {
            $this->setDisplayName($data->displayName);
            unset($data->displayName);
        }
        if(isset($data->givenName))
        {
            $this->setGivenName($data->givenName);
            unset($data->givenName);
        }
        if(isset($data->sn))
        {
            $this->setLastName($data->sn);
            unset($data->sn);
        }
        if(isset($data->cn))
        {
            $this->setNickName($data->cn);

The call to the method Auth\User::setNickName() seems un-needed as the method has no side-effects.

            unset($data->cn);
        }
    }

    private function checkForUnsettableElements($data)
    {
        if(isset($data->mail))
        {
            if($data->mail !== $this->getEmail())
            {
                throw new \Exception('Unable to change email!');
            }
            unset($data->mail);
        }
        if(isset($data->uid))
        {
            if($data->uid !== $this->getUid())
            {
                throw new \Exception('Unable to change uid!');
            }
            unset($data->uid);
        }
    }

    private function editAddressElements($data)
    {
        if(isset($data->postalAddress))
        {
            $this->setAddress($data->postalAddress);
            unset($data->postalAddress);
        }
        if(isset($data->l))
        {
            $this->setCity($data->l);
            unset($data->l);
        }
        if(isset($data->st))
        {
            $this->setState($data->st);
            unset($data->st);
        }
        if(isset($data->postalCode))
        {
            $this->setPostalCode($data->postalCode);
            unset($data->postalCode);
        }
        if(isset($data->c))
        {
            $this->setCountry($data->c);
            unset($data->c);
        }
    }

    private function editOrganizationElements($data)
    {
        if(isset($data->o))
        {
            $this->setOrganization($data->o);

The call to the method Auth\User::setOrganization() seems un-needed as the method has no side-effects.

            unset($data->o);
        }
        if(isset($data->title))
        {
            $this->setTitles($data->title);
            unset($data->title);
        }
        if(isset($data->ou))
        {
            $this->setOrganizationUnits($data->ou);
            unset($data->ou);
        }
    }

    /**
     * Modify the user given the provided data object
     *
     * @param stdClass $data The user's new data
     *
     * @return true|false true if the user's data was changed, false otherwise
     */
    public function editUser($data)
    {
        $this->enableReadWrite();

        $this->checkForUnsettableElements($data);
        $this->editUserPassword($data);
        $this->editNames($data);
        $this->editAddressElements($data);
        $this->editOrganizationElements($data);

        if(isset($data->jpegPhoto))
        {
            $this->setPhoto(base64_decode($data->jpegPhoto));
            unset($data->jpegPhoto);
        }
        if(isset($data->mobile))
        {
            $this->setPhoneNumber($data->mobile);
            unset($data->mobile);
        }
    }

    /**
     * Obtain the user's password reset hash
     *
     * @return string|false A hash if available, false otherwise
     */
    public function getPasswordResetHash()
    {
        return false;
    }

    /**
     * Serialize the user data into a format usable by the json_encode method
     *
     * @return array A simple keyed array representing the user
     */
    public function jsonSerialize()
    {
        $user = array();
        $user['displayName'] = $this->getDisplayName();
        $user['givenName'] = $this->getGivenName();
        $user['jpegPhoto'] = base64_encode($this->getPhoto());
        $user['mail'] = $this->getEmail();
        $user['mobile'] = $this->getPhoneNumber();
        $user['uid'] = $this->getUid();
        $user['o'] = $this->getOrganization();
        $user['title'] = $this->getTitles();
        $user['titlenames'] = $this->getTitleNames();
        $user['st'] = $this->getState();
        $user['l'] = $this->getCity();
        $user['sn'] = $this->getLastName();
        $user['cn'] = $this->getNickName();
        $user['postalAddress'] = $this->getAddress();
        $user['postalCode'] = $this->getPostalCode();
        $user['c'] = $this->getCountry();
        $user['ou'] = $this->getOrganizationUnits();
        $user['host'] = $this->getLoginProviders();
        $user['class'] = get_class($this);
        return $user;

The return type of return $user; (array<string,boolean|string>) is incompatible with the return type of the parent method SerializableObject::jsonSerialize of type SerializableObject.

    }

    /**
     * Serialize the user data into a VCARD 2.1 format
     *
     * @return string The VCARD for the user
     */
    public function getVcard()
    {
        $ret = "BEGIN:VCARD\nVERSION:2.1\n";
        $ret.= 'N:'.$this->getLastName().';'.$this->getGivenName()."\n";
        $ret.= 'FN:'.$this->getGivenName()."\n";
        $ret.= 'TITLE:'.implode(',', $this->getTitles())."\n";
        $ret.= "ORG: Austin Artistic Reconstruction\n";
        $ret.= 'TEL;TYPE=MOBILE,VOICE:'.$this->getPhoneNumber()."\n";
        $ret.= 'EMAIL;TYPE=PREF,INTERNET:'.$this->getEmail()."\n";
        $ret.= "END:VCARD\n";
        return $ret;
    }
}
/* vim: set tabstop=4 shiftwidth=4 expandtab: */
?>

It is not recommended to use PHP's closing tag ?> in files other than templates.