Update changelog for 1.2.0-1 release

Create an override_dh_auto_install rule that appropriately forces the PREFIX
for a managed installation. Creating autotools boilerplate or a fancier
Makefile for this script is not yet worthwhile.

Makefile

@@ -1,15 +1,19 @@
+PREFIX := /usr/local
+
 all:
 
 install:
-	install -d $(DESTDIR)$(PREFIX)/etc/cron.d
+	install -d $(DESTDIR)/etc/cron.d
-	install -d $(DESTDIR)$(PREFIX)/etc/cron.daily
+	install -d $(DESTDIR)/etc/cron.daily
-	install -d $(DESTDIR)$(PREFIX)/etc/cron.hourly
+	install -d $(DESTDIR)/etc/cron.hourly
-	install -d $(DESTDIR)$(PREFIX)/etc/cron.weekly
+	install -d $(DESTDIR)/etc/cron.weekly
-	install -d $(DESTDIR)$(PREFIX)/etc/cron.monthly
+	install -d $(DESTDIR)/etc/cron.monthly
-	install etc/zfs-auto-snapshot.cron.frequent $(DESTDIR)$(PREFIX)/etc/cron.d/zfs-auto-snapshot
+	install -m 0644 etc/zfs-auto-snapshot.cron.frequent $(DESTDIR)/etc/cron.d/zfs-auto-snapshot
-	install etc/zfs-auto-snapshot.cron.hourly   $(DESTDIR)$(PREFIX)/etc/cron.hourly/zfs-auto-snapshot
+	install etc/zfs-auto-snapshot.cron.hourly   $(DESTDIR)/etc/cron.hourly/zfs-auto-snapshot
-	install etc/zfs-auto-snapshot.cron.daily    $(DESTDIR)$(PREFIX)/etc/cron.daily/zfs-auto-snapshot
+	install etc/zfs-auto-snapshot.cron.daily    $(DESTDIR)/etc/cron.daily/zfs-auto-snapshot
-	install etc/zfs-auto-snapshot.cron.weekly   $(DESTDIR)$(PREFIX)/etc/cron.weekly/zfs-auto-snapshot
+	install etc/zfs-auto-snapshot.cron.weekly   $(DESTDIR)/etc/cron.weekly/zfs-auto-snapshot
-	install etc/zfs-auto-snapshot.cron.monthly  $(DESTDIR)$(PREFIX)/etc/cron.monthly/zfs-auto-snapshot
+	install etc/zfs-auto-snapshot.cron.monthly  $(DESTDIR)/etc/cron.monthly/zfs-auto-snapshot
+	install -d $(DESTDIR)$(PREFIX)/share/man/man8
+	install src/zfs-auto-snapshot.8 $(DESTDIR)$(PREFIX)/share/man/man8/zfs-auto-snapshot.8
 	install -d $(DESTDIR)$(PREFIX)/sbin
 	install src/zfs-auto-snapshot.sh $(DESTDIR)$(PREFIX)/sbin/zfs-auto-snapshot

README

@@ -10,3 +10,12 @@ snapshots if it is installed.
 
 This program is a posixly correct bourne shell script.  It depends only on
 the zfs utilities and cron, and can run in the dash shell.
+
+
+Installation:
+-------------
+
+wget https://github.com/zfsonlinux/zfs-auto-snapshot/archive/master.zip
+unzip master.zip
+cd zfs-auto-snapshot-master
+make install

debian/changelog

@@ -0,0 +1,100 @@
+zfs-auto-snapshot (1.2.0-1) unstable; urgency=low
+
+  [ Roland Stühmer ]
+  * Fix SNAPNAME to contain the DATE if label is empty
+
+  [ Borut Mrak ]
+  * Remove PREFIX from cron scripts - they should always end up in /etc.
+  * Leave PREFIX for man page and program, and set it to /usr/local by default.
+
+  [ Maciej Małecki ]
+  * Add `--{pre,post}-snapshot` for pre and post creation hook
+  * Abort if pre snapshot hook returns non-zero
+  * Document `--{pre,post}-snapshot
+
+  [ Mike Baynton ]
+  * Make --{pre,post}-snapshot optional, add --destroy-only, revise docs
+
+  [ virtualguy ]
+  * Update README
+
+  [ Darik Horn ]
+  * Install the cron.d part without the execute bit.
+  * Update debian/rules for Makefile changes.
+
+ -- Darik Horn <dajhorn@vanadac.com>  Mon, 13 Oct 2014 23:17:30 -0500
+
+zfs-auto-snapshot (1.1.0-0ubuntu1) unstable; urgency=low
+
+  [ Markus Heberling ]
+  * Use only name property for zfs list
+
+  [ Darik Horn ]
+  * Add a switch for the fast zfs list invocation.
+
+  [ Mike Swanson ]
+  * Add a manpage
+  * Update Makefile for the manual page
+
+  [ HawkOwl ]
+  * Set the snapshots to use UTC time, which makes the date/time display correctly in Windows 7 Previous Versions.
+
+ -- Darik Horn <dajhorn@vanadac.com>  Mon, 31 Mar 2014 01:48:58 -0500
+
+zfs-auto-snapshot (1.0.8-0ubuntu2) unstable; urgency=low
+
+  * Update the debian/control file.
+
+ -- Darik Horn <dajhorn@vanadac.com>  Sun, 31 Mar 2013 23:10:55 -0500
+
+zfs-auto-snapshot (1.0.8-0ubuntu1) unstable; urgency=low
+
+  * Update the README file to be more descriptive.
+  * Fix pool exclusions.
+
+ -- Darik Horn <dajhorn@vanadac.com>  Sat, 21 Jan 2012 16:37:28 -0600
+
+zfs-auto-snapshot (1.0.7-0ubuntu1) unstable; urgency=low
+
+  [ Darik Horn ]
+  * Change objects to datasets in help and comments.
+  * Set keep=8 in the weekly cron job.
+
+  [ Ulrich Petri ]
+  * Fixed --prefix and --sep regexes
+
+ -- Darik Horn <dajhorn@vanadac.com>  Wed, 28 Dec 2011 13:30:02 -0600
+
+zfs-auto-snapshot (1.0.6-0ubuntu1) unstable; urgency=low
+
+  * Remove redundant lines in the cron.d file.
+  * Fix the hourly-daily transposition in the Makefile.
+
+ -- Darik Horn <dajhorn@vanadac.com>  Mon, 28 Nov 2011 00:10:05 -0600
+
+zfs-auto-snapshot (1.0.5-0ubuntu1) unstable; urgency=low
+
+  * Split the cron file for anacron compatibilty.
+
+ -- Darik Horn <dajhorn@vanadac.com>  Fri, 25 Nov 2011 14:28:07 -0600
+
+zfs-auto-snapshot (1.0.4-0ubuntu1) unstable; urgency=low
+
+  * Invert the --skip-scrub test.
+  * Fold the main loops into a do_snapshots function.
+  * Consistently quote literal strings.
+  * Implement --prefix parameter checking.
+  * Rebase exit codes to above 127.
+  * Implement the --event option for :auto-snap-desc.
+
+ -- Darik Horn <dajhorn@vanadac.com>  Wed, 23 Nov 2011 10:49:14 -0600
+
+zfs-auto-snapshot (1.0.3-0ubuntu1) unstable; urgency=low
+
+  * Add -q to the getopt list of short options.
+  * Add an explicit `exit 0` to the end of the script.
+  * Add gbp.conf file for git-buildpackage.
+  * Expand the options variable in the cron part file.
+  * Initial debian packaging.
+
+ -- Darik Horn <dajhorn@vanadac.com>  Mon, 21 Nov 2011 21:52:11 -0600

debian/compat

@@ -0,0 +1 @@
+7

debian/control

@@ -0,0 +1,16 @@
+Source: zfs-auto-snapshot
+Section: admin
+Priority: extra
+Maintainer: Darik Horn <dajhorn@vanadac.com>
+Build-Depends: debhelper (>= 8)
+Standards-Version: 3.9.4
+Homepage: http://www.zfsonlinux.org/
+Vcs-Git: git://github.com/zfsonlinux/zfs-auto-snapshot.git
+Vcs-Browser: https://github.com/zfsonlinux/zfs-auto-snapshot/
+
+Package: zfs-auto-snapshot
+Architecture: all
+Depends: ${misc:Depends}, cron, zfsutils
+Description: ZFS Automatic Snapshot Service
+ Automatically create and destroy ZFS snapshots on an hourly, daily, weekly
+ and monthly schedule.

debian/copyright

@@ -0,0 +1 @@
+Copyright 2011 Darik Horn <dajhorn@vanadac.com>

debian/gbp.conf

@@ -0,0 +1,3 @@
+[DEFAULT]
+upstream-branch = master
+debian-branch = debian

debian/rules

@@ -0,0 +1,7 @@
+#!/usr/bin/make -f
+
+%:
+	dh $@
+
+override_dh_auto_install:
+	dh_auto_install -- PREFIX=/usr

debian/watch

@@ -0,0 +1,2 @@
+version=3
+http://githubredir.debian.net/github/dajhorn/zfs-auto-snapshot/([\d\.].*).tar.gz

src/zfs-auto-snapshot.8

@@ -0,0 +1,91 @@
+.TH ZFS-AUTO-SNAPSHOT "8" "June 16, 2013" "zfs-auto-snapshot.sh" "System Administration Commands"
+.SH NAME
+zfs-auto-snapshot \- take regular ZFS snapshots
+.SH SYNOPSIS
+.B zfs-auto-snapshot
+[\fIoptions\fR] [\fI-l label\fR] \fI<'//' | name \fR[\fIname\fR...]\fI>\fR
+.SH DESCRIPTION
+.B zfs-auto-snapshot
+automatically creates, rotates, and destroys snapshots for all your
+ZFS datasets, and is compatible with both zfsonlinux and zfs-fuse.
+.SH OPTIONS
+.TP
+\fB\-\-default\-exclude\fR
+By default \fBzfs-auto-snapshot\fR will snapshot all datasets except
+for those in which the user-property \fBcom.sun:auto-snapshot\fR is
+set to \fBfalse\fR.  This option reverses the behavior and requires
+\fBcom.sun:auto-snapshot\fR to be set to \fBtrue\fR.
+.TP
+\fB\-d\fR, \fB\-\-debug\fR
+Print debugging messages.
+.TP
+\fB\-e\fR, \fB\-\-event\fR=\fIEVENT\fR
+Set the com.sun:auto\-snapshot\-desc property to EVENT.
+.TP
+\fB\-\-fast\fR
+Use a faster zfs list invocation.
+.TP
+\fB\-n\fR, \fB\-\-dry\-run\fR
+Print actions without actually doing anything.
+.TP
+\fB\-s\fR, \fB\-\-skip\-scrub\fR
+Do not snapshot filesystems in scrubbing pools.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print the usage message.
+.TP
+\fB\-k\fR, \fB\-\-keep\fR=\fINUM\fR
+Keep NUM recent snapshots and destroy older snapshots.
+.TP
+\fB\-l\fR, \fB\-\-label\fR=\fILAB\fR
+LAB is usually 'hourly', 'daily', or 'monthly'.
+.TP
+\fB\-p\fR, \fB\-\-prefix\fR=\fIPRE\fR
+PRE is 'zfs\-auto\-snap' by default.
+.TP
+\fB\-q\fR, \fB\-\-quiet\fR
+Suppress warnings and notices at the console.
+.TP
+\fB\-\-send\-full\fR=\fIF\fR
+Send zfs full backup. Unimplemented.
+.TP
+\fB\-\-send\-incr\fR=\fIF\fR
+Send zfs incremental backup. Unimplemented.
+.TP
+\fB\-\-sep\fR=\fICHAR\fR
+Use CHAR to separate date stamps in snapshot names.
+.TP
+\fB\-g\fR, \fB\-\-syslog\fR
+Write messages into the system log.
+.TP
+\fB\-r\fR, \fB\-\-recursive\fR
+Snapshot named filesystem and all descendants.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Print info messages.
+.TP
+\fB\-\-pre-snapshot\fR=\fICOMMAND\fR
+Command to run before each dataset is snapshotted. 
+It is passed the dataset and snapshot name. If it
+returns non-zero, snapshotting this dataset is 
+aborted.
+.TP
+\fB\-\-post-snapshot\fR=\fICOMMAND\fR
+Command to run after each dataset is snapshotted. 
+It is passed the dataset and snapshot name.
+.TP
+\fB\-\-destroy-only\fR
+Do not create new snapshots, but do destroy older 
+snapshots. Has no effect unless used with \fB\-k\fR.
+.IP
+A non-obvious use may be constructon of cron jobs or
+scripts that run pre-snapshot command(s), then run 
+zfs-auto-snapshot (without \fB\-k\fR) to quickly
+snapshot all datasets, then run post-snapshot
+command(s) and clean up with zfs-auto-snapshot
+\fB\-\-destroy-only\fR.
+.TP
+name
+Filesystem and volume names, or '//' for all ZFS datasets.
+.SH SEE ALSO
+.BR zfs (8)

src/zfs-auto-snapshot.sh

@@ -29,6 +29,7 @@ opt_backup_incremental=''
 opt_default_exclude=''
 opt_dry_run=''
 opt_event='-'
+opt_fast_zfs_list=''
 opt_keep=''
 opt_label=''
 opt_prefix='zfs-auto-snap'
@@ -38,6 +39,9 @@ opt_setauto=''
 opt_syslog=''
 opt_skip_scrub=''
 opt_verbose=''
+opt_pre_snapshot=''
+opt_post_snapshot=''
+opt_do_snapshots=1
 
 # Global summary statistics.
 DESTRUCTION_COUNT='0'
@@ -54,6 +58,7 @@ print_usage ()
   --default-exclude  Exclude datasets if com.sun:auto-snapshot is unset.
   -d, --debug        Print debugging messages.
   -e, --event=EVENT  Set the com.sun:auto-snapshot-desc property to EVENT.
+      --fast         Use a faster zfs list invocation.
   -n, --dry-run      Print actions without actually doing anything.
   -s, --skip-scrub   Do not snapshot filesystems in scrubbing pools.
   -h, --help         Print this usage message.
@@ -67,6 +72,7 @@ print_usage ()
   -g, --syslog       Write messages into the system log.
   -r, --recursive    Snapshot named filesystem and all descendants.
   -v, --verbose      Print info messages.
+      --destroy-only Only destroy older snapshots, do not create new ones.
       name           Filesystem and volume names, or '//' for all ZFS datasets.
 " 
 }
@@ -146,6 +152,7 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
 	local GLOB="$4"
 	local TARGETS="$5"
 	local KEEP=''
+	local RUNSNAP=1
 
 	# global DESTRUCTION_COUNT
 	# global SNAPSHOT_COUNT
@@ -154,13 +161,21 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
 
 	for ii in $TARGETS
 	do
-		if do_run "zfs snapshot $PROPS $FLAGS '$ii@$NAME'" 
+		if [ -n "$opt_do_snapshots" ]
 		then
+			if [ "$opt_pre_snapshot" != "" ]
+			then
+				do_run "$opt_pre_snapshot $ii $NAME" || RUNSNAP=0
+			fi
+			if [ $RUNSNAP -eq 1 ] && do_run "zfs snapshot $PROPS $FLAGS '$ii@$NAME'"
+			then
+				[ "$opt_post_snapshot" != "" ] && do_run "$opt_post_snapshot $ii $NAME"
 				SNAPSHOT_COUNT=$(( $SNAPSHOT_COUNT + 1 ))
 			else
 				WARNING_COUNT=$(( $WARNING_COUNT + 1 ))
 				continue
 			fi 
+		fi
 
 		# Retain at most $opt_keep number of old snapshots of this filesystem,
 		# including the one that was just recently created.
@@ -193,9 +208,10 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
 # {
 
 GETOPT=$(getopt \
-  --longoptions=default-exclude,dry-run,skip-scrub,recursive \
+  --longoptions=default-exclude,dry-run,fast,skip-scrub,recursive \
   --longoptions=event:,keep:,label:,prefix:,sep: \
   --longoptions=debug,help,quiet,syslog,verbose \
+  --longoptions=pre-snapshot:,post-snapshot:,destroy-only \
   --options=dnshe:l:k:p:rs:qgv \
   -- "$@" ) \
   || exit 128
@@ -226,6 +242,10 @@ do
 			fi
 			shift 2
 			;;
+		(--fast)
+			opt_fast_zfs_list='1'
+			shift 1
+			;;
 		(-n|--dry-run)
 			opt_dry_run='1'
 			shift 1
@@ -302,6 +322,18 @@ do
 			opt_verbose='1'
 			shift 1
 			;;
+		(--pre-snapshot)
+			opt_pre_snapshot="$2"
+			shift 2
+			;;
+		(--post-snapshot)
+			opt_post_snapshot="$2"
+			shift 2
+			;;
+		(--destroy-only)
+			opt_do_snapshots=''
+			shift 1
+			;;
 		(--)
 			shift 1
 			break
@@ -339,9 +371,14 @@ ZFS_LIST=$(env LC_ALL=C zfs list -H -t filesystem,volume -s name \
   -o name,com.sun:auto-snapshot,com.sun:auto-snapshot:"$opt_label") \
   || { print_log error "zfs list $?: $ZFS_LIST"; exit 136; }
 
+if [ -n "$opt_fast_zfs_list" ]
+then
+	SNAPSHOTS_OLD=$(env LC_ALL=C zfs list -H -t snapshot -o name -s name|grep $opt_prefix |awk '{ print substr( $0, length($0) - 14, length($0) ) " " $0}' |sort -r -k1,1 -k2,2|awk '{ print substr( $0, 17, length($0) )}') \
+	  || { print_log error "zfs list $?: $SNAPSHOTS_OLD"; exit 137; }
+else
 	SNAPSHOTS_OLD=$(env LC_ALL=C zfs list -H -t snapshot -S creation -o name) \
 	  || { print_log error "zfs list $?: $SNAPSHOTS_OLD"; exit 137; }
-
+fi
 
 # Verify that each argument is a filesystem or volume.
 for ii in "$@"
@@ -493,20 +530,37 @@ SNAPPROP="-o com.sun:auto-snapshot-desc='$opt_event'"
 
 # ISO style date; fifteen characters: YYYY-MM-DD-HHMM
 # On Solaris %H%M expands to 12h34.
-DATE=$(date +%F-%H%M)
+DATE=$(date --utc +%F-%H%M)
 
 # The snapshot name after the @ symbol.
-SNAPNAME="$opt_prefix${opt_label:+$opt_sep$opt_label-$DATE}"
+SNAPNAME="$opt_prefix${opt_label:+$opt_sep$opt_label}-$DATE"
 
 # The expression for matching old snapshots.  -YYYY-MM-DD-HHMM
 SNAPGLOB="$opt_prefix${opt_label:+?$opt_label}????????????????"
 
+if [ -n "$opt_do_snapshots" ]
+then
 	test -n "$TARGETS_REGULAR" \
 	  && print_log info "Doing regular snapshots of $TARGETS_REGULAR"
 
 	test -n "$TARGETS_RECURSIVE" \
 	  && print_log info "Doing recursive snapshots of $TARGETS_RECURSIVE"
 
+	if test -n "$opt_keep" && [ "$opt_keep" -ge "1" ]
+	then
+		print_log info "Destroying all but the newest $opt_keep snapshots of each dataset."
+	fi
+elif test -n "$opt_keep" && [ "$opt_keep" -ge "1" ]
+then
+	test -n "$TARGETS_REGULAR" \
+	  && print_log info "Destroying all but the newest $opt_keep snapshots of $TARGETS_REGULAR"
+
+	test -n "$TARGETS_RECURSIVE" \
+	  && print_log info "Recursively destroying all but the newest $opt_keep snapshots of $TARGETS_RECURSIVE"
+else
+	print_log notice "Only destroying snapshots, but count of snapshots to preserve not given. Nothing to do."
+fi
+
 test -n "$opt_dry_run" \
   && print_log info "Doing a dry run. Not running these commands..."