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
SYSTEMCTL =
"/bin/systemctl".freeze
WICKED =
"/usr/sbin/wicked".freeze
DEFAULT_BACKEND =
:wicked

Instance Method Summary collapse

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)


124
125
126
# File 'library/network/src/modules/NetworkService.rb', line 124

def backend_available?(backend)
  PackageSystem.Installed(BACKEND_PKG_NAMES[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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
# File 'library/network/src/modules/NetworkService.rb', line 266

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



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

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

  Read()
end

#disabled?Boolean Also known as: is_disabled

Returns:

  • (Boolean)


152
153
154
# File 'library/network/src/modules/NetworkService.rb', line 152

def disabled?
  cached_service?(nil)
end

#EnableDisableNowObject

Helper to apply a change of the network service



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

def EnableDisableNow
  return if !Modified()

  stop_service(@current_name)
  disable_service(@current_name)

  RunSystemCtl(BACKENDS[@cached_name], "--force enable")

  @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



226
227
228
# File 'library/network/src/modules/NetworkService.rb', line 226

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

#isNetworkRunningObject



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

def isNetworkRunning
  isNetworkv4Running || isNetworkv6Running
end

#isNetworkv4RunningObject

test for IPv4



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
# File 'library/network/src/modules/NetworkService.rb', line 292

def isNetworkv4Running
  net = Convert.to_integer(
    SCR.Execute(
      path(".target.bash"),
      "ip addr|grep -v '127.0.0\\|inet6'|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



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
# File 'library/network/src/modules/NetworkService.rb', line 309

def isNetworkv6Running
  net = Convert.to_integer(
    SCR.Execute(
      path(".target.bash"),
      "ip addr|grep -v 'inet6 ::1\\|inet6 fe80'|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



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

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

  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



118
119
120
121
# File 'library/network/src/modules/NetworkService.rb', line 118

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

#netconfig?Boolean Also known as: is_netconfig

Returns:

  • (Boolean)


140
141
142
# File 'library/network/src/modules/NetworkService.rb', line 140

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



134
135
136
# File 'library/network/src/modules/NetworkService.rb', line 134

def network_manager?
  cached_service?(:network_manager)
end

#ReadObject

Initialize module data



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
# File 'library/network/src/modules/NetworkService.rb', line 189

def Read
  return if @initialized

  if Stage.initial
    @current_name = DEFAULT_BACKEND
    log.info "Running in installer/AutoYaST, use default: #{@current_name}"
  else
    service = SystemdService.find("network")
    @current_name = BACKENDS.invert[service.name] if service
  end

  @cached_name = @current_name

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

  nil
end

#ReloadOrRestartObject

Reload or restars the network service.



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

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

#RestartObject

Restarts the network service



242
243
244
245
246
247
248
249
250
# File 'library/network/src/modules/NetworkService.rb', line 242

def Restart
  if Stage.initial
    wicked_restart
  else
    systemctl_restart
  end

  nil
end

#run_wicked(*params) ⇒ Object



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

def run_wicked(*params)
  cmd = "#{WICKED} #{params.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



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
# File 'library/network/src/modules/NetworkService.rb', line 328

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) ⇒ Object

Helper to run systemctl actions

Returns:

  • exit code



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

def RunSystemCtl(service, action)
  cmd = Builtins.sformat("%1 %2 %3.service", SYSTEMCTL, action, service)
  ret = Convert.convert(
    SCR.Execute(path(".target.bash_output"), cmd, "TERM" => "raw"),
    from: "any",
    to:   "map <string, any>"
  )
  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



253
254
255
256
257
# File 'library/network/src/modules/NetworkService.rb', line 253

def StartStop
  ReloadOrRestart()

  nil
end

#use_netconfigObject



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

def use_netconfig
  Read()
  @cached_name = :netconfig

  nil
end

#use_network_managerObject



158
159
160
161
162
163
# File 'library/network/src/modules/NetworkService.rb', line 158

def use_network_manager
  Read()
  @cached_name = :network_manager

  nil
end

#use_wickedObject



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

def use_wicked
  Read()
  @cached_name = :wicked

  nil
end

#wicked?Boolean Also known as: is_wicked

Returns:

  • (Boolean)


146
147
148
# File 'library/network/src/modules/NetworkService.rb', line 146

def wicked?
  cached_service?(:wicked)
end