292 lines
9.4 KiB
PHP
292 lines
9.4 KiB
PHP
<?php
|
|
/**
|
|
* Piwik - free/libre analytics platform
|
|
*
|
|
* @link http://piwik.org
|
|
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
|
|
*
|
|
*/
|
|
namespace Piwik\Plugins\UsersManager;
|
|
|
|
use Piwik\Common;
|
|
use Piwik\Db;
|
|
use Piwik\Piwik;
|
|
|
|
/**
|
|
* The UsersManager API lets you Manage Users and their permissions to access specific websites.
|
|
*
|
|
* You can create users via "addUser", update existing users via "updateUser" and delete users via "deleteUser".
|
|
* There are many ways to list users based on their login "getUser" and "getUsers", their email "getUserByEmail",
|
|
* or which users have permission (view or admin) to access the specified websites "getUsersWithSiteAccess".
|
|
*
|
|
* Existing Permissions are listed given a login via "getSitesAccessFromUser", or a website ID via "getUsersAccessFromSite",
|
|
* or you can list all users and websites for a given permission via "getUsersSitesFromAccess". Permissions are set and updated
|
|
* via the method "setUserAccess".
|
|
* See also the documentation about <a href='http://piwik.org/docs/manage-users/' rel='noreferrer' target='_blank'>Managing Users</a> in Piwik.
|
|
*/
|
|
class Model
|
|
{
|
|
private static $rawPrefix = 'user';
|
|
private $table;
|
|
|
|
public function __construct()
|
|
{
|
|
$this->table = Common::prefixTable(self::$rawPrefix);
|
|
}
|
|
|
|
/**
|
|
* Returns the list of all the users
|
|
*
|
|
* @param string[] $userLogins List of users to select. If empty, will return all users
|
|
* @return array the list of all the users
|
|
*/
|
|
public function getUsers(array $userLogins)
|
|
{
|
|
$where = '';
|
|
$bind = array();
|
|
|
|
if (!empty($userLogins)) {
|
|
$where = 'WHERE login IN (' . Common::getSqlStringFieldsArray($userLogins) . ')';
|
|
$bind = $userLogins;
|
|
}
|
|
|
|
$users = $this->getDb()->fetchAll("SELECT * FROM " . $this->table . "
|
|
$where
|
|
ORDER BY login ASC", $bind);
|
|
|
|
return $users;
|
|
}
|
|
|
|
/**
|
|
* Returns the list of all the users login
|
|
*
|
|
* @return array the list of all the users login
|
|
*/
|
|
public function getUsersLogin()
|
|
{
|
|
$users = $this->getDb()->fetchAll("SELECT login FROM " . $this->table . " ORDER BY login ASC");
|
|
|
|
$return = array();
|
|
foreach ($users as $login) {
|
|
$return[] = $login['login'];
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
public function getUsersSitesFromAccess($access)
|
|
{
|
|
$users = $this->getDb()->fetchAll("SELECT login,idsite FROM " . Common::prefixTable("access")
|
|
. " WHERE access = ?
|
|
ORDER BY login, idsite", $access);
|
|
|
|
$return = array();
|
|
foreach ($users as $user) {
|
|
$return[$user['login']][] = $user['idsite'];
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
public function getUsersAccessFromSite($idSite)
|
|
{
|
|
$users = $this->getDb()->fetchAll("SELECT login,access FROM " . Common::prefixTable("access")
|
|
. " WHERE idsite = ?", $idSite);
|
|
|
|
$return = array();
|
|
foreach ($users as $user) {
|
|
$return[$user['login']] = $user['access'];
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
public function getUsersLoginWithSiteAccess($idSite, $access)
|
|
{
|
|
$users = $this->getDb()->fetchAll("SELECT login
|
|
FROM " . Common::prefixTable("access")
|
|
. " WHERE idsite = ? AND access = ?", array($idSite, $access));
|
|
|
|
$logins = array();
|
|
foreach ($users as $user) {
|
|
$logins[] = $user['login'];
|
|
}
|
|
|
|
return $logins;
|
|
}
|
|
|
|
/**
|
|
* For each website ID, returns the access level of the given $userLogin.
|
|
* If the user doesn't have any access to a website ('noaccess'),
|
|
* this website will not be in the returned array.
|
|
* If the user doesn't have any access, the returned array will be an empty array.
|
|
*
|
|
* @param string $userLogin User that has to be valid
|
|
*
|
|
* @return array The returned array has the format
|
|
* array(
|
|
* idsite1 => 'view',
|
|
* idsite2 => 'admin',
|
|
* idsite3 => 'view',
|
|
* ...
|
|
* )
|
|
*/
|
|
public function getSitesAccessFromUser($userLogin)
|
|
{
|
|
$users = $this->getDb()->fetchAll("SELECT idsite,access FROM " . Common::prefixTable("access")
|
|
. " WHERE login = ?", $userLogin);
|
|
|
|
$return = array();
|
|
foreach ($users as $user) {
|
|
$return[] = array(
|
|
'site' => $user['idsite'],
|
|
'access' => $user['access'],
|
|
);
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
public function getUser($userLogin)
|
|
{
|
|
$db = $this->getDb();
|
|
|
|
$matchedUsers = $db->fetchAll("SELECT * FROM " . $this->table . " WHERE login = ?", $userLogin);
|
|
|
|
// for BC in 2.15 LTS, if there is a user w/ an exact match to the requested login, return that user.
|
|
// this is done since before this change, login was case sensitive. until 3.0, we want to maintain
|
|
// this behavior.
|
|
foreach ($matchedUsers as $user) {
|
|
if ($user['login'] == $userLogin) {
|
|
return $user;
|
|
}
|
|
}
|
|
|
|
return reset($matchedUsers);
|
|
}
|
|
|
|
public function getUserByEmail($userEmail)
|
|
{
|
|
return $this->getDb()->fetchRow("SELECT * FROM " . $this->table . " WHERE email = ?", $userEmail);
|
|
}
|
|
|
|
public function getUserByTokenAuth($tokenAuth)
|
|
{
|
|
return $this->getDb()->fetchRow('SELECT * FROM ' . $this->table . ' WHERE token_auth = ?', $tokenAuth);
|
|
}
|
|
|
|
public function addUser($userLogin, $passwordTransformed, $email, $alias, $tokenAuth, $dateRegistered)
|
|
{
|
|
$user = array(
|
|
'login' => $userLogin,
|
|
'password' => $passwordTransformed,
|
|
'alias' => $alias,
|
|
'email' => $email,
|
|
'token_auth' => $tokenAuth,
|
|
'date_registered' => $dateRegistered,
|
|
'superuser_access' => 0
|
|
);
|
|
|
|
$this->getDb()->insert($this->table, $user);
|
|
}
|
|
|
|
public function setSuperUserAccess($userLogin, $hasSuperUserAccess)
|
|
{
|
|
$this->getDb()->update($this->table,
|
|
array(
|
|
'superuser_access' => $hasSuperUserAccess ? 1 : 0
|
|
),
|
|
"login = '$userLogin'"
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Note that this returns the token_auth which is as private as the password!
|
|
*
|
|
* @return array[] containing login, email and token_auth
|
|
*/
|
|
public function getUsersHavingSuperUserAccess()
|
|
{
|
|
$users = $this->getDb()->fetchAll("SELECT login, email, token_auth
|
|
FROM " . Common::prefixTable("user") . "
|
|
WHERE superuser_access = 1
|
|
ORDER BY date_registered ASC");
|
|
|
|
return $users;
|
|
}
|
|
|
|
public function updateUser($userLogin, $password, $email, $alias, $tokenAuth)
|
|
{
|
|
$this->getDb()->update($this->table,
|
|
array(
|
|
'password' => $password,
|
|
'alias' => $alias,
|
|
'email' => $email,
|
|
'token_auth' => $tokenAuth
|
|
),
|
|
"login = '$userLogin'"
|
|
);
|
|
}
|
|
|
|
public function userExists($userLogin)
|
|
{
|
|
$count = $this->getDb()->fetchOne("SELECT count(*) FROM " . $this->table . " WHERE login = ?", $userLogin);
|
|
|
|
return $count != 0;
|
|
}
|
|
|
|
public function userEmailExists($userEmail)
|
|
{
|
|
$count = $this->getDb()->fetchOne("SELECT count(*) FROM " . $this->table . " WHERE email = ?", $userEmail);
|
|
|
|
return $count != 0;
|
|
}
|
|
|
|
public function addUserAccess($userLogin, $access, $idSites)
|
|
{
|
|
foreach ($idSites as $idsite) {
|
|
$this->getDb()->insert(Common::prefixTable("access"),
|
|
array("idsite" => $idsite,
|
|
"login" => $userLogin,
|
|
"access" => $access)
|
|
);
|
|
}
|
|
}
|
|
|
|
public function deleteUserOnly($userLogin)
|
|
{
|
|
$this->getDb()->query("DELETE FROM " . $this->table . " WHERE login = ?", $userLogin);
|
|
|
|
/**
|
|
* Triggered after a user has been deleted.
|
|
*
|
|
* This event should be used to clean up any data that is related to the now deleted user.
|
|
* The **Dashboard** plugin, for example, uses this event to remove the user's dashboards.
|
|
*
|
|
* @param string $userLogin The login handle of the deleted user.
|
|
*/
|
|
Piwik::postEvent('UsersManager.deleteUser', array($userLogin));
|
|
}
|
|
|
|
public function deleteUserAccess($userLogin, $idSites = null)
|
|
{
|
|
if (is_null($idSites)) {
|
|
$this->getDb()->query("DELETE FROM " . Common::prefixTable("access") .
|
|
" WHERE login = ?",
|
|
array($userLogin));
|
|
} else {
|
|
foreach ($idSites as $idsite) {
|
|
$this->getDb()->query("DELETE FROM " . Common::prefixTable("access") .
|
|
" WHERE idsite = ? AND login = ?",
|
|
array($idsite, $userLogin)
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
private function getDb()
|
|
{
|
|
return Db::get();
|
|
}
|
|
|
|
}
|