home-manager/modules/services/screen-locker.nix

161 lines
4.7 KiB
Nix
Raw Permalink Normal View History

2017-09-20 16:50:49 +02:00
{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.services.screen-locker;
in {
2023-05-14 12:40:31 +02:00
meta.maintainers = [ hm.maintainers.jrobsonchase hm.maintainers.rszamszur ];
imports = let
origOpt = name: [ "services" "screen-locker" name ];
xautolockOpt = name: [ "services" "screen-locker" "xautolock" name ];
xssLockOpt = name: [ "services" "screen-locker" "xss-lock" name ];
in [
(mkRenamedOptionModule (origOpt "xssLockExtraOptions")
(xssLockOpt "extraOptions"))
(mkRenamedOptionModule (origOpt "xautolockExtraOptions")
(xautolockOpt "extraOptions"))
(mkRenamedOptionModule (origOpt "enableDetectSleep")
(xautolockOpt "detectSleep"))
];
2017-09-20 16:50:49 +02:00
options.services.screen-locker = {
enable = mkEnableOption "screen locker for X session";
2017-09-20 16:50:49 +02:00
lockCmd = mkOption {
type = types.str;
description = "Locker command to run.";
2017-09-20 16:50:49 +02:00
example = "\${pkgs.i3lock}/bin/i3lock -n -c 000000";
};
inactiveInterval = mkOption {
type = types.int;
default = 10;
description = ''
2017-09-20 16:50:49 +02:00
Inactive time interval in minutes after which session will be locked.
The minimum is 1 minute, and the maximum is 1 hour.
If {option}`xautolock.enable` is true, it will use this setting.
See <https://linux.die.net/man/1/xautolock>.
Otherwise, this will be used with {command}`xset` to configure
the X server's screensaver timeout.
2017-09-20 16:50:49 +02:00
'';
};
xautolock = {
enable = mkOption {
type = types.bool;
default = true;
description = "Use xautolock for time-based locking.";
};
2017-09-20 16:50:49 +02:00
package = mkOption {
type = types.package;
default = pkgs.xautolock;
description = ''
Package providing the {command}`xautolock` binary.
'';
2017-09-20 16:50:49 +02:00
};
detectSleep = mkOption {
type = types.bool;
default = true;
description = ''
Whether to reset xautolock timers when awaking from sleep.
No effect if {option}`xautolock.enable` is false.
'';
};
2017-09-20 16:50:49 +02:00
extraOptions = mkOption {
type = types.listOf types.str;
default = [ ];
description = ''
Extra command-line arguments to pass to {command}`xautolock`.
No effect if {option}`xautolock.enable` is false.
'';
2017-09-20 16:50:49 +02:00
};
};
xss-lock = {
package = mkOption {
type = types.package;
default = pkgs.xss-lock;
description = ''
Package providing the {command}`xss-lock` binary.
'';
};
extraOptions = mkOption {
type = types.listOf types.str;
default = [ ];
description = ''
Extra command-line arguments to pass to {command}`xss-lock`.
'';
};
screensaverCycle = mkOption {
type = types.int;
default = 600;
description = ''
2022-11-08 10:13:26 +01:00
The X server's screensaver cycle value expressed as seconds.
This will be used with {command}`xset` to configure
the cycle along with timeout.
'';
};
};
2017-09-20 16:50:49 +02:00
};
config = mkIf cfg.enable (mkMerge [
{
assertions = [
(lib.hm.assertions.assertPlatform "services.screen-locker" pkgs
lib.platforms.linux)
];
systemd.user.services.xss-lock = {
Unit = {
Description = "xss-lock, session locker service";
After = [ "graphical-session-pre.target" ];
PartOf = [ "graphical-session.target" ];
};
Install = { WantedBy = [ "graphical-session.target" ]; };
Service = {
ExecStart = concatStringsSep " "
([ "${cfg.xss-lock.package}/bin/xss-lock" "-s \${XDG_SESSION_ID}" ]
++ cfg.xss-lock.extraOptions ++ [ "-- ${cfg.lockCmd}" ]);
};
};
}
(mkIf (!cfg.xautolock.enable) {
systemd.user.services.xss-lock.Service.ExecStartPre =
"${pkgs.xorg.xset}/bin/xset s ${toString (cfg.inactiveInterval * 60)} ${
toString cfg.xss-lock.screensaverCycle
}";
})
(mkIf cfg.xautolock.enable {
systemd.user.services.xautolock-session = {
Unit = {
Description = "xautolock, session locker service";
After = [ "graphical-session-pre.target" ];
PartOf = [ "graphical-session.target" ];
};
Install = { WantedBy = [ "graphical-session.target" ]; };
Service = {
ExecStart = concatStringsSep " " ([
"${cfg.xautolock.package}/bin/xautolock"
"-time ${toString cfg.inactiveInterval}"
"-locker '${pkgs.systemd}/bin/loginctl lock-session \${XDG_SESSION_ID}'"
] ++ optional cfg.xautolock.detectSleep "-detectsleep"
++ cfg.xautolock.extraOptions);
};
};
})
]);
2017-09-20 16:50:49 +02:00
}