Module: Yast::NetworkRoutinesInclude

Includes:
I18n, Logger, Yast
Defined in:
../../src/include/network/routines.rb

Constant Summary

Constant Summary

Constants included from Yast

DNS, Host, InternetDevices, Lan, LanItems, LanUdevAuto, NetHwDetection, Network, NetworkStorage, Remote, Routing, SuSEFirewall4Network

Instance Method Summary (collapse)

Instance Method Details

- (Object) Abort

Abort function

Returns:

  • blah blah lahjk



59
60
61
62
63
64
65
66
67
68
# File '../../src/include/network/routines.rb', line 59

def Abort
  Yast.import "Mode"
  return false if Mode.commandline
  return UI.PollInput == :abort

  # FIXME: NI
  # if(AbortFunction != nil)
  # 	return eval(AbortFunction) == true;
  false
end

- (Object) BusyPopup(message)

Show busy popup (for proposal)

Parameters:

  • message (String)

    label to be shown



206
207
208
209
210
211
# File '../../src/include/network/routines.rb', line 206

def BusyPopup(message)
  UI.BusyCursor
  UI.OpenDialog(VBox(Label(message)))

  nil
end

- (Object) BusyPopupClose

Close busy popup

See Also:



215
216
217
218
219
# File '../../src/include/network/routines.rb', line 215

def BusyPopupClose
  UI.CloseDialog

  nil
end

- (Object) ChangedComment(modul)

Create comment for changed file

Examples:

ChangedComment(“lan”) -> # Changed by YaST2 module lan 1.1.2000“

Parameters:

  • modul (String)

    YaST2 module changing the file

Returns:

  • comment



191
192
193
194
195
196
197
198
199
200
201
202
# File '../../src/include/network/routines.rb', line 191

def ChangedComment(modul)
  ret = "\n# Changed by YaST2"
  if modul != nil && modul != ""
    ret = Ops.add(Ops.add(ret, " module "), modul)
  end
  out = Convert.to_map(
    SCR.Execute(path(".target.bash_output"), "/bin/date '+%x'")
  )
  date = Ops.get_string(out, "stdout", "")
  ret = Ops.add(Ops.add(ret, " "), date) if date != ""
  ret
end

- (Object) ChangeWidgetIfExists(id, param, value)

Change UI widget only if it exists

Parameters:

  • id (Yast::Term)

    widget id

  • param (Symbol)

    widget parameter

  • value (Object)

    widget parameter value



108
109
110
111
112
113
114
115
116
117
118
# File '../../src/include/network/routines.rb', line 108

def ChangeWidgetIfExists(id, param, value)
  id = deep_copy(id)
  value = deep_copy(value)
  if UI.WidgetExists(id)
    UI.ChangeWidget(id, param, value)
  else
    Builtins.y2debug("Not changing: %1", id)
  end

  nil
end

- (Object) ControllerType(hwdevice)

Simple convertor from subclass to controller type.

Examples:

ControllerType(<ethernet controller map>) -> “eth”

Parameters:

  • hwdevice (Hash)

    map with card info containing “subclass”

Returns:

  • short device name



533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
# File '../../src/include/network/routines.rb', line 533

def ControllerType(hwdevice)
  hwdevice = deep_copy(hwdevice)
  return "modem" if Ops.get_string(hwdevice, "subclass", "") == "Modem"
  return "isdn" if Ops.get_string(hwdevice, "subclass", "") == "ISDN"
  return "dsl" if Ops.get_string(hwdevice, "subclass", "") == "DSL"

  subclass_id = Ops.get_integer(hwdevice, "sub_class_id", -1)

  # Network controller
  if Ops.get_integer(hwdevice, "class_id", -1) == 2
    if subclass_id == 0
      return "eth"
    elsif subclass_id == 1
      return "tr"
    elsif subclass_id == 2
      return "fddi"
    elsif subclass_id == 3
      return "atm"
    elsif subclass_id == 4
      return "isdn"
    elsif subclass_id == 6
      return "ib"
    elsif subclass_id == 129
      return "myri"
    elsif subclass_id == 130
      return "wlan"
    elsif subclass_id == 131
      return "xp"
    elsif subclass_id == 134
      return "qeth"
    elsif subclass_id == 135
      return "hsi"
    elsif subclass_id == 136
      return "ctc"
    elsif subclass_id == 137
      return "lcs"
    elsif subclass_id == 142
      return "ficon"
    elsif subclass_id == 143
      return "escon"
    elsif subclass_id == 144
      return "iucv"
    elsif subclass_id == 145
      return "usb" # #22739
    elsif subclass_id == 128
      # Nothing was found
      Builtins.y2error("Unknown network controller type: %1", hwdevice)
      Builtins.y2error(
        "It's probably missing in hwinfo (NOT src/hd/hd.h:sc_net_if)"
      )
      return ""
    else
      # Nothing was found
      Builtins.y2error("Unknown network controller type: %1", hwdevice)
      return ""
    end
  end
  # exception for infiniband device
  if Ops.get_integer(hwdevice, "class_id", -1) == 12
    return "ib" if subclass_id == 6
  end

  # Communication controller
  if Ops.get_integer(hwdevice, "class_id", -1) == 7
    if subclass_id == 3
      return "modem"
    elsif subclass_id == 128
      # Nothing was found
      Builtins.y2error("Unknown network controller type: %1", hwdevice)
      Builtins.y2error(
        "It's probably missing in hwinfo (src/hd/hd.h:sc_net_if)"
      )
      return ""
    else
      # Nothing was found
      Builtins.y2error("Unknown network controller type: %1", hwdevice)
      return ""
    end
  # Network Interface
  # check the CVS history and then kill this code!
  # 0x107 is the output of hwinfo --network
  # which lists the INTERFACES
  # but we are inteested in hwinfo --netcard
  # Just make sure that hwinfo or ag_probe
  # indeed does not pass this to us
  elsif Ops.get_integer(hwdevice, "class_id", -1) == 263
    Builtins.y2milestone("CLASS 0x107") # this should happen rarely
    if subclass_id == 0
      return "lo"
    elsif subclass_id == 1
      return "eth"
    elsif subclass_id == 2
      return "tr"
    elsif subclass_id == 3
      return "fddi"
    elsif subclass_id == 4
      return "ctc"
    elsif subclass_id == 5
      return "iucv"
    elsif subclass_id == 6
      return "hsi"
    elsif subclass_id == 7
      return "qeth"
    elsif subclass_id == 8
      return "escon"
    elsif subclass_id == 9
      return "myri"
    elsif subclass_id == 10
      return "wlan"
    elsif subclass_id == 11
      return "xp"
    elsif subclass_id == 12
      return "usb"
    elsif subclass_id == 128
      # Nothing was found
      Builtins.y2error("Unknown network interface type: %1", hwdevice)
      Builtins.y2error(
        "It's probably missing in hwinfo (src/hd/hd.h:sc_net_if)"
      )
      return ""
    elsif subclass_id == 129
      return "sit"
    else
      # Nothing was found
      Builtins.y2error("Unknown network interface type: %1", hwdevice)
      return ""
    end
  elsif Ops.get_integer(hwdevice, "class_id", -1) == 258
    return "modem"
  elsif Ops.get_integer(hwdevice, "class_id", -1) == 259
    return "isdn"
  elsif Ops.get_integer(hwdevice, "class_id", -1) == 276
    return "dsl"
  end

  # Nothing was found
  Builtins.y2error("Unknown controller type: %1", hwdevice)
  ""
end

- (Object) dev_name_to_sysfs_id(dev_name, hardware)



407
408
409
410
411
412
413
414
# File '../../src/include/network/routines.rb', line 407

def dev_name_to_sysfs_id(dev_name, hardware)
  hardware = deep_copy(hardware)
  # hardware is cached list of netcards
  hw_item = Builtins.find(hardware) do |i|
    Ops.get_string(i, "dev_name", "") == dev_name
  end
  Ops.get_string(hw_item, "sysfs_id", "")
end

- (Object) DeviceName(hwdevice)

Extract the device 'name'

Parameters:

  • hwdevice (Hash)

    hardware device

Returns:

  • name consisting of vendor and device name



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
# File '../../src/include/network/routines.rb', line 487

def DeviceName(hwdevice)
  hwdevice = deep_copy(hwdevice)
  delimiter = " " # "\n";
  model = ""
  vendor = ""
  dev = ""

  if IsNotEmpty(Ops.get_string(hwdevice, "device", ""))
    return Ops.get_string(hwdevice, "device", "")
  end

  model = Ops.get_string(hwdevice, "model", "")
  return model if model != "" && model != nil

  vendor = Ops.get_string(hwdevice, "sub_vendor", "")
  dev = Ops.get_string(hwdevice, "sub_device", "")

  if vendor == "" || dev == ""
    vendor = Ops.get_string(hwdevice, "vendor", "")
    dev = Ops.get_string(hwdevice, "device", "")
  end

  if vendor != ""
    return Ops.add(Ops.add(vendor, delimiter), dev)
  else
    return dev
  end
end

- (Object) disable_unconfigureable_items(items, show_popup)

Disables all widgets which cannot be configured with current network service

see bnc#433084 if listed any items, disable them, if show_popup, show warning popup

returns true if items were disabled



1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
# File '../../src/include/network/routines.rb', line 1024

def disable_unconfigureable_items(items, show_popup)
  return false if !unconfigureable_service?

  items.each { |i| UI.ChangeWidget(Id(i), :Enabled, false) }

  if show_popup
    Popup.Warning(
      _(
        "Network is currently handled by NetworkManager\n" +
        "or completely disabled. YaST is unable to configure some options."
      )
    )
    UI.FakeUserInput({ "ID" => "global" })
  end

  return true
end

- (Object) DistinguishedName(name, hwdevice)



472
473
474
475
476
477
478
479
480
481
482
# File '../../src/include/network/routines.rb', line 472

def DistinguishedName(name, hwdevice)
  hwdevice = deep_copy(hwdevice)
  if Ops.get_string(hwdevice, "sysfs_bus_id", "") != ""
    return Builtins.sformat(
      "%1 (%2)",
      name,
      Ops.get_string(hwdevice, "sysfs_bus_id", "")
    )
  end
  name
end

- (Object) DriverType(type)

For s390 hwinfo gives us a multitude of types but some are handled the same, mostly acording to the driver which is used. So let's group them under the name Driver Type.

Parameters:

  • type (String)

    a type, as in Lan::type

Returns:

  • driver type, like formerly type2 for s390



366
367
368
369
370
371
372
373
374
375
376
377
378
379
# File '../../src/include/network/routines.rb', line 366

def DriverType(type)
  drvtype = type
  # handle HSI like qeth, S#40692#c15
  if type == "hsi"
    drvtype = "qeth"
  # Should eth occur on s390?
  elsif type == "tr" || type == "eth"
    drvtype = "lcs"
  # N#82891
  elsif type == "escon" || type == "ficon"
    drvtype = "ctc"
  end
  drvtype
end

- (Object) FinishPopup(modified, head, text, run, params)

Display the finished popup and possibly run another module. If not modified, don't do anything.

Parameters:

  • modified (Boolean)

    true if there are any modified data

  • head (String)

    headline to be shown

  • text (String)

    text to be shown

  • run (String)

    module to be run

  • params (Array)

    parameters to pass to the module

Returns:

  • always `next



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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
# File '../../src/include/network/routines.rb', line 292

def FinishPopup(modified, head, text, run, params)
  params = deep_copy(params)
  return :next if !modified

  h = head
  if h == nil || h == ""
    # Popup headline
    h = _("Configuration Successfully Saved")
  end

  heads = {
    # Popup headline
    "dns"      => _("DNS Configuration Successfully Saved"),
    # Popup headline
    "dsl"      => _("DSL Configuration Successfully Saved"),
    # Popup headline
    "host"     => _(
      "Hosts Configuration Successfully Saved"
    ),
    # Popup headline
    "isdn"     => _(
      "ISDN Configuration Successfully Saved"
    ),
    # Popup headline
    "lan"      => _(
      "Network Card Configuration Successfully Saved"
    ),
    # Popup headline
    "modem"    => _(
      "Modem Configuration Successfully Saved"
    ),
    # Popup headline
    "proxy"    => _(
      "Proxy Configuration Successfully Saved"
    ),
    # Popup headline
    "provider" => _(
      "Provider Configuration Successfully Saved"
    ),
    # Popup headline
    "routing"  => _(
      "Routing Configuration Successfully Saved"
    )
  }
  h = Ops.get_string(heads, head, h)

  t = text
  texts = {
    # Popup text
    "mail" => _("Configure mail now?")
  }
  t = Ops.get_string(texts, run, text) if t == ""
  if t == ""
    # Popup text
    t = Builtins.sformat(_("Run configuration of %1?"), run)
  end

  ret = nil
  if run != ""
    ret = Popup.YesNoHeadline(h, t)
    # FIXME: check for the module presence
    Call.Function(run, params) if ret == true
  else
    ret = Popup.AnyMessage(h, t)
  end

  :next
end

- (Array) GetAllInterfaces

Return list of all interfaces present in the system (not only configured ones as NetworkInterfaces::List does).

Returns:

  • (Array)

    of interface names.



922
923
924
925
926
927
928
# File '../../src/include/network/routines.rb', line 922

def GetAllInterfaces
  result = RunAndRead("ls /sys/class/net")

  Ops.get_boolean(result, "exit", false) ?
    Ops.get_list(result, "output", []) :
    []
end

- (Object) getHardware(sysfs_id, _Hw)

map<string, any> getcfg(string options, string device){ map <string, any> cfg=$[]; map <string, any> output = (map <string, any>)SCR::Execute(.target.bash_output, sformat(“getcfg %1 %2”, options, device)); foreach(string row, splitstring(output:“”, “n”), { row=deletechars(row, “\”;“); list<string> keyval=splitstring(row, ”=“); if (size(keyval)>1) cfg[keyval:”“]=keyval:”“;

}); y2milestone(“%1 %2n%3”, options, device, cfg); return cfg; }



460
461
462
463
464
465
466
467
468
469
470
# File '../../src/include/network/routines.rb', line 460

def getHardware(sysfs_id, _Hw)
  _Hw = deep_copy(_Hw)
  hardware = {}
  Builtins.foreach(_Hw) do |hw_temp|
    if sysfs_id ==
        Builtins.sformat("/sys%1", Ops.get_string(hw_temp, "sysfs_id", ""))
      hardware = deep_copy(hw_temp)
    end
  end
  deep_copy(hardware)
end

- (boolean) has_carrier?(dev_name)

Checks if given device has carrier

Returns:

  • (boolean)

    true if device has carrier



965
966
967
968
969
970
# File '../../src/include/network/routines.rb', line 965

def has_carrier?(dev_name)
  SCR.Read(
    path(".target.string"),
    "/sys/class/net/#{dev_name}/carrier"
  ).to_i != 0
end

- (Object) hwlist2items(l, selected)

Create a list of items for UI from the given hardware list.

This list is used when selecting <ol> <li> detected unconfigured cards, there we want to see the link status </li> <li> undetected cards manually. there is no link status there and it won't be displayed. all is ok. </li> </ol>

Parameters:

  • l (Array<Hash>)

    given list for conversion

  • selected (Fixnum)

    selected item (0 for the first)

Returns:

  • a list of items



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
# File '../../src/include/network/routines.rb', line 260

def hwlist2items(l, selected)
  l = deep_copy(l)
  # Translators: Appended after a network card name to indicate that
  # there is no carrier, no link to the network, the cable is not
  # plugged in. Preferably a short string.
  nolink = _("unplugged")

  items = []
  n = 0
  Builtins.foreach(l) do |i|
    # Table field (Unknown device)
    hwname = Ops.get_locale(i, "name", _("Unknown"))
    label = Ops.add(
      hwname,
      Ops.get(i, "link") == false ? Builtins.sformat(" (%1)", nolink) : ""
    )
    num = Ops.get_integer(i, "num", n) # num for detected, n for manual
    items = Builtins.add(items, Item(Id(num), hwname, num == selected))
    n = Ops.add(n, 1)
  end
  deep_copy(items) 
  #return list2items(maplist(map h, l, { return h["name"]:_("Unknown Device"); }), selected);
end

- (Object) initialize_network_routines(include_target)



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# File '../../src/include/network/routines.rb', line 35

def initialize_network_routines(include_target)
  Yast.import "UI"

  textdomain "network"

  Yast.import "Call"
  Yast.import "Popup"
  Yast.import "Progress"
  Yast.import "String"
  Yast.import "NetworkService"
  Yast.import "PackageSystem"
  Yast.import "NetworkInterfaces"
  Yast.import "Arch"
  Yast.import "Confirm"
  Yast.import "Map"
  Yast.import "Netmask"
  Yast.import "Mode"
  Yast.import "IP"
  Yast.import "TypeRepository"
  Yast.import "Stage"
end

- (Object) IsEmpty(value)

Checks if given value is emtpy.



222
223
224
225
# File '../../src/include/network/routines.rb', line 222

def IsEmpty(value)
  value = deep_copy(value)
  TypeRepository.IsEmpty(value)
end

- (Object) IsNotEmpty(value)

Checks if given value is non emtpy.



228
229
230
231
# File '../../src/include/network/routines.rb', line 228

def IsNotEmpty(value)
  value = deep_copy(value)
  !IsEmpty(value)
end

- (Object) list2items(l, selected)

Create a list of items for UI from the given list

Examples:

[ “x”, “y” ] -> [ item(id(0), “x”), item(id(1), “y”) ]

Parameters:

  • l (Array)

    given list for conversion

  • selected (Fixnum)

    selected item (0 for the first)

Returns:

  • a list of items



238
239
240
241
242
243
244
245
246
247
# File '../../src/include/network/routines.rb', line 238

def list2items(l, selected)
  l = deep_copy(l)
  items = []
  n = 0
  Builtins.foreach(l) do |i|
    items = Builtins.add(items, Item(Id(n), i, n == selected))
    n = Ops.add(n, 1)
  end
  deep_copy(items)
end

- (Object) needHwcfg(hw)



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
# File '../../src/include/network/routines.rb', line 381

def needHwcfg(hw)
  hw = deep_copy(hw)
  need = true
  # if kernel will autoload module for device
  if IsNotEmpty(Ops.get_string(hw, "modalias", ""))
    if Ops.greater_than(Builtins.size(Ops.get_list(hw, "drivers", [])), 1)
      Builtins.y2milestone(
        "there are more modules available for device, hwcfg is needed"
      )
    else
      Builtins.y2milestone(
        "Just one autoloadable module available.No need to write hwcfg"
      )
      need = false
    end
  # not autoload because of built-in driver (compiled in kernel)
  elsif IsEmpty(Ops.get_string(hw, "driver_module", ""))
    Builtins.y2milestone(
      "built-in driver %1",
      Ops.get_string(hw, "driver", "")
    )
    need = false
  end
  need
end

- (Object) PackagesInstall(packages)

Check if required packages are installed and install them if they're not

Parameters:

  • packages (Array<String>)

    list of required packages ([“rpm”, “bash”])

Returns:

  • next if packages installation is successfull,abort otherwise



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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
# File '../../src/include/network/routines.rb', line 136

def PackagesInstall(packages)
  packages = deep_copy(packages)
  return :next if packages == []

  log.info "Checking packages: #{packages}"

  # bnc#888130 In inst-sys, there is no RPM database to check
  # If the required package is part of the inst-sys, it will work,
  # if not, package can't be installed anyway
  #
  # Ideas:
  # - check /.packages.* for presence of the required package
  # - use `extend` to load the required packages on-the-fly
  return :next if Stage.initial

  Yast.import "Package"
  return :next if Package.InstalledAll(packages)

  # Popup text
  text = _("These packages need to be installed:") + "<p>"
  Builtins.foreach(packages) do |l|
    text = Ops.add(text, Builtins.sformat("%1<br>", l))
  end
  Builtins.y2debug("Installing packages: %1", text)

  ret = false
  while true
    ret = Package.InstallAll(packages)
    break if ret == true

    if ret == false && Package.InstalledAll(packages)
      ret = true
      break
    end

    # Popup text
    if !Popup.YesNo(
        _(
          "The required packages are not installed.\n" +
            "The configuration will be aborted.\n" +
            "\n" +
            "Try again?\n"
        ) + "\n"
      )
      break
    end
  end

  ret == true ? :next : :abort
end

- (boolean) phy_connected?(dev_name)

Checks if device is physically connected to a network

It does neccessary steps which might be needed for proper initialization of devices driver.

Returns:

  • (boolean)

    true if physical layer is connected



978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
# File '../../src/include/network/routines.rb', line 978

def phy_connected?(dev_name)
  return true if has_carrier?(dev_name)

  # SetLinkUp ensures that driver is loaded
  SetLinkUp(dev_name)

  # Wait for driver initialization if needed. bnc#876848
  # 5 secs is minimum proposed by sysconfig guys for intel drivers.
  #
  # For a discussion regarding this see
  # https://github.com/yast/yast-network/pull/202
  sleep(5)

  has_carrier?(dev_name)
end

- (Object) PollAbort

Check for pending Abort press

Returns:

  • true if pending abort



72
73
74
# File '../../src/include/network/routines.rb', line 72

def PollAbort
  UI.PollInput == :abort
end

- (Object) ProgressNextStage(title)

Progress::NextStage and Progress::Title combined into one function

Parameters:

  • title (String)

    progressbar title



97
98
99
100
101
102
# File '../../src/include/network/routines.rb', line 97

def ProgressNextStage(title)
  Progress.NextStage
  Progress.Title(title)

  nil
end

- (Object) QueryWidgetIfExists(id, param, value)

Query UI widget only if it exists

Parameters:

  • id (Yast::Term)

    widget id

  • param (Symbol)

    widget parameter

  • value (Object)

    previous parameter value

Returns:

  • widget value if exists, previous value otherwise



125
126
127
128
129
130
131
# File '../../src/include/network/routines.rb', line 125

def QueryWidgetIfExists(id, param, value)
  id = deep_copy(id)
  value = deep_copy(value)
  return UI.QueryWidget(id, param) if UI.WidgetExists(id)
  Builtins.y2debug("Not changing: %1", id)
  deep_copy(value)
end

- (Object) ReadHardware(hwtype)

Read HW information

Parameters:

  • hwtype (String)

    type of devices to read (netcard|modem|isdn)

Returns:

  • array of hashes describing detected device



676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
# File '../../src/include/network/routines.rb', line 676

def ReadHardware(hwtype)
  _Hardware = []

  Builtins.y2debug("hwtype=%1", hwtype)

  # Confirmation: label text (detecting hardware: xxx)
  return [] if !confirmed_detection(hwtype)

  # read the corresponding hardware
  allcards = []
  if hwtypes[hwtype]
    allcards = Convert.to_list(SCR.Read(hwtypes[hwtype]))
  elsif hwtype == "all" || hwtype.nil? || hwtype.empty?
    Builtins.maplist(
      Convert.convert(
        Map.Values(hwtypes),
        :from => "list",
        :to   => "list <path>"
      )
    ) do |v|
      allcards = Builtins.merge(allcards, Convert.to_list(SCR.Read(v)))
    end
  else
    Builtins.y2error("unknown hwtype: %1", hwtype)
    return []
  end

  if allcards.nil?
    Builtins.y2error("hardware detection failure")
    return []
  end


  # #97540
  bms = Convert.to_string(SCR.Read(path(".etc.install_inf.BrokenModules")))
  bms = "" if bms == nil
  broken_modules = Builtins.splitstring(bms, " ")

  # fill in the hardware data
  num = 0
  Builtins.maplist(
    Convert.convert(allcards, :from => "list", :to => "list <map>")
  ) do |card|
    # common stuff
    resource = Ops.get_map(card, "resource", {})
    controller = ControllerType(card)

    one = {}
    one["name"] = DeviceName(card)
    # Temporary solution for s390: #40587
    one["name"] = DistinguishedName(one["name"], card) if Arch.s390
    one["type"] = controller
    one["udi"] = card["udi"] || ""
    one["sysfs_id"] = card["sysfs_id"] || ""
    one["dev_name"] = card["dev_name"] || ""
    one["requires"] = card["requires"] || []
    one["modalias"] = card["modalias"] || ""
    one["unique"] = card["unique_key"] || ""
    # driver option needs for (bnc#412248)
    one["driver"] = card["driver"] || ""
    # Each card remembers its position in the list of _all_ cards.
    # It is used when selecting the card from the list of _unconfigured_
    # ones (which may be smaller). #102945.
    one["num"] = num

    case controller
      # modem
      when "modem"
        one["device_name"] = card["dev_name"] || ""
        one["drivers"] = card["drivers"] || []

        speed = Ops.get_integer(resource, ["baud", 0, "speed"], 57600)
        # :-) have to check .probe and libhd if this confusion is
        # really necessary. maybe a pppd bug too? #148893
        speed = 57600 if speed == 12000000

        one["speed"] = speed
        one["init1"] = Ops.get_string(resource, ["init_strings", 0, "init1"], "")
        one["init2"] = Ops.get_string(resource, ["init_strings", 0, "init2"], "")
        one["pppd_options"] = Ops.get_string(resource, ["pppd_option", 0, "option"], "")

      # isdn card
      when "isdn"
        drivers = card["isdn"] || []
        one["drivers"] = drivers
        one["sel_drv"] = 0
        one["bus"] = card["bus"] || ""
        one["io"] = Ops.get_integer(resource, ["io", 0, "start"], 0)
        one["irq"] = Ops.get_integer(resource, ["irq", 0, "irq"], 0)

      # dsl card
      when "dsl"
        driver_info = Ops.get_map(card, ["dsl", 0], {})
        translate_mode = { "capiadsl" => "capi-adsl", "pppoe" => "pppoe" }
        m = driver_info["mode"] || ""
        one["pppmode"] = translate_mode[m] || m

      # treat the rest as a network card
      else
        # drivers:
        # Although normally there is only one module
        # (one=$[active:, module:, options:,...]), the generic
        # situation is: one or more driver variants (exclusive),
        # each having one or more modules (one[drivers])

        # only drivers that are not marked as broken (#97540)
        drivers = Builtins.filter(Ops.get_list(card, "drivers", [])) do |d|
          # ignoring more modules per driver...
          module0 = Ops.get_list(d, ["modules", 0], []) # [module, options]
          brk = broken_modules.include?(module0[0])

          if brk
            Builtins.y2milestone("In BrokenModules, skipping: %1", module0)
          end

          !brk
        end

        if drivers == []
          Builtins.y2milestone("No good drivers found")
        else
          one["drivers"] = drivers

          driver = drivers[0] || {}
          one["active"] = driver["active"] || false
          module0 = Ops.get_list(driver, ["modules", 0], [])
          one["module"] = module0[0] || ""
          one["options"] = module0[1] || ""
        end

        # FIXME: this should be also done for modems and others
        # FIXME: #13571
        hp = card["hotplug"] || ""
        if hp == "pcmcia" || hp == "cardbus"
          one["hotplug"] = "pcmcia"
        elsif hp == "usb"
          one["hotplug"] = "usb"
        end

        # store the BUS type
        bus = card["bus_hwcfg"] || card["bus"] || ""

        if bus == "PCI"
          bus = "pci"
        elsif bus == "USB"
          bus = "usb"
        elsif bus == "Virtual IO"
          bus = "vio"
        end

        one["bus"] = bus
        one["busid"] = card["sysfs_bus_id"] || ""
        one["mac"] = Ops.get_string(resource, ["hwaddr", 0, "addr"], "")
        # is the cable plugged in? nil = don't know
        one["link"] = Ops.get(resource, ["link", 0, "state"])

        # Wireless Card Features
        one["wl_channels"] = Ops.get(resource, ["wlan", 0, "channels"])
        one["wl_bitrates"] = Ops.get(resource, ["wlan", 0, "bitrates"])
        one["wl_auth_modes"] = Ops.get(resource, ["wlan", 0, "auth_modes"])
        one["wl_enc_modes"] = Ops.get(resource, ["wlan", 0, "enc_modes"])
      end

      if controller != "" && !filter_out(card, one["module"])
        Builtins.y2debug("found device: %1", one)

        Ops.set(_Hardware, Builtins.size(_Hardware), one)
        num = num + 1
      else
        Builtins.y2milestone("Filtering out: %1", card)
      end
  end

  # if there is wlan, put it to the front of the list
  # that's because we want it proposed and currently only one card
  # can be proposed
  found = false
  i = 0
  Builtins.foreach(_Hardware) do |h|
    if h["type"] == "wlan"
      found = true
      raise Break
    end
    i = i + 1
  end

  if found
    temp = _Hardware[0] || {}
    _Hardware[0] = _Hardware[i]
    _Hardware[i] = temp
    # adjust mapping: #98852, #102945
    Ops.set(_Hardware, [0, "num"], 0)
    Ops.set(_Hardware, [i, "num"], i)
  end

  Builtins.y2debug("Hardware=%1", _Hardware)
  deep_copy(_Hardware)
end

- (Object) ReallyAbort

If modified, ask for confirmation

Returns:

  • true if abort is confirmed



78
79
80
81
82
83
# File '../../src/include/network/routines.rb', line 78

def ReallyAbort
  Popup.ReallyAbort(true) 

  # FIXME: NI
  # return !Modified() || Popup::ReallyAbort(true);
end

- (Object) ReallyAbortCond(modified)

If modified, ask for confirmation

Parameters:

  • modified (Boolean)

    true if modified

Returns:

  • true if abort is confirmed



88
89
90
91
92
93
# File '../../src/include/network/routines.rb', line 88

def ReallyAbortCond(modified)
  !modified || Popup.ReallyAbort(true) 

  # FIXME: NI
  # return (!modified && !Modified()) || Popup::ReallyAbort(true);
end

- (Object) Run(command)

Returns whether command execution succeeds

Parameters:

  • Shell

    command to run

Returns:

  • whether command execution succeeds



910
911
912
913
914
915
916
# File '../../src/include/network/routines.rb', line 910

def Run(command)
  ret = SCR.Execute(path(".target.bash"), command) == 0

  Builtins.y2error("Run <%1>: Command execution failed.", command) if !ret

  ret
end

- (Object) RunAndRead(command)

Returns Hash in form $[ “exit”: <command-exit-status>, “output”: [ <1st line>, <2nd line>, … ] ]

Parameters:

  • Shell

    command to run

Returns:

  • Hash in form $[ “exit”: <command-exit-status>, “output”: [ <1st line>, <2nd line>, … ] ]



880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
# File '../../src/include/network/routines.rb', line 880

def RunAndRead(command)
  ret = { "exit" => false, "output" => [] }
  result = Convert.to_map(SCR.Execute(path(".target.bash_output"), command))
  output = Ops.get_string(result, "stdout", "")

  if Builtins.regexpmatch(output, ".*\n$")
    output = Builtins.substring(
      output,
      0,
      Ops.subtract(Builtins.size(output), 1)
    )
  end

  Ops.set(ret, "output", Builtins.splitstring(output, "\n"))
  Ops.set(ret, "exit", Ops.get_integer(result, "exit", 1) == 0)

  if Ops.get_boolean(ret, "exit", false) == false ||
      IsEmpty(Ops.get_string(result, "stderr", "")) == false
    Builtins.y2error(
      "RunAndRead <%1>: Command execution failed.\n%2",
      command,
      Ops.get_string(result, "stderr", "")
    )
  end

  deep_copy(ret)
end

- (Object) s390_device_needs_persistent_mac(sysfs_id, hardware)



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
# File '../../src/include/network/routines.rb', line 424

def s390_device_needs_persistent_mac(sysfs_id, hardware)
  hardware = deep_copy(hardware)
  card_type = sysfs_card_type(sysfs_id, hardware)
  types_needing_persistent = [
    "OSD_100",
    "OSD_1000",
    "OSD_10GIG",
    "OSD_FE_LANE",
    "OSD_GbE_LANE",
    "OSD_Express"
  ]
  needs_persistent = Builtins.contains(types_needing_persistent, card_type)
  Builtins.y2milestone(
    "Sysfs Device: %1, card type: %2, needs persistent MAC: %3",
    sysfs_id,
    card_type,
    needs_persistent
  )
  needs_persistent
end

- (boolean) SetAllLinksDown

Tries to set all available interfaces down

Returns:

  • (boolean)

    false if some of interfaces cannot be set down



954
955
956
957
958
959
960
# File '../../src/include/network/routines.rb', line 954

def SetAllLinksDown
  interfaces = GetAllInterfaces()

  return false if interfaces.empty?

  interfaces.all? { |i| SetLinkDown(i) }
end

- (boolean) SetAllLinksUp

Tries to set all available interfaces up

Returns:

  • (boolean)

    false if some of interfaces cannot be set up



943
944
945
946
947
948
949
# File '../../src/include/network/routines.rb', line 943

def SetAllLinksUp
  interfaces = GetAllInterfaces()

  return false if interfaces.empty?

  interfaces.all? { |i| SetLinkUp(i) }
end

- (Object) SetLinkDown(dev_name)



935
936
937
938
# File '../../src/include/network/routines.rb', line 935

def SetLinkDown(dev_name)
  log.info("Setting link down for interface #{dev_name}")
  Run("ip link set #{dev_name} down")
end

- (Object) SetLinkUp(dev_name)



930
931
932
933
# File '../../src/include/network/routines.rb', line 930

def SetLinkUp(dev_name)
  log.info("Setting link up for interface #{dev_name}")
  Run("ip link set #{dev_name} up")
end

- (Object) sysfs_card_type(sysfs_id, hardware)



416
417
418
419
420
421
422
# File '../../src/include/network/routines.rb', line 416

def sysfs_card_type(sysfs_id, hardware)
  hardware = deep_copy(hardware)
  return "none" if sysfs_id == ""
  filename = Ops.add(Ops.add("/sys", sysfs_id), "/card_type")
  card_type = Convert.to_string(SCR.Read(path(".target.string"), filename))
  String.FirstChunk(card_type, "\n")
end

- (Boolean) unconfigureable_service?

Returns:

  • (Boolean)


1011
1012
1013
1014
1015
1016
# File '../../src/include/network/routines.rb', line 1011

def unconfigureable_service?
  return true if Mode.normal && NetworkService.is_network_manager
  return true if NetworkService.is_disabled

  return false
end

- (Object) UsedNicName(name)

Checks if device with the given name is configured already.



525
526
527
# File '../../src/include/network/routines.rb', line 525

def UsedNicName(name)
  Builtins.contains(NetworkInterfaces.List(""), name)
end

- (Object) ValidNicName(name)

Validates given name for use as a nic name in sysconfig. See bnc#784952



517
518
519
520
521
522
# File '../../src/include/network/routines.rb', line 517

def ValidNicName(name)
  # 16 is the kernel limit on interface name size (IFNAMSIZ)
  return false if !Builtins.regexpmatch(name, "^[[:alnum:]._:-]{1,15}$")

  true
end

- (Object) validPrefixOrNetmask(ip, mask)



994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
# File '../../src/include/network/routines.rb', line 994

def validPrefixOrNetmask(ip, mask)
  valid_mask = false
  if Builtins.substring(mask, 0, 1) == "/"
    mask = Builtins.substring(mask, 1)
  end

  if IP.Check4(ip) && (Netmask.Check4(mask) || Netmask.CheckPrefix4(mask))
    valid_mask = true
  elsif IP.Check6(ip) && Netmask.Check6(mask)
    valid_mask = true
  else
    Builtins.y2warning("IP address %1 is not valid", ip)
  end
  valid_mask
end