yast/yast-yast2

# ***************************************************************************
#
# Copyright (c) 2002 - 2013 Novell, Inc.
# 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 Novell, Inc.
#
# To contact Novell about this file by physical or electronic mail,
# you may find current contact information at www.novell.com
#
# ***************************************************************************
#
# Purpose:  Responsible for getting information from the /etc/os-release file
#
require "yast"

module Yast
  import "Misc"
  import "Stage"
  import "FileUtils"

  class OSReleaseFileMissingError < StandardError
  end

  class OSReleaseClass < Module
    include Yast::Logger

    def initialize
      super

      textdomain "base"
    end

    OS_RELEASE_PATH = "/etc/os-release".freeze

    # Get information about the OS release
    # Throws exception Yast::OSReleaseFileMissingError if release file
    # is missing.
    #
    # @param [String] directory containing the installed system (/ in installed system)
    # @return [String] the release information
    def ReleaseInformation(directory = "/")
      release_file = File.join(directory, OS_RELEASE_PATH)

      if !os_release_exists?(directory)
        log.info "Release file #{release_file} not found"
        raise(
          OSReleaseFileMissingError,
          format(_("Release file %{file} not found"), file: release_file)
        )
      end

      MakeNiceName(Misc.CustomSysconfigRead("PRETTY_NAME", "", release_file))
    end

    # Get information about the OS name
    # Is limited for the currently running product
    # @return [String] the release information
    def ReleaseName(directory = "/")
      Misc.CustomSysconfigRead("NAME", "SUSE Linux", File.join(directory, OS_RELEASE_PATH))
    end

    # Get information about the OS version (technical). E.g. 15.2
    # Is limited for the currently running product
    # @return [String] the release information
    def ReleaseVersion(directory = "/")
      Misc.CustomSysconfigRead("VERSION_ID", "", File.join(directory, OS_RELEASE_PATH))
    end

    # Get information about the OS version (human readable). E.g. 15-SP2
    # Is limited for the currently running product
    # @return [String] the release information
    def ReleaseVersionHumanReadable(directory = "/")
      Misc.CustomSysconfigRead("VERSION", "", File.join(directory, OS_RELEASE_PATH))
    end

    # Get information about OS ID
    # Is limited for the currently running product
    # @return [String] the OS identifier (sles, opensuse, etc.)
    def id(directory = "/")
      Misc.CustomSysconfigRead("ID", "", File.join(directory, OS_RELEASE_PATH))
    end

    # Returns whether os-release file exists in the given directory
    #
    # @param [String] (optional) directory, defaults to "/"
    # @return [Boolean] whether exists
    def os_release_exists?(directory = "/")
      FileUtils.Exists(
        File.join(directory, OS_RELEASE_PATH)
      )
    end

    publish function: :ReleaseInformation, type: "string (string)"
    publish function: :ReleaseName, type: "string ()"
    publish function: :ReleaseVersion, type: "string ()"
    publish function: :ReleaseVersionHumanReadable, type: "string ()"

  private

    # Make a nice name for a system out of the long name
    # @param [String] longname string the long product name
    # @return [String] nice product name (to be displayed)
    def MakeNiceName(longname)
      # remove everything after first left parenthesis and spaces leading to it
      longname.gsub(/ *\(.*/, "")
    end
  end

  OSRelease = OSReleaseClass.new
end