usr.sbin/bsdconfig/share/media/floppy.subr

   1 if [ ! "$_MEDIA_FLOPPY_SUBR" ]; then _MEDIA_FLOPPY_SUBR=1
   2 #
   3 # Copyright (c) 2012-2013 Devin Teske
   4 # All rights reserved.
   5 #
   6 # Redistribution and use in source and binary forms, with or without
   7 # modification, are permitted provided that the following conditions
   8 # are met:
   9 # 1. Redistributions of source code must retain the above copyright
  10 #    notice, this list of conditions and the following disclaimer.
  11 # 2. Redistributions in binary form must reproduce the above copyright
  12 #    notice, this list of conditions and the following disclaimer in the
  13 #    documentation and/or other materials provided with the distribution.
  14 #
  15 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 # SUCH DAMAGE.
  26 #
  27 # $FreeBSD$
  28 #
  29 ############################################################ INCLUDES
  30
  31 BSDCFG_SHARE="/usr/share/bsdconfig"
  32 . $BSDCFG_SHARE/common.subr || exit 1
  33 f_dprintf "%s: loading includes..." media/floppy.subr
  34 f_include $BSDCFG_SHARE/device.subr
  35 f_include $BSDCFG_SHARE/dialog.subr
  36 f_include $BSDCFG_SHARE/media/common.subr
  37 f_include $BSDCFG_SHARE/struct.subr
  38 f_include $BSDCFG_SHARE/variable.subr
  39
  40 BSDCFG_LIBE="/usr/libexec/bsdconfig"
  41 f_include_lang $BSDCFG_LIBE/include/messages.subr
  42
  43 ############################################################ GLOBALS
  44
  45 FLOPPY_MOUNTED=
  46 FLOPPY_DISTWANTED=
  47
  48 ############################################################ FUNCTIONS
  49
  50 # f_media_set_floppy
  51 #
  52 # Return success if we both found and set the media type to be a floppy.
  53 #
  54 f_media_set_floppy()
  55 {
  56         f_media_close
  57
  58         local devs ndevs
  59         f_device_find "" $DEVICE_TYPE_FLOPPY devs
  60         ndevs=$( set -- $devs; echo $# )
  61
  62         if [ ${ndevs:=0} -eq 0 ]; then
  63                 f_interactive && f_show_msg "$msg_no_floppy_devices_found"
  64                 return $FAILURE
  65         elif [ $ndevs -gt 1 ]; then
  66                 local title="$msg_choose_a_floppy_drive"
  67                 local prompt="$msg_please_select_a_floppy_drive"
  68                 local hline=""
  69
  70                 local dev retval
  71                 dev=$( f_device_menu \
  72                         "$title" "$prompt" "$hline" $DEVICE_TYPE_FLOPPY \
  73                         2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD )
  74                 retval=$?
  75                 [ "$dev" ] || return $FAILURE
  76
  77                 f_device_find "$dev" $DEVICE_TYPE_FLOPPY devs
  78                 [ "$devs" ] || return $FAILURE
  79                 dev="${devs%%[$IFS]*}"
  80
  81                 f_struct_copy device_$dev device_media
  82                 [ $retval -eq $SUCCESS ] || return $FAILURE
  83         else
  84                 f_struct_copy device_$devs device_media
  85         fi
  86
  87         f_struct device_media &&
  88                 device_media unset private
  89
  90         f_struct device_media || return $FAILURE
  91 }
  92
  93 # f_media_init_floppy $device
  94 #
  95 # Initializes the Floppy media device. Returns success if able to mount the
  96 # Floppy disk device using either mount_msdosfs(8) or mount(8) (tried in that
  97 # order).
  98 #
  99 f_media_init_floppy()
 100 {
 101         local dev="$1" devname err
 102
 103         device_$dev get devname devname || return $FAILURE
 104         f_dprintf "Init floppy called for %s distribution. devname=[%s]" \
 105                   "${FLOPPY_DISTWANTED:-some}" "$devname"
 106
 107         if [ "$FLOPPY_MOUNTED" ]; then
 108                 f_dprintf "Floppy device already mounted."
 109                 return $SUCCESS
 110         fi
 111
 112         local mp
 113         device_$dev get private mp
 114         if [ ! -e "${mp:=$MOUNTPOINT}" ] && ! f_quietly mkdir -p "$mp"; then
 115                 f_show_msg "$msg_unable_to_make_directory_mountpoint" \
 116                            "$mp" "$devname"
 117                 return $FAILURE
 118         fi
 119
 120         if f_interactive; then
 121                 local desc
 122                 device_$dev get desc desc
 123                 if [ "$FLOPPY_DISTWANTED" ]; then
 124                         f_show_msg "$msg_please_insert_floppy_in_drive" "$desc"
 125                 else
 126                         f_show_msg "$msg_please_insert_floppy_containing" \
 127                                    "$FLOPPY_DISTWANTED" "$desc"
 128                 fi
 129         fi
 130
 131         if ! {
 132             f_quietly mount_msdosfs -o ro -m 0777 -u 0 -g 0 "$devname" "$mp" ||
 133             err=$( mount -o ro "$devname" "$mp" 2>&1 )
 134         }; then
 135                 err="${err#mount: }"; err="${err#*: }"
 136                 local name
 137                 device_$dev get name name
 138                 f_show_msg "$msg_error_mounting_floppy_device" \
 139                            "$name" "$devname" "$mp" "$err"
 140                 return $FAILURE
 141         fi
 142         FLOPPY_MOUNTED=1
 143         FLOPPY_DISTWANTED=
 144         return $SUCCESS
 145 }
 146
 147 # f_media_get_floppy $device $file [$probe_type]
 148 #
 149 # Returns data from $file on a mounted Floppy disk device. Similar to cat(1).
 150 # If $probe_type is present and non-NULL, limits retries to zero and returns
 151 # success if $file exists. If $probe_type is equal to $PROBE_SIZE, prints the
 152 # size of $file in bytes to standard-out.
 153 #
 154 f_media_get_floppy()
 155 {
 156         local dev="$1" file="$2" probe_type="$3"
 157
 158         f_dprintf "f_media_get_floppy: dev=[%s] file=[%s] probe_type=%s" \
 159                   "$dev" "$file" "$probe_type"
 160
 161         #
 162         # floppies don't use f_media_generic_get() because it's too expensive
 163         # to speculatively open files on a floppy disk.  Make user get it
 164         # right or give up with floppies.
 165         #
 166         local mp
 167         device_$dev get private mp
 168         local fp="${mp:=$MOUNTPOINT}/$file"
 169         if ! [ -f "$fp" -a -r "$fp" ]; then
 170                 local nretries=4
 171                 [ "$probe_type" = "$PROBE_SIZE" ] && echo "-1"
 172                 [ "$probe_type" ] && return $FAILURE
 173                 while ! [ -f "$fp" -a -r "$fp" ]; do
 174                         if [ $nretries -eq 0 ]; then
 175                                 f_show_msg "$msg_failed_to_get_floppy_file" \
 176                                            "$fp"
 177                                 [ "$probe_type" = "$PROBE_SIZE" ] && echo "-1"
 178                                 return $FAILURE
 179                         fi
 180                         FLOPPY_DISTWANTED="$fp"
 181                         f_media_shutdown_floppy "$dev"
 182                         f_media_init_floppy "$dev" || return $FAILURE
 183                         nretries=$(( $nretries - 1 ))
 184                 done
 185         fi
 186         #
 187         # If we reach here, $file exists
 188         #
 189         if [ "$probe_type" = "$PROBE_SIZE" ]; then
 190                 local size
 191                 size=$( stat -f %z "$fp" 2>&1 ) || f_dprintf "stat: %s" "$size"
 192                 f_isinteger "$size" || size=-1
 193                 echo "$size"
 194         fi
 195         [ "$probe_type" ] && return $SUCCESS
 196         cat "$fp"
 197 }
 198
 199 # f_media_shutdown_floppy $device
 200 #
 201 # Shuts down the Floppy disk device using umount(8). Return status should be
 202 # ignored.
 203 #
 204 f_media_shutdown_floppy()
 205 {
 206         local dev="$1" err mp
 207
 208         [ "$FLOPPY_MOUNTED" ] || return $FAILURE
 209
 210         device_$dev get private mp
 211         if ! err=$( umount -f "${mp:=$MOUNTPOINT}" 2>&1 ); then
 212                 err="${err#umount: }"; err="${err#*:}"
 213                 f_dprintf "Umount of floppy on %s failed: %s" "$mp" "$err"
 214         else
 215                 FLOPPY_MOUNTED=
 216                 if f_interactive && [ "$_systemState" != "fixit" ]; then
 217                         local desc
 218                         device_$dev get desc desc
 219                         f_show_msg "$msg_you_may_remove_the_floppy" "$desc"
 220                 fi
 221         fi
 222 }
 223
 224 ############################################################ MAIN
 225
 226 f_dprintf "%s: Successfully loaded." media/floppy.subr
 227
 228 fi # ! $_MEDIA_FLOPPY_SUBR