nixos/modules/programs/oblogout.nix


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
167
168
169
170
171
172
173
174
175
176

# Global configuration for oblogout.

{ config, lib, pkgs, ... }:

with lib;

let cfg = config.programs.oblogout;

in
{
  ###### interface

  options = {

    programs.oblogout = {

      enable = mkOption {
        type = types.bool;
        default = false;
        description = ''
          Whether to install OBLogout and create <filename>/etc/oblogout.conf</filename>.
          See <filename>${pkgs.oblogout}/share/doc/README</filename>.
        '';
      };

      opacity = mkOption {
        type = types.int;
        default = 70;
        description = ''
          Opacity percentage of Cairo rendered backgrounds.
        '';
      };

      bgcolor = mkOption {
        type = types.str;
        default = "black";
        description = ''
          Colour name or hex code (#ffffff) of the background color.
        '';
      };

      buttontheme = mkOption {
        type = types.str;
        default = "simplistic";
        description = ''
          Icon theme for the buttons, must be in the themes folder of
          the package, or in
          <filename>~/.themes/&lt;name&gt;/oblogout/</filename>.
        '';
      };

      buttons = mkOption {
        type = types.str;
        default =  "cancel, logout, restart, shutdown, suspend, hibernate";
        description = ''
          List and order of buttons to show.
        '';
      };

      cancel = mkOption {
        type = types.str;
        default =  "Escape";
        description = ''
          Cancel logout/shutdown shortcut.
        '';
      };

      shutdown = mkOption {
        type = types.str;
        default = "S";
        description = ''
          Shutdown shortcut.
        '';
      };

      restart = mkOption {
        type = types.str;
        default = "R";
        description = ''
          Restart shortcut.
        '';
      };

      suspend = mkOption {
        type = types.str;
        default = "U";
        description = ''
          Suspend shortcut.
        '';
      };

      logout = mkOption {
        type = types.str;
        default = "L";
        description = ''
          Logout shortcut.
        '';
      };

      lock = mkOption {
        type = types.str;
        default = "K";
        description = ''
          Lock session shortcut.
        '';
      };

      hibernate = mkOption {
        type = types.str;
        default =  "H";
        description = ''
          Hibernate shortcut.
        '';
      };

      clogout = mkOption {
        type = types.str;
        default = "openbox --exit";
        description = ''
          Command to logout.
        '';
      };

      clock = mkOption {
        type = types.str;
        default = "";
        description = ''
          Command to lock screen.
        '';
      };

      cswitchuser = mkOption {
        type = types.str;
        default = "";
        description = ''
          Command to switch user.
        '';
      };
    };
  };

  ###### implementation

  config = mkIf cfg.enable {
    environment.systemPackages = [ pkgs.oblogout ];

    environment.etc."oblogout.conf".text = ''
      [settings]
      usehal = false

      [looks]
      opacity = ${toString cfg.opacity}
      bgcolor = ${cfg.bgcolor}
      buttontheme = ${cfg.buttontheme}
      buttons = ${cfg.buttons}

      [shortcuts]
      cancel = ${cfg.cancel}
      shutdown = ${cfg.shutdown}
      restart = ${cfg.restart}
      suspend = ${cfg.suspend}
      logout = ${cfg.logout}
      lock = ${cfg.lock}
      hibernate = ${cfg.hibernate}

      [commands]
      shutdown = systemctl poweroff
      restart = systemctl reboot
      suspend = systemctl suspend
      hibernate = systemctl hibernate
      logout = ${cfg.clogout}
      lock = ${cfg.clock}
      switchuser = ${cfg.cswitchuser}
    '';
  };
}