r102:
[carnet-tools-cn.git] / functions.sh
index f3124da..2ab04ff 100644 (file)
@@ -1,6 +1,13 @@
+# Initialize "public" CP_ECHO_RETURN variable once
+if [ -z "$_CP_INIT_ECHO_RETURN" ]; then
+  _CP_INIT_ECHO_RETURN=1
+  CP_ECHO_RETURN=""
+fi
+
 # by ddzeko & ico, Fri, 18 Mar 2005 14:44:08 +0100
 cp_get_ifaddr() {
   [ "$CP_SCRIPT_DEBUG" ] && set -vx
+
   local ifaddr interface echo_return
   echo_return="$CP_ECHO_RETURN" # since we're making our own calls
   # in our own way we need to set CP_ECHO_RETURN the way we want it
@@ -17,13 +24,13 @@ cp_get_ifaddr() {
   if ! ifconfig $interface 2> /dev/null >> /dev/null; then
     echo "cp_get_ifaddr: $interface: No such interface" 1>&2
     CP_ECHO_RETURN="$echo_return"
-    return 1
+    return 2
   fi
 
   ifaddr="`/sbin/ifconfig $interface | awk '/inet/{ printf("%s\n",substr($2,index($2,":")+1)) }'`"
 
   if [ -z $ifaddr ]; then
-    echo "cp_get_ifaddr: $interface: No such ipaddress" 1>&2
+    echo "cp_get_ifaddr: $interface: No ip address found" 1>&2
     CP_ECHO_RETURN="$echo_return"
     return 1
   fi
@@ -36,6 +43,7 @@ cp_get_ifaddr() {
 # by ddzeko & ico, Fri, 18 Mar 2005 14:44:08 +0100
 cp_get_ifmask() {
   [ "$CP_SCRIPT_DEBUG" ] && set -vx
+
   local ifmask interface echo_return
   echo_return="$CP_ECHO_RETURN" # since we're making our own calls
   # in our own way we need to set CP_ECHO_RETURN the way we want it
@@ -58,7 +66,7 @@ cp_get_ifmask() {
   ifmask="`/sbin/ifconfig $interface | awk '/Mask/{if($3~/Mask/)a=$3;else if ($4~/Mask/)a=$4;printf ("%s\n", substr(a,index(a,":")+1))}'`"
 
   if [ -z "$ifmask" ]; then
-    echo "cp_get_ifmask: $interface: No such netmask" 1>&2
+    echo "cp_get_ifmask: $interface: No netmask found" 1>&2
     CP_ECHO_RETURN="$echo_return"
     return 1
   fi
@@ -70,28 +78,42 @@ cp_get_ifmask() {
 
 # by ddzeko, Mon, 21 Mar 2005 07:00:22 +0100
 cp_get_ifdefault() {
+  [ "$CP_SCRIPT_DEBUG" ] && set -vx
+
   local echo_return
   echo_return="$CP_ECHO_RETURN" # since we're making our own calls
   # in our own way we need to set CP_ECHO_RETURN the way we want it
   # but preserving initial state so it could be used afterwards
   CP_ECHO_RETURN=""
 
-  [ "$CP_SCRIPT_DEBUG" ] && set -vx
   RET=""
   case $1 in
-    dev)  RET=`route -n | awk '/^0.0.0.0/{print $8}'` ;;
-    addr) RET=`route -n | awk '/^0.0.0.0/{print $2}'` ;;
-    *)    echo "cp_get_ifdefault: Argument required (dev or addr)" >&2 ;;
+    dev)
+      RET=`route -n | awk 'BEGIN {m = 2^32}
+                           /^0\.0\.0\.0[ \t]/ {if ($5 < m) {r = $8; m = $5}}
+                             END {print r}'`
+      ;;
+    addr)
+      RET=`route -n | awk 'BEGIN {m = 2^32}
+                           /^0\.0\.0\.0[ \t]/ {if ($5 < m) {r = $2; m = $5}}
+                                    END {print r}'`
+      ;;
+    *)
+      echo "cp_get_ifdefault: Argument required (dev or addr)" >&2
+      ;;
   esac
-  [ -z "$RET" -a "$1" -a "$CP_VERBOSE" ] && echo "cp_get_ifdefault: No default route" >&2
+
+  [ -z "$RET" -a "$1" ] && echo "cp_get_ifdefault: No default route" >&2
+
   [ -z "$echo_return" ] || echo $RET
   CP_ECHO_RETURN="$echo_return"
-  [ -z "$RET" ] && return 1
+  [ -n "$RET" ] || return 1
 }
 
 # by ico, Tue, 15 Mar 2005 14:04:21 +0100
 cp_get_netaddr() {
   [ "$CP_SCRIPT_DEBUG" ] && set -vx
+
   local netmask ipaddress interface cidr echo_return
   echo_return="$CP_ECHO_RETURN" # since we're making our own calls
   # in our own way we need to set CP_ECHO_RETURN the way we want it
@@ -114,14 +136,14 @@ cp_get_netaddr() {
   cp_get_ifaddr "$interface"
   ipaddress="$RET"
   if [ -z $ipaddress ]; then
-    echo "cp_get_netaddr: $interface: No such ipaddress" 1>&2
+    echo "cp_get_netaddr: $interface: No IP address found" 1>&2
     CP_ECHO_RETURN="$echo_return"
     return 1
   fi
   cp_get_ifmask "$interface"
   netmask="$RET"
   if [ -z $netmask ]; then
-    echo "cp_get_netaddr: $interface: No such netmask" 1>&2
+    echo "cp_get_netaddr: $interface: No netmask found" 1>&2
     CP_ECHO_RETURN="$echo_return"
     return 1
   fi
@@ -137,32 +159,96 @@ cp_get_netaddr() {
   CP_ECHO_RETURN="$echo_return"
 }
 
+cp_check_and_backup() {
+  [ "$CP_SCRIPT_DEBUG" ] && set -vx
+
+  cp_backup_conffile -r "$@"
+}
+
 # by ico, Tue, 15 Mar 2005 14:04:21 +0100
 cp_backup_conffile() {
   [ "$CP_SCRIPT_DEBUG" ] && set -vx
-  local file_bak
 
+  local dir ext file_bak check did opt_p opt_d
+  
+  dir=/var/backups
+  ext=.bak
+  
+  while echo "x$1" |grep -q '^x-'; do
+    case "$1" in
+    -r)
+      shift
+      check=1
+      ;;
+    -p)
+      shift
+      opt_p=1
+      ;;
+    -d)
+      shift
+      opt_d=1
+      # Is argument to -d full path or relative?
+      if echo "$1" |grep -q '^/'; then
+        dir="$1"
+      else
+        dir="$dir/$1"
+      fi
+      shift
+      ;;
+    -n)
+      shift
+      ext=
+      ;;
+    esac
+  done
+  if [ "$opt_d" ]; then
+    if [ ! -e "$dir" -a "$opt_p" ]; then
+      mkdir "$dir"
+    fi
+    if [ $? -ne 0 ]; then
+      echo "cp_backup_conffile: Error creating backup directory $dir" 1>&2
+      return 3
+    fi
+  fi
+  if [ ! -d "$dir" ]; then
+    echo "cp_backup_conffile: Invalid backup directory $dir" 1>&2
+    return 3
+  fi
   if [ -z "$1" ]; then
     return 1
   fi
   if [ ! -f "$1" ]; then
     echo "cp_backup_conffile: $1: No such file" 1>&2
-    return 1
+    return 2
+  fi
+  if [ -z "$2" ]; then
+    file_bak="$dir/`basename $1`$ext"
+  else
+    file_bak="$dir/`basename $2`$ext"
   fi
 
-  file_bak="/var/backups/`basename $1`.bak"
-
-  if [ ! -f $file_bak ]; then
-    cp -pf "$1" $file_bak
+  if [ ! -f "$file_bak" ]; then
+    cp -pf "$1" "$file_bak"
+    did=1
   else
-    if ! cmp -s "$1" $file_bak; then
-      /usr/bin/savelog -p -c 7 $file_bak > /dev/null 2> /dev/null
-      cp -pf $1 $file_bak
+    if ! cmp -s "$1" "$file_bak"; then
+      /usr/bin/savelog -p -c 7 "$file_bak" > /dev/null 2> /dev/null
+      cp -pf "$1" "$file_bak"
+      did=1
     fi
   fi
+
+  [ -z "$check" ] && return 0
+
+  if [ "$check" -a ! "$did" ]; then
+    return 3
+  else
+    return 0
+  fi
 }
 
 # by jelly, Tue, 15 Mar 2005 14:04:21 +0100
+# modified by ico, Mon,  6 Jun 2005 11:58:08 +0200
 # A sed wrapper, to use instead of perl -pi -e
 #  - relatively safe in-place s///g
 #  - takes care of symlinks and ownership
@@ -170,7 +256,11 @@ cp_backup_conffile() {
 #
 cp_check_and_sed() {
   [ "$CP_SCRIPT_DEBUG" ] && set -vx
-  local s sedcmd ret i
+
+  local s sedcmd grepret ret i
+  if [ -z "$3" ]; then
+    return 1
+  fi
   s="$1"
   shift
   sedcmd="$1"
@@ -179,11 +269,17 @@ cp_check_and_sed() {
   for i in "$@"
   do
     [ -e "$i" ]        || continue
-    if egrep -q "$s" "$i"; then
+    if ! egrep -q "$s" "$i"; then
+      grepret=1
       continue
     fi
     [ -h "$i" ]        && i=$(readlink -f "$i")
     sed "$sedcmd" "$i" > "$i.dpkg-tmp"
+    if [ $? -ne 0 ]; then
+      rm "$i.dpkg-tmp"
+      echo "cp_check_and_sed: Problem with sed" 1>&2
+      return 5
+    fi
     if ! cmp -s "$i" "$i.dpkg-tmp" 2>&1 >/dev/null; then
       cp_mv "$i.dpkg-tmp" "$i"
     else
@@ -191,12 +287,14 @@ cp_check_and_sed() {
     fi
     ret=0
   done
+  [ "$ret" -eq 2 -a "$grepret" ] && ret=1
   return $ret
 }
 
 # by jelly, Sun, 20 Mar 2005 20:12:19 +0100
 cp_echo () {
   [ "$CP_SCRIPT_DEBUG" ] && set -vx
+
   if [ "x$1" = "x-mailonly" -o "x$1" = "x-m" ]; then
     shift
   else   
@@ -212,13 +310,18 @@ cp_echo () {
 # by jelly, Sun, 20 Mar 2005 20:12:19 +0100
 cp_mail () {
   [ "$CP_SCRIPT_DEBUG" ] && set -vx
+
   local pkg version quiet
   if [ "x$1" = "x-q" ]; then
     quiet=1
     shift
   fi
-  [ -n "$1" ] && pkg="$1"       # barf if no package
-  [ -n "$2" ] && version=" $2" || true
+  if [ -n "$1" ]; then
+    pkg="$1"
+  else
+    return 1 # must have at least the package name as argument
+  fi
+  [ -n "$2" ] && version=" $2"
   if [ "$(echo $CP_NOTICE|wc -w)" -gt 0 ]; then
     [ -n "$quiet" ] || echo "Mailing upgrade output to root."
     CP_NOTICE="From: $pkg postinst script <root>
@@ -243,6 +346,7 @@ ${CP_NOTICE}----------"
 # by ddzeko, Mon, 21 Mar 2005 11:31:59 +0100
 cp_mv () {
   [ "$CP_SCRIPT_DEBUG" ] && set -vx
+
   local new old
   if [ -z "$2" ]; then
     return 1
@@ -255,6 +359,7 @@ cp_mv () {
   fi
   mv "$new" "$old"
 }
+
 # by ddzeko, Mon, 21 Mar 2005 13:35:42 +0100
 cp_yes_no () {
   [ "$CP_SCRIPT_DEBUG" ] && set -vx
@@ -266,7 +371,7 @@ cp_yes_no () {
   # check to prevent user from using this when debconf is active
   # (it would break communication with its backend - uses stdin/out)
   if [ "$DEBCONF_REDIR" ]; then
-    echo "cn_yes_no: debconf redirection detected" >&2
+    echo "cp_yes_no: debconf redirection detected" >&2
     return 1
   fi
 
@@ -297,9 +402,19 @@ cp_yes_no () {
 # --> that's why we wrap the db_get call to return unset RET variable
 #     instead of some gibberish error message that our script does
 #     not expect
-cp_db_get_wrap() {
+cp_db_get() {
+  [ "$CP_SCRIPT_DEBUG" ] && set -vx
+
   local var
   var="$1"
+  
+  # check to prevent user from using this before activating debconf
+  # confmodule needs to be loaded before accessing db_* functions
+  if [ -z "$DEBCONF_REDIR" ]; then
+    echo "cp_db_get: debconf not activated!" >&2
+    return 1
+  fi
   if ! db_get "$var"; then
     case "$RET" in
         *doesn\'t\ exist)
@@ -312,3 +427,94 @@ cp_db_get_wrap() {
   fi
 }
 
+# by ico, Wed, 20 Apr 2005 21:09:54 +0200
+cp_get_ldap_suffix() {
+  [ "$CP_SCRIPT_DEBUG" ] && set -vx
+
+  local echo_return
+  echo_return="$CP_ECHO_RETURN" # since we're making our own calls
+  # in our own way we need to set CP_ECHO_RETURN the way we want it
+  # but preserving initial state so it could be used afterwards
+  CP_ECHO_RETURN=""
+
+  if [ ! -f /etc/ldap/slapd.conf ]; then
+    echo "cp_get_ldap_suffix: /etc/ldap/slapd.conf: No such file" >&2
+    return 2
+  fi
+  
+  RET="`awk  '/^suffix/      { exit }
+              END            { gsub(/"/, "", $2); print $2 }' \
+            < /etc/ldap/slapd.conf`"
+
+  if [ "`echo $RET | sed 's/,/ /g' | wc -w`" -gt 2 ]; then
+    RET=""
+    echo "cp_get_ldap_suffix: Invalid LDAP suffix in /etc/ldap/slapd.conf" >&2
+    return 2
+  fi
+    
+  [ -z "$RET" ] && echo "cp_get_ldap_suffix: No LDAP suffix in /etc/ldap/slapd.conf" >&2
+  [ -z "$echo_return" ] || echo $RET
+  CP_ECHO_RETURN="$echo_return"
+}
+
+# by ico, Wed, 20 Apr 2005 21:09:54 +0200
+cp_get_ldap_realm() {
+  [ "$CP_SCRIPT_DEBUG" ] && set -vx
+
+  local echo_return
+  echo_return="$CP_ECHO_RETURN" # since we're making our own calls
+  # in our own way we need to set CP_ECHO_RETURN the way we want it
+  # but preserving initial state so it could be used afterwards
+  CP_ECHO_RETURN=""
+
+  if [ ! -f /etc/ldap/slapd.conf ]; then
+    echo "cp_get_ldap_realm: /etc/ldap/slapd.conf: No such file" >&2
+    return 2
+  fi
+  cp_get_ldap_suffix || true
+  RET="`echo $RET | awk -F, '{print $1}' | awk -F= '{print $2}'`"
+
+  [ -z "$RET" ] && echo "cp_get_ldap_realm: No LDAP REALM in /etc/ldap/slapd.conf" >&2
+  [ -z "$echo_return" ] || echo $RET
+  CP_ECHO_RETURN="$echo_return"
+}
+
+_cp_customize() {
+  [ "$CP_SCRIPT_DEBUG" ] && set -vx
+  # < input functions > output_functions
+  # new-prefix list-of-functions
+  perl -e '
+    $prefix = shift; %keep = (); $output = "";
+    $keep{$_} = 1 for @ARGV;
+    # add dependent functions
+    %deps = (
+      get_ifaddr       => [ "get_ifdefault" ],
+      get_netaddr      => [ "get_ifdefault", "get_ifaddr", "get_ifmask" ],
+      check_and_backup => [ "backup_conffile" ],
+      check_and_sed    => [ "mv" ],
+      get_ldap_realm   => [ "get_ldap_suffix" ],
+    );
+    foreach my $f (keys(%keep)) {
+      if (exists($deps{$f})) {
+        $keep{$_} = 1 for (@{$deps{$f}});
+      }
+    }
+    while (<STDIN>) {
+      if (/^_?cp_(\w+) *\(\) *\{/) {
+        if (! exists($keep{$1})) {
+          while (<STDIN>) { last if /^\}/; } # skip it
+          next;
+        } else {
+          $output .= "\n";
+        }
+      }
+      next if /^\s*(\#|$)/;
+      $output .= $_;
+    }
+    $output =~ s/\b(_?)cp_/$1${prefix}_/sg;
+    $prefix = uc($prefix);
+    $output =~ s/\b(_?)CP_/$1${prefix}_/sg;
+    print $output;
+  ' -- $*
+}