;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2020, 2021 Marius Bakke <marius@gnu.org>
;;; Copyright © 2023 Clément Lassieur <clement@lassieur.org>
;;;
;;; 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 <http://www.gnu.org/licenses/>.

(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)
    (location (package-location pkg))
    (name (string-append (package-name pkg) "-icecat"))
    (native-inputs '())
    (inputs '())
    (propagated-inputs (package-propagated-inputs pkg))
    (outputs '("out"))
    (build-system trivial-build-system)
    (arguments
     (list
      #:modules '((guix build utils))
      #:builder
      #~(begin
          (use-modules (guix build utils))
          (let* ((addon-id #$(assq-ref (package-properties pkg) 'addon-id))
                 (moz-app-id "{ec8030f7-c20a-464f-9b0e-13a3a9e97384}")
                 (search-dir (string-append #$output "/lib/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 either because it would never change (but it
            ;; wouldn't make sense anyway).

            (mkdir-p search-dir)
            (symlink (in-vicinity (ungexp pkg pkg-output) addon-id)
                     (in-vicinity search-dir addon-id))))))))
</span></td><td><a href='/guix/commit/gnu/system/shadow.scm?id=1e8ac2c41bb43338e00179a538cd6f8880a63cdb'>system: Add default guix-home-config.</a><span class='msg-avail'>...</span></td><td>Efraim Flashner</td></tr>
<tr><td><span title='2024-01-17 11:11:09 +0200'>2024-01-17</span></td><td><a href='/guix/commit/gnu/system/shadow.scm?id=3ca02f03048fc1ef5c604d1ac566e0b75ab5a45f'>system: Export default guile config.</a><span class='msg-avail'>...</span></td><td>Efraim Flashner</td></tr>
<tr><td><span title='2024-01-17 11:11:09 +0200'>2024-01-17</span></td><td><a href='/guix/commit/gnu/system/shadow.scm?id=33136e0426f5722dea63e18a14e7f54cda530132'>system: Export default nanorc.</a><span class='msg-avail'>...</span></td><td>Efraim Flashner</td></tr>
<tr><td><span title='2024-01-17 11:11:09 +0200'>2024-01-17</span></td><td><a href='/guix/commit/gnu/system/shadow.scm?id=eef3babfdb3fecbca80d8e25bbeb9e43cc5cc097'>system: Export default gdbinit.</a><span class='msg-avail'>...</span></td><td>Efraim Flashner</td></tr>
<tr><td><span title='2024-01-17 11:11:09 +0200'>2024-01-17</span></td><td><a href='/guix/commit/gnu/system/shadow.scm?id=72928388746e05fa698b62fd7a6c78965f374aef'>system: Export default xdefaults.</a><span class='msg-avail'>...</span></td><td>Efraim Flashner</td></tr>
<tr><td><span title='2024-01-17 11:11:09 +0200'>2024-01-17</span></td><td><a href='/guix/commit/gnu/system/shadow.scm?id=6a9e4b063917240c8c4bf412db47f7e07df39732'>system: Export default zprofile.</a><span class='msg-avail'>...</span></td><td>Efraim Flashner</td></tr>
<tr><td><span title='2024-01-17 11:11:03 +0200'>2024-01-17</span></td><td><a href='/guix/commit/gnu/system/shadow.scm?id=cdcb2e78d26297215ae9382b57ca3832d16b4824'>system: Export default bash-profile.</a><span class='msg-avail'>...</span></td><td>Efraim Flashner</td></tr>
<tr><td><span title='2023-10-06 11:52:13 +0200'>2023-10-06</span></td><td><a href='/guix/commit/gnu/system/shadow.scm?id=70c27db33edc76424ac680bd2cb8470573ea42fe'>system: Modify bash skeleton to colorize 'ip' output.</a><span class='msg-avail'>...</span></td><td>Bruno Victal</td></tr>
<tr><td><span title='2023-06-09 14:19:14 +0200'>2023-06-09</span></td><td><a href='/guix/commit/gnu/system/shadow.scm?id=56ad923f47d352e1bee1a94da1a246ae21c03569'>system: account: Fix default value.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2023-05-16 19:45:27 +0400'>2023-05-16</span></td><td><a href='/guix/commit/gnu/system/shadow.scm?id=66ecffbeba0685ff2f1071db8aeb2393986afb97'>services: Add default values.</a><span class='msg-avail'>...</span></td><td>Andrew Tropin</td></tr>
<tr><td><span title='2023-05-12 20:27:06 +0800'>2023-05-12</span></td><td><a href='/guix/commit/gnu/system/shadow.scm?id=40310efde9b4a4f2cf98081d6cd10f843685ebb6'>system: default-skeletons: Merge search-paths of multiple profiles.</a><span class='msg-avail'>...</span></td><td>宋文武</td></tr>
<tr><td><span title='2023-03-07 16:35:20 +0200'>2023-03-07</span></td><td><a href='/guix/commit/gnu/system/shadow.scm?id=723fc5df3e964fcecb09c7c6fd48f00f97e2e806'>system: Update skeleton gdbinit.</a><span class='msg-avail'>...</span></td><td>Efraim Flashner</td></tr>
<tr><td><span title='2023-02-08 18:13:08 +0400'>2023-02-08</span></td><td><a href='/guix/commit/gnu/system/shadow.scm?id=a4dfbead19a785cb7a25b53798757b39ad10b828'>system: Source .profile in skeleton bash_profile.</a><span class='msg-avail'>...</span></td><td>Andrew Tropin</td></tr>
<tr><td><span title='2023-01-05 15:00:27 +0100'>2023-01-05</span></td><td><a href='/guix/commit/gnu/system/shadow.scm?id=086df6ef213d44d4b75c263033552eef6b2bd868'>system: Define default 'PS1' in /etc/bashrc rather than ~/.bashrc.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>
<tr><td><span title='2023-01-05 14:21:19 +0100'>2023-01-05</span></td><td><a href='/guix/commit/gnu/system/shadow.scm?id=2127e56bd8b3ee8ae5b6cde1b7ed5bf50cf7127b'>system, home: Factorize default '.bashrc'.</a><span class='msg-avail'>...</span></td><td>Ludovic Courtès</td></tr>