]> git.donarmstrong.com Git - neurodebian.git/blobdiff - tools/nd-aptenable
initial postinst and postrm scripts for neurodebian-repository pkg
[neurodebian.git] / tools / nd-aptenable
index 499a3e8c307639473c629648220054610a12ba3f..d6f5192106887adc35829e243d98489f5f5867e0 100755 (executable)
@@ -2,7 +2,7 @@
 #emacs: -*- mode: shell-script; c-basic-offset: 4; tab-width: 4; indent-tabs-mode: nil -*-
 #ex: set sts=4 ts=4 sw=4 et:
 
-# Depends:    apt, python, wget
+# Depends:    apt (assumed to be present), python, wget
 # Recommends: netselect
 
 # play safe
@@ -16,20 +16,24 @@ set -u
 nd_aptenable_version=0.1
 
 nd_key_id=0x2649A5A9
+nd_config_url=https://raw.githubusercontent.com/neurodebian/neurodebian/master/neurodebian.cfg
 nd_config_file=/etc/neurodebian/neurodebian.cfg
 nd_mirror_origin=http://neuro.debian.net/debian
 nd_mirror_default=$nd_mirror_origin # or may be AWS?
 
-# To be set by cmdline args
-ae_release=
-ae_components=software,data
-ae_flavor=
-ae_mirror=best
-ae_suffix=
-ae_verbose=1
-ae_overwrite=
-ae_sources=
-ae_dry_run=
+# To be set by cmdline args or via env variables with prefix ND_AE_
+ae_release=${ND_AE_RELEASE:-}
+ae_components=${ND_AE_COMPONENTS:-software,data}
+ae_flavor=${ND_AE_FLAVOR:-}
+ae_mirror=${ND_AE_MIRROR:-best}
+ae_suffix=${ND_AE_SUFFIX:-}
+ae_verbose=${ND_AE_VERBOSE:-1}
+ae_overwrite=${ND_AE_OVERWRITE:-}
+ae_sources=${ND_AE_SOURCES:-}
+ae_install=${ND_AE_INSTALL:-}
+ae_update=${ND_AE_UPDATE:-1}
+ae_dry_run=${ND_AE_DRY_RUN:-}
+ae_defun_only=${ND_AE_DEFUN_ONLY:-} # mode to source this file as a "library"
 
 ae_sudo=
 exe_dir=$(dirname $0)
@@ -38,16 +42,25 @@ exe_dir=$(dirname $0)
 # - apt priority! (so we could avoid automagic upgrades etc)
 # - multiarch setups
 
-ae_tempdir=$(mktemp -d)
-trap "rm -rf \"$ae_tempdir\"" TERM INT EXIT
+if [ -z "${ND_AE_TEMPDIR:-}" ]; then
+    ae_tempdir=$(mktemp -d)
+    trap "rm -rf \"$ae_tempdir\"" TERM INT EXIT
+else
+    # reuse the same directory/fetched configuration if was specified
+    ae_tempdir="${ND_AE_TEMPDIR:-}"
+fi
+
 
+nd_config_file_fresh="$ae_tempdir/neurodebian.cfg"
 
 print_verbose()
 {
     level=$1; shift
        if [ "$ae_verbose" -ge $level ]; then
         # use stderr for printing within functions stdout of which might be used
-        echo -e "I: $*" >&2
+        echo -n "I: " >&2
+        i=1; while [ $i -lt $level ]; do echo -ne " ">&2; i=$(($i+1)); done
+        echo -e "$*" >&2
     fi
 }
 
@@ -77,9 +90,13 @@ EOT
 eval_dry()
 {
     if [ -z "$ae_dry_run" ]; then
-        eval "$ae_sudo $@"
+        if eval "$ae_sudo $@" 1>|"$ae_tempdir/eval.log" 2>&1; then
+            rm "$ae_tempdir/eval.log"
+        else
+            error $? "Command $@ failed with exit code $?.  Output was: `cat $ae_tempdir/eval.log`"
+        fi
     else
-        echo "DRY: $@"
+        echo "DRY: $@" >&2
     fi
 }
 
@@ -98,6 +115,9 @@ Options:
     it is deduced from the  apt-cache policy  output, by taking repository
     of Debian or Ubuntu origin with highest priority.
 
+  --print-releases
+    Return a list of releases present in NeuroDebian repository.
+
   -f, --flavor=full|libre
     Which flavor of the repository should be enabled:
      libre -- Only  main  component, containing only DFSG-compliant content.
@@ -116,6 +136,9 @@ Options:
     Which mirror to use.  Could be a mirror code-name (as specified in
     /etc/neurodebian/neurodebian.cfg), or a URL.
 
+  --print-mirrors
+    Return a list (with abbreviation) of known NeuroDebian mirrors.
+
   --overwrite,
     If apt file already present, it would not be overriden (by default).
     Use this option to overwrite.
@@ -132,6 +155,10 @@ Options:
     Do not perform any changes -- generated configurations and commands will
     simply be printed to stdout
 
+  --install
+    If found absent, all necessary tools (wget, netselect) if available will
+    be apt-get installed
+
   -v, --verbose
     Enable additional progress messages.  Could be used multiple times
 
@@ -170,19 +197,28 @@ EOT
 
 get_neurodebian_cfg()
 {
+    if [ -s "$nd_config_file_fresh" ]; then
+        print_verbose 3 "Config file $nd_config_file_fresh exists -- not fetching"
+        echo "$nd_config_file_fresh"
+        return 0
+    fi
     # First we try to fetch the most recent version from the github
     print_verbose 3 "Fetching config file from the github repository"
-    cfgfile_temp="$ae_tempdir/neurodebian.cfg"
-    wget -c -q -O$cfgfile_temp https://raw.githubusercontent.com/neurodebian/neurodebian/master/neurodebian.cfg \
-        && { echo $cfgfile_temp; } \
-        || { [ -e "$nd_config_file" ] && return "$nd_config_file"; }
-    # if not -- should blow up
+    assure_command_from_package wget wget 1
+    wget --no-check-certificate -c -q -O$nd_config_file_fresh \
+        $nd_config_url \
+        && { echo "$nd_config_file_fresh"; } \
+        || { [ -e "$nd_config_file" ] \
+             && echo "$nd_config_file" \
+             || error 10 "Neither could fetch $nd_config_url, nor found $nd_config_file"; }
 }
 
 query_cfg_section()
 {
     config_file="$1"
     section="$2"
+    print_verbose 3 "Querying config $config_file section $section"
+    assure_command_from_package python python-minimal 1
     python -c "from ConfigParser import SafeConfigParser as SP; cfg = SP(); cfg.read('$config_file'); print('\n'.join([' '.join(x) for x in cfg.items('$section')]))"
 }
 
@@ -190,29 +226,67 @@ get_mirrors()
 {
     nd_config=`get_neurodebian_cfg`
 #    $exe_dir/nd_querycfg -F" " --config-file="$nd_config" "mirrors" \
+    n=""
     query_cfg_section "$nd_config" "mirrors" \
     | while read mirror_name mirror_url; do
         # verify that url is just a url
         if echo "$mirror_url" | grep -v -e '^[a-z0-9:+]*://[-+_%.a-z0-9/]*$'; then
             print_verbose 1 "Mirror $mirror_name has 'illegit' URL: $mirror_url.  Skipping"
         fi
-        echo "$mirror_name $mirror_url"
+        [ -z "$n" ] || echo -ne "${ND_IFS:-\n}"; n+=1
+        echo -n "$mirror_name $mirror_url"
+    done
+}
+
+get_releases()
+{
+    nd_config=`get_neurodebian_cfg`
+    n=""
+    query_cfg_section "$nd_config" "release files" \
+    | while read release_name release_url; do
+        # verify that url is just a url
+        if [ "$release_name" = "data" ]; then
+            # skip data
+            continue
+        fi
+        [ -z "$n" ] || echo -ne "${ND_IFS:-\n}"; n+=1
+        echo -n "$release_name"
     done
 }
 
+get_package_version()
+{
+    pkg_version=$(apt-cache policy "$1" | awk '/^ *Installed:/{print $2;}')
+    [ "$pkg_version" != '(none)' ] || pkg_version=''
+    echo "$pkg_version"
+}
+
 netselect_mirror() {
     # select "closest" mirror according to netselect.
     print_verbose 2 "Selecting the 'best' mirror using netselect"
-    if ! which netselect >/dev/null; then
+    assure_command_from_package netselect
+    if ! which netselect >&/dev/null; then
         print_verbose 1 "netselect (apt-get install netselect) needed to select the 'best' mirror was not found"
         print_verbose 1 "Selecting the default repository: $nd_mirror_default"
         echo $nd_mirror_default
     else
-        get_mirrors | awk '{print $2;}' | $ae_sudo xargs netselect -D -s 1 | awk '{print $2;}'
+        # squeeze version doesn't have -D yet to force output of the URL not IP, but for our mirrors ATM it shouldn't matter
+        netselect_opts="-s 1"
+        netselect_version="$(get_package_version netselect)"
+        if dpkg --compare-versions "$netselect_version" ge 0.3.ds1-17; then
+            netselect_opts+=" -D"
+        fi
+        if dpkg --compare-versions "$netselect_version" ge 0.3.ds1-15; then
+            netselect_opts+=" -I"
+        fi
+        best_mirror=$(get_mirrors | awk '{print $2;}' | eval $ae_sudo xargs netselect $netselect_opts | awk '{print $2;}')
+        print_verbose 2 "Best mirror: $best_mirror"
+        echo $best_mirror
     fi
 }
 
-get_mirror_url() {
+get_mirror_url()
+{
     # given mirror alias -- find its url
     url=$(get_mirrors | awk "/^$1 /{print \$2;}")
     if [ -z "$url" ]; then
@@ -230,14 +304,50 @@ get_apt_policy()
     # or
     # get_apt_policy NeuroDebian
     suites="$1"
-    apt-cache policy | grep -B1 -e "o=\(${suites//,/\\|}\)" | tr '\n' ' ' | sed -e 's, -- ,\n,g' | grep -v -e '-\(updates\|security\)' | sort -nr
+    $ae_sudo apt-cache policy | grep -B1 -e "o=\(${suites//,/\\|}\)" | tr '\n' ' ' | sed -e 's, -- ,\n,g' | grep -v -e '-\(updates\|security\)' | sort -nr
 }
 
-include_component()
+is_component_included()
 {
     echo "$ae_components" | tr ',' '\n' | grep -q "^$1\$"
 }
 
+is_sources_enabled()
+{
+    apt-cache showsrc apt >&/dev/null && echo 1 || echo 0
+}
+
+assure_command_from_package()
+{
+    cmd=$1
+    pkg=${2:-$cmd}
+    fail=${3:-}
+
+    which "$cmd" >&/dev/null && return 0
+
+    # if absent -- check availability of the package
+    apt_cache=$(LANG=C apt-cache policy "$pkg" 2>&1)
+    if [[ "$apt_cache" =~ "Unable to locate package" ]] || [[ "$apt_cache" =~ "Candidate: (none)" ]]; then
+        print_verbose 1 "Package $pkg providing command $cmd is N/A. Skipping"
+        return 10;
+    fi
+    if echo "$apt_cache" | grep -q '^\s*\*\*\*'; then
+        print_verbose 1 "WARNING -- command $cmd is N/A but package $pkg is claimed to be installed"
+        [ -z "$fail" ] && return 11 || error $fail "Command $cmd is required to proceed"
+    fi
+    if [ "$ae_install" = "1" ]; then
+        print_verbose 1 "Installing $pkg package to get $cmd command"
+        eval_dry DEBIAN_FRONTEND=noninteractive apt-get install -y "$pkg"
+        return
+    else
+        print_verbose 1 "Command $cmd (from package $pkg) is N/A."
+        print_verbose 1 "Use with --install to get all necessary packages installed automatically"
+        [ -z "$fail" ] && return 12 || error $fail "Command $cmd is required to proceed"
+    fi
+}
+
+# if it was requested -- return without doing anything
+[ -z "$ae_defun_only" ] || return
 
 #
 # Commandline options handling
@@ -247,7 +357,7 @@ include_component()
 # Note that we use `"$@"' to let each command-line parameter expand to a
 # separate word. The quotes around `$@' are essential!
 # We need CLOPTS as the `eval set --' would nuke the return value of getopt.
-CLOPTS=`getopt -o h,r:,m:,f:,c:,q,v,n --long help,version,quiet,verbose,mirror:,release:,flavor:,components:,suffix:,overwrite,sources,no-sources,dry-run,print-mirrors,print-best-mirror -n 'nd-aptenable' -- "$@"`
+CLOPTS=`getopt -o h,r:,m:,f:,c:,q,v,n --long help,version,quiet,verbose,mirror:,release:,flavor:,components:,suffix:,overwrite,sources,no-sources,install,dry-run,do-not-update,print-releases,print-mirrors,print-best-mirror -n 'nd-aptenable' -- "$@"`
 
 if [ $? != 0 ] ; then
   error 2 "Problem with parsing cmdline.  Terminating..."
@@ -268,11 +378,14 @@ while true ; do
       -m|--mirror) shift;  ae_mirror="$1"; shift;;
          --print-mirrors)  get_mirrors; exit 0;;
          --print-best-mirror)  netselect_mirror; exit 0;;
+         --print-releases)  get_releases; exit 0;;
       -n|--dry-run)        ae_dry_run=1; shift;;
          --suffix) shift;  ae_suffix="$1"; shift;;
          --overwrite)      ae_overwrite="$1"; shift;;
+         --do-not-update)  ae_update=""; shift;;
          --sources)        ae_sources=1; shift;;
          --no-sources)     ae_sources=0; shift;;
+         --install)        ae_install=1; shift;;
          -q|--quiet)          ae_verbose=0; shift;;
          -v|--verbose)        ae_verbose=$(($ae_verbose+1)); shift;;
          -h|--help) print_help; exit 0;;
@@ -312,7 +425,7 @@ fi
 #
 
 # knowing mirror is not necessary for -devel available only from the main site
-if include_component software || include_component data; then
+if is_component_included software || is_component_included data; then
     # for now just use default
     if [ -z "$ae_mirror" ]; then # none specified
         ae_mirror_url=$nd_mirror_origin
@@ -341,7 +454,7 @@ case $ae_flavor in
 esac
 
 if [ -z "$ae_sources" ]; then
-    apt-cache showsrc apt >&/dev/null && ae_sources=1 || ae_sources=0
+    ae_sources=$(is_sources_enabled)
 fi
 
 if [ $ae_sources -eq 0 ]; then
@@ -352,7 +465,7 @@ fi
 
 apt_list=
 
-if include_component software; then
+if is_component_included software; then
     apt_list+="
 # NeuroDebian software repository
 deb     $ae_mirror_url $ae_release main $apt_flavor
@@ -360,7 +473,7 @@ ${sources_comment}deb-src $ae_mirror_url $ae_release main $apt_flavor
 "
 fi
 
-if include_component data; then
+if is_component_included data; then
     apt_list+="
 # NeuroDebian data repository
 deb     $ae_mirror_url data main $apt_flavor
@@ -368,7 +481,7 @@ ${sources_comment}deb-src $ae_mirror_url data main $apt_flavor
 "
 fi
 
-if include_component devel; then
+if is_component_included devel; then
     apt_list+="
 # NeuroDebian -devel repository
 deb     http://neuro.debian.net/debian-devel $ae_release main $apt_flavor
@@ -414,21 +527,29 @@ if LANG=C eval $ae_sudo apt-key export $nd_key_id 2>&1 1>/dev/null | grep -qe "n
     eval_dry apt-key adv --recv-keys --keyserver pgp.mit.edu $nd_key_id
 fi
 
+
 #
 # Finalizing (apt-get update etc)
 #
 
-print_verbose 1 "Updating APT listings, might take a few minutes"
-if [ -z "$ae_dry_run" ]; then
-    apt_logfile="$ae_tempdir/apt.log"
-    $ae_sudo apt-get update 1>"$apt_logfile" 2>&1 \
-        && rm -f "$apt_logfile" \
-        || {
-             cat "$apt_logfile"
-             error 5 "E: Update failed with exit code $? (above output logged into $apt_logfile)."
-             }
-else
-    eval_dry apt-get update
+if [ ! -z "$ae_update" ]; then
+    print_verbose 1 "Updating APT listings, might take a few minutes"
+    if [ -z "$ae_dry_run" ]; then
+        apt_logfile="$ae_tempdir/apt.log"
+        $ae_sudo apt-get update 1>"$apt_logfile" 2>&1 \
+            && rm -f "$apt_logfile" \
+            || {
+                 apt_log=$(cat "$apt_logfile")
+                 echo "$apt_log"
+                 if echo "$apt_log" | grep -q "Malformed line [0-9]* in source list $ae_output_file"; then
+                     $ae_sudo mv "${ae_output_file}" "${ae_output_file}-failed.disabled"
+                     error 6 "Update failed to possible errorneous APT listing file produced by this script.  Generated $ae_output_file renamed to ${ae_output_file}-failed.disabled to not interfer"
+                 fi
+                 error 5 "Update failed with exit code $? (above output logged into $apt_logfile)."
+                 }
+    else
+        eval_dry apt-get update
+    fi
 fi
 
 if [ "$ae_verbose" -ge 2 ]; then