#!/usr/local/bin/scripts/sh
#^ pen: default TIMEOUT ?
#
#.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/A8A2BB3A_78F0_11E6_B6F3_0000C00A45A9!0.!c
#
#/*******************************************************************************
#     io disk mediaAccess mediaHandlers.d/A8A2BB3A_78F0_11E6_B6F3_0000C00A45A9
#     ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
#
#     purpose             : media handler for a multicomponent dm-linear media
#
#     begin               : Thu May 18 11:29:02 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("A8A2BB3A_78F0_11E6_B6F3_0000C00A45A9" = 0x089A
#
# * for every function:
#   * if returned result is not commented, the function returns 0 on no-error.


disk_mediaAccess_A8A2BB3A_78F0_11E6_B6F3_0000C00A45A9() {
  # * handles a multicomponent dm-linear media;
  # $1: command, in {
  #       "2ChildDev", "2ChildMedia", "DESTROY", "REALIZE", "RealizeForced",
  #       "SIZE", "VERIFY", "WAIT", "_:", "__:"
  #     },
  #     * $1 in {
  #         "2ChildDev", "2ChildMedia", "DESTROY", "REALIZE", "RealizeForced",
  #         "SIZE", "VERIFY", "WAIT"
  #       }: see "../CommonCommandsSpecification.TXT",
  #     ^* "_:":  ^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;
  #              ^* writes the size-parameter to "stdout".

  local  COMMAND FORCED INDEX MediaInfo ParentMedia ParentMediaPath SubCommand

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

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

  # quick, for verifying and 'wait':
    [ "0" == "$(
      disk_mediaAccess__VerifyMayWait                                       \
        "$COMMAND" "$INDEX" "$MediaInfo" "$ParentMedia" "$ParentMediaPath"  \
        "$SubCommand"
      )"                                                                    \
    ]  && {
      disk_mediaAccess__VerifyMayWait                                       \
        "$COMMAND" "$INDEX" "$MediaInfo" "$ParentMedia" "$ParentMediaPath"  \
        "$SubCommand"                                   >/dev/null  2>/dev/null
      return                                       # for correct verify, 'wait'
    }                                              # and invalid sub-commands.

  # here, for 'WAIT' == '<COMMAND>' ==> "1" == "<SubCommand>" !

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

  case "$COMMAND" in
      2ChildDev)
        disk_mediaAccess___2ChildDev                                        \
          "$INDEX" "$MediaInfo" "$ParentMedia" "$ParentMediaPath"  ;;

      2ChildMedia)
        disk_mediaAccess___2ChildMedia0                                     \
                   "$MediaInfo"                                    ;;

      CHECK|REPAIR)  return  0                                     ;;

      DESTROY)
        disk_mediaAccess___Destroy0                                         \
                   "$MediaInfo"                                ''  ;;

      REALIZE|RealizeForced)
        disk_mediaAccess__0x089A_REALIZE                                    \
          "$FORCED"                                                         \
          "$INDEX" "$MediaInfo"                "$ParentMediaPath"  ;;

      SIZE)
        disk_mediaAccess__Size0                                             \
               '0' "$MediaInfo"                                    ;;

      WAIT)
        disk_mediaAccess__0x089A_WaitForComponentMedias                     \
          "$INDEX" "$MediaInfo" "$ParentMedia" "$ParentMediaPath"  ;;
#     _:)
#       shift 1
#       disk_mediaAccess__0x089A_col__   "$@"                      ;;
                                                   # ^
#     __:)
#       shift 1
#       disk_mediaAccess__0x089A_col___  "$@"                      ;;
                                                   # ^
      *)
        disk_mediaAccess___NoContainer                                      \
          "$COMMAND" "$INDEX" "$ParentMedia"                                \
          || return                                # return on error.
        disk_mediaAccess__InvalidCommandError                               \
          "$COMMAND" "$INDEX"                                               \
          'A8A2BB3A_78F0_11E6_B6F3_0000C00A45A9'                            \
          "$ParentMedia"                                           ;;
    esac                                           # return result of previous
}                                                  # command.


disk_mediaAccess__0x089A_REALIZE() {
  # realizes the media or realizes the media forced;
  # $1: <FORCED>,
  # $2: <INDEX>,
  # $3: <MediaInfo>,
  # $4: <ParentMediaPath>.

  # global:    DisksByUuidMountPath0x0EAA

  local        ChildMediaName ComponentMediaPath ComponentSize
  local        ComponentStartSector FORCED I INDEX MediaInfo numComponents
  local        ParametersFile ParentMediaPath TABLE TableIndex

  # parameters:
    local  -a  ComponentMedias
    local      COPYRIGHT CopyrightDetails NOTES OnlyOnHosts RealizationOptions
    local      SIZE
    local  -a  STARTS
    local      TIMEOUT URL UUID

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

  # echo  $FORCED                                                 >>/dev/stderr
  # echo  $INDEX                                                  >>/dev/stderr
  # echo  "$MediaInfo"                                            >>/dev/stderr
  # echo  $ParentMediaPath                                        >>/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  $CopyrightDetails                                       >>/dev/stderr
  # echo  ${ComponentMedias[@]}                                   >>/dev/stderr
  # echo  $NOTES                                                  >>/dev/stderr
  # echo  $OnlyOnHosts                                            >>/dev/stderr
  # echo  $RealizationOptions                                     >>/dev/stderr
  # echo  $SIZE                                                   >>/dev/stderr
  # echo  ${STARTS[@]}                                            >>/dev/stderr
  # echo  $TIMEOUT                                                >>/dev/stderr
  # echo  $URL                                                    >>/dev/stderr
  # echo  $UUID                                                   >>/dev/stderr

  ChildMediaName="$UUID"
  # echo  $ChildMediaName                                         >>/dev/stderr

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

  numComponents="${#ComponentMedias[@]}"
  # echo  $numComponents                                          >>/dev/stderr

  TABLE=''; TableIndex='0'
  for ((I = 0; I < numComponents; I++))
    do
        ComponentMediaPath="${ComponentMedias[$I]}"
        ComponentStartSector="${STARTS[$I]}"
        echo  $ComponentStartSector                             >>/dev/stderr

        if [ "THIS" == "$ComponentMediaPath" ]; then
            ComponentMediaPath="$ParentMediaPath"
            ComponentSize="$SIZE"
          else
            ComponentMediaPath="$(
              disk_mediaAccess___Media2AbsolutePath  "${ComponentMedias[$I]}"
            )"                                                       || return
                                                   # return on error.
            ComponentSize="$(disk_SIZE  "$ComponentMediaPath" 'S')"  || return
                                                   # return on error.
            let "ComponentSize -= ComponentStartSector"
          fi

        # echo  $ComponentMediaPath                               >>/dev/stderr
        # echo  $ComponentSize                                    >>/dev/stderr

        TABLE+="$TableIndex $ComponentSize  linear  $ComponentMediaPath "
        TABLE+="$ComponentStartSector\n"
          # echo  -e  "$TABLE"                                    >>/dev/stderr
        let  "TableIndex += ComponentSize"
    done
      # echo  -e  "$TABLE"                                        >>/dev/stderr

      echo  -e  "$TABLE"  | disk_mediaAccess__DmCreate                         \
        "$ChildMediaName" "$RealizationOptions"  || return
        # "-e": table contains "\n"!               # return on error.

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


disk_mediaAccess__0x089A_WaitForComponentMedias() {
  # wait for component medias;
  # $2: <INDEX>,
  # $3: <MediaInfo>,
  # $1: <ParentMedia>,
  # $1: <ParentMediaPath>.

  local    INDEX MediaInfo ParametersFile ParentMedia ParentMediaPath

  # parameters:
    local  ComponentMedias TIMEOUT

  INDEX="$1"
  MediaInfo="$2"
  ParentMedia="$3"
  ParentMediaPath="$4"

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

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

  # echo  $TIMEOUT                                                >>/dev/stderr

  disk_mediaAccess__WaitForComponentMedias                             \
    "$INDEX" "$ParentMedia" "$ParentMediaPath" "$TIMEOUT"
}


Xdisk_mediaAccess__0x089A_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__0x089A_col___  \
    "$MediaHandlerUuid" "$SIZE" "$UUID" "$PREFIX"
}


Xdisk_mediaAccess__0x089A_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"
}


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

  disk_mediaAccess_A8A2BB3A_78F0_11E6_B6F3_0000C00A45A9  "_:"  "$@"
}


Xdisk_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__A8A2BB3A_78F0_11E6_B6F3_0000C00A45A9  "__:" "$@"
}