Fix how version number is saved/retrieved. Version is now stored in

[monkeysphere.git] / src / share / common

diff --git a/src/share/common b/src/share/common
index 31f8ddd08a0cbba9f633be7576a24c836a9e58c5..b2dcd35d98628ed56ba6472b78f7b7444ab8e396 100644 (file)
--- a/src/share/common
+++ b/src/share/common
@@ -8,7 +8,7 @@
 # Jamie McClelland <jm@mayfirst.org>
 # Daniel Kahn Gillmor <dkg@fifthhorseman.net>
 #
-# Copyright 2008, released under the GPL, version 3 or later
+# Copyright 2008-2009, released under the GPL, version 3 or later
 
 # all-caps variables are meant to be user supplied (ie. from config
 # file) and are considered global
@@ -20,9 +20,6 @@
 SYSCONFIGDIR=${MONKEYSPHERE_SYSCONFIGDIR:-"/etc/monkeysphere"}
 export SYSCONFIGDIR
 
-# monkeysphere version
-VERSION=__VERSION__
-
 # default log level
 LOG_LEVEL="INFO"
 
@@ -41,6 +38,11 @@ PROMPT="true"
 ########################################################################
 ### UTILITY FUNCTIONS
 
+# output version info
+version() {
+    cat "${SYSSHAREDIR}/VERSION"
+}
+
 # failure function.  exits with code 255, unless specified otherwise.
 failure() {
     [ "$1" ] && echo "$1" >&2
@@ -149,9 +151,14 @@ cutline() {
     head --line="$1" "$2" | tail -1
 }
 
-# make a temporary directly
+# make a temporary directory
 msmktempdir() {
-    mktemp -d ${TMPDIR:-/tmp}/tmp.XXXXXXXXXX
+    mktemp -d ${TMPDIR:-/tmp}/monkeysphere.XXXXXXXXXX
+}
+
+# make a temporary file
+msmktempfile() {
+    mktemp ${TMPDIR:-/tmp}/monkeysphere.XXXXXXXXXX
 }
 
 # this is a wrapper for doing lock functions.
@@ -581,8 +588,8 @@ gpg2authorized_keys() {
 # FIXME: need to figure out how to retrieve all matching keys
 # (not just first N (5 in this case))
 gpg_fetch_userid() {
+    local returnCode=0
     local userID
-    local returnCode
 
     if [ "$CHECK_KEYSERVER" != 'true' ] ; then
        return 0
@@ -621,6 +628,7 @@ gpg_fetch_userid() {
 #
 # expects global variable: "MODE"
 process_user_id() {
+    local returnCode=0
     local userID
     local requiredCapability
     local requiredPubCapability
@@ -652,10 +660,10 @@ process_user_id() {
     # output gpg info for (exact) userid and store
     gpgOut=$(gpg --list-key --fixed-list-mode --with-colon \
        --with-fingerprint --with-fingerprint \
-       ="$userID" 2>/dev/null)
+       ="$userID" 2>/dev/null) || returnCode="$?"
 
     # if the gpg query return code is not 0, return 1
-    if [ "$?" -ne 0 ] ; then
+    if [ "$returnCode" -ne 0 ] ; then
         log verbose " no primary keys found."
         return 1
     fi
@@ -885,6 +893,7 @@ process_host_known_hosts() {
 # update the known_hosts file for a set of hosts listed on command
 # line
 update_known_hosts() {
+    local returnCode=0
     local nHosts
     local nHostsOK
     local nHostsBAD
@@ -914,9 +923,9 @@ update_known_hosts() {
 
     for host ; do
        # process the host
-       process_host_known_hosts "$host"
+       process_host_known_hosts "$host" || returnCode="$?"
        # note the result
-       case "$?" in
+       case "$returnCode" in
            0)
                nHostsOK=$((nHostsOK+1))
                ;;
@@ -1038,6 +1047,7 @@ process_uid_authorized_keys() {
 # update the authorized_keys files from a list of user IDs on command
 # line
 update_authorized_keys() {
+    local returnCode=0
     local userID
     local nIDs
     local nIDsOK
@@ -1067,10 +1077,10 @@ update_authorized_keys() {
     for userID ; do
        # process the user ID, change return code if key not found for
        # user ID
-       process_uid_authorized_keys "$userID"
+       process_uid_authorized_keys "$userID" || returnCode="$?"
 
        # note the result
-       case "$?" in
+       case "$returnCode" in
            0)
                nIDsOK=$((nIDsOK+1))
                ;;
@@ -1148,10 +1158,49 @@ process_authorized_user_ids() {
 # takes a gpg key or keys on stdin, and outputs a list of
 # fingerprints, one per line:
 list_primary_fingerprints() {
-    local file="$1"
     local fake=$(msmktempdir)
     GNUPGHOME="$fake" gpg --no-tty --quiet --import
     GNUPGHOME="$fake" gpg --with-colons --fingerprint --list-keys | \
        awk -F: '/^fpr:/{ print $10 }'
     rm -rf "$fake"
 }
+
+
+check_cruft_file() {
+    local loc="$1"
+    local version="$2"
+    
+    if [ -e "$loc" ] ; then
+       printf "! The file '%s' is no longer used by\n  monkeysphere (as of version %s), and can be removed.\n\n" "$loc" "$version" | log info
+    fi
+}
+
+check_upgrade_dir() {
+    local loc="$1"
+    local version="$2"
+
+    if [ -d "$loc" ] ; then
+       printf "The presence of directory '%s' indicates that you have\nnot yet completed a monkeysphere upgrade.\nYou should probably run the following script:\n  %s/transitions/%s\n\n" "$loc" "$SYSSHAREDIR" "$version" | log info
+    fi
+}
+
+## look for cruft from old versions of the monkeysphere, and notice if
+## upgrades have not been run:
+report_cruft() {
+    check_upgrade_dir "${SYSCONFIGDIR}/gnupg-host" 0.23
+    check_upgrade_dir "${SYSCONFIGDIR}/gnupg-authentication" 0.23
+
+    check_cruft_file "${SYSCONFIGDIR}/gnupg-authentication.conf" 0.23
+    check_cruft_file "${SYSCONFIGDIR}/gnupg-host.conf" 0.23
+
+    local found=
+    for foo in "${SYSDATADIR}/backup-from-"*"-transition"  ; do
+       if [ -d "$foo" ] ; then
+           printf "! %s\n" "$foo" | log info
+           found=true
+       fi
+    done
+    if [ "$found" ] ; then
+       printf "The directories above are backups left over from a monkeysphere transition.\nThey may contain copies of sensitive data (host keys, certifier lists), but\nthey are no longer needed by monkeysphere.\nYou may remove them at any time.\n\n" | log info
+    fi
+}