path: root/System/apt-update-python-bin-packages-to-official-archive.sh

#!/bin/bash
########################################################################################################################
# apt-update-python-bin-packages-to-official-archive.sh
########################################################################################################################
#
# All rights reserved Ⓒ 2017-2023 sdxlive.com
#
# Written by Jean-Christophe Manciot <jcmanciot@sdxlive.com>
#
# Licensed under a GPLv3 License.
# You may not use this file except in compliance with the License. You may obtain a copy of the License at
#
#    https://www.gnu.org/licenses/gpl-3.0.md
#
# The licensor cannot revoke these freedoms as long as you follow the license terms.
#
# Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. 
# You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
#
########################################################################################################################

########################################################################################################################
#
# Updating all installed Python binary packages to the package version provided by the official Debian/Ubuntu repositories.
#
########################################################################################################################
#
# Requirements:
# ------------
#
# - We assume that apt alongside all its dependencies are already installed.
# - We expect that 'deb-src' URIs are set in your sources.list
#
########################################################################################################################
#
# Parameters:
# ----------
#
# - <os_version>: binary packages version ending with +<os_version>
#   For instance:
#       * 11|11.0       matches bullseye Debian distribution
#       * 22.04         matches jammy Ubuntu distribution
# - <auto>: one of
#       * true|yes: the binary packages will be updated without any user's confirmation
#                   Use with caution.
#       * false|no: the binary packages will be updated only with user's confirmation for each source package
#                   (default)
# - <versions_group>: optional, one of
#       + positive: updating only the subset of installed Python binary packages with a version ending with +<os_version> 
#       + negative: updating only the subset of installed Python binary packages with a version ending with -<os_version> 
#       + all: updating all installed Python binary packages
#              (default)
# - <apt_non_interactive_enabled>: boolean
#       * true: 
#               + debconf/frontend is set to Noninteractive at the beginning of the script then
#               + debconf/frontend is set to Dialog at the end of the script
#       * false: debconf/frontend is not modified
#                (default)
#
#######################################################################################################################
#
# Usage example:
# -------------
#
# apt-update-python-bin-packages-to-official-archive.sh 19.10 true positive
#
########################################################################################################################
# set -x
# Expanding aliases
shopt -s expand_aliases

#------------------------------------apt-get-src-package-name--------------------------------------
# Getting the source package name fromp a binary package name.
function apt-get-src-package-name ()
{
        local python_bin_package_name=$1
        local python_bin_package_version=$2
        local PARAMETERS_NUMBER=2

        case "$#" in
                ${PARAMETERS_NUMBER})
                        ;;
                *)
                        echo -e ''$_{1..180}'\b-'
                        echo Wrong number of parameters: $(basename $0) $@
                        echo -e ''$_{1..180}'\b-'
                        return 1
                        ;;
        esac

        if [[ -n "$python_bin_package_version" ]]; then
                src_package_name=$(apt-cache -q=0 2>&1 show ${python_bin_package_name}=${python_bin_package_version} | grep Source: | head -n 1 | cut -d ' ' -f 2)
        else
                src_package_name=$(apt-cache -q=0 2>&1 show ${python_bin_package_name} | grep Source: | head -n 1 | cut -d ' ' -f 2)
        fi
        if [[ -z "$src_package_name" ]]; then
                src_package_name=$(apt-cache -q=0 2>&1 showsrc ${python_bin_package_name} | grep Package: | head -n 1 | cut -d ' ' -f 2)
                if [[ -z "$src_package_name" ]]; then
                        echo ''
                        return 1
                fi
        fi
        echo "$src_package_name"
        return 0
}

#------------------------------------apt-update-python-bin-packages-to-official-archive.sh-----------
os_version=$1
auto=$2
versions_group=$3
apt_non_interactive_enabled=$4
PARAMETERS_NUMBER=1

case "$#" in
        0)
                end_of_help_message_line_number=$(awk '/^# set -x/{ print NR; exit }' $(which apt-update-python-bin-packages-to-official-archive.sh))
                ((end_of_help_message_line_number--))
                if [[ (-n $(apt-cache -q=0 2>&1 policy zenity | grep Installed)) && (! ($(apt-cache -q=0 2>&1 policy zenity | grep Installed) =~ none)) ]]; then
                        awk -v var=$end_of_help_message_line_number 'NR >= 2 && NR <= var' $(which apt-update-python-bin-packages-to-official-archive.sh) | zenity --text-info --title "apt-update-python-bin-packages-to-official-archive.sh help" --width 1350 --height 1000
                else
                        awk -v var=$end_of_help_message_line_number 'NR >= 2 && NR <= var' $(which apt-update-python-bin-packages-to-official-archive.sh)
                fi
                exit 1
                ;;
        $PARAMETERS_NUMBER)
                case "$1" in
                        -h|--help)
                                end_of_help_message_line_number=$(awk '/^# set -x/{ print NR; exit }' $(which apt-update-python-bin-packages-to-official-archive.sh))
                                ((end_of_help_message_line_number--))
                                if [[ (-n $(apt-cache -q=0 2>&1 policy zenity | grep Installed)) && (! ($(apt-cache -q=0 2>&1 policy zenity | grep Installed) =~ none)) ]]; then
                                        awk -v var=$end_of_help_message_line_number 'NR >= 2 && NR <= var' $(which apt-update-python-bin-packages-to-official-archive.sh) | zenity --text-info --title "apt-update-python-bin-packages-to-official-archive.sh help" --width 1350 --height 1000
                                else
                                        awk -v var=$end_of_help_message_line_number 'NR >= 2 && NR <= var' $(which apt-update-python-bin-packages-to-official-archive.sh)
                                fi
                                exit 1
                                ;;
                        *)
                                auto=false
                                versions_group=all
                                apt_non_interactive_enabled=false
                                ;;
                esac
                ;;
        $((PARAMETERS_NUMBER+1)))
                versions_group=all
                apt_non_interactive_enabled=false
                ;;
        $((PARAMETERS_NUMBER+2)))
                apt_non_interactive_enabled=false
                ;;
        $((PARAMETERS_NUMBER+3)))
                ;;
        *)
                echo -e ''$_{1..180}'\b-'
                echo Wrong number of parameters: $(basename $0) $@
                echo -e ''$_{1..180}'\b-'
                exit 1
                ;;
esac

# Escaping the '$.*?/|\^(){}+@[]' characters for later grep -P searched string
# Letters, digits and '-' must not be escaped
alias escape_grep_pcre_search_string=$'sed -e \'s|[]$.*?/|\^(){}+@[]|\\\&|g\''
# '
# Escaping the '$.*?/|\^(){}+@[]' characters for later sed -E|-r searched string
# Letters, digits and '-' must not be escaped
alias escape_sed_ere_search_string=$'sed -e \'s|[]$.*?/|\^(){}+@[]|\\\&|g\''
# '

dpkg-lock.sh apt update

if [[ $apt_non_interactive_enabled == true ]]; then
        echo 'debconf debconf/frontend select Noninteractive' | debconf-set-selections
fi        

# Installing dependencies needed to play an alert or a completion sound when necessary
dpkg-lock.sh apt -y install alsa-utils emacspeak pidgin-data

grep_esc_os_version="$(echo "$os_version" | escape_grep_pcre_search_string)"

os_distribution=$(lsb_release -a  2>/dev/null | grep "Distributor ID" | cut -d ':' -f 2)
os_distribution=${os_distribution//[[:space:]]/}
case $os_distribution in
        Debian)
                official_archives_uri=deb.debian.org/debian
                ;;
        Ubuntu)
                official_archives_uri=archive.ubuntu.com/ubuntu
                ;;
        *)
                echo -e ''$_{1..180}'\b-'
                echo Unknown distribution $os_distribution
                echo -e ''$_{1..180}'\b-'
                if [[ $apt_non_interactive_enabled == true ]]; then
                        echo 'debconf debconf/frontend select Dialog' | debconf-set-selections
                fi        
                exit 1
                ;;
esac
grep_esc_official_archives_uri="$(echo "$official_archives_uri" | escape_grep_pcre_search_string)"

# Python binary packages installed from distribution $os_version
python_bin_package_names=()
case $versions_group in
        positive)
                readarray -t python_bin_package_names < <(apt list --installed 2>/dev/null | grep -P -- ".*python.*\+${grep_esc_os_version} " | cut -d '/' -f 1)
                ;;
        negative)
                readarray -t python_bin_package_names < <(apt list --installed 2>/dev/null | grep -P -- ".*python.*-${grep_esc_os_version} " | cut -d '/' -f 1)
                ;;
        all)
                readarray -t python_bin_package_names < <(apt list --installed 2>/dev/null | grep -P -- ".*python.* " | cut -d '/' -f 1)
                ;;
        *)
                echo -e ''$_{1..180}'\b-'
                echo Unknown versions group $versions_group
                echo -e ''$_{1..180}'\b-'
                if [[ $apt_non_interactive_enabled == true ]]; then
                        echo 'debconf debconf/frontend select Dialog' | debconf-set-selections
                fi        
                exit 1
                ;;
esac

# Sorting the array
if [[ ${#python_bin_package_names[@]} -ne 0 ]]; then
        sorted_python_bin_package_names=()
        IFS=$'\n' sorted_python_bin_package_names=($(sort -uV <<<"${python_bin_package_names[*]}"))
        unset IFS
else
        aplay /usr/share/sounds/purple/login.wav
        if [[ $apt_non_interactive_enabled == true ]]; then
                echo 'debconf debconf/frontend select Dialog' | debconf-set-selections
        fi        
        exit 0
fi

updated_python_bin_package_names_versions=()
for ((s=0; s<${#sorted_python_bin_package_names[@]}; s++))
do
        python_bin_package_family_names_versions=()
        python_bin_package_name="${sorted_python_bin_package_names[${s}]}"
        if [[ -z "$python_bin_package_name" ]]; then
                continue
        fi
        python_bin_package_installed_version=$(apt-cache -q=0 2>&1 policy "$python_bin_package_name" | grep Installed | sed -E 's|^.*?: (.*)$|\1|g')
        src_package_name=$(apt-get-src-package-name "$python_bin_package_name" "$python_bin_package_installed_version")
        if [[ -z "$src_package_name" ]]; then
                continue
        fi
        python_bin_package_installed_core_version=$(echo "$python_bin_package_installed_version" | sed -E "s|^(.*)[\+-]${os_version}$|\1|g")
        grep_esc_python_bin_package_name="$(echo "$python_bin_package_name" | escape_grep_pcre_search_string)"
        python_bin_package_official_candidate_version=$(apt-cache -q=0 2>&1 madison "$python_bin_package_name" | grep -P "$grep_esc_python_bin_package_name" | grep -P "$grep_esc_official_archives_uri" | grep amd64 | head -n 1 | cut -d '|' -f 2)
        # Removing all spaces, tabs, line breaks
        python_bin_package_official_candidate_version=${python_bin_package_official_candidate_version//[[:space:]]/}
        if [[ -n "$python_bin_package_official_candidate_version" ]]; then
                python_bin_package_family_names_versions=("${python_bin_package_name}@${python_bin_package_installed_version}@${python_bin_package_installed_core_version}@${python_bin_package_official_candidate_version}")
                # Removing $python_bin_package_family_name from ${sorted_python_bin_package_names[@]} array
                # Beware that the unset creates a gap in the array but modifies its size
                unset "sorted_python_bin_package_names[${s}]"
                # It also messes with the index if the removed cell index is lower than or equal to the current cell index
                ((s--))
                # Rebuilding the array to fill the gap
                sorted_python_bin_package_names=("${sorted_python_bin_package_names[@]}")
        else
                # This binary package is not available in the official repositories
                continue
        fi

        # Searching for all installed binary packages which share the same source package as $python_bin_package_name
        for ((index=0; index<${#sorted_python_bin_package_names[@]}; index++))
        do
                python_bin_package_name_2="${sorted_python_bin_package_names[${index}]}"
                if [[ (-z "$python_bin_package_name_2") || ("$python_bin_package_name_2" == "$python_bin_package_name") ]]; then
                        continue
                fi
                python_bin_package_installed_version_2=$(apt-cache -q=0 2>&1 policy "$python_bin_package_name_2" | grep Installed | sed -E 's|^.*?: (.*)$|\1|g')
                src_package_name_2=$(apt-get-src-package-name "$python_bin_package_name_2" "$python_bin_package_installed_version_2")
                if [[ "$src_package_name_2" == "$src_package_name" ]]; then
                        # Removing $python_bin_package_family_name from ${sorted_python_bin_package_names[@]} array
                        # Beware that the unset creates a gap in the array which modifies its size
                        unset "sorted_python_bin_package_names[${index}]"
                        # It also messes with the index if the removed cell index is lower than or equal to the current cell index
                        ((index--))
                        # Rebuilding the array to fill the gap
                        sorted_python_bin_package_names=("${sorted_python_bin_package_names[@]}")

                        python_bin_package_installed_core_version_2=$(echo "$python_bin_package_installed_version_2" | sed -E "s|^(.*)[\+-]${os_version}$|\1|g")
                        grep_esc_python_bin_package_name_2="$(echo "$python_bin_package_name_2" | escape_grep_pcre_search_string)"
                        python_bin_package_official_candidate_version_2=$(apt-cache -q=0 2>&1 madison "$python_bin_package_name_2" | grep -P "$grep_esc_python_bin_package_name_2" | grep -P "$grep_esc_official_archives_uri" | grep amd64 | head -n 1 | cut -d '|' -f 2)
                        # Removing all spaces, tabs, line breaks
                        python_bin_package_official_candidate_version_2=${python_bin_package_official_candidate_version_2//[[:space:]]/}
                        if [[ -n "$python_bin_package_official_candidate_version_2" ]]; then
                                python_bin_package_family_names_versions=("${python_bin_package_family_names_versions[@]}" "${python_bin_package_name_2}@${python_bin_package_installed_version_2}@${python_bin_package_installed_core_version_2}@${python_bin_package_official_candidate_version_2}")
                        else
                                # This binary package is not available in the official repositories
                                continue
                        fi
                fi
        done

        unset update_group
        # Building the $update_group with all the binary packages from the same source family and their official candidate version
        for python_bin_package_family_name_versions in "${python_bin_package_family_names_versions[@]}"
        do
                python_bin_package_family_name=$(echo "$python_bin_package_family_name_versions" | cut -d '@' -f 1)
                python_bin_package_family_name_official_candidate_version=$(echo "$python_bin_package_family_name_versions" | cut -d '@' -f 4)
                if [[ -n "$python_bin_package_family_name_official_candidate_version" ]]; then
                        if [[ -z "$update_group" ]]; then
                                update_group="${python_bin_package_family_name}=${python_bin_package_family_name_official_candidate_version}"
                        else
                                update_group="${update_group} ${python_bin_package_family_name}=${python_bin_package_family_name_official_candidate_version}"
                        fi
                fi
        done

        # Updating all the binary packages from the same source family
        if [[ -n $update_group ]]; then
                printf "\n"
                echo -e ''$_{1..180}'\b='
                echo "Updating all installed binary packages from source package: $src_package_name"
                echo "to: $update_group"
                echo -e ''$_{1..180}'\b='
                case $auto in
                        true|yes)
                                dpkg-lock.sh apt --show-progress --assume-yes --allow-downgrades --allow-change-held-packages install $update_group
                                return_code=$?
                                if [[ $return_code -eq 0 ]]; then
                                        updated_python_bin_package_names_versions=("${updated_python_bin_package_names_versions[@]}" "${python_bin_package_family_names_versions[@]}")
                                else
                                        aplay /usr/share/emacs/site-lisp/emacspeak/sounds/classic/alert-user.wav
                                        if [[ $apt_non_interactive_enabled == true ]]; then
                                                echo 'debconf debconf/frontend select Dialog' | debconf-set-selections
                                        fi        
                                        exit 1
                                fi
                                ;;
                        false|no)
                                dpkg-lock.sh apt --show-progress --allow-downgrades --allow-change-held-packages install $update_group
                                return_code=$?
                                if [[ $return_code -eq 0 ]]; then
                                        updated_python_bin_package_names_versions=("${updated_python_bin_package_names_versions[@]}" "${python_bin_package_family_names_versions[@]}")
                                elif [[ $return_code -ne 1 ]]; then
                                        aplay /usr/share/emacs/site-lisp/emacspeak/sounds/classic/alert-user.wav
                                        if [[ $apt_non_interactive_enabled == true ]]; then
                                                echo 'debconf debconf/frontend select Dialog' | debconf-set-selections
                                        fi        
                                        exit 1
                                fi
                                ;;
                        *)
                                printf "\n"
                                echo -e ''$_{1..180}'\b-'
                                echo "Unknown auto: $auto"
                                echo -e ''$_{1..180}'\b-'
                                if [[ $apt_non_interactive_enabled == true ]]; then
                                        echo 'debconf debconf/frontend select Dialog' | debconf-set-selections
                                fi        
                                exit 1
                                ;;
                esac
        fi
done

if [[ ${#updated_python_bin_package_names_versions[@]} -ne 0 ]]; then
        printf "\n"
        echo -e ''$_{1..180}'\b='
        echo "The following Python binary packages have been updated from their installed version to their official candidate version:"
        echo -e ''$_{1..180}'\b='
        echo "python_bin_package_name <--> python_bin_package_installed_version <--> python_bin_package_installed_core_version <--> python_bin_package_official_candidate_version "
        echo -e ''$_{1..180}'\b='
        printf "%s\n" "${updated_python_bin_package_names_versions[@]}" | sort -uV | sed -E 's|@| <--> |g'
fi

aplay /usr/share/sounds/purple/login.wav
if [[ $apt_non_interactive_enabled == true ]]; then
        echo 'debconf debconf/frontend select Dialog' | debconf-set-selections
fi        
exit 0