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         f_count ndevs $devs
  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 -eq 1 ]; then
  66                 f_struct_copy $devs device_media
  67         else
  68                 local dev
  69                 local title="$msg_choose_a_floppy_drive"
  70                 local prompt="$msg_please_select_a_floppy_drive"
  71                 local hline=
  72
  73                 dev=$( f_device_menu \
  74                         "$title" "$prompt" "$hline" $DEVICE_TYPE_FLOPPY \
  75                         2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD ) ||
  76                         return $FAILURE
  77
  78                 f_struct_copy "$dev" device_media
  79         fi
  80
  81         f_struct device_media &&
  82                 device_media unset private
  83
  84         f_struct device_media || return $FAILURE
  85 }
  86
  87 # f_media_init_floppy $device
  88 #
  89 # Initializes the Floppy media device. Returns success if able to mount the
  90 # Floppy disk device using either mount_msdosfs(8) or mount(8) (tried in that
  91 # order).
  92 #
  93 f_media_init_floppy()
  94 {
  95         local funcname=f_media_init_floppy
  96         local dev="$1" devname err
  97
  98         $dev get devname devname || return $FAILURE
  99         f_dprintf "Init floppy called for %s distribution. devname=[%s]" \
 100                   "${FLOPPY_DISTWANTED:-some}" "$devname"
 101
 102         if [ "$FLOPPY_MOUNTED" ]; then
 103                 f_dprintf "Floppy device already mounted."
 104                 return $SUCCESS
 105         fi
 106
 107         local mp
 108         $dev get private mp
 109         if [ ! -e "${mp:=$MOUNTPOINT}" ] && ! f_quietly mkdir -p "$mp"; then
 110                 f_show_msg "$msg_unable_to_make_directory_mountpoint" \
 111                            "$mp" "$devname"
 112                 return $FAILURE
 113         fi
 114
 115         if f_interactive; then
 116                 local desc
 117                 $dev get desc desc
 118                 if [ "$FLOPPY_DISTWANTED" ]; then
 119                         f_show_msg "$msg_please_insert_floppy_in_drive" "$desc"
 120                 else
 121                         f_show_msg "$msg_please_insert_floppy_containing" \
 122                                    "$FLOPPY_DISTWANTED" "$desc"
 123                 fi
 124         fi
 125
 126         if ! {
 127             f_eval_catch -dk err $funcname mount_msdosfs \
 128                 'mount_msdosfs -o ro -m 0777 -u 0 -g 0 "%s" "%s"' \
 129                 "$devname" "$mp" ||
 130             f_eval_catch -dk err $funcname mount \
 131                 'mount -o ro "%s" "%s"' "$devname" "$mp"
 132         }; then
 133                 err="${err#mount: }"; err="${err#*: }"
 134                 local name
 135                 $dev get name name
 136                 f_show_msg "$msg_error_mounting_floppy_device" \
 137                            "$name" "$devname" "$mp" "$err"
 138                 return $FAILURE
 139         fi
 140         FLOPPY_MOUNTED=1
 141         FLOPPY_DISTWANTED=
 142         return $SUCCESS
 143 }
 144
 145 # f_media_get_floppy $device $file [$probe_type]
 146 #
 147 # Returns data from $file on a mounted Floppy disk device. Similar to cat(1).
 148 # If $probe_type is present and non-NULL, limits retries to zero and returns
 149 # success if $file exists. If $probe_type is equal to $PROBE_SIZE, prints the
 150 # size of $file in bytes to standard-out.
 151 #
 152 f_media_get_floppy()
 153 {
 154         local funcname=f_media_get_floppy
 155         local dev="$1" file="$2" probe_type="$3"
 156         local name
 157
 158         $dev get name name
 159         f_dprintf "f_media_get_floppy: dev=[%s] file=[%s] probe_type=%s" \
 160                   "$name" "$file" "$probe_type"
 161
 162         #
 163         # floppies don't use f_media_generic_get() because it's too expensive
 164         # to speculatively open files on a floppy disk.  Make user get it
 165         # right or give up with floppies.
 166         #
 167         local mp
 168         $dev get private mp
 169         local fp="${mp:=$MOUNTPOINT}/$file"
 170         if ! [ -f "$fp" -a -r "$fp" ]; then
 171                 local nretries=4
 172                 [ "$probe_type" = "$PROBE_SIZE" ] && echo "-1"
 173                 [ "$probe_type" ] && return $FAILURE
 174                 while ! [ -f "$fp" -a -r "$fp" ]; do
 175                         if [ $nretries -eq 0 ]; then
 176                                 f_show_msg "$msg_failed_to_get_floppy_file" \
 177                                            "$fp"
 178                                 [ "$probe_type" = "$PROBE_SIZE" ] && echo "-1"
 179                                 return $FAILURE
 180                         fi
 181                         FLOPPY_DISTWANTED="$fp"
 182                         f_media_shutdown_floppy "$dev"
 183                         f_media_init_floppy "$dev" || return $FAILURE
 184                         nretries=$(( $nretries - 1 ))
 185                 done
 186         fi
 187         #
 188         # If we reach here, $file exists
 189         #
 190         if [ "$probe_type" = "$PROBE_SIZE" ]; then
 191                 local size
 192                 f_eval_catch -dk size $funcname stat 'stat -f %%z "%s"' "$fp"
 193                 f_isinteger "$size" || size=-1
 194                 echo "$size"
 195         fi
 196         [ "$probe_type" ] && return $SUCCESS
 197         cat "$fp"
 198 }
 199
 200 # f_media_shutdown_floppy $device
 201 #
 202 # Shuts down the Floppy disk device using umount(8). Return status should be
 203 # ignored.
 204 #
 205 f_media_shutdown_floppy()
 206 {
 207         local funcname=f_media_shutdown_floppy
 208         local dev="$1" err mp
 209
 210         [ "$FLOPPY_MOUNTED" ] || return $FAILURE
 211
 212         $dev get private mp
 213         if f_eval_catch -d $funcname umount \
 214                 'umount -f "%s"' "${mp:=$MOUNTPOINT}"
 215         then
 216                 FLOPPY_MOUNTED=
 217                 if f_interactive && [ "$_systemState" != "fixit" ]; then
 218                         local desc
 219                         $dev get desc desc
 220                         f_show_msg "$msg_you_may_remove_the_floppy" "$desc"
 221                 fi
 222         fi
 223 }
 224
 225 ############################################################ MAIN
 226
 227 f_dprintf "%s: Successfully loaded." media/floppy.subr
 228
 229 fi # ! $_MEDIA_FLOPPY_SUBR