Add zen extension config and fix zen policy config

This commit is contained in:
DashieTM 2025-03-14 23:10:08 +01:00
parent 58c42ed7d8
commit 4f04b5d683
11 changed files with 647 additions and 144 deletions

View file

@ -0,0 +1,456 @@
diff --git a/src/background/user-storage.ts b/src/background/user-storage.ts
index 54612fb3b1f6..298e5032fc94 100644
--- a/src/background/user-storage.ts
+++ b/src/background/user-storage.ts
@@ -5,7 +5,7 @@ import {PromiseBarrier} from '../utils/promise-barrier';
import {isURLMatched} from '../utils/url';
import {validateSettings} from '../utils/validation';
-import {readSyncStorage, readLocalStorage, writeSyncStorage, writeLocalStorage, removeSyncStorage, removeLocalStorage} from './utils/extension-api';
+import {readManagedStorage, readSyncStorage, readLocalStorage, writeSyncStorage, writeLocalStorage, removeSyncStorage, removeLocalStorage} from './utils/extension-api';
import {logWarn} from './utils/log';
@@ -78,12 +78,7 @@ export default class UserStorage {
return settings;
}
- private static async loadSettingsFromStorage(): Promise<UserSettings> {
- if (UserStorage.loadBarrier) {
- return await UserStorage.loadBarrier.entry();
- }
- UserStorage.loadBarrier = new PromiseBarrier();
-
+ private static async loadSettingsFromStorageWithoutManaged(): Promise<UserSettings> {
let local = await readLocalStorage(DEFAULT_SETTINGS);
if (local.schemeVersion < 2) {
@@ -113,10 +108,8 @@ export default class UserStorage {
if (local.syncSettings == null) {
local.syncSettings = DEFAULT_SETTINGS.syncSettings;
}
+
if (!local.syncSettings) {
- UserStorage.migrateAutomationSettings(local);
- UserStorage.fillDefaults(local);
- UserStorage.loadBarrier.resolve(local);
return local;
}
@@ -126,18 +119,34 @@ export default class UserStorage {
local.syncSettings = false;
UserStorage.set({syncSettings: false});
UserStorage.saveSyncSetting(false);
- UserStorage.loadBarrier.resolve(local);
return local;
}
const {errors: syncCfgErrors} = validateSettings($sync);
syncCfgErrors.forEach((err) => logWarn(err));
+ return $sync;
+ }
+
+ private static async loadSettingsFromStorage(): Promise<UserSettings> {
+ if (UserStorage.loadBarrier) {
+ return await UserStorage.loadBarrier.entry();
+ }
+ UserStorage.loadBarrier = new PromiseBarrier();
- UserStorage.migrateAutomationSettings($sync);
- UserStorage.fillDefaults($sync);
+ let settings = await UserStorage.loadSettingsFromStorageWithoutManaged();
- UserStorage.loadBarrier.resolve($sync);
- return $sync;
+ const managed = await readManagedStorage(settings);
+ const {errors: managedCfgErrors} = validateSettings(managed);
+ if (managedCfgErrors.length === 0) {
+ settings = managed;
+ } else {
+ managedCfgErrors.forEach((err) => logWarn(err));
+ }
+
+ UserStorage.migrateAutomationSettings(settings);
+ UserStorage.fillDefaults(settings);
+ UserStorage.loadBarrier.resolve(settings);
+ return settings;
}
static async saveSettings(): Promise<void> {
diff --git a/src/background/utils/extension-api.ts b/src/background/utils/extension-api.ts
index 6d18fc0919df..6812ac2e4224 100644
--- a/src/background/utils/extension-api.ts
+++ b/src/background/utils/extension-api.ts
@@ -97,6 +97,19 @@ export async function readLocalStorage<T extends {[key: string]: any}>(defaults:
});
}
+export async function readManagedStorage<T extends {[key: string]: any}>(defaults: T): Promise<T> {
+ return new Promise<T>((resolve) => {
+ chrome.storage.managed.get(defaults, (managed: T) => {
+ if (chrome.runtime.lastError) {
+ console.error(chrome.runtime.lastError.message);
+ resolve(defaults);
+ return;
+ }
+ resolve(managed);
+ });
+ });
+}
+
function prepareSyncStorage<T extends {[key: string]: any}>(values: T): {[key: string]: any} {
for (const key in values) {
const value = values[key];
diff --git a/src/managed-storage.json b/src/managed-storage.json
new file mode 100644
index 000000000000..e394d0f1ff60
--- /dev/null
+++ b/src/managed-storage.json
@@ -0,0 +1,304 @@
+{
+
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "type": "object",
+ "properties": {
+ "schemeVersion": {
+ "type": "integer"
+ },
+ "enabled": {
+ "type": "boolean"
+ },
+ "fetchNews": {
+ "type": "boolean"
+ },
+ "theme": {
+ "$ref": "Theme"
+ },
+ "presets": {
+ "type": "array",
+ "items": {
+ "$ref": "ThemePreset"
+ }
+ },
+ "customThemes": {
+ "type": "array",
+ "items": {
+ "$ref": "CustomSiteConfig"
+ }
+ },
+ "enabledByDefault": {
+ "type": "boolean"
+ },
+ "enabledFor": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "minLength": 1
+ }
+ },
+ "disabledFor": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "minLength": 1
+ }
+ },
+ "changeBrowserTheme": {
+ "type": "boolean"
+ },
+ "syncSettings": {
+ "type": "boolean"
+ },
+ "syncSitesFixes": {
+ "type": "boolean"
+ },
+ "automation": {
+ "$ref": "Automation"
+ },
+ "time": {
+ "$ref": "TimeSettings"
+ },
+ "location": {
+ "$ref": "LocationSettings"
+ },
+ "previewNewDesign": {
+ "type": "boolean"
+ },
+ "previewNewestDesign": {
+ "type": "boolean"
+ },
+ "enableForPDF": {
+ "type": "boolean"
+ },
+ "enableForProtectedPages": {
+ "type": "boolean"
+ },
+ "enableContextMenus": {
+ "type": "boolean"
+ },
+ "detectDarkTheme": {
+ "type": "boolean"
+ },
+ // Chrome's JSON schema format is weird and doesn't support `definitions` property and thus `#/definitions` references
+ // https://datatracker.ietf.org/doc/html/draft-zyp-json-schema-03
+ // This "property" mimics it
+ "definitions": {
+ "type": "object",
+ "properties": {
+ "Theme": {
+ "id": "Theme",
+ "type": "object",
+ "properties": {
+ "mode": {
+ "$ref": "FilterMode"
+ },
+ "brightness": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 200
+ },
+ "contrast": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 200
+ },
+ "grayscale": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 100
+ },
+ "sepia": {
+ "type": "integer",
+ "minimum": 0,
+ "maximum": 100
+ },
+ "useFont": {
+ "type": "boolean"
+ },
+ "fontFamily": {
+ "type": "string",
+ "minLength": 1
+ },
+ "textStroke": {
+ "type": "number"
+ },
+ "engine": {
+ "type": "string",
+ "enum": [
+ "cssFilter",
+ "svgFilter",
+ "staticTheme",
+ "dynamicTheme"
+ ]
+ },
+ "stylesheet": {
+ "type": "string"
+ },
+ "darkSchemeBackgroundColor": {
+ "$ref": "HexColor"
+ },
+ "darkSchemeTextColor": {
+ "$ref": "HexColor"
+ },
+ "lightSchemeBackgroundColor": {
+ "$ref": "HexColor"
+ },
+ "lightSchemeTextColor": {
+ "$ref": "HexColor"
+ },
+ "scrollbarColor": {
+ "$ref": "HexColorOrAuto"
+ },
+ "selectionColor": {
+ "$ref": "HexColorOrAuto"
+ },
+ "styleSystemControls": {
+ "type": "boolean"
+ },
+ "lightColorScheme": {
+ "type": "string",
+ "minLength": 1
+ },
+ "darkColorScheme": {
+ "type": "string",
+ "minLength": 1
+ },
+ "immediateModify": {
+ "type": "boolean"
+ }
+ }
+ },
+ "HexColor": {
+ "id": "HexColor",
+ "type": "string",
+ "pattern": "^[0-9a-f]{6}$"
+ },
+ "HexColorOrAuto": {
+ "id": "HexColorOrAuto",
+ "type": "string",
+ "pattern": "^([0-9a-f]{6}|auto)$"
+ },
+ "FilterMode": {
+ "id": "FilterMode",
+ "type": "integer",
+ "enum": [
+ 0,
+ 1
+ ]
+ },
+ "ThemePreset": {
+ "id": "ThemePreset",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "minLength": 1
+ },
+ "name": {
+ "type": "string",
+ "minLength": 1
+ },
+ "urls": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "minLength": 1
+ }
+ },
+ "theme": {
+ "$ref": "Theme"
+ }
+ },
+ "required": [
+ "id",
+ "name",
+ "urls",
+ "theme"
+ ]
+ },
+ "CustomSiteConfig": {
+ "id": "CustomSiteConfig",
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "minLength": 1
+ }
+ },
+ "theme": {
+ "$ref": "Theme"
+ },
+ "builtin": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "url",
+ "theme"
+ ]
+ },
+ "Automation": {
+ "id": "Automation",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "mode": {
+ "$ref": "AutomationMode"
+ },
+ "behavior": {
+ "type": "string",
+ "enum": [
+ "OnOff",
+ "Scheme"
+ ]
+ }
+ }
+ },
+ "AutomationMode": {
+ "id": "AutomationMode",
+ "type": "string",
+ "enum": [
+ "",
+ "time",
+ "system",
+ "location"
+ ]
+ },
+ "TimeSettings": {
+ "id": "TimeSettings",
+ "type": "object",
+ "properties": {
+ "activation": {
+ "$ref": "Time"
+ },
+ "deactivation": {
+ "$ref": "Time"
+ }
+ }
+ },
+ "Time": {
+ "id": "Time",
+ "type": "string",
+ "pattern": "^((0?[0-9])|(1[0-9])|(2[0-3])):([0-5][0-9])$"
+ },
+ "LocationSettings": {
+ "id": "LocationSettings",
+ "type": "object",
+ "properties": {
+ "latitude": {
+ "type": "number"
+ },
+ "longitude": {
+ "type": "number"
+ }
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/tasks/bundle-manifest.js b/tasks/bundle-manifest.js
index ae29531e67b7..f4058a129f52 100644
--- a/tasks/bundle-manifest.js
+++ b/tasks/bundle-manifest.js
@@ -4,6 +4,7 @@ import {PLATFORM} from './platform.js';
import * as reload from './reload.js';
import {createTask} from './task.js';
import {readJSON, writeJSON} from './utils.js';
+import {copyFile} from 'node:fs/promises';
async function patchManifest(platform, debug, watch, test) {
const manifest = await readJSON(absolutePath('src/manifest.json'));
@@ -16,6 +17,11 @@ async function patchManifest(platform, debug, watch, test) {
if (platform === PLATFORM.CHROMIUM_MV3) {
patched.browser_action = undefined;
}
+ if (platform === PLATFORM.CHROMIUM_MV2 || platform === PLATFORM.CHROMIUM_MV3) {
+ patched.storage = {
+ managed_schema: 'managed-storage.json',
+ };
+ }
if (debug) {
patched.version = '1';
patched.description = `Debug build, platform: ${platform}, watch: ${watch ? 'yes' : 'no'}.`;
@@ -42,6 +48,9 @@ async function manifests({platforms, debug, watch, test}) {
const manifest = await patchManifest(platform, debug, watch, test);
const destDir = getDestDir({debug, platform});
await writeJSON(`${destDir}/manifest.json`, manifest);
+ if (platform === PLATFORM.CHROMIUM_MV2 || platform === PLATFORM.CHROMIUM_MV3) {
+ await copyFile(absolutePath('src/managed-storage.json'), `${destDir}/managed-storage.json`);
+ }
}
}
@@ -49,7 +58,7 @@ const bundleManifestTask = createTask(
'bundle-manifest',
manifests,
).addWatcher(
- ['src/manifest*.json'],
+ ['src/manifest*.json', 'src/managed-storage.json'],
async (changedFiles, _, buildPlatforms) => {
const chrome = changedFiles.some((file) => file.endsWith('manifest.json'));
const platforms = {};

View file

@ -0,0 +1,23 @@
# credits to Voronind for darkreader config https://github.com/voronind-com/nix/blob/main/home/program/firefox/default.nix
{
lib,
stable,
...
}:
stable.buildNpmPackage rec {
version = "4.9.99";
pname = "dark-reader";
npmDepsHash = "sha256-m41HkwgbeRRmxJALQFJl/grYjjIqFOc47ltaesob1FA=";
env.ESBUILD_BINARY_PATH = lib.getExe stable.esbuild;
patches = [./darkeader.patch];
src = stable.fetchFromGitHub {
hash = "sha256-K375/4qOyE1Tp/T5V5uCGcNd1IVVbT1Pjdnq/8oRHj0=";
owner = "darkreader";
repo = "darkreader";
rev = "v${version}";
};
installPhase = ''
mkdir -p $out
cp build/release/darkreader-firefox.xpi $out/latest.xpi
'';
}

View file

@ -9,8 +9,8 @@ in {
"zen-browser"
];
name = "Zen Browser";
wrappedPackageName = "zen-browser-unwrapped";
unwrappedPackageName = "zen-browser";
wrappedPackageName = "zen";
unwrappedPackageName = "zen-unwrapped";
visible = true;
platforms = {
linux = {

View file

@ -1,11 +1,25 @@
# credits to Voronind for darkreader config https://github.com/voronind-com/nix/blob/main/home/program/firefox/default.nix
{
lib,
config,
options,
inputs,
stable,
system,
pkgs,
...
}: {
}: let
# at time of using this here, stylix might not be evaluated yet
# hence ensure it is by using base16 mkSchemeAttrs
base16 = pkgs.callPackage inputs.base16.lib {};
scheme = base16.mkSchemeAttrs config.stylix.base16Scheme;
mkExtension = id: install_url: {
${id} = {
inherit install_url;
installation_mode = "normal_installed";
};
};
in {
options.mods.browser.zen = {
enable = lib.mkOption {
default = false;
@ -13,6 +27,37 @@
type = lib.types.bool;
description = "Enables the zen browser";
};
extensions = lib.mkOption {
default = [
(mkExtension "uBlock0@raymondhill.net" "https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi")
(mkExtension "{a6c4a591-f1b2-4f03-b3ff-767e5bedf4e7}" "https://addons.mozilla.org/firefox/downloads/latest/user-agent-string-switcher/latest.xpi")
(mkExtension "{d7742d87-e61d-4b78-b8a1-b469842139fa}" "https://addons.mozilla.org/firefox/downloads/latest/vimium-ff/latest.xpi")
(mkExtension "firefox@ghostery.com" "https://addons.mozilla.org/firefox/downloads/latest/ghostery/latest.xpi")
(mkExtension "CanvasBlocker@kkapsner.de" "https://addons.mozilla.org/firefox/downloads/latest/canvasblocker/latest.xpi")
(mkExtension "jid1-KKzOGWgsW3Ao4Q@jetpack" "https://addons.mozilla.org/firefox/downloads/latest/i-dont-care-about-cookies/latest.xpi")
(mkExtension "keepassxc-browser@keepassxc.org" "https://addons.mozilla.org/firefox/downloads/latest/keepassxc-browser/latest.xpi")
(mkExtension "@react-devtools" "https://addons.mozilla.org/firefox/downloads/latest/react-devtools/latest.xpi")
(mkExtension "extension@redux.devtools" "https://addons.mozilla.org/firefox/downloads/latest/reduxdevtools/latest.xpi")
(mkExtension "private-relay@firefox.com" "https://addons.mozilla.org/firefox/downloads/latest/private-relay/latest.xpi")
(mkExtension "addon@darkreader.org" "file://${pkgs.callPackage ./darkreader.nix {inherit lib stable;}}/latest.xpi")
];
example = [];
type = with lib.types; listOf anything;
description = ''
List of extensions via attrsets:
```nix
# id
# figure out the id via:
# nix run github:tupakkatapa/mozid -- 'https://addons.mozilla.org/en/firefox/addon/ublock-origin'
"uBlock0@raymondhill.net" = {
# install url
install_url = "https://addons.mozilla.org/firefox/downloads/latest/ublock-origin/latest.xpi";
# method https://mozilla.github.io/policy-templates/#extensionsettings
installation_mode = "force_installed";
};
```
'';
};
configuration = lib.mkOption {
default = {
EnableTrackingProtection = {
@ -22,15 +67,10 @@
Fingerprinting = true;
};
DisablePocket = true;
DisplayBookmarksToolbar = "never";
DisplayMenuBar = "default-off";
CaptivePortal = false;
DisableFirefoxStudies = true;
DisableTelemetry = true;
DisableFirefoxAccounts = false;
NoDefaultBookmarks = true;
OfferToSaveLogins = false;
OfferToSaveLoginsDefault = false;
PasswordManagerEnabled = false;
FirefoxHome = {
Search = true;
@ -43,27 +83,22 @@
ExtensionRecommendations = false;
SkipOnboarding = true;
};
"3rdparty".Extensions = {
"addon@darkreader.org" = {
theme = {
darkSchemeBackgroundColor = "#${scheme.base00}";
darkSchemeTextColor = "#${scheme.base05}";
};
previewNewDesign = true;
};
};
};
example = {};
type = with lib.types; attrsOf anything;
description = "Zen policy configuration. See https://mozilla.github.io/policy-templates for more information.";
};
profiles = lib.mkOption {
default = let
extensions = [
pkgs.nur.repos.rycee.firefox-addons.darkreader
pkgs.nur.repos.rycee.firefox-addons.ublock-origin
pkgs.nur.repos.rycee.firefox-addons.ghostery
pkgs.nur.repos.rycee.firefox-addons.canvasblocker
pkgs.nur.repos.rycee.firefox-addons.i-dont-care-about-cookies
pkgs.nur.repos.rycee.firefox-addons.keepassxc-browser
pkgs.nur.repos.rycee.firefox-addons.vimium
pkgs.nur.repos.rycee.firefox-addons.react-devtools
pkgs.nur.repos.rycee.firefox-addons.reduxdevtools
pkgs.nur.repos.rycee.firefox-addons.user-agent-string-switcher
pkgs.nur.repos.rycee.firefox-addons.private-relay
];
in [
default = [
{
name = "${config.conf.username}";
value = {
@ -76,7 +111,6 @@
zen.theme.accent-color = "#b4bbff";
extensions.autoDisableScopes = 0;
};
extensions.packages = extensions;
isDefault = true;
id = 0;
};
@ -93,7 +127,6 @@
zen.theme.accent-color = "#b4bbff";
extensions.autoDisableScopes = 0;
};
extensions.packages = extensions;
isDefault = false;
id = 1;
};
@ -122,25 +155,15 @@
enable = true;
package =
pkgs.wrapFirefox
(inputs.zen-browser.packages.${pkgs.system}.default.overrideAttrs (prevAttrs: {
passthru =
prevAttrs.passthru
or {}
// {
applicationName = "Zen Browser";
binaryName = "zen";
ffmpegSupport = true;
gssSupport = true;
gtk3 = pkgs.gtk3;
};
}))
inputs.zen-browser.packages.${system}.zen-browser-unwrapped
{
icon = "zen-beta";
wmClass = "zen";
hasMozSystemDirPatch = false;
pname = "zen-browser";
extraPolicies =
config.mods.browser.zen.configuration
// {
ExtensionSettings = builtins.foldl' (acc: ext: acc // ext) {} config.mods.browser.zen.extensions;
};
};
policies = config.mods.browser.zen.configuration;
profiles = builtins.listToAttrs config.mods.browser.zen.profiles;
};
}