pleroma-docker/pleroma

#!/bin/bash

set -e
set -o pipefail

print_help() {
    echo "
Pleroma Maintenance Script

Usage:
    $0 [action]

Actions:
    build                     Rebuild the pleroma container.

    dump                      Dump the generated docker-compose.yml to stdout.

    debug [bin] [args...]     Launches a new pleroma container but uses \$bin instead of phx.server as entrypoint.
                              **Warning**: This is intended for debugging pleroma with tools like :debugger and :observer.
                              It thus forwards your X-Server into docker and temporarily fiddles with your xhost
                              access controls. If this is a security concern for you, please export NO_X_FORWARDING=1
                              before launching a debugger session.

    enter                     Spawn a shell inside the container for debugging/maintenance.
                              This command does not link to the postgres container.
                              If you need that use #debug instead.

    logs                      Show the current container logs.

    mix [task] [args...]      Run a mix task without entering the container.

    mod [file]                Creates the file in custom.d and downloads the content from pleroma.social.
                              The download respects your \$PLEROMA_VERSION from .env.

    passthrough / p [...]     Pass any custom command to docker-compose.

    restart                   Executes #stop and #start respectively.

    start / up                Start pleroma and sibling services.

    stop / down               Stop pleroma and sibling services.

    status / ps               Show the current container status.

Environment:
    DEBUG can be used to modify the loglevel.
        DEBUG=1 prints all commands before they are executed.
        DEBUG=2 prints all bash statements before they are executed (a lot).

    SHOPT can be used to modify shell options.
        Pass a list of options to this variable like SHOPT='-x -e'.
        -e is always on unless you set it to +e.

        For setting long options with -o use a colon (:) instead of a space
        to seperate the option from -o. For example: SHOPT='-x -e -o:pipefail'.

Contributing:
    You can report bugs or contribute to this project at:
        https://glitch.sh/sn0w/pleroma-docker
"
}

flags=""

render_template() {
    m4 $flags docker-compose.m4 | awk 'NF'
}

docker_compose() {
    docker-compose \
        -f <(render_template) \
        --project-directory . \
        "$@"
}

load_env() {
    if [[ ! -f .env ]]; then
        echo "Please create a .env file first"
        echo "(Copy .env.dist to .env for a template)"
        exit 1
    fi

    while read -r line; do
        if [[ "$line" == \#* ]] || [[ -z "$line" ]]; then
            continue;
        fi

        export "${line?}"
        flags="-D__${line?} $flags"
    done < .env
}

action__build()       { docker_compose build --build-arg __BUST_CACHE="$(date +%s)" server; }
action__dump()        { cat <(render_template); }
action__enter()       { docker_compose exec server ash -c 'cd /pleroma && ash'; }
action__logs()        { docker_compose logs -f; }
action__mix()         { docker_compose exec server ash -c "cd /pleroma && mix $*"; }
action__passthrough() { docker_compose $*; }
action__p()           { action__passthrough $*; }

action__restart()     { action__stop; action__start; }

action__start()       { docker_compose up --remove-orphans -d; }
action__up()          { action__start; }

action__stop()        { docker_compose down; }
action__down()        { action__stop; }

action__status()      { docker_compose ps; }
action__ps()          { action__status; }

###
# This function rips out the mix caches from the container
# in order to speed up rebuilds during debugging/modding sessions.
# To persist the changes, the user still needs to rebuild the container.
###
action__debug() {
    debug_mounts="\
        -v $(pwd)/custom.d:/custom.d \
        -v $(pwd)/debug.d/build:/home/pleroma/pleroma/_build \
        -v $(pwd)/debug.d/deps:/home/pleroma/pleroma/deps \
        -v $(pwd)/docker-config.exs:/docker-config.exs \
    "

    if [[ ! -d ./debug.d ]]; then
        mkdir -p ./debug.d/{build,deps}
    fi

    if [[ ! -d ./custom.d/lib ]]; then
        mkdir -p ./custom.d/lib
    fi

    action__stop

    docker_compose run --rm -u pleroma -w /home/pleroma/pleroma $debug_mounts server bash -c 'cp -rvf /custom.d/* /home/pleroma/pleroma && mix deps.get'

    x_flags=""
    if [[ $NO_X_FORWARDING != 1 ]]; then
        x_flags="-e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix"
    fi

    [[ $NO_X_FORWARDING == 1 ]] || xhost +local:root
    docker_compose run --rm -u pleroma -w /home/pleroma/pleroma $debug_mounts $x_flags server bash -c "cp -rvf /custom.d/* /home/pleroma/pleroma && $*"
    [[ $NO_X_FORWARDING == 1 ]] || xhost -local:root
}

action__mod() {
    if [[ -z "$(command -v curl)" ]] || [[ -z "$(command -v jq)" ]] || [[ -z "$(command -v dialog)" ]]; then
        echo "You need curl(1), jq(1), and dialog(1) in your PATH for this subcommand."
        exit 1
    fi

    if [[ ! -d ./debug.d ]]; then
        mkdir ./debug.d
    fi

    if [[ ! -f ./debug.d/mod_files.json ]] || [[ ! -z "$(find ./debug.d/mod_files.json -mmin +5)" ]]; then
        curl -sSL -# "https://glitch.sh/mirror/pleroma/files/$PLEROMA_VERSION?format=json" > ./debug.d/mod_files.json

        if [[ -f ./debug.d/mod_files.lst ]]; then
            rm ./debug.d/mod_files.lst
        fi
        cat ./debug.d/mod_files.json | jq -r 'map("\(.)\n") | add' > ./debug.d/mod_files.lst
    fi

    if [[ -f ./debug.d/mod_files.lst ]] && [[ -r ./debug.d/mod_files.lst ]]; then
        choices=""

        while read -r candidate; do
            choices="$choices $candidate $(echo $candidate | rev | cut -d/ -f1 | rev)"
        done <<< $(cat ./debug.d/mod_files.lst | grep -E ".*$1.*")

        res=$(mktemp)
        dialog --menu "Select the file you want to modify:" 35 80 30 $choices 2>$res
        choice=$(cat $res)

        install -D <(echo '') ./custom.d/$choice
        curl -sSL -# "https://git.pleroma.social/pleroma/pleroma/raw/$PLEROMA_VERSION/$choice" > "./custom.d/$choice"
    else
        install -D <(echo '') ./custom.d/$1
        curl -sSL -# "https://git.pleroma.social/pleroma/pleroma/raw/$PLEROMA_VERSION/$1" > "./custom.d/$1"
    fi
}

# Check if there is any command at all
if [[ -z "$1" ]]; then
    print_help
    exit 1
fi

# Check for SHOPTs
if [[ ! -z "$SHOPT" ]]; then
    for opt in $SHOPT; do
        if [[ $opt =~ ":" ]]; then
            set -o ${opt//-o:/}
        else
            set $opt
        fi
    done
fi

# Check for DEBUG
if [[ ! -z "$DEBUG" ]]; then
    if [[ $DEBUG == 1 ]]; then
        export DEBUG_COMMANDS=1
    elif [[ $DEBUG == 2 ]]; then
        set -x
    fi
fi

# Parse .env
load_env

# Guess function name of current command
# and then check for it's existance.
func="action__${1}"

if type -t $func 2>&1 1>/dev/null; then
    shift
    [[ $DEBUG != 1 ]] || set -x
    $func $@
    { [[ $DEBUG != 1 ]] || set +x; } 2>/dev/null
else
    print_help
    exit 1
fi