mirror of
https://github.com/YunoHost/yunohost.git
synced 2024-09-03 20:06:10 +02:00
95 lines
3.1 KiB
Text
95 lines
3.1 KiB
Text
# Check if a YunoHost user exists
|
|
#
|
|
# example: ynh_user_exists 'toto' || exit 1
|
|
#
|
|
# usage: ynh_user_exists username
|
|
# | arg: username - the username to check
|
|
ynh_user_exists() {
|
|
sudo yunohost user list --output-as json | grep -q "\"username\": \"${1}\""
|
|
}
|
|
|
|
# Retrieve a YunoHost user information
|
|
#
|
|
# example: mail=$(ynh_user_get_info 'toto' 'mail')
|
|
#
|
|
# usage: ynh_user_get_info username key
|
|
# | arg: username - the username to retrieve info from
|
|
# | arg: key - the key to retrieve
|
|
# | ret: string - the key's value
|
|
ynh_user_get_info() {
|
|
sudo yunohost user info "$1" --output-as plain | ynh_get_plain_key "$2"
|
|
}
|
|
|
|
# Get the list of YunoHost users
|
|
#
|
|
# example: for u in $(ynh_user_list); do ...
|
|
#
|
|
# usage: ynh_user_list
|
|
# | ret: string - one username per line
|
|
ynh_user_list() {
|
|
sudo yunohost user list --output-as plain --quiet \
|
|
| awk '/^##username$/{getline; print}'
|
|
}
|
|
|
|
# Check if a user exists on the system
|
|
#
|
|
# usage: ynh_system_user_exists username
|
|
# | arg: username - the username to check
|
|
ynh_system_user_exists() {
|
|
getent passwd "$1" &>/dev/null
|
|
}
|
|
|
|
# Create a system user
|
|
#
|
|
# examples:
|
|
# - ynh_system_user_create --username=nextcloud -> creates a nextcloud user with
|
|
# no home directory and /usr/sbin/nologin login shell (hence no login capability)
|
|
# - ynh_system_user_create --username=discourse --home_dir=/var/www/discourse --use_shell --> creates a
|
|
# discourse user using /var/www/discourse as home directory and the default login shell
|
|
#
|
|
# usage: ynh_system_user_create --username=user_name [--home_dir=home_dir] [--use_shell]
|
|
# | arg: -u, --username - Name of the system user that will be create
|
|
# | arg: -h, --home_dir - Path of the home dir for the user. Usually the final path of the app. If this argument is omitted, the user will be created without home
|
|
# | arg: -s, --use_shell - Create a user using the default login shell if present.
|
|
# If this argument is omitted, the user will be created with /usr/sbin/nologin shell
|
|
ynh_system_user_create () {
|
|
# Declare an array to define the options of this helper.
|
|
local legacy_args=uh
|
|
declare -Ar args_array=( [u]=username= [h]=home_dir= [s]=use_shell )
|
|
local username
|
|
local home_dir
|
|
local use_shell
|
|
# Manage arguments with getopts
|
|
ynh_handle_getopts_args "$@"
|
|
use_shell="${use_shell:-0}"
|
|
home_dir="${home_dir:-}"
|
|
|
|
if ! ynh_system_user_exists "$username" # Check if the user exists on the system
|
|
then # If the user doesn't exist
|
|
if [ -n "$home_dir" ]; then # If a home dir is mentioned
|
|
local user_home_dir="-d $home_dir"
|
|
else
|
|
local user_home_dir="--no-create-home"
|
|
fi
|
|
if [ $use_shell -eq 1 ]; then # If we want a shell for the user
|
|
local shell="" # Use default shell
|
|
else
|
|
local shell="--shell /usr/sbin/nologin"
|
|
fi
|
|
useradd $user_home_dir --system --user-group $username $shell || ynh_die "Unable to create $username system account"
|
|
fi
|
|
}
|
|
|
|
# Delete a system user
|
|
#
|
|
# usage: ynh_system_user_delete user_name
|
|
# | arg: user_name - Name of the system user that will be create
|
|
ynh_system_user_delete () {
|
|
if ynh_system_user_exists "$1" # Check if the user exists on the system
|
|
then
|
|
echo "Remove the user $1" >&2
|
|
sudo userdel $1
|
|
else
|
|
echo "The user $1 was not found" >&2
|
|
fi
|
|
}
|