Class: Yast::NetworkServiceClass

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

Constant Summary collapse

BACKENDS =

network backend identification to service name mapping

{
  # <internal-id>        <service name>
  netconfig:       "network",
  network_manager: "NetworkManager",
  wicked:          "wicked"
}.freeze
BACKEND_PKG_NAMES =

network backend identification to its rpm package name mapping

{
  # <internal-id>        <service name>
  netconfig:       "sysconfig-network",
  network_manager: "NetworkManager",
  wicked:          "wicked"
}.freeze
DEFAULT_BACKEND =
:wicked

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#cached_nameObject

Replies with currently selected network service name

Currently known backends:

  • :network_manager - not supported by YaST
  • :netconfig - supported
  • :wicked - supported (via its backward compatibility to ifup)

395
396
397
398
# File 'library/network/src/modules/NetworkService.rb', line 395

def cached_name
  Read()
  @cached_name
end

#current_nameObject

return [String, nil] current network backend identification, nil is valid value for "no service selected / running"


49
50
51
# File 'library/network/src/modules/NetworkService.rb', line 49

def current_name
  @current_name
end

Instance Method Details

#backend_available?(backend) ⇒ Boolean Also known as: is_backend_available

Checks if given network backend is available in the system

Returns:

  • (Boolean)

126
127
128
# File 'library/network/src/modules/NetworkService.rb', line 126

def backend_available?(backend)
  PackageSystem.Installed(BACKEND_PKG_NAMES[backend])
end

#backend_in_useSymbol?

Determines which backend is in use based on the network service. In an (auto)installation it returns the default backend except if systemd is running (live) where the systemd service can be checked.

Returns:

  • (Symbol, nil)

    backend in use or nil


208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'library/network/src/modules/NetworkService.rb', line 208

def backend_in_use
  backend = nil

  if Stage.initial && !Systemd.Running
    backend = DEFAULT_BACKEND
    log.info "Running in installer/AutoYaST, use default: #{backend}"
  else
    service = Yast2::Systemd::Service.find("network")
    backend = BACKENDS.invert[service.name] if service
  end

  backend
end

#ConfirmNetworkManagerBoolean

Opens up a continue/cancel confirmation popup in the case when NetworkManager is enabled. User is informed that continuing the configuration may produce undefined results. If NetworkManager is not used, silently returns true.

Returns:

  • (Boolean)

    continue


300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
# File 'library/network/src/modules/NetworkService.rb', line 300

def ConfirmNetworkManager
  return true if @already_asked_for_NetworkManager || !network_manager?

  # TRANSLATORS: pop-up question when reading the service configuration
  cont = Popup.ContinueCancel(
    _(
      "Your network interfaces are currently controlled by NetworkManager\n" \
        "but the service to configure might not work well with it.\n" \
        "\n" \
        "Really continue?"
    )
  )
  Builtins.y2milestone(
    "Network is controlled by NetworkManager, user decided %1...",
    cont ? "to continue" : "not to continue"
  )
  @already_asked_for_NetworkManager = true

  cont
end

#disableObject

disables network service completely


195
196
197
198
199
200
201
# File 'library/network/src/modules/NetworkService.rb', line 195

def disable
  @cached_name = nil
  stop_service(@current_name)
  disable_service(@current_name)

  Read()
end

#disabled?Boolean Also known as: is_disabled

Returns:

  • (Boolean)

154
155
156
# File 'library/network/src/modules/NetworkService.rb', line 154

def disabled?
  cached_service?(nil)
end

#EnableDisableNowObject

Helper to apply a change of the network service


241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
# File 'library/network/src/modules/NetworkService.rb', line 241

def EnableDisableNow
  return if !Modified()

  if current_name
    stop_service(current_name)
    disable_service(current_name)
  end

  enable_service(cached_name) if cached_name

  @initialized = false
  Read()

  nil
end

#IsActiveObject

Reports if network service is active or not. It does not report if network is connected.

Returns:

  • true when network service is active


260
261
262
# File 'library/network/src/modules/NetworkService.rb', line 260

def IsActive
  RunSystemCtl("network", "is-active") == 0
end

#isNetworkRunningObject


321
322
323
# File 'library/network/src/modules/NetworkService.rb', line 321

def isNetworkRunning
  isNetworkv4Running || isNetworkv6Running
end

#isNetworkv4RunningObject

test for IPv4


326
327
328
329
330
331
332
333
334
335
336
337
338
# File 'library/network/src/modules/NetworkService.rb', line 326

def isNetworkv4Running
  net = SCR.Execute(
    path(".target.bash"),
    "/bin/ip addr | /usr/bin/grep -v '127.0.0\\|inet6' | /usr/bin/grep -c inet"
  )
  if net == 0
    Builtins.y2milestone("IPv4 network is running ...")
    return true
  else
    Builtins.y2milestone("IPv4 network is not running ...")
    return false
  end
end

#isNetworkv6RunningObject

test for IPv6


341
342
343
344
345
346
347
348
349
350
351
352
353
354
# File 'library/network/src/modules/NetworkService.rb', line 341

def isNetworkv6Running
  net = SCR.Execute(
    path(".target.bash"),
    "/bin/ip addr | /usr/bin/grep -v 'inet6 ::1\\|inet6 fe80' | /usr/bin/grep -c inet6"
  )

  if net == 0
    Builtins.y2milestone("IPv6 network is running ...")
    return true
  else
    Builtins.y2milestone("IPv6 network is not running ...")
    return false
  end
end

#mainObject


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# File 'library/network/src/modules/NetworkService.rb', line 73

def main
  Yast.import "NetworkConfig"
  Yast.import "Popup"
  Yast.import "Mode"
  Yast.import "Stage"
  Yast.import "PackageSystem"
  Yast.import "Systemd"

  textdomain "base"

  # if false, read needs to do work
  @initialized = false

  # Variable remembers that the question has been asked during this run already.
  # It avoids useless questions over and over again.
  @already_asked_for_NetworkManager = false
end

#ModifiedObject

Whether a network service change were requested

Returns:

  • true when service change were requested


120
121
122
123
# File 'library/network/src/modules/NetworkService.rb', line 120

def Modified
  Read()
  @cached_name != @current_name
end

#netconfig?Boolean Also known as: is_netconfig

Returns:

  • (Boolean)

142
143
144
# File 'library/network/src/modules/NetworkService.rb', line 142

def netconfig?
  cached_service?(:netconfig)
end

#network_manager?Boolean Also known as: is_network_manager

Checks if configuration is managed by NetworkManager

Returns:

  • (Boolean)

    true when the network is managed by an external tool, like NetworkManager, false otherwise


136
137
138
# File 'library/network/src/modules/NetworkService.rb', line 136

def network_manager?
  cached_service?(:network_manager)
end

#ReadObject

Initialize module data


223
224
225
226
227
228
229
230
231
232
# File 'library/network/src/modules/NetworkService.rb', line 223

def Read
  return if @initialized

  @cached_name = @current_name = backend_in_use

  log.info "Current backend: #{@current_name}"
  @initialized = true

  nil
end

#ReloadOrRestartObject

Reload or restars the network service.


265
266
267
268
269
270
271
272
273
# File 'library/network/src/modules/NetworkService.rb', line 265

def ReloadOrRestart
  if Stage.initial
    # inst-sys is not running systemd nor sysV init, so systemctl call
    # is not available and service has to be restarted directly
    wicked_restart
  else
    systemctl_reload_restart
  end
end

#reset!Object


234
235
236
237
238
# File 'library/network/src/modules/NetworkService.rb', line 234

def reset!
  @initialized = false
  @current_name = nil
  @cached_name = nil
end

#RestartObject

Restarts the network service


276
277
278
279
280
281
282
283
284
# File 'library/network/src/modules/NetworkService.rb', line 276

def Restart
  if Stage.initial
    wicked_restart
  else
    systemctl_restart
  end

  nil
end

#run_wicked(*params) ⇒ Object


108
109
110
111
112
113
114
115
116
# File 'library/network/src/modules/NetworkService.rb', line 108

def run_wicked(*params)
  cmd = "/usr/sbin/wicked #{params.map(&:shellescape).join(" ")}"
  ret = SCR.Execute(
    path(".target.bash"),
    cmd
  )

  Builtins.y2milestone("run_wicked: #{cmd} -> #{ret}")
end

#RunningNetworkPopupObject

If there is network running, return true. Otherwise show error popup depending on Stage and return false

Returns:

  • true if network running


359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
# File 'library/network/src/modules/NetworkService.rb', line 359

def RunningNetworkPopup
  network_running = isNetworkRunning

  log.info "RunningNetworkPopup #{network_running}"

  return true if network_running

  error_text = if Stage.initial
    _(
      "No running network detected.\n" \
      "Restart installation and configure network in Linuxrc\n" \
      "or continue without network."
    )
  else
    _(
      "No running network detected.\n" \
      "Configure network with YaST or Network Manager plug-in\n" \
      "and start this module again\n" \
      "or continue without network."
    )
  end

  ret = Popup.ContinueCancel(error_text)

  log.error "Network not runing!"
  ret
end

#RunSystemCtl(service, action, force: false) ⇒ Object

Helper to run systemctl actions

Parameters:

  • service (String)

    name of service

  • action (String)

    action what to do with service

  • force (Boolean) (defaults to: false)

    if action should be forced

Returns:

  • exit code

Raises:

  • (ArgumentError)

96
97
98
99
100
101
102
103
104
105
106
# File 'library/network/src/modules/NetworkService.rb', line 96

def RunSystemCtl(service, action, force: false)
  raise ArgumentError, "No network service defined." if service.nil?

  cmd = "/usr/bin/systemctl "\
    "#{force ? "--force" : ""} " \
    "#{action.shellescape} " \
    "#{service.shellescape}.service"
  ret = SCR.Execute(path(".target.bash_output"), cmd, "TERM" => "raw")
  Builtins.y2debug("RunSystemCtl: Command '%1' returned '%2'", cmd, ret)
  Ops.get_integer(ret, "exit", -1)
end

#StartStopObject

This is an old, confusing name for ReloadOrRestart() now


287
288
289
290
291
# File 'library/network/src/modules/NetworkService.rb', line 287

def StartStop
  ReloadOrRestart()

  nil
end

#use(name) ⇒ Object

Choose the given backend as the one to be used

Parameters:

  • name (Symbol)

    backend name

  • return (Boolean)

    whether the given backend was selected or not


164
165
166
167
168
169
170
171
# File 'library/network/src/modules/NetworkService.rb', line 164

def use(name)
  return false unless BACKENDS.key?(name)

  Read()
  @cached_name = name

  true
end

#use_netconfigObject


180
181
182
183
184
185
# File 'library/network/src/modules/NetworkService.rb', line 180

def use_netconfig
  Read()
  @cached_name = :netconfig

  nil
end

#use_network_managerObject


173
174
175
176
177
178
# File 'library/network/src/modules/NetworkService.rb', line 173

def use_network_manager
  Read()
  @cached_name = :network_manager

  nil
end

#use_wickedObject


187
188
189
190
191
192
# File 'library/network/src/modules/NetworkService.rb', line 187

def use_wicked
  Read()
  @cached_name = :wicked

  nil
end

#wicked?Boolean Also known as: is_wicked

Returns:

  • (Boolean)

148
149
150
# File 'library/network/src/modules/NetworkService.rb', line 148

def wicked?
  cached_service?(:wicked)
end