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

   1 if [ ! "$_MEDIA_CDROM_SUBR" ]; then _MEDIA_CDROM_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/cdrom.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 CDROM_MOUNTED=
  46 CDROM_PREVIOUSLY_MOUNTED=
  47 CDROM_INIT_QUIET=
  48
  49 ############################################################ FUNCTIONS
  50
  51 # f_media_set_cdrom
  52 #
  53 # Return success if we both found and set the media type to be a CD.
  54 #
  55 f_media_set_cdrom()
  56 {
  57         f_media_close
  58
  59         local devs ndevs
  60         f_device_find "" $DEVICE_TYPE_CDROM devs
  61         ndevs=$( set -- $devs; echo $# )
  62
  63         if [ ${ndevs:=0} -eq 0 ]; then
  64                 f_interactive && f_show_msg "$msg_no_cd_dvd_devices_found"
  65                 return $FAILURE
  66         elif [ $ndevs -gt 1 ]; then
  67                 local title="$msg_choose_a_cd_dvd_type"
  68                 local prompt="$msg_please_select_a_cd_dvd_drive"
  69                 local hline=""
  70
  71                 local dev retval
  72                 dev=$( f_device_menu \
  73                         "$title" "$prompt" "$hline" $DEVICE_TYPE_CDROM \
  74                         2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD )
  75                 retval=$?
  76                 [ "$dev" ] || return $FAILURE
  77
  78                 f_device_find "$dev" $DEVICE_TYPE_CDROM devs
  79                 [ "$devs" ] || return $FAILURE
  80                 dev="${devs%%[$IFS]*}"
  81
  82                 f_struct_copy device_$dev device_media
  83                 [ $retval -eq $SUCCESS ] || return $FAILURE
  84         else
  85                 f_struct_copy device_$devs device_media
  86         fi
  87
  88         f_struct device_media || return $FAILURE
  89 }
  90
  91 # f_media_init_cdrom $device
  92 #
  93 # Initializes the CDROM media device. Returns success if able to mount the CD
  94 # device using mount_cd9660(8).
  95 #
  96 f_media_init_cdrom()
  97 {
  98         local dev="$1" devname err
  99
 100         device_$dev get devname devname || return $FAILURE
 101         f_dprintf "Init routine called for CDROM device. devname=[%s]" \
 102                   "$devname"
 103
 104         if [ "$CDROM_MOUNTED" ]; then
 105                 f_dprintf "CDROM device already mounted."
 106                 return $SUCCESS
 107         fi
 108
 109         if [ ! -e "$MOUNTPOINT" ] &&
 110            ! err=$( mkdir -p "$MOUNTPOINT" 2>&1 )
 111         then
 112                 f_dialog_msgbox "$err"
 113                 return $FAILURE
 114         fi
 115
 116         if ! err=$( mount_cd9660 "$devname" "$MOUNTPOINT" 2>&1 )
 117         then
 118                 err="${err#mount_cd9660: }"; err="${err#$devname: }"
 119                 case "$err" in
 120                 "Device busy")
 121                         # Perhaps the CDROM drive is already mounted as /cdrom
 122                         if f_mounted /cdrom; then
 123                                 CDROM_PREVIOUSLY_MOUNTED=1
 124                                 MOUNTPOINT=/cdrom
 125                                 err=
 126                         fi
 127                         ;;
 128                 esac
 129                 case "$err" in
 130                 "") : good ;; # no error
 131                 *)
 132                         [ "$CDROM_INIT_QUIET" ] ||
 133                                 f_show_msg "$msg_error_mounting_device" \
 134                                            "$devname" "$MOUNTPOINT" "$err"
 135                         return $FAILURE
 136                 esac
 137         fi
 138         CDROM_MOUNTED=1
 139
 140         : xxx # /cdrom.inf has been deprecated since 9.0-R
 141
 142         # No other CDROM media validation at this time
 143
 144         return $SUCCESS
 145 }
 146
 147 # f_media_get_cdrom $device $file [$probe_only]
 148 #
 149 # Returns data from $file on a mounted CDROM device. Similar to cat(1). If
 150 # $probe_only is present and non-NULL, returns success if $file exists.
 151 #
 152 f_media_get_cdrom()
 153 {
 154         local dev="$1" file="$2" probe_only="$3"
 155
 156         f_dprintf "f_media_get_cdrom: dev=[%s] file=[%s] probe_only=%s" \
 157                   "$dev" "$file" "$probe_only"
 158
 159         f_media_generic_get "$MOUNTPOINT" "$file" "$probe_only"
 160 }
 161
 162 # f_media_shutdown_cdrom $device
 163 #
 164 # Shuts down the CDROM device and ejects the media using f_media_eject_cdrom(),
 165 # below. Return status should be ignored.
 166 #
 167 f_media_shutdown_cdrom()
 168 {
 169         local dev="$1" err
 170
 171         [ "$CDROM_MOUNTED" ] || return
 172
 173         if [ "$CDROM_PREVIOUSLY_MOUNTED" ]; then
 174                 CDROM_MOUNTED=
 175                 return $SUCCESS
 176         fi
 177
 178         if ! err=$( umount -f "$MOUNTPOINT" 2>&1 ); then
 179                 err="${err#umount: }"; err="${err#*: }"
 180                 f_show_msg "$msg_could_not_unmount_the_cdrom_dvd" \
 181                            "$MOUNTPOINT" "$err"
 182         else
 183                 CDROM_MOUNTED=
 184         fi
 185
 186         f_media_eject_cdrom "$dev"
 187 }
 188
 189 # f_media_eject_cdrom $device
 190 #
 191 # Eject the media from the CDROM device. Returns success.
 192 #
 193 f_media_eject_cdrom()
 194 {
 195         local dev="$1" devname err
 196         device_$dev get name devname || return $SUCCESS
 197         case "$devname" in /dev/iso9660/*) return $SUCCESS; esac
 198         f_dprintf "Ejecting CDROM/DVD at %s" "$devname"
 199         if ! err=$( cdcontrol -f "$devname" eject 2>&1 ); then
 200                 f_dprintf "Could not eject the CDROM/DVD from %s: %s" \
 201                           "$devname" "${err#cdcontrol: }"
 202         fi
 203         return $SUCCESS
 204 }
 205
 206 ############################################################ MAIN
 207
 208 f_dprintf "%s: Successfully loaded." media/cdrom.subr
 209
 210 fi # ! $_MEDIA_CDROM_SUBR