Firefox-user.js-supplement/misc/user.js-notify.sh

#!/usr/bin/env bash
#
# NOTE TO SELF: DIST. set $sScriptVer value
#
## SCRIPT INFORMATION
# ------------------------------------------------------------------------------
# Name          : Firefox Config Update Notifier
# Description   : compare version of local 'arkenfox' user.js and, optionally,
#               : 12bytes.org user-overrides.js, to their remote counterparts
#               : and display a desktop notification containing version info
# Version       : 2020-09-16
# Copyright     : 12bytes.org, 2020
# License       : GNU General Public License, version 3+
# Dependencies  : notify-send, curl
# Author        : 12bytes.org
# Website       : 12bytes.org / Firefox-user.js-supplement
#               : https://codeberg.org/12bytes.org/Firefox-user.js-supplement
# Website       :  arkenfox/user.js
#               : https://github.com/arkenfox/user.js
# Website       : The Firefox Privacy Guide For Dummies!
#               : https://12bytes.org/articles/tech/firefox/the-firefox-privacy-guide-for-dummies/ – 12Bytes.org
# Website       : Firefox Configuration Guide for Privacy Freaks and Performance Buffs – 12Bytes.org
#               : https://12bytes.org/articles/tech/firefox/firefoxgecko-configuration-guide-for-privacy-and-performance-buffs/
# Comment       : Developed on Manjaro (Arch) Linux, GNU bash version 5.x
#
## LICENSE
# ------------------------------------------------------------------------------
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
#
## USAGE
# ------------------------------------------------------------------------------
# Place this script in your Firefox profile directory along side the 'arkenfox'
# user.js file and make it executable. To run this script automatically you can
# add it to your startup programs, or as a CRON job, a systemd timer, etc.
#
## BEGIN USER CONFIGURATION
# ------------------------------------------------------------------------------

# Firefox profile directory - replace '<user>' and '<profile_name>' (no trailing
# slash)
sFfProfileDir='/home/<user>/.mozilla/firefox/<profile_name>'

# check for updated user-overrides.js by 12bytes.org? ('yes' or 'no')
sChkOverridesJs='yes'

# how many seconds to wait after log-on before performing an update check
sleep 20

# ------------------------------------------------------------------------------
## END USER CONFIGURATION

sScriptVer='2020-09-16'

cd "$sFfProfileDir" || { echo "Failed to change directory!"; exit 1; }

func_err () {
    notify-send -i dialog-error 'Firefox Config Update Notifier' "<b>ERROR: ${sErr}</b>"
    exit 1
}

# check for updated version of this script
if sRemoteScript="$( curl -sm 30 'https://codeberg.org/12bytes.org/Firefox-user.js-supplement/raw/branch/master/misc/user.js-notify.sh' )" ; then
    if sRemoteScriptVer="$( echo "$sRemoteScript" | grep -Pom 1 '^# Version       : \K.*' )" ; then
        if [[ "$sRemoteScriptVer" != "$sScriptVer" ]] ; then
            notify-send 'Firefox Config Update Notifier' 'Please update the Firefox Config Update Notifier script:<a href="https://codeberg.org/12bytes.org/Firefox-user.js-supplement/raw/branch/master/misc/user.js-notify.sh">DOWNLOAD</a>'
            exit 0
        fi
    else
        sErr="Failed to get version of remote Firefox Config Update Notifier script."
        func_err
    fi
else
    sErr="Failed to read remote Firefox Config Update Notifier script."
    func_err
fi

# get firefox version
if sFfVer="$( firefox --version | grep -Eo '[0-9]+\..*' )" ; then
    sNotify="<b>Firefox:</b> v${sFfVer}<br/>"
else
    sErr="Failed to get Firefox version."
    func_err
fi

# get local user.js version and date
if sLocalJsVer="$( grep -Pom 1 '^\* version \K[0-9]+.*' 'user.js' )" ; then
    # get local user.js date string
    if sLocalJsDate="$( grep -Pom 1 '^\* date: \K.*' 'user.js' )" ; then
        sNotify+="<b>Local user.js:</b> v${sLocalJsVer}, ${sLocalJsDate}<br/>"
    else
        sErr="Failed to get local user.js date."
        func_err
    fi
else
    sErr="Failed to get local user.js version."
    func_err
fi

# read remote user.js
if sRemoteJs="$( curl -sm 30 'https://raw.githubusercontent.com/arkenfox/user.js/master/user.js' )" ; then
    # get remote version and date
    if sRemoteJsVer="$( echo "$sRemoteJs" | grep -Pom 1 '^\* version \K.*' )" ; then
        if sRemoteJsDate="$( echo "$sRemoteJs" | grep -Pom 1 '^\* date: \K.*' )" ; then
            sNotify+='<b><a href="https://github.com/arkenfox/user.js">Remote user.js:</a></b> v'"${sRemoteJsVer}, ${sRemoteJsDate}<br/>"

        else
            sErr="Failed to get remote user.js date."
            func_err
        fi
    else
        sErr="Failed to get remote user.js version."
        func_err
    fi
else
    sErr="Failed to read remote user.js."
    func_err
fi

# check for user-overrides.js
if [[ "$sChkOverridesJs" == 'yes' ]] ; then
    # get local user-overrides.js version string
    if sLocalOverridesJsVer="$( grep -Pom 1 '^ \* version  : \K.*' 'user-overrides.js' )" ; then
        sNotify+="<b>Local user-overrides.js:</b> v${sLocalOverridesJsVer}<br/>"
    else
        sErr="Failed to get local user-overrides.js version."
        func_err
    fi

    # read remote user-overrides.js
    if sRemoteOverridesJs="$( curl -sm 30 'https://codeberg.org/12bytes.org/Firefox-user.js-supplement/raw/branch/master/user-overrides.js' )" ; then
        # get remote version
        if sRemoteOverridesJsVer="$( echo "$sRemoteOverridesJs" | grep -Pom 1 '^ \* version  : \K.*' )" ; then
            sNotify+='<b><a href="https://codeberg.org/12bytes.org/Firefox-user.js-supplement">Remote user-overrides.js</a>:</b> v'"${sRemoteOverridesJsVer}<br/>"
        else
            sErr="Failed to get remote user-overrides.js version."
            func_err
        fi
    else
        sErr="Failed to read remote user-overrides.js."
        func_err
    fi
fi

# notify-send icons: https://specifications.freedesktop.org/icon-naming-spec/latest/ar01s04.html
notify-send 'Firefox Config Update Notifier' "<br/>${sNotify}"