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

   1 if [ ! "$_MEDIA_COMMON_SUBR" ]; then _MEDIA_COMMON_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/common.subr
  34 f_include $BSDCFG_SHARE/device.subr
  35 f_include $BSDCFG_SHARE/media/any.subr
  36 f_include $BSDCFG_SHARE/struct.subr
  37
  38 ############################################################ GLOBALS
  39
  40 #
  41 # Where to mount media
  42 #
  43 MOUNTPOINT=/dist
  44
  45 ############################################################ FUNCTIONS
  46
  47 # f_media_open
  48 #
  49 # Returms success if able to initialize the media device.
  50 #
  51 f_media_open()
  52 {
  53         f_dprintf "f_media_open: Verifying and initiliazing media device"
  54         { # Verify and initialize device media if-defined
  55                 f_struct device_media &&
  56                 f_media_verify &&
  57                 f_device_init media
  58         } || return $FAILURE
  59 }
  60
  61 # f_media_close
  62 #
  63 # Shuts down the media device, see f_device_shutdown() from device.subr for
  64 # more details.
  65 #
  66 f_media_close()
  67 {
  68         f_dprintf "f_media_close: Shutting down media device"
  69         f_struct device_media &&
  70                 f_device_shutdown media
  71         f_struct_free device_media
  72 }
  73
  74 # f_media_verify
  75 #
  76 # Returns success if the media device is available, and if not, prompts the
  77 # user to select a media type. See f_media_get_type() from media/any.subr for
  78 # more details.
  79 #
  80 f_media_verify()
  81 {
  82         f_dprintf "f_media_verify: Verifying media device"
  83         f_struct device_media || f_media_get_type
  84 }
  85
  86 # f_media_generic_get $base $file [$probe_only]
  87 #
  88 # A generic open which follows a well-known "path" of places to look. If
  89 # $probe_only is present and non-NULL, returns success if $file exists.
  90 #
  91 f_media_generic_get()
  92 {
  93         local base="$1" file="$2" probe_only="$3"
  94
  95         local fname=f_media_generic_get
  96         f_dprintf "%s: base=[%s] files=[%s] probe_only=%s" \
  97                   $fname "$base" "$file" "$probe_only"
  98
  99         local rel path
 100         f_getvar $VAR_RELNAME rel
 101         for path in \
 102                 "$base/$file" \
 103                 "$base/FreeBSD/$file" \
 104                 "$base/releases/$file" \
 105                 "$base/$rel/$file" \
 106         ; do
 107                 if [ -f "$path" -a -r "$path" ]; then
 108                         f_dprintf "%s: file exists path=[%s]" $fname "$path"
 109                         [ "$probe_only" ] && return $SUCCESS
 110                         cat "$path"
 111                         return
 112                 fi
 113         done
 114
 115         path="$base/releases/$rel/$file" # Final path to try
 116         if [ -f "$path" -a -r "$path" ]; then
 117                 f_dprintf "%s: file exists path=[%s]" $fname "$path"
 118                 [ "$probe_only" ] && return $SUCCESS
 119         elif [ "$probe_only" ]; then
 120                 return $FAILURE
 121         fi
 122         cat "$base/releases/$rel/$file" # Final path to try
 123 }
 124
 125 ############################################################ MAIN
 126
 127 f_dprintf "%s: Successfully loaded." media/common.subr
 128
 129 fi # ! $_MEDIA_COMMON_SUBR