#!/bin/bash

MYVERSION=0.20080420

# If you improve this script, please read the comments at the
# end of this file.  Thanks.

#usage/help message
usage_message() {
cat >&2 <<EOT

Usage:   ${0##*/} [ options ] [ directory ]

Makes a tarred, gzipped backup of a Firefox profile.
If no directory is given, the backup is stored in
the Firefox settings directory.

Options:
   -h               print this help text and exit
   -p profilename   back up the named profile
                       (default is "default")
   -q               tar in quiet mode
   -t tag           add string tag to the backup filename
   -v               tar in verbose mode

EOT
}

# variable initialization
# note variables holding directory paths do *not* include the trailing /
TODAY=$(date -Idate | sed 's~-~~g')  # used in backup filename
TAG=""                               # used in backup filename
FXSETDIR=~/.mozilla/firefox          # Fx settings dir
#FXSETDIR=$APPDATA/Mozilla/Firefox   #
OUTDIR=$FXSETDIR                     # default output dir
PROFNAME=default                     # default profilename
TARVERB=--verbose                    # change to "" to make tar quiet by default

# message formats
ERRFMT=${0##*/}:\ error:\ \\033[33\;41\;1m\ %b\ \\033[0m\\\n  # yellow/red
NFOFMT=${0##*/}:\ \\033[36\;1m%b\\033[0m\\\n                  # bold cyan
#ERRFMT=${0##*/}:\ error:\ %b\\\n    # use these formats instead,
#WRNFMT=${0##*/}:\ warning:\ %b\\\n  # if you don't want colors

# exit codes
E_ARGS=65    # error parsing arguments
E_OUTDIR=3   # problem with output directory
E_PROF=4     # problem with specified profile
E_TARGZ=5    # problem with tar.gz creation
E_CYG=6      # cygwin-specific problem
E_OSTYPE=7   # problem with this OS
E_HELP=10    # called with -h or -V

[[ $OSTYPE == *gnu* || $OSTYPE == *cygwin* ]] || {
	printf "$ERRFMT" \
		"I only work in a GNU environment" \
		"To make me try to execute in strange" \
		"territory, comment out lines 54-60" >&2
	exit $E_OSTYPE
	}

#parse the arguments
while getopts "hp:qt:vV" ARGS 2>/dev/null; do
	case $ARGS in
		\?) printf "$ERRFMT" "cannot parse given parameters" >&2
			usage_message
			exit $E_ARGS
			;;
		h) usage_message; exit $E_HELP; ;;
		p) PROFNAME=$OPTARG; ;;
		q) TARVERB=""; ;;
		t) TAG=-$OPTARG; ;;
		v) TARVERB=--verbose; ;;
		V) printf "$NFOFMT" "version $MYVERSION" >&2; exit $E_HELP; ;;
	esac
done

# move on to non-option parameters
shift $((OPTIND - 1))

# the only parameter (if any) should be the output directory,
# so figure it out and do a little error checking
[[ $# -gt 1 ]] && { 
	printf "$ERRFMT" "too many arguments given" >&2
	usage_message
	exit $E_ARGS
	}
[[ -n $1 ]] && OUTDIR=$1

# if under cygwin, change paths to POSIXness
if [[ $OSTYPE == *cygwin* ]]; then
	FXSETDIR=$(cygpath "$FXSETDIR") && OUTDIR=$(cygpath "$OUTDIR") || {
		printf "$ERRFMT" \
			"error using cygpath under cygwin" \
			"please make sure cygpath is installed" >&2
		exit $E_CYG
		}
fi

# strip trailing / if present
OUTDIR=$(echo "$OUTDIR" | sed 's~\(.\+\)/$~\1~')

[[ -d $OUTDIR ]] || {
	printf "$ERRFMT" "$OUTDIR is not a directory" >&2
	usage_message
	exit $E_OUTDIR
	}
[[ -w $OUTDIR ]] || {
	printf "$ERRFMT" "no permission to write to $OUTDIR" >&2
	usage_message
	exit $E_OUTDIR
	}

# use the profilename to find its directory by examining profiles.ini
PROFDESC=$(grep -B 1 -A 2 "^Name=$PROFNAME[[:cntrl:]]\?$" "$FXSETDIR/profiles.ini")
[[ -z $PROFDESC ]] && {
	printf "$ERRFMT" \
		"cannot find profile '$PROFNAME'" \
		"to verify the name, run firefox -ProfileManager" >&2
	usage_message
	exit $E_PROF
	}
[[ $(echo "$PROFDESC" | wc -l) -ne 4 ]] && {
	printf "$ERRFMT" \
		"cannot determine profile directory to back up" \
		"            please debug me now              " >&2
	exit $E_PROF
	}

RELFLAG=$(echo "$PROFDESC" | sed -n '/^IsRelative=\([01]\)/{s~^IsRelative=\([01]\)[[:cntrl:]]\?$~\1~; p}')
[[ $RELFLAG	-eq 1 ]] &&
	PROFDIR=$FXSETDIR/$(echo "$PROFDESC" | sed -n '\~^Path=~{s~Path=~~; p}') ||
	PROFDIR=$(echo "$PROFDESC" | sed -n '\~^Path=~{s~Path=~~; p}')
# if under cygwin, change path to POSIXness
if [[ $OSTYPE == *cygwin* ]]; then
	PROFDIR=$(cygpath "$PROFDIR") || {
		printf "$ERRFMT" "error using cygpath under cygwin" \
		                 "please make sure cygpath is installed" >&2
		exit $E_CYG
		}
fi
[[ ! -d $PROFDIR ]] && {
	printf "$ERRFMT" \
		"cannot determine profile to back up" \
		"    please debug me now            " >&2
	exit $E_PROF
	}
[[ -h $PROFDIR/lock ]] || [[ -e $PROFDIR/lock ]] || [[ -e $PROFDIR/parent.lock ]] && {
	printf "$ERRFMT" \
		"profile '$PROFNAME' is locked" \
		"try again after killing any firefoxen" >&2
	exit $E_PROF
	}

# generate name for backup file
BACKUPCOUNT=1
BACKUPFILE=$OUTDIR/${PROFDIR##*/}.$TODAY$TAG.tar.gz
while [[ -e $BACKUPFILE ]]; do
	BACKUPFILE=$OUTDIR/${PROFDIR##*/}.$TODAY$TAG-$BACKUPCOUNT.tar.gz
	BACKUPCOUNT=$((BACKUPCOUNT+1))
done

# make the tar.gz, check tar's exit code, and be done
cd "${PROFDIR%/*}" || {
	printf "$ERRFMT" "cannot enter ${PROFDIR%/*}" >&2
	exit $E_PROF
	}
tar $TARVERB --gzip --preserve --create --file="$BACKUPFILE" --exclude=Cache* "${PROFDIR##*/}"
[[ $OSTYPE == *cygwin* ]] && BACKUPFILE=$(cygpath -m "$BACKUPFILE")
printf "$NFOFMT"  \
	"The Firefox profile '$PROFNAME' has been backed up to" \
	"$BACKUPFILE"
exit 0

##################################################################
##                                                              ##
##   This script is provided as-is, with no warranty.  Use it   ##
##   however you want.  No rights are reserved.                 ##
##                                                              ##
##   If you improve the script, please mail your changes to     ##
##   boxcars at gmx dot net.                                    ##
##                                                              ##
##################################################################