#!/usr/local/bin/scripts/sh
#
#.Y / 70 83 / / / / 105 / / / /  / /               ;A4_QUER.Y
#.YT 3 2 0 0 3 3 1 / / /
#.H!a!0:linux/<scripts>/io/disk/mediaAccess/mediaHandlers.d/A8A2BB2D_78F0_11E6_B6F3_0000C00A45A9!0.!c
#
#/*******************************************************************************
#     io disk mediaAccess mediaHandlers.d/A8A2BB2D_78F0_11E6_B6F3_0000C00A45A9
#     ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
#
#     purpose             : media handler for a basically dm-linear media
#
#     begin               : Mon May 15 14:33:04 CEST 2017
#
#     changes             :
#
#     copyright           : (C) 2017 by Thomas Bruecker
#
#     email               : public@thomas-r-bruecker.ch
#
#     version             : -0.0.0
#
#*******************************************************************************/

#/***************************************************************************
# *                                                                         *
# *   This program is free software; you can redistribute it and/or modify  *
# *   it under the terms of the GNU General Public License as published by  *
# *   the Free Software Foundation; either version 2 of the License, or     *
# *   (at your option) any later version.                                   *
# *                                                                         *
# *   This program is distributed in the hope that it will be useful, but   *
# *   WITHOUT ANY WARRANTY; without even the implied warranty of            *
# *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      *
# *   General Public License for more details.                              *
# *                                                                         *
# *   You should have received a copy of the GNU General Public License     *
# *   along with this program; if not, write to the Free Software           *
# *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,            *
# *   MA 02110-1301 USA.                                                    *
# *                                                                         *
# ***************************************************************************/

# MyHash("A8A2BB2D_78F0_11E6_B6F3_0000C00A45A9") = 0x089C_2D
#
# * for every function:
#   * if returned result is not commented, the function returns 0 on no-error.


disk_mediaAccess_0x089C_2D_col__() {
  # $1: size,
  # $2: uuid,
  # $3: prefix; most often: indent,
  # * writes the size-parameter to "stdout".

  local  MediaHandlerUuid PREFIX SIZE UUID

  PREFIX="$3"
  PREFIX1="  $PREFIX0"
  SIZE="$1"
  UUID="$2"

  MediaHandlerUuid="$(
    echo  "${FUNCNAME[1]}"                                      \
      | string__SearchAndReplace   '^disk_mediaAccess_*' ''     \
        | string_SearchAndReplace  '_'                   '-'    \
  )"

  disk_mediaAccess_0x089C_2D_col___  \
    "$MediaHandlerUuid" "$SIZE" "$UUID" "$PREFIX"
}


disk_mediaAccess_0x089C_2D_col___() {
  # $1: media-handler-uuid,
  # $2: size,
  # $3: uuid,
  # $4: prefix; most often: indent,
  # ^* writes the size-parameter to "stdout".

  local  MediaHandlerUuid PREFIX SIZE UUID

  MediaHandlerUuid="$1"
  PREFIX0="$4"
  PREFIX1="  $PREFIX0"
  SIZE="$2"
  UUID="$3"

  START='8' # ^
  # ^ sort parameters.

  disk_mediaAccess_col__METHOD              "$MediaHandlerUuid" "$PREFIX0"
    disk_mediaAccess_col__CommonParameters  "$MediaHandlerUuid" "$PREFIX1"
    disk_mediaAccess_col__SIZE              "$SIZE"             "$PREFIX1"
    disk_mediaAccess_col__START             "$START"            "$PREFIX1"
    disk_mediaAccess_col__UUID              "$UUID"             "$PREFIX1"
  disk_mediaAccess_col__MethodEnd                               "$PREFIX0"
}


disk_mediaAccess_A8A2BB2D_78F0_11E6_B6F3_0000C00A45A9() {
  # handles a dm-linear media;
  # $1: command, in {
  #       "2ChildMedia", "2QualifiedChildDev", "CHECK", "CheckForced",
  #       "DESTROY", "REALIZE", "RealizeForced", "REPAIR", "RepairForced",
  #       "SIZE", "VERIFY", "WAIT", "_:", "__:"
  #     },
  #     * $1 in {
  #         "2ChildMedia", "2QualifiedChildDev", "CHECK", "CheckForced",
  #         "DESTROY", "REPAIR", "RepairForced", "SIZE", "VERIFY", "WAIT"
  #       }: see "../CommonCommandsSpecification.TXT";
  #     * detailed description see:
  #                 "disk_mediaAccess__A8A2BB2D_78F0_11E6_B6F3_0000C00A45A9()".

  local  COMMAND INDEX MediaInfo ParentMedia ParentMediaPath SUFFIX

  COMMAND="$1"
  # echo  "$COMMAND"                                              >>/dev/stderr

  case "$COMMAND" in
      DESTROY | REALIZE | RealizeForced)
          INDEX="$2"
          MediaInfo="$3"
          ParentMedia="$4"
          ParentMediaPath="$5"
          shift 5
          SUFFIX=''

          # echo  "$COMMAND"                                      >>/dev/stderr
          # echo  "$INDEX"                                        >>/dev/stderr
          # echo  "$MediaInfo"                                    >>/dev/stderr
          # echo  "$ParentMedia"                                  >>/dev/stderr
          # echo  "$ParentMediaPath"                              >>/dev/stderr
          # echo  "$SUFFIX"                                       >>/dev/stderr

          disk_mediaAccess__A8A2BB2D_78F0_11E6_B6F3_0000C00A45A9        \
            "$COMMAND"                                                  \
            "$INDEX" "$MediaInfo" "$ParentMedia" "$ParentMediaPath"     \
            "$SUFFIX" "$@"                                              ;;
      *)  # echo  "$COMMAND"                                      >>/dev/stderr
          disk_mediaAccess__A8A2BB2D_78F0_11E6_B6F3_0000C00A45A9  "$@"  ;;
    esac
}


disk_mediaAccess_col__LINEAR() {                  # ': _LINEAR'
  # $1: size,
  # $2: uuid,
  # $3: prefix; most often: indent,
  # * writes the size-parameter to "stdout".

  disk_mediaAccess__A8A2BB2D_78F0_11E6_B6F3_0000C00A45A9  "_:"  "$@"
}


disk_mediaAccess_col___LINEAR() {                  # ': __LINEAR'
  # $1: media-handler-uuid,
  # $2: size,
  # $3: uuid,
  # $4: prefix; most often: indent,
  # ^* writes the size-parameter to "stdout".

  disk_mediaAccess__A8A2BB2D_78F0_11E6_B6F3_0000C00A45A9  "__:" "$@"
}


disk_mediaAccess__0x089C_2D_REALIZE() {
  # realize media or realize media forced;
  # $1: <FORCED>,
  # $2: <INDEX>,
  # $3: <MediaInfo>,
  # $4: <ParentMediaPath>,
  # $5: <SUFFIX>.

  local    ChildMediaName FORCED INDEX MediaInfo ParametersFile ParentMediaPath
  local    SUFFIX

  # parameters:
    local  COPYRIGHT CopyrightDetails OnlyOnHosts RealizationOptions SIZE START
    local  URL UUID

  FORCED="$1"
  INDEX="$2"
  MediaInfo="$3"
  ParentMediaPath="$4"
  SUFFIX="$5"

  # echo  "$FORCED"                                               >>/dev/stderr
  # echo  "$INDEX"                                                >>/dev/stderr
  # echo  "$MediaInfo"                                            >>/dev/stderr
  # echo  "$ParentMediaPath"                                      >>/dev/stderr
  # echo  "$SUFFIX"                                               >>/dev/stderr

  # clear global optional not ignored parameters.
    OnlyOnHosts=''
    RealizationOptions=''

  ParametersFile="$(disk_mediaAccess__Parameters2File  "$MediaInfo")"  \
    || return                                      # return on error.
    .  "$ParametersFile"  || return                # return on error.

  # echo  "$COPYRIGHT"                                            >>/dev/stderr
  # echo  "$CopyrightDetail"                                      >>/dev/stderr
  # echo  "$OnlyOnHosts"                                          >>/dev/stderr
  # echo  "$RealizationOptions"                                   >>/dev/stderr
  # echo  "$SIZE"                                                 >>/dev/stderr
  # echo  "$START"                                                >>/dev/stderr
  # echo  "$URL"                                                  >>/dev/stderr
  # echo  "$UUID"                                                 >>/dev/stderr

  ChildMediaName="${UUID}$SUFFIX"
  # echo  "$ChildMediaName"                                       >>/dev/stderr

  disk_mediaAccess_isHandled                                           \
    "$FORCED" "$OnlyOnHosts" "$RealizationOptions"  || return 0

  disk_mediaAccess____LinearTable                                      \
    "$ChildMediaName"                                                  \
    "$ParentMediaPath" "$RealizationOptions" "$SIZE" "$START"          \
    || return                                      # return on error.

  disk_mediaAccess__LinkAndMap                                         \
   "$ChildMediaName" "$INDEX" "$ParentMediaPath"
}


disk_mediaAccess__A8A2BB2D_78F0_11E6_B6F3_0000C00A45A9() {
  # handles basically a dm-linear media;
  # $1: command, in {
  #       "2ChildMedia", "2QualifiedChildDev", "CHECK", "CheckForced",
  #       "DESTROY", "REALIZE", "RealizeForced", "REPAIR", "RepairForced",
  #       "SIZE", "VERIFY", "WAIT", "_:", "__:"
  #     },
  #     * $1 in {
  #         "2ChildMedia", "2QualifiedChildDev", "CHECK", "CheckForced",
  #         "DESTROY", "REPAIR", "RepairForced", "SIZE", "VERIFY", "WAIT"
  #       }: see "../CommonCommandsSpecification.TXT";
  #     * "REALIZE":
  #       * realizes the media,
  #       * writes the name of the realized media to "stdout";
  #       $2: index into the container,
  #       $3: <MediaInfo>,
  #       $4: <ParentMedia>,
  #       $5: <ParentMediaPath>,
  #       $6: suffix;
  #     * "RealizeForced":
  #       * realizes the media forced;
  #       * writes the name of the realized media to "stdout";
  #       $2: index into the container,
  #       $3: <MediaInfo>,
  #       $4: <ParentMedia>,
  #       $5: <ParentMediaPath>,
  #       $6: suffix;
  #     * "_:":
  #       ^verify command;
  #       ^$2: path to the media (device, file, rootFolder of a filsystem),
  #       ^$3: index into container;
  #     * "__:":
  #       ^verify command;
  #       $2: media-handler-uuid,
  #       $3: size,
  #       $4: uuid,
  #       $5: prefix, most often: indent.

  local  COMMAND FORCED INDEX MediaInfo ParentMedia ParentMediaPath SUFFIX

  COMMAND="$1"
  INDEX="$2"
  MediaInfo="$3"
  ParentMedia="$4"
  ParentMediaPath="$5"
  SUFFIX="$6"

  # echo  "$COMMAND"                                              >>/dev/stderr
  # echo  "$INDEX"                                                >>/dev/stderr
  # echo  "$MediaInfo"                                            >>/dev/stderr
  # echo  "$ParentMedia"                                          >>/dev/stderr
  # echo  "$ParentMediaPath"                                      >>/dev/stderr
  # echo  "$SUFFIX"                                               >>/dev/stderr

  # quick, for verifying and 'wait':
    disk_mediaAccess__VerifyNoWait  "$COMMAND"  && return 0
                                                   # if ok, return 0; no
                                                   # waiting for component
                                                   # medias at all.

  disk_mediaAccess__RealizeForced2Forced  "$COMMAND"
  # echo  "$FORCED"                                               >>/dev/stderr

  case "$COMMAND" in
      2ChildMedia)
        disk_mediaAccess___2ChildMedia0                            \
                   "$MediaInfo"                                    ;;
      2QualifiedChildDev)
        disk_mediaAccess___2QualifiedChildDev                      \
          "$INDEX" "$MediaInfo" "$ParentMedia" "$ParentMediaPath"  ;;
      CHECK | CheckForced | REPAIR | RepairForced)  return  0      ;;
      DESTROY)
        disk_mediaAccess___Destroy0                                \
                   "$MediaInfo"                                    \
          "$SUFFIX"                                                ;;
      REALIZE | RealizeForced)
        disk_mediaAccess__0x089C_2D_REALIZE                        \
          "$FORCED"                                                \
          "$INDEX" "$MediaInfo"                "$ParentMediaPath"  \
          "$SUFFIX"                                                ;;
      SIZE)
        disk_mediaAccess__Size0                                    \
          '0'      "$MediaInfo"                                    ;;
      _:)
        shift 1
        disk_mediaAccess_0x089C_2D_col__   "$@"                    ;;
                                                   # ^
      __:)
        shift 1
        disk_mediaAccess_0x089C_2D_col___  "$@"                    ;;
                                                   # ^
      *)
        disk_mediaAccess___NoContainer                             \
          "$COMMAND" "$INDEX" "$ParentMedia"                       \
          || return                                # return on error.

        disk_mediaAccess__InvalidCommandError                      \
          "$COMMAND" "$INDEX"                                      \
          'A8A2BB2D_78F0_11E6_B6F3_0000C00A45A9'                   \
          "$ParentMedia"                                           ;;
    esac                                           # return result of previous
}                                                  # command.