installerfw-sh-functions

   1 # Copyright 2013 Intel Corporation
   2 # Author: Artem Bityutskiy
   3 # License: GPLv2
   4
   5 # This file contains common functions for setup-ivi-* programs
   6
   7 # Own name
   8 __PROG="${PROG:-installerfw-sh-functions}"
   9
  10 # Installer framework variables are saved in this file
  11 __installerfw_file="/etc/installerfw-environment"
  12 # The OS release information file
  13 __osrelease_file="/etc/os-release"
  14 # EFI System Partition PARTUUID
  15 __esp_ptypeid="C12A7328-F81F-11D2-BA4B-00A0C93EC93B"
  16
  17 __fatal()
  18 {
  19         IFS= printf "%s\n" "$__PROG: error: $*" 1>&2
  20         exit 1
  21 }
  22
  23 __verbose()
  24 {
  25         if [ -n "$verbose" ]; then
  26                 IFS= printf "%s\n" "$__PROG (verbose): $*" >&2
  27         fi
  28 }
  29
  30 # Verify that an environment variable is defined
  31 installerfw_verify_defined()
  32 {
  33         local variable="$1"
  34
  35         printenv "$variable" > /dev/null ||
  36                 __fatal "cannot find required environment variable" \
  37                         "\"$variable\""
  38 }
  39
  40 # Add the INSTALLERFW_MOUNT_PREFIX prefix to a path. This does not really
  41 # require a separate function unless we want to be fancy and avoid double or
  42 # tripple "/" in the resulting path.
  43 installerfw_mnt_prefix()
  44 {
  45         local path="${INSTALLERFW_MOUNT_PREFIX:-}/$1"
  46
  47         printf "%s" "$path" | LC_ALL=C sed -e 's/\/\+/\//g'
  48 }
  49
  50 # Return full path to the file which contains the installer framework
  51 # environment variables.
  52 installerfw_get_env_file_name()
  53 {
  54         printf "%s" "$(installerfw_mnt_prefix "$__installerfw_file")"
  55 }
  56
  57 # Save installer framework environment variables. Note, all the variables can
  58 # be split on 2 classes - those which make sense only inside the particular
  59 # installer and those which make sense in the OS environment. We only save the
  60 # latter.
  61 installerfw_save_env()
  62 {
  63         local file="$(installerfw_get_env_file_name)"
  64         local opts="\
  65 -e '^INSTALLERFW_KERNEL_OPTS=' \
  66 -e '^INSTALLERFW_PART[[:digit:]]\+_ALIGN=' \
  67 -e '^INSTALLERFW_PART[[:digit:]]\+_BOOTFLAG=' \
  68 -e '^INSTALLERFW_PART[[:digit:]]\+_FSOPTS=' \
  69 -e '^INSTALLERFW_PART[[:digit:]]\+_FSTYPE=' \
  70 -e '^INSTALLERFW_PART[[:digit:]]\+_LABEL=' \
  71 -e '^INSTALLERFW_PART[[:digit:]]\+_MOUNTPOINT=' \
  72 -e '^INSTALLERFW_PART[[:digit:]]\+_PARTUUID=' \
  73 -e '^INSTALLERFW_PART[[:digit:]]\+_SIZE=' \
  74 -e '^INSTALLERFW_PART[[:digit:]]\+_TYPE_ID=' \
  75 -e '^INSTALLERFW_PART[[:digit:]]\+_UUID=' \
  76 -e '^INSTALLERFW_PART_COUNT=' \
  77 -e '^INSTALLERFW_PTABLE_FORMAT=' \
  78 "
  79
  80         local variables="$(printenv | eval "LC_ALL=C grep $opts")"
  81
  82         if [ "$(printf "%s" "$variables" | wc -l)" -eq "0" ]; then
  83                 __fatal "no installer framework environment variables" \
  84                         "found, nothing to save"
  85         fi
  86
  87         printf "%s" "$variables" | LC_ALL=C sed -n -e \
  88                 "s/\(^INSTALLERFW_[^=]\+\)=\(.*\)/\1=\"\2\"/p" > "$file"
  89         __verbose "installerfw_save_env(): saved installer framework" \
  90                   "environment in \"$file\""
  91 }
  92
  93 # Restore installer framework environment variables.
  94 installerfw_restore_env()
  95 {
  96         local file="$(installerfw_get_env_file_name)"
  97
  98         [ -f "$file" ] || \
  99                 __fatal "installerfw_restore_env(): can't restore the" \
 100                         "installer framework environment: can't find" \
 101                         "\"$file\""
 102
 103         while IFS= read -r line; do
 104                 eval "export $line"
 105         done < "$file"
 106
 107         __verbose "installerfw_restore_env(): restored installer" \
 108                   "framework environment from \"$file\""
 109 }
 110
 111 # Check whether installer framework variables are defined
 112 installerfw_available()
 113 {
 114         if printenv | LC_ALL=C grep -q "^INSTALLERFW_[^[:blank:]]\+"; then
 115                 return 0;
 116         else
 117                 return 1;
 118         fi
 119 }
 120
 121 # Check if the system is an EFI boot system by checking whether the boot
 122 # partition is a FAT 32 partition with the magic EFI type GUID.
 123 installerfw_is_efi_boot_system()
 124 {
 125         installerfw_get_part_info "/boot" "TYPE_ID" "__ptypeid"
 126
 127         # Make sure the UUID uses capital letters
 128         __ptypeid="$(printf "%s" "$__ptypeid" | tr "[:lower:]" "[:upper:]")"
 129
 130         installerfw_verify_defined "INSTALLERFW_PTABLE_FORMAT"
 131
 132         if [ "${INSTALLERFW_PTABLE_FORMAT:-}" = "gpt" ] && \
 133            [ "$__ptypeid" = "$__esp_ptypeid" ]; then
 134                 __verbose "installerfw_is_efi_boot_system(): /boot is" \
 135                           "the EFI system partition"
 136                 return 0
 137         else
 138                 __verbose "installerfw_is_efi_boot_system(): no EFI" \
 139                           "system partition found"
 140                 return 1
 141         fi
 142 }
 143
 144 # Get a piece of installer framework data for a partition. At the moment the
 145 # partition is specified by it's mount point (in $1), but this can be extended
 146 # to also accept the partition number, if needed.
 147 #
 148 # The second parameter ($2) is the a partial installer framework variable name
 149 # which should be returned. For example, "PARTUUID" would correspond to
 150 # "INSTALLERFW_PARTx_PARTUUID", and so on.
 151 #
 152 # The third parameter ($3) is name of the variable to store the result at. If
 153 # the requested installer framework variable is undefined or null, the shell
 154 # variable with name stored in $3 will have null value upon exit.
 155 installerfw_get_part_info()
 156 {
 157         local __mntpoint="$1"; shift
 158         local __var="$1"; shift
 159         local __res_var="$1"; shift
 160         local __pnum="0"
 161
 162         installerfw_verify_defined "INSTALLERFW_PART_COUNT"
 163
 164         while [ "$__pnum" -lt "$INSTALLERFW_PART_COUNT" ]; do
 165                 local __mp="INSTALLERFW_PART${__pnum}_MOUNTPOINT"
 166                 installerfw_verify_defined "$__mp"
 167
 168                 __mp="$(eval printf "%s" "\"\$$__mp\"")"
 169
 170                 [ "$__mp" != "$__mntpoint" ] || break
 171
 172                 __pnum="$((__pnum+1))"
 173         done
 174
 175         local installerfw_var="INSTALLERFW_PART${__pnum}_${__var}"
 176
 177         local __value=
 178         if printenv "$installerfw_var" > /dev/null; then
 179                 __value="$(eval printf "%s" "\"\$$installerfw_var\"")"
 180         fi
 181
 182         __verbose "installerfw_get_part_info(): $__res_var=$__value"
 183         eval "$__res_var"="\"\$__value\""
 184 }