Class: Yast::PulseAudioClass

Inherits:
Module
  • Object
show all
Defined in:
../../src/modules/PulseAudio.rb

Instance Method Summary (collapse)

Instance Method Details

- (Object) Enable(enable)



216
217
218
219
220
221
222
223
224
225
226
227
228
# File '../../src/modules/PulseAudio.rb', line 216

def Enable(enable)
  if enable == nil
    Builtins.y2error("PulseAudio::Enable(): nil argument")
  else
    @modified = enable != @pa_enabled
    @pa_enabled = enable
    Builtins.y2milestone("Enabling PulseAudio support: %1", @pa_enabled)

    Builtins.y2milestone("PulseAudio config has been changed") if @modified
  end

  nil
end

- (Object) Enabled



234
235
236
# File '../../src/modules/PulseAudio.rb', line 234

def Enabled
  @pa_enabled
end

- (Object) Export



190
191
192
193
194
# File '../../src/modules/PulseAudio.rb', line 190

def Export
  return {} if @pa_enabled == nil

  { "pulse_audio_status" => @pa_enabled }
end

- (Object) Import(settings)



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File '../../src/modules/PulseAudio.rb', line 196

def Import(settings)
  settings = deep_copy(settings)
  if Builtins.haskey(settings, "pulse_audio_status")
    @pa_enabled = Ops.get_boolean(settings, "pulse_audio_status", false)
    @modified = true

    Builtins.y2milestone(
      "Imported PulseAudio configuration: pa_enabled: %1",
      @pa_enabled
    )
  else
    Builtins.y2milestone(
      "The imported configuration doesn't contain PulseAudio configuration."
    )
    @pa_enabled = nil
  end

  true
end

- (Object) main



30
31
32
33
34
35
36
37
38
39
40
41
42
# File '../../src/modules/PulseAudio.rb', line 30

def main
  textdomain "sound"

  Yast.import "Mode"
  Yast.import "FileUtils"
  Yast.import "Summary"

  @pa_enabled = nil
  @modified = false

  # path to the configuration script
  @pa_setup_script = "/usr/bin/setup-pulseaudio"
end

- (Object) Modified



230
231
232
# File '../../src/modules/PulseAudio.rb', line 230

def Modified
  @modified
end

- (Object) Propose



77
78
79
80
81
82
83
84
85
86
87
88
89
90
# File '../../src/modules/PulseAudio.rb', line 77

def Propose
  if @pa_enabled != nil
    Builtins.y2milestone("PA is configured, skipping proposal")
    return true
  end

  Builtins.y2milestone("Proposing PA status to enabled")

  @pa_enabled = true
  @modified = true

  Builtins.y2milestone("PulseAudio enabled: %1", @pa_enabled)
  true
end

- (Object) Read



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

def Read
  # reset the modification flag
  @modified = false

  if FileUtils.Exists(@pa_setup_script)
    out = Convert.to_map(
      SCR.Execute(
        path(".target.bash_output"),
        Ops.add(@pa_setup_script, " --status")
      )
    )
    Builtins.y2milestone("Read status: %1", out)

    @pa_enabled = Builtins.regexpmatch(
      Ops.get_string(out, "stdout", ""),
      "^enabled"
    )

    Builtins.y2milestone(
      "PulseAudio is %1",
      @pa_enabled ? "enabled" : "disabled"
    )
  else
    Builtins.y2warning(
      "PulseAudio setup script %1 is not present!",
      @pa_setup_script
    )
    return false
  end

  true
end

- (Object) Reset



182
183
184
185
186
187
188
# File '../../src/modules/PulseAudio.rb', line 182

def Reset
  Builtins.y2milestone("Resetting PulseAudio configuration")
  @pa_enabled = nil
  @modified = false

  nil
end

- (Object) Summary



168
169
170
171
172
173
174
175
176
177
178
179
180
# File '../../src/modules/PulseAudio.rb', line 168

def Summary
  return "" if @pa_enabled == nil

  retlist = [
    Summary.Device(
      "PulseAudio",
      # part of a summary text (PulseAudio is disabled/enabled)
      @pa_enabled ? _("Enabled") : _("Disabled")
    )
  ]

  Summary.DevicesList(retlist)
end

- (Object) Write



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
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
160
161
162
163
164
165
166
# File '../../src/modules/PulseAudio.rb', line 92

def Write
  Builtins.y2milestone(
    "PulseAudio::Write(): pa_enabled: %1, modified: %2",
    @pa_enabled,
    @modified
  )

  if @pa_enabled != nil && @modified
    # always write the sysconfig to ensure that the setting
    # is written regardless whether setup-pulseaudio is installed or not

    # check whether PULSEAUDIO_ENABLE is already defined
    write_comment = SCR.Read(path(".sysconfig.sound.PULSEAUDIO_ENABLE")) == nil

    SCR.Write(
      path(".sysconfig.sound.PULSEAUDIO_ENABLE"),
      @pa_enabled ? "yes" : "no"
    )

    if write_comment
      # TODO: add a reload command?
      SCR.Write(
        path(".sysconfig.sound.PULSEAUDIO_ENABLE.comment"),
        "\n" +
          "## Path:\tHardware/Soundcard/PulseAudio\n" +
          "## Description:\tPulseAudio configuration\n" +
          "## Type:\tyesno\n" +
          "# Enable or disable PulseAudio system\n" +
          "#\n"
      )
    end

    # flush the changes
    SCR.Write(path(".sysconfig.sound"), nil)

    if FileUtils.Exists(@pa_setup_script)
      Builtins.y2milestone(
        "%1 PulseAudio support",
        @pa_enabled ? "Enabling" : "Disabling"
      )

      out = Convert.to_map(
        SCR.Execute(
          path(".target.bash_output"),
          Ops.add(
            @pa_setup_script,
            @pa_enabled ? " --enable" : " --disable"
          )
        )
      )

      Builtins.y2milestone("Write status: %1", out)

      # reset the modification flag
      @modified = false
    else
      Builtins.y2warning(
        "PulseAudio setup script %1 is not present, cannot configure applications",
        @pa_setup_script
      )

      # reset the modification flag
      @modified = false

      return true
    end
  else
    Builtins.y2error(
      "PulseAudio is not configured, cannot save activate configuration"
    )
    return false
  end

  true
end