nixpkgs/pkgs/applications/misc/zathura/wrapper.nix
Maximilian Bosch c0bd479d77
zathura: improve overridability; set plugin dir through the environment
The current package setup has two issues:

* You can only access `pkgs.zathura` which is the "final" derivation,
  i.e. a wrapper. This is a problem if you want to apply a patch to
  `zathura(1)` in an overlay. To make this a bit easier, I decided to
  expose `zathuraPkgs` entirely and `zathura` is now
  `zathuraPkgs.zathuraWrapper`.

  With this change, patches can now be added like this:

  ```
  with import ./. {
    overlays = [
      (self: super: {
        zathura = super.zathura.override {
          zathura_core = super.zathuraPkgs.zathura_core.overrideAttrs (_: {
            patches = [
              ~/Projects/zathura/0001-Fix-remote-link-resolution-in-zathura.patch
            ];
          });
        };
      })
    ];
  };
  zathura
  ```

* As soon as you open another window in `zathura` from `zathura` (e.g.
  to follow a PDF-embedded link to another PDF), it currently fails
  because `--plugins-dir=` isn't passed along. This is because `zathura`
  uses `argv[0]`[1] to open another process and the GApps-wrapper inside
  `zathuraPkgs.zathura_core` does a `exec -a "$0"` which isn't the
  `bin/zathura` from the wrapper that appends `--plugins-dir=`:

  ```
  execve("/nix/var/nix/profiles/per-user/ma27/home-manager-140-link/home-path/bin/zathura", ["/nix/var/nix/profiles/per-user/ma27/home-manager-140-link/home-path/bin/zathura", "/home/ma27/Documents/Uni/Studium/Notepad/Aktuell/Index.pdf"], 0x7ffd7a4bf4b0 /* 108 vars */) = 0
  execve("/nix/store/2wjhxbgzcnn0qqdwqy0m01hw39dxwfmk-zathura-0.4.8-bin/bin/zathura", ["/nix/store/2wjhxbgzcnn0qqdwqy0m01hw39dxwfmk-zathura-0.4.8-bin/bin/zathura", "--plugins-dir=/nix/store/wcch63yzwykc9x5393dzjfdxsf80mrb8-zathura-with-plugins-0.4.8/lib/zathura", "/home/ma27/Documents/Uni/Studium/Notepad/Aktuell/Index.pdf"], 0x1442010 /* 107 vars */) = 0
  execve("/nix/store/2wjhxbgzcnn0qqdwqy0m01hw39dxwfmk-zathura-0.4.8-bin/bin/.zathura-wrapped", ["/nix/store/2wjhxbgzcnn0qqdwqy0m01hw39dxwfmk-zathura-0.4.8-bin/bin/zathura", "--plugins-dir=/nix/store/wcch63yzwykc9x5393dzjfdxsf80mrb8-zathura-with-plugins-0.4.8/lib/zathura", "/home/ma27/Documents/Uni/Studium/Notepad/Aktuell/Index.pdf"], 0x81d010 /* 108 vars */) = 0
  ```

  I figured it's way simpler to actually use the environment variable
  `ZATHURA_PLUGINS_PATH` for that purpose as the environment is
  inherited when a new process is started.

[1] 242329b534/zathura/links.c (L205-215)
2022-02-05 19:27:24 +01:00

39 lines
1.5 KiB
Nix

{ symlinkJoin, lib, makeWrapper, zathura_core, file, plugins ? [] }:
symlinkJoin {
name = "zathura-with-plugins-${zathura_core.version}";
paths = with zathura_core; [ man dev out ] ++ plugins;
nativeBuildInputs = [ makeWrapper ];
postBuild = let
fishCompletion = "share/fish/vendor_completions.d/zathura.fish";
in ''
makeWrapper ${zathura_core.bin}/bin/zathura $out/bin/zathura \
--prefix PATH ":" "${lib.makeBinPath [ file ]}" \
--prefix ZATHURA_PLUGINS_PATH : "$out/lib/zathura"
# zathura fish completion references the zathura_core derivation to
# check for supported plugins which live in the wrapper derivation,
# so we need to fix the path to reference $out instead.
rm "$out/${fishCompletion}"
substitute "${zathura_core.out}/${fishCompletion}" "$out/${fishCompletion}" \
--replace "${zathura_core.out}" "$out"
'';
meta = with lib; {
homepage = "https://git.pwmt.org/pwmt/zathura/";
description = "A highly customizable and functional PDF viewer";
longDescription = ''
Zathura is a highly customizable and functional PDF viewer based on the
poppler rendering library and the GTK toolkit. The idea behind zathura
is an application that provides a minimalistic and space saving interface
as well as an easy usage that mainly focuses on keyboard interaction.
'';
license = licenses.zlib;
platforms = platforms.unix;
maintainers = with maintainers; [ smironov globin TethysSvensson ];
mainProgram = "zathura";
};
}