yast/yast-network

# Copyright (c) [2019-2020] 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.

module Yast
  # Functions for accessing and handling s390 specific needs.
  module NetworkLanS390Include
    SYS_DIR = "/sys/class/net".freeze

    def initialize_network_lan_s390(_include_target)
      Yast.import "FileUtils"
      Yast.import "Arch"
    end

    # Checks if driver was successfully loaded for particular device.
    def s390_DriverLoaded(devname)
      return false if !Yast::Arch.s390
      return false if devname.empty?

      Yast::FileUtils.IsDirectory("#{SYS_DIR}/#{devname}") == true
    end

    # Reads particular qeth attribute and returns its value as a string.
    #
    # @param [String] attrib attribute name as exported by qeth module
    # @return attribute value or nil in case of error.
    def s390_ReadQethAttribute(devname, attrib)
      return nil if !s390_DriverLoaded(devname)

      result = Yast::Convert.to_string(
        Yast::SCR.Read(
          Yast.path(".target.string"),
          Yast::Builtins.sformat("%1/%2/device/%3", SYS_DIR, devname, attrib)
        )
      )

      Yast::Builtins.regexpsub(result, "(.*)\n", "\\1")
    end

    # Reads attributes for particular qeth based network device.
    #
    # Returned map is compatible with similar map used for storing sysconfig
    # values used elswhere in the code.
    # As a consequence, boolean values are stored as strings with yes/no value.
    #
    # Currently loaded attributes are:
    # QETH_LAYER2      yes/no string.
    # QETH_PORTNUMBER  portnumber or empty string
    # QETH_CHANIDS     read/write/control channel ids separated by space (compatibility requirement)
    #
    # see lsqeth for inspiration
    #
    # @return a map with keys QETH_LAYER2, QETH_PORTNAME, QETH_PORTNUMBER, QETH_CHANIDS
    def s390_ReadQethConfig(devname)
      return {} if devname.empty?
      return {} if !s390_DriverLoaded(devname)

      result = {}

      qeth_layer2 = (s390_ReadQethAttribute(devname, "layer2") == "1") ? "yes" : "no"
      result = Yast::Builtins.add(result, "QETH_LAYER2", qeth_layer2)

      qeth_portno = s390_ReadQethAttribute(devname, "portno")
      result = Yast::Builtins.add(result, "QETH_PORTNUMBER", qeth_portno)

      # FIXME: another code handles chanids merged in one string separated by spaces.
      read_chan = s390_ReadQethAttribute(devname, "cdev0")
      write_chan = s390_ReadQethAttribute(devname, "cdev1")
      ctrl_chan = s390_ReadQethAttribute(devname, "cdev2")
      qeth_chanids = Yast::Builtins.mergestring(
        [read_chan, write_chan, ctrl_chan],
        " "
      )
      result = Yast::Builtins.add(result, "QETH_CHANIDS", qeth_chanids)

      # TODO: ipa_takover. study a bit. It cannot be read from /sys. Not visible using lsqeth,
      # qethconf configures it.

      Yast::Builtins.y2debug("s390_ReadQethConfig: %1", result)

      Yast.deep_copy(result)
    end
  end
end