Class: Yast::Y2ModuleConfigClass

Inherits:
Module
  • Object
show all
Includes:
Logger
Defined in:
../../src/modules/Y2ModuleConfig.rb

Constant Summary

RESOURCE_NAME_KEY =

Key for AutoYaST client name in desktop file

"X-SuSE-YaST-AutoInstResource"
RESOURCE_NAME_MERGE_KEYS =
"X-SuSE-YaST-AutoInstMerge"
MODES =
%w(all configure write)

Instance Method Summary (collapse)

Instance Method Details

- (Array) ConstructMenu

Construct Menu Widget

Returns:

  • (Array)


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

def ConstructMenu
  CreateGroupTree(@GroupMap)

  Builtins.foreach(@ModuleMap) do |m, v|
    name = Ops.get_string(v, "Name", "")
    menu_entry = { "entry" => m, "title" => name }
    menu_list = []
    if Builtins.haskey(v, "X-SuSE-YaST-Group")
      parent = Ops.get_string(v, "X-SuSE-YaST-Group", "")
      @MenuTreeData = Builtins.maplist(@MenuTreeData) do |k|
        if Ops.get_string(k, "entry", "") == parent
          children = Ops.get_list(k, "children", [])
          children = Builtins.add(children, menu_entry)
          Ops.set(k, "children", children)
          next deep_copy(k)
        else
          next deep_copy(k)
        end
      end
    else
      @MenuTreeData = Builtins.add(@MenuTreeData, menu_entry)
    end
  end 
  # y2debug("MenuTreeData: %1", MenuTreeData );

  nil
end

- (void) CreateGroupTree(_Groups)

This method returns an undefined value.

Create group tree

Parameters:

  • map (string, map)

    groups



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# File '../../src/modules/Y2ModuleConfig.rb', line 115

def CreateGroupTree(_Groups)
  _Groups = deep_copy(_Groups)
  #y2debug("Groups: %1", Groups);

  grouplist = []
  grouplist = SortGroups(_Groups, Builtins.maplist(_Groups) do |rawname, group|
    rawname
  end)

  Builtins.foreach(grouplist) do |name|
    title = Desktop.Translate(Ops.get_string(_Groups, [name, "Name"], name))
    _MeunTreeEntry = { "entry" => name, "title" => title }
    @MenuTreeData = Builtins.add(@MenuTreeData, _MeunTreeEntry)
  end

  #y2debug("data: %1", MenuTreeData);
  nil
end

- (Array<Hash>) Deps

Simple dependency resolving

Returns:

  • (Array<Hash>)


277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
# File '../../src/modules/Y2ModuleConfig.rb', line 277

def Deps
  deps = {}
  m = []
  done = []
  Builtins.foreach(@ModuleMap) do |p, d|
    if Builtins.haskey(d, "X-SuSE-YaST-AutoInstRequires") &&
        Ops.get_string(d, "X-SuSE-YaST-AutoInstRequires", "") != ""
      req = Builtins.splitstring(
        Ops.get_string(d, "X-SuSE-YaST-AutoInstRequires", ""),
        ", "
      )
      req = Builtins.filter(req) { |r| r != "" }
      Ops.set(deps, p, req)
    end
  end
  Builtins.y2milestone("New dependencies: %1", deps)

  Builtins.foreach(@ModuleMap) do |p, d|
    Builtins.y2debug("done: %1", done)
    Builtins.y2debug("Working on : %1", p)
    if !Builtins.contains(done, p)
      if Builtins.haskey(deps, p)
        Builtins.foreach(Ops.get_list(deps, p, [])) do |r|
          if !Builtins.contains(done, r)
            m = Builtins.add(
              m,
              { "res" => r, "data" => Ops.get(@ModuleMap, r, {}) }
            )
            done = Builtins.add(done, r)
          end
        end
        m = Builtins.add(m, { "res" => p, "data" => d })
        done = Builtins.add(done, p)
      else
        m = Builtins.add(m, { "res" => p, "data" => d })
        done = Builtins.add(done, p)
      end
    end
  end

  deep_copy(m)
end

- (Hash) getModuleConfig(name)

Returns configuration for a given module

Parameters:

  • name (String)

    Module name.

Returns:

  • (Hash)

    Module configuration using the same structure as

    Deps method (with “res” and “data” keys).

See Also:



395
396
397
398
399
400
401
402
403
# File '../../src/modules/Y2ModuleConfig.rb', line 395

def getModuleConfig(name)
  entries = ReadMenuEntries(MODES).first # entries, groups
  entry = entries.find { |k, v| k == name } # name, entry
  if entry
    { "res" => name, "data" => entry.last }
  else
    nil
  end
end

- (String) getResource(default_resource)

Get resource name

Parameters:

  • string

    resource

Returns:

  • (String)

    resource as defined in desktop file



194
195
196
197
198
199
200
201
202
203
204
205
# File '../../src/modules/Y2ModuleConfig.rb', line 194

def getResource(default_resource)
  ret = Ops.get_string(
    @ModuleMap,
    [default_resource, RESOURCE_NAME_KEY],
    ""
  )
  if ret == ""
    return default_resource
  else
    return ret
  end
end

- (Object) getResourceData(resourceMap, resource)

Get resource data

Parameters:

  • resourceMap (Hash)

    Resource Map

  • resrouce

    the resource

Returns:

  • (Object)

    Resource Data



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
# File '../../src/modules/Y2ModuleConfig.rb', line 211

def getResourceData(resourceMap, resource)
  resourceMap = deep_copy(resourceMap)
  tmp_resource = Ops.get_string(
    resourceMap,
    RESOURCE_NAME_KEY,
    ""
  )
  resource = tmp_resource if tmp_resource != ""

  data_type = Ops.get_string(
    resourceMap,
    "X-SuSE-YaST-AutoInstDataType",
    "map"
  )
  tomerge = Ops.get_string(resourceMap, RESOURCE_NAME_MERGE_KEYS, "")
  tomergetypes = Ops.get_string(
    resourceMap,
    "X-SuSE-YaST-AutoInstMergeTypes",
    ""
  )

  mergedResource = {}
  if Ops.greater_than(Builtins.size(tomerge), 0)
    _MergeTypes = Builtins.splitstring(tomergetypes, ",")
    _Merge = Builtins.splitstring(tomerge, ",")
    i = 0
    Builtins.foreach(_Merge) do |res|
      if Ops.get(_MergeTypes, i, "map") == "map"
        Ops.set(
          mergedResource,
          res,
          Builtins.eval(Ops.get_map(Profile.current, res, {}))
        )
      else
        Ops.set(
          mergedResource,
          res,
          Builtins.eval(Ops.get_list(Profile.current, res, []))
        )
      end
      i = Ops.add(i, 1)
    end
    if mergedResource == {}
      return nil
    else
      return deep_copy(mergedResource)
    end
  else
    if data_type == "map"
      if Ops.get_map(Profile.current, resource, {}) == {}
        return nil
      else
        return Builtins.eval(Ops.get_map(Profile.current, resource, {}))
      end
    else
      if Ops.get_list(Profile.current, resource, []) == []
        return nil
      else
        return Builtins.eval(Ops.get_list(Profile.current, resource, []))
      end
    end
  end
end

- (Object) main



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# File '../../src/modules/Y2ModuleConfig.rb', line 20

def main
  textdomain "autoinst"

  Yast.import "Mode"
  Yast.import "Stage"
  Yast.import "Profile"
  Yast.import "Installation"
  Yast.import "Desktop"
  Yast.import "Wizard"
  Yast.import "Directory"

  # include "autoinstall/io.ycp";

  @GroupMap = {}
  @ModuleMap = {}

  # MenuTreeData
  # @return [Array] of modules
  @MenuTreeData = []
  Y2ModuleConfig()
end

- (Hash) ReadMenuEntries(modes)

Read module configuration files

Returns:

  • (Hash)


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
95
# File '../../src/modules/Y2ModuleConfig.rb', line 44

def ReadMenuEntries(modes)
  modes = deep_copy(modes)
  Desktop.AgentPath = path(".autoyast2.desktop")

  _Values = [
    "Name",
    "GenericName",
    "Icon",
    "Hidden",
    "X-SuSE-YaST-AutoInst",
    RESOURCE_NAME_KEY,
    "X-SuSE-YaST-AutoInstClient",
    "X-SuSE-YaST-Group",
    RESOURCE_NAME_MERGE_KEYS,
    "X-SuSE-YaST-AutoInstMergeTypes",
    "X-SuSE-YaST-AutoInstDataType",
    "X-SuSE-YaST-AutoInstClonable",
    "X-SuSE-YaST-AutoInstRequires",
    "X-SuSE-DocTeamID",
    "X-SuSE-YaST-AutoLogResource"
  ]
  Desktop.Read(_Values)
  configurations = deep_copy(Desktop.Modules)

  #y2debug("%1", configurations );
  groups = deep_copy(Desktop.Groups)

  confs = {}

  Builtins.foreach(configurations) do |name, values|
    if Builtins.contains(
        modes,
        Ops.get_string(values, "X-SuSE-YaST-AutoInst", "")
      )
      module_auto = ""
      # determine name of client, if not default name
      if !Builtins.haskey(values, "X-SuSE-YaST-AutoInstClient") ||
          Ops.get_string(values, "X-SuSE-YaST-AutoInstClient", "") == ""
        client = Ops.add(name, "_auto")
        Builtins.y2debug("client: %1", client)
        Ops.set(values, "X-SuSE-YaST-AutoInstClient", client)
      end
      Builtins.y2debug(
        "name: %1 values: %2",
        name,
        Ops.get_string(values, "X-SuSE-YaST-AutoInstClient", "")
      )
      Ops.set(confs, name, values)
    end
  end
  [confs, groups]
end

- (Boolean) SetDesktopIcon(file)

Set Desktop Icon

Parameters:

  • file (String)

    Desktop File

Returns:

  • (Boolean)


323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
# File '../../src/modules/Y2ModuleConfig.rb', line 323

def SetDesktopIcon(file)
  filename = Builtins.sformat("%1/%2.desktop", Directory.desktopdir, file)
  if Ops.less_than(SCR.Read(path(".target.size"), filename), 0)
    filename = Builtins.sformat(
      "%1/%2.desktop",
      "/usr/share/autoinstall/modules",
      file
    )
  end
  filepath = Ops.add(
    Ops.add(path(".autoyast2.desktop.v"), filename),
    path(".\"Desktop Entry\".Icon")
  )
  icon = Convert.to_string(SCR.Read(filepath))
  Builtins.y2debug("icon: %1 (%2)", icon, filepath)

  return false if icon == nil

  Wizard.SetTitleIcon(icon)
  true
end

- (Array) SortGroups(_GroupMap, _GroupList)

Sort tree groups

Parameters:

  • map (string, map)

    group map

  • list (string)

    group list

Returns:

  • (Array)


102
103
104
105
106
107
108
109
110
# File '../../src/modules/Y2ModuleConfig.rb', line 102

def SortGroups(_GroupMap, _GroupList)
  _GroupMap = deep_copy(_GroupMap)
  _GroupList = deep_copy(_GroupList)
  Builtins.sort(_GroupList) do |x, y|
    first = Ops.get_string(_GroupMap, [x, "SortKey"], "")
    second = Ops.get_string(_GroupMap, [y, "SortKey"], "")
    Ops.less_than(first, second)
  end
end

- (Array<String>) unhandled_profile_sections

Returns list of all profile sections from the current profile, including unsupported ones, that do not have any handler (AutoYaST client) assigned at the current system and are not handled by AutoYaST itself.

Returns:

  • (Array<String>)

    of unknown profile sections



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
# File '../../src/modules/Y2ModuleConfig.rb', line 350

def unhandled_profile_sections
  profile_sections = Profile.current.keys

  profile_handlers = @ModuleMap.map do |name, desc|
    if desc[RESOURCE_NAME_MERGE_KEYS]
      # The YAST module has diffent AutoYaST sections (resources).
      # e.g. Users has: users,groups,user_defaults,login_settings
      desc[RESOURCE_NAME_MERGE_KEYS].split(",")
    else
      # Taking the resource name or the plain module name.
      desc[RESOURCE_NAME_KEY] || name
    end
  end
  profile_handlers.flatten!

  profile_sections.reject! do |section|
    profile_handlers.include?(section)
  end

  # Sections which are not handled in any desktop file but the
  # corresponding clients/*_auto.rb file is available.
  # e.g. user_defaults, report, general, files, scripts
  profile_sections.reject! do |section|
    WFM.ClientExists("#{section}_auto")
  end

  # Generic sections are handled by AutoYast itself and not mentioned
  # in any desktop or clients/*_auto.rb file.
  profile_sections - Yast::ProfileClass::GENERIC_PROFILE_SECTIONS
end

- (Array<String>) unsupported_profile_sections

Returns list of all profile sections from the current profile that are obsolete, e.g., we do not support them anymore.

Returns:

  • (Array<String>)

    of unsupported profile sections



385
386
387
# File '../../src/modules/Y2ModuleConfig.rb', line 385

def unsupported_profile_sections
  unhandled_profile_sections & Yast::ProfileClass::OBSOLETE_PROFILE_SECTIONS
end

- (Object) Y2ModuleConfig

Y2ModuleConfig () Constructor



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
# File '../../src/modules/Y2ModuleConfig.rb', line 167

def Y2ModuleConfig
  # Read module configuration data (desktop files)
  _MenuEntries = []
  if Mode.autoinst
    _MenuEntries = ReadMenuEntries(["all", "write"])
  else
    _MenuEntries = ReadMenuEntries(["all", "configure"])
  end

  @ModuleMap = Ops.get_map(_MenuEntries, 0, {})

  Profile.ModuleMap = deep_copy(@ModuleMap)

  @GroupMap = Ops.get_map(_MenuEntries, 1, {})

  if Mode.config
    # construct the tree menu
    ConstructMenu()
  end

  nil
end