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         f_count ndevs $devs
  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 -eq 1 ]; then
  67                 f_struct_copy $devs device_media
  68         else
  69                 local dev
  70                 local title="$msg_choose_a_cd_dvd_type"
  71                 local prompt="$msg_please_select_a_cd_dvd_drive"
  72                 local hline=
  73
  74                 dev=$( f_device_menu \
  75                         "$title" "$prompt" "$hline" $DEVICE_TYPE_CDROM \
  76                         2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD ) ||
  77                         return $FAILURE
  78
  79                 f_struct_copy "$dev" device_media
  80         fi
  81
  82         f_struct device_media || return $FAILURE
  83 }
  84
  85 # f_media_init_cdrom $device
  86 #
  87 # Initializes the CDROM media device. Returns success if able to mount the CD
  88 # device using mount_cd9660(8).
  89 #
  90 f_media_init_cdrom()
  91 {
  92         local funcname=f_media_init_cdrom
  93         local dev="$1" devname err
  94
  95         f_struct "$dev" get devname devname || return $FAILURE
  96         f_dprintf "Init routine called for CDROM device. devname=[%s]" \
  97                   "$devname"
  98
  99         if [ "$CDROM_MOUNTED" ]; then
 100                 f_dprintf "CDROM device already mounted."
 101                 return $SUCCESS
 102         fi
 103
 104         if [ ! -e "$MOUNTPOINT" ]; then
 105                 f_eval_catch $funcname mkdir 'mkdir -p "%s"' "$MOUNTPOINT" ||
 106                         return $FAILURE
 107         fi
 108
 109         if ! f_eval_catch -dk err $funcname mount_cd9660 \
 110                 'mount_cd9660 "%s" "%s"' "$devname" "$MOUNTPOINT"
 111         then
 112                 err="${err#mount_cd9660: }"; err="${err#$devname: }"
 113                 case "$err" in
 114                 "Device busy")
 115                         # Perhaps the CDROM drive is already mounted as /cdrom
 116                         if f_mounted /cdrom; then
 117                                 CDROM_PREVIOUSLY_MOUNTED=1
 118                                 MOUNTPOINT=/cdrom
 119                                 err=
 120                         fi
 121                         ;;
 122                 esac
 123                 case "$err" in
 124                 "") : good ;; # no error
 125                 *)
 126                         [ "$CDROM_INIT_QUIET" ] ||
 127                                 f_show_msg "$msg_error_mounting_device" \
 128                                            "$devname" "$MOUNTPOINT" "$err"
 129                         return $FAILURE
 130                 esac
 131         fi
 132         CDROM_MOUNTED=1
 133
 134         : xxx # /cdrom.inf has been deprecated since 9.0-R
 135
 136         # No other CDROM media validation at this time
 137
 138         return $SUCCESS
 139 }
 140
 141 # f_media_get_cdrom $device $file [$probe_type]
 142 #
 143 # Returns data from $file on a mounted CDROM device. Similar to cat(1). If
 144 # $probe_type is present and non-NULL, returns success if $file exists. If
 145 # $probe_type is equal to $PROBE_SIZE, prints the size of $file in bytes to
 146 # standard-out.
 147 #
 148 f_media_get_cdrom()
 149 {
 150         local dev="$1" file="$2" probe_type="$3"
 151         local name
 152
 153         $dev get name name
 154         f_dprintf "f_media_get_cdrom: dev=[%s] file=[%s] probe_type=%s" \
 155                   "$name" "$file" "$probe_type"
 156
 157         f_media_generic_get "$MOUNTPOINT" "$file" "$probe_type"
 158 }
 159
 160 # f_media_shutdown_cdrom $device
 161 #
 162 # Shuts down the CDROM device. Return status should be ignored.
 163 #
 164 f_media_shutdown_cdrom()
 165 {
 166         local funcname=f_media_shutdown_cdrom
 167         local dev="$1" err
 168
 169         [ "$CDROM_MOUNTED" ] || return $FAILURE
 170
 171         if [ "$CDROM_PREVIOUSLY_MOUNTED" ]; then
 172                 CDROM_MOUNTED=
 173                 return $SUCCESS
 174         fi
 175
 176         if ! f_eval_catch -dk err $funcname umount \
 177                 'umount -f "%s"' "$MOUNTPOINT"
 178         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
 187 # f_media_eject_cdrom $device
 188 #
 189 # Eject the media from the CDROM device. Returns success.
 190 #
 191 f_media_eject_cdrom()
 192 {
 193         local funcname=f_media_eject_cdrom
 194         local dev="$1" name devname err
 195
 196         f_struct "$dev" || return $SUCCESS
 197         $dev get name name || return $SUCCESS
 198         $dev get devname devname || return $SUCCESS
 199
 200         # Don't eject labels
 201         case "$name" in */*) return $SUCCESS; esac
 202
 203         f_dprintf "Ejecting CDROM/DVD at %s" "$devname"
 204         if ! f_eval_catch -dk err $funcname cdcontrol \
 205                 'cdcontrol -f "%s" eject' "$devname"
 206         then
 207                 f_dprintf "Could not eject the CDROM/DVD from %s: %s" \
 208                           "$devname" "${err#cdcontrol: }"
 209         fi
 210         return $SUCCESS
 211 }
 212
 213 ############################################################ MAIN
 214
 215 f_dprintf "%s: Successfully loaded." media/cdrom.subr
 216
 217 fi # ! $_MEDIA_CDROM_SUBR