🍽 Fork YunoHost — snapshot mangé par la machine à tsoins

Upstream: https://github.com/YunoHost/yunohost @ 3a5f8bac8301c450897b96cbd43a4c7d3ba750fb
But (José) : transformer tout le code en bions + ploxions du xerboxion.
La carte de digestion vit au labo : /yunohost-digest.json

helpers/helpers.v2.1.d/postgresql

@@ -0,0 +1,143 @@
+#!/usr/bin/env bash
+#
+# Copyright (c) 2024 YunoHost Contributors
+#
+# This file is part of YunoHost (see https://yunohost.org)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+
+# shellcheck disable=SC2034
+PSQL_ROOT_PWD_FILE=/etc/yunohost/psql
+PSQL_VERSION=15
+
+# Run SQL instructions in a database ($db_name by default)
+#
+# usage: ynh_psql_db_shell database <<< "instructions"
+# | arg: database    - the database to connect to (by default, $db_name)
+#
+# examples:
+#    ynh_psql_db_shell $db_name <<< "UPDATE ...;"
+#    ynh_psql_db_shell < /path/to/file.sql
+#
+ynh_psql_db_shell() {
+    local database="${1:-$db_name}"
+    sudo --user=postgres psql "$database"
+}
+
+# Create a database and grant optionnaly privilegies to a user
+#
+# [internal] ... handled by the core / "database resource"
+#
+# usage: ynh_psql_create_db db [user]
+# | arg: db - the database name to create
+# | arg: user - the user to grant privilegies
+#
+ynh_psql_create_db() {
+    local db=$1
+    local user=${2:-}
+
+    local sql="CREATE DATABASE ${db};"
+
+    # grant all privilegies to user
+    if [ -n "$user" ]; then
+        sql+="ALTER DATABASE ${db} OWNER TO ${user};"
+        sql+="GRANT ALL PRIVILEGES ON DATABASE ${db} TO ${user} WITH GRANT OPTION;"
+    fi
+
+    sudo --user=postgres psql <<< "$sql"
+}
+
+# Drop a database
+#
+# [internal] ... handled by the core / "database resource"
+#
+# If you intend to drop the database *and* the associated user,
+# consider using ynh_psql_remove_db instead.
+#
+# usage: ynh_psql_drop_db db
+# | arg: db - the database name to drop
+#
+ynh_psql_drop_db() {
+    local db=$1
+    # First, force disconnection of all clients connected to the database
+    # https://stackoverflow.com/questions/17449420/postgresql-unable-to-drop-database-because-of-some-auto-connections-to-db
+    sudo --user=postgres psql "$db" <<< "REVOKE CONNECT ON DATABASE $db FROM public;"
+    sudo --user=postgres psql "$db" <<< "SELECT pg_terminate_backend (pg_stat_activity.pid) FROM pg_stat_activity WHERE pg_stat_activity.datname = '$db' AND pid <> pg_backend_pid();"
+    sudo --user=postgres dropdb "$db"
+}
+
+# Dump a database
+#
+# usage: ynh_psql_dump_db database
+# | arg: database    - the database name to dump (by default, $db_name)
+# | ret: the psqldump output
+#
+# example: ynh_psql_dump_db 'roundcube' > ./dump.sql
+#
+ynh_psql_dump_db() {
+    local database="${1:-$db_name}"
+    sudo --user=postgres pg_dump "$database"
+}
+
+# Create a user
+#
+# [internal] ... handled by the core / "database resource"
+#
+# usage: ynh_psql_create_user user pwd
+# | arg: user - the user name to create
+# | arg: pwd - the password to identify user by
+#
+ynh_psql_create_user() {
+    local user=$1
+    local pwd=$2
+    sudo --user=postgres psql <<< "CREATE USER $user WITH ENCRYPTED PASSWORD '$pwd'"
+}
+
+# Check if a psql user exists
+#
+# [internal]
+#
+# usage: ynh_psql_user_exists user
+# | arg: user=    - the user for which to check existence
+# | exit: Return 1 if the user doesn't exist, 0 otherwise
+#
+ynh_psql_user_exists() {
+    local user=$1
+    sudo --user=postgres psql -tAc "SELECT rolname FROM pg_roles WHERE rolname='$user';" | grep --quiet "$user"
+}
+
+# Check if a psql database exists
+#
+# [internal]
+#
+# usage: ynh_psql_database_exists database
+# | arg: database    - the database for which to check existence
+# | exit: Return 1 if the database doesn't exist, 0 otherwise
+#
+ynh_psql_database_exists() {
+    local database=$1
+    sudo --user=postgres psql -tAc "SELECT datname FROM pg_database WHERE datname='$database';" | grep --quiet "$database"
+}
+
+# Drop a user
+#
+# [internal] ... handled by the core / "database resource"
+#
+# usage: ynh_psql_drop_user user
+# | arg: user - the user name to drop
+#
+ynh_psql_drop_user() {
+    sudo --user=postgres psql <<< "DROP USER ${1};"
+}