Compare commits

..

4 commits

Author SHA1 Message Date
Benjamin Renard
6873a7e2a0
Auth\Db: add edit_user CLI command 2024-09-13 18:52:05 +02:00
Benjamin Renard
4a2060458d
Auth\Db: implement update_user() 2024-09-13 18:48:45 +02:00
Benjamin Renard
2ee5c7540b
Auth\Db::add_user(): add check of username uniqueness 2024-09-13 18:43:33 +02:00
Benjamin Renard
e2dca482b3
Auth\User: implement array access interface 2024-09-13 18:27:52 +02:00
2 changed files with 153 additions and 7 deletions

View file

@ -8,6 +8,8 @@ use EesyPHP\Log;
use Exception;
use function EesyPHP\vardump;
class Db extends Backend {
/**
@ -70,8 +72,19 @@ class Db extends Backend {
self :: $password_field = App::get('auth.db.password_field', null, 'string');
self :: $exposed_fields = App::get('auth.db.exposed_fields', null, 'array');
if (App :: get('cli.enabled'))
Cli :: add_command('add_user', ['\\EesyPHP\\Auth\\Db', 'cli_add_user'], 'Add user');
if (App :: get('cli.enabled')) {
Cli :: add_command(
'add_user',
['\\EesyPHP\\Auth\\Db', 'cli_add_user'],
'Add user'
);
Cli :: add_command(
'edit_user',
['\\EesyPHP\\Auth\\Db', 'cli_edit_user'],
'Edit user',
'[username]'
);
}
return true;
}
@ -138,18 +151,29 @@ class Db extends Backend {
*/
public static function add_user($info) {
$values = [
App::get('auth.db.username_field') => $info['username'],
App::get('auth.db.password_field') => password_hash(
$info['password'],
constant('PASSWORD_'.strtoupper(App::get('auth.db.password_hash_algo')))
self :: $username_field => $info['username'] ?? null,
self :: $password_field => (
($info['password'] ?? null)?
password_hash(
$info['password'],
constant('PASSWORD_'.strtoupper(App::get('auth.db.password_hash_algo')))
):
null
),
];
foreach($info as $field => $value) {
if (!$value) {
Log :: error("add_user: field %s is missing", $field);
Log :: error("add_user: field %s is missing (or null)", $field);
return false;
}
}
// Check username uniqueness
if (self :: get_user($info['username'])) {
Log :: error("add_user: a user with username %s already exist");
return false;
}
foreach(App :: get('auth.db.exposed_fields') as $field)
if (isset($info[$field]) && $info[$field])
$values[$field] = $info[$field];
@ -162,6 +186,83 @@ class Db extends Backend {
return false;
}
/**
* Update a user in database
* @param \EesyPHP\Auth\User $user The user object
* @param array<string,mixed> $changes Array of changes
* @param boolean $no_change_as_success Consider no change provided as success
* (optional, default: false)
* @return boolean True if user was updated, false otherwise
*/
public static function update_user($user, $changes, $no_change_as_success=False) {
Log::debug("update_user(%s): changes=%s", $user->username, vardump($changes));
if (!$user->username) {
Log::error("update_user(): Invalid user provided (no username)");
return false;
}
if (!is_array($changes)) {
Log::error("update_user(%s): Invalid changes provided (not an array)", $user->username);
return false;
}
$values = [];
foreach($changes as $field => $value) {
switch ($field) {
case "username":
if ($value != $user->username) {
// Check username uniqueness
if (self :: get_user($value)) {
Log :: error(
"update_user(%s): invalid new username '%s': another user with this username already exist",
$user->username,
$value
);
return false;
}
$values[self :: $username_field] = $value;
}
break;
case "password":
if (!password_verify($value, $user["password"]))
$values[self :: $password_field] = password_hash(
$value,
constant('PASSWORD_'.strtoupper(App::get('auth.db.password_hash_algo')))
);
break;
default:
if (in_array($field, App :: get('auth.db.exposed_fields'))) {
if ($value != $user[$field])
$values[$field] = $values;
break;
}
Log :: error("update_user: unknown field %s", $field);
return false;
}
}
if (empty($values)) {
Log::log(
$no_change_as_success?"DEBUG":"ERROR",
"update_user(%s): no change",
$user->username
);
return $no_change_as_success;
}
Log::debug("update_user(%s): changes=%s", $user->username, vardump($values));
if (
self :: $class :: update(
self :: $users_table,
$values,
[App::get('auth.db.username_field') => $user->username]
)
) {
Log :: info('update_user(%s): user updated', $user->username);
return true;
}
Log :: error('update_user(%s): error adding user', $user->username);
return false;
}
/**
* CLI command to add user
* @param array $command_args Command arguments
@ -189,4 +290,41 @@ class Db extends Backend {
}
Log :: fatal("Error occurred adding user %s", $info['username']);
}
/**
* CLI command to edit an existing user
* @param array $command_args Command arguments
* @return bool
*/
public static function cli_edit_user($command_args) {
if (count($command_args) != 1)
Cli :: usage();
$username = $command_args[0];
$user = self :: get_user($username);
if (!$user) Cli :: usage("Invalid user '$username'");
$changes = [
"username" => trim(
Cli::ask_user("Please enter user new username [$username]: ")
),
"password" => Cli::ask_user("Please enter user new password [empty = unchange]: ", true),
];
if (!$changes["username"]) unset($changes["username"]);
if (!$changes["password"]) unset($changes["password"]);
foreach(self :: $exposed_fields as $field) {
$value = Cli::ask_user("Please enter user $field [{$user[$field]}]: ");
if (empty($value))
continue;
$changes[$field] = $value;
}
if (!$changes) {
print("No change.\n");
return true;
}
if (self :: update_user($user, $changes)) {
printf("User %s updated\n", $username);
return true;
}
Log :: fatal("Error occurred updating user %s", $username);
}
}

View file

@ -108,6 +108,14 @@ class User {
}
}
/**
* ArrayAccess interface
*/
public function offsetExists($offset) { return self :: __isset($offset); }
public function offsetGet($offset){ return self :: __get($offset); }
public function offsetSet($offset, $value) { self :: __set($offset, $value); }
public function offsetUnset($offset) { self :: __set($offset, null); }
/**
* Check user password
* @param string $password