Use latest format config file.

user_tools/linux/recovery.sh

 #!/bin/sh
 #
 # Copyright (c) 2010 The Chromium OS Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 #
 # This attempts to guide linux users through the process of putting a recovery
 # image onto a removeable USB drive.
 #
 # We may not need root privileges if we have the right permissions.
@@ skipping 95 matching lines @@
 #   CHECK          = command to invoke to generate checksums on a file
 #   CHECKTYPE      = type of checksum generated
 #   DISKUTIL       = set if we have 'diskutil' (for Macs)
 #
 require_utils() {
   local external
   local errors
   local tool
   local tmp
 
-  external='cat cut dd grep ls mkdir mount readlink sed sync tr umount unzip wc'
+  external='cat cut dd grep ls mkdir mount readlink sed sync umount unzip wc'

[scottz, 2010/12/09 01:47:25]

md5sum openssl sha1sum

I assume you leave wget/curl out since you try both.

[Bill Richardson, 2010/12/09 17:34:29]

Yes, just below.

[scottz, 2010/12/09 18:04:27]

Ahh I missed that :) 

On 2010/12/09 17:34:29, Bill Richardson wrote:

   if [ -z "$WORKDIR" ]; then
     external="$external mktemp"
   fi
   errors=
 
   for tool in $external ; do
     if ! type "$tool" >/dev/null 2>&1 ; then
       warn "ERROR: need \"$tool\""
       errors=yes
     fi
@@ skipping 28 matching lines @@
   if [ -z "$CHECK" ] && tmp=$(type openssl 2>/dev/null) ; then
     CHECK="openssl"
     CHECKTYPE="md5"
   fi
   if [ -z "$CHECK" ]; then
     warn "ERROR: need \"md5sum\" or \"sha1sum\" or \"openssl\""
     errors=yes
   fi
 
   # FIXME: If we're on a Mac, we need this too. Is there a way to tell we're on
   # a Mac other than by having this executable?

[scottz, 2010/12/09 01:47:25]

uname == "Darwin" will tell you you are on a mac. 

[Bill Richardson, 2010/12/09 17:34:29]

Okay. I'm not sure it matters, though. If we've got diskutil, we should probably
just use it, right?

[scottz, 2010/12/09 18:04:27]

Sure we can assume that, I was just answering your fixme :) if you are fine with
how it works you might as well remove this comment. 

On 2010/12/09 17:34:29, Bill Richardson wrote:

   DISKUTIL=
   if type diskutil >/dev/null 2>&1; then
     DISKUTIL=diskutil
   fi
 
   if [ -n "$errors" ]; then
     ufatal "Some required utilities are missing."
   fi
 }
 
@@ skipping 48 matching lines @@
 compute_checksum() {
   local filename
 
   filename="$1"
 
   DEBUG "CHECK=($CHECK) CHECKTYPE=($CHECKTYPE)"
 
   if [ "$CHECK" = "openssl" ]; then
     openssl md5 < "$filename"
   else
-    $CHECK "$tarball" | cut -d' ' -f1
+    $CHECK "$zipfile" | cut -d' ' -f1
   fi
 }
 
 
 ##############################################################################
-# Helper functions to handle the config file and image tarball.
+# Helper functions to handle the config file and image zipfile.
 
 # Each paragraph in the config file should describe a new image. Let's make
 # sure it follows all the rules. This scans the config file and returns success
 # if it looks valid. As a side-effect, it lists the line numbers of the start
 # and end of each stanza in the global variables 'start_lines' and 'end_lines'
 # and saves the total number of images in the global variable 'num_images'.
 good_config() {
   local line
   local key
   local val
-  local display_name
+  local name
   local file
-  local size
+  local zipfilesize
+  local filesize
   local url
   local md5
   local sha1
   local skipping
   local errors
   local count
   local line_num
 
-  display_name=
+  name=
   file=
-  size=
+  zipfilesize=
+  filesize=
   url=
   md5=
   sha1=
   skipping=yes
   errors=
   count=0
   line_num=0
 
   # global
   start_lines=
@@ skipping 16 matching lines @@
         continue
       fi
 
       # right, looks good
       if [ -n "$skipping" ]; then
         skipping=
         start_lines="$start_lines $line_num"
       fi
 
       case $key in
-        display_name)
-          if [ -n "$display_name" ]; then
+        name)
+          if [ -n "$name" ]; then
             DEBUG "duplicate $key"
             errors=yes
           fi
-          display_name="$val"
+          name="$val"
           ;;
         file)
           if [ -n "$file" ]; then
             DEBUG "duplicate $key"
             errors=yes
           fi
           file="$val"
           ;;
-        size)
-          if [ -n "$size" ]; then
+        zipfilesize)
+          if [ -n "$zipfilesize" ]; then
             DEBUG "duplicate $key"
             errors=yes
           fi
-          size="$val"
+          zipfilesize="$val"
+          ;;
+        filesize)
+          if [ -n "$filesize" ]; then
+            DEBUG "duplicate $key"
+            errors=yes
+          fi
+          filesize="$val"
           ;;
         url)
           url="$val"
           ;;
         md5)
           md5="$val"
           ;;
         sha1)
           sha1="$val"
           ;;
       esac
     else
       # Between paragraphs. Time to check what we've found so far.
       end_lines="$end_lines $line_num"
       count=$(( count + 1))
 
-      if [ -z "$display_name" ]; then
-        DEBUG "image $count is missing display_name"
+      if [ -z "$name" ]; then
+        DEBUG "image $count is missing name"
         errors=yes
       fi
       if [ -z "$file" ]; then
         DEBUG "image $count is missing file"
         errors=yes
       fi
-      if [ -z "$size" ]; then
-        DEBUG "image $count is missing size"
+      if [ -z "$zipfilesize" ]; then
+        DEBUG "image $count is missing zipfilesize"
+        errors=yes
+      fi
+      if [ -z "$filesize" ]; then
+        DEBUG "image $count is missing filesize"
         errors=yes
       fi
       if [ -z "$url" ]; then
         DEBUG "image $count is missing url"
         errors=yes
       fi
       if [ "$CHECKTYPE" = "md5" ] && [ -z "$md5" ]; then
         DEBUG "image $count is missing required md5"
         errors=yes
       fi
       if [ "$CHECKTYPE" = "sha1" ] && [ -z "$sha1" ]; then
         DEBUG "image $count is missing required sha1"
         errors=yes
       fi
 
       # Prepare for next stanza
-      display_name=
+      name=
       file=
-      size=
+      zipfilesize=
+      filesize=
       url=
       md5=
       sha1=
       skipping=yes
     fi
   done < "$config"
 
   DEBUG "$count images found"
   num_images="$count"
 
@@ skipping 20 matching lines @@
       if [ "$num_images" -gt 1 ]; then
         echo "There are $num_images recovery images to choose from:"
       else
         echo "There is $num_images recovery image to choose from:"
       fi
       echo
       count=0
       echo "0 - <quit>"
       # NOTE: making assumptions about the order of lines in each stanza!
       while read line; do
-        if echo "$line" | grep -q '^display_name='; then
+        if echo "$line" | grep -q '^name='; then
           echo
           count=$(( count + 1 ))
-          echo "$line" | sed "s/display_name=/$count - /"
+          echo "$line" | sed "s/name=/$count - /"
         elif echo "$line" | grep -q '^channel='; then
           echo "$line" | sed 's/channel=/      channel:  /'
-        elif echo "$line" | grep -q '^hwid=[^*]'; then
+        elif echo "$line" | grep -q '^hwid='; then
           echo "$line" | sed 's/hwid=/      HWID:     /'
         fi
       done < "$config"
       echo
       show=
     fi
     prompt "Please select a recovery image to download: "
     read num
     if [ -z "$num" ] || [ "$num" = "?" ]; then
       show=yes
@@ skipping 18 matching lines @@
 # Fetch and verify the user's chosen image. On success, it sets the global
 # variable 'image_file' to indicate the local name of the unpacked binary that
 # should be written to the USB drive.
 fetch_image() {
   local start
   local end
   local line
   local key
   local val
   local file
-  local size
+  local zipfilesize
+  local filesize
   local url
   local md5
   local sha1
   local line_num
-  local tarball
+  local zipfile
   local err
   local sum
 
   file=
-  size=
+  zipfilesize=
+  filesize=
   url=
   md5=
   sha1=
   line_num="0"
 
   # Convert image number to line numbers within config file.
   start=$(echo $start_lines | cut -d' ' -f$1)
   end=$(echo $end_lines | cut -d' ' -f$1)
 
   while read line; do
@@ skipping 10 matching lines @@
       if [ -z "$key" ] || [ -z "$val" ] || [ "$key=$val" != "$line" ]; then
         DEBUG "ignoring $line"
         continue
       fi
 
       case $key in
         # The descriptive stuff we'll just save for later.
         file)
           file="$val"
           ;;
-        size)
-          size="$val"
+        zipfilesize)
+          zipfilesize="$val"
+          ;;
+        filesize)
+          filesize="$val"
           ;;
         md5)
           md5="$val"
           ;;
         sha1)
           sha1="$val"
           ;;
         url)
           # Try to download each url until one works.
           if [ -n "$url" ]; then
             # We've already got one (it's very nice).
             continue;
           fi
-          warn "Downloading image tarball from $val"
+          warn "Downloading image zipfile from $val"
           warn ""
-          tarball=${val##*/}
-          if fetch_url "$val" "$tarball" "resumeok"; then
+          zipfile=${val##*/}
+          if fetch_url "$val" "$zipfile" "resumeok"; then
             # Got it.
             url="$val"
           fi
           ;;
       esac
     fi
   done < "$config"
 
   if [ -z "$url" ]; then
-    DEBUG "couldn't fetch tarball"
+    DEBUG "couldn't fetch zipfile"
     return 1
   fi
 
-  # Verify the tarball
-  if ! ls -l "$tarball" | grep -q "$size"; then
-    DEBUG "size is wrong"
+  # Verify the zipfile
+  if ! ls -l "$zipfile" | grep -q "$zipfilesize"; then
+    DEBUG "zipfilesize is wrong"
     return 1
   fi
-  sum=$(compute_checksum "$tarball")
+  sum=$(compute_checksum "$zipfile")
   DEBUG "checksum is $sum"
   if [ "$CHECKTYPE" = "md5" ] && [ "$sum" != "$md5" ]; then
     DEBUG "wrong $CHECK"
     return 1
   elif [ "$CHECKTYPE" = "sha1" ] && [ "$sum" != "$sha1" ]; then
     DEBUG "wrong $CHECK"
     return 1
   fi
 
   # Unpack the file
-  warn "Unpacking the tarball"
+  warn "Unpacking the zipfile"
   rm -f "$file"
-  if ! unzip "$tarball" "$file"; then
-    DEBUG "Can't unpack the tarball"
+  if ! unzip "$zipfile" "$file"; then
+    DEBUG "Can't unpack the zipfile"
     return 1
   fi
 
+  if ! ls -l "$file" | grep -q "$filesize"; then
+    DEBUG "unpacked filesize is wrong"
+    return 1
+  fi
+
   # global
   image_file="$file"
 }
 
 ##############################################################################
 # Helper functions to manage USB drives.
 
 # Return a list of base device names ("sda sdb ...") for all USB drives
 get_devlist() {
   local dev
@@ skipping 155 matching lines @@
 
 cd "$WORKDIR"
 warn "Working in $WORKDIR/"
 rm -f "$debug"
 
 # Download the config file to see what choices we have.
 warn "Downloading config file from $CONFIGURL"
 fetch_url "$CONFIGURL" "$tmpfile" || \
   gfatal "Unable to download the config file"
 
-# Un-DOS-ify the config file and separate the version info from the images
-tr -d '\015' < "$tmpfile" | grep '^recovery_tool' > "$version"
-tr -d '\015' < "$tmpfile" | grep -v '^#' | grep -v '^recovery_tool' > "$config"
+# Separate the version info from the images
+grep '^recovery_tool' "$tmpfile" > "$version" 
+grep -v '^#' "$tmpfile" | grep -v '^recovery_tool' > "$config"
 # Add one empty line to the config file to terminate the last stanza
 echo >> "$config"

[scottz, 2010/12/09 01:47:25]

Is there a reason to not make this be part of the format I am generating?

[Bill Richardson, 2010/12/09 17:34:29]

No. The first example didn't have it, and here at Google we tend to frown on
blank lines at the end of files. This just makes my parsing simpler. I don't
know about the others.

 
 # Make sure that the config file version matches this script version.
 # FIXME: Prefer linux or use linux only? What about macs?
 tmp=$(grep '^recovery_tool_linux_version=' "$version") || \
   tmp=$(grep '^recovery_tool_version=' "$version") || \
   gfatal "The config file doesn't contain a version string."
 filevers=${tmp#*=}
 if [ "$filevers" != "$MYVERSION" ]; then
   tmp=$(grep '^recovery_tool_update=' "$version");
   msg=${tmp#*=}
@@ skipping 76 matching lines @@
 prompt "Shall I remove the temporary files now? [y/n] "
 read tmp
 case $tmp in
   [Yy]*)
     cd
     \rm -rf ${WORKDIR}
     ;;
 esac
 
 exit 0