getAllowedUsers($project_id); if (empty($allowed_users)) { $allowed_users = $this->user->getList(); } 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 getAllowedUsers($project_id) { $users = $this->db ->table(self::TABLE_USERS) ->join(User::TABLE, 'id', 'user_id') ->eq('project_id', $project_id) ->asc('username') ->columns(User::TABLE.'.id', User::TABLE.'.username', User::TABLE.'.name') ->findAll(); $result = array(); foreach ($users as $user) { $result[$user['id']] = $user['name'] ?: $user['username']; } asort($result); return $result; } /** * 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(), ); $all_users = $this->user->getList(); $users['allowed'] = $this->getAllowedUsers($project_id); foreach ($all_users as $user_id => $username) { if (! isset($users['allowed'][$user_id])) { $users['not_allowed'][$user_id] = $username; } } return $users; } /** * Allow a specific user for a given project * * @access public * @param integer $project_id Project id * @param integer $user_id User id * @return bool */ public function allowUser($project_id, $user_id) { return $this->db ->table(self::TABLE_USERS) ->save(array('project_id' => $project_id, 'user_id' => $user_id)); } /** * Revoke a specific user for a given project * * @access public * @param integer $project_id Project id * @param integer $user_id User id * @return bool */ public function revokeUser($project_id, $user_id) { return $this->db ->table(self::TABLE_USERS) ->eq('project_id', $project_id) ->eq('user_id', $user_id) ->remove(); } /** * 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) { // If there is nobody specified, everybody have access to the project $nb_users = $this->db ->table(self::TABLE_USERS) ->eq('project_id', $project_id) ->count(); if ($nb_users < 1) return true; // Check if user has admin rights $nb_users = $this->db ->table(User::TABLE) ->eq('id', $user_id) ->eq('is_admin', 1) ->count(); if ($nb_users > 0) return true; // Otherwise, allow only specific users return (bool) $this->db ->table(self::TABLE_USERS) ->eq('project_id', $project_id) ->eq('user_id', $user_id) ->count(); } /** * Get a project by the id * * @access public * @param integer $project_id Project id * @return array */ public function getById($project_id) { return $this->db->table(self::TABLE)->eq('id', $project_id)->findOne(); } /** * Get a project by the name * * @access public * @param string $project_name Project name * @return array */ public function getByName($project_name) { return $this->db->table(self::TABLE)->eq('name', $project_name)->findOne(); } /** * Fetch project data by using the token * * @access public * @param string $token Token * @return array */ public function getByToken($token) { return $this->db->table(self::TABLE)->eq('token', $token)->eq('is_public', 1)->findOne(); } /** * Return the first project from the database (no sorting) * * @access public * @return array */ public function getFirst() { return $this->db->table(self::TABLE)->findOne(); } /** * Get all projects, optionaly fetch stats for each project and can check users permissions * * @access public * @param bool $filter_permissions If true, remove projects not allowed for the current user * @return array */ public function getAll($filter_permissions = false) { $projects = $this->db->table(self::TABLE)->asc('name')->findAll(); if ($filter_permissions) { foreach ($projects as $key => $project) { if (! $this->isUserAllowed($project['id'], $this->acl->getUserId())) { unset($projects[$key]); } } } return $projects; } /** * Return the list of all projects * * @access public * @param bool $prepend If true, prepend to the list the value 'None' * @return array */ public function getList($prepend = true) { if ($prepend) { return array(t('None')) + $this->db->table(self::TABLE)->asc('name')->listing('id', 'name'); } return $this->db->table(self::TABLE)->asc('name')->listing('id', 'name'); } /** * Get all projects with all its data for a given status * * @access public * @param integer $status Proejct status: self::ACTIVE or self:INACTIVE * @return array */ public function getAllByStatus($status) { return $this->db ->table(self::TABLE) ->asc('name') ->eq('is_active', $status) ->findAll(); } /** * Get a list of project by status * * @access public * @param integer $status Project status: self::ACTIVE or self:INACTIVE * @return array */ public function getListByStatus($status) { return $this->db ->table(self::TABLE) ->asc('name') ->eq('is_active', $status) ->listing('id', 'name'); } /** * Return the number of projects by status * * @access public * @param integer $status Status: self::ACTIVE or self:INACTIVE * @return integer */ public function countByStatus($status) { return $this->db ->table(self::TABLE) ->eq('is_active', $status) ->count(); } /** * 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 * @return array */ public function filterListByAccess(array $projects, $user_id) { foreach ($projects as $project_id => $project_name) { if (! $this->isUserAllowed($project_id, $user_id)) { unset($projects[$project_id]); } } return $projects; } /** * Return a list of projects for a given user * * @access public * @param integer $user_id User id * @return array */ public function getAvailableList($user_id) { return $this->filterListByAccess($this->getListByStatus(self::ACTIVE), $user_id); } /** * Gather some task metrics for a given project * * @access public * @param integer $project_id Project id * @return array */ public function getStats($project_id) { $stats = array(); $columns = $this->board->getcolumns($project_id); $stats['nb_active_tasks'] = 0; foreach ($columns as &$column) { $column['nb_active_tasks'] = $this->task->countByColumnId($project_id, $column['id']); $stats['nb_active_tasks'] += $column['nb_active_tasks']; } $stats['columns'] = $columns; $stats['nb_tasks'] = $this->task->countByProjectId($project_id); $stats['nb_inactive_tasks'] = $stats['nb_tasks'] - $stats['nb_active_tasks']; return $stats; } /** * Create a project from another one. * * @author Antonio Rabelo * @param integer $project_id Project Id * @return integer Cloned Project Id */ public function createProjectFromAnotherProject($project_id) { $project_name = $this->db->table(self::TABLE)->eq('id', $project_id)->findOneColumn('name'); $project = array( 'name' => $project_name.' ('.t('Clone').')', 'is_active' => true, 'last_modified' => 0, 'token' => '', ); if (! $this->db->table(self::TABLE)->save($project)) { return false; } return $this->db->getConnection()->getLastId(); } /** * Copy user access from a project to another one * * @author Antonio Rabelo * @param integer $project_from Project Template * @return integer $project_to Project that receives the copy * @return boolean */ public function duplicateUsers($project_from, $project_to) { $users = $this->getAllowedUsers($project_from); foreach ($users as $user_id => $name) { if (! $this->allowUser($project_to, $user_id)) { return false; } } return true; } /** * Clone a project * * @author Antonio Rabelo * @param integer $project_id Project Id * @return integer Cloned Project Id */ public function duplicate($project_id) { $this->db->startTransaction(); // Get the cloned project Id $clone_project_id = $this->createProjectFromAnotherProject($project_id); if (! $clone_project_id) { $this->db->cancelTransaction(); return false; } // Clone Board if (! $this->board->duplicate($project_id, $clone_project_id)) { $this->db->cancelTransaction(); return false; } // Clone Categories if (! $this->category->duplicate($project_id, $clone_project_id)) { $this->db->cancelTransaction(); return false; } // Clone Allowed Users if (! $this->duplicateUsers($project_id, $clone_project_id)) { $this->db->cancelTransaction(); return false; } // Clone Actions if (! $this->action->duplicate($project_id, $clone_project_id)) { $this->db->cancelTransaction(); return false; } $this->db->closeTransaction(); return (int) $clone_project_id; } /** * Create a project * * @access public * @param array $values Form values * @return integer Project id */ public function create(array $values) { $this->db->startTransaction(); $values['token'] = ''; if (! $this->db->table(self::TABLE)->save($values)) { $this->db->cancelTransaction(); return false; } $project_id = $this->db->getConnection()->getLastId(); $column_names = explode(',', $this->config->get('default_columns', implode(',', $this->board->getDefaultColumns()))); $columns = array(); foreach ($column_names as $column_name) { $column_name = trim($column_name); if (! empty($column_name)) { $columns[] = array('title' => $column_name, 'task_limit' => 0); } } $this->board->create($project_id, $columns); $this->db->closeTransaction(); return (int) $project_id; } /** * Check if the project have been modified * * @access public * @param integer $project_id Project id * @param integer $timestamp Timestamp * @return bool */ public function isModifiedSince($project_id, $timestamp) { return (bool) $this->db->table(self::TABLE) ->eq('id', $project_id) ->gt('last_modified', $timestamp) ->count(); } /** * Update modification date * * @access public * @param integer $project_id Project id * @return bool */ public function updateModificationDate($project_id) { return $this->db->table(self::TABLE)->eq('id', $project_id)->save(array( 'last_modified' => time() )); } /** * Update a project * * @access public * @param array $values Form values * @return bool */ public function update(array $values) { return $this->exists($values['id']) && $this->db->table(self::TABLE)->eq('id', $values['id'])->save($values); } /** * Remove a project * * @access public * @param integer $project_id Project id * @return bool */ public function remove($project_id) { return $this->db->table(self::TABLE)->eq('id', $project_id)->remove(); } /** * Return true if the project exists * * @access public * @param integer $project_id Project id * @return boolean */ public function exists($project_id) { return $this->db->table(self::TABLE)->eq('id', $project_id)->count() === 1; } /** * Enable a project * * @access public * @param integer $project_id Project id * @return bool */ public function enable($project_id) { return $this->exists($project_id) && $this->db ->table(self::TABLE) ->eq('id', $project_id) ->update(array('is_active' => 1)); } /** * Disable a project * * @access public * @param integer $project_id Project id * @return bool */ public function disable($project_id) { return $this->exists($project_id) && $this->db ->table(self::TABLE) ->eq('id', $project_id) ->update(array('is_active' => 0)); } /** * Enable public access for a project * * @access public * @param integer $project_id Project id * @return bool */ public function enablePublicAccess($project_id) { return $this->exists($project_id) && $this->db ->table(self::TABLE) ->eq('id', $project_id) ->save(array('is_public' => 1, 'token' => Security::generateToken())); } /** * Disable public access for a project * * @access public * @param integer $project_id Project id * @return bool */ public function disablePublicAccess($project_id) { return $this->exists($project_id) && $this->db ->table(self::TABLE) ->eq('id', $project_id) ->save(array('is_public' => 0, 'token' => '')); } /** * Common validation rules * * @access private * @return array */ private function commonValidationRules() { return array( new Validators\Integer('id', t('This value must be an integer')), new Validators\Integer('is_active', t('This value must be an integer')), new Validators\Required('name', t('The project name is required')), new Validators\MaxLength('name', t('The maximum length is %d characters', 50), 50), new Validators\Unique('name', t('This project must be unique'), $this->db->getConnection(), self::TABLE), ); } /** * Validate project creation * * @access public * @param array $values Form values * @return array $valid, $errors [0] = Success or not, [1] = List of errors */ public function validateCreation(array $values) { $v = new Validator($values, $this->commonValidationRules()); return array( $v->execute(), $v->getErrors() ); } /** * Validate project modification * * @access public * @param array $values Form values * @return array $valid, $errors [0] = Success or not, [1] = List of errors */ public function validateModification(array $values) { $rules = array( new Validators\Required('id', t('This value is required')), ); $v = new Validator($values, array_merge($rules, $this->commonValidationRules())); return array( $v->execute(), $v->getErrors() ); } /** * Validate allowed users * * @access public * @param array $values Form values * @return array $valid, $errors [0] = Success or not, [1] = List of errors */ public function validateUserAccess(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')), )); return array( $v->execute(), $v->getErrors() ); } /** * Attach events * * @access public */ public function attachEvents() { $events = array( Task::EVENT_UPDATE, Task::EVENT_CREATE, Task::EVENT_CLOSE, Task::EVENT_OPEN, ); $listener = new ProjectModificationDate($this); foreach ($events as $event_name) { $this->event->attach($event_name, $listener); } } /** * Get project activity * * @access public * @param integer $project_id Project id * @return array */ public function getActivity($project_id) { $activity = array(); $tasks = $this->taskHistory->getAllContentByProjectId($project_id, 25); $comments = $this->commentHistory->getAllContentByProjectId($project_id, 25); $subtasks = $this->subtaskHistory->getAllContentByProjectId($project_id, 25); foreach ($tasks as &$task) { $activity[$task['date_creation'].'-'.$task['id']] = $task; } foreach ($subtasks as &$subtask) { $activity[$subtask['date_creation'].'-'.$subtask['id']] = $subtask; } foreach ($comments as &$comment) { $activity[$comment['date_creation'].'-'.$comment['id']] = $comment; } krsort($activity); return $activity; } }