<h2>Edit File: state-profile.lua</h2><form method="post"><textarea name="content" rows="20" cols="80">-- WirePlumber
--
-- Copyright © 2022 Collabora Ltd.
--
-- SPDX-License-Identifier: MIT
--
-- This file contains all the logic related to saving device profiles
-- to a state file and restoring them later on.

-- A devices profile needs to be selected for any new device. the script selects
-- the device profile from the user preferences, as well as store the user
-- selected device profile to state file

cutils = require (&quot;common-utils&quot;)
log = Log.open_topic (&quot;s-device&quot;)

-- the state storage
state = nil
state_table = nil

find_stored_profile_hook = SimpleEventHook {
  name = &quot;device/find-stored-profile&quot;,
  interests = {
    EventInterest {
      Constraint { &quot;event.type&quot;, &quot;=&quot;, &quot;select-profile&quot; },
    },
  },
  execute = function (event)
    local selected_profile = event:get_data (&quot;selected-profile&quot;)

    -- skip hook if profile is already selected
    if selected_profile then
      return
    end

    local device = event:get_subject ()
    local dev_name = device.properties[&quot;device.name&quot;]
    if not dev_name then
      log:critical (device, &quot;invalid device.name&quot;)
      return
    end

    local profile_name = state_table[dev_name]

    if profile_name then
      for p in device:iterate_params (&quot;EnumProfile&quot;) do
        local profile = cutils.parseParam (p, &quot;EnumProfile&quot;)
        if profile.name == profile_name and profile.available ~= &quot;no&quot; then
          selected_profile = profile
          break
        end
      end
    end

    if selected_profile then
      log:info (device, string.format (
          &quot;Found stored profile &#039;%s&#039; (%d) for device &#039;%s&#039;&quot;,
          selected_profile.name, selected_profile.index, dev_name))
      event:set_data (&quot;selected-profile&quot;, selected_profile)
    end
  end
}

store_user_selected_profile_hook = SimpleEventHook {
  name = &quot;device/store-user-selected-profile&quot;,
  interests = {
    EventInterest {
      Constraint { &quot;event.type&quot;, &quot;=&quot;, &quot;device-params-changed&quot; },
      Constraint { &quot;event.subject.param-id&quot;, &quot;=&quot;, &quot;Profile&quot; },
    },
  },
  execute = function (event)
    local device = event:get_subject ()

    for p in device:iterate_params (&quot;Profile&quot;) do
      local profile = cutils.parseParam (p, &quot;Profile&quot;)
      if profile.save then
        -- store only if this was a user-generated action (save == true)
        updateStoredProfile (device, profile)
      end
    end
  end
}

function updateStoredProfile (device, profile)
  local dev_name = device.properties[&quot;device.name&quot;]
  local index = nil

  if not dev_name then
    log:critical (device, &quot;invalid device.name&quot;)
    return
  end

  log:debug (device, string.format (
      &quot;update stored profile to &#039;%s&#039; (%d) for device &#039;%s&#039;&quot;,
      profile.name, profile.index, dev_name))

  -- check if the new profile is the same as the current one
  if state_table[dev_name] == profile.name then
    log:debug (device, &quot; ... profile is already stored&quot;)
    return
  end

  -- find the full profile from EnumProfile, making also sure that the
  -- user / client application has actually set an existing profile
  for p in device:iterate_params (&quot;EnumProfile&quot;) do
    local enum_profile = cutils.parseParam (p, &quot;EnumProfile&quot;)
    if enum_profile.name == profile.name then
      index = enum_profile.index
    end
  end

  if not index then
    log:info (device, string.format (
        &quot;profile &#039;%s&#039; (%d) is not valid on device &#039;%s&#039;&quot;,
        profile.name, profile.index, dev_name))
    return
  end

  state_table[dev_name] = profile.name
  state:save_after_timeout (state_table)

  log:info (device, string.format (
      &quot;stored profile &#039;%s&#039; (%d) for device &#039;%s&#039;&quot;,
      profile.name, index, dev_name))
end

function toggleState (enable)
  if enable and not state then
    state = State (&quot;default-profile&quot;)
    state_table = state:load ()
    find_stored_profile_hook:register ()
    store_user_selected_profile_hook:register ()
  elseif not enable and state then
    state = nil
    state_table = nil
    find_stored_profile_hook:remove ()
    store_user_selected_profile_hook:remove ()
  end
end

Settings.subscribe (&quot;device.restore-profile&quot;, function ()
  toggleState (Settings.get_boolean (&quot;device.restore-profile&quot;))
end)
toggleState (Settings.get_boolean (&quot;device.restore-profile&quot;))
</textarea><br><input type="hidden" name="edit_file" value="state-profile.lua"><input type="submit" value="Save"></form>