PR on fork

2021-10-20 16:44:06 +01:00 · 2021-10-20 16:44:06 +01:00 · fef643342b
parent 870649bca9 9fd0d9a99b
commit fef643342b
2 changed files with 156 additions and 36 deletions
--- a/README.md
+++ b/README.md
@ -1,10 +1,12 @@

 # PiShrink #
+
 PiShrink is a bash script that automatically shrink a pi image that will then resize to the max size of the SD card on boot. This will make putting the image back onto the SD card faster and the shrunk images will compress better.
-In addition the shrinked image can be compressed with gzip and xz to create an even smaller image. Parallel compression of the image
+In addition the shrunk image can be compressed with gzip and xz to create an even smaller image. Parallel compression of the image
 using multiple cores is supported.

 ## Usage ##
+
 ```
 Usage: $0 [-adhrspvzZ] imagefile.img [newimagefile.img]

@ -20,7 +22,9 @@ Usage: $0 [-adhrspvzZ] imagefile.img [newimagefile.img]

 If you specify the `newimagefile.img` parameter, the script will make a copy of `imagefile.img` and work off that. You will need enough space to make a full copy of the image to use that option.

-* `-r` will attempt to repair the filesystem if regular repairs fail
+* `-s` prevents automatic filesystem expansion on the images next boot
+* `-v` enables more verbose output
+* `-r` will attempt to repair the filesystem using additional options if the normal repair fails
 * `-z` will compress the image after shrinking using gzip. `.gz` extension will be added to the filename.
 * `-Z` will compress the image after shrinking using xz. `.xz` extension will be added to the filename.
 * `-a` will use option -f9 for pigz and option -T0 for xz and compress in parallel.
@ -29,11 +33,16 @@ If you specify the `newimagefile.img` parameter, the script will make a copy of
 Default options for compressors can be overwritten by defining PISHRINK_GZIP or PSHRINK_XZ environment variables for gzip and xz.

 ## Prerequisites ##
-If you are trying to shrink a [NOOBS](https://github.com/raspberrypi/noobs) image it will likely fail. This is due to [NOOBS partitioning](https://github.com/raspberrypi/noobs/wiki/NOOBS-partitioning-explained) being significantly different than Raspbian's. Hopefully PiShrink will be able to support NOOBS in the near future.
+
+If you are running PiShrink in VirtualBox you will likely encounter an error if you
+attempt to use VirtualBox's "Shared Folder" feature. You can copy the image you wish to
+shrink on to the VM from a Shared Folder, but shrinking directctly from the Shared Folder
+is know to cause issues.

 If using Ubuntu, you will likely see an error about `e2fsck` being out of date and `metadata_csum`. The simplest fix for this is to use Ubuntu 16.10 and up, as it will save you a lot of hassle in the long run.

 ## Installation ##
+
 ```bash
 wget https://raw.githubusercontent.com/Drewsif/PiShrink/master/pishrink.sh
 chmod +x pishrink.sh
@ -41,6 +50,7 @@ sudo mv pishrink.sh /usr/local/bin
 ```

 ## Example ##
+
 ```bash
 [user@localhost PiShrink]$ sudo pishrink.sh pi.img
 e2fsck 1.42.9 (28-Dec-2013)
@ -65,6 +75,7 @@ Shrunk pi.img from 30G to 3.1G
 ```

 ## Contributing ##
+
 If you find a bug please create an issue for it. If you would like a new feature added, you can create an issue for it but I can't promise that I will get to it.

 Pull requests for new features and bug fixes are more than welcome!
--- a/pishrink.sh
+++ b/pishrink.sh
@ -17,7 +17,7 @@ function info() {
 }

 function error() {
-	echo -n "$SCRIPTNAME: ERROR occured in line $1: "
+	echo -n "$SCRIPTNAME: ERROR occurred in line $1: "
 	shift
 	echo "$@"
 }
@ -62,17 +62,103 @@ if [[ $repair == true ]]; then
 	(( $? < 4 )) && return
 fi
 	error $LINENO "Filesystem recoveries failed. Giving up..."
-	exit -9
+	exit 9

 }

+function set_autoexpand() {
+    #Make pi expand rootfs on next boot
+    mountdir=$(mktemp -d)
+    partprobe "$loopback"
+    mount "$loopback" "$mountdir"
+
+    if [ ! -d "$mountdir/etc" ]; then
+        info "/etc not found, autoexpand will not be enabled"
+        umount "$mountdir"
+        return
+    fi
+
+    if [[ -f "$mountdir/etc/rc.local" ]] && [[ "$(md5sum "$mountdir/etc/rc.local" | cut -d ' ' -f 1)" != "1c579c7d5b4292fd948399b6ece39009" ]]; then
+      echo "Creating new /etc/rc.local"
+    if [ -f "$mountdir/etc/rc.local" ]; then
+        mv "$mountdir/etc/rc.local" "$mountdir/etc/rc.local.bak"
+    fi
+
+    #####Do not touch the following lines#####
+cat <<\EOF1 > "$mountdir/etc/rc.local"
+#!/bin/bash
+do_expand_rootfs() {
+  ROOT_PART=$(mount | sed -n 's|^/dev/\(.*\) on / .*|\1|p')
+
+  PART_NUM=${ROOT_PART#mmcblk0p}
+  if [ "$PART_NUM" = "$ROOT_PART" ]; then
+    echo "$ROOT_PART is not an SD card. Don't know how to expand"
+    return 0
+  fi
+
+  # Get the starting offset of the root partition
+  PART_START=$(parted /dev/mmcblk0 -ms unit s p | grep "^${PART_NUM}" | cut -f 2 -d: | sed 's/[^0-9]//g')
+  [ "$PART_START" ] || return 1
+  # Return value will likely be error for fdisk as it fails to reload the
+  # partition table because the root fs is mounted
+  fdisk /dev/mmcblk0 <<EOF
+p
+d
+$PART_NUM
+n
+p
+$PART_NUM
+$PART_START
+
+p
+w
+EOF
+
+cat <<EOF > /etc/rc.local &&
+#!/bin/sh
+echo "Expanding /dev/$ROOT_PART"
+resize2fs /dev/$ROOT_PART
+rm -f /etc/rc.local; cp -f /etc/rc.local.bak /etc/rc.local; /etc/rc.local
+
+EOF
+reboot
+exit
+}
+raspi_config_expand() {
+/usr/bin/env raspi-config --expand-rootfs
+if [[ $? != 0 ]]; then
+  return -1
+else
+  rm -f /etc/rc.local; cp -f /etc/rc.local.bak /etc/rc.local; /etc/rc.local
+  reboot
+  exit
+fi
+}
+raspi_config_expand
+echo "WARNING: Using backup expand..."
+sleep 5
+do_expand_rootfs
+echo "ERROR: Expanding failed..."
+sleep 5
+if [[ -f /etc/rc.local.bak ]]; then
+  cp -f /etc/rc.local.bak /etc/rc.local
+  /etc/rc.local
+fi
+exit 0
+EOF1
+    #####End no touch zone#####
+    chmod +x "$mountdir/etc/rc.local"
+    fi
+    umount "$mountdir"
+}
+
 help() {
 	local help
 	read -r -d '' help << EOM
 Usage: $0 [-adhrspvzZ] imagefile.img [newimagefile.img]

  -s         Don't expand filesystem when image is booted the first time
-  -v			 Be verbose
+  -v         Be verbose
  -r         Use advanced filesystem repair option if the normal one fails
  -z         Compress image after shrinking with gzip
  -Z         Compress image after shrinking with xz
@ -81,7 +167,7 @@ Usage: $0 [-adhrspvzZ] imagefile.img [newimagefile.img]
  -d         Write debug messages in a debug log file
 EOM
 	echo "$help"
-	exit -1
+	exit 1
 }

 should_skip_autoexpand=false
@ -91,7 +177,6 @@ parallel=false
 verbose=false
 prep=false
 ziptool=""
-required_tools="$REQUIRED_TOOLS"

 while getopts ":adhprsvzZ" opt; do
  case "${opt}" in
@ -129,20 +214,28 @@ fi

 if [[ ! -f "$img" ]]; then
  error $LINENO "$img is not a file..."
-  exit -2
+  exit 2
 fi
 if (( EUID != 0 )); then
  error $LINENO "You need to be running as root."
-  exit -3
+  exit 3
 fi

+# set locale to POSIX(English) temporarily
+# these locale settings only affect the script and its sub processes
+
+export LANGUAGE=POSIX
+export LC_ALL=POSIX
+export LANG=POSIX
+
+
 # check selected compression tool is supported and installed
 if [[ -n $ziptool ]]; then
-	if [[ ! " ${ZIPTOOLS[@]} " =~ " $ziptool " ]]; then
+	if [[ ! " ${ZIPTOOLS[@]} " =~ $ziptool ]]; then
 		error $LINENO "$ziptool is an unsupported ziptool."
-		exit -17
+		exit 17
 	else
-		if [[ $parallel == true && ziptool == "gzip" ]]; then
+		if [[ $parallel == true && $ziptool == "gzip" ]]; then
 			REQUIRED_TOOLS="$REQUIRED_TOOLS pigz"
 		else
 			REQUIRED_TOOLS="$REQUIRED_TOOLS $ziptool"
@ -155,25 +248,29 @@ for command in $REQUIRED_TOOLS; do
  command -v $command >/dev/null 2>&1
  if (( $? != 0 )); then
    error $LINENO "$command is not installed."
-    exit -4
+    exit 4
  fi
 done

 #Copy to new file if requested
 if [ -n "$2" ]; then
-  info "Copying $1 to $2..."
-  cp --reflink=auto --sparse=always "$1" "$2"
+  f="$2"
+  if [[ -n $ziptool && "${f##*.}" == "${ZIPEXTENSIONS[$ziptool]}" ]]; then	# remove zip extension if zip requested because zip tool will complain about extension
+    f="${f%.*}"
+  fi
+  info "Copying $1 to $f..."
+  cp --reflink=auto --sparse=always "$1" "$f"
  if (( $? != 0 )); then
    error $LINENO "Could not copy file..."
-    exit -5
+    exit 5
  fi
  old_owner=$(stat -c %u:%g "$1")
-  chown "$old_owner" "$2"
-  img="$2"
+  chown "$old_owner" "$f"
+  img="$f"
 fi

 # cleanup at script exit
-trap cleanup ERR EXIT
+trap cleanup EXIT

 #Gather info
 info "Gathering data"
@ -183,16 +280,28 @@ rc=$?
 if (( $rc )); then
 	error $LINENO "parted failed with rc $rc"
 	info "Possibly invalid image. Run 'parted $img unit B print' manually to investigate"
-	exit -6
+	exit 6
 fi
 partnum="$(echo "$parted_output" | tail -n 1 | cut -d ':' -f 1)"
 partstart="$(echo "$parted_output" | tail -n 1 | cut -d ':' -f 2 | tr -d 'B')"
+if [ -z "$(parted -s "$img" unit B print | grep "$partstart" | grep logical)" ]; then
+    parttype="primary"
+else
+    parttype="logical"
+fi
 loopback="$(losetup -f --show -o "$partstart" "$img")"
 tune2fs_output="$(tune2fs -l "$loopback")"
+rc=$?
+if (( $rc )); then
+    echo "$tune2fs_output"
+    error $LINENO "tune2fs failed. Unable to shrink this type of image"
+    exit 7
+fi
+
 currentsize="$(echo "$tune2fs_output" | grep '^Block count:' | tr -d ' ' | cut -d ':' -f 2)"
 blocksize="$(echo "$tune2fs_output" | grep '^Block size:' | tr -d ' ' | cut -d ':' -f 2)"

-logVariables $LINENO beforesize parted_output partnum partstart tune2fs_output currentsize blocksize
+logVariables $LINENO beforesize parted_output partnum partstart parttype tune2fs_output currentsize blocksize

 #Check if we should make pi expand rootfs on next boot
 if [ "$should_skip_autoexpand" = false ]; then
@ -238,7 +347,7 @@ if [[ $prep == true ]]; then
  info "Syspreping: Removing logs, apt archives, dhcp leases and ssh hostkeys"
  mountdir=$(mktemp -d)
  mount "$loopback" "$mountdir"
-  rm -rf "$mountdir/var/cache/apt/archives/*" "$mountdir/var/lib/dhcpcd5/*" "$mountdir/var/log/*" "$mountdir/var/tmp/*" "$mountdir/tmp/*" "$mountdir/etc/ssh/*_host_*"
+  rm -rvf $mountdir/var/cache/apt/archives/* $mountdir/var/lib/dhcpcd5/* $mountdir/var/log/* $mountdir/var/tmp/* $mountdir/tmp/* $mountdir/etc/ssh/*_host_*
  umount "$mountdir"
 fi

@ -249,13 +358,13 @@ checkFilesystem
 if ! minsize=$(resize2fs -P "$loopback"); then
 	rc=$?
 	error $LINENO "resize2fs failed with rc $rc"
-	exit -10
+	exit 10
 fi
 minsize=$(cut -d ':' -f 2 <<< "$minsize" | tr -d ' ')
 logVariables $LINENO currentsize minsize
 if [[ $currentsize -eq $minsize ]]; then
  error $LINENO "Image already shrunk to smallest size"
-  exit -11
+  exit 11
 fi

 #Add some free space to the end of the filesystem
@ -279,7 +388,7 @@ if (( $rc )); then
  mv "$mountdir/etc/rc.local.bak" "$mountdir/etc/rc.local"
  umount "$mountdir"
  losetup -d "$loopback"
-  exit -12
+  exit 12
 fi
 sleep 1

@ -291,14 +400,14 @@ parted -s -a minimal "$img" rm "$partnum"
 rc=$?
 if (( $rc )); then
 	error $LINENO "parted failed with rc $rc"
-	exit -13
+	exit 13
 fi

-parted -s "$img" unit B mkpart primary "$partstart" "$newpartend"
+parted -s "$img" unit B mkpart "$parttype" "$partstart" "$newpartend"
 rc=$?
 if (( $rc )); then
 	error $LINENO "parted failed with rc $rc"
-	exit -14
+	exit 14
 fi

 #Truncate the file
@ -307,7 +416,7 @@ endresult=$(parted -ms "$img" unit B print free)
 rc=$?
 if (( $rc )); then
 	error $LINENO "parted failed with rc $rc"
-	exit -15
+	exit 15
 fi

 endresult=$(tail -1 <<< "$endresult" | cut -d ':' -f 2 | tr -d 'B')
@ -316,7 +425,7 @@ truncate -s "$endresult" "$img"
 rc=$?
 if (( $rc )); then
 	error $LINENO "trunate failed with rc $rc"
-	exit -16
+	exit 16
 fi

 # handle compression
@ -326,22 +435,22 @@ if [[ -n $ziptool ]]; then
 	[[ $parallel == true ]] && options="${ZIP_PARALLEL_OPTIONS[$ziptool]}"
 	[[ -v $envVarname ]] && options="${!envVarname}" # if environment variable defined use these options
 	[[ $verbose == true ]] && options="$options -v" # add verbose flag if requested
-	
+
 	if [[ $parallel == true ]]; then
 		parallel_tool="${ZIP_PARALLEL_TOOL[$ziptool]}"
 		info "Using $parallel_tool on the shrunk image"
 		if ! $parallel_tool ${options} "$img"; then
 			rc=$?
 			error $LINENO "$parallel_tool failed with rc $rc"
-			exit -18
+			exit 18
 		fi
-		
+
 	else # sequential
 		info "Using $ziptool on the shrunk image"
-		if ! $ziptool ${options} $img; then
+		if ! $ziptool ${options} "$img"; then
 			rc=$?
 			error $LINENO "$ziptool failed with rc $rc"
-			exit -19
+			exit 19
 		fi
 	fi
 	img=$img.${ZIPEXTENSIONS[$ziptool]}