Class: Yast::ProductFeaturesClass

Inherits:
Module
  • Object
show all
Defined in:
library/control/src/modules/ProductFeatures.rb

Instance Method Summary collapse

Instance Method Details

#ClearOverlayObject

Remove a `@features` overlay; does nothing if SetOverlay was never called.

Returns:

  • void

See Also:



342
343
344
345
346
347
348
# File 'library/control/src/modules/ProductFeatures.rb', line 342

def ClearOverlay
  return if @backup_features.nil?
  @features = deep_copy(@backup_features)
  # when overlay is cleared, remove backup as it can become invalid over-time
  # when new extensions is applied
  @backup_features = nil
end

#ExportHash <String, Hash{String => Object>}

Exports the current set of ProductFeatures

Returns:



305
306
307
# File 'library/control/src/modules/ProductFeatures.rb', line 305

def Export
  deep_copy(@features)
end

#GetBooleanFeature(section, feature) ⇒ Boolean

Note:

This is a stable API function

Get value of a feature If the feature is missing `false` is returned. So it is not possible to distingush between a missing value and a false value.

Parameters:

  • section (String)

    string section of the feature

  • features

    string feature name

Returns:

  • (Boolean)

    the feature value



234
235
236
237
238
239
# File 'library/control/src/modules/ProductFeatures.rb', line 234

def GetBooleanFeature(section, feature)
  value = GetFeature(section, feature)
  return value if Ops.is_boolean?(value)

  Ops.is_string?(value) && Builtins.tolower(Convert.to_string(value)) == "yes"
end

#GetFeature(section, feature) ⇒ Object

Note:

This is a stable API function

Get value of a feature

Parameters:

  • section (String)

    string section of the feature

  • features

    string feature name

Returns:

  • (Object)

    the feature value, “” if not found



202
203
204
205
206
207
# File 'library/control/src/modules/ProductFeatures.rb', line 202

def GetFeature(section, feature)
  InitIfNeeded()
  ret = Ops.get(@features, [section, feature])
  ret = "" if ret.nil?
  deep_copy(ret)
end

#GetIntegerFeature(section, feature) ⇒ Fixnum

Note:

This is a stable API function

Get value of a feature

Parameters:

  • section (String)

    string section of the feature

  • features

    string feature name

Returns:

  • (Fixnum)

    the feature value, nil if not found



246
247
248
249
250
251
252
253
# File 'library/control/src/modules/ProductFeatures.rb', line 246

def GetIntegerFeature(section, feature)
  value = GetFeature(section, feature)
  if Ops.is_integer?(value)
    value
  elsif Ops.is_string?(value)
    Builtins.tointeger(Convert.to_string(value))
  end
end

#GetSection(section_name) ⇒ Object

Note:

This is a stable API function

Get a complete section for evaluation

Parameters:

  • section_name (String)

    string name of the section

Returns:

  • a map key->value, options in the section



128
129
130
131
# File 'library/control/src/modules/ProductFeatures.rb', line 128

def GetSection(section_name)
  InitFeatures(false)
  Ops.get(@features, section_name, {})
end

#GetStringFeature(section, feature) ⇒ String

Note:

This is a stable API function

Get value of a feature

Parameters:

  • section (String)

    string section of the feature

  • features

    string feature name

Returns:

  • (String)

    the feature value, “” if not found



214
215
216
217
218
219
220
221
222
223
224
225
# File 'library/control/src/modules/ProductFeatures.rb', line 214

def GetStringFeature(section, feature)
  value = GetFeature(section, feature)

  case value
  when ::String
    value
  when true, false
    value ? "yes" : "no"
  else
    Builtins.sformat("%1", value)
  end
end

#Import(import_settings) ⇒ Object

Imports product features

Parameters:

  • map (string, map <string, any>)

    features



312
313
314
315
316
317
# File 'library/control/src/modules/ProductFeatures.rb', line 312

def Import(import_settings)
  import_settings = deep_copy(import_settings)
  @features = deep_copy(import_settings)

  nil
end

#InitFeatures(force) ⇒ Object

Initialize default values of features

Parameters:

  • force (Boolean)

    boolean drop all settings which were set before



98
99
100
101
102
103
# File 'library/control/src/modules/ProductFeatures.rb', line 98

def InitFeatures(force)
  return if !(force || @features.nil?)
  @features = deep_copy(@defaults)

  nil
end

#InitIfNeededObject

Note:

This is a stable API function

Initialize the features structure if needed Either read from /etc/YaST2/ProductFeatures or set default values



186
187
188
189
190
191
192
193
194
195
# File 'library/control/src/modules/ProductFeatures.rb', line 186

def InitIfNeeded
  return if !@features.nil?
  if Stage.normal || Stage.firstboot
    Restore()
  else
    InitFeatures(false)
  end

  nil
end

#mainObject



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'library/control/src/modules/ProductFeatures.rb', line 35

def main
  textdomain "base"

  Yast.import "Misc"
  Yast.import "Mode"
  Yast.import "Stage"

  # Map of all features
  # See defaults map below for sample contents
  @features = nil

  # See SetOverlay and ClearOverlay
  @backup_features = nil

  # Default values for features
  # two-level map, section_name -> [ feature -> value ]
  @defaults = {
    "globals"      => {
      "incomplete_translation_treshold" => "95",
      "ui_mode"                         => "expert",
      "enable_autologin"                => true,
      "language"                        => "",
      "skip_language_dialog"            => false,
      "keyboard"                        => "",
      "default_target"                  => "",
      "timezone"                        => "",
      "fam_local_only"                  => "never",
      "enable_firewall"                 => true,
      "firewall_enable_ssh"             => false,
      "enable_sshd"                     => false,
      "additional_kernel_parameters"    => "",
      "flags"                           => [],
      "run_you"                         => true,
      "relnotesurl"                     => "",
      "vendor_url"                      => "",
      "enable_clone"                    => false,
      "disable_os_prober"               => false,
      # FATE #304865
      "base_product_license_directory"  => "/etc/YaST2/licenses/base/"
    },
    "partitioning" => {
      "use_flexible_partitioning"    => false,
      "flexible_partitioning"        => {},
      "vm_keep_unpartitioned_region" => false
    },
    "software"     => {
      "software_proposal"                    => "selection",
      "selection_type"                       => :auto,
      "delete_old_packages"                  => true,
      "only_update_installed"                => false,
      "packages_transmogrify"                => "",
      "base_selection"                       => "",
      "packages"                             => [],
      "kernel_packages"                      => [],
      "addon_selections"                     => [],
      "inform_about_suboptimal_distribution" => false
    },
    "network"      => { "force_static_ip" => false }
  }
end

#RestoreObject

Note:

This is a stable API function

Restore product features in running system



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'library/control/src/modules/ProductFeatures.rb', line 163

def Restore
  InitFeatures(true)
  groups = SCR.Dir(path(".product.features.section"))
  Builtins.foreach(groups) do |group|
    Ops.set(@features, group, Ops.get(@features, group, {}))
    values = SCR.Dir(Ops.add(path(".product.features.value"), group))
    Builtins.foreach(values) do |v|
      Ops.set(
        @features,
        [group, v],
        SCR.Read(
          Ops.add(Ops.add(path(".product.features.value"), group), v)
        )
      )
    end
  end

  nil
end

#SaveObject

Note:

This is a stable API function

Save product features



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
# File 'library/control/src/modules/ProductFeatures.rb', line 135

def Save
  InitFeatures(false)
  if Mode.update # in case of update old file has different format
    SCR.Execute(
      path(".target.bash"),
      "test -f /etc/YaST2/ProductFeatures && /bin/rm /etc/YaST2/ProductFeatures"
    )
  end
  Builtins.foreach(@features) do |group, options|
    Builtins.foreach(options) do |key, value|
      if Ops.is_map?(value) || Ops.is_list?(value) || Ops.is_symbol?(value)
        Builtins.y2debug("Skipping option %1", key)
      else
        strval = GetStringFeature(group, key)
        SCR.Write(
          Ops.add(Ops.add(path(".product.features.value"), group), key),
          strval
        )
      end
    end
  end
  SCR.Write(path(".product.features"), nil) # flush

  nil
end

#SetBooleanFeature(section, feature, value) ⇒ Object

Note:

This is a stable API function

Set value of a feature

Parameters:

  • section (String)

    string section of the feature

  • features

    string feature name

  • value (Boolean)

    boolean the feature value



285
286
287
288
289
# File 'library/control/src/modules/ProductFeatures.rb', line 285

def SetBooleanFeature(section, feature, value)
  SetFeature(section, feature, value)

  nil
end

#SetFeature(section, feature, value) ⇒ Object

Note:

This is a stable API function

Set value of a feature

Parameters:

  • section (String)

    string section of the feature

  • features

    string feature name

  • value (Object)

    any the feature value



260
261
262
263
264
265
266
267
# File 'library/control/src/modules/ProductFeatures.rb', line 260

def SetFeature(section, feature, value)
  value = deep_copy(value)
  InitIfNeeded()
  Ops.set(@features, section, {}) if !Builtins.haskey(@features, section)
  Ops.set(@features, [section, feature], value)

  nil
end

#SetIntegerFeature(section, feature, value) ⇒ Object

Note:

This is a stable API function

Set value of a feature

Parameters:

  • section (String)

    string section of the feature

  • features

    string feature name

  • value (Fixnum)

    integer the feature value



296
297
298
299
300
# File 'library/control/src/modules/ProductFeatures.rb', line 296

def SetIntegerFeature(section, feature, value)
  SetFeature(section, feature, value)

  nil
end

#SetOverlay(features) ⇒ Object

Overlay, or override, some features. The intended use is to use SetOverlay to apply some features specified by a system role (FATE#317481). Clear would be called only when coming Back to the role selection dialog (and then SetOverlay with a different one)

Parameters:

  • features (Hash{String => Hash{String => Object}})

    in the same format as `@features` or `@defaults`

Returns:

  • void

Raises:



328
329
330
331
332
333
334
335
336
337
# File 'library/control/src/modules/ProductFeatures.rb', line 328

def SetOverlay(features)
  raise "SetOverlay called when old overlay was not cleared" if @backup_features
  @backup_features = deep_copy(@features)

  features.each do |section_name, section|
    section.each do |k, v|
      SetFeature(section_name, k, v)
    end
  end
end

#SetSection(section_name, section_map) ⇒ Object

Note:

This is a stable API function

Set a feature section Default values will be used where value not defined

Parameters:

  • section

    name string the name of the section

  • section_map (Hash{String => Object})

    a map containing data of the section



110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'library/control/src/modules/ProductFeatures.rb', line 110

def SetSection(section_name, section_map)
  section_map = deep_copy(section_map)
  InitFeatures(false)
  Builtins.y2debug("Setting section: %1", section_name)
  section_map = Convert.convert(
    Builtins.union(Ops.get(@defaults, section_name, {}), section_map),
    from: "map",
    to:   "map <string, any>"
  )
  Ops.set(@features, section_name, section_map)

  nil
end

#SetStringFeature(section, feature, value) ⇒ Object

Note:

This is a stable API function

Set value of a feature

Parameters:

  • section (String)

    string section of the feature

  • features

    string feature name

  • value (String)

    string the feature value



274
275
276
277
278
# File 'library/control/src/modules/ProductFeatures.rb', line 274

def SetStringFeature(section, feature, value)
  SetFeature(section, feature, value)

  nil
end