Unverified Commit f48e0c7d authored by Jan van Brügge's avatar Jan van Brügge
Browse files

epkowa: Allow to specify set of plugins

parent d42ef9dc
Loading
Loading
Loading
Loading
+21 −489
Original line number Diff line number Diff line
{
  lib,
  stdenv,
  callPackages,
  fetchurl,
  fetchpatch,
  makeWrapper,
@@ -12,11 +13,9 @@
  libxslt,
  libusb-compat-0_1,
  sane-backends,
  rpm,
  cpio,
  getopt,
  autoPatchelfHook,
  gcc,
  epkowa,
  plugins ? epkowa.plugins,
}:
let
  common_meta = {
@@ -25,492 +24,12 @@ let
    license = with lib.licenses; epson;
    platforms = with lib.platforms; linux;
  };
in
############################
#
#  PLUGINS
#
############################

# adding a plugin for another printer shouldn't be too difficult, but you need the firmware to test...
let
  plugins = {
    v330 = stdenv.mkDerivation rec {
      name = "iscan-v330-bundle";
      version = "2.30.4";

      src = fetchurl {
        # To find new versions, visit
        # http://download.ebz.epson.net/dsc/search/01/search/?OSC=LX and search for
        # some printer like for instance "WF-7210" to get to the most recent
        # version.
        # NOTE: Don't forget to update the webarchive link too!
        urls = [
          "https://download2.ebz.epson.net/iscan/plugin/perfection-v330/rpm/x64/iscan-perfection-v330-bundle-${version}.x64.rpm.tar.gz"
          "https://web.archive.org/web/https://download2.ebz.epson.net/iscan/plugin/perfection-v330/rpm/x64/iscan-perfection-v330-bundle-${version}.x64.rpm.tar.gz"
        ];
        sha256 = "056c04pfsf98nnknphg28l489isqb6y4l2c8g7wqhclwgj7m338i";
      };

      nativeBuildInputs = [
        autoPatchelfHook
        rpm
      ];

      installPhase = ''
        ${rpm}/bin/rpm2cpio plugins/esci-interpreter-perfection-v330-*.x86_64.rpm | ${cpio}/bin/cpio -idmv
        mkdir $out{,/share,/lib}
        cp -r ./usr/share/{iscan-data,esci}/ $out/share/
        cp -r ./usr/lib64/esci $out/lib
      '';

      passthru = {
        registrationCommand = ''
          $registry --add interpreter usb 0x04b8 0x0142 "$plugin/lib/esci/libesci-interpreter-perfection-v330 $plugin/share/esci/esfwad.bin"
        '';
        hw = "Perfection V330 Photo";
      };
      meta = common_meta // {
        description = "Plugin to support " + passthru.hw + " scanner in sane";
      };
    };
    v370 = stdenv.mkDerivation rec {
      name = "iscan-v370-bundle";
      version = "2.30.4";

      src = fetchurl {
        urls = [
          "https://download2.ebz.epson.net/iscan/plugin/perfection-v370/rpm/x64/iscan-perfection-v370-bundle-${version}.x64.rpm.tar.gz"
          "https://web.archive.org/web/https://download2.ebz.epson.net/iscan/plugin/perfection-v370/rpm/x64/iscan-perfection-v370-bundle-${version}.x64.rpm.tar.gz"
        ];
        sha256 = "1ff7adp9mha1i2ibllz540xkagpy8r757h4s3h60bgxbyzv2yggr";
      };

      nativeBuildInputs = [
        autoPatchelfHook
        rpm
      ];

      installPhase = ''
        cd plugins
        ${rpm}/bin/rpm2cpio iscan-plugin-perfection-v370-*.x86_64.rpm | ${cpio}/bin/cpio -idmv


        mkdir -p $out/share $out/lib
        cp -r usr/share/{iscan-data,iscan}/ $out/share
        cp -r usr/lib64/iscan $out/lib
        mv $out/share/iscan $out/share/esci
        mv $out/lib/iscan $out/lib/esci
      '';

      passthru = {
        registrationCommand = ''
          $registry --add interpreter usb 0x04b8 0x014a "$plugin/lib/esci/libiscan-plugin-perfection-v370 $plugin/share/esci/esfwdd.bin"
        '';
        hw = "Perfection V37/V370";
      };
      meta = common_meta // {
        description = "Plugin to support " + passthru.hw + " scanner in sane";
      };
    };
    v550 = stdenv.mkDerivation rec {
      pname = "iscan-perfection-v550-bundle";
      version = "2.30.4";

      nativeBuildInputs = [
        autoPatchelfHook
        rpm
      ];
      src = fetchurl {
        urls = [
          "https://download2.ebz.epson.net/iscan/plugin/perfection-v550/rpm/x64/iscan-perfection-v550-bundle-${version}.x64.rpm.tar.gz"
          "https://web.archive.org/web/https://download2.ebz.epson.net/iscan/plugin/perfection-v550/rpm/x64/iscan-perfection-v550-bundle-${version}.x64.rpm.tar.gz"
        ];
        sha256 = "f8b3abf21354fc5b9bc87753cef950b6c0f07bf322a94aaff2c163bafcf50cd9";
      };
      installPhase = ''
        cd plugins
        ${rpm}/bin/rpm2cpio iscan-plugin-perfection-v550-*.x86_64.rpm | ${cpio}/bin/cpio -idmv
        mkdir $out
        cp -r usr/share $out
        cp -r usr/lib64 $out/lib
        mv $out/share/iscan $out/share/esci
        mv $out/lib/iscan $out/lib/esci
      '';
      passthru = {
        registrationCommand = ''
          $registry --add interpreter usb 0x04b8 0x013b "$plugin/lib/esci/libiscan-plugin-perfection-v550 $plugin/share/esci/esfweb.bin"
        '';
        hw = "Perfection V550 Photo";
      };
      meta = common_meta // {
        description = "Plugin to support " + passthru.hw + " scanner in sane";
      };
    };
    v600 = stdenv.mkDerivation rec {
      pname = "iscan-gt-x820-bundle";
      version = "2.30.4";

      nativeBuildInputs = [
        autoPatchelfHook
        rpm
      ];
      src = fetchurl {
        urls = [
          "https://download2.ebz.epson.net/iscan/plugin/gt-x820/rpm/x64/iscan-gt-x820-bundle-${version}.x64.rpm.tar.gz"
          "https://web.archive.org/web/https://download2.ebz.epson.net/iscan/plugin/gt-x820/rpm/x64/iscan-gt-x820-bundle-${version}.x64.rpm.tar.gz"
        ];
        sha256 = "1vlba7dsgpk35nn3n7is8nwds3yzlk38q43mppjzwsz2d2n7sr33";
      };
      installPhase = ''
        cd plugins
        ${rpm}/bin/rpm2cpio iscan-plugin-gt-x820-*.x86_64.rpm | ${cpio}/bin/cpio -idmv
        mkdir $out
        cp -r usr/share $out
        cp -r usr/lib64 $out/lib
        mv $out/share/iscan $out/share/esci
        mv $out/lib/iscan $out/lib/esci
      '';
      passthru = {
        registrationCommand = ''
          $registry --add interpreter usb 0x04b8 0x013a "$plugin/lib/esci/libesintA1 $plugin/share/esci/esfwA1.bin"
        '';
        hw = "Perfection V600 Photo";
      };
      meta = common_meta // {
        description = "iscan esci x820 plugin for " + passthru.hw;
      };
    };
    x770 = stdenv.mkDerivation rec {
      pname = "iscan-gt-x770-bundle";
      version = "2.30.4";

      nativeBuildInputs = [
        autoPatchelfHook
        rpm
      ];
      src = fetchurl {
        urls = [
          "https://download2.ebz.epson.net/iscan/plugin/gt-x770/rpm/x64/iscan-gt-x770-bundle-${version}.x64.rpm.tar.gz"
          "https://web.archive.org/web/https://download2.ebz.epson.net/iscan/plugin/gt-x770/rpm/x64/iscan-gt-x770-bundle-${version}.x64.rpm.tar.gz"
        ];
        sha256 = "1chxdm6smv2d14pn2jl9xyd0vr42diy7vpskd3b9a61gf5h3gj03";
      };
      installPhase = ''
        cd plugins
        ${rpm}/bin/rpm2cpio iscan-plugin-gt-x770-*.x86_64.rpm | ${cpio}/bin/cpio -idmv
        mkdir $out
        cp -r usr/share $out
        cp -r usr/lib64 $out/lib
        mv $out/share/iscan $out/share/esci
        mv $out/lib/iscan $out/lib/esci
      '';
      passthru = {
        registrationCommand = ''
          $registry --add interpreter usb 0x04b8 0x0130 "$plugin/lib/esci/libesint7C $plugin/share/esci/esfw7C.bin"
        '';
        hw = "Perfection V500 Photo";
      };
      meta = common_meta // {
        description = "iscan esci x770 plugin for " + passthru.hw;
      };
    };
    f720 = stdenv.mkDerivation rec {
      pname = "iscan-gt-f720-bundle";
      version = "2.30.4";

      nativeBuildInputs = [ autoPatchelfHook ];
      buildInputs = [ gcc.cc.lib ];
      src = fetchurl {
        urls = [
          "https://download2.ebz.epson.net/iscan/plugin/gt-f720/rpm/x64/iscan-gt-f720-bundle-${version}.x64.rpm.tar.gz"
          "https://web.archive.org/web/https://download2.ebz.epson.net/iscan/plugin/gt-f720/rpm/x64/iscan-gt-f720-bundle-${version}.x64.rpm.tar.gz"
        ];
        sha256 = "1xnbmb2rn610kqpg1x6k1cc13zlmx2f3l2xnj6809rnhg96qqn20";
      };
      installPhase = ''
        cd plugins
        ${rpm}/bin/rpm2cpio esci-interpreter-gt-f720-*.x86_64.rpm | ${cpio}/bin/cpio -idmv
        mkdir $out
        cp -r usr/share $out
        cp -r usr/lib64 $out/lib
      '';

      passthru = {
        registrationCommand = ''
          $registry --add interpreter usb 0x04b8 0x0131 "$plugin/lib/esci/libesci-interpreter-gt-f720 $plugin/share/esci/esfw8b.bin"
        '';
        hw = "GT-F720, GT-S620, Perfection V30, Perfection V300 Photo";
      };

      meta = common_meta // {
        description = "iscan esci f720 plugin for " + passthru.hw;
      };
    };
    s80 = stdenv.mkDerivation rec {
      pname = "iscan-gt-s80-bundle";
      version = "2.30.4";

      nativeBuildInputs = [ autoPatchelfHook ];
      buildInputs = [
        gcc.cc.lib
        libtool
      ];
      src = fetchurl {
        urls = [
          "https://download2.ebz.epson.net/iscan/plugin/gt-s80/rpm/x64/iscan-gt-s80-bundle-${version}.x64.rpm.tar.gz"
          "https://web.archive.org/web/https://download2.ebz.epson.net/iscan/plugin/gt-s80/rpm/x64/iscan-gt-s80-bundle-${version}.x64.rpm.tar.gz"
        ];
        sha256 = "00qfdgs03k7bbs67zjrk8hbxvlyinsmk890amp9cmpfjfzdxgg58";
      };
      installPhase = ''
        cd plugins
        ${rpm}/bin/rpm2cpio esci-interpreter-gt-s80-*.x86_64.rpm | ${cpio}/bin/cpio -idmv
        ${rpm}/bin/rpm2cpio iscan-plugin-esdip-*.x86_64.rpm | ${cpio}/bin/cpio -idmv
        mkdir $out
        cp -r usr/share $out
        cp -r usr/lib64 $out/lib
        mkdir $out/share/esci
      '';

      passthru = {
        registrationCommand = ''
          $registry --add interpreter usb 0x04b8 0x0136 "$plugin/lib/esci/libesci-interpreter-gt-s80.so"
          $registry --add interpreter usb 0x04b8 0x0137 "$plugin/lib/esci/libesci-interpreter-gt-s50.so"
          $registry --add interpreter usb 0x04b8 0x0143 "$plugin/lib/esci/libesci-interpreter-gt-s50.so"
          $registry --add interpreter usb 0x04b8 0x0144 "$plugin/lib/esci/libesci-interpreter-gt-s80.so"
        '';
        hw = "ES-D200, ED-D350, ES-D400, GT-S50, GT-S55, GT-S80, GT-S85";
      };

      meta = common_meta // {
        description = "iscan esci s80 plugin for " + passthru.hw;
      };
    };
    s600 = stdenv.mkDerivation rec {
      name = "iscan-gt-s600-bundle";
      version = "2.30.4";

      src = fetchurl {
        urls = [
          "https://download2.ebz.epson.net/iscan/plugin/gt-s600/rpm/x64/iscan-gt-s600-bundle-${version}.x64.rpm.tar.gz"
          "https://web.archive.org/web/20240614120113/https://download2.ebz.epson.net/iscan/plugin/gt-s600/rpm/x64/iscan-gt-s600-bundle-${version}.x64.rpm.tar.gz"
        ];
        sha256 = "fe1356b1d5c40bc5ac985a5693166efb9e5049a78b412f49c385eb503eadf2c6";
      };

      nativeBuildInputs = [
        autoPatchelfHook
        rpm
      ];

      installPhase = ''
        cd plugins
        ${rpm}/bin/rpm2cpio iscan-plugin-gt-s600-*.x86_64.rpm | ${cpio}/bin/cpio -idmv
        mkdir $out
        cp -r usr/share $out
        cp -r usr/lib64 $out/lib
        mv $out/share/iscan $out/share/esci
        mv $out/lib/iscan $out/lib/esci
      '';

      passthru = {
        registrationCommand = ''
          $registry --add interpreter usb 0x04b8 0x012d "$plugin/lib/esci/libesint66 $plugin/share/esci/esfw66.bin"
        '';
        hw = "GT-F650, GT-S600, Perfection V10, Perfection V100 Photo";
      };
      meta = common_meta // {
        description = "iscan gt-s600 plugin for " + passthru.hw;
      };
    };
    s650 = stdenv.mkDerivation rec {
      name = "iscan-gt-s650-bundle";
      version = "2.30.4";

      src = fetchurl {
        urls = [
          "https://download2.ebz.epson.net/iscan/plugin/gt-s650/rpm/x64/iscan-gt-s650-bundle-${version}.x64.rpm.tar.gz"
          "https://web.archive.org/web/https://download2.ebz.epson.net/iscan/plugin/gt-s650/rpm/x64/iscan-gt-s650-bundle-${version}.x64.rpm.tar.gz"
        ];
        sha256 = "0fn4lz4g0a8l301v6yv7fwl37wgwhz5y90nf681f655xxc91hqh7";
      };

      nativeBuildInputs = [
        autoPatchelfHook
        rpm
      ];

      installPhase = ''
        cd plugins
        ${rpm}/bin/rpm2cpio iscan-plugin-gt-s650-*.x86_64.rpm | ${cpio}/bin/cpio -idmv
        mkdir $out
        cp -r usr/share $out
        cp -r usr/lib64 $out/lib
        mv $out/share/iscan $out/share/esci
        mv $out/lib/iscan $out/lib/esci
      '';

      passthru = {
        registrationCommand = ''
          $registry --add interpreter usb 0x04b8 0x013c "$plugin/lib/esci/libiscan-plugin-gt-s650 $plugin/share/esci/esfw010c.bin"
          $registry --add interpreter usb 0x04b8 0x013d "$plugin/lib/esci/libiscan-plugin-gt-s650 $plugin/share/esci/esfw010c.bin"
        '';
        hw = "GT-S650, Perfection V19, Perfection V39";
      };
      meta = common_meta // {
        description = "iscan GT-S650 for " + passthru.hw;
      };
    };
    x750 = stdenv.mkDerivation rec {
      name = "iscan-gt-x750-bundle";
      version = "2.30.4";

      src = fetchurl {
        urls = [
          "https://download2.ebz.epson.net/iscan/plugin/gt-x750/rpm/x64/iscan-gt-x750-bundle-${version}.x64.rpm.tar.gz"
          "https://web.archive.org/web/https://download2.ebz.epson.net/iscan/plugin/gt-x750/rpm/x64/iscan-gt-x750-bundle-${version}.x64.rpm.tar.gz"
        ];
        sha256 = "sha256-9EeBHmh1nwSxnTnevPP8RZ4WBdyY+itR3VXo2I7f5N0=";
      };

      nativeBuildInputs = [
        autoPatchelfHook
        rpm
      ];

      installPhase = ''
        cd plugins
        ${rpm}/bin/rpm2cpio iscan-plugin-gt-x750-*.x86_64.rpm | ${cpio}/bin/cpio -idmv
        mkdir $out
        cp -r usr/share $out
        cp -r usr/lib64 $out/lib
        mv $out/share/iscan $out/share/esci
        mv $out/lib/iscan $out/lib/esci
      '';

      passthru = {
        registrationCommand = ''
          $registry --add interpreter usb 0x04b8 0x0119 "$plugin/lib/esci/libesint54 $plugin/share/esci/esfw54.bin"
        '';
        hw = "GT-X750, Perfection 4490";
      };
      meta = common_meta // {
        description = "iscan GT-X750 for " + passthru.hw;
      };
    };
    gt1500 = stdenv.mkDerivation rec {
      name = "iscan-gt-1500-bundle";
      version = "2.30.4";

      src = fetchurl {
        urls = [
          "https://download2.ebz.epson.net/iscan/plugin/gt-1500/rpm/x64/iscan-gt-1500-bundle-${version}.x64.rpm.tar.gz"
          "https://web.archive.org/web/https://download2.ebz.epson.net/iscan/plugin/gt-1500/rpm/x64/iscan-gt-1500-bundle-${version}.x64.rpm.tar.gz"
        ];
        sha256 = "sha256-1rVsbBsb+QtCOT1FsyhgvCbZIN6IeQH7rZXNmsD7cl8=";
      };

      nativeBuildInputs = [
        autoPatchelfHook
        rpm
      ];

      installPhase = ''
        cd plugins
        ${rpm}/bin/rpm2cpio iscan-plugin-gt-1500-*.x86_64.rpm | ${cpio}/bin/cpio -idmv
        mkdir $out
        cp -r usr/share $out
        cp -r usr/lib64 $out/lib
        mv $out/share/iscan $out/share/esci
        mv $out/lib/iscan $out/lib/esci
      '';

      passthru = {
        registrationCommand = ''
          $registry --add interpreter usb 0x04b8 0x0133 "$plugin/lib/esci/libesint86 $plugin/share/esci/esfw86.bin"
        '';
        hw = "GT-1500";
      };
      meta = common_meta // {
        description = "iscan GT-1500 for " + passthru.hw;
      };
    };
    ds30 = stdenv.mkDerivation rec {
      name = "iscan-ds-30-bundle";
      version = "2.30.4";

      src = fetchurl {
        urls = [
          "https://download2.ebz.epson.net/iscan/plugin/ds-30/rpm/x64/iscan-ds-30-bundle-${version}.x64.rpm.tar.gz"
          "https://web.archive.org/web/https://download2.ebz.epson.net/iscan/plugin/ds-30/rpm/x64/iscan-ds-30-bundle-${version}.x64.rpm.tar.gz"
        ];
        sha256 = "0d5ef9b83999c56c14bd17ca63537f63ad4f0d70056870dc00888af1b36f4153";
      };

      nativeBuildInputs = [
        autoPatchelfHook
        rpm
      ];

      installPhase = ''
        ${rpm}/bin/rpm2cpio plugins/iscan-plugin-ds-30-*.x86_64.rpm | ${cpio}/bin/cpio -idmv
        mkdir $out
        cp -r usr/share $out
        cp -r usr/lib64 $out/lib
        mv $out/lib/iscan $out/lib/esci
        mkdir $out/share/esci
      '';

      passthru = {
        registrationCommand = ''
          $registry --add interpreter usb 0x04b8 0x0147 "$plugin/lib/esci/libiscan-plugin-ds-30.so"
        '';
        hw = "DS-30";
      };
      meta = common_meta // {
        description = "Plugin to support " + passthru.hw + " scanner in sane";
      };
    };
    network = stdenv.mkDerivation rec {
      pname = "iscan-nt-bundle";
      # for the version, look for the driver of XP-750 in the search page
      version = "2.30.4";

      buildInputs = [ (lib.getLib stdenv.cc.cc) ];
      nativeBuildInputs = [ autoPatchelfHook ];

      src = fetchurl {
        urls = [
          "https://download2.ebz.epson.net/iscan/general/rpm/x64/iscan-bundle-${version}.x64.rpm.tar.gz"
          "https://web.archive.org/web/https://download2.ebz.epson.net/iscan/general/rpm/x64/iscan-bundle-${version}.x64.rpm.tar.gz"
        ];
        sha256 = "0jssigsgkxb9i7qa7db291a1gbvwl795i4ahvb7bnqp33czkj85k";
      };
      installPhase = ''
        cd plugins
        ${rpm}/bin/rpm2cpio iscan-network-nt-*.x86_64.rpm | ${cpio}/bin/cpio -idmv

        mkdir $out
        cp -r usr/share $out
        cp -r usr/lib64 $out/lib
        mkdir $out/share/esci
      '';
      passthru = {
        registrationCommand = "";
        hw = "network";
      };

      meta = common_meta // {
        description = "iscan network plugin";
      };
    };
  };
  plugins' = lib.attrsets.filterAttrs (_: lib.isDerivation) plugins;
in
let
  fwdir = symlinkJoin {
    name = "esci-firmware-dir";
    paths = lib.mapAttrsToList (name: value: value + "/share/esci") plugins;
    paths = lib.mapAttrsToList (name: value: value + "/share/esci") plugins';
  };
in
let
@@ -588,7 +107,9 @@ stdenv.mkDerivation rec {
    echo "epkowa" > $out/etc/sane.d/dll.conf
    ln -s ${iscan-data}/share/iscan-data $out/share/iscan-data
    mkdir -p $out/lib/iscan
    ln -s ${plugins.network}/lib/iscan/network $out/lib/iscan/network
  ''
  + lib.optionalString (plugins' ? network) ''
    ln -s ${plugins'.network}/lib/iscan/network $out/lib/iscan/network
  '';
  postFixup = ''
    # iscan-registry is a shell script requiring getopt
@@ -599,15 +120,26 @@ stdenv.mkDerivation rec {
    lib.mapAttrsToList (name: value: ''
      plugin=${value};
      ${value.passthru.registrationCommand}
    '') plugins
    '') plugins'
  );

  passthru.plugins = callPackages ./plugins.nix { inherit common_meta; };

  meta = common_meta // {
    description = "sane-epkowa backend for some epson scanners";
    longDescription = ''
      Includes gui-less iscan (aka. Image Scan! for Linux).
      Supported hardware: at least :
    ''
    + lib.concatStringsSep ", " (lib.mapAttrsToList (name: value: value.passthru.hw) plugins);
    + lib.concatStringsSep ", " (lib.mapAttrsToList (name: value: value.passthru.hw) plugins')
    + ''
      It is possible to only use a subset of the plugins by overriding the `plugins` input:
      epkowa' = pkgs.epkowa.override {
        plugins = {
          inherit (pkgs.epkowa.plugins) x770; # Select correct plugins for your scanner here
        };
      };
    '';
    maintainers = with lib.maintainers; [
      symphorien
      dominikh
+485 −0

File added.

Preview size limit exceeded, changes collapsed.