commit fb52d5df8669aa7ca64f3cb83c42c118cd244603 · pyrox.dev/nixpkgs

lib/generators.nix

···

       230
       230
        
           in

     

       231
       231
        
             toINI_ (gitFlattenAttrs attrs);

     

       232
       232
        
       

     

       233
       233
       +
         # mkKeyValueDefault wrapper that handles dconf INI quirks.

     

       234
       234
       +
         # The main differences of the format is that it requires strings to be quoted.

     

       235
       235
       +
         mkDconfKeyValue = mkKeyValueDefault { mkValueString = v: toString (lib.gvariant.mkValue v); } "=";

     

       236
       236
       +
       

     

       237
       237
       +
         # Generates INI in dconf keyfile style. See https://help.gnome.org/admin/system-admin-guide/stable/dconf-keyfiles.html.en

     

       238
       238
       +
         # for details.

     

       239
       239
       +
         toDconfINI = toINI { mkKeyValue = mkDconfKeyValue; };

     

       240
       240
       +
       

     

       233
       241
        
         /* Generates JSON from an arbitrary (non-function) value.

     

       234
       242
        
           * For more information see the documentation of the builtin.

     

       235
       243
        
           */

+150 -5

nixos/modules/programs/dconf.nix

···

       3
       3
        
       let

     

       4
       4
        
         cfg = config.programs.dconf;

     

       5
       5
        
       

     

       6
       6
       +
         # Compile keyfiles to dconf DB

     

       7
       7
       +
         compileDconfDb = dir: pkgs.runCommand "dconf-db"

     

       8
       8
       +
           {

     

       9
       9
       +
             nativeBuildInputs = [ (lib.getBin pkgs.dconf) ];

     

       10
       10
       +
           } "dconf compile $out ${dir}";

     

       11
       11
       +
       

     

       12
       12
       +
         # Check if dconf keyfiles are valid

     

       13
       13
       +
         checkDconfKeyfiles = dir: pkgs.runCommand "check-dconf-keyfiles"

     

       14
       14
       +
           {

     

       15
       15
       +
             nativeBuildInputs = [ (lib.getBin pkgs.dconf) ];

     

       16
       16
       +
           } ''

     

       17
       17
       +
           if [[ -f ${dir} ]]; then

     

       18
       18
       +
             echo "dconf keyfiles should be a directory but a file is provided: ${dir}"

     

       19
       19
       +
             exit 1

     

       20
       20
       +
           fi

     

       21
       21
       +
       

     

       22
       22
       +
           dconf compile db ${dir} || (

     

       23
       23
       +
             echo "The dconf keyfiles are invalid: ${dir}"

     

       24
       24
       +
             exit 1

     

       25
       25
       +
           )

     

       26
       26
       +
           cp -R ${dir} $out

     

       27
       27
       +
         '';

     

       28
       28
       +
       

     

       29
       29
       +
         # Generate dconf DB from dconfDatabase and keyfiles

     

       30
       30
       +
         mkDconfDb = val: compileDconfDb (pkgs.symlinkJoin {

     

       31
       31
       +
           name = "nixos-generated-dconf-keyfiles";

     

       32
       32
       +
           paths = [

     

       33
       33
       +
             (pkgs.writeTextDir "nixos-generated-dconf-keyfiles" (lib.generators.toDconfINI val.settings))

     

       34
       34
       +
           ] ++ (map checkDconfKeyfiles val.keyfiles);

     

       35
       35
       +
         });

     

       36
       36
       +
       

     

       37
       37
       +
         # Check if a dconf DB file is valid. The dconf cli doesn't return 1 when it can't

     

       38
       38
       +
         # open the database file so we have to check if the output is empty.

     

       39
       39
       +
         checkDconfDb = file: pkgs.runCommand "check-dconf-db"

     

       40
       40
       +
           {

     

       41
       41
       +
             nativeBuildInputs = [ (lib.getBin pkgs.dconf) ];

     

       42
       42
       +
           } ''

     

       43
       43
       +
           if [[ -d ${file} ]]; then

     

       44
       44
       +
             echo "dconf DB should be a file but a directory is provided: ${file}"

     

       45
       45
       +
             exit 1

     

       46
       46
       +
           fi

     

       47
       47
       +
       

     

       48
       48
       +
           echo "file-db:${file}" > profile

     

       49
       49
       +
           DCONF_PROFILE=$(pwd)/profile dconf dump / > output 2> error

     

       50
       50
       +
           if [[ ! -s output ]] && [[ -s error ]]; then

     

       51
       51
       +
             cat error

     

       52
       52
       +
             echo "The dconf DB file is invalid: ${file}"

     

       53
       53
       +
             exit 1

     

       54
       54
       +
           fi

     

       55
       55
       +
       

     

       56
       56
       +
           cp ${file} $out

     

       57
       57
       +
         '';

     

       58
       58
       +
       

     

       6
       59
        
         # Generate dconf profile

     

       7
       60
        
         mkDconfProfile = name: value:

     

       8
       8
       -
           pkgs.runCommand "dconf-profile" { } ''

     

       9
       9
       -
             mkdir -p $out/etc/dconf/profile/

     

       10
       10
       -
             cp ${value} $out/etc/dconf/profile/${name}

     

       11
       11
       -
           '';

     

       61
       61
       +
           if lib.isDerivation value || lib.isPath value then

     

       62
       62
       +
             pkgs.runCommand "dconf-profile" { } ''

     

       63
       63
       +
               if [[ -d ${value} ]]; then

     

       64
       64
       +
                 echo "Dconf profile should be a file but a directory is provided."

     

       65
       65
       +
                 exit 1

     

       66
       66
       +
               fi

     

       67
       67
       +
               mkdir -p $out/etc/dconf/profile/

     

       68
       68
       +
               cp ${value} $out/etc/dconf/profile/${name}

     

       69
       69
       +
             ''

     

       70
       70
       +
           else

     

       71
       71
       +
             pkgs.writeTextDir "etc/dconf/profile/${name}" (

     

       72
       72
       +
               lib.concatMapStrings (x: "${x}\n") ((

     

       73
       73
       +
                 lib.optional value.enableUserDb "user-db:user"

     

       74
       74
       +
               ) ++ (

     

       75
       75
       +
                 map

     

       76
       76
       +
                   (value:

     

       77
       77
       +
                     let

     

       78
       78
       +
                       db = if lib.isAttrs value && !lib.isDerivation value then mkDconfDb value else checkDconfDb value;

     

       79
       79
       +
                     in

     

       80
       80
       +
                     "file-db:${db}")

     

       81
       81
       +
                   value.databases

     

       82
       82
       +
               ))

     

       83
       83
       +
             );

     

       84
       84
       +
       

     

       85
       85
       +
         dconfDatabase = with lib.types; submodule {

     

       86
       86
       +
           options = {

     

       87
       87
       +
             keyfiles = lib.mkOption {

     

       88
       88
       +
               type = listOf (oneOf [ path package ]);

     

       89
       89
       +
               default = [ ];

     

       90
       90
       +
               description = lib.mdDoc "A list of dconf keyfile directories.";

     

       91
       91
       +
             };

     

       92
       92
       +
             settings = lib.mkOption {

     

       93
       93
       +
               type = attrs;

     

       94
       94
       +
               default = { };

     

       95
       95
       +
               description = lib.mdDoc "An attrset used to generate dconf keyfile.";

     

       96
       96
       +
               example = literalExpression ''

     

       97
       97
       +
                 with lib.gvariant;

     

       98
       98
       +
                 {

     

       99
       99
       +
                   "com/raggesilver/BlackBox" = {

     

       100
       100
       +
                     scrollback-lines = mkUint32 10000;

     

       101
       101
       +
                     theme-dark = "Tommorow Night";

     

       102
       102
       +
                   };

     

       103
       103
       +
                 }

     

       104
       104
       +
               '';

     

       105
       105
       +
             };

     

       106
       106
       +
           };

     

       107
       107
       +
         };

     

       108
       108
       +
       

     

       109
       109
       +
         dconfProfile = with lib.types; submodule {

     

       110
       110
       +
           options = {

     

       111
       111
       +
             enableUserDb = lib.mkOption {

     

       112
       112
       +
               type = bool;

     

       113
       113
       +
               default = true;

     

       114
       114
       +
               description = lib.mdDoc "Add `user-db:user` at the beginning of the profile.";

     

       115
       115
       +
             };

     

       116
       116
       +
       

     

       117
       117
       +
             databases = lib.mkOption {

     

       118
       118
       +
               type = with lib.types; listOf (oneOf [

     

       119
       119
       +
                 path

     

       120
       120
       +
                 package

     

       121
       121
       +
                 dconfDatabase

     

       122
       122
       +
               ]);

     

       123
       123
       +
               default = [ ];

     

       124
       124
       +
               description = lib.mdDoc ''

     

       125
       125
       +
                 List of data sources for the profile. An element can be an attrset,

     

       126
       126
       +
                 or the path of an already compiled database. Each element is converted

     

       127
       127
       +
                 to a file-db.

     

       128
       128
       +
       

     

       129
       129
       +
                 A key is searched from up to down and the first result takes the

     

       130
       130
       +
                 priority. If a lock for a particular key is installed then the value from

     

       131
       131
       +
                 the last database in the profile where the key is locked will be used.

     

       132
       132
       +
                 This can be used to enforce mandatory settings.

     

       133
       133
       +
               '';

     

       134
       134
       +
             };

     

       135
       135
       +
           };

     

       136
       136
       +
         };

     

       137
       137
       +
       

     

       12
       138
        
       in

     

       13
       139
        
       {

     

       14
       140
        
         options = {

     
···

       19
       145
        
               type = with lib.types; attrsOf (oneOf [

     

       20
       146
        
                 path

     

       21
       147
        
                 package

     

       148
       148
       +
                 dconfProfile

     

       22
       149
        
               ]);

     

       23
       23
       -
               description = lib.mdDoc "Attrset of dconf profiles.";

     

       150
       150
       +
               default = { };

     

       151
       151
       +
               description = lib.mdDoc ''

     

       152
       152
       +
                 Attrset of dconf profiles. By default the `user` profile is used which

     

       153
       153
       +
                 ends up in `/etc/dconf/profile/user`.

     

       154
       154
       +
               '';

     

       155
       155
       +
               example = lib.literalExpression ''

     

       156
       156
       +
                 {

     

       157
       157
       +
                   # A "user" profile with a database

     

       158
       158
       +
                   user.databases = [

     

       159
       159
       +
                     {

     

       160
       160
       +
                       settings = { };

     

       161
       161
       +
                     }

     

       162
       162
       +
                   ];

     

       163
       163
       +
                   # A "bar" profile from a package

     

       164
       164
       +
                   bar = pkgs.bar-dconf-profile;

     

       165
       165
       +
                   # A "foo" profile from a path

     

       166
       166
       +
                   foo = ''${./foo}

     

       167
       167
       +
                 };

     

       168
       168
       +
               '';

     

       24
       169
        
             };

     

       25
       170
        
       

     

       26
       171
        
             packages = lib.mkOption {