yast/yast-storage-ng

# Copyright (c) [2019] SUSE LLC
#
# All Rights Reserved.
#
# This program is free software; you can redistribute it and/or modify it
# under the terms of version 2 of the GNU General Public License as published
# by the Free Software Foundation.
#
# 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, contact SUSE LLC.
#
# To contact SUSE LLC about this file by physical or electronic mail, you may
# find current contact information at www.suse.com.

require "yast"
require "yast2/popup"
require "y2partitioner/widgets/devices_selection"

Yast.import "Popup"

module Y2Partitioner
  module Widgets
    # Widget making possible to add and remove devices to a Btrfs filesystem
    class BtrfsDevicesSelector < Widgets::DevicesSelection
      # Constructor
      #
      # @param controller [Actions::Controllers::BtrfsDevices]
      def initialize(controller)
        @controller = controller
        super()

        textdomain "storage"
      end

      # @macro seeCustomWidget
      def help
        help_for_available_devices + help_for_selected_devices
      end

      # @see Widgets::DevicesSelection#selected
      def selected
        controller.selected_devices
      end

      # @see Widgets::DevicesSelection#unselected
      def unselected
        controller.available_devices
      end

      # @see Widgets::DevicesSelection#select
      def select(sids)
        filter_devices(unselected, sids).each do |device|
          controller.add_device(device)
        end
      end

      # @see Widgets::DevicesSelection#unselect
      def unselect(sids)
        filter_devices(selected, sids).each do |device|
          controller.remove_device(device)
        end
      end

      # Returns nil to not show the selected size (makes non sense for Btrfs)
      def selected_size
        nil
      end

      # Returns nil to not show the unselected size (for UI uniformity because the selected size is
      # not shown either)
      def unselected_size
        nil
      end

      # @macro seeAbstractWidget
      #
      # Validates the selected devices
      #
      # An error popup is shown when there is some error in selected devices.
      #
      # @return [Boolean]
      def validate
        error = selected_devices_error
        return true unless error

        Yast2::Popup.show(error, headline: :error, buttons: :ok)

        false
      end

      private

      # @return [Actions::Controllers::BtrfsDevices]
      attr_reader :controller

      # Help text for the available devices
      #
      # @return [String]
      def help_for_available_devices
        # TRANSLATORS: help text, where %{label} is a widget label
        format(
          _("<p><b>%{label}</b> Unused devices that can be used for a Btrfs filesystem.</p>"),
          label: unselected_label
        )
      end

      # Help text for the selected devices
      #
      # @return [String]
      def help_for_selected_devices
        # TRANSLATORS: help text, where %{label} is a widget label
        format(
          _("<p><b>%{label}</b> Devices selected to be part of the Btrfs.</p>"),
          label: selected_label
        )
      end

      # Error when there are no selected devices
      #
      # @return [String, nil] nil when at least one device is selected
      def selected_devices_error
        return nil if controller.selected_devices.any?

        # TRANSLATORS: Error message when no device is selected
        _("Select at least one device.")
      end

      # Filters devices with the given sids
      #
      # @param devices [Array<Y2Storage::BlkDevice>]
      # @param sids [Array<Integer>]
      #
      # @return [Array<Y2Storage::BlkDevice>]
      def filter_devices(devices, sids)
        devices.select { |d| sids.include?(d.sid) }
      end
    end
  end
end