loginized-cli.sh

#!/bin/bash

# Core functionalities to alter login theme
# This application provides easy access api to install specific theme as login theme for GNOME desktop 
# environment. 

user=$(whoami)
# Dynamically configured at install
appName="Loginized"
basePath="/opt/$appName"

# Dynamic properties
runAsUser=""
configPath=""
runConfig=/tmp/loginized-run.tmp

# Global variables
# defaultBackground=noise-texture.png
gs=gnome-shell-theme.gresource
workDir=/tmp/shell
gdm3=/etc/alternatives/gdm3.css
gdmConf=/etc/dconf/db/gdm.d
# Used by login screen shield
imagesPath=/usr/share/Loginized/images

function notRecognized {
    echo "action $1 was not recogninzed, use -h, --help flags for help" && exit 1
}

function help {
    echo "Usage: loginized-cli.sh [-h | --help] | [--gui] [action] [theme] [image] | [--gui] set [config] [arg]
Provides functionality to alternate login gnome shell theme. Theme must be found under 
/usr/share/themes in order to list as option.
Definition of arguments.
 -h | --help | ? .... Shows help
 install ............ Install theme. First parameter is the theme itself that is being installed and
                      the second and parameter is additional background image with path to it
                      if installed via cli. 
 list ............... Lists themes available in /usr/share/themes folder. Note all themes that are 
                      located there is not available this is due missing gnome-shell-theme.gresource
                      for one reason or another. In such scenario you could manually compile the theme
                      using compile option of this tool and place it under gnome-shell folder of
                      the theme. This would make the theme available for this tool.
 extract ............ Extracts theme to /tmp/shell/theme folder. Additionally target folder 
                      may be provided where to extract content.
 compile ............ Compiles theme and places it to provided folder.
 set ................ Set is configuration command to change GDM configurations. Set can change 
                      login screen user list configuration or default shield picture for login screen. 
 
Examples.
 loginized-cli.sh list    This will list available themes. These themes are available for this tool.
 
 loginized-cli.sh install Adapta my-background.png    
    This example will install Adapta theme from /usr/share/themes with my-background.png as 
    background image
 
 loginized-cli.sh install Default
    This example will install default theme as login theme
 
 loginized-cli.sh install Adapta
    This example will install Adapta theme as login theme without any modifications
        
 loginized-cli.sh extract Adapta-Eta
    This will extract Adata-Eta theme from /usr/share/themes to extract folder. If folder is not 
    found it will be created
 
 loginized-cli.sh extract Adapta-Nokto /path/to/my/custom/location
    This will extract Adapta-Nokto theme from /usr/share/themes place extracted content to provided
    custom location. Custom location must be a folder. This will also create a folder like name of 
    the theme + extracted e.g Adapta-Nokto-extracted to provided custom location

 loginized-cli.sh compile /path/to/theme/root/folder /path/to/target/folder
    This will compile theme sources to .gresource file in given source path. Theme root folder
    must containt the gnome-shell.css file and rest of sources accordingly. Target folder must be a 
    valid location and it is used to place the compiled .gresource file.

 loginized-cli.sh set shield
    This will set the default shield in use for login screen. 

 loginized-cli.sh set shield /usr/share/mypic.jpg 
    This will set mypic.jpg as default shield for login screen.

 loginized-cli.sh set user-list true
    This will set user list enabled in login screen. This is by default true.

 loginized-cli.sh set user-list false
    This will set user list disabled in login screen.
    
Copyright (C) 2020 Juha Kukkonen - Licensed under <https://www.gnu.org/licenses/gpl-3.0.txt>
This program is provided AS IS and comes with ABSOLUTELY NO WARRANTY"
}

# Simple function to extract gui attribute from cmd
function extractGui() {
    cmd="$@"
    gui=""
    for arg in $(echo $cmd); do
        [ "$arg" == "--gui" ] && gui=$arg && break;
    done

    echo $gui
}

# Determine whether we are running on gui
if [ "$(extractGui "$@")" == "--gui" ]; then
    runningOnGui=true
else 
    runningOnGui=false
fi

# Trim --gui from arguments
args="$@"
argList=""
for arg in $(echo $args); do
    [ $arg != "--gui" ] && argList="$argList $arg"
done

function removeWorkDir {
    rm -rf $workDir
}

# Extracts theme (.gresource)
function extract {
    theme=$1
    
    # Clear existing theme content from work dir so there wont be any funny collisions
    test -d $workDir/theme && rm -r $workDir/theme
    
    if [ "$theme" == "Default" ]; then
        location=$configPath/default
    else
        location=/usr/share/themes/$theme/gnome-shell
    fi
    gsl=$location/$gs

    for r in $(gresource list $gsl); do
        # correctly generate necessary folder structure from actual resource
        rDir=$(echo ${r%/*})
        rDir=$(echo ${rDir#\/org\/gnome\/shell})
        test ! -d "$workDir""$rDir" && mkdir -p "$workDir""$rDir"
        # extract the resource to the folder
        gresource extract $gsl $r > $workDir${r/#\/org\/gnome\/shell}
    done

    if [ -d "$2" ]; then
        test ! -d $2/"$theme"-extracted && mkdir $2/"$theme"-extracted
        cp -r $workDir/theme $2/"$theme"-extracted 
    fi
}

trimmed=""
# Trims last slash from provider parameter
function trimLastSlash {
    if [ "$(echo $1 | rev | cut -c 1)" == "/" ]; then
        trimmed=$(echo $1 | rev | cut -c 2- | rev)
    else 
        trimmed=$1
    fi
}

# Compiles theme in source location and places compiled theme to target location
function compile {
    trimLastSlash $1
    source=$trimmed
    trimLastSlash $2
    target=$trimmed

    #Generate gresource xml file for current theme
    # resourceFiles=$(for file in $(find $source -type f | sed "s|$source||" | cut -c 2-); do echo "<file>$file</file>"; done)
    resourceFiles=$(find $source -type f | sed "s|$source||" | cut -c 2- | while read file; do echo "<file>$file</file>"; done)
    gresourceXml="<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<gresources>
  <gresource prefix=\"/org/gnome/shell/theme\">
    $resourceFiles
  </gresource>
</gresources>"
    echo $gresourceXml > $source/$gs.xml

    glib-compile-resources --sourcedir=$source $source/$gs.xml
    
    if [[ "$source" != "." && "$target" != "." && "$source" != "$target" && "$target" != "" ]]; then
        cp $source/$gs "$target/$gs"
    fi
}

# Install gdm3 css file if it is being used by the operating system. Ubuntu newer than 16.10 uses it
function installGdm3Css {
    from=$1
    if [ -f $gdm3 ]; then 
        cp $from $gdm3
    fi
}

# Install specific theme with defaults as login theme
function installThemeWithDefaults {
    theme=$1
    test ! -d /usr/share/themes/$theme && echo "Theme not found (/usr/share/themes/$theme), cannot perform install" && exit 1;
    cp /usr/share/themes/$theme/gnome-shell/$gs /usr/share/gnome-shell/$gs
    installGdm3Css /usr/share/themes/$theme/gnome-shell/gnome-shell.css
}

# Install default theme what has been backed up during initial startup
function installDefault {
    test ! -f $configPath/default/$gs && echo "Default theme not found ($configPath/default/$gs), cannot perform install" && exit 1;
    cp $configPath/default/$gs /usr/share/gnome-shell/$gs
    extract Default
    installGdm3Css $workDir/theme/gnome-shell.css
}

# Install theme $1=theme, $2=image $3=rounded login icon
function install {
    theme="$(echo $1 | sed 's|\\| |')"
    image="$(echo $2 | sed 's|\\| |')"
    forceRoundedLoginIcon=$3

    # Force rounded icon is always provided so when this is empty string then the image has not been provided!
    if [ "$forceRoundedLoginIcon" == "" ]; then
        forceRoundedLoginIcon=false
        image=""
    fi

    if [[ "$theme" == "Default" && "$image" == "" ]]; then 
        installDefault
    
    elif [ "$image" == "" ]; then 
        installThemeWithDefaults $theme
    
    else 
        test ${#theme} -eq 0 && echo "Theme is not defined $theme, cannot continue installation" && exit 1;
        test ${#image} -eq 0 && echo "Image is not defined $image, cannot continue installation" && exit 1;
        extract "$theme"

        tempImage=$(basename "$image")
        dialogCss="#lockDialogGroup { background: #2e3436 url(\"resource:\/\/\/org\/gnome\/shell\/theme\/$tempImage\"); background-repeat: none; background-size: cover; }"
        location=/usr/share/gnome-shell
        workLocation=$workDir/theme
        
        # When processed from gui image is saved to $configPath
        if [ $runningOnGui == true ]; then
            cp $configPath/"$image" $workLocation/.
        else 
            cp "$image" $workLocation/.        
        fi

        sed -i "/#lockDialogGroup/,/}/ { /#lockDialogGroup/ { s/.*// }; /}/ ! { s/.*// }; /}/ { s/.*/$dialogCss/ }; }" $workLocation/gnome-shell.css

        if [ $forceRoundedLoginIcon == true ]; then
            roundedLoginIconCss="
.user-icon { background-size: contain; color: #eeeeec; border-radius: 99px; }

.user-icon:hover { color: white; }"
            echo "$roundedLoginIconCss" >> $workLocation/gnome-shell.css
        fi
        
        # Compile the modified theme and install it
        compile $workLocation "$location"
        
        installGdm3Css $workLocation/gnome-shell.css
        
        # Clear work dir after installation
        removeWorkDir
    fi
}

# List themes available. Themes must have .gresource file in order it to be available for install. Default will be always available.
function list {
    echo $(for theme in $(ls /usr/share/themes); do test -f /usr/share/themes/$theme/gnome-shell/gnome-shell-theme.gresource && echo $theme; done) Default
}

# On start functionality
function onStart {
    test ! -d $configPath && mkdir -p $configPath
    # Take a backup at the beginning if back up does not exists
    if [ ! -f $configPath/default/$gs ]; then
        test ! -d $configPath/default && mkdir -p $configPath/default
        test -f /usr/share/gnome-shell/$gs && cp /usr/share/gnome-shell/$gs $configPath/default/$gs
    fi
    echo $configPath
}

# Reboots system no questions asked
function fastReboot {
    rebootBin=$(which reboot)
    $rebootBin now
}

function reboot {
    read -p "Changes will take affect after reboot, Reboot now? [Y/n]: " decision
    echo $decision
    if [[ "$decision" == "" || "$decision" == "y" || "$decision" == "Y" ]]; then 
        fastReboot
    fi;
}

function createGdmProfile() {
    gdmProfile=/etc/dconf/profile

    # If gdm profile is not found create one and fill with data.
    test ! -d $gdmProfile && mkdir -p $gdmProfile
    echo -e "user-db:user\nsystem-db:gdm\nfile-db:/usr/share/gdm/greeter-dconf-defaults" > $gdmProfile/gdm
}

# Sets user list in login screen either enabled or disabled
function setUserList() {
    showUserList=$1
    createGdmProfile
    
    # Invert selection for sake of api
    if [ $showUserList == true ]; then
        showUserList=false
    else 
        showUserList=true
    fi;

    # If there is no option provided show not recognized message
    [ "$showUserList" == "" ] && notRecognized

    test ! -d $gdmConf && mkdir -p $gdmConf
    # Compare status to real argument and set inverted argument to file
    if [ "$1" == "false" ]; then 
        echo -e "[org/gnome/login-screen]\ndisable-user-list=$showUserList" > $gdmConf/00-screensaver
    else 
        # Set defaults when user list is set to true
        rm -f $gdmConf/00-screensaver
    fi;
    
    dconf update
}

# Changes login screen shield picture.
function setShield() {
    createGdmProfile
    shield=$(echo $1 | sed 's|\\| |')

    test ! -d $gdmConf && mkdir -p $gdmConf
    if [ "$shield" != "" ]; then 
        # Make sure that image's path is available
        test ! -d $imagesPath && mkdir -p $imagesPath
        # Copy the actual file to images path and use that path for shield image
        shieldPath=$imagesPath/$(basename "$shield")
        cp "$shield" $shieldPath
        echo -e "[org/gnome/desktop/screensaver]\npicture-uri='file://$shieldPath'" > $gdmConf/01-screensaver
    else 
        # Set defaults when there is no image provided
        rm -f $gdmConf/01-screensaver
    fi;

    dconf update
}

function save() {
    cmd=$(echo $@ | cut -c 5-)
    theme=$(echo $cmd | cut -d ',' -f 1)
    background=$(echo $cmd | cut -d ',' -f 2)
    shield=$(echo $cmd | cut -d ',' -f 3)
    userList=$(echo $cmd | cut -d ',' -f 4)
    forceRoundedLoginIcon=$(echo $cmd | cut -d ',' -f 5)

    install $(echo $theme | sed 's| |\\|') $(echo $background | sed 's| |\\|') $forceRoundedLoginIcon
    setShield $(echo $shield | sed 's| |\\|')
    setUserList $userList
}

# Determine whether we need help
if [[ "$1" == "-h" || "$1" == "--help" ]]; then help && exit 0; fi

# Run as root if current user is not root, $1 = file, $2 = args, $3 = guil
function runAsRoot() {
    cmd="$@"
    if [ "$user" != "root" ]; then 
        if [ $runningOnGui == true ]; then
            exec pkexec bash -c "$cmd"
        else 
            exec sudo bash -c "$cmd"
        fi;
    fi;
}

#echo "debug:" $user $0 $args "|runningOnGui:" $runningOnGui "|argList:" "$argList"

function main() {
    if [ ! -f $runConfig ]; then
        echo $user > $runConfig
        configPath="/home/$user/.config/$appName"
    else
        runAsUser=$(cat $runConfig)
        configPath="/home/$runAsUser/.config/$appName"
    fi
    # Main functions
    # $1 = option, $2 = theme, 3 = image
    case $1 in
        extract)
            extract $2 $3
        ;;
        compile)
            compile $2 $3
        ;;
        reboot)
            fastReboot
        ;;
        install)
            # On cli version we make sure that command is executed with correct rights.
            runAsRoot $0 $args
            if [ "$user" == "root" ]; then
                install $2 $3
                # Only offer reboot option if this was executed non GUI
                [ $runningOnGui == true ] || reboot
            fi;
        ;;
        list)
            list
        ;;
        start)
            # when gui is started check defaults
            onStart
        ;;
        save)
            runAsRoot $0 $args
            [ "$user" == "root" ] && save $argList
        ;;
        set)
        # $2 = config, $3 = value
            case $2 in
                shield)
                    runAsRoot $0 $args
                    if [ "$user" == "root" ]; then 
                        setShield $3
                        # Only cli version is offered to reboot
                        [ $runningOnGui == true ] || reboot
                    fi;
                ;;
                user-list)
                    runAsRoot $0 $args
                    if [ "$user" == "root" ]; then 
                        setUserList $3
                        # Only cli version is offered to reboot
                        [ $runningOnGui == true ] || reboot
                    fi;
                ;;
                *)
                notRecognized $2
                ;;
            esac
        ;;
        *)
            notRecognized $1
        ;;
    esac
}

main $argList 

test -f $runConfig && rm -f $runConfig