Canvas\Models\Users

Complexity

Total Complexity

45

Size/Duplication

Total Lines	718
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	19

Test Coverage

Coverage

0%

Importance

Changes

0

27 Methods

Rating	Name	Duplication	Size	Complexity
B	initialize()	0	152	1
A	validation()	0	30	1
A	getSource()	0	4	1
A	createSettingsModel()	0	4	1
A	getKey()	0	4	1
A	isFirstSignup()	0	4	1
A	hasRole()	0	4	1
A	subscriptions()	0	18	1
A	startFreeTrial()	0	25	1
A	beforeCreate()	0	18	3
A	currentCompanyId()	0	5	2
A	getDefaultCompany()	0	9	2
A	currentCompanyBranchId()	0	4	1
A	afterCreate()	0	20	3
A	afterSave()	0	5	1
A	updatePermissionRoles()	0	9	2
A	getPermission()	0	4	1
A	getAssociatedApps()	0	12	2
A	getAssociatedCompanies()	0	12	2
A	getByUserActivationEmail()	0	7	1
A	getPhoto()	0	4	1
A	switchDefaultCompanyByBranch()	0	13	4
A	updatePassword()	0	30	3
A	resetPassword()	0	13	2
A	signUp()	0	38	4
A	generateForgotHash()	0	7	1
A	assignRole()	0	10	1

<?php
declare(strict_types=1);

namespace Canvas\Models;

use Canvas\Traits\PermissionsTrait;
use Canvas\Traits\SubscriptionPlanLimitTrait;
use Phalcon\Cashier\Billable;
use Carbon\Carbon;
use Phalcon\Validation;
use Phalcon\Validation\Validator\Email;
use Phalcon\Validation\Validator\PresenceOf;
use Phalcon\Validation\Validator\Regex;
use Phalcon\Validation\Validator\Uniqueness;
use Canvas\Traits\FileSystemModelTrait;
use Phalcon\Security\Random;
use Baka\Database\Contracts\HashTableTrait;
use Canvas\Contracts\Notifications\NotifiableTrait;
use Canvas\Traits\EventManagerAwareTrait;
use Phalcon\Di;
use Canvas\Auth\App as AppAuth;
use Exception;
use Canvas\Validations\PasswordValidation;
use Baka\Auth\Models\Users as BakUser;
use Canvas\Hashing\Password;

/**
 * Class Users.
 *
 * @package Canvas\Models
 *
 * @property Users $user
 * @property Config $config
 * @property Apps $app
 * @property Companies $defaultCompany
 * @property \Phalcon\Di $di
 */
class Users extends \Baka\Auth\Models\Users
{
    use PermissionsTrait;
    use Billable;
    use SubscriptionPlanLimitTrait;
    use FileSystemModelTrait;
    use HashTableTrait;
    use NotifiableTrait;
    use EventManagerAwareTrait;

    /**
     * Default Company Branch.
     *
     * @var integer
     */
    public $default_company_branch;

$default_company_branch does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    /**
     * Roles id.
     *
     * @var integer
     */
    public $roles_id;

$roles_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    /**
     * Stripe id.
     *
     * @var string
     */
    public $stripe_id;

$stripe_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    /**
     * Card last four numbers.
     *
     * @var integer
     */
    public $card_last_four;

$card_last_four does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    /**
     * Card Brand.
     *
     * @var integer
     */
    public $card_brand;

$card_brand does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    /**
     * Trial end date.
     *
     * @var string
     */
    public $trial_ends_at;

$trial_ends_at does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    /**
     * Provide the app plan id
     * if the user is signing up a new company.
     *
     * @var integer
     */
    public $appPlanId = null;

    /**
     * Active subscription id.Not an actual table field, used temporarily.
     * @var string
     */
    public $active_subscription_id;

$active_subscription_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    /**
     * System Module Id.
     * @var integer
     */
    public $system_modules_id = 2;

$system_modules_id does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    /**
     * User email activation code.
     *
     * @var string
     */
    public $user_activation_email;

$user_activation_email does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    /**
     * Initialize method for model.
     */
    public function initialize()
    {
        $this->setSource('users');

        //overwrite parent relationships
        $this->hasOne('id', 'Baka\Auth\Models\Sessions', 'users_id', ['alias' => 'session']);
        $this->hasMany('id', 'Baka\Auth\Models\Sessions', 'users_id', ['alias' => 'sessions']);
        $this->hasMany('id', 'Baka\Auth\Models\SessionKeys', 'users_id', ['alias' => 'sessionKeys']);
        $this->hasMany('id', 'Baka\Auth\Models\Banlist', 'users_id', ['alias' => 'bans']);
        $this->hasMany('id', 'Baka\Auth\Models\Sessions', 'users_id', ['alias' => 'sessions']);
        $this->hasMany('id', 'Canvas\Models\UserConfig', 'users_id', ['alias' => 'config']);
        $this->hasMany('id', 'Canvas\Models\UserLinkedSources', 'users_id', ['alias' => 'sources']);

        $this->hasOne(
            'default_company',
            'Canvas\Models\Companies',
            'id',
            ['alias' => 'defaultCompany']
        );

        $this->hasOne(
            'default_company',
            'Canvas\Models\Companies',
            'id',
            ['alias' => 'currentCompany']
        );

        $this->hasOne(
            'id',
            'Canvas\Models\UserRoles',
            'users_id',
            [
                'alias' => 'userRole',
                'params' => [
                    'limit' => 1,
                    'conditions' => 'Canvas\Models\UserRoles.apps_id in (?0, ?1)',
                    'bind' => [$this->di->getApp()->getId(), Roles::DEFAULT_ACL_APP_ID],
                ]
            ]
        );

        $this->hasMany(
            'id',
            'Canvas\Models\UserRoles',
            'users_id',
            [
                'alias' => 'permissions',
                'params' => [
                    'conditions' => 'Canvas\Models\UserRoles.apps_id = ' . $this->di->getApp()->getId(),
                ]
            ]
        );

        $this->hasManyToMany(
            'id',
            'Canvas\Models\UserRoles',
            'users_id',
            'roles_id',
            'Canvas\Models\Roles',
            'id',
            [
                'alias' => 'roles',
                'params' => [
                    'limit' => 1,
                    'conditions' => 'Canvas\Models\UserRoles.apps_id = ' . $this->di->getApp()->getId(),
                ]
            ]
        );

        $this->hasMany(
            'id',
            'Canvas\Models\Subscription',
            'user_id',
            [
                'alias' => 'allSubscriptions',
                'params' => [
                    'conditions' => 'apps_id = ?0',
                    'bind' => [$this->di->getApp()->getId()],
                    'order' => 'id DESC'
                ]
            ]
        );

        $this->hasMany(
            'id',
            'Canvas\Models\UsersAssociatedApps',
            'users_id',
            [
                'alias' => 'companies',
                'params' => [
                    'conditions' => 'apps_id = ?0',
                    'bind' => [$this->di->getApp()->getId()],
                ]
            ]
        );

        $this->hasMany(
            'id',
            'Canvas\Models\UsersAssociatedApps',
            'users_id',
            [
                'alias' => 'apps',
            ]
        );

        $this->hasOne(
            'id',
            'Canvas\Models\UsersAssociatedApps',
            'users_id',
            [
                'alias' => 'app',
                'params' => [
                    'conditions' => 'apps_id = ?0',
                    'bind' => [Di::getDefault()->getApp()->getId()]
                ]
            ]
        );

        $this->hasMany(
            'id',
            'Canvas\Models\UserWebhooks',
            'users_id',
            ['alias' => 'userWebhook']
        );

        $systemModule = SystemModules::getSystemModuleByModelName(self::class);

The method Canvas\Models\SystemModules::getSystemModuleByModelName() has been deprecated with message: v2

        $this->hasOne(
            'id',
            'Canvas\Models\FileSystemEntities',
            'entity_id',
            [
                'alias' => 'files',
                'params' => [
                    'conditions' => 'system_modules_id = ?0',
                    'bind' => [$systemModule->getId()]
                ]
            ]
        );

        $this->hasOne(
            'id',
            'Canvas\Models\FileSystemEntities',
            'entity_id',
            [
                'alias' => 'photo',
                'params' => [
                    'conditions' => 'system_modules_id = ?0',
                    'bind' => [$systemModule->getId()]
                ]
            ]
        );
    }

    /**
     * Validations and business logic.
     */
    public function validation()

The return type could not be reliably inferred; please add a @return annotation.

    {
        $validator = new Validation();
        $validator->add(
            'email',
            new Email([
                'field' => 'email',
                'required' => true,
            ])
        );

        $validator->add(
            'displayname',
            new PresenceOf([
                'field' => 'displayname',
                'required' => true,
            ])
        );

        // Unique values
        $validator->add(
            'email',
            new Uniqueness([
                'field' => 'email',
                'message' => _('This email already has an account.'),
            ])
        );

        return $this->validate($validator);
    }

    /**
     * Returns table name mapped in the model.
     *
     * @return string
     */
    public function getSource() : string
    {
        return 'users';
    }

    /**
    * Set hashtable settings table, userConfig ;).
    *
    * @return void
    */
    private function createSettingsModel(): void

This method is not used, and could be removed.

    {
        $this->settingsModel = new UserConfig();
    }

    /**
     * Get the User key for redis.
     *
     * @return string

Should the return type not be integer?

     */
    public function getKey() : int
    {
        return $this->id;
    }

    /**
     * A company owner is the first person that register this company
     * This only ocurres when signing up the first time, after that all users invites
     * come with a default_company id attached.
     *
     * @return boolean
     */
    public function isFirstSignup(): bool
    {
        return empty($this->default_company);
    }

    /**
     * Does the user have a role assign to him?
     *
     * @return boolean
     */
    public function hasRole(): bool
    {
        return !empty($this->roles_id);
    }

    /**
     * Get all of the subscriptions for the user.
     */
    public function subscriptions()

The return type could not be reliably inferred; please add a @return annotation.

    {
        $this->hasMany(
            'id',
            'Canvas\Models\Subscription',
            'user_id',
            [
                'alias' => 'subscriptions',
                'params' => [
                    'conditions' => 'apps_id = ?0 and companies_id = ?1',
                    'bind' => [$this->di->getApp()->getId(), $this->default_company],
                    'order' => 'id DESC'
                ]
            ]
        );

        return $this->getRelated('subscriptions');
    }

    /**
     * Strat a free trial.
     *
     * @param Users $user

There is no parameter named $user. Was it maybe removed?

     * @return Subscription
     */
    public function startFreeTrial() : Subscription
    {
        $defaultPlan = AppsPlans::getDefaultPlan();
        $trialEndsAt = Carbon::now()->addDays($this->di->getApp()->plan->free_trial_dates);

        $subscription = new Subscription();
        $subscription->user_id = $this->getId();
        $subscription->companies_id = $this->default_company;
        $subscription->apps_id = $this->di->getApp()->getId();
        $subscription->apps_plans_id = $this->di->getApp()->default_apps_plan_id;
        $subscription->name = $defaultPlan->name;
        $subscription->stripe_id = $defaultPlan->stripe_id;
        $subscription->stripe_plan = $defaultPlan->stripe_plan;
        $subscription->quantity = 1;
        $subscription->trial_ends_at = $trialEndsAt->toDateTimeString();
        $subscription->trial_ends_days = $trialEndsAt->diffInDays(Carbon::now());
        $subscription->is_freetrial = 1;
        $subscription->is_active = 1;
        $subscription->saveOrFail();

        $this->trial_ends_at = $subscription->trial_ends_at;
        $this->updateOrFail();

        return $subscription;
    }

    /**
     * Before create.
     *
     * @return void
     */
    public function beforeCreate()
    {
        parent::beforeCreate();
        $random = new Random();
        $this->user_activation_email = $random->uuid();

        //this is only empty when creating a new user
        if (!$this->isFirstSignup()) {
            //confirm if the app reach its limit
            $this->isAtLimit();
        }

        //Assign admin role to the system if we dont get a specify role
        if (!$this->hasRole()) {
            $role = Roles::getByName('Admins');
            $this->roles_id = $role->getId();
        }
    }

    /**
     * What the current company the users is logged in with
     * in this current session?
     *
     * @return integer
     */
    public function currentCompanyId(): int
    {
        $defaultCompanyId = $this->get(Companies::cacheKey());

Are you sure the assignment to $defaultCompanyId is correct as $this->get(\Canvas\Models\Companies::cacheKey()) (which targets Baka\Database\Contracts\HashTableTrait::get()) seems to always return null.

        return !is_null($defaultCompanyId) ? (int) $defaultCompanyId : (int) $this->default_company;
    }

    /**
     * Overwrite the user relationship.
     * use Phalcon Registry to assure we mantian the same instance accross the request.
     */
    public function getDefaultCompany(): Companies
    {
        $registry = Di::getDefault()->getRegistry();
        $key = 'company_' . Di::getDefault()->getApp()->getId() . '_' . $this->getId();
        if (!isset($registry[$key])) {
            $registry[$key] = Companies::findFirstOrFail($this->currentCompanyId());
        }
        return  $registry[$key];
    }

    /**
     * What the current company brach the users is logged in with
     * in this current session?
     *
     * @return integer
     */
    public function currentCompanyBranchId(): int
    {
        return (int) $this->default_company_branch;
    }

    /**
     * What to do after the creation of a new users
     *  - Assign default role.
     *
     * @return void
     */
    public function afterCreate()
    {
        //need to run it here, since we overwirte the default_company id and null this function objective
        $isFirstSignup = $this->isFirstSignup();

        /**
         * if we dont find the userdata di lets create it.
         * @todo this is not ideal lets fix it later
         */
        if (!$this->di->has('userData')) {
            $this->di->setShared('userData', $this);
        }

        $this->fire('user:afterSignup', $this, $isFirstSignup);

        //update user activity when its not a empty user
        if (!$isFirstSignup) {
            $this->updateAppActivityLimit();
        }
    }

    /**
     * Upload Files.
     *
     * @todo move this to the baka class
     *
     * @return void
     */
    public function afterSave()
    {
        $this->associateFileSystem();
        $this->updatePermissionRoles();
    }

    /**
     * update user role for the specific app.
     *
     * @return void

Should the return type not be boolean?

     */
    protected function updatePermissionRoles(): bool

function updatePermissionRoles() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

    {
        if ($permission = $this->getPermission()) {
            $permission->roles_id = $this->roles_id;
            return $permission->updateOrFail();
        }

        return false;
    }

    /**
     * Overwrite the permission relationship to force the user of company id.
     *
     * @return UserRoles
     */
    public function getPermission()
    {
        return $this->getUserRole('companies_id =' . $this->currentCompanyId());
    }

    /**
     * Get the list of all the associated apps this users has.
     *:w.
     * @return array
     */
    public function getAssociatedApps(): array
    {
        $apps = $this->getApps(['columns' => 'apps_id', 'group' => 'apps_id']);

        if ($apps->count()) {
            return array_map(function ($apps) {
                return $apps['apps_id'];
            }, $apps->toArray());
        }

        return [0];
    }

    /**
     * Get an array of the associates companies Ids.
     *
     * @return array
     */
    public function getAssociatedCompanies(): array
    {
        $companies = $this->getCompanies(['columns' => 'companies_id']);

        if ($companies->count()) {
            return array_map(function ($company) {
                return $company['companies_id'];
            }, $companies->toArray());
        }

        return [0];
    }

    /**
     * Get user by key.
     * @param string $userActivationEmail
     * @return Users
     */
    public static function getByUserActivationEmail(string $userActivationEmail): Users
    {
        return self::findFirst([
            'conditions' => 'user_activation_email = ?0 and user_active =?1 and is_deleted = 0',
            'bind' => [$userActivationEmail, 1],
        ]);
    }

    /**
     * Overwrite the relationship.
     *
     * @return void

Should the return type not be string|null?

     */
    public function getPhoto()
    {
        return $this->getFileByName('photo');
    }

    /**
     * Update the user current default company.
     *
     * @param integer $companyId

There is no parameter named $companyId. Was it maybe removed?

     * @return void
     */
    public function switchDefaultCompanyByBranch(int $branchId): void
    {
        if ($branch = CompaniesBranches::findFirst($branchId)) {
            if ($branch->company) {
                if ($branch->company->userAssociatedToCompany($this)) {
                    $this->default_company = $branch->company->getId();
                    $this->default_company_branch = $branch->getId();
                    //set the default company id per the specific app , we do this so we can have multip default companies per diff apps
                    $this->set(Companies::cacheKey(), $this->default_company);
                }
            }
        }
    }

    /**
     * Update the password for a current user.
     *
     * @param string $newPassword
     * @return boolean
     */
    public function updatePassword(string $currentPassword, string $newPassword, string $verifyPassword) : bool

function updatePassword() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

    {
        $currentPassword = trim($currentPassword);

Consider using a different name than the parameter $currentPassword. This often makes code more readable.

        $newPassword = trim($newPassword);

Consider using a different name than the parameter $newPassword. This often makes code more readable.

        $verifyPassword = trim($verifyPassword);

Consider using a different name than the parameter $verifyPassword. This often makes code more readable.

        $app = Di::getDefault()->getApp();

        if (!$app->ecosystemAuth()) {
            $userAppData = $this->getApp([
                'conditions' => 'companies_id = :id:',
                'bind' => [
                    'id' => $this->currentCompanyId()
                ]
            ]);

            $password = $userAppData->password;
        } else {
            $password = $this->password;
        }

        // First off check that the current password matches the current password
        if (Password::check($currentPassword, $password)) {
            PasswordValidation::validate($newPassword, $verifyPassword);

            return $this->resetPassword($newPassword);
        }

        throw new Exception(_(' Your current password is incorrect .'));
    }

    /**
     * Reset the user passwrod.
     *
     * @param string $newPassword
     * @return bool
     */
    public function resetPassword(string $newPassword): bool

function resetPassword() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

    {
        $app = Di::getDefault()->getApp();

        if (!$app->ecosystemAuth()) {
            //update all companies password for the current user app
            AppAuth::updatePassword($this, Password::make($newPassword));
        } else {
            $this->password = Password::make($newPassword);
        }

        return true;
    }

    /**
     * user signup to the service.
     *
     * did we find the email?
     * does it have access to this app?
     * no?
     * ok lets register / associate to this app
     * yes?
     * it meas he was invites so get the fuck out?
     *
     * @return Users
     */
    public function signUp() : BakUser
    {
        $app = Di::getDefault()->getApp();

        if (!$app->ecosystemAuth()) {
            try {
                $user = self::getByEmail($this->email);

                $userAppData = $user->countApps('apps_id = ' . $this->getDI()->getDefault()->getApp()->getId());

                if ($userAppData > 0) {
                    throw new Exception('This email already has an account.');
                }

                //assign user role for the current app
                $user->roles_id = Roles::getByName(Roles::DEFAULT)->getId();

                $this->fire('user:afterSignup', $user, true);

                //update the passwords for the current app
                AppAuth::updatePassword($user, Password::make($this->password));

                //overwrite the current user object
                $this->id = $user->getId();
                $this->email = $user->getEmail();
            } catch (Exception $e) {
                //if we cant find the user normal signup
                $user = parent::signUp();

                //update all the password for the apps
                AppAuth::updatePassword($user, $this->password);
            }
        } else {
            $user = parent::signUp();
        }

        return $user;
    }

    /**
     * Generate new forgot password hash.
     *
     * @return string
     */
    public function generateForgotHash(): string
    {
        $this->user_activation_forgot = $this->generateActivationKey();
        $this->updateOrFail();

        return $this->user_activation_forgot;
    }

    /**
     * Given a Role assign it to the user for the current app.
     *
     * @param Roles $role
     * @return boolean
     */
    public function assignRole(Roles $role): bool

function assignRole() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

    {
        $userRole = new UserRoles();
        $userRole->users_id = $this->getId();
        $userRole->roles_id = $role->getId();
        $userRole->apps_id = $this->di->getApp()->getId();
        $userRole->companies_id = $this->getDefaultCompany()->getId();

        return $userRole->saveOrFail();
    }
}