From patchwork Tue Oct 17 12:48:55 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Cl=C3=A9ment_Lassieur?= X-Patchwork-Id: 54933 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id 1A87727BBE9; Tue, 17 Oct 2023 13:50:05 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.7 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,MAILING_LIST_MULTI,SPF_HELO_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 5D05727BBE2 for ; Tue, 17 Oct 2023 13:50:01 +0100 (BST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qsjW7-000387-0x; Tue, 17 Oct 2023 08:49:49 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qsjVy-00037k-04 for guix-patches@gnu.org; Tue, 17 Oct 2023 08:49:38 -0400 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qsjVx-0001Td-Ol for guix-patches@gnu.org; Tue, 17 Oct 2023 08:49:37 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qsjWM-0007Qd-3c; Tue, 17 Oct 2023 08:50:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#66408] [PATCH v4] gnu: icecat: Add support for Guix packaged extensions. References: In-Reply-To: Resent-From: =?utf-8?q?Cl=C3=A9ment?= Lassieur Original-Sender: "Debbugs-submit" Resent-CC: jonathan.brielmaier@web.de, guix-patches@gnu.org Resent-Date: Tue, 17 Oct 2023 12:50:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 66408 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 66408@debbugs.gnu.org Cc: =?utf-8?q?Cl=C3=A9ment?= Lassieur , Jonathan Brielmaier X-Debbugs-Original-Xcc: Jonathan Brielmaier Received: via spool by 66408-submit@debbugs.gnu.org id=B66408.169754699628539 (code B ref 66408); Tue, 17 Oct 2023 12:50:02 +0000 Received: (at 66408) by debbugs.gnu.org; 17 Oct 2023 12:49:56 +0000 Received: from localhost ([127.0.0.1]:58832 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qsjWF-0007QE-Pc for submit@debbugs.gnu.org; Tue, 17 Oct 2023 08:49:56 -0400 Received: from wout4-smtp.messagingengine.com ([64.147.123.20]:56023) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qsjWA-0007Px-VG for 66408@debbugs.gnu.org; Tue, 17 Oct 2023 08:49:54 -0400 Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.west.internal (Postfix) with ESMTP id 1638C32009A2; Tue, 17 Oct 2023 08:49:19 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute1.internal (MEProxy); Tue, 17 Oct 2023 08:49:19 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lassieur.org; h= cc:cc:content-transfer-encoding:content-type:content-type:date :date:from:from:in-reply-to:message-id:mime-version:reply-to :sender:subject:subject:to:to; s=fm2; t=1697546958; x= 1697633358; bh=3AS6rPLUSThAoxf1M0zhl7RDzcBl+VoXB2MVOumHuNQ=; b=U m2eICrzeSmBzAenFozP5BO1ZDySZHfkrjLdOPu/G+B8q8PaxMLCZh4dh7GRLxyqL ZlsXmbQ8b9VEkswLhSg7FnfUcDxgSFR0kGRGUFaZLMweXbGfl7zS9fe8wCv3yyam u4FwCF70L4J4WO9RIA93HMl2SLgTHlO4te27ZCwMEpbmHMPzyOj6HG45G48C9tqz Y8JoP55P9yFD2zZ6zhfxNbXpC1xdgPgDJftN5LSJd/WMmqEcsuaMNKSKs3PykdhP KpIgbRxfpM4Yyzr1hVbO47rUmkLwD4qzRIArvmpRkw7v8D5NBUEZPE51y0kCsI2p z8ydMie7v3Bkw0VMA7Jkg== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-transfer-encoding :content-type:content-type:date:date:feedback-id:feedback-id :from:from:in-reply-to:message-id:mime-version:reply-to:sender :subject:subject:to:to:x-me-proxy:x-me-proxy:x-me-sender :x-me-sender:x-sasl-enc; s=fm3; t=1697546958; x=1697633358; bh=3 AS6rPLUSThAoxf1M0zhl7RDzcBl+VoXB2MVOumHuNQ=; b=oUbHzgxifD6imeqTm ubD9+8fe+Qhat57hFW2G6W7mvpneNjxVqpnWqVtdF9m7qmIa5mYNAwJlkZtWZYAi pWQ4hr7thN82d765Fph7vvxQveS6a9uvtEFFX7/EA+KKb4sT/W1NrT0XS1CLwbdc Px2BJw8gbHK8Z97EQelqdlTjrgUdz30bgmD40TH9xSblukHvNJhxhUTB7RxnyI1x NfzaXrpkZVOwv5xF+uPWn5wKcp6lEIhelyFYcxYDykX8v4Mwnpz1jXBa9nA2AuIy kyKghjr2fbgPaKPKxkgBtW1LW3l3KPgaUc08+MNvBb8Q8TPKpUS1LJ9YioiwOBlR rHj/A== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvkedrjedvgdehiecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecunecujfgurhephffvvefufffkofggtgfgsehtkeertd ertdejnecuhfhrohhmpeevlhormhgvnhhtucfnrghsshhivghurhcuoegtlhgvmhgvnhht sehlrghsshhivghurhdrohhrgheqnecuggftrfgrthhtvghrnhepffdufeethfehveevie dtjedvteevueegkeevgffgffehtedvjeeigeeghedvffelnecuffhomhgrihhnpehgnhhu rdhorhhgnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehmrghilhhfrhhomh eptghlvghmvghntheslhgrshhsihgvuhhrrdhorhhg X-ME-Proxy: Feedback-ID: i4c21472a:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Tue, 17 Oct 2023 08:49:17 -0400 (EDT) From: =?utf-8?q?Cl=C3=A9ment?= Lassieur Date: Tue, 17 Oct 2023 14:48:55 +0200 Message-ID: <4df560c46b4d4512cabcce18b8d3a38d2f2730bc.1697546935.git.clement@lassieur.org> X-Mailer: git-send-email 2.41.0 MIME-Version: 1.0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches * gnu/build/icecat-extension.scm: New file with a MAKE-ICECAT-EXTENSION procedure that makes sure the add-on directory is a symlink, so that Icecat can normalize it into a package store path. * gnu/local.mk (dist_patch_DATA): Register it, as well as new patches. * gnu/packages/browser-extensions.scm (ublock-origin)[properties]: Store the add-on ID so that it is accessible in MAKE-ICECAT-EXTENSION. [arguments]: Use the add-on ID as root directory. (ublock-origin/icecat): New procedure. * gnu/packages/gnuzilla.scm (icecat-minimal)[arguments]: Rewrite the unused 'apply-guix-specific-patches' phase so that it applies the following two patches. [native-search-paths]: New field. * gnu/packages/patches/icecat-compare-paths.patch: New patch that compares add-on paths (which are package store paths) to detect package changes. * gnu/packages/patches/icecat-use-guix-extensions.patch: New patch that replaces "/usr/share/mozilla/extensions" with "$ICECAT_EXTENSION_DIR". --- gnu/build/icecat-extension.scm | 71 +++++++++++++++++++ gnu/local.mk | 3 + gnu/packages/browser-extensions.scm | 13 +++- gnu/packages/gnuzilla.scm | 22 +++--- .../patches/icecat-compare-paths.patch | 19 +++++ .../patches/icecat-use-guix-extensions.patch | 40 +++++++++++ 6 files changed, 155 insertions(+), 13 deletions(-) create mode 100644 gnu/build/icecat-extension.scm create mode 100644 gnu/packages/patches/icecat-compare-paths.patch create mode 100644 gnu/packages/patches/icecat-use-guix-extensions.patch base-commit: 5498835bb38c0de57f284f0fa6b1178ecdcaf678 diff --git a/gnu/build/icecat-extension.scm b/gnu/build/icecat-extension.scm new file mode 100644 index 000000000000..8ecd8a505f72 --- /dev/null +++ b/gnu/build/icecat-extension.scm @@ -0,0 +1,71 @@ +;;; GNU Guix --- Functional package management for GNU +;;; Copyright © 2020, 2021 Marius Bakke +;;; Copyright © 2023 Clément Lassieur +;;; +;;; This file is part of GNU Guix. +;;; +;;; GNU Guix is free software; you can redistribute it and/or modify it +;;; under the terms of the GNU General Public License as published by +;;; the Free Software Foundation; either version 3 of the License, or (at +;;; your option) any later version. +;;; +;;; GNU Guix is distributed in the hope that it will be useful, but +;;; WITHOUT ANY WARRANTY; without even the implied warranty of +;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;;; GNU General Public License for more details. +;;; +;;; You should have received a copy of the GNU General Public License +;;; along with GNU Guix. If not, see . + +(define-module (gnu build icecat-extension) + #:use-module (guix gexp) + #:use-module (guix packages) + #:use-module (guix build-system trivial) + #:export (make-icecat-extension)) + +(define* (make-icecat-extension pkg #:optional (pkg-output "out")) + "Create an Icecat extension from package PKG and return a package that, +when installed, will make the extension contained in PKG available as an +Icecat browser extension. PKG-OUTPUT specifies which output of PKG to use." + (package + (inherit pkg) + (name (string-append (package-name pkg) "-icecat")) + (native-inputs '()) + (inputs '()) + (propagated-inputs '()) + (outputs '("out")) + (build-system trivial-build-system) + (arguments + (list + #:modules '((guix build utils)) + #:builder + #~(begin + (use-modules (guix build utils)) + (let* ((id #$(assq-ref (package-properties pkg) 'id)) + (moz-app-id "{ec8030f7-c20a-464f-9b0e-13a3a9e97384}") + (search-dir (string-append #$output + "/share/icecat/extensions/" + moz-app-id))) + ;; Icecat's iterates over `search-dir` for directories. If a + ;; directory's name is not a valid add-on ID, it is ignored. See + ;; `DirectoryLocation::readAddons()` in XPIProvider.jsm. + + ;; This directory has to be a symlink, because Icecat's + ;; `_readLinkFile(aFile)` calls `normalize()` only if `aFile` is a + ;; symlink. + + ;; Normalizing is required because Icecat compares the add-on path + ;; against its local database to know if there is an extension + ;; update. We want the add-on path to be the package store path, + ;; so that a path change is detected every time the package is + ;; updated. See `updateExistingAddon()` in XPIDatabase.jsm, with + ;; our patch `icecat-compare-paths.patch`. + + ;; We don't want the add-on path to be the profile store path, + ;; which would change too often. We don't want the add-on path to + ;; be hard-coded ("/usr/share/mozilla/extensions") either because + ;; it would never change. + + (mkdir-p search-dir) + (symlink (in-vicinity (ungexp pkg pkg-output) id) + (in-vicinity search-dir id)))))))) diff --git a/gnu/local.mk b/gnu/local.mk index 13c2b949449d..5e8aaea9ff99 100644 --- a/gnu/local.mk +++ b/gnu/local.mk @@ -761,6 +761,7 @@ GNU_SYSTEM_MODULES = \ %D%/build/chromium-extension.scm \ %D%/build/cross-toolchain.scm \ %D%/build/dbus-service.scm \ + %D%/build/icecat-extension.scm \ %D%/build/image.scm \ %D%/build/jami-service.scm \ %D%/build/file-systems.scm \ @@ -1416,6 +1417,8 @@ dist_patch_DATA = \ %D%/packages/patches/icecat-makeicecat.patch \ %D%/packages/patches/icecat-102-makeicecat.patch \ %D%/packages/patches/icecat-avoid-bundled-libraries.patch \ + %D%/packages/patches/icecat-compare-paths.patch \ + %D%/packages/patches/icecat-use-guix-extensions.patch \ %D%/packages/patches/icecat-use-system-graphite2+harfbuzz.patch \ %D%/packages/patches/icecat-use-system-media-libs.patch \ %D%/packages/patches/icedtea-7-hotspot-aarch64-use-c++98.patch \ diff --git a/gnu/packages/browser-extensions.scm b/gnu/packages/browser-extensions.scm index 3f6da8d77a3f..68c38a76d8ac 100644 --- a/gnu/packages/browser-extensions.scm +++ b/gnu/packages/browser-extensions.scm @@ -1,6 +1,7 @@ ;;; GNU Guix --- Functional package management for GNU ;;; Copyright © 2020, 2021 Marius Bakke ;;; Copyright © 2023 Nicolas Graves +;;; Copyright © 2023 Clément Lassieur ;;; ;;; This file is part of GNU Guix. ;;; @@ -25,6 +26,7 @@ (define-module (gnu packages browser-extensions) #:use-module (guix build-system gnu) #:use-module ((guix licenses) #:prefix license:) #:use-module (gnu build chromium-extension) + #:use-module (gnu build icecat-extension) #:use-module (gnu packages compression) #:use-module (gnu packages python)) @@ -98,6 +100,7 @@ (define ublock-origin "1i8rnij3sbwg6vj6znprrsca0n5xjzhmhppaa8v6jyxg6wrrfch1")))) (build-system gnu-build-system) (outputs '("xpi" "firefox" "chromium")) + (properties '((id . "uBlock0@raymondhill.net"))) (arguments (list #:tests? #f ;no tests @@ -125,9 +128,10 @@ (define ublock-origin (invoke "./tools/make-chromium.sh"))) (add-after 'build-chromium 'install (lambda* (#:key outputs #:allow-other-keys) - (let ((firefox (assoc-ref outputs "firefox")) - (xpi (assoc-ref outputs "xpi")) - (chromium (assoc-ref outputs "chromium"))) + (let* ((id #$(assq-ref properties 'id)) + (firefox (in-vicinity (assoc-ref outputs "firefox") id)) + (xpi (assoc-ref outputs "xpi")) + (chromium (assoc-ref outputs "chromium"))) (install-file "dist/build/uBlock0.firefox.xpi" (string-append xpi "/lib/mozilla/extensions")) (copy-recursively "dist/build/uBlock0.firefox" firefox) @@ -142,3 +146,6 @@ (define ublock-origin (define-public ublock-origin/chromium (make-chromium-extension ublock-origin "chromium")) + +(define-public ublock-origin/icecat + (make-icecat-extension ublock-origin "firefox")) diff --git a/gnu/packages/gnuzilla.scm b/gnu/packages/gnuzilla.scm index a367d7a00ff6..608219c97303 100644 --- a/gnu/packages/gnuzilla.scm +++ b/gnu/packages/gnuzilla.scm @@ -885,16 +885,13 @@ (define-public icecat-minimal #:phases #~(modify-phases %standard-phases (add-after 'unpack 'apply-guix-specific-patches - (lambda* (#:key inputs native-inputs #:allow-other-keys) - (let ((patch (search-input-file inputs "bin/patch"))) - (for-each (match-lambda - ((label . file) - (when (and (string-prefix? "icecat-" label) - (string-suffix? ".patch" label)) - (format #t "applying '~a'...~%" file) - (invoke patch "--force" "--no-backup-if-mismatch" - "-p1" "--input" file)))) - (or native-inputs inputs))))) + (lambda _ + (for-each + (lambda (file) (invoke "patch" "--force" "-p1" "-i" file)) + '(#$(local-file + (search-patch "icecat-compare-paths.patch")) + #$(local-file + (search-patch "icecat-use-guix-extensions.patch")))))) (add-after 'apply-guix-specific-patches 'remove-bundled-libraries (lambda _ ;; Remove bundled libraries that we don't use, since they may @@ -1138,6 +1135,11 @@ (define-public icecat-minimal '("default16.png" "default22.png" "default24.png" "default32.png" "default48.png" "content/icon64.png" "mozicon128.png" "default256.png")))))))) + (native-search-paths + (list (search-path-specification + (variable "ICECAT_EXTENSION_DIR") + (separator #f) ;single entry + (files '("share/icecat/extensions"))))) (home-page "https://www.gnu.org/software/gnuzilla/") (synopsis "Entirely free browser derived from Mozilla Firefox") (description diff --git a/gnu/packages/patches/icecat-compare-paths.patch b/gnu/packages/patches/icecat-compare-paths.patch new file mode 100644 index 000000000000..9205899dc0c4 --- /dev/null +++ b/gnu/packages/patches/icecat-compare-paths.patch @@ -0,0 +1,19 @@ +--- a/toolkit/mozapps/extensions/internal/XPIDatabase.jsm ++++ b/toolkit/mozapps/extensions/internal/XPIDatabase.jsm +@@ -3452,6 +3452,7 @@ const XPIDatabaseReconcile = { + if ( + newAddon || + oldAddon.updateDate != xpiState.mtime || ++ oldAddon.path != xpiState.path || + (aUpdateCompatibility && this.isAppBundledLocation(installLocation)) + ) { + newAddon = this.updateMetadata( +@@ -3460,8 +3461,6 @@ const XPIDatabaseReconcile = { + xpiState, + newAddon + ); +- } else if (oldAddon.path != xpiState.path) { +- newAddon = this.updatePath(installLocation, oldAddon, xpiState); + } else if (aUpdateCompatibility || aSchemaChange) { + newAddon = this.updateCompatibility( + installLocation, diff --git a/gnu/packages/patches/icecat-use-guix-extensions.patch b/gnu/packages/patches/icecat-use-guix-extensions.patch new file mode 100644 index 000000000000..ed1ce922d55b --- /dev/null +++ b/gnu/packages/patches/icecat-use-guix-extensions.patch @@ -0,0 +1,40 @@ +--- a/toolkit/xre/nsXREDirProvider.cpp ++++ b/toolkit/xre/nsXREDirProvider.cpp +@@ -281,6 +281,22 @@ nsresult nsXREDirProvider::GetBackgroundTasksProfilesRootDir( + } + #endif + ++static nsresult GetGuixExtensionDir(nsIFile** aFile) { ++ nsresult rv; ++ nsCOMPtr localDir; ++ ++ const char* extensionDir = getenv("ICECAT_EXTENSION_DIR"); ++ if (!extensionDir || !*extensionDir) return NS_ERROR_FAILURE; ++ ++ rv = NS_NewNativeLocalFile(nsDependentCString(extensionDir), true, ++ getter_AddRefs(localDir)); ++ ++ if (NS_SUCCEEDED(rv)) { ++ localDir.forget(aFile); ++ } ++ return rv; ++} ++ + #if defined(XP_UNIX) || defined(XP_MACOSX) + /** + * Get the directory that is the parent of the system-wide directories +@@ -415,13 +431,7 @@ nsXREDirProvider::GetFile(const char* aProperty, bool* aPersistent, + #if defined(XP_UNIX) && !defined(XP_MACOSX) + else if (!strcmp(aProperty, XRE_SYS_SHARE_EXTENSION_PARENT_DIR)) { + # ifdef ENABLE_SYSTEM_EXTENSION_DIRS +-# if defined(__OpenBSD__) || defined(__FreeBSD__) +- static const char* const sysLExtDir = "/usr/local/share/mozilla/extensions"; +-# else +- static const char* const sysLExtDir = "/usr/share/mozilla/extensions"; +-# endif +- rv = NS_NewNativeLocalFile(nsDependentCString(sysLExtDir), false, +- getter_AddRefs(file)); ++ rv = ::GetGuixExtensionDir(getter_AddRefs(file)); + # endif + } + #endif // defined(XP_UNIX) && !defined(XP_MACOSX)