foomatic-db-ppds (cups ppd files): init

`foomatic-db-ppds` uses the Foomatic database from the packages
`foomatic-db` and -- optionally -- `foomatic-db-nonfree`
and the perl modules from `foomatic-db-engine`
to generate about 8,800 ppd files.

The general structure of the build recipe is as follows:

* Merge `foomatic-db` and `foomatic-db-nonfree` into
one package that represents the Foomatic database.
The package `foomatic-db-nonfree` is optional
as it taints the result license-wise;
it will only be used if `withNonfreeDb`
is to to `true` in the `callPackage` call.
We create a tiny setup hook script that provides the combined
database and sets an environment variable pointing to the
database direcotry, which is expected by the foomatic engine.

* The final package's license and version are computed
from the licenses and versions of the database packages.
The license is set to `free` if each database-providing
package has a free license, and to `unfree` otherwise.
The version is simply the highest version
of the database-providing packages.

* The final package uses `foomatic-compiledb`
from the `foomatic-db-engine` package to extract
all ppd files from the database packages.
`patchPpdFilesHook` is used to patch most
executable invocations in the ppd files
so that they point to nix store paths.
Finally, ppd files are gzipped to reduce storage
(from about 550 MiB to 90 MiB installed).

The "nonfree" version of the package, i.e. the version that is
based on `foomatic-db-nonfree` in addition to `foomatic-db`,
contains about 120 additional ppd files
compared to the "free" version.
Since the "free" version already produces about 8,700
ppd files and hydra won't build the "nonfree" version,
the commit adds two package variables to `all-packages.nix`:

* `foomatic-db-ppds` is based on `foomatic-db` only
* `foomatic-db-ppds-withNonfreeDb`
is also based on `foomaitc-db-nonfree`

The package introduced by this commit
is the result of combining other packages;
it is not the build product of a simple source tarball.
While it would also be possible to perform the ppd file
generation directly in the build process of the database
packages, this would yield further complexity as the
`foomatic-db-nonfree` package needs to be combined with the
`foomatic-db` package before ppd file extraction is possible.

There is no upstream product with a name that
could/should be used for the `name` attribute,
the variable name, or for the filename in nixpkgs.
Similar packages have different names across distributions:

* https://repology.org/projects/?search=openprinting
* https://repology.org/projects/?search=foomatic

The name `foomatic-db-ppds` seems to be most common
(albeit not really *that* common):

* https://repology.org/project/foomatic-db-ppds/versions

At least openSUSE splits their corresponding
package into multiple "binary" packages
(similar to our multi-output packages):

* https://build.opensuse.org/package/binaries/Printing/OpenPrintingPPDs/openSUSE_Tumbleweed

I considered something similar.
However, after doing some statistics,
I concluded that it's not worth the effort:
The biggest dependencies (`perl` and `cups-filters`) are
already present on most NixOS systems, and they cannot
be "split away" easily since it cannot be
done along a canonical line (e.g. printer driver).
Splitting directly by dependency risks that ppd files
unexpectedly "move from output to output" on package updates;
disappearing ppd files can be quite annoying for package users.

Yarny0 075d1121 156cc612

+133 -2
+5 -1
pkgs/misc/cups/drivers/foomatic-db-nonfree/default.nix
··· 69 69 # searching for ppd files can find this package 70 70 longDescription = '' 71 71 The collected knowledge about printers, 72 - drivers, and driver options in XML files. 72 + drivers, and driver options in XML files, 73 + used by `foomatic-db-engine` to generate PPD files. 73 74 This is a package of PPD and Foomatic XML files 74 75 that may have restrictions that keep them 75 76 from being used on a variety of machines 76 77 for licensing and other non-technical reasons. 78 + The XML files in this package enable `foomatic-db-ppds` 79 + to create about 120 additional PPD files, for printer from 80 + Dell, Genicom, Lexmark, Oce, Tektronix and Xerox. 77 81 Besides the XML files, this package contains 78 82 about 130 PPD files, for printers from 79 83 Dell, Genicom, Lexmark, Oce and Xerox.
+122
pkgs/misc/cups/drivers/foomatic-db-ppds/default.nix
··· 1 + { lib 2 + , foomatic-db 3 + , foomatic-db-nonfree 4 + , buildEnv 5 + , foomatic-db-engine 6 + , stdenv 7 + , cups-filters 8 + , ghostscript 9 + , netpbm 10 + , perl 11 + , psutils 12 + , patchPpdFilesHook 13 + , withNonfreeDb ? false # include foomatic-db-nonfree ppd files 14 + }: 15 + 16 + let 17 + foomatic-db-packages = [ foomatic-db ] ++ 18 + lib.lists.optional withNonfreeDb foomatic-db-nonfree; 19 + 20 + foomatic-db-combined = buildEnv { 21 + name = "foomatic-db-combined"; 22 + paths = foomatic-db-packages; 23 + pathsToLink = [ "/share/foomatic" ]; 24 + # `foomatic-db-combined` is a nativeBuildInput of `foomatic-db-ppds`. 25 + # The setup hook defined here helps scripts in 26 + # `foomatic-db-engine` to find the database. 27 + postBuild = '' 28 + mkdir -p "${placeholder "out"}"/{etc/cups,nix-support} 29 + cat >> "${placeholder "out"}/nix-support/setup-hook" << eof 30 + export FOOMATICDB="${placeholder "out"}/share/foomatic" 31 + eof 32 + ''; 33 + }; 34 + 35 + # the effective license is `free` if all database 36 + # packages have free licenses, `unfree` otherwise 37 + isFree = lib.trivial.pipe foomatic-db-packages [ 38 + (lib.lists.map (lib.attrsets.attrByPath [ "meta" "license" ] lib.licenses.unfree)) 39 + (lib.lists.all (lib.attrsets.attrByPath [ "free" ] true)) 40 + ]; 41 + in 42 + 43 + stdenv.mkDerivation { 44 + pname = "foomatic-db-ppds"; 45 + # the effective version is simply the 46 + # highest version of all database packages 47 + version = lib.trivial.pipe foomatic-db-packages [ 48 + (lib.lists.map (lib.attrsets.getAttr "version")) 49 + (lib.lists.sort lib.strings.versionOlder) 50 + lib.lists.reverseList 51 + lib.lists.head 52 + ]; 53 + 54 + buildInputs = [ 55 + cups-filters 56 + ghostscript 57 + netpbm 58 + perl 59 + psutils 60 + ]; 61 + 62 + nativeBuildInputs = [ 63 + foomatic-db-combined 64 + foomatic-db-engine 65 + patchPpdFilesHook 66 + ]; 67 + 68 + dontUnpack = true; 69 + 70 + installPhase = '' 71 + runHook preInstall 72 + mkdir -p "${placeholder "out"}/share/cups/model" 73 + foomatic-compiledb -j "$NIX_BUILD_CORES" -d "${placeholder "out"}/share/cups/model/foomatic-db-ppds" 74 + runHook postInstall 75 + ''; 76 + 77 + # Comments indicate the respective 78 + # package the command is contained in. 79 + ppdFileCommands = [ 80 + "cat" "echo" # coreutils 81 + "foomatic-rip" # cups-filters or foomatic-filters 82 + "gs" # ghostscript 83 + "pnmflip" "pnmgamma" "pnmnoraw" # netpbm 84 + "perl" # perl 85 + "psresize" # psutils 86 + # These commands aren't packaged yet. 87 + # ppd files using these likely won't work. 88 + #"c2050" "c2070" "cjet" "lm1100" 89 + #"pbm2l2030" "pbm2lwxl" "rastertophaser6100" 90 + ]; 91 + 92 + # compress ppd files 93 + postFixup = '' 94 + echo 'compressing ppd files' 95 + find -H "${placeholder "out"}/share/cups/model/foomatic-db-ppds" -type f -iname '*.ppd' -print0 \ 96 + | xargs -0r -n 64 -P "$NIX_BUILD_CORES" gzip -9n 97 + ''; 98 + 99 + meta = { 100 + description = "OpenPrinting ppd files"; 101 + homepage = "https://openprinting.github.io/projects/02-foomatic/"; 102 + license = if isFree then lib.licenses.free else lib.licenses.unfree; 103 + maintainers = [ lib.maintainers.yarny ]; 104 + # list printer manufacturers here so people 105 + # searching for ppd files can find this package 106 + longDescription = '' 107 + All PPD files available in 108 + OpenPrinting's Foomatic database. 109 + This package contains about 8,800 PPD files, 110 + for printers from 111 + Alps, Anitech, Apollo, Apple, Avery, Brother, Canon, 112 + Citizen, CItoh, Compaq, DEC, Dell, Dymo-CoStar, Epson, 113 + Fujitsu, FujiXerox, Generic, Genicom, Gestetner, 114 + Heidelberg, Hitachi, HP, IBM, Imagen, Imagistics, 115 + InfoPrint, Infotec, Kodak, KONICAMINOLTA, Kyocera, Lanier, 116 + Lexmark, Minolta, MinoltaQMS, Mitsubishi, NEC, NRG, Oce, 117 + Oki, Olivetti, Panasonic, PCPI, Pentax, QMS, Raven, Ricoh, 118 + Samsung, Savin, Seiko, Sharp, SiPix, Sony, Star, Tally, 119 + Tektronix, TexasInstruments, Toshiba, Xante and Xerox. 120 + ''; 121 + }; 122 + }
+4 -1
pkgs/misc/cups/drivers/foomatic-db/default.nix
··· 88 88 # searching for ppd files can find this package 89 89 longDescription = '' 90 90 The collected knowledge about printers, 91 - drivers, and driver options in XML files. 91 + drivers, and driver options in XML files, 92 + used by `foomatic-db-engine` to generate PPD files. 93 + PPD files generated from the XML files in this package 94 + are contained in the package 'foomatic-db-ppds'. 92 95 Besides the XML files, this package contains 93 96 about 6,600 PPD files, for printers from 94 97 Brother, Canon, Epson, Gestetner, HP, InfoPrint,
+2
pkgs/top-level/all-packages.nix
··· 36322 36322 foomatic-db = callPackage ../misc/cups/drivers/foomatic-db {}; 36323 36323 foomatic-db-engine = callPackage ../misc/cups/drivers/foomatic-db-engine {}; 36324 36324 foomatic-db-nonfree = callPackage ../misc/cups/drivers/foomatic-db-nonfree {}; 36325 + foomatic-db-ppds = callPackage ../misc/cups/drivers/foomatic-db-ppds {}; 36326 + foomatic-db-ppds-withNonfreeDb = callPackage ../misc/cups/drivers/foomatic-db-ppds { withNonfreeDb = true; }; 36325 36327 36326 36328 gutenprint = callPackage ../misc/drivers/gutenprint { }; 36327 36329