home-manager/modules/programs/chromium.nix

203 lines
7.1 KiB
Nix
Raw Normal View History

2018-05-29 18:41:53 +02:00
{ config, lib, pkgs, ... }:
with lib;
let
supportedBrowsers = [
"chromium"
"google-chrome"
"google-chrome-beta"
"google-chrome-dev"
"brave"
];
2018-05-29 18:41:53 +02:00
browserModule = defaultPkg: name: visible:
let
browser = (builtins.parseDrvName defaultPkg.name).name;
isProprietaryChrome = hasPrefix "Google Chrome" name;
2020-02-02 00:39:17 +01:00
in {
enable = mkOption {
inherit visible;
type = types.bool;
2020-02-02 00:39:17 +01:00
default = false;
example = true;
description = "Whether to enable ${name}.";
};
2018-05-29 18:41:53 +02:00
2020-02-02 00:39:17 +01:00
package = mkOption {
inherit visible;
type = types.package;
default = defaultPkg;
defaultText = literalExpression "pkgs.${browser}";
2020-02-02 00:39:17 +01:00
description = "The ${name} package to use.";
};
commandLineArgs = mkOption {
inherit visible;
type = types.listOf types.str;
default = [ ];
example = [ "--enable-logging=stderr" "--ignore-gpu-blocklist" ];
description = ''
List of command-line arguments to be passed to ${name}.
</para><para>
Note this option does not have any effect when using a
custom package for <option>programs.${browser}.package</option>.
</para><para>
For a list of common switches, see
<link xlink:href="https://chromium.googlesource.com/chromium/src/+/refs/heads/main/chrome/common/chrome_switches.cc">Chrome switches</link>.
</para><para>
To search switches for other components, see
<link xlink:href="https://source.chromium.org/search?q=file:switches.cc&amp;ss=chromium%2Fchromium%2Fsrc">Chromium codesearch</link>.
'';
};
} // optionalAttrs (!isProprietaryChrome) {
# Extensions do not work with Google Chrome
# see https://github.com/nix-community/home-manager/issues/1383
2020-02-02 00:39:17 +01:00
extensions = mkOption {
inherit visible;
type = with types;
let
extensionType = submodule {
options = {
id = mkOption {
type = strMatching "[a-zA-Z]{32}";
description = ''
The extension's ID from the Chome Web Store url or the unpacked crx.
'';
default = "";
};
updateUrl = mkOption {
type = str;
description = ''
URL of the extension's update manifest XML file. Linux only.
'';
default = "https://clients2.google.com/service/update2/crx";
visible = pkgs.stdenv.isLinux;
readOnly = pkgs.stdenv.isDarwin;
};
crxPath = mkOption {
type = nullOr path;
description = ''
Path to the extension's crx file. Linux only.
'';
default = null;
visible = pkgs.stdenv.isLinux;
};
version = mkOption {
type = nullOr str;
description = ''
The extension's version, required for local installation. Linux only.
'';
default = null;
visible = pkgs.stdenv.isLinux;
};
};
};
in listOf (coercedTo str (v: { id = v; }) extensionType);
2020-02-02 00:39:17 +01:00
default = [ ];
example = literalExpression ''
2020-02-02 00:39:17 +01:00
[
{ id = "cjpalhdlnbpafiamejdnhcphjbkeiagm"; } # ublock origin
{
id = "dcpihecpambacapedldabdbpakmachpb";
updateUrl = "https://raw.githubusercontent.com/iamadamdev/bypass-paywalls-chrome/master/updates.xml";
}
{
id = "aaaaaaaaaabbbbbbbbbbcccccccccc";
crxPath = "/home/share/extension.crx";
version = "1.0";
}
2020-02-02 00:39:17 +01:00
]
'';
description = ''
List of ${name} extensions to install.
To find the extension ID, check its URL on the
<link xlink:href="https://chrome.google.com/webstore/category/extensions">Chrome Web Store</link>.
</para><para>
To install extensions outside of the Chrome Web Store set
<literal>updateUrl</literal> or <literal>crxPath</literal> and
<literal>version</literal> as explained in the
<link xlink:href="https://developer.chrome.com/docs/extensions/mv2/external_extensions">Chrome
documentation</link>.
2020-02-02 00:39:17 +01:00
'';
2018-05-29 18:41:53 +02:00
};
2020-02-02 00:39:17 +01:00
};
2018-05-29 18:41:53 +02:00
browserConfig = cfg:
let
drvName = (builtins.parseDrvName cfg.package.name).name;
browser = if drvName == "ungoogled-chromium" then "chromium" else drvName;
isProprietaryChrome = hasPrefix "google-chrome" drvName;
2018-05-29 18:41:53 +02:00
darwinDirs = {
chromium = "Chromium";
google-chrome = "Google/Chrome";
google-chrome-beta = "Google/Chrome Beta";
google-chrome-dev = "Google/Chrome Dev";
brave = "BraveSoftware/Brave-Browser";
2018-05-29 18:41:53 +02:00
};
linuxDirs = { brave = "BraveSoftware/Brave-Browser"; };
2020-02-02 00:39:17 +01:00
configDir = if pkgs.stdenv.isDarwin then
"Library/Application Support/" + (darwinDirs."${browser}" or browser)
2020-02-02 00:39:17 +01:00
else
"${config.xdg.configHome}/" + (linuxDirs."${browser}" or browser);
2018-05-29 18:41:53 +02:00
extensionJson = ext:
assert ext.crxPath != null -> ext.version != null;
with builtins; {
name = "${configDir}/External Extensions/${ext.id}.json";
value.text = toJSON (if ext.crxPath != null then {
external_crx = ext.crxPath;
external_version = ext.version;
} else {
external_update_url = ext.updateUrl;
});
2018-05-29 18:41:53 +02:00
};
2020-02-02 00:39:17 +01:00
in mkIf cfg.enable {
home.packages = [ cfg.package ];
home.file = optionalAttrs (!isProprietaryChrome)
(listToAttrs (map extensionJson cfg.extensions));
2020-02-02 00:39:17 +01:00
};
2018-05-29 18:41:53 +02:00
browserPkgs = genAttrs supportedBrowsers (browser:
let cfg = config.programs.${browser};
in if cfg.commandLineArgs != [ ] then
pkgs.${browser}.override {
commandLineArgs = concatStringsSep " " cfg.commandLineArgs;
}
else
pkgs.${browser});
2020-02-02 00:39:17 +01:00
in {
# Extensions do not work with the proprietary Google Chrome version
# see https://github.com/nix-community/home-manager/issues/1383
imports = map (flip mkRemovedOptionModule
"The `extensions` option does not work on Google Chrome anymore.") [
[ "programs" "google-chrome" "extensions" ]
[ "programs" "google-chrome-beta" "extensions" ]
[ "programs" "google-chrome-dev" "extensions" ]
];
2018-05-29 18:41:53 +02:00
options.programs = {
chromium = browserModule browserPkgs.chromium "Chromium" true;
google-chrome =
browserModule browserPkgs.google-chrome "Google Chrome" false;
2020-02-02 00:39:17 +01:00
google-chrome-beta =
browserModule browserPkgs.google-chrome-beta "Google Chrome Beta" false;
2020-02-02 00:39:17 +01:00
google-chrome-dev =
browserModule browserPkgs.google-chrome-dev "Google Chrome Dev" false;
brave = browserModule browserPkgs.brave "Brave Browser" false;
2018-05-29 18:41:53 +02:00
};
config = mkMerge
(map (browser: browserConfig config.programs.${browser}) supportedBrowsers);
2018-05-29 18:41:53 +02:00
}