kanboard_ynh/sources/app/Model/ProjectPermission.php

<?php

namespace Model;

use SimpleValidator\Validator;
use SimpleValidator\Validators;

/**
 * Project permission model
 *
 * @package  model
 * @author   Frederic Guillot
 */
class ProjectPermission extends Base
{
    /**
     * SQL table name for permissions
     *
     * @var string
     */
    const TABLE = 'project_has_users';

    /**
     * Get a list of people that can be assigned for tasks
     *
     * @access public
     * @param  integer   $project_id            Project id
     * @param  bool      $prepend_unassigned    Prepend the 'Unassigned' value
     * @param  bool      $prepend_everybody     Prepend the 'Everbody' value
     * @param  bool      $allow_single_user     If there is only one user return only this user
     * @return array
     */
    public function getMemberList($project_id, $prepend_unassigned = true, $prepend_everybody = false, $allow_single_user = false)
    {
        $allowed_users = $this->getMembers($project_id);

        if ($allow_single_user && count($allowed_users) === 1) {
            return $allowed_users;
        }

        if ($prepend_unassigned) {
            $allowed_users = array(t('Unassigned')) + $allowed_users;
        }

        if ($prepend_everybody) {
            $allowed_users = array(User::EVERYBODY_ID => t('Everybody')) + $allowed_users;
        }

        return $allowed_users;
    }

    /**
     * Get a list of allowed people for a project
     *
     * @access public
     * @param  integer   $project_id   Project id
     * @return array
     */
    public function getMembers($project_id)
    {
        if ($this->isEverybodyAllowed($project_id)) {
            return $this->user->getList();
        }

        return $this->getAssociatedUsers($project_id);
    }

    /**
     * Get a list of people associated to the project
     *
     * @access public
     * @param  integer   $project_id   Project id
     * @return array
     */
    public function getAssociatedUsers($project_id)
    {
        $users = $this->db
            ->table(self::TABLE)
            ->join(User::TABLE, 'id', 'user_id')
            ->eq('project_id', $project_id)
            ->asc('username')
            ->columns(User::TABLE.'.id', User::TABLE.'.username', User::TABLE.'.name')
            ->findAll();

        return $this->user->prepareList($users);
    }

    /**
     * Get a list of owners for a project
     *
     * @access public
     * @param  integer   $project_id   Project id
     * @return array
     */
    public function getManagers($project_id)
    {
        $users = $this->db
            ->table(self::TABLE)
            ->join(User::TABLE, 'id', 'user_id')
            ->eq('project_id', $project_id)
            ->eq('is_owner', 1)
            ->asc('username')
            ->columns(User::TABLE.'.id', User::TABLE.'.username', User::TABLE.'.name')
            ->findAll();

        return $this->user->prepareList($users);
    }

    /**
     * Get allowed and not allowed users for a project
     *
     * @access public
     * @param  integer   $project_id   Project id
     * @return array
     */
    public function getAllUsers($project_id)
    {
        $users = array(
            'allowed' => array(),
            'not_allowed' => array(),
            'managers' => array(),
        );

        $all_users = $this->user->getList();

        $users['allowed'] = $this->getMembers($project_id);
        $users['managers'] = $this->getManagers($project_id);

        foreach ($all_users as $user_id => $username) {

            if (! isset($users['allowed'][$user_id])) {
                $users['not_allowed'][$user_id] = $username;
            }
        }

        return $users;
    }

    /**
     * Add a new project member
     *
     * @access public
     * @param  integer   $project_id   Project id
     * @param  integer   $user_id      User id
     * @return bool
     */
    public function addMember($project_id, $user_id)
    {
        return $this->db
                    ->table(self::TABLE)
                    ->save(array('project_id' => $project_id, 'user_id' => $user_id));
    }

    /**
     * Remove a member
     *
     * @access public
     * @param  integer   $project_id   Project id
     * @param  integer   $user_id      User id
     * @return bool
     */
    public function revokeMember($project_id, $user_id)
    {
        return $this->db
                    ->table(self::TABLE)
                    ->eq('project_id', $project_id)
                    ->eq('user_id', $user_id)
                    ->remove();
    }

    /**
     * Add a project manager
     *
     * @access public
     * @param  integer   $project_id   Project id
     * @param  integer   $user_id      User id
     * @return bool
     */
    public function addManager($project_id, $user_id)
    {
        return $this->db
                    ->table(self::TABLE)
                    ->save(array('project_id' => $project_id, 'user_id' => $user_id, 'is_owner' => 1));
    }

    /**
     * Change the role of a member
     *
     * @access public
     * @param  integer   $project_id   Project id
     * @param  integer   $user_id      User id
     * @param  integer   $is_owner     Is user owner of the project
     * @return bool
     */
    public function changeRole($project_id, $user_id, $is_owner)
    {
        return $this->db
                    ->table(self::TABLE)
                    ->eq('project_id', $project_id)
                    ->eq('user_id', $user_id)
                    ->update(array('is_owner' => (int) $is_owner));
    }

    /**
     * Check if a specific user is member of a project
     *
     * @access public
     * @param  integer   $project_id   Project id
     * @param  integer   $user_id      User id
     * @return bool
     */
    public function isMember($project_id, $user_id)
    {
        if ($this->isEverybodyAllowed($project_id)) {
            return true;
        }

        return $this->db
                    ->table(self::TABLE)
                    ->eq('project_id', $project_id)
                    ->eq('user_id', $user_id)
                    ->count() === 1;
	}

	/**
     * Check if a specific user is manager of a given project
     *
     * @access public
     * @param  integer   $project_id   Project id
     * @param  integer   $user_id      User id
     * @return bool
     */
    public function isManager($project_id, $user_id)
    {
        return $this->db
                    ->table(self::TABLE)
                    ->eq('project_id', $project_id)
                    ->eq('user_id', $user_id)
                    ->eq('is_owner', 1)
                    ->count() === 1;
    }

    /**
     * Check if a specific user is allowed to access to a given project
     *
     * @access public
     * @param  integer   $project_id   Project id
     * @param  integer   $user_id      User id
     * @return bool
     */
    public function isUserAllowed($project_id, $user_id)
    {
        return $project_id === 0 || $this->user->isAdmin($user_id) || $this->isMember($project_id, $user_id);
    }

    /**
     * Return true if everybody is allowed for the project
     *
     * @access public
     * @param  integer   $project_id   Project id
     * @return bool
     */
    public function isEverybodyAllowed($project_id)
    {
        return $this->db
                    ->table(Project::TABLE)
                    ->eq('id', $project_id)
                    ->eq('is_everybody_allowed', 1)
                    ->count() === 1;
    }

    /**
     * Filter a list of projects for a given user
     *
     * @access public
     * @param  array     $projects     Project list: ['project_id' => 'project_name']
     * @param  integer   $user_id      User id
     * @param  string    $filter       Method name to apply
     * @return array
     */
    public function filterProjects(array $projects, $user_id, $filter = 'isUserAllowed')
    {
        foreach ($projects as $project_id => $project_name) {
            if (! $this->$filter($project_id, $user_id)) {
                unset($projects[$project_id]);
            }
        }

        return $projects;
    }

    /**
     * Return a list of allowed projects for a given user
     *
     * @access public
     * @param  integer   $user_id      User id
     * @return array
     */
    public function getAllowedProjects($user_id)
    {
        if ($this->user->isAdmin($user_id)) {
            return $this->project->getListByStatus(Project::ACTIVE);
        }

        return $this->getMemberProjects($user_id);
    }

    /**
     * Return a list of projects where the user is member
     *
     * @access public
     * @param  integer   $user_id      User id
     * @return array
     */
    public function getMemberProjects($user_id)
    {
        return $this->db
                    ->hashtable(Project::TABLE)
                    ->eq('user_id', $user_id)
                    ->join(self::TABLE, 'project_id', 'id')
                    ->getAll('projects.id', 'name');
    }

    /**
     * Return a list of project ids where the user is member
     *
     * @access public
     * @param  integer   $user_id      User id
     * @return array
     */
    public function getMemberProjectIds($user_id)
    {
        return $this->db
                    ->table(Project::TABLE)
                    ->eq('user_id', $user_id)
                    ->join(self::TABLE, 'project_id', 'id')
                    ->findAllByColumn('projects.id');
    }

    /**
     * Return a list of active project ids where the user is member
     *
     * @access public
     * @param  integer   $user_id      User id
     * @return array
     */
    public function getActiveMemberProjectIds($user_id)
    {
        return $this->db
                    ->table(Project::TABLE)
                    ->eq('user_id', $user_id)
                    ->eq(Project::TABLE.'.is_active', Project::ACTIVE)
                    ->join(self::TABLE, 'project_id', 'id')
                    ->findAllByColumn('projects.id');
    }

    /**
     * Return a list of active projects where the user is member
     *
     * @access public
     * @param  integer   $user_id      User id
     * @return array
     */
    public function getActiveMemberProjects($user_id)
    {
        return $this->db
                    ->hashtable(Project::TABLE)
                    ->eq('user_id', $user_id)
                    ->eq(Project::TABLE.'.is_active', Project::ACTIVE)
                    ->join(self::TABLE, 'project_id', 'id')
                    ->getAll('projects.id', 'name');
    }

    /**
     * Copy user access from a project to another one
     *
     * @param  integer    $project_src       Project Template
     * @return integer    $project_dst       Project that receives the copy
     * @return boolean
     */
    public function duplicate($project_src, $project_dst)
    {
        $rows = $this->db
                     ->table(self::TABLE)
                     ->columns('project_id', 'user_id', 'is_owner')
                     ->eq('project_id', $project_src)
                     ->findAll();

        foreach ($rows as $row) {

            $result = $this->db
                           ->table(self::TABLE)
                           ->save(array(
                               'project_id' => $project_dst,
                               'user_id' => $row['user_id'],
                               'is_owner' => (int) $row['is_owner'], // (int) for postgres
                           ));

            if (! $result) {
                return false;
            }
        }

        return true;
    }

    /**
     * Validate allow user
     *
     * @access public
     * @param  array   $values           Form values
     * @return array   $valid, $errors   [0] = Success or not, [1] = List of errors
     */
    public function validateUserModification(array $values)
    {
        $v = new Validator($values, array(
            new Validators\Required('project_id', t('The project id is required')),
            new Validators\Integer('project_id', t('This value must be an integer')),
            new Validators\Required('user_id', t('The user id is required')),
            new Validators\Integer('user_id', t('This value must be an integer')),
            new Validators\Integer('is_owner', t('This value must be an integer')),
        ));

        return array(
            $v->execute(),
            $v->getErrors()
        );
    }

    /**
     * Validate allow everybody
     *
     * @access public
     * @param  array   $values           Form values
     * @return array   $valid, $errors   [0] = Success or not, [1] = List of errors
     */
    public function validateProjectModification(array $values)
    {
        $v = new Validator($values, array(
            new Validators\Required('id', t('The project id is required')),
            new Validators\Integer('id', t('This value must be an integer')),
            new Validators\Integer('is_everybody_allowed', t('This value must be an integer')),
        ));

        return array(
            $v->execute(),
            $v->getErrors()
        );
    }
}