2017-01-11 00:36:43 +01:00
|
|
|
|
{ config, lib, pkgs, ... }:
|
|
|
|
|
|
|
|
|
|
with lib;
|
|
|
|
|
|
|
|
|
|
let
|
|
|
|
|
|
2019-12-28 23:28:21 +01:00
|
|
|
|
inherit (pkgs.stdenv.hostPlatform) isDarwin;
|
|
|
|
|
|
2017-01-11 00:36:43 +01:00
|
|
|
|
cfg = config.programs.firefox;
|
|
|
|
|
|
2019-12-28 23:28:21 +01:00
|
|
|
|
mozillaConfigPath =
|
|
|
|
|
if isDarwin
|
|
|
|
|
then "Library/Application Support/Mozilla"
|
|
|
|
|
else ".mozilla";
|
|
|
|
|
|
|
|
|
|
firefoxConfigPath =
|
|
|
|
|
if isDarwin
|
|
|
|
|
then "Library/Application Support/Firefox"
|
|
|
|
|
else "${mozillaConfigPath}/firefox";
|
|
|
|
|
|
|
|
|
|
profilesPath =
|
|
|
|
|
if isDarwin
|
|
|
|
|
then "${firefoxConfigPath}/Profiles"
|
|
|
|
|
else firefoxConfigPath;
|
|
|
|
|
|
2020-03-15 18:10:38 +01:00
|
|
|
|
# The extensions path shared by all profiles; will not be supported
|
|
|
|
|
# by future Firefox versions.
|
2019-03-11 00:55:32 +01:00
|
|
|
|
extensionPath = "extensions/{ec8030f7-c20a-464f-9b0e-13a3a9e97384}";
|
|
|
|
|
|
2020-03-15 18:10:38 +01:00
|
|
|
|
extensionsEnvPkg = pkgs.buildEnv {
|
|
|
|
|
name = "hm-firefox-extensions";
|
|
|
|
|
paths = cfg.extensions;
|
|
|
|
|
};
|
|
|
|
|
|
2019-05-24 09:08:56 +02:00
|
|
|
|
profiles =
|
|
|
|
|
flip mapAttrs' cfg.profiles (_: profile:
|
|
|
|
|
nameValuePair "Profile${toString profile.id}" {
|
|
|
|
|
Name = profile.name;
|
2019-12-28 23:28:21 +01:00
|
|
|
|
Path =
|
|
|
|
|
if isDarwin
|
|
|
|
|
then "Profiles/${profile.path}"
|
|
|
|
|
else profile.path;
|
2019-05-24 09:08:56 +02:00
|
|
|
|
IsRelative = 1;
|
|
|
|
|
Default = if profile.isDefault then 1 else 0;
|
|
|
|
|
}
|
|
|
|
|
) // {
|
|
|
|
|
General = {
|
|
|
|
|
StartWithLastProfile = 1;
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
profilesIni = generators.toINI {} profiles;
|
|
|
|
|
|
|
|
|
|
mkUserJs = prefs: extraPrefs: ''
|
|
|
|
|
// Generated by Home Manager.
|
|
|
|
|
|
|
|
|
|
${concatStrings (mapAttrsToList (name: value: ''
|
|
|
|
|
user_pref("${name}", ${builtins.toJSON value});
|
|
|
|
|
'') prefs)}
|
|
|
|
|
|
|
|
|
|
${extraPrefs}
|
|
|
|
|
'';
|
|
|
|
|
|
2017-01-11 00:36:43 +01:00
|
|
|
|
in
|
|
|
|
|
|
|
|
|
|
{
|
2017-09-26 23:40:31 +02:00
|
|
|
|
meta.maintainers = [ maintainers.rycee ];
|
|
|
|
|
|
2020-04-18 11:21:24 +02:00
|
|
|
|
imports = [
|
2021-02-09 05:37:24 +01:00
|
|
|
|
(mkRemovedOptionModule ["programs" "firefox" "enableAdobeFlash"]
|
|
|
|
|
"Support for this option has been removed.")
|
2020-04-18 11:21:24 +02:00
|
|
|
|
(mkRemovedOptionModule ["programs" "firefox" "enableGoogleTalk"]
|
|
|
|
|
"Support for this option has been removed.")
|
|
|
|
|
(mkRemovedOptionModule ["programs" "firefox" "enableIcedTea"]
|
|
|
|
|
"Support for this option has been removed.")
|
|
|
|
|
];
|
|
|
|
|
|
2017-01-11 00:36:43 +01:00
|
|
|
|
options = {
|
|
|
|
|
programs.firefox = {
|
|
|
|
|
enable = mkEnableOption "Firefox";
|
|
|
|
|
|
|
|
|
|
package = mkOption {
|
|
|
|
|
type = types.package;
|
2019-08-18 10:57:30 +02:00
|
|
|
|
default =
|
|
|
|
|
if versionAtLeast config.home.stateVersion "19.09"
|
|
|
|
|
then pkgs.firefox
|
|
|
|
|
else pkgs.firefox-unwrapped;
|
2019-08-28 00:12:28 +02:00
|
|
|
|
defaultText = literalExample "pkgs.firefox";
|
2021-05-14 21:06:54 +02:00
|
|
|
|
example = literalExample ''
|
|
|
|
|
pkgs.firefox.override {
|
|
|
|
|
# See nixpkgs' firefox/wrapper.nix to check which options you can use
|
|
|
|
|
cfg = {
|
|
|
|
|
# Gnome shell native connector
|
|
|
|
|
enableGnomeExtensions = true;
|
|
|
|
|
# Tridactyl native connector
|
|
|
|
|
enableTridactylNative = true;
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
'';
|
2019-08-18 10:57:30 +02:00
|
|
|
|
description = ''
|
|
|
|
|
The Firefox package to use. If state version ≥ 19.09 then
|
|
|
|
|
this should be a wrapped Firefox package. For earlier state
|
|
|
|
|
versions it should be an unwrapped Firefox package.
|
|
|
|
|
'';
|
2017-01-11 00:36:43 +01:00
|
|
|
|
};
|
|
|
|
|
|
2019-03-11 00:55:32 +01:00
|
|
|
|
extensions = mkOption {
|
|
|
|
|
type = types.listOf types.package;
|
|
|
|
|
default = [];
|
|
|
|
|
example = literalExample ''
|
2019-03-20 23:41:02 +01:00
|
|
|
|
with pkgs.nur.repos.rycee.firefox-addons; [
|
2019-03-11 00:55:32 +01:00
|
|
|
|
https-everywhere
|
|
|
|
|
privacy-badger
|
|
|
|
|
]
|
|
|
|
|
'';
|
|
|
|
|
description = ''
|
2020-05-31 19:47:46 +02:00
|
|
|
|
List of Firefox add-on packages to install. Some
|
|
|
|
|
pre-packaged add-ons are accessible from NUR,
|
|
|
|
|
<link xlink:href="https://github.com/nix-community/NUR"/>.
|
|
|
|
|
Once you have NUR installed run
|
|
|
|
|
|
|
|
|
|
<screen language="console">
|
|
|
|
|
<prompt>$</prompt> <userinput>nix-env -f '<nixpkgs>' -qaP -A nur.repos.rycee.firefox-addons</userinput>
|
|
|
|
|
</screen>
|
|
|
|
|
|
|
|
|
|
to list the available Firefox add-ons.
|
2020-06-09 22:12:08 +02:00
|
|
|
|
|
2020-05-31 19:47:46 +02:00
|
|
|
|
</para><para>
|
2020-06-09 22:12:08 +02:00
|
|
|
|
|
2020-05-31 19:47:46 +02:00
|
|
|
|
Note that it is necessary to manually enable these
|
|
|
|
|
extensions inside Firefox after the first installation.
|
2020-06-09 22:12:08 +02:00
|
|
|
|
|
|
|
|
|
</para><para>
|
|
|
|
|
|
|
|
|
|
Extensions listed here will only be available in Firefox
|
|
|
|
|
profiles managed through the
|
|
|
|
|
<link linkend="opt-programs.firefox.profiles">programs.firefox.profiles</link>
|
|
|
|
|
option. This is due to recent changes in the way Firefox
|
|
|
|
|
handles extension side-loading.
|
2019-03-11 00:55:32 +01:00
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
2019-05-24 09:08:56 +02:00
|
|
|
|
profiles = mkOption {
|
|
|
|
|
type = types.attrsOf (types.submodule ({config, name, ...}: {
|
|
|
|
|
options = {
|
|
|
|
|
name = mkOption {
|
|
|
|
|
type = types.str;
|
|
|
|
|
default = name;
|
|
|
|
|
description = "Profile name.";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
id = mkOption {
|
|
|
|
|
type = types.ints.unsigned;
|
|
|
|
|
default = 0;
|
|
|
|
|
description = ''
|
|
|
|
|
Profile ID. This should be set to a unique number per profile.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
settings = mkOption {
|
|
|
|
|
type = with types; attrsOf (either bool (either int str));
|
|
|
|
|
default = {};
|
|
|
|
|
example = literalExample ''
|
|
|
|
|
{
|
|
|
|
|
"browser.startup.homepage" = "https://nixos.org";
|
|
|
|
|
"browser.search.region" = "GB";
|
|
|
|
|
"browser.search.isUS" = false;
|
|
|
|
|
"distribution.searchplugins.defaultLocale" = "en-GB";
|
|
|
|
|
"general.useragent.locale" = "en-GB";
|
|
|
|
|
"browser.bookmarks.showMobileBookmarks" = true;
|
|
|
|
|
}
|
|
|
|
|
'';
|
|
|
|
|
description = "Attribute set of Firefox preferences.";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
extraConfig = mkOption {
|
|
|
|
|
type = types.lines;
|
|
|
|
|
default = "";
|
|
|
|
|
description = ''
|
|
|
|
|
Extra preferences to add to <filename>user.js</filename>.
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
userChrome = mkOption {
|
|
|
|
|
type = types.lines;
|
|
|
|
|
default = "";
|
2020-03-09 07:39:37 +01:00
|
|
|
|
description = "Custom Firefox user chrome CSS.";
|
2019-05-24 09:08:56 +02:00
|
|
|
|
example = ''
|
|
|
|
|
/* Hide tab bar in FF Quantum */
|
|
|
|
|
@-moz-document url("chrome://browser/content/browser.xul") {
|
|
|
|
|
#TabsToolbar {
|
|
|
|
|
visibility: collapse !important;
|
|
|
|
|
margin-bottom: 21px !important;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#sidebar-box[sidebarcommand="treestyletab_piro_sakura_ne_jp-sidebar-action"] #sidebar-header {
|
|
|
|
|
visibility: collapse !important;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
2020-03-09 07:39:37 +01:00
|
|
|
|
userContent = mkOption {
|
|
|
|
|
type = types.lines;
|
|
|
|
|
default = "";
|
|
|
|
|
description = "Custom Firefox user content CSS.";
|
|
|
|
|
example = ''
|
|
|
|
|
/* Hide scrollbar in FF Quantum */
|
|
|
|
|
*{scrollbar-width:none !important}
|
|
|
|
|
'';
|
|
|
|
|
};
|
|
|
|
|
|
2019-05-24 09:08:56 +02:00
|
|
|
|
path = mkOption {
|
|
|
|
|
type = types.str;
|
|
|
|
|
default = name;
|
|
|
|
|
description = "Profile path.";
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
isDefault = mkOption {
|
|
|
|
|
type = types.bool;
|
|
|
|
|
default = config.id == 0;
|
|
|
|
|
defaultText = "true if profile ID is 0";
|
|
|
|
|
description = "Whether this is a default profile.";
|
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
}));
|
|
|
|
|
default = {};
|
|
|
|
|
description = "Attribute set of Firefox profiles.";
|
|
|
|
|
};
|
|
|
|
|
|
2020-10-19 15:37:49 +02:00
|
|
|
|
enableGnomeExtensions = mkOption {
|
|
|
|
|
type = types.bool;
|
|
|
|
|
default = false;
|
|
|
|
|
description = ''
|
2020-10-20 00:28:52 +02:00
|
|
|
|
Whether to enable the GNOME Shell native host connector. Note, you
|
|
|
|
|
also need to set the NixOS option
|
|
|
|
|
<literal>services.gnome3.chrome-gnome-shell.enable</literal> to
|
|
|
|
|
<literal>true</literal>.
|
2020-10-19 15:37:49 +02:00
|
|
|
|
'';
|
|
|
|
|
};
|
2017-01-11 00:36:43 +01:00
|
|
|
|
};
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
config = mkIf cfg.enable {
|
2019-05-24 09:08:56 +02:00
|
|
|
|
assertions = [
|
|
|
|
|
(
|
|
|
|
|
let
|
|
|
|
|
defaults =
|
|
|
|
|
catAttrs "name" (filter (a: a.isDefault) (attrValues cfg.profiles));
|
|
|
|
|
in {
|
|
|
|
|
assertion = cfg.profiles == {} || length defaults == 1;
|
|
|
|
|
message =
|
|
|
|
|
"Must have exactly one default Firefox profile but found "
|
|
|
|
|
+ toString (length defaults)
|
|
|
|
|
+ optionalString (length defaults > 1)
|
|
|
|
|
(", namely " + concatStringsSep ", " defaults);
|
|
|
|
|
}
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
(
|
|
|
|
|
let
|
|
|
|
|
duplicates =
|
|
|
|
|
filterAttrs (_: v: length v != 1)
|
|
|
|
|
(zipAttrs
|
|
|
|
|
(mapAttrsToList (n: v: { "${toString v.id}" = n; })
|
|
|
|
|
(cfg.profiles)));
|
|
|
|
|
|
|
|
|
|
mkMsg = n: v: " - ID ${n} is used by ${concatStringsSep ", " v}";
|
|
|
|
|
in {
|
|
|
|
|
assertion = duplicates == {};
|
|
|
|
|
message =
|
|
|
|
|
"Must not have Firefox profiles with duplicate IDs but\n"
|
|
|
|
|
+ concatStringsSep "\n" (mapAttrsToList mkMsg duplicates);
|
|
|
|
|
}
|
|
|
|
|
)
|
|
|
|
|
];
|
|
|
|
|
|
2021-05-14 21:06:54 +02:00
|
|
|
|
warnings = optional (cfg.enableGnomeExtensions or false) ''
|
|
|
|
|
Using 'programs.firefox.enableGnomeExtensions' has been deprecated and
|
|
|
|
|
will be removed in the future. Please change to overriding the package
|
|
|
|
|
configuration using 'programs.firefox.package' instead. You can refer to
|
|
|
|
|
its example for how to do this.
|
|
|
|
|
'';
|
|
|
|
|
|
2017-01-11 00:36:43 +01:00
|
|
|
|
home.packages =
|
|
|
|
|
let
|
2019-08-18 10:57:30 +02:00
|
|
|
|
# The configuration expected by the Firefox wrapper.
|
|
|
|
|
fcfg = {
|
2020-10-19 15:37:49 +02:00
|
|
|
|
enableGnomeExtensions = cfg.enableGnomeExtensions;
|
2017-01-11 00:36:43 +01:00
|
|
|
|
};
|
|
|
|
|
|
2019-08-18 10:57:30 +02:00
|
|
|
|
# A bit of hackery to force a config into the wrapper.
|
|
|
|
|
browserName = cfg.package.browserName
|
|
|
|
|
or (builtins.parseDrvName cfg.package.name).name;
|
|
|
|
|
|
|
|
|
|
# The configuration expected by the Firefox wrapper builder.
|
|
|
|
|
bcfg = setAttrByPath [browserName] fcfg;
|
|
|
|
|
|
|
|
|
|
package =
|
2019-12-28 23:28:21 +01:00
|
|
|
|
if isDarwin then
|
|
|
|
|
cfg.package
|
|
|
|
|
else if versionAtLeast config.home.stateVersion "19.09" then
|
2021-05-10 00:06:04 +02:00
|
|
|
|
cfg.package.override (old: { cfg = old.cfg or {} // fcfg; })
|
2019-12-28 23:28:21 +01:00
|
|
|
|
else
|
|
|
|
|
(pkgs.wrapFirefox.override { config = bcfg; }) cfg.package { };
|
2017-01-11 00:36:43 +01:00
|
|
|
|
in
|
2019-08-18 10:57:30 +02:00
|
|
|
|
[ package ];
|
2019-03-11 00:55:32 +01:00
|
|
|
|
|
2019-05-24 09:08:56 +02:00
|
|
|
|
home.file = mkMerge (
|
|
|
|
|
[{
|
2020-03-15 18:10:38 +01:00
|
|
|
|
"${mozillaConfigPath}/${extensionPath}" = mkIf (cfg.extensions != []) {
|
|
|
|
|
source = "${extensionsEnvPkg}/share/mozilla/${extensionPath}";
|
|
|
|
|
recursive = true;
|
|
|
|
|
};
|
2019-05-24 09:08:56 +02:00
|
|
|
|
|
2019-12-28 23:28:21 +01:00
|
|
|
|
"${firefoxConfigPath}/profiles.ini" = mkIf (cfg.profiles != {}) {
|
2019-05-24 09:08:56 +02:00
|
|
|
|
text = profilesIni;
|
2019-03-11 00:55:32 +01:00
|
|
|
|
};
|
2019-05-24 09:08:56 +02:00
|
|
|
|
}]
|
|
|
|
|
++ flip mapAttrsToList cfg.profiles (_: profile: {
|
2019-12-28 23:28:21 +01:00
|
|
|
|
"${profilesPath}/${profile.path}/chrome/userChrome.css" =
|
2019-05-24 09:08:56 +02:00
|
|
|
|
mkIf (profile.userChrome != "") {
|
|
|
|
|
text = profile.userChrome;
|
|
|
|
|
};
|
|
|
|
|
|
2020-03-09 07:39:37 +01:00
|
|
|
|
"${profilesPath}/${profile.path}/chrome/userContent.css" =
|
|
|
|
|
mkIf (profile.userContent != "") {
|
|
|
|
|
text = profile.userContent;
|
|
|
|
|
};
|
|
|
|
|
|
2019-12-28 23:28:21 +01:00
|
|
|
|
"${profilesPath}/${profile.path}/user.js" =
|
2019-05-24 09:08:56 +02:00
|
|
|
|
mkIf (profile.settings != {} || profile.extraConfig != "") {
|
|
|
|
|
text = mkUserJs profile.settings profile.extraConfig;
|
|
|
|
|
};
|
2020-03-15 18:10:38 +01:00
|
|
|
|
|
|
|
|
|
"${profilesPath}/${profile.path}/extensions" = mkIf (cfg.extensions != []) {
|
|
|
|
|
source = "${extensionsEnvPkg}/share/mozilla/${extensionPath}";
|
|
|
|
|
recursive = true;
|
2020-03-17 22:37:06 +01:00
|
|
|
|
force = true;
|
2020-03-15 18:10:38 +01:00
|
|
|
|
};
|
2019-05-24 09:08:56 +02:00
|
|
|
|
})
|
2019-03-11 00:55:32 +01:00
|
|
|
|
);
|
2017-01-11 00:36:43 +01:00
|
|
|
|
};
|
|
|
|
|
}
|