Merge pull request #109 from mergwyn/master

Correct incorrect sh syntax

CHANGELOG

@@ -0,0 +1,9 @@
+[ 1.2.5 (Unreleased) ]
+
+ * Start a changelog
+ * Accept PR#94 from aimileus/macos
+   - Replace --utc longform option with -u for macos compatibility
+ * Accept PR#107 from ArakniD/master
+   - Add optional label for snap removals
+
+ -- Jonathan Carter 2019-09-25, 15:24 SAST

Makefile

@@ -1,17 +1,28 @@
+PREFIX := /usr/local
+
 all:
 
 install:
-	install -d $(DESTDIR)$(PREFIX)/etc/cron.d
-	install -d $(DESTDIR)$(PREFIX)/etc/cron.daily
-	install -d $(DESTDIR)$(PREFIX)/etc/cron.hourly
-	install -d $(DESTDIR)$(PREFIX)/etc/cron.weekly
-	install -d $(DESTDIR)$(PREFIX)/etc/cron.monthly
-	install etc/zfs-auto-snapshot.cron.frequent $(DESTDIR)$(PREFIX)/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.daily    $(DESTDIR)$(PREFIX)/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.monthly  $(DESTDIR)$(PREFIX)/etc/cron.monthly/zfs-auto-snapshot
+	install -d $(DESTDIR)/etc/cron.d
+	install -d $(DESTDIR)/etc/cron.daily
+	install -d $(DESTDIR)/etc/cron.hourly
+	install -d $(DESTDIR)/etc/cron.weekly
+	install -d $(DESTDIR)/etc/cron.monthly
+	install -m 0644 etc/zfs-auto-snapshot.cron.frequent $(DESTDIR)/etc/cron.d/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)/etc/cron.daily/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)/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 -m 0644 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
+
+uninstall:
+	rm $(DESTDIR)/etc/cron.d/zfs-auto-snapshot
+	rm $(DESTDIR)/etc/cron.hourly/zfs-auto-snapshot
+	rm $(DESTDIR)/etc/cron.daily/zfs-auto-snapshot
+	rm $(DESTDIR)/etc/cron.weekly/zfs-auto-snapshot
+	rm $(DESTDIR)/etc/cron.monthly/zfs-auto-snapshot
+	rm $(DESTDIR)$(PREFIX)/share/man/man8/zfs-auto-snapshot.8
+	rm $(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/upstream/1.2.4.tar.gz
+tar -xzf 1.2.4.tar.gz
+cd zfs-auto-snapshot-upstream-1.2.4
+make install

etc/zfs-auto-snapshot.cron.daily

@@ -1,2 +1,6 @@
 #!/bin/sh
+
+# Only call zfs-auto-snapshot if it's available
+which zfs-auto-snapshot > /dev/null || exit 0
+
 exec zfs-auto-snapshot --quiet --syslog --label=daily --keep=31 //

etc/zfs-auto-snapshot.cron.frequent

@@ -1,3 +1,3 @@
-PATH="/usr/bin:/bin:/usr/sbin:/sbin"
+PATH="/usr/bin:/bin:/usr/local/sbin:/usr/sbin:/sbin"
 
-*/15 * * * * root zfs-auto-snapshot -q -g --label=frequent --keep=4  //
+*/15 * * * * root which zfs-auto-snapshot > /dev/null || exit 0 ; zfs-auto-snapshot --quiet --syslog --label=frequent --keep=4 //

etc/zfs-auto-snapshot.cron.hourly

@@ -1,2 +1,6 @@
 #!/bin/sh
+
+# Only call zfs-auto-snapshot if it's available
+which zfs-auto-snapshot > /dev/null || exit 0
+
 exec zfs-auto-snapshot --quiet --syslog --label=hourly --keep=24 //

etc/zfs-auto-snapshot.cron.monthly

@@ -1,2 +1,6 @@
 #!/bin/sh
+
+# Only call zfs-auto-snapshot if it's available
+which zfs-auto-snapshot > /dev/null || exit 0
+
 exec zfs-auto-snapshot --quiet --syslog --label=monthly --keep=12 //

etc/zfs-auto-snapshot.cron.weekly

@@ -1,2 +1,6 @@
 #!/bin/sh
+
+# Only call zfs-auto-snapshot if it's available
+which zfs-auto-snapshot > /dev/null || exit 0
+
 exec zfs-auto-snapshot --quiet --syslog --label=weekly --keep=8 //

src/zfs-auto-snapshot.8

@@ -64,6 +64,27 @@ Snapshot named filesystem and all descendants.
 \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 construction 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

src/zfs-auto-snapshot.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/bin/sh
 
 # zfs-auto-snapshot for Linux
 # Automatically create, rotate, and destroy periodic ZFS snapshots.
@@ -42,6 +42,7 @@ opt_verbose=''
 opt_pre_snapshot=''
 opt_post_snapshot=''
 opt_do_snapshots=1
+opt_min_size=0
 
 # Global summary statistics.
 DESTRUCTION_COUNT='0'
@@ -110,7 +111,7 @@ print_log () # level, message, ...
 			;;
 		(inf*)
 			# test -n "$opt_syslog" && logger -t "$opt_prefix" -p daemon.info $*
-			test -z ${opt_quiet+x} && test -n "$opt_verbose" && echo $*
+			test -z "$opt_quiet" && test -n "$opt_verbose" && echo $*
 			;;
 		(deb*)
 			# test -n "$opt_syslog" && logger -t "$opt_prefix" -p daemon.debug $*
@@ -152,7 +153,6 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
 	local GLOB="$4"
 	local TARGETS="$5"
 	local KEEP=''
-	local LABEL="$6"
 	local RUNSNAP=1
 
 	# global DESTRUCTION_COUNT
@@ -162,7 +162,23 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
 
 	for ii in $TARGETS
 	do
-		if [ -n "$opt_do_snapshots" ]
+                # Check if size check is > 0
+                size_check_skip=0
+                if [ "$opt_min_size" -gt 0 ]
+                then
+                        bytes_written=`zfs get -Hp -o value written $ii`
+                        kb_written=$(( $bytes_written / 1024 ))
+                        if [ "$kb_written" -lt "$opt_min_size" ]
+                        then
+                                size_check_skip=1
+                                if [ $opt_verbose -gt 0 ]
+                                then
+                                        echo "Skipping target $ii, only $kb_written kB written since last snap. opt_min_size is $opt_min_size"
+                                fi
+                        fi
+                fi
+
+                if [ -n "$opt_do_snapshots" -a "$size_check_skip" -eq 0 ]
 		then
 			if [ "$opt_pre_snapshot" != "" ]
 			then
@@ -184,19 +200,15 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
 		KEEP="$opt_keep"
 
 		# ASSERT: The old snapshot list is sorted by increasing age.
-		# Match on both $GLOB *and* label.
-		while IFS='	' read -ra arrjj
+		for jj in $SNAPSHOTS_OLD
 		do
 			# Check whether this is an old snapshot of the filesystem.
-			if [ -z "${arrjj[1]#$ii@$GLOB}" ]
+			if [ -z "${jj#$ii@$GLOB}" ]
 			then
-				# Check whether the snapshot has the same label property
-				test "${arrjj[0]}" = "$LABEL" || continue
-			
 				KEEP=$(( $KEEP - 1 ))
 				if [ "$KEEP" -le '0' ]
 				then
-					if do_run "zfs destroy -d $FLAGS '${arrjj[1]}'" 
+					if do_run "zfs destroy -d $FLAGS '$jj'"
 					then
 						DESTRUCTION_COUNT=$(( $DESTRUCTION_COUNT + 1 ))
 					else
@@ -204,7 +216,7 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
 					fi
 				fi
 			fi
-		done <<< "$SNAPSHOTS_OLD"
+		done
 	done
 }
 
@@ -212,12 +224,19 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
 # main ()
 # {
 
-GETOPT=$(getopt \
+if [ "$(uname)" = "Darwin" ]; then
+  GETOPT_BIN="$(brew --prefix gnu-getopt 2> /dev/null || echo /usr/local)/bin/getopt"
+else
+  GETOPT_BIN="getopt"
+fi
+
+GETOPT=$($GETOPT_BIN \
   --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 \
+  --longoptions=min-size: \
+  --options=dnshe:l:k:p:rs:qgvm: \
   -- "$@" ) \
   || exit 128
 
@@ -276,6 +295,10 @@ do
 			opt_label="$2"
 			shift 2
 			;;
+		(-m|--min-size)
+			opt_min_size="$2"
+			shift 2
+			;;
 		(-p|--prefix)
 			opt_prefix="$2"
 			while test "${#opt_prefix}" -gt '0'
@@ -379,14 +402,26 @@ ZFS_LIST=$(env LC_ALL=C zfs list -H -t filesystem,volume -s name \
 
 if [ -n "$opt_fast_zfs_list" ]
 then
- 	SNAPSHOTS_OLD=$(env LC_ALL=C zfs list -H -t snapshot -o com.sun:auto-snapshot-label,name -s name | \
-		grep $opt_prefix | \
+	# Check if a snapshot label is being used, in which case restrict the old
+	# snapshot removal to only snapshots with the same label format
+	if [ -n "$opt_label" ]
+	then
+		SNAPSHOTS_OLD=$(env LC_ALL=C zfs list -H -t snapshot -o name -s name | \
+			grep "$opt_prefix"_"$opt_label" | \
 			awk '{ print substr( $0, length($0) - 14, length($0) ) " " $0}' | \
-		sort -r -k1,1 -k3,2 | \
+			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 -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; }
+	fi
 else
-        SNAPSHOTS_OLD=$(env LC_ALL=C zfs list -H -t snapshot -S creation -o com.sun:auto-snapshot-label,name) \
+        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
 
@@ -447,11 +482,19 @@ do
 	iii="$ii/"
 
 
-    # Exclude datasets that are not named on the command line.
+	# Exclude datasets
+	# * that are not named on the command line or
+	# * those whose prefix is not on the command line (if --recursive flag is set)
 	IN_ARGS='0'
 	for jj in "$@"
 	do
+		# Ibid regarding iii.
+		jjj="$jj/"
+
 		if [ "$jj" = '//' -o "$jj" = "$ii" ]
+		then
+			IN_ARGS=$(( $IN_ARGS + 1 ))
+		elif [ -n "$opt_recursive" -a "$iii" != "${iii#$jjj}" ]
 		then
 			IN_ARGS=$(( $IN_ARGS + 1 ))
 		fi
@@ -537,17 +580,18 @@ done
 
 # Linux lacks SMF and the notion of an FMRI event, but always set this property
 # because the SUNW program does. The dash character is the default.
-SNAPPROP="-o com.sun:auto-snapshot-desc='$opt_event' -o com.sun:auto-snapshot-label=$opt_label"
+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 --utc +%F-%H%M)
+# We use the shortfirm -u here because --utc is not supported on macos.
+DATE=$(date -u +%F-%H%M)
 
 # The snapshot name after the @ symbol.
-SNAPNAME="$opt_prefix$opt_sep$DATE"
+SNAPNAME="${opt_prefix:+$opt_prefix$opt_sep}${opt_label:+$opt_label}-$DATE"
 
 # The expression for matching old snapshots.  -YYYY-MM-DD-HHMM
-SNAPGLOB="${opt_prefix}????????????????"
+SNAPGLOB="${opt_prefix:+$opt_prefix$opt_sep}${opt_label:+$opt_label}-???????????????"
 
 if [ -n "$opt_do_snapshots" ]
 then
@@ -575,8 +619,8 @@ fi
 test -n "$opt_dry_run" \
   && print_log info "Doing a dry run. Not running these commands..."
 
-do_snapshots "$SNAPPROP" ""   "$SNAPNAME" "$SNAPGLOB" "$TARGETS_REGULAR" "$opt_label"
-do_snapshots "$SNAPPROP" "-r" "$SNAPNAME" "$SNAPGLOB" "$TARGETS_RECURSIVE" "$opt_label"
+do_snapshots "$SNAPPROP" ""   "$SNAPNAME" "$SNAPGLOB" "$TARGETS_REGULAR"
+do_snapshots "$SNAPPROP" "-r" "$SNAPNAME" "$SNAPGLOB" "$TARGETS_RECURSIVE"
 
 print_log notice "@$SNAPNAME," \
   "$SNAPSHOT_COUNT created," \