depot/third_party/nixpkgs/pkgs/by-name/si/signal-desktop/generic.nix

289 lines
7.4 KiB
Nix
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
stdenv,
lib,
fetchurl,
autoPatchelfHook,
noto-fonts-color-emoji,
dpkg,
asar,
rsync,
python3,
buildPackages,
nixosTests,
gtk3,
atk,
at-spi2-atk,
cairo,
pango,
pipewire,
gdk-pixbuf,
glib,
freetype,
fontconfig,
dbus,
libX11,
xorg,
libXi,
libXcursor,
libXdamage,
libXrandr,
libXcomposite,
libXext,
libXfixes,
libXrender,
libXtst,
libXScrnSaver,
nss,
nspr,
alsa-lib,
cups,
expat,
libuuid,
at-spi2-core,
libappindicator-gtk3,
mesa,
# Runtime dependencies:
systemd,
libnotify,
libdbusmenu,
libpulseaudio,
xdg-utils,
wayland,
}:
{
pname,
dir,
version,
hash,
url,
}:
let
inherit (stdenv) targetPlatform;
ARCH = if targetPlatform.isAarch64 then "arm64" else "x64";
# Noto Color Emoji PNG files for emoji replacement; see below.
noto-fonts-color-emoji-png = noto-fonts-color-emoji.overrideAttrs (prevAttrs: {
pname = "noto-fonts-color-emoji-png";
# The build produces 136×128 PNGs by default for arcane font
# reasons, but we want square PNGs.
buildFlags = prevAttrs.buildFlags or [ ] ++ [ "BODY_DIMENSIONS=128x128" ];
makeTargets = [ "compressed" ];
installPhase = ''
runHook preInstall
mkdir -p $out/share
mv build/compressed_pngs $out/share/noto-fonts-color-emoji-png
python3 add_aliases.py --srcdir=$out/share/noto-fonts-color-emoji-png
runHook postInstall
'';
});
in
stdenv.mkDerivation rec {
inherit pname version;
# Please backport all updates to the stable channel.
# All releases have a limited lifetime and "expire" 90 days after the release.
# When releases "expire" the application becomes unusable until an update is
# applied. The expiration date for the current release can be extracted with:
# $ grep -a "^{\"buildExpiration" "${signal-desktop}/lib/${dir}/resources/app.asar"
# (Alternatively we could try to patch the asar archive, but that requires a
# few additional steps and might not be the best idea.)
src = fetchurl {
inherit url hash;
recursiveHash = true;
downloadToTemp = true;
nativeBuildInputs = [
dpkg
asar
];
# Signal ships the Apple emoji set without a licence via an npm
# package and upstream does not seem terribly interested in fixing
# this; see:
#
# * <https://github.com/signalapp/Signal-Android/issues/5862>
# * <https://whispersystems.discoursehosting.net/t/signal-is-likely-violating-apple-license-terms-by-using-apple-emoji-in-the-sticker-creator-and-android-and-desktop-apps/52883>
#
# We work around this by replacing it with the Noto Color Emoji
# set, which is available under a FOSS licence and more likely to
# be used on a NixOS machine anyway. The Apple emoji are removed
# during `fetchurl` to ensure that the build doesnt cache the
# unlicensed emoji files, but the rest of the work is done in the
# main derivation.
postFetch = ''
dpkg-deb -x $downloadedFile $out
asar extract "$out/opt/${dir}/resources/app.asar" $out/asar-contents
rm -r \
"$out/opt/${dir}/resources/app.asar"{,.unpacked} \
$out/asar-contents/node_modules/emoji-datasource-apple
'';
};
nativeBuildInputs = [
rsync
asar
python3
autoPatchelfHook
# override doesn't preserve splicing https://github.com/NixOS/nixpkgs/issues/132651
# Has to use `makeShellWrapper` from `buildPackages` even though `makeShellWrapper` from the inputs is spliced because `propagatedBuildInputs` would pick the wrong one because of a different offset.
(buildPackages.wrapGAppsHook3.override { makeWrapper = buildPackages.makeShellWrapper; })
];
buildInputs = [
alsa-lib
at-spi2-atk
at-spi2-core
atk
cairo
cups
dbus
expat
fontconfig
freetype
gdk-pixbuf
glib
gtk3
libX11
libXScrnSaver
libXcomposite
libXcursor
libXdamage
libXext
libXfixes
libXi
libXrandr
libXrender
libXtst
libappindicator-gtk3
libpulseaudio
libnotify
libuuid
mesa # for libgbm
nspr
nss
pango
systemd
xorg.libxcb
xorg.libxshmfence
];
runtimeDependencies = [
(lib.getLib systemd)
libappindicator-gtk3
libnotify
libdbusmenu
pipewire
xdg-utils
wayland
];
dontBuild = true;
dontConfigure = true;
unpackPhase = ''
rsync -a --chmod=+w $src/ .
'';
installPhase = ''
runHook preInstall
mkdir -p $out/lib
mv usr/share $out/share
mv "opt/${dir}" "$out/lib/${dir}"
# Symlink to bin
mkdir -p $out/bin
ln -s "$out/lib/${dir}/${pname}" $out/bin/${pname}
# Create required symlinks:
ln -s libGLESv2.so "$out/lib/${dir}/libGLESv2.so.2"
# Copy the Noto Color Emoji PNGs into the ASAR contents. See `src`
# for the motivation, and the script for the technical details.
emojiPrefix=$(
python3 ${./copy-noto-emoji.py} \
${noto-fonts-color-emoji-png}/share/noto-fonts-color-emoji-png \
asar-contents
)
# Replace the URL used for fetching large versions of emoji with
# the local path to our copied PNGs.
substituteInPlace asar-contents/preload.bundle.js \
--replace-fail \
'emoji://jumbo?emoji=' \
"file://$out/lib/${lib.escapeURL dir}/resources/app.asar/$emojiPrefix/"
# `asar(1)` copies files from the corresponding `.unpacked`
# directory when extracting, and will put them back in the modified
# archive if you dont specify them again when repacking. Signal
# leaves their native `.node` libraries unpacked, so we match that.
asar pack \
--unpack '*.node' \
asar-contents \
"$out/lib/${dir}/resources/app.asar"
runHook postInstall
'';
preFixup = ''
gappsWrapperArgs+=(
--add-flags "\''${NIXOS_OZONE_WL:+\''${WAYLAND_DISPLAY:+--ozone-platform-hint=auto --enable-features=WaylandWindowDecorations --enable-wayland-ime=true}}"
--suffix PATH : ${lib.makeBinPath [ xdg-utils ]}
)
# Fix the desktop link
substituteInPlace $out/share/applications/${pname}.desktop \
--replace-fail "/opt/${dir}/${pname}" ${meta.mainProgram} \
--replace-fail "StartupWMClass=Signal" "StartupWMClass=signal"
# Note: The following path contains bundled libraries:
# $out/lib/${dir}/resources/app.asar.unpacked/node_modules/
patchelf --add-needed ${libpulseaudio}/lib/libpulse.so "$out/lib/${dir}/resources/app.asar.unpacked/node_modules/@signalapp/ringrtc/build/linux/libringrtc-${ARCH}.node"
'';
passthru = {
# Tests if the application launches and waits for "Link your phone to Signal Desktop":
tests.application-launch = nixosTests.signal-desktop;
updateScript.command = [ ./update.sh ];
};
meta = {
description = "Private, simple, and secure messenger";
longDescription = ''
Signal Desktop is an Electron application that links with your
"Signal Android" or "Signal iOS" app.
'';
homepage = "https://signal.org/";
changelog = "https://github.com/signalapp/Signal-Desktop/releases/tag/v${version}";
license = [
lib.licenses.agpl3Only
# Various npm packages
lib.licenses.free
];
maintainers = with lib.maintainers; [
mic92
equirosa
urandom
bkchr
teutat3s
emily
Gliczy
];
mainProgram = pname;
platforms = [
"x86_64-linux"
"aarch64-linux"
"x86_64-darwin"
"aarch64-darwin"
];
sourceProvenance = with lib.sourceTypes; [ binaryNativeCode ];
};
}