diff --git a/modules/lib/maintainers.nix b/modules/lib/maintainers.nix
index f1a81815..9793d5c3 100644
--- a/modules/lib/maintainers.nix
+++ b/modules/lib/maintainers.nix
@@ -49,6 +49,12 @@
github = "bertof";
githubId = 9915675;
};
+ bricked = {
+ name = "Bricked";
+ email = "hello@bricked.dev";
+ github = "brckd";
+ githubId = 92804487;
+ };
CarlosLoboxyz = {
name = "Carlos Lobo";
email = "86011416+CarlosLoboxyz@users.noreply.github.com";
diff --git a/modules/programs/firefox.nix b/modules/programs/firefox.nix
index 3bee6e0b..ac85990f 100644
--- a/modules/programs/firefox.nix
+++ b/modules/programs/firefox.nix
@@ -1,974 +1,51 @@
-{ config, lib, pkgs, ... }:
+{ lib, ... }:
with lib;
let
- inherit (pkgs.stdenv.hostPlatform) isDarwin;
+ modulePath = [ "programs" "firefox" ];
- cfg = config.programs.firefox;
+ moduleName = concatStringsSep "." modulePath;
- jsonFormat = pkgs.formats.json { };
-
- 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;
-
- nativeMessagingHostsPath = if isDarwin then
- "${mozillaConfigPath}/NativeMessagingHosts"
- else
- "${mozillaConfigPath}/native-messaging-hosts";
-
- nativeMessagingHostsJoined = pkgs.symlinkJoin {
- name = "ff_native-messaging-hosts";
- paths = [
- # Link a .keep file to keep the directory around
- (pkgs.writeTextDir "lib/mozilla/native-messaging-hosts/.keep" "")
- # Link package configured native messaging hosts (entire Firefox actually)
- cfg.finalPackage
- ]
- # Link user configured native messaging hosts
- ++ cfg.nativeMessagingHosts;
- };
-
- # The extensions path shared by all profiles; will not be supported
- # by future Firefox versions.
- extensionPath = "extensions/{ec8030f7-c20a-464f-9b0e-13a3a9e97384}";
-
- profiles = flip mapAttrs' cfg.profiles (_: profile:
- nameValuePair "Profile${toString profile.id}" {
- Name = profile.name;
- Path = if isDarwin then "Profiles/${profile.path}" else profile.path;
- IsRelative = 1;
- Default = if profile.isDefault then 1 else 0;
- }) // {
- General = { StartWithLastProfile = 1; };
- };
-
- profilesIni = generators.toINI { } profiles;
-
- userPrefValue = pref:
- builtins.toJSON (if isBool pref || isInt pref || isString pref then
- pref
- else
- builtins.toJSON pref);
-
- mkUserJs = prefs: extraPrefs: bookmarks:
- let
- prefs' = lib.optionalAttrs ([ ] != bookmarks) {
- "browser.bookmarks.file" = toString (firefoxBookmarksFile bookmarks);
- "browser.places.importBookmarksHTML" = true;
- } // prefs;
- in ''
- // Generated by Home Manager.
-
- ${concatStrings (mapAttrsToList (name: value: ''
- user_pref("${name}", ${userPrefValue value});
- '') prefs')}
-
- ${extraPrefs}
- '';
-
- mkContainersJson = containers:
- let
- containerToIdentity = _: container: {
- userContextId = container.id;
- name = container.name;
- icon = container.icon;
- color = container.color;
- public = true;
- };
- in ''
- ${builtins.toJSON {
- version = 4;
- lastUserContextId =
- elemAt (mapAttrsToList (_: container: container.id) containers) 0;
- identities = mapAttrsToList containerToIdentity containers ++ [
- {
- userContextId = 4294967294; # 2^32 - 2
- name = "userContextIdInternal.thumbnail";
- icon = "";
- color = "";
- accessKey = "";
- public = false;
- }
- {
- userContextId = 4294967295; # 2^32 - 1
- name = "userContextIdInternal.webextStorageLocal";
- icon = "";
- color = "";
- accessKey = "";
- public = false;
- }
- ];
- }}
- '';
-
- firefoxBookmarksFile = bookmarks:
- let
- indent = level:
- lib.concatStringsSep "" (map (lib.const " ") (lib.range 1 level));
-
- bookmarkToHTML = indentLevel: bookmark:
- ''
- ${indent indentLevel}
${escapeXML bookmark.name}'';
-
- directoryToHTML = indentLevel: directory: ''
- ${indent indentLevel}${
- if directory.toolbar then
- ''
- Bookmarks Toolbar''
- else
- ''${escapeXML directory.name}''
- }
- ${indent indentLevel}
- ${allItemsToHTML (indentLevel + 1) directory.bookmarks}
- ${indent indentLevel}
'';
-
- itemToHTMLOrRecurse = indentLevel: item:
- if item ? "url" then
- bookmarkToHTML indentLevel item
- else
- directoryToHTML indentLevel item;
-
- allItemsToHTML = indentLevel: bookmarks:
- lib.concatStringsSep "\n"
- (map (itemToHTMLOrRecurse indentLevel) bookmarks);
-
- bookmarkEntries = allItemsToHTML 1 bookmarks;
- in pkgs.writeText "firefox-bookmarks.html" ''
-
-
-
-
Bookmarks
- Bookmarks Menu
-
- ${bookmarkEntries}
-
- '';
-
- mkNoDuplicateAssertion = entities: entityKind:
- (let
- # Return an attribute set with entity IDs as keys and a list of
- # entity names with corresponding ID as value. An ID is present in
- # the result only if more than one entity has it. The argument
- # entities is a list of AttrSet of one id/name pair.
- findDuplicateIds = entities:
- filterAttrs (_entityId: entityNames: length entityNames != 1)
- (zipAttrs entities);
-
- duplicates = findDuplicateIds (mapAttrsToList
- (entityName: entity: { "${toString entity.id}" = entityName; })
- entities);
-
- mkMsg = entityId: entityNames:
- " - ID ${entityId} is used by " + concatStringsSep ", " entityNames;
- in {
- assertion = duplicates == { };
- message = ''
- Must not have a Firefox ${entityKind} with an existing ID but
- '' + concatStringsSep "\n" (mapAttrsToList mkMsg duplicates);
- });
-
- wrapPackage = package:
- let
- # The configuration expected by the Firefox wrapper.
- fcfg = { enableGnomeExtensions = cfg.enableGnomeExtensions; };
-
- # A bit of hackery to force a config into the wrapper.
- browserName =
- package.browserName or (builtins.parseDrvName package.name).name;
-
- # The configuration expected by the Firefox wrapper builder.
- bcfg = setAttrByPath [ browserName ] fcfg;
-
- in if package == null then
- null
- else if isDarwin then
- package
- else if versionAtLeast config.home.stateVersion "19.09" then
- package.override (old: {
- cfg = old.cfg or { } // fcfg;
- extraPolicies = (old.extraPolicies or { }) // cfg.policies;
- })
- else
- (pkgs.wrapFirefox.override { config = bcfg; }) package { };
+ mkFirefoxModule = import ./firefox/mkFirefoxModule.nix;
in {
- meta.maintainers = [ maintainers.rycee maintainers.kira-bruneau ];
+ meta.maintainers =
+ [ maintainers.rycee maintainers.kira-bruneau hm.maintainers.bricked ];
imports = [
- (mkRemovedOptionModule [ "programs" "firefox" "extensions" ] ''
+ (mkFirefoxModule {
+ inherit modulePath;
+ name = "Firefox";
+ wrappedPackageName = "firefox";
+ unwrappedPackageName = "firefox-unwrapped";
+ visible = true;
+
+ platforms.linux = rec {
+ vendorPath = ".mozilla";
+ configPath = "${vendorPath}/firefox";
+ };
+ platforms.darwin = {
+ vendorPath = "Library/Application Support/Mozilla";
+ configPath = "Library/Application Support/Firefox";
+ };
+ })
+
+ (mkRemovedOptionModule (modulePath ++ [ "extensions" ]) ''
Extensions are now managed per-profile. That is, change from
- programs.firefox.extensions = [ foo bar ];
+ ${moduleName}.extensions = [ foo bar ];
to
- programs.firefox.profiles.myprofile.extensions = [ foo bar ];'')
- (mkRemovedOptionModule [ "programs" "firefox" "enableAdobeFlash" ]
+ ${moduleName}.profiles.myprofile.extensions = [ foo bar ];'')
+ (mkRemovedOptionModule (modulePath ++ [ "enableAdobeFlash" ])
"Support for this option has been removed.")
- (mkRemovedOptionModule [ "programs" "firefox" "enableGoogleTalk" ]
+ (mkRemovedOptionModule (modulePath ++ [ "enableGoogleTalk" ])
"Support for this option has been removed.")
- (mkRemovedOptionModule [ "programs" "firefox" "enableIcedTea" ]
+ (mkRemovedOptionModule (modulePath ++ [ "enableIcedTea" ])
"Support for this option has been removed.")
];
-
- options = {
- programs.firefox = {
- enable = mkEnableOption "Firefox";
-
- package = mkOption {
- type = with types; nullOr package;
- default = if versionAtLeast config.home.stateVersion "19.09" then
- pkgs.firefox
- else
- pkgs.firefox-unwrapped;
- defaultText = literalExpression "pkgs.firefox";
- example = literalExpression ''
- pkgs.firefox.override {
- # See nixpkgs' firefox/wrapper.nix to check which options you can use
- nativeMessagingHosts = [
- # Gnome shell native connector
- pkgs.gnome-browser-connector
- # Tridactyl native connector
- pkgs.tridactyl-native
- ];
- }
- '';
- 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.
- Set to `null` to disable installing Firefox.
- '';
- };
-
- languagePacks = mkOption {
- type = types.listOf types.str;
- default = [ ];
- description = ''
- The language packs to install. Available language codes can be found
- on the releases page:
- `https://releases.mozilla.org/pub/firefox/releases/''${version}/linux-x86_64/xpi/`,
- replacing `''${version}` with the version of Firefox you have.
- '';
- example = [ "en-GB" "de" ];
- };
-
- nativeMessagingHosts = mkOption {
- type = types.listOf types.package;
- default = [ ];
- description = ''
- Additional packages containing native messaging hosts that should be
- made available to Firefox extensions.
- '';
- };
-
- finalPackage = mkOption {
- type = with types; nullOr package;
- readOnly = true;
- description = "Resulting Firefox package.";
- };
-
- policies = mkOption {
- type = types.attrsOf jsonFormat.type;
- default = { };
- description =
- "[See list of policies](https://mozilla.github.io/policy-templates/).";
- example = {
- DefaultDownloadDirectory = "\${home}/Downloads";
- BlockAboutConfig = true;
- };
- };
-
- 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 = types.attrsOf (jsonFormat.type // {
- description =
- "Firefox preference (int, bool, string, and also attrs, list, float as a JSON string)";
- });
- default = { };
- example = literalExpression ''
- {
- "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;
- "browser.newtabpage.pinned" = [{
- title = "NixOS";
- url = "https://nixos.org";
- }];
- }
- '';
- description = ''
- Attribute set of Firefox preferences.
-
- Firefox only supports int, bool, and string types for
- preferences, but home-manager will automatically
- convert all other JSON-compatible values into strings.
- '';
- };
-
- extraConfig = mkOption {
- type = types.lines;
- default = "";
- description = ''
- Extra preferences to add to {file}`user.js`.
- '';
- };
-
- userChrome = mkOption {
- type = types.lines;
- default = "";
- description = "Custom Firefox user chrome CSS.";
- 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;
- }
- }
- '';
- };
-
- userContent = mkOption {
- type = types.lines;
- default = "";
- description = "Custom Firefox user content CSS.";
- example = ''
- /* Hide scrollbar in FF Quantum */
- *{scrollbar-width:none !important}
- '';
- };
-
- bookmarks = mkOption {
- type = let
- bookmarkSubmodule = types.submodule ({ config, name, ... }: {
- options = {
- name = mkOption {
- type = types.str;
- default = name;
- description = "Bookmark name.";
- };
-
- tags = mkOption {
- type = types.listOf types.str;
- default = [ ];
- description = "Bookmark tags.";
- };
-
- keyword = mkOption {
- type = types.nullOr types.str;
- default = null;
- description = "Bookmark search keyword.";
- };
-
- url = mkOption {
- type = types.str;
- description = "Bookmark url, use %s for search terms.";
- };
- };
- }) // {
- description = "bookmark submodule";
- };
-
- bookmarkType = types.addCheck bookmarkSubmodule (x: x ? "url");
-
- directoryType = types.submodule ({ config, name, ... }: {
- options = {
- name = mkOption {
- type = types.str;
- default = name;
- description = "Directory name.";
- };
-
- bookmarks = mkOption {
- type = types.listOf nodeType;
- default = [ ];
- description = "Bookmarks within directory.";
- };
-
- toolbar = mkOption {
- type = types.bool;
- default = false;
- description = ''
- Make this the toolbar directory. Note, this does _not_
- mean that this directory will be added to the toolbar,
- this directory _is_ the toolbar.
- '';
- };
- };
- }) // {
- description = "directory submodule";
- };
-
- nodeType = types.either bookmarkType directoryType;
- in with types;
- coercedTo (attrsOf nodeType) attrValues (listOf nodeType);
- default = [ ];
- example = literalExpression ''
- [
- {
- name = "wikipedia";
- tags = [ "wiki" ];
- keyword = "wiki";
- url = "https://en.wikipedia.org/wiki/Special:Search?search=%s&go=Go";
- }
- {
- name = "kernel.org";
- url = "https://www.kernel.org";
- }
- {
- name = "Nix sites";
- toolbar = true;
- bookmarks = [
- {
- name = "homepage";
- url = "https://nixos.org/";
- }
- {
- name = "wiki";
- tags = [ "wiki" "nix" ];
- url = "https://wiki.nixos.org/";
- }
- ];
- }
- ]
- '';
- description = ''
- Preloaded bookmarks. Note, this may silently overwrite any
- previously existing bookmarks!
- '';
- };
-
- 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.";
- };
-
- search = {
- force = mkOption {
- type = with types; bool;
- default = false;
- description = ''
- Whether to force replace the existing search
- configuration. This is recommended since Firefox will
- replace the symlink for the search configuration on every
- launch, but note that you'll lose any existing
- configuration by enabling this.
- '';
- };
-
- default = mkOption {
- type = with types; nullOr str;
- default = null;
- example = "DuckDuckGo";
- description = ''
- The default search engine used in the address bar and search bar.
- '';
- };
-
- privateDefault = mkOption {
- type = with types; nullOr str;
- default = null;
- example = "DuckDuckGo";
- description = ''
- The default search engine used in the Private Browsing.
- '';
- };
-
- order = mkOption {
- type = with types; uniq (listOf str);
- default = [ ];
- example = [ "DuckDuckGo" "Google" ];
- description = ''
- The order the search engines are listed in. Any engines
- that aren't included in this list will be listed after
- these in an unspecified order.
- '';
- };
-
- engines = mkOption {
- type = with types; attrsOf (attrsOf jsonFormat.type);
- default = { };
- example = literalExpression ''
- {
- "Nix Packages" = {
- urls = [{
- template = "https://search.nixos.org/packages";
- params = [
- { name = "type"; value = "packages"; }
- { name = "query"; value = "{searchTerms}"; }
- ];
- }];
-
- icon = "''${pkgs.nixos-icons}/share/icons/hicolor/scalable/apps/nix-snowflake.svg";
- definedAliases = [ "@np" ];
- };
-
- "NixOS Wiki" = {
- urls = [{ template = "https://wiki.nixos.org/index.php?search={searchTerms}"; }];
- iconUpdateURL = "https://wiki.nixos.org/favicon.png";
- updateInterval = 24 * 60 * 60 * 1000; # every day
- definedAliases = [ "@nw" ];
- };
-
- "Bing".metaData.hidden = true;
- "Google".metaData.alias = "@g"; # builtin engines only support specifying one additional alias
- }
- '';
- description = ''
- Attribute set of search engine configurations. Engines
- that only have {var}`metaData` specified will
- be treated as builtin to Firefox.
-
- See [SearchEngine.jsm](https://searchfox.org/mozilla-central/rev/669329e284f8e8e2bb28090617192ca9b4ef3380/toolkit/components/search/SearchEngine.jsm#1138-1177)
- in Firefox's source for available options. We maintain a
- mapping to let you specify all options in the referenced
- link without underscores, but it may fall out of date with
- future options.
-
- Note, {var}`icon` is also a special option
- added by Home Manager to make it convenient to specify
- absolute icon paths.
- '';
- };
- };
-
- containersForce = mkOption {
- type = types.bool;
- default = false;
- description = ''
- Whether to force replace the existing containers
- configuration. This is recommended since Firefox will
- replace the symlink on every launch, but note that you'll
- lose any existing configuration by enabling this.
- '';
- };
-
- containers = mkOption {
- type = types.attrsOf (types.submodule ({ name, ... }: {
- options = {
- name = mkOption {
- type = types.str;
- default = name;
- description = "Container name, e.g., shopping.";
- };
-
- id = mkOption {
- type = types.ints.unsigned;
- default = 0;
- description = ''
- Container ID. This should be set to a unique number per container in this profile.
- '';
- };
-
- # List of colors at
- # https://searchfox.org/mozilla-central/rev/5ad226c7379b0564c76dc3b54b44985356f94c5a/toolkit/components/extensions/parent/ext-contextualIdentities.js#32
- color = mkOption {
- type = types.enum [
- "blue"
- "turquoise"
- "green"
- "yellow"
- "orange"
- "red"
- "pink"
- "purple"
- "toolbar"
- ];
- default = "pink";
- description = "Container color.";
- };
-
- icon = mkOption {
- type = types.enum [
- "briefcase"
- "cart"
- "circle"
- "dollar"
- "fence"
- "fingerprint"
- "gift"
- "vacation"
- "food"
- "fruit"
- "pet"
- "tree"
- "chill"
- ];
- default = "fruit";
- description = "Container icon.";
- };
- };
- }));
- default = { };
- example = {
- "shopping" = {
- id = 1;
- color = "blue";
- icon = "cart";
- };
- "dangerous" = {
- id = 2;
- color = "red";
- icon = "fruit";
- };
- };
- description = ''
- Attribute set of container configurations. See
- [Multi-Account
- Containers](https://support.mozilla.org/en-US/kb/containers)
- for more information.
- '';
- };
-
- extensions = mkOption {
- type = types.listOf types.package;
- default = [ ];
- example = literalExpression ''
- with pkgs.nur.repos.rycee.firefox-addons; [
- privacy-badger
- ]
- '';
- description = ''
- List of Firefox add-on packages to install for this profile.
- Some pre-packaged add-ons are accessible from the
- [Nix User Repository](https://github.com/nix-community/NUR).
- Once you have NUR installed run
-
- ```console
- $ nix-env -f '' -qaP -A nur.repos.rycee.firefox-addons
- ```
-
- to list the available Firefox add-ons.
-
- Note that it is necessary to manually enable these extensions
- inside Firefox after the first installation.
-
- To automatically enable extensions add
- `"extensions.autoDisableScopes" = 0;`
- to
- [{option}`programs.firefox.profiles..settings`](#opt-programs.firefox.profiles._name_.settings)
- '';
- };
-
- };
- }));
- default = { };
- description = "Attribute set of Firefox profiles.";
- };
-
- enableGnomeExtensions = mkOption {
- type = types.bool;
- default = false;
- description = ''
- Whether to enable the GNOME Shell native host connector. Note, you
- also need to set the NixOS option
- `services.gnome.gnome-browser-connector.enable` to
- `true`.
- '';
- };
- };
- };
-
- config = mkIf cfg.enable {
- 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
- getContainers = profiles:
- flatten
- (mapAttrsToList (_: value: (attrValues value.containers)) profiles);
-
- findInvalidContainerIds = profiles:
- filter (container: container.id >= 4294967294)
- (getContainers profiles);
- in {
- assertion = cfg.profiles == { }
- || length (findInvalidContainerIds cfg.profiles) == 0;
- message = "Container id must be smaller than 4294967294 (2^32 - 2)";
- })
-
- {
- assertion = cfg.languagePacks == [ ] || cfg.package != null;
- message = ''
- 'programs.firefox.languagePacks' requires 'programs.firefox.package'
- to be set to a non-null value.
- '';
- }
-
- (mkNoDuplicateAssertion cfg.profiles "profile")
- ] ++ (mapAttrsToList
- (_: profile: mkNoDuplicateAssertion profile.containers "container")
- cfg.profiles);
-
- 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.
- '';
-
- programs.firefox.finalPackage = wrapPackage cfg.package;
-
- programs.firefox.policies = {
- ExtensionSettings = listToAttrs (map (lang:
- nameValuePair "langpack-${lang}@firefox.mozilla.org" {
- installation_mode = "normal_installed";
- install_url =
- "https://releases.mozilla.org/pub/firefox/releases/${cfg.package.version}/linux-x86_64/xpi/${lang}.xpi";
- }) cfg.languagePacks);
- };
-
- home.packages = lib.optional (cfg.finalPackage != null) cfg.finalPackage;
-
- home.file = mkMerge ([{
- "${firefoxConfigPath}/profiles.ini" =
- mkIf (cfg.profiles != { }) { text = profilesIni; };
-
- "${nativeMessagingHostsPath}" = {
- source =
- "${nativeMessagingHostsJoined}/lib/mozilla/native-messaging-hosts";
- recursive = true;
- };
- }] ++ flip mapAttrsToList cfg.profiles (_: profile: {
- "${profilesPath}/${profile.path}/.keep".text = "";
-
- "${profilesPath}/${profile.path}/chrome/userChrome.css" =
- mkIf (profile.userChrome != "") { text = profile.userChrome; };
-
- "${profilesPath}/${profile.path}/chrome/userContent.css" =
- mkIf (profile.userContent != "") { text = profile.userContent; };
-
- "${profilesPath}/${profile.path}/user.js" = mkIf (profile.settings != { }
- || profile.extraConfig != "" || profile.bookmarks != [ ]) {
- text =
- mkUserJs profile.settings profile.extraConfig profile.bookmarks;
- };
-
- "${profilesPath}/${profile.path}/containers.json" =
- mkIf (profile.containers != { }) {
- force = profile.containersForce;
- text = mkContainersJson profile.containers;
- };
-
- "${profilesPath}/${profile.path}/search.json.mozlz4" = mkIf
- (profile.search.default != null || profile.search.privateDefault != null
- || profile.search.order != [ ] || profile.search.engines != { }) {
- force = profile.search.force;
- source = let
- settings = {
- version = 6;
- engines = let
- # Map of nice field names to internal field names.
- # This is intended to be exhaustive and should be
- # updated at every version bump.
- internalFieldNames = (genAttrs [
- "name"
- "isAppProvided"
- "loadPath"
- "hasPreferredIcon"
- "updateInterval"
- "updateURL"
- "iconUpdateURL"
- "iconURL"
- "iconMapObj"
- "metaData"
- "orderHint"
- "definedAliases"
- "urls"
- ] (name: "_${name}")) // {
- searchForm = "__searchForm";
- };
-
- processCustomEngineInput = input:
- (removeAttrs input [ "icon" ])
- // optionalAttrs (input ? icon) {
- # Convenience to specify absolute path to icon
- iconURL = "file://${input.icon}";
- } // (optionalAttrs (input ? iconUpdateURL) {
- # Convenience to default iconURL to iconUpdateURL so
- # the icon is immediately downloaded from the URL
- iconURL = input.iconURL or input.iconUpdateURL;
- } // {
- # Required for custom engine configurations, loadPaths
- # are unique identifiers that are generally formatted
- # like: [source]/path/to/engine.xml
- loadPath = ''
- [home-manager]/programs.firefox.profiles.${profile.name}.search.engines."${
- replaceStrings [ "\\" ] [ "\\\\" ] input.name
- }"'';
- });
-
- processEngineInput = name: input:
- let
- requiredInput = {
- inherit name;
- isAppProvided = input.isAppProvided or removeAttrs input
- [ "metaData" ] == { };
- metaData = input.metaData or { };
- };
- in if requiredInput.isAppProvided then
- requiredInput
- else
- processCustomEngineInput (input // requiredInput);
-
- buildEngineConfig = name: input:
- mapAttrs' (name: value: {
- name = internalFieldNames.${name} or name;
- inherit value;
- }) (processEngineInput name input);
-
- sortEngineConfigs = configs:
- let
- buildEngineConfigWithOrder = order: name:
- let
- config = configs.${name} or {
- _name = name;
- _isAppProvided = true;
- _metaData = { };
- };
- in config // {
- _metaData = config._metaData // { inherit order; };
- };
-
- engineConfigsWithoutOrder =
- attrValues (removeAttrs configs profile.search.order);
-
- sortedEngineConfigs =
- (imap buildEngineConfigWithOrder profile.search.order)
- ++ engineConfigsWithoutOrder;
- in sortedEngineConfigs;
-
- engineInput = profile.search.engines // {
- # Infer profile.search.default as an app provided
- # engine if it's not in profile.search.engines
- ${profile.search.default} =
- profile.search.engines.${profile.search.default} or { };
- } // {
- ${profile.search.privateDefault} =
- profile.search.engines.${profile.search.privateDefault} or { };
- };
- in sortEngineConfigs (mapAttrs buildEngineConfig engineInput);
-
- metaData = optionalAttrs (profile.search.default != null) {
- current = profile.search.default;
- hash = "@hash@";
- } // optionalAttrs (profile.search.privateDefault != null) {
- private = profile.search.privateDefault;
- privateHash = "@privateHash@";
- } // {
- useSavedOrder = profile.search.order != [ ];
- };
- };
-
- # Home Manager doesn't circumvent user consent and isn't acting
- # maliciously. We're modifying the search outside of Firefox, but
- # a claim by Mozilla to remove this would be very anti-user, and
- # is unlikely to be an issue for our use case.
- disclaimer = appName:
- "By modifying this file, I agree that I am doing so "
- + "only within ${appName} itself, using official, user-driven search "
- + "engine selection processes, and in a way which does not circumvent "
- + "user consent. I acknowledge that any attempt to change this file "
- + "from outside of ${appName} is a malicious act, and will be responded "
- + "to accordingly.";
-
- salt = if profile.search.default != null then
- profile.path + profile.search.default + disclaimer "Firefox"
- else
- null;
-
- privateSalt = if profile.search.privateDefault != null then
- profile.path + profile.search.privateDefault
- + disclaimer "Firefox"
- else
- null;
- in pkgs.runCommand "search.json.mozlz4" {
- nativeBuildInputs = with pkgs; [ mozlz4a openssl ];
- json = builtins.toJSON settings;
- inherit salt privateSalt;
- } ''
- if [[ -n $salt ]]; then
- export hash=$(echo -n "$salt" | openssl dgst -sha256 -binary | base64)
- export privateHash=$(echo -n "$privateSalt" | openssl dgst -sha256 -binary | base64)
- mozlz4a <(substituteStream json search.json.in --subst-var hash --subst-var privateHash) "$out"
- else
- mozlz4a <(echo "$json") "$out"
- fi
- '';
- };
-
- "${profilesPath}/${profile.path}/extensions" =
- mkIf (profile.extensions != [ ]) {
- source = let
- extensionsEnvPkg = pkgs.buildEnv {
- name = "hm-firefox-extensions";
- paths = profile.extensions;
- };
- in "${extensionsEnvPkg}/share/mozilla/${extensionPath}";
- recursive = true;
- force = true;
- };
- }));
- };
}
diff --git a/modules/programs/firefox/mkFirefoxModule.nix b/modules/programs/firefox/mkFirefoxModule.nix
new file mode 100644
index 00000000..32ab4b47
--- /dev/null
+++ b/modules/programs/firefox/mkFirefoxModule.nix
@@ -0,0 +1,1017 @@
+{ modulePath, name, description ? null, wrappedPackageName ? null
+, unwrappedPackageName ? null, platforms, visible ? false }:
+
+{ config, lib, pkgs, ... }:
+
+with lib;
+
+let
+
+ inherit (pkgs.stdenv.hostPlatform) isDarwin;
+
+ moduleName = concatStringsSep "." modulePath;
+
+ cfg = getAttrFromPath modulePath config;
+
+ jsonFormat = pkgs.formats.json { };
+
+ supportedPlatforms = flatten (attrVals (attrNames platforms) lib.platforms);
+
+ isWrapped = versionAtLeast config.home.stateVersion "19.09"
+ && wrappedPackageName != null;
+
+ defaultPackageName =
+ if isWrapped then wrappedPackageName else unwrappedPackageName;
+
+ packageName = if wrappedPackageName != null then
+ wrappedPackageName
+ else
+ unwrappedPackageName;
+
+ profilesPath =
+ if isDarwin then "${cfg.configPath}/Profiles" else cfg.configPath;
+
+ nativeMessagingHostsPath = if isDarwin then
+ "${cfg.vendorPath}/NativeMessagingHosts"
+ else
+ "${cfg.vendorPath}/native-messaging-hosts";
+
+ nativeMessagingHostsJoined = pkgs.symlinkJoin {
+ name = "ff_native-messaging-hosts";
+ paths = [
+ # Link a .keep file to keep the directory around
+ (pkgs.writeTextDir "lib/mozilla/native-messaging-hosts/.keep" "")
+ # Link package configured native messaging hosts (entire browser actually)
+ cfg.finalPackage
+ ]
+ # Link user configured native messaging hosts
+ ++ cfg.nativeMessagingHosts;
+ };
+
+ # The extensions path shared by all profiles; will not be supported
+ # by future browser versions.
+ extensionPath = "extensions/{ec8030f7-c20a-464f-9b0e-13a3a9e97384}";
+
+ profiles = flip mapAttrs' cfg.profiles (_: profile:
+ nameValuePair "Profile${toString profile.id}" {
+ Name = profile.name;
+ Path = if isDarwin then "Profiles/${profile.path}" else profile.path;
+ IsRelative = 1;
+ Default = if profile.isDefault then 1 else 0;
+ }) // {
+ General = {
+ StartWithLastProfile = 1;
+ Version = 2;
+ };
+ };
+
+ profilesIni = generators.toINI { } profiles;
+
+ userPrefValue = pref:
+ builtins.toJSON (if isBool pref || isInt pref || isString pref then
+ pref
+ else
+ builtins.toJSON pref);
+
+ mkUserJs = prefs: extraPrefs: bookmarks:
+ let
+ prefs' = lib.optionalAttrs ([ ] != bookmarks) {
+ "browser.bookmarks.file" = toString (browserBookmarksFile bookmarks);
+ "browser.places.importBookmarksHTML" = true;
+ } // prefs;
+ in ''
+ // Generated by Home Manager.
+
+ ${concatStrings (mapAttrsToList (name: value: ''
+ user_pref("${name}", ${userPrefValue value});
+ '') prefs')}
+
+ ${extraPrefs}
+ '';
+
+ mkContainersJson = containers:
+ let
+ containerToIdentity = _: container: {
+ userContextId = container.id;
+ name = container.name;
+ icon = container.icon;
+ color = container.color;
+ public = true;
+ };
+ in ''
+ ${builtins.toJSON {
+ version = 4;
+ lastUserContextId =
+ elemAt (mapAttrsToList (_: container: container.id) containers) 0;
+ identities = mapAttrsToList containerToIdentity containers ++ [
+ {
+ userContextId = 4294967294; # 2^32 - 2
+ name = "userContextIdInternal.thumbnail";
+ icon = "";
+ color = "";
+ accessKey = "";
+ public = false;
+ }
+ {
+ userContextId = 4294967295; # 2^32 - 1
+ name = "userContextIdInternal.webextStorageLocal";
+ icon = "";
+ color = "";
+ accessKey = "";
+ public = false;
+ }
+ ];
+ }}
+ '';
+
+ browserBookmarksFile = bookmarks:
+ let
+ indent = level:
+ lib.concatStringsSep "" (map (lib.const " ") (lib.range 1 level));
+
+ bookmarkToHTML = indentLevel: bookmark:
+ ''
+ ${indent indentLevel}${escapeXML bookmark.name}'';
+
+ directoryToHTML = indentLevel: directory: ''
+ ${indent indentLevel}${
+ if directory.toolbar then
+ ''
+ Bookmarks Toolbar''
+ else
+ ''${escapeXML directory.name}''
+ }
+ ${indent indentLevel}
+ ${allItemsToHTML (indentLevel + 1) directory.bookmarks}
+ ${indent indentLevel}
'';
+
+ itemToHTMLOrRecurse = indentLevel: item:
+ if item ? "url" then
+ bookmarkToHTML indentLevel item
+ else
+ directoryToHTML indentLevel item;
+
+ allItemsToHTML = indentLevel: bookmarks:
+ lib.concatStringsSep "\n"
+ (map (itemToHTMLOrRecurse indentLevel) bookmarks);
+
+ bookmarkEntries = allItemsToHTML 1 bookmarks;
+ in pkgs.writeText "${packageName}-bookmarks.html" ''
+
+
+
+
Bookmarks
+ Bookmarks Menu
+
+ ${bookmarkEntries}
+
+ '';
+
+ mkNoDuplicateAssertion = entities: entityKind:
+ (let
+ # Return an attribute set with entity IDs as keys and a list of
+ # entity names with corresponding ID as value. An ID is present in
+ # the result only if more than one entity has it. The argument
+ # entities is a list of AttrSet of one id/name pair.
+ findDuplicateIds = entities:
+ filterAttrs (_entityId: entityNames: length entityNames != 1)
+ (zipAttrs entities);
+
+ duplicates = findDuplicateIds (mapAttrsToList
+ (entityName: entity: { "${toString entity.id}" = entityName; })
+ entities);
+
+ mkMsg = entityId: entityNames:
+ " - ID ${entityId} is used by " + concatStringsSep ", " entityNames;
+ in {
+ assertion = duplicates == { };
+ message = ''
+ Must not have a ${name} ${entityKind} with an existing ID but
+ '' + concatStringsSep "\n" (mapAttrsToList mkMsg duplicates);
+ });
+
+ wrapPackage = package:
+ let
+ # The configuration expected by the Firefox wrapper.
+ fcfg = { enableGnomeExtensions = cfg.enableGnomeExtensions; };
+
+ # A bit of hackery to force a config into the wrapper.
+ browserName =
+ package.browserName or (builtins.parseDrvName package.name).name;
+
+ # The configuration expected by the Firefox wrapper builder.
+ bcfg = setAttrByPath [ browserName ] fcfg;
+
+ in if package == null then
+ null
+ else if isDarwin then
+ package
+ else if isWrapped then
+ package.override (old: {
+ cfg = old.cfg or { } // fcfg;
+ extraPolicies = (old.extraPolicies or { }) // cfg.policies;
+ })
+ else
+ (pkgs.wrapFirefox.override { config = bcfg; }) package { };
+
+in {
+ options = setAttrByPath modulePath {
+ enable = mkOption {
+ type = types.bool;
+ default = false;
+ example = true;
+ description = ''
+ Whether to enable ${name}.${
+ optionalString (description != null) " ${description}"
+ }
+ ${optionalString (!visible)
+ "See `programs.firefox` for more configuration options."}
+ '';
+ };
+
+ package = mkOption {
+ inherit visible;
+ type = with types; nullOr package;
+ default = pkgs.${defaultPackageName};
+ defaultText = literalExpression "pkgs.${packageName}";
+ example = literalExpression ''
+ pkgs.${packageName}.override {
+ # See nixpkgs' firefox/wrapper.nix to check which options you can use
+ nativeMessagingHosts = [
+ # Gnome shell native connector
+ pkgs.gnome-browser-connector
+ # Tridactyl native connector
+ pkgs.tridactyl-native
+ ];
+ }
+ '';
+ description = ''
+ The ${name} package to use. If state version ≥ 19.09 then
+ this should be a wrapped ${name} package. For earlier state
+ versions it should be an unwrapped ${name} package.
+ Set to `null` to disable installing ${name}.
+ '';
+ };
+
+ languagePacks = mkOption {
+ type = types.listOf types.str;
+ default = [ ];
+ description = ''
+ The language packs to install. Available language codes can be found
+ on the releases page:
+ `https://releases.mozilla.org/pub/firefox/releases/''${version}/linux-x86_64/xpi/`,
+ replacing `''${version}` with the version of Firefox you have.
+ '';
+ example = [ "en-GB" "de" ];
+ };
+
+ name = mkOption {
+ internal = true;
+ type = types.str;
+ default = name;
+ example = "Firefox";
+ description = "The name of the browser.";
+ };
+
+ wrappedPackageName = mkOption {
+ internal = true;
+ type = with types; nullOr str;
+ default = wrappedPackageName;
+ description = "Name of the wrapped browser package.";
+ };
+
+ vendorPath = mkOption {
+ internal = true;
+ type = with types; nullOr str;
+ default = with platforms;
+ if isDarwin then
+ darwin.vendorPath or null
+ else
+ linux.vendorPath or null;
+ example = ".mozilla";
+ description =
+ "Directory containing the native messaging hosts directory.";
+ };
+
+ configPath = mkOption {
+ internal = true;
+ type = types.str;
+ default = with platforms;
+ if isDarwin then darwin.configPath else linux.configPath;
+ example = ".mozilla/firefox";
+ description = "Directory containing the ${name} configuration files.";
+ };
+
+ nativeMessagingHosts = optionalAttrs (cfg.vendorPath != null) (mkOption {
+ inherit visible;
+ type = types.listOf types.package;
+ default = [ ];
+ description = ''
+ Additional packages containing native messaging hosts that should be
+ made available to ${name} extensions.
+ '';
+ });
+
+ finalPackage = mkOption {
+ inherit visible;
+ type = with types; nullOr package;
+ readOnly = true;
+ description = "Resulting ${cfg.name} package.";
+ };
+
+ policies = optionalAttrs (unwrappedPackageName != null) (mkOption {
+ inherit visible;
+ type = types.attrsOf jsonFormat.type;
+ default = { };
+ description =
+ "[See list of policies](https://mozilla.github.io/policy-templates/).";
+ example = {
+ DefaultDownloadDirectory = "\${home}/Downloads";
+ BlockAboutConfig = true;
+ };
+ });
+
+ profiles = mkOption {
+ inherit visible;
+ 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 = types.attrsOf (jsonFormat.type // {
+ description =
+ "${name} preference (int, bool, string, and also attrs, list, float as a JSON string)";
+ });
+ default = { };
+ example = literalExpression ''
+ {
+ "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;
+ "browser.newtabpage.pinned" = [{
+ title = "NixOS";
+ url = "https://nixos.org";
+ }];
+ }
+ '';
+ description = ''
+ Attribute set of ${name} preferences.
+
+ ${name} only supports int, bool, and string types for
+ preferences, but home-manager will automatically
+ convert all other JSON-compatible values into strings.
+ '';
+ };
+
+ extraConfig = mkOption {
+ type = types.lines;
+ default = "";
+ description = ''
+ Extra preferences to add to {file}`user.js`.
+ '';
+ };
+
+ userChrome = mkOption {
+ type = types.lines;
+ default = "";
+ description = "Custom ${name} user chrome CSS.";
+ 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;
+ }
+ }
+ '';
+ };
+
+ userContent = mkOption {
+ type = types.lines;
+ default = "";
+ description = "Custom ${name} user content CSS.";
+ example = ''
+ /* Hide scrollbar in FF Quantum */
+ *{scrollbar-width:none !important}
+ '';
+ };
+
+ bookmarks = mkOption {
+ type = let
+ bookmarkSubmodule = types.submodule ({ config, name, ... }: {
+ options = {
+ name = mkOption {
+ type = types.str;
+ default = name;
+ description = "Bookmark name.";
+ };
+
+ tags = mkOption {
+ type = types.listOf types.str;
+ default = [ ];
+ description = "Bookmark tags.";
+ };
+
+ keyword = mkOption {
+ type = types.nullOr types.str;
+ default = null;
+ description = "Bookmark search keyword.";
+ };
+
+ url = mkOption {
+ type = types.str;
+ description = "Bookmark url, use %s for search terms.";
+ };
+ };
+ }) // {
+ description = "bookmark submodule";
+ };
+
+ bookmarkType = types.addCheck bookmarkSubmodule (x: x ? "url");
+
+ directoryType = types.submodule ({ config, name, ... }: {
+ options = {
+ name = mkOption {
+ type = types.str;
+ default = name;
+ description = "Directory name.";
+ };
+
+ bookmarks = mkOption {
+ type = types.listOf nodeType;
+ default = [ ];
+ description = "Bookmarks within directory.";
+ };
+
+ toolbar = mkOption {
+ type = types.bool;
+ default = false;
+ description = ''
+ Make this the toolbar directory. Note, this does _not_
+ mean that this directory will be added to the toolbar,
+ this directory _is_ the toolbar.
+ '';
+ };
+ };
+ }) // {
+ description = "directory submodule";
+ };
+
+ nodeType = types.either bookmarkType directoryType;
+ in with types;
+ coercedTo (attrsOf nodeType) attrValues (listOf nodeType);
+ default = [ ];
+ example = literalExpression ''
+ [
+ {
+ name = "wikipedia";
+ tags = [ "wiki" ];
+ keyword = "wiki";
+ url = "https://en.wikipedia.org/wiki/Special:Search?search=%s&go=Go";
+ }
+ {
+ name = "kernel.org";
+ url = "https://www.kernel.org";
+ }
+ {
+ name = "Nix sites";
+ toolbar = true;
+ bookmarks = [
+ {
+ name = "homepage";
+ url = "https://nixos.org/";
+ }
+ {
+ name = "wiki";
+ tags = [ "wiki" "nix" ];
+ url = "https://wiki.nixos.org/";
+ }
+ ];
+ }
+ ]
+ '';
+ description = ''
+ Preloaded bookmarks. Note, this may silently overwrite any
+ previously existing bookmarks!
+ '';
+ };
+
+ 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.";
+ };
+
+ search = {
+ force = mkOption {
+ type = with types; bool;
+ default = false;
+ description = ''
+ Whether to force replace the existing search
+ configuration. This is recommended since ${name} will
+ replace the symlink for the search configuration on every
+ launch, but note that you'll lose any existing
+ configuration by enabling this.
+ '';
+ };
+
+ default = mkOption {
+ type = with types; nullOr str;
+ default = null;
+ example = "DuckDuckGo";
+ description = ''
+ The default search engine used in the address bar and search bar.
+ '';
+ };
+
+ privateDefault = mkOption {
+ type = with types; nullOr str;
+ default = null;
+ example = "DuckDuckGo";
+ description = ''
+ The default search engine used in the Private Browsing.
+ '';
+ };
+
+ order = mkOption {
+ type = with types; uniq (listOf str);
+ default = [ ];
+ example = [ "DuckDuckGo" "Google" ];
+ description = ''
+ The order the search engines are listed in. Any engines
+ that aren't included in this list will be listed after
+ these in an unspecified order.
+ '';
+ };
+
+ engines = mkOption {
+ type = with types; attrsOf (attrsOf jsonFormat.type);
+ default = { };
+ example = literalExpression ''
+ {
+ "Nix Packages" = {
+ urls = [{
+ template = "https://search.nixos.org/packages";
+ params = [
+ { name = "type"; value = "packages"; }
+ { name = "query"; value = "{searchTerms}"; }
+ ];
+ }];
+
+ icon = "''${pkgs.nixos-icons}/share/icons/hicolor/scalable/apps/nix-snowflake.svg";
+ definedAliases = [ "@np" ];
+ };
+
+ "NixOS Wiki" = {
+ urls = [{ template = "https://wiki.nixos.org/index.php?search={searchTerms}"; }];
+ iconUpdateURL = "https://wiki.nixos.org/favicon.png";
+ updateInterval = 24 * 60 * 60 * 1000; # every day
+ definedAliases = [ "@nw" ];
+ };
+
+ "Bing".metaData.hidden = true;
+ "Google".metaData.alias = "@g"; # builtin engines only support specifying one additional alias
+ }
+ '';
+ description = ''
+ Attribute set of search engine configurations. Engines
+ that only have {var}`metaData` specified will
+ be treated as builtin to ${name}.
+
+ See [SearchEngine.jsm](https://searchfox.org/mozilla-central/rev/669329e284f8e8e2bb28090617192ca9b4ef3380/toolkit/components/search/SearchEngine.jsm#1138-1177)
+ in Firefox's source for available options. We maintain a
+ mapping to let you specify all options in the referenced
+ link without underscores, but it may fall out of date with
+ future options.
+
+ Note, {var}`icon` is also a special option
+ added by Home Manager to make it convenient to specify
+ absolute icon paths.
+ '';
+ };
+ };
+
+ containersForce = mkOption {
+ type = types.bool;
+ default = false;
+ description = ''
+ Whether to force replace the existing containers configuration.
+ This is recommended since Firefox will replace the symlink on
+ every launch, but note that you'll lose any existing configuration
+ by enabling this.
+ '';
+ };
+
+ containers = mkOption {
+ type = types.attrsOf (types.submodule ({ name, ... }: {
+ options = {
+ name = mkOption {
+ type = types.str;
+ default = name;
+ description = "Container name, e.g., shopping.";
+ };
+
+ id = mkOption {
+ type = types.ints.unsigned;
+ default = 0;
+ description = ''
+ Container ID. This should be set to a unique number per container in this profile.
+ '';
+ };
+
+ # List of colors at
+ # https://searchfox.org/mozilla-central/rev/5ad226c7379b0564c76dc3b54b44985356f94c5a/toolkit/components/extensions/parent/ext-contextualIdentities.js#32
+ color = mkOption {
+ type = types.enum [
+ "blue"
+ "turquoise"
+ "green"
+ "yellow"
+ "orange"
+ "red"
+ "pink"
+ "purple"
+ "toolbar"
+ ];
+ default = "pink";
+ description = "Container color.";
+ };
+
+ icon = mkOption {
+ type = types.enum [
+ "briefcase"
+ "cart"
+ "circle"
+ "dollar"
+ "fence"
+ "fingerprint"
+ "gift"
+ "vacation"
+ "food"
+ "fruit"
+ "pet"
+ "tree"
+ "chill"
+ ];
+ default = "fruit";
+ description = "Container icon.";
+ };
+ };
+ }));
+ default = { };
+ example = {
+ "shopping" = {
+ id = 1;
+ color = "blue";
+ icon = "cart";
+ };
+ "dangerous" = {
+ id = 2;
+ color = "red";
+ icon = "fruit";
+ };
+ };
+ description = ''
+ Attribute set of container configurations. See
+ [Multi-Account
+ Containers](https://support.mozilla.org/en-US/kb/containers)
+ for more information.
+ '';
+ };
+
+ extensions = mkOption {
+ type = types.listOf types.package;
+ default = [ ];
+ example = literalExpression ''
+ with pkgs.nur.repos.rycee.firefox-addons; [
+ privacy-badger
+ ]
+ '';
+ description = ''
+ List of ${name} add-on packages to install for this profile.
+ Some pre-packaged add-ons are accessible from the
+ [Nix User Repository](https://github.com/nix-community/NUR).
+ Once you have NUR installed run
+
+ ```console
+ $ nix-env -f '' -qaP -A nur.repos.rycee.firefox-addons
+ ```
+
+ to list the available ${name} add-ons.
+
+ Note that it is necessary to manually enable these extensions
+ inside ${name} after the first installation.
+
+ To automatically enable extensions add
+ `"extensions.autoDisableScopes" = 0;`
+ to
+ [{option}`${moduleName}.profiles..settings`](#opt-${moduleName}.profiles._name_.settings)
+ '';
+ };
+
+ };
+ }));
+ default = { };
+ description = "Attribute set of ${name} profiles.";
+ };
+
+ enableGnomeExtensions = mkOption {
+ inherit visible;
+ type = types.bool;
+ default = false;
+ description = ''
+ Whether to enable the GNOME Shell native host connector. Note, you
+ also need to set the NixOS option
+ `services.gnome.gnome-browser-connector.enable` to
+ `true`.
+ '';
+ };
+ };
+
+ config = mkIf cfg.enable ({
+ assertions = [
+ (hm.assertions.assertPlatform moduleName pkgs supportedPlatforms)
+
+ (let
+ defaults =
+ catAttrs "name" (filter (a: a.isDefault) (attrValues cfg.profiles));
+ in {
+ assertion = cfg.profiles == { } || length defaults == 1;
+ message = "Must have exactly one default ${cfg.name} profile but found "
+ + toString (length defaults) + optionalString (length defaults > 1)
+ (", namely " + concatStringsSep ", " defaults);
+ })
+
+ (let
+ getContainers = profiles:
+ flatten
+ (mapAttrsToList (_: value: (attrValues value.containers)) profiles);
+
+ findInvalidContainerIds = profiles:
+ filter (container: container.id >= 4294967294)
+ (getContainers profiles);
+ in {
+ assertion = cfg.profiles == { }
+ || length (findInvalidContainerIds cfg.profiles) == 0;
+ message = "Container id must be smaller than 4294967294 (2^32 - 2)";
+ })
+
+ {
+ assertion = cfg.languagePacks == [ ] || cfg.package != null;
+ message = ''
+ 'programs.firefox.languagePacks' requires 'programs.firefox.package'
+ to be set to a non-null value.
+ '';
+ }
+
+ (mkNoDuplicateAssertion cfg.profiles "profile")
+ ] ++ (mapAttrsToList
+ (_: profile: mkNoDuplicateAssertion profile.containers "container")
+ cfg.profiles);
+
+ warnings = optional (cfg.enableGnomeExtensions or false) ''
+ Using '${moduleName}.enableGnomeExtensions' has been deprecated and
+ will be removed in the future. Please change to overriding the package
+ configuration using '${moduleName}.package' instead. You can refer to
+ its example for how to do this.
+ '';
+
+ programs.firefox.policies = {
+ ExtensionSettings = listToAttrs (map (lang:
+ nameValuePair "langpack-${lang}@firefox.mozilla.org" {
+ installation_mode = "normal_installed";
+ install_url =
+ "https://releases.mozilla.org/pub/firefox/releases/${cfg.package.version}/linux-x86_64/xpi/${lang}.xpi";
+ }) cfg.languagePacks);
+ };
+
+ home.packages = lib.optional (cfg.finalPackage != null) cfg.finalPackage;
+
+ home.file = mkMerge ([{
+ "${cfg.configPath}/profiles.ini" =
+ mkIf (cfg.profiles != { }) { text = profilesIni; };
+ }] ++ optional (cfg.vendorPath != null) {
+ "${nativeMessagingHostsPath}" = {
+ source =
+ "${nativeMessagingHostsJoined}/lib/mozilla/native-messaging-hosts";
+ recursive = true;
+ };
+ } ++ flip mapAttrsToList cfg.profiles (_: profile: {
+ "${profilesPath}/${profile.path}/.keep".text = "";
+
+ "${profilesPath}/${profile.path}/chrome/userChrome.css" =
+ mkIf (profile.userChrome != "") { text = profile.userChrome; };
+
+ "${profilesPath}/${profile.path}/chrome/userContent.css" =
+ mkIf (profile.userContent != "") { text = profile.userContent; };
+
+ "${profilesPath}/${profile.path}/user.js" = mkIf (profile.settings != { }
+ || profile.extraConfig != "" || profile.bookmarks != [ ]) {
+ text =
+ mkUserJs profile.settings profile.extraConfig profile.bookmarks;
+ };
+
+ "${profilesPath}/${profile.path}/containers.json" =
+ mkIf (profile.containers != { }) {
+ text = mkContainersJson profile.containers;
+ force = profile.containersForce;
+ };
+
+ "${profilesPath}/${profile.path}/search.json.mozlz4" = mkIf
+ (profile.search.default != null || profile.search.privateDefault != null
+ || profile.search.order != [ ] || profile.search.engines != { }) {
+ force = profile.search.force;
+ source = let
+ settings = {
+ version = 6;
+ engines = let
+ # Map of nice field names to internal field names.
+ # This is intended to be exhaustive and should be
+ # updated at every version bump.
+ internalFieldNames = (genAttrs [
+ "name"
+ "isAppProvided"
+ "loadPath"
+ "hasPreferredIcon"
+ "updateInterval"
+ "updateURL"
+ "iconUpdateURL"
+ "iconURL"
+ "iconMapObj"
+ "metaData"
+ "orderHint"
+ "definedAliases"
+ "urls"
+ ] (name: "_${name}")) // {
+ searchForm = "__searchForm";
+ };
+
+ processCustomEngineInput = input:
+ (removeAttrs input [ "icon" ])
+ // optionalAttrs (input ? icon) {
+ # Convenience to specify absolute path to icon
+ iconURL = "file://${input.icon}";
+ } // (optionalAttrs (input ? iconUpdateURL) {
+ # Convenience to default iconURL to iconUpdateURL so
+ # the icon is immediately downloaded from the URL
+ iconURL = input.iconURL or input.iconUpdateURL;
+ } // {
+ # Required for custom engine configurations, loadPaths
+ # are unique identifiers that are generally formatted
+ # like: [source]/path/to/engine.xml
+ loadPath = ''
+ [home-manager]/${moduleName}.profiles.${profile.name}.search.engines."${
+ replaceStrings [ "\\" ] [ "\\\\" ] input.name
+ }"'';
+ });
+
+ processEngineInput = name: input:
+ let
+ requiredInput = {
+ inherit name;
+ isAppProvided = input.isAppProvided or removeAttrs input
+ [ "metaData" ] == { };
+ metaData = input.metaData or { };
+ };
+ in if requiredInput.isAppProvided then
+ requiredInput
+ else
+ processCustomEngineInput (input // requiredInput);
+
+ buildEngineConfig = name: input:
+ mapAttrs' (name: value: {
+ name = internalFieldNames.${name} or name;
+ inherit value;
+ }) (processEngineInput name input);
+
+ sortEngineConfigs = configs:
+ let
+ buildEngineConfigWithOrder = order: name:
+ let
+ config = configs.${name} or {
+ _name = name;
+ _isAppProvided = true;
+ _metaData = { };
+ };
+ in config // {
+ _metaData = config._metaData // { inherit order; };
+ };
+
+ engineConfigsWithoutOrder =
+ attrValues (removeAttrs configs profile.search.order);
+
+ sortedEngineConfigs =
+ (imap buildEngineConfigWithOrder profile.search.order)
+ ++ engineConfigsWithoutOrder;
+ in sortedEngineConfigs;
+
+ engineInput = profile.search.engines // {
+ # Infer profile.search.default as an app provided
+ # engine if it's not in profile.search.engines
+ ${profile.search.default} =
+ profile.search.engines.${profile.search.default} or { };
+ } // {
+ ${profile.search.privateDefault} =
+ profile.search.engines.${profile.search.privateDefault} or { };
+ };
+ in sortEngineConfigs (mapAttrs buildEngineConfig engineInput);
+
+ metaData = optionalAttrs (profile.search.default != null) {
+ current = profile.search.default;
+ hash = "@hash@";
+ } // optionalAttrs (profile.search.privateDefault != null) {
+ private = profile.search.privateDefault;
+ privateHash = "@privateHash@";
+ } // {
+ useSavedOrder = profile.search.order != [ ];
+ };
+ };
+
+ # Home Manager doesn't circumvent user consent and isn't acting
+ # maliciously. We're modifying the search outside of the browser, but
+ # a claim by Mozilla to remove this would be very anti-user, and
+ # is unlikely to be an issue for our use case.
+ disclaimer = appName:
+ "By modifying this file, I agree that I am doing so "
+ + "only within ${appName} itself, using official, user-driven search "
+ + "engine selection processes, and in a way which does not circumvent "
+ + "user consent. I acknowledge that any attempt to change this file "
+ + "from outside of ${appName} is a malicious act, and will be responded "
+ + "to accordingly.";
+
+ salt = if profile.search.default != null then
+ profile.path + profile.search.default + disclaimer cfg.name
+ else
+ null;
+
+ privateSalt = if profile.search.privateDefault != null then
+ profile.path + profile.search.privateDefault
+ + disclaimer cfg.name
+ else
+ null;
+ in pkgs.runCommand "search.json.mozlz4" {
+ nativeBuildInputs = with pkgs; [ mozlz4a openssl ];
+ json = builtins.toJSON settings;
+ inherit salt privateSalt;
+ } ''
+ if [[ -n $salt ]]; then
+ export hash=$(echo -n "$salt" | openssl dgst -sha256 -binary | base64)
+ export privateHash=$(echo -n "$privateSalt" | openssl dgst -sha256 -binary | base64)
+ mozlz4a <(substituteStream json search.json.in --subst-var hash --subst-var privateHash) "$out"
+ else
+ mozlz4a <(echo "$json") "$out"
+ fi
+ '';
+ };
+
+ "${profilesPath}/${profile.path}/extensions" =
+ mkIf (profile.extensions != [ ]) {
+ source = let
+ extensionsEnvPkg = pkgs.buildEnv {
+ name = "hm-firefox-extensions";
+ paths = profile.extensions;
+ };
+ in "${extensionsEnvPkg}/share/mozilla/${extensionPath}";
+ recursive = true;
+ force = true;
+ };
+ }));
+ } // setAttrByPath modulePath { finalPackage = wrapPackage cfg.package; });
+}
+
diff --git a/tests/default.nix b/tests/default.nix
index 28ce4f64..1c143716 100644
--- a/tests/default.nix
+++ b/tests/default.nix
@@ -189,7 +189,7 @@ in import nmtSrc {
./modules/programs/bemenu
./modules/programs/borgmatic
./modules/programs/boxxy
- ./modules/programs/firefox
+ ./modules/programs/firefox/firefox.nix
./modules/programs/foot
./modules/programs/freetube
./modules/programs/fuzzel
diff --git a/tests/modules/programs/firefox/container-id-out-of-range.nix b/tests/modules/programs/firefox/container-id-out-of-range.nix
index 5dbeaedd..2ea08e88 100644
--- a/tests/modules/programs/firefox/container-id-out-of-range.nix
+++ b/tests/modules/programs/firefox/container-id-out-of-range.nix
@@ -1,27 +1,32 @@
+modulePath:
{ config, lib, ... }:
-{
- imports = [ ./setup-firefox-mock-overlay.nix ];
+with lib;
- config = lib.mkIf config.test.enableBig {
+let
+
+ firefoxMockOverlay = import ./setup-firefox-mock-overlay.nix modulePath;
+
+in {
+ imports = [ firefoxMockOverlay ];
+
+ config = mkIf config.test.enableBig ({
test.asserts.assertions.expected =
[ "Container id must be smaller than 4294967294 (2^32 - 2)" ];
+ } // setAttrByPath modulePath {
+ enable = true;
- programs.firefox = {
- enable = true;
+ profiles.my-profile = {
+ isDefault = true;
+ id = 1;
- profiles.my-profile = {
- isDefault = true;
- id = 1;
-
- containers = {
- "shopping" = {
- id = 4294967294;
- color = "blue";
- icon = "circle";
- };
+ containers = {
+ "shopping" = {
+ id = 4294967294;
+ color = "blue";
+ icon = "circle";
};
};
};
- };
+ });
}
diff --git a/tests/modules/programs/firefox/default.nix b/tests/modules/programs/firefox/default.nix
deleted file mode 100644
index 1cd462f2..00000000
--- a/tests/modules/programs/firefox/default.nix
+++ /dev/null
@@ -1,9 +0,0 @@
-{
- firefox-profile-settings = ./profile-settings.nix;
- firefox-state-version-19_09 = ./state-version-19_09.nix;
- firefox-deprecated-native-messenger = ./deprecated-native-messenger.nix;
- firefox-duplicate-profile-ids = ./duplicate-profile-ids.nix;
- firefox-duplicate-container-ids = ./duplicate-container-ids.nix;
- firefox-container-id-out-of-range = ./container-id-out-of-range.nix;
- firefox-policies = ./policies.nix;
-}
diff --git a/tests/modules/programs/firefox/deprecated-native-messenger.nix b/tests/modules/programs/firefox/deprecated-native-messenger.nix
index db70d405..87423aba 100644
--- a/tests/modules/programs/firefox/deprecated-native-messenger.nix
+++ b/tests/modules/programs/firefox/deprecated-native-messenger.nix
@@ -1,21 +1,26 @@
-{ config, lib, pkgs, ... }:
+modulePath:
+{ config, lib, ... }:
with lib;
-{
- imports = [ ./setup-firefox-mock-overlay.nix ];
+let
- config = lib.mkIf config.test.enableBig {
- programs.firefox = {
- enable = true;
- enableGnomeExtensions = true;
- };
+ moduleName = concatStringsSep "." modulePath;
+ firefoxMockOverlay = import ./setup-firefox-mock-overlay.nix modulePath;
+
+in {
+ imports = [ firefoxMockOverlay ];
+
+ config = mkIf config.test.enableBig (setAttrByPath modulePath {
+ enable = true;
+ enableGnomeExtensions = true;
+ } // {
test.asserts.warnings.expected = [''
- Using 'programs.firefox.enableGnomeExtensions' has been deprecated and
+ Using '${moduleName}.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
+ configuration using '${moduleName}.package' instead. You can refer to
its example for how to do this.
''];
- };
+ });
}
diff --git a/tests/modules/programs/firefox/duplicate-container-ids.nix b/tests/modules/programs/firefox/duplicate-container-ids.nix
index fce91fa0..2ad99b4b 100644
--- a/tests/modules/programs/firefox/duplicate-container-ids.nix
+++ b/tests/modules/programs/firefox/duplicate-container-ids.nix
@@ -1,35 +1,42 @@
+modulePath:
{ config, lib, ... }:
-{
- imports = [ ./setup-firefox-mock-overlay.nix ];
+with lib;
- config = lib.mkIf config.test.enableBig {
+let
+
+ cfg = getAttrFromPath modulePath config;
+
+ firefoxMockOverlay = import ./setup-firefox-mock-overlay.nix modulePath;
+
+in {
+ imports = [ firefoxMockOverlay ];
+
+ config = mkIf config.test.enableBig ({
test.asserts.assertions.expected = [''
- Must not have a Firefox container with an existing ID but
+ Must not have a ${cfg.name} container with an existing ID but
- ID 9 is used by dangerous, shopping''];
+ } // setAttrByPath modulePath {
+ enable = true;
- programs.firefox = {
- enable = true;
+ profiles = {
+ my-profile = {
+ isDefault = true;
+ id = 1;
- profiles = {
- my-profile = {
- isDefault = true;
- id = 1;
-
- containers = {
- "shopping" = {
- id = 9;
- color = "blue";
- icon = "circle";
- };
- "dangerous" = {
- id = 9;
- color = "red";
- icon = "circle";
- };
+ containers = {
+ "shopping" = {
+ id = 9;
+ color = "blue";
+ icon = "circle";
+ };
+ "dangerous" = {
+ id = 9;
+ color = "red";
+ icon = "circle";
};
};
};
};
- };
+ });
}
diff --git a/tests/modules/programs/firefox/duplicate-profile-ids.nix b/tests/modules/programs/firefox/duplicate-profile-ids.nix
index 9b0b7c06..ad946af1 100644
--- a/tests/modules/programs/firefox/duplicate-profile-ids.nix
+++ b/tests/modules/programs/firefox/duplicate-profile-ids.nix
@@ -1,23 +1,30 @@
+modulePath:
{ config, lib, ... }:
-{
- imports = [ ./setup-firefox-mock-overlay.nix ];
+with lib;
- config = lib.mkIf config.test.enableBig {
+let
+
+ cfg = getAttrFromPath modulePath config;
+
+ firefoxMockOverlay = import ./setup-firefox-mock-overlay.nix modulePath;
+
+in {
+ imports = [ firefoxMockOverlay ];
+
+ config = mkIf config.test.enableBig ({
test.asserts.assertions.expected = [''
- Must not have a Firefox profile with an existing ID but
+ Must not have a ${cfg.name} profile with an existing ID but
- ID 1 is used by first, second''];
+ } // setAttrByPath modulePath {
+ enable = true;
- programs.firefox = {
- enable = true;
-
- profiles = {
- first = {
- isDefault = true;
- id = 1;
- };
- second = { id = 1; };
+ profiles = {
+ first = {
+ isDefault = true;
+ id = 1;
};
+ second = { id = 1; };
};
- };
+ });
}
diff --git a/tests/modules/programs/firefox/firefox.nix b/tests/modules/programs/firefox/firefox.nix
new file mode 100644
index 00000000..6598d6ec
--- /dev/null
+++ b/tests/modules/programs/firefox/firefox.nix
@@ -0,0 +1,11 @@
+let name = "firefox";
+
+in builtins.mapAttrs (test: module: import module [ "programs" name ]) {
+ "${name}-profile-settings" = ./profile-settings.nix;
+ "${name}-state-version-19_09" = ./state-version-19_09.nix;
+ "${name}-deprecated-native-messenger" = ./deprecated-native-messenger.nix;
+ "${name}-duplicate-profile-ids" = ./duplicate-profile-ids.nix;
+ "${name}-duplicate-container-ids" = ./duplicate-container-ids.nix;
+ "${name}-container-id-out-of-range" = ./container-id-out-of-range.nix;
+ "${name}-policies" = ./policies.nix;
+}
diff --git a/tests/modules/programs/firefox/policies.nix b/tests/modules/programs/firefox/policies.nix
index 7b503d3d..5e02a191 100644
--- a/tests/modules/programs/firefox/policies.nix
+++ b/tests/modules/programs/firefox/policies.nix
@@ -1,22 +1,29 @@
+modulePath:
{ config, lib, pkgs, ... }:
-{
- imports = [ ./setup-firefox-mock-overlay.nix ];
+with lib;
- config = lib.mkIf config.test.enableBig {
+let
+
+ cfg = getAttrFromPath modulePath config;
+
+ firefoxMockOverlay = import ./setup-firefox-mock-overlay.nix modulePath;
+
+in {
+ imports = [ firefoxMockOverlay ];
+
+ config = mkIf config.test.enableBig ({
home.stateVersion = "23.05";
-
- programs.firefox = {
- enable = true;
- policies = { BlockAboutConfig = true; };
- package = pkgs.firefox.override {
- extraPolicies = { DownloadDirectory = "/foo"; };
- };
+ } // setAttrByPath modulePath {
+ enable = true;
+ policies = { BlockAboutConfig = true; };
+ package = pkgs.${cfg.wrappedPackageName}.override {
+ extraPolicies = { DownloadDirectory = "/foo"; };
};
-
+ }) // {
nmt.script = ''
jq=${lib.getExe pkgs.jq}
- config_file="${config.programs.firefox.finalPackage}/lib/firefox/distribution/policies.json"
+ config_file="${cfg.finalPackage}/lib/${cfg.wrappedPackageName}/distribution/policies.json"
assertFileExists "$config_file"
diff --git a/tests/modules/programs/firefox/profile-settings.nix b/tests/modules/programs/firefox/profile-settings.nix
index 8b781552..d7776eb4 100644
--- a/tests/modules/programs/firefox/profile-settings.nix
+++ b/tests/modules/programs/firefox/profile-settings.nix
@@ -1,177 +1,184 @@
+modulePath:
{ config, lib, pkgs, ... }:
-{
- imports = [ ./setup-firefox-mock-overlay.nix ];
+with lib;
- config = lib.mkIf config.test.enableBig {
- programs.firefox = {
- enable = true;
- profiles.basic.isDefault = true;
+let
- profiles.test = {
- id = 1;
- settings = {
- "general.smoothScroll" = false;
- "browser.newtabpage.pinned" = [{
- title = "NixOS";
- url = "https://nixos.org";
+ cfg = getAttrFromPath modulePath config;
+
+ firefoxMockOverlay = import ./setup-firefox-mock-overlay.nix modulePath;
+
+in {
+ imports = [ firefoxMockOverlay ];
+
+ config = mkIf config.test.enableBig (setAttrByPath modulePath {
+ enable = true;
+ profiles.basic.isDefault = true;
+
+ profiles.test = {
+ id = 1;
+ settings = {
+ "general.smoothScroll" = false;
+ "browser.newtabpage.pinned" = [{
+ title = "NixOS";
+ url = "https://nixos.org";
+ }];
+ };
+ };
+
+ profiles.bookmarks = {
+ id = 2;
+ settings = { "general.smoothScroll" = false; };
+ bookmarks = [
+ {
+ toolbar = true;
+ bookmarks = [{
+ name = "Home Manager";
+ url = "https://wiki.nixos.org/wiki/Home_Manager";
}];
- };
- };
+ }
+ {
+ name = "wikipedia";
+ tags = [ "wiki" ];
+ keyword = "wiki";
+ url = "https://en.wikipedia.org/wiki/Special:Search?search=%s&go=Go";
+ }
+ {
+ name = "kernel.org";
+ url = "https://www.kernel.org";
+ }
+ {
+ name = "Nix sites";
+ bookmarks = [
+ {
+ name = "homepage";
+ url = "https://nixos.org/";
+ }
+ {
+ name = "wiki";
+ tags = [ "wiki" "nix" ];
+ url = "https://wiki.nixos.org/";
+ }
+ {
+ name = "Nix sites";
+ bookmarks = [
+ {
+ name = "homepage";
+ url = "https://nixos.org/";
+ }
+ {
+ name = "wiki";
+ url = "https://wiki.nixos.org/";
+ }
+ ];
+ }
+ ];
+ }
+ ];
+ };
- profiles.bookmarks = {
- id = 2;
- settings = { "general.smoothScroll" = false; };
- bookmarks = [
- {
- toolbar = true;
- bookmarks = [{
- name = "Home Manager";
- url = "https://wiki.nixos.org/wiki/Home_Manager";
+ profiles.search = {
+ id = 3;
+ search = {
+ force = true;
+ default = "Google";
+ privateDefault = "DuckDuckGo";
+ order = [ "Nix Packages" "NixOS Wiki" ];
+ engines = {
+ "Nix Packages" = {
+ urls = [{
+ template = "https://search.nixos.org/packages";
+ params = [
+ {
+ name = "type";
+ value = "packages";
+ }
+ {
+ name = "query";
+ value = "{searchTerms}";
+ }
+ ];
}];
- }
- {
- name = "wikipedia";
- tags = [ "wiki" ];
- keyword = "wiki";
- url =
- "https://en.wikipedia.org/wiki/Special:Search?search=%s&go=Go";
- }
- {
- name = "kernel.org";
- url = "https://www.kernel.org";
- }
- {
- name = "Nix sites";
- bookmarks = [
- {
- name = "homepage";
- url = "https://nixos.org/";
- }
- {
- name = "wiki";
- tags = [ "wiki" "nix" ];
- url = "https://wiki.nixos.org/";
- }
- {
- name = "Nix sites";
- bookmarks = [
- {
- name = "homepage";
- url = "https://nixos.org/";
- }
- {
- name = "wiki";
- url = "https://wiki.nixos.org/";
- }
- ];
- }
- ];
- }
- ];
- };
- profiles.search = {
- id = 3;
- search = {
- force = true;
- default = "Google";
- privateDefault = "DuckDuckGo";
- order = [ "Nix Packages" "NixOS Wiki" ];
- engines = {
- "Nix Packages" = {
- urls = [{
- template = "https://search.nixos.org/packages";
- params = [
- {
- name = "type";
- value = "packages";
- }
- {
- name = "query";
- value = "{searchTerms}";
- }
- ];
- }];
+ icon =
+ "/run/current-system/sw/share/icons/hicolor/scalable/apps/nix-snowflake.svg";
- icon =
- "/run/current-system/sw/share/icons/hicolor/scalable/apps/nix-snowflake.svg";
-
- definedAliases = [ "@np" ];
- };
-
- "NixOS Wiki" = {
- urls = [{
- template =
- "https://wiki.nixos.org/index.php?search={searchTerms}";
- }];
- iconUpdateURL = "https://wiki.nixos.org/favicon.png";
- updateInterval = 24 * 60 * 60 * 1000;
- definedAliases = [ "@nw" ];
- };
-
- "Bing".metaData.hidden = true;
- "Google".metaData.alias = "@g";
+ definedAliases = [ "@np" ];
};
+
+ "NixOS Wiki" = {
+ urls = [{
+ template =
+ "https://wiki.nixos.org/index.php?search={searchTerms}";
+ }];
+ iconUpdateURL = "https://wiki.nixos.org/favicon.png";
+ updateInterval = 24 * 60 * 60 * 1000;
+ definedAliases = [ "@nw" ];
+ };
+
+ "Bing".metaData.hidden = true;
+ "Google".metaData.alias = "@g";
};
};
+ };
- profiles.searchWithoutDefault = {
- id = 4;
- search = {
- force = true;
- order = [ "Google" "Nix Packages" ];
- engines = {
- "Nix Packages" = {
- urls = [{
- template = "https://search.nixos.org/packages";
- params = [
- {
- name = "type";
- value = "packages";
- }
- {
- name = "query";
- value = "{searchTerms}";
- }
- ];
- }];
+ profiles.searchWithoutDefault = {
+ id = 4;
+ search = {
+ force = true;
+ order = [ "Google" "Nix Packages" ];
+ engines = {
+ "Nix Packages" = {
+ urls = [{
+ template = "https://search.nixos.org/packages";
+ params = [
+ {
+ name = "type";
+ value = "packages";
+ }
+ {
+ name = "query";
+ value = "{searchTerms}";
+ }
+ ];
+ }];
- definedAliases = [ "@np" ];
- };
- };
- };
- };
-
- profiles.containers = {
- id = 5;
- containers = {
- "shopping" = {
- id = 6;
- icon = "circle";
- color = "yellow";
+ definedAliases = [ "@np" ];
};
};
};
};
+ profiles.containers = {
+ id = 5;
+ containers = {
+ "shopping" = {
+ id = 6;
+ icon = "circle";
+ color = "yellow";
+ };
+ };
+ };
+ } // {
+
nmt.script = ''
assertFileRegex \
- home-path/bin/firefox \
+ home-path/bin/${cfg.wrappedPackageName} \
MOZ_APP_LAUNCHER
- assertDirectoryExists home-files/.mozilla/firefox/basic
+ assertDirectoryExists home-files/${cfg.configPath}/basic
assertFileContent \
- home-files/.mozilla/firefox/test/user.js \
+ home-files/${cfg.configPath}/test/user.js \
${./profile-settings-expected-user.js}
assertFileContent \
- home-files/.mozilla/firefox/containers/containers.json \
+ home-files/${cfg.configPath}/containers/containers.json \
${./profile-settings-expected-containers.json}
bookmarksUserJs=$(normalizeStorePaths \
- home-files/.mozilla/firefox/bookmarks/user.js)
+ home-files/${cfg.configPath}/bookmarks/user.js)
assertFileContent \
$bookmarksUserJs \
@@ -179,7 +186,7 @@
bookmarksFile="$(sed -n \
'/browser.bookmarks.file/ {s|^.*\(/nix/store[^"]*\).*|\1|;p}' \
- $TESTED/home-files/.mozilla/firefox/bookmarks/user.js)"
+ $TESTED/home-files/${cfg.configPath}/bookmarks/user.js)"
assertFileContent \
$bookmarksFile \
@@ -197,12 +204,12 @@
}
assertFirefoxSearchContent \
- home-files/.mozilla/firefox/search/search.json.mozlz4 \
+ home-files/${cfg.configPath}/search/search.json.mozlz4 \
${./profile-settings-expected-search.json}
assertFirefoxSearchContent \
- home-files/.mozilla/firefox/searchWithoutDefault/search.json.mozlz4 \
+ home-files/${cfg.configPath}/searchWithoutDefault/search.json.mozlz4 \
${./profile-settings-expected-search-without-default.json}
'';
- };
+ });
}
diff --git a/tests/modules/programs/firefox/setup-firefox-mock-overlay.nix b/tests/modules/programs/firefox/setup-firefox-mock-overlay.nix
index 0f0d182a..ecbd492f 100644
--- a/tests/modules/programs/firefox/setup-firefox-mock-overlay.nix
+++ b/tests/modules/programs/firefox/setup-firefox-mock-overlay.nix
@@ -1,16 +1,24 @@
-{ pkgs, ... }:
+modulePath:
+{ config, lib, pkgs, ... }:
-{
+with lib;
+
+let
+
+ cfg = getAttrFromPath modulePath config;
+
+in {
nixpkgs.overlays = [
(self: super: {
- firefox-unwrapped = pkgs.runCommandLocal "firefox-0" {
- meta.description = "I pretend to be Firefox";
- passthru.gtk3 = null;
- } ''
- mkdir -p "$out"/{bin,lib}
- touch "$out/bin/firefox"
- chmod 755 "$out/bin/firefox"
- '';
+ "${cfg.wrappedPackageName}-unwrapped" =
+ pkgs.runCommandLocal "${cfg.wrappedPackageName}-0" {
+ meta.description = "I pretend to be ${cfg.name}";
+ passthru.gtk3 = null;
+ } ''
+ mkdir -p "$out"/{bin,lib}
+ touch "$out/bin/${cfg.wrappedPackageName}"
+ chmod 755 "$out/bin/${cfg.wrappedPackageName}"
+ '';
chrome-gnome-shell =
pkgs.runCommandLocal "dummy-chrome-gnome-shell" { } ''
diff --git a/tests/modules/programs/firefox/state-version-19_09.nix b/tests/modules/programs/firefox/state-version-19_09.nix
index c4c75970..475705c3 100644
--- a/tests/modules/programs/firefox/state-version-19_09.nix
+++ b/tests/modules/programs/firefox/state-version-19_09.nix
@@ -1,19 +1,24 @@
+modulePath:
{ config, lib, pkgs, ... }:
with lib;
-{
- imports = [ ./setup-firefox-mock-overlay.nix ];
+let
- config = lib.mkIf config.test.enableBig {
+ cfg = getAttrFromPath modulePath config;
+
+ firefoxMockOverlay = import ./setup-firefox-mock-overlay.nix modulePath;
+
+in {
+ imports = [ firefoxMockOverlay ];
+
+ config = lib.mkIf config.test.enableBig ({
home.stateVersion = "19.09";
-
- programs.firefox.enable = true;
-
+ } // setAttrByPath modulePath { enable = true; } // {
nmt.script = ''
assertFileRegex \
- home-path/bin/firefox \
+ home-path/bin/${cfg.wrappedPackageName} \
MOZ_APP_LAUNCHER
'';
- };
+ });
}