App\Services\Auth\BaseOidcUserProvider

Complexity

Total Complexity

27

Size/Duplication

Total Lines	199
Duplicated Lines	0 %

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	retrieveByToken()	0	3	1
A	__construct()	0	3	1
A	updateRememberToken()	0	1	1
A	retrieveById()	0	6	1
A	getModel()	0	2	1
A	validateCredentials()	0	2	1
A	createUserFromCredentials()	0	13	5
A	createModel()	0	4	1
A	setModel()	0	4	1
C	retrieveByCredentials()	0	59	14

<?php

namespace App\Services\Auth;

use Illuminate\Support\Facades\App;
use Illuminate\Support\Facades\Config;
use Illuminate\Contracts\Auth\UserProvider;
use Illuminate\Contracts\Auth\Authenticatable;
use App\Services\Auth\Contracts\OidcAuthenticatable;
use App\Services\Auth\Contracts\OidcUserValidator;
use App\Models\Manager;
use App\Models\UserRole;
use App\Models\Applicant;

class BaseOidcUserProvider implements UserProvider {

    /**
     * The Eloquent user model.
     *
     * @var string
     */
    protected $model;

    /**
     * The role new users should be created with
     *
     * @var string
     */
    protected $defaultRole;



    /**
     * Create a new user provider.
     *
     * @param  string  $model

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @param  string  $defaultRole

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @return void
     */
    public function __construct($model, $defaultRole) {

Method \App\Services\Auth\BaseOidcUserProvider::__construct() does not have parameter type hint for its parameter $model but it should be possible to add it based on @param annotation "string".

Method \App\Services\Auth\BaseOidcUserProvider::__construct() does not have parameter type hint for its parameter $defaultRole but it should be possible to add it based on @param annotation "string".

Type hint "string" missing for $model

Type hint "string" missing for $defaultRole

        $this->model = $model;
        $this->defaultRole = $defaultRole;
    }

    /**
     * Retrieve a user by their unique identifier.
     *
     * @param  mixed  $identifier

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @return \Illuminate\Contracts\Auth\Authenticatable|null
     */
    public function retrieveById($identifier) {

Method \App\Services\Auth\BaseOidcUserProvider::retrieveById() does not have return type hint for its return value but it should be possible to add it based on @return annotation "\Illuminate\Contracts\Auth\Authenticatable|null".

        $model = $this->createModel();

        return $model->newQuery()

The expression return $model->newQuery()->where($model->getAuthIdentifierName(), $identifier)->first() also could return the type Illuminate\Database\Eloquent\Model which is incompatible with the documented return type Illuminate\Contracts\Auth\Authenticatable|null.

                        ->where($model->getAuthIdentifierName(), $identifier)
                        ->first();
    }

    /**
     * Retrieve a user by their unique identifier and "remember me" token.
     *
     * @param  mixed  $identifier

Missing parameter comment

     * @param  string  $token

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @return \Illuminate\Contracts\Auth\Authenticatable|null
     */
    public function retrieveByToken($identifier, $token) {

Method \App\Services\Auth\BaseOidcUserProvider::retrieveByToken() does not have return type hint for its return value but it should be possible to add it based on @return annotation "\Illuminate\Contracts\Auth\Authenticatable|null".

Type hint "string" missing for $token

        //TODO: Should we implement "remember me" tokens?
        return null;
    }

    /**
     * Update the "remember me" token for the given user in storage.
     *
     * @param  \Illuminate\Contracts\Auth\Authenticatable  $user

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @param  string  $token

Missing parameter comment

Expected 37 spaces after parameter type; 2 found

     * @return void
     */
    public function updateRememberToken(Authenticatable $user, $token) {

Method \App\Services\Auth\BaseOidcUserProvider::updateRememberToken() does not have parameter type hint for its parameter $token but it should be possible to add it based on @param annotation "string".

Method \App\Services\Auth\BaseOidcUserProvider::updateRememberToken() does not have return type hint for its return value but it should be possible to add it based on @return annotation "void".

Type hint "string" missing for $token

        //TODO: Should we implement "remember me" tokens?
    }

    /**
     * Retrieve a user by the given credentials.
     *
     * @param  array  $credentials

@param annotation of method \App\Services\Auth\BaseOidcUserProvider::retrieveByCredentials() does not specify type hint for items of its traversable parameter $credentials.

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @return App\Services\Auth\Contracts\OidcAuthenticatable|null
     */
    public function retrieveByCredentials(array $credentials) {
        if (empty($credentials)) {
            return;

Function return type is not void, but function is returning void here

        }
        if (isset($credentials['iss']) && isset($credentials['sub'])) {
            // First we will try to find a user that matches the openid issuer
            // and sub code.

            $model = $this->createModel();

            $user = $model->findByOidcSub($credentials['iss'], $credentials['sub']);

            // If no user was found, use the provided credentials to create a
            // new user
            if ($user === null) {

Blank line found at start of control structure

                $user = $this->createUserFromCredentials($credentials);
                if ($user) {
                    //If a user was created successfully, save it to database
                    $user->save();
                }

Blank line found at end of control structure

            }

            //If running in a local environment, and FORCE_ADMIN is true,
            //automatically set any logged in user to (temporarilly) be an admin
            if (App::environment() == 'local' && Config::get('app.force_admin')) {
                $adminRole = UserRole::where('name', 'admin')->firstOrFail();
                $user->user_role_id = $adminRole->id;
                // $user->user_role = $adminRole;
                $user->save();
            }

            //Ensure the user has a proper profile associated with it
            //If now profile exists yet create one.
            //Admins should be givven an applicant and manager profile
            if ($user->user_role->name == 'applicant' ||
                $user->user_role->name == 'admin') {
                $applicantProfile = Applicant::where(['user_id' => $user->id])->first();
                if (!$applicantProfile) {
                    $applicantProfile = new Applicant();
                    $applicantProfile->user_id = $user->id;
                    $applicantProfile->save();
                }

Blank line found at end of control structure

            }
            if ($user->user_role->name == 'manager' ||
                $user->user_role->name == 'admin') {
                $managerProfile = Manager::where(['user_id' => $user->id])->first();
                if (!$managerProfile) {
                    $managerProfile = new Manager();
                    $managerProfile->user_id = $user->id;
                    $managerProfile->save();
                }
            }

            return $user;
        } else {
            return;
        }
    }

    /**
     * Create a new user object using the given credentials.
     *
     * @param  array  $credentials

@param annotation of method \App\Services\Auth\BaseOidcUserProvider::createUserFromCredentials() does not specify type hint for items of its traversable parameter $credentials.

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @return App\Services\Auth\Contracts\OidcAuthenticatable|null
     */
    public function createUserFromCredentials(array $credentials) {

Method \App\Services\Auth\BaseOidcUserProvider::createUserFromCredentials() does not have return type hint for its return value but it should be possible to add it based on @return annotation "App\Services\Auth\Contracts\OidcAuthenticatable|null".

        //At a minimum, email, iss and sub codes must be available.
        if (!isset($credentials['email']) || !isset($credentials['iss']) ||
                !isset($credentials['sub'])) {
            return null;
        }

        $model = $this->createModel();

        $name = isset($credentials['name']) ? $credentials['name'] : "";

        return $model->createWithOidcCredentials($name, $credentials['email'],

The expression return $model->createWithOidcCredentials($name, $credentials['email'], $credentials['iss'], $credentials['sub'], $this->defaultRole) also could return the type Illuminate\Database\Eloquent\Builder which is incompatible with the documented return type Illuminate\Support\Facades\App\Services\Auth\Contracts\OidcAuthenticatable|null.

                $credentials['iss'], $credentials['sub'], $this->defaultRole);
    }

    /**
     * Validate a user against the given credentials.
     *
     * @param  App\Services\Auth\Contracts\OidcAuthenticatable  $user

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @param  array  $credentials

@param annotation of method \App\Services\Auth\BaseOidcUserProvider::validateCredentials() does not specify type hint for items of its traversable parameter $credentials.

Missing parameter comment

Expected 43 spaces after parameter type; 2 found

     * @return bool

Expected "boolean" but found "bool" for function return type

     */
    public function validateCredentials(Authenticatable $user, array $credentials) {

Method \App\Services\Auth\BaseOidcUserProvider::validateCredentials() does not have return type hint for its return value but it should be possible to add it based on @return annotation "bool".

        return $user instanceof Authenticatable;
        //$subMatches = $credentials['sub'] === $user->getSub($credentials['iss']);
        //return $subMatches;
    }

    /**
     * Create a new instance of the model.
     *
     * @return \Illuminate\Database\Eloquent\Model
     */
    public function createModel() {

Method \App\Services\Auth\BaseOidcUserProvider::createModel() does not have return type hint for its return value but it should be possible to add it based on @return annotation "\Illuminate\Database\Eloquent\Model".

        $class = '\\' . ltrim($this->model, '\\');

        return new $class;
    }

    /**
     * Gets the name of the Eloquent user model.
     *
     * @return string
     */
    public function getModel() {

Method \App\Services\Auth\BaseOidcUserProvider::getModel() does not have return type hint for its return value but it should be possible to add it based on @return annotation "string".

        return $this->model;
    }

    /**
     * Sets the name of the Eloquent user model.
     *
     * @param  string  $model

Missing parameter comment

Expected 1 spaces after parameter type; 2 found

     * @return $this
     */
    public function setModel($model) {

Method \App\Services\Auth\BaseOidcUserProvider::setModel() does not have parameter type hint for its parameter $model but it should be possible to add it based on @param annotation "string".

Type hint "string" missing for $model

        $this->model = $model;

        return $this;
    }

}