nixpkgs/pkgs/applications/window-managers/sway/wrapper.nix
Adam Joseph c7a7acb034
sway: respect systemdSupport and dbusSupport (#160972)
Sway can be compiled with or without systemd(-logind) and dbus.  This
commit exposes that support via the global systemdSupport and
dbusSupport arguments, which are understood by many other nixpkgs
expressions and can be set globally in ~/.config/nixpkgs/config.nix.

This commit also adds a third argument, trayEnabled, which allows to
disable sway's tray.  The tray requires dbusSupport and
systemdSupport.

Reviewers of this commit asked for potential use cases.  There are
many of them; a very non-exhaustive list includes:

* Use of nixpkgs on operating systems which systemd does not support,
  such as MacOS/Darwin, FreeBSD, OpenBSD, or Alpine Linux.

* Use of nixpkgs on *-musl platforms, which systemd does not
  officially support (out-of-tree patches to support musl exist for a
  few systemd versions).

* Use of sway in situations where dbus is inappropriate, such as
  sway's "kiosk mode".

* High-security environments, where the additional attack surface
  exposed by dbus outweighs any features it may offer.

This is a very non-exhaustive list.
2022-03-06 13:39:31 +01:00

62 lines
1.7 KiB
Nix

{ lib
, sway-unwrapped
, makeWrapper, symlinkJoin, writeShellScriptBin
, withBaseWrapper ? true, extraSessionCommands ? "", dbus
, withGtkWrapper ? false, wrapGAppsHook, gdk-pixbuf, glib, gtk3
, extraOptions ? [] # E.g.: [ "--verbose" ]
# Used by the NixOS module:
, isNixOS ? false
, enableXWayland ? true
, dbusSupport ? true
}:
assert extraSessionCommands != "" -> withBaseWrapper;
with lib;
let
sway = sway-unwrapped.override { inherit isNixOS enableXWayland; };
baseWrapper = writeShellScriptBin "sway" ''
set -o errexit
if [ ! "$_SWAY_WRAPPER_ALREADY_EXECUTED" ]; then
export XDG_CURRENT_DESKTOP=sway
${extraSessionCommands}
export _SWAY_WRAPPER_ALREADY_EXECUTED=1
fi
if [ "$DBUS_SESSION_BUS_ADDRESS" ]; then
export DBUS_SESSION_BUS_ADDRESS
exec ${sway}/bin/sway "$@"
else
exec ${if !dbusSupport then "" else "${dbus}/bin/dbus-run-session"} ${sway}/bin/sway "$@"
fi
'';
in symlinkJoin {
name = "sway-${sway.version}";
paths = (optional withBaseWrapper baseWrapper)
++ [ sway ];
nativeBuildInputs = [ makeWrapper ]
++ (optional withGtkWrapper wrapGAppsHook);
buildInputs = optionals withGtkWrapper [ gdk-pixbuf glib gtk3 ];
# We want to run wrapProgram manually
dontWrapGApps = true;
postBuild = ''
${optionalString withGtkWrapper "gappsWrapperArgsHook"}
wrapProgram $out/bin/sway \
${optionalString withGtkWrapper ''"''${gappsWrapperArgs[@]}"''} \
${optionalString (extraOptions != []) "${concatMapStrings (x: " --add-flags " + x) extraOptions}"}
'';
passthru = {
inherit (sway.passthru) tests;
providedSessions = [ "sway" ];
};
inherit (sway) meta;
}