Skip to content

dbus: dedup result conversion code #493

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Luap99 merged 1 commit into from
Jan 21, 2026
+31 −177
Merged

dbus: dedup result conversion code #493

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
208 changes: 31 additions & 177 deletions dbus/methods.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,30 +397,33 @@ type UnitStatus struct {

type storeFunc func(retvalues ...any) error

func (c *Conn) listUnitsInternal(f storeFunc) ([]UnitStatus, error) {
result := make([][]any, 0)
err := f(&result)
if err != nil {
return nil, err
// convertSlice converts a []any result into a slice of the target type T
// using dbus.Store to handle the type conversion.
func convertSlice[T any](result []any) ([]T, error) {
converted := make([]T, len(result))
convertedInterface := make([]any, len(converted))
for i := range converted {
convertedInterface[i] = &converted[i]
}

resultInterface := make([]any, len(result))
for i := range result {
resultInterface[i] = result[i]
err := dbus.Store(result, convertedInterface...)
if err != nil {
return nil, err
}

status := make([]UnitStatus, len(result))
statusInterface := make([]any, len(status))
for i := range status {
statusInterface[i] = &status[i]
}
return converted, nil
}

err = dbus.Store(resultInterface, statusInterface...)
// storeSlice fetches D-Bus array results via the provided storeFunc
// and converts them into a slice of the target type T.
func storeSlice[T any](f storeFunc) ([]T, error) {
var result []any
err := f(&result)
if err != nil {
return nil, err
}

return status, nil
return convertSlice[T](result)
}

// GetUnitByPID returns the unit object path of the unit a process ID
Expand Down Expand Up @@ -457,7 +460,7 @@ func (c *Conn) ListUnits() ([]UnitStatus, error) {
// Also note that a unit is only loaded if it is active and/or enabled.
// Units that are both disabled and inactive will thus not be returned.
func (c *Conn) ListUnitsContext(ctx context.Context) ([]UnitStatus, error) {
return c.listUnitsInternal(c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.ListUnits", 0).Store)
return storeSlice[UnitStatus](c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.ListUnits", 0).Store)
}

// Deprecated: use ListUnitsFilteredContext instead.
Expand All @@ -468,7 +471,7 @@ func (c *Conn) ListUnitsFiltered(states []string) ([]UnitStatus, error) {
// ListUnitsFilteredContext returns an array with units filtered by state.
// It takes a list of units' statuses to filter.
func (c *Conn) ListUnitsFilteredContext(ctx context.Context, states []string) ([]UnitStatus, error) {
return c.listUnitsInternal(c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.ListUnitsFiltered", 0, states).Store)
return storeSlice[UnitStatus](c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.ListUnitsFiltered", 0, states).Store)
}

// Deprecated: use ListUnitsByPatternsContext instead.
Expand All @@ -481,7 +484,7 @@ func (c *Conn) ListUnitsByPatterns(states []string, patterns []string) ([]UnitSt
// Note that units may be known by multiple names at the same time,
// and hence there might be more unit names loaded than actual units behind them.
func (c *Conn) ListUnitsByPatternsContext(ctx context.Context, states []string, patterns []string) ([]UnitStatus, error) {
return c.listUnitsInternal(c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.ListUnitsByPatterns", 0, states, patterns).Store)
return storeSlice[UnitStatus](c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.ListUnitsByPatterns", 0, states, patterns).Store)
}

// Deprecated: use ListUnitsByNamesContext instead.
Expand All @@ -496,48 +499,22 @@ func (c *Conn) ListUnitsByNames(units []string) ([]UnitStatus, error) {
//
// Requires systemd v230 or higher.
func (c *Conn) ListUnitsByNamesContext(ctx context.Context, units []string) ([]UnitStatus, error) {
return c.listUnitsInternal(c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.ListUnitsByNames", 0, units).Store)
return storeSlice[UnitStatus](c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.ListUnitsByNames", 0, units).Store)
}

type UnitFile struct {
Path string
Type string
}

func (c *Conn) listUnitFilesInternal(f storeFunc) ([]UnitFile, error) {
result := make([][]any, 0)
err := f(&result)
if err != nil {
return nil, err
}

resultInterface := make([]any, len(result))
for i := range result {
resultInterface[i] = result[i]
}

files := make([]UnitFile, len(result))
fileInterface := make([]any, len(files))
for i := range files {
fileInterface[i] = &files[i]
}

err = dbus.Store(resultInterface, fileInterface...)
if err != nil {
return nil, err
}

return files, nil
}

// Deprecated: use ListUnitFilesContext instead.
func (c *Conn) ListUnitFiles() ([]UnitFile, error) {
return c.ListUnitFilesContext(context.Background())
}

// ListUnitFilesContext returns an array of all available units on disk.
func (c *Conn) ListUnitFilesContext(ctx context.Context) ([]UnitFile, error) {
return c.listUnitFilesInternal(c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.ListUnitFiles", 0).Store)
return storeSlice[UnitFile](c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.ListUnitFiles", 0).Store)
}

// Deprecated: use ListUnitFilesByPatternsContext instead.
Expand All @@ -547,7 +524,7 @@ func (c *Conn) ListUnitFilesByPatterns(states []string, patterns []string) ([]Un

// ListUnitFilesByPatternsContext returns an array of all available units on disk matched the patterns.
func (c *Conn) ListUnitFilesByPatternsContext(ctx context.Context, states []string, patterns []string) ([]UnitFile, error) {
return c.listUnitFilesInternal(c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.ListUnitFilesByPatterns", 0, states, patterns).Store)
return storeSlice[UnitFile](c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.ListUnitFilesByPatterns", 0, states, patterns).Store)
}

type LinkUnitFileChange EnableUnitFileChange
Expand Down Expand Up @@ -575,29 +552,7 @@ func (c *Conn) LinkUnitFiles(files []string, runtime bool, force bool) ([]LinkUn
// or unlink), the file name of the symlink and the destination of the
// symlink.
func (c *Conn) LinkUnitFilesContext(ctx context.Context, files []string, runtime bool, force bool) ([]LinkUnitFileChange, error) {
result := make([][]any, 0)
err := c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.LinkUnitFiles", 0, files, runtime, force).Store(&result)
if err != nil {
return nil, err
}

resultInterface := make([]any, len(result))
for i := range result {
resultInterface[i] = result[i]
}

changes := make([]LinkUnitFileChange, len(result))
changesInterface := make([]any, len(changes))
for i := range changes {
changesInterface[i] = &changes[i]
}

err = dbus.Store(resultInterface, changesInterface...)
if err != nil {
return nil, err
}

return changes, nil
return storeSlice[LinkUnitFileChange](c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.LinkUnitFiles", 0, files, runtime, force).Store)
}

// Deprecated: use EnableUnitFilesContext instead.
Expand All @@ -623,25 +578,14 @@ func (c *Conn) EnableUnitFiles(files []string, runtime bool, force bool) (bool,
// symlink.
func (c *Conn) EnableUnitFilesContext(ctx context.Context, files []string, runtime bool, force bool) (bool, []EnableUnitFileChange, error) {
var carries_install_info bool
var result []any

result := make([][]any, 0)
err := c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.EnableUnitFiles", 0, files, runtime, force).Store(&carries_install_info, &result)
if err != nil {
return false, nil, err
}

resultInterface := make([]any, len(result))
for i := range result {
resultInterface[i] = result[i]
}

changes := make([]EnableUnitFileChange, len(result))
changesInterface := make([]any, len(changes))
for i := range changes {
changesInterface[i] = &changes[i]
}

err = dbus.Store(resultInterface, changesInterface...)
changes, err := convertSlice[EnableUnitFileChange](result)
if err != nil {
return false, nil, err
}
Expand Down Expand Up @@ -673,29 +617,7 @@ func (c *Conn) DisableUnitFiles(files []string, runtime bool) ([]DisableUnitFile
// symlink or unlink), the file name of the symlink and the destination of the
// symlink.
func (c *Conn) DisableUnitFilesContext(ctx context.Context, files []string, runtime bool) ([]DisableUnitFileChange, error) {
result := make([][]any, 0)
err := c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.DisableUnitFiles", 0, files, runtime).Store(&result)
if err != nil {
return nil, err
}

resultInterface := make([]any, len(result))
for i := range result {
resultInterface[i] = result[i]
}

changes := make([]DisableUnitFileChange, len(result))
changesInterface := make([]any, len(changes))
for i := range changes {
changesInterface[i] = &changes[i]
}

err = dbus.Store(resultInterface, changesInterface...)
if err != nil {
return nil, err
}

return changes, nil
return storeSlice[DisableUnitFileChange](c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.DisableUnitFiles", 0, files, runtime).Store)
}

type DisableUnitFileChange struct {
Expand All @@ -719,29 +641,7 @@ func (c *Conn) MaskUnitFiles(files []string, runtime bool, force bool) ([]MaskUn
// runtime only (true, /run/systemd/..), or persistently (false,
// /etc/systemd/..).
func (c *Conn) MaskUnitFilesContext(ctx context.Context, files []string, runtime bool, force bool) ([]MaskUnitFileChange, error) {
result := make([][]any, 0)
err := c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.MaskUnitFiles", 0, files, runtime, force).Store(&result)
if err != nil {
return nil, err
}

resultInterface := make([]any, len(result))
for i := range result {
resultInterface[i] = result[i]
}

changes := make([]MaskUnitFileChange, len(result))
changesInterface := make([]any, len(changes))
for i := range changes {
changesInterface[i] = &changes[i]
}

err = dbus.Store(resultInterface, changesInterface...)
if err != nil {
return nil, err
}

return changes, nil
return storeSlice[MaskUnitFileChange](c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.MaskUnitFiles", 0, files, runtime, force).Store)
}

type MaskUnitFileChange struct {
Expand All @@ -763,29 +663,7 @@ func (c *Conn) UnmaskUnitFiles(files []string, runtime bool) ([]UnmaskUnitFileCh
// for runtime only (true, /run/systemd/..), or persistently (false,
// /etc/systemd/..).
func (c *Conn) UnmaskUnitFilesContext(ctx context.Context, files []string, runtime bool) ([]UnmaskUnitFileChange, error) {
result := make([][]any, 0)
err := c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.UnmaskUnitFiles", 0, files, runtime).Store(&result)
if err != nil {
return nil, err
}

resultInterface := make([]any, len(result))
for i := range result {
resultInterface[i] = result[i]
}

changes := make([]UnmaskUnitFileChange, len(result))
changesInterface := make([]any, len(changes))
for i := range changes {
changesInterface[i] = &changes[i]
}

err = dbus.Store(resultInterface, changesInterface...)
if err != nil {
return nil, err
}

return changes, nil
return storeSlice[UnmaskUnitFileChange](c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.UnmaskUnitFiles", 0, files, runtime).Store)
}

type UnmaskUnitFileChange struct {
Expand Down Expand Up @@ -831,31 +709,7 @@ func (c *Conn) ListJobs() ([]JobStatus, error) {

// ListJobsContext returns an array with all currently queued jobs.
func (c *Conn) ListJobsContext(ctx context.Context) ([]JobStatus, error) {
return c.listJobsInternal(ctx)
}

func (c *Conn) listJobsInternal(ctx context.Context) ([]JobStatus, error) {
result := make([][]any, 0)
if err := c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.ListJobs", 0).Store(&result); err != nil {
return nil, err
}

resultInterface := make([]any, len(result))
for i := range result {
resultInterface[i] = result[i]
}

status := make([]JobStatus, len(result))
statusInterface := make([]any, len(status))
for i := range status {
statusInterface[i] = &status[i]
}

if err := dbus.Store(resultInterface, statusInterface...); err != nil {
return nil, err
}

return status, nil
return storeSlice[JobStatus](c.sysobj.CallWithContext(ctx, "org.freedesktop.systemd1.Manager.ListJobs", 0).Store)
}

// FreezeUnit freezes the cgroup associated with the unit.
Expand Down