summaryrefslogtreecommitdiff
path: root/app/Model/UserModel.php
diff options
context:
space:
mode:
Diffstat (limited to 'app/Model/UserModel.php')
-rw-r--r--app/Model/UserModel.php390
1 files changed, 390 insertions, 0 deletions
diff --git a/app/Model/UserModel.php b/app/Model/UserModel.php
new file mode 100644
index 00000000..f7a051c5
--- /dev/null
+++ b/app/Model/UserModel.php
@@ -0,0 +1,390 @@
+<?php
+
+namespace Kanboard\Model;
+
+use PicoDb\Database;
+use Kanboard\Core\Base;
+use Kanboard\Core\Security\Token;
+use Kanboard\Core\Security\Role;
+
+/**
+ * User model
+ *
+ * @package Kanboard\Model
+ * @author Frederic Guillot
+ */
+class UserModel extends Base
+{
+ /**
+ * SQL table name
+ *
+ * @var string
+ */
+ const TABLE = 'users';
+
+ /**
+ * Id used for everybody (filtering)
+ *
+ * @var integer
+ */
+ const EVERYBODY_ID = -1;
+
+ /**
+ * Return true if the user exists
+ *
+ * @access public
+ * @param integer $user_id User id
+ * @return boolean
+ */
+ public function exists($user_id)
+ {
+ return $this->db->table(self::TABLE)->eq('id', $user_id)->exists();
+ }
+
+ /**
+ * Return true if the user is active
+ *
+ * @access public
+ * @param integer $user_id User id
+ * @return boolean
+ */
+ public function isActive($user_id)
+ {
+ return $this->db->table(self::TABLE)->eq('id', $user_id)->eq('is_active', 1)->exists();
+ }
+
+ /**
+ * Get query to fetch all users
+ *
+ * @access public
+ * @return \PicoDb\Table
+ */
+ public function getQuery()
+ {
+ return $this->db->table(self::TABLE);
+ }
+
+ /**
+ * Return the full name
+ *
+ * @param array $user User properties
+ * @return string
+ */
+ public function getFullname(array $user)
+ {
+ return $user['name'] ?: $user['username'];
+ }
+
+ /**
+ * Return true is the given user id is administrator
+ *
+ * @access public
+ * @param integer $user_id User id
+ * @return boolean
+ */
+ public function isAdmin($user_id)
+ {
+ return $this->userSession->isAdmin() || // Avoid SQL query if connected
+ $this->db
+ ->table(UserModel::TABLE)
+ ->eq('id', $user_id)
+ ->eq('role', Role::APP_ADMIN)
+ ->exists();
+ }
+
+ /**
+ * Get a specific user by id
+ *
+ * @access public
+ * @param integer $user_id User id
+ * @return array
+ */
+ public function getById($user_id)
+ {
+ return $this->db->table(self::TABLE)->eq('id', $user_id)->findOne();
+ }
+
+ /**
+ * Get a specific user by the Google id
+ *
+ * @access public
+ * @param string $column
+ * @param string $id
+ * @return array|boolean
+ */
+ public function getByExternalId($column, $id)
+ {
+ if (empty($id)) {
+ return false;
+ }
+
+ return $this->db->table(self::TABLE)->eq($column, $id)->findOne();
+ }
+
+ /**
+ * Get a specific user by the username
+ *
+ * @access public
+ * @param string $username Username
+ * @return array
+ */
+ public function getByUsername($username)
+ {
+ return $this->db->table(self::TABLE)->eq('username', $username)->findOne();
+ }
+
+ /**
+ * Get user_id by username
+ *
+ * @access public
+ * @param string $username Username
+ * @return integer
+ */
+ public function getIdByUsername($username)
+ {
+ return $this->db->table(self::TABLE)->eq('username', $username)->findOneColumn('id');
+ }
+
+ /**
+ * Get a specific user by the email address
+ *
+ * @access public
+ * @param string $email Email
+ * @return array|boolean
+ */
+ public function getByEmail($email)
+ {
+ if (empty($email)) {
+ return false;
+ }
+
+ return $this->db->table(self::TABLE)->eq('email', $email)->findOne();
+ }
+
+ /**
+ * Fetch user by using the token
+ *
+ * @access public
+ * @param string $token Token
+ * @return array|boolean
+ */
+ public function getByToken($token)
+ {
+ if (empty($token)) {
+ return false;
+ }
+
+ return $this->db->table(self::TABLE)->eq('token', $token)->findOne();
+ }
+
+ /**
+ * Get all users
+ *
+ * @access public
+ * @return array
+ */
+ public function getAll()
+ {
+ return $this->getQuery()->asc('username')->findAll();
+ }
+
+ /**
+ * Get the number of users
+ *
+ * @access public
+ * @return integer
+ */
+ public function count()
+ {
+ return $this->db->table(self::TABLE)->count();
+ }
+
+ /**
+ * List all users (key-value pairs with id/username)
+ *
+ * @access public
+ * @param boolean $prepend Prepend "All users"
+ * @return array
+ */
+ public function getActiveUsersList($prepend = false)
+ {
+ $users = $this->db->table(self::TABLE)->eq('is_active', 1)->columns('id', 'username', 'name')->findAll();
+ $listing = $this->prepareList($users);
+
+ if ($prepend) {
+ return array(UserModel::EVERYBODY_ID => t('Everybody')) + $listing;
+ }
+
+ return $listing;
+ }
+
+ /**
+ * Common method to prepare a user list
+ *
+ * @access public
+ * @param array $users Users list (from database)
+ * @return array Formated list
+ */
+ public function prepareList(array $users)
+ {
+ $result = array();
+
+ foreach ($users as $user) {
+ $result[$user['id']] = $this->getFullname($user);
+ }
+
+ asort($result);
+
+ return $result;
+ }
+
+ /**
+ * Prepare values before an update or a create
+ *
+ * @access public
+ * @param array $values Form values
+ */
+ public function prepare(array &$values)
+ {
+ if (isset($values['password'])) {
+ if (! empty($values['password'])) {
+ $values['password'] = \password_hash($values['password'], PASSWORD_BCRYPT);
+ } else {
+ unset($values['password']);
+ }
+ }
+
+ $this->helper->model->removeFields($values, array('confirmation', 'current_password'));
+ $this->helper->model->resetFields($values, array('is_ldap_user', 'disable_login_form'));
+ $this->helper->model->convertNullFields($values, array('gitlab_id'));
+ $this->helper->model->convertIntegerFields($values, array('gitlab_id'));
+ }
+
+ /**
+ * Add a new user in the database
+ *
+ * @access public
+ * @param array $values Form values
+ * @return boolean|integer
+ */
+ public function create(array $values)
+ {
+ $this->prepare($values);
+ return $this->db->table(self::TABLE)->persist($values);
+ }
+
+ /**
+ * Modify a new user
+ *
+ * @access public
+ * @param array $values Form values
+ * @return boolean
+ */
+ public function update(array $values)
+ {
+ $this->prepare($values);
+ $result = $this->db->table(self::TABLE)->eq('id', $values['id'])->update($values);
+ $this->userSession->refresh($values['id']);
+ return $result;
+ }
+
+ /**
+ * Disable a specific user
+ *
+ * @access public
+ * @param integer $user_id
+ * @return boolean
+ */
+ public function disable($user_id)
+ {
+ return $this->db->table(self::TABLE)->eq('id', $user_id)->update(array('is_active' => 0));
+ }
+
+ /**
+ * Enable a specific user
+ *
+ * @access public
+ * @param integer $user_id
+ * @return boolean
+ */
+ public function enable($user_id)
+ {
+ return $this->db->table(self::TABLE)->eq('id', $user_id)->update(array('is_active' => 1));
+ }
+
+ /**
+ * Remove a specific user
+ *
+ * @access public
+ * @param integer $user_id User id
+ * @return boolean
+ */
+ public function remove($user_id)
+ {
+ $this->avatarFileModel->remove($user_id);
+
+ return $this->db->transaction(function (Database $db) use ($user_id) {
+
+ // All assigned tasks are now unassigned (no foreign key)
+ if (! $db->table(TaskModel::TABLE)->eq('owner_id', $user_id)->update(array('owner_id' => 0))) {
+ return false;
+ }
+
+ // All assigned subtasks are now unassigned (no foreign key)
+ if (! $db->table(SubtaskModel::TABLE)->eq('user_id', $user_id)->update(array('user_id' => 0))) {
+ return false;
+ }
+
+ // All comments are not assigned anymore (no foreign key)
+ if (! $db->table(CommentModel::TABLE)->eq('user_id', $user_id)->update(array('user_id' => 0))) {
+ return false;
+ }
+
+ // All private projects are removed
+ $project_ids = $db->table(ProjectModel::TABLE)
+ ->eq('is_private', 1)
+ ->eq(ProjectUserRoleModel::TABLE.'.user_id', $user_id)
+ ->join(ProjectUserRoleModel::TABLE, 'project_id', 'id')
+ ->findAllByColumn(ProjectModel::TABLE.'.id');
+
+ if (! empty($project_ids)) {
+ $db->table(ProjectModel::TABLE)->in('id', $project_ids)->remove();
+ }
+
+ // Finally remove the user
+ if (! $db->table(UserModel::TABLE)->eq('id', $user_id)->remove()) {
+ return false;
+ }
+ });
+ }
+
+ /**
+ * Enable public access for a user
+ *
+ * @access public
+ * @param integer $user_id User id
+ * @return bool
+ */
+ public function enablePublicAccess($user_id)
+ {
+ return $this->db
+ ->table(self::TABLE)
+ ->eq('id', $user_id)
+ ->save(array('token' => Token::getToken()));
+ }
+
+ /**
+ * Disable public access for a user
+ *
+ * @access public
+ * @param integer $user_id User id
+ * @return bool
+ */
+ public function disablePublicAccess($user_id)
+ {
+ return $this->db
+ ->table(self::TABLE)
+ ->eq('id', $user_id)
+ ->save(array('token' => ''));
+ }
+}
generated by cgit v1.2.3 (git 2.46.0) at 2024-11-23 05:13:57 +0000