Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nixos/printers: allow supplying raw ppd file #80601

Closed
wants to merge 1 commit into from

Conversation

ryantrinkle
Copy link
Contributor

Motivation for this change

I have a printer whose driver is not in gutenprint, but for which I have a driver and a PPD file. Before using declarative printer configuration, I supplied the PPD file in the CUPS console when adding the printer. This change allows the same approach to be used with the declarative printer configuration module.

I'm not very happy with the way ppd and model interact here, but I'm not sure exactly what would be a better way. I'd appreciate suggestions on a better interface we could provide!

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • [N/A] macOS
    • [N/A] other Linux distributions
  • [N/A] Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • [N/A] Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • [N/A] Tested execution of all binary files (usually in ./result/bin/)
  • [N/A] Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

@ryantrinkle
Copy link
Contributor Author

@florianjacob I'd appreciate your input on the interface here; if you have an idea for how to do it more cleanly, I'll be happy to update it!

description = ''
Location of the ppd driver file for the printer.
Model of the printer, in the form of a path to an installed PPD file.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you say drv:///... so people don't think it's a file path?

@@ -82,13 +86,27 @@ in {
'';
};
model = mkOption {
type = types.str;
type = types.nullOr types.str;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a types.either

@florianjacob
Copy link
Contributor

Thanks for looking at this case, I really thought you could specify absolute paths to ppd files for model and are done with it. 👍

In general, I wonder how complex it currently is to package custom ppd files and whether that should be the One True Way™ to deal with custom ppd files.
In theory, it shouldn't be more than a simple derivation with a folder share/cups/model/<manufacturer>/<ppdfile>.ppd, adding that to services.printing.drivers = [ pkgs.gutenprint pkgs.foomatic-filters pkgs.hplip custom-derivation ]; and then one should be able to use model = "<manufacturer>/<ppdfile>.ppd"; - here model actually is a file path, but a relative one to share/cups/model. This is also the case for the hplip drivers, which also just copy their ppd files and don't use some form of drv:// protocol prefix.

As I never required a ppd file that wasn't yet packaged in pkgs/misc/drivers/ / pkgs/misc/cups/drivers, @ryantrinkle what do you think on path to ppd file vs. custom derivation? I would also imagine that if we aren't careful, the path to ppd file could end up more brittle on rebuilds when the file isn't present / its copy in /nix/store gets garbage-collected.

Concretely, I also think that types.either types.path or types.str; would lead to a better user experience, probably with an assert that in case type is types.str, it does not start with "/". Even if the options are then less aligned with lpadmin, but we're building a wrapper anyway.

@stale
Copy link

stale bot commented Aug 24, 2020

Hello, I'm a bot and I thank you in the name of the community for your contributions.

Nixpkgs is a busy repository, and unfortunately sometimes PRs get left behind for too long. Nevertheless, we'd like to help committers reach the PRs that are still important. This PR has had no activity for 180 days, and so I marked it as stale, but you can rest assured it will never be closed by a non-human.

If this is still important to you and you'd like to remove the stale label, we ask that you leave a comment. Your comment can be as simple as "still important to me". But there's a bit more you can do:

If you received an approval by an unprivileged maintainer and you are just waiting for a merge, you can @ mention someone with merge permissions and ask them to help. You might be able to find someone relevant by using Git blame on the relevant files, or via GitHub's web interface. You can see if someone's a member of the nixpkgs-committers team, by hovering with the mouse over their username on the web interface, or by searching them directly on the list.

If your PR wasn't reviewed at all, it might help to find someone who's perhaps a user of the package or module you are changing, or alternatively, ask once more for a review by the maintainer of the package/module this is about. If you don't know any, you can use Git blame on the relevant files, or GitHub's web interface to find someone who touched the relevant files in the past.

If your PR has had reviews and nevertheless got stale, make sure you've responded to all of the reviewer's requests / questions. Usually when PR authors show responsibility and dedication, reviewers (privileged or not) show dedication as well. If you've pushed a change, it's possible the reviewer wasn't notified about your push via email, so you can always officially request them for a review, or just @ mention them and say you've addressed their comments.

Lastly, you can always ask for help at our Discourse Forum, or more specifically, at this thread or at #nixos' IRC channel.

@stale stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Aug 24, 2020
@ryantrinkle
Copy link
Contributor Author

@florianjacob Sorry for the very long delay! I've tried out the approach you suggested, and it worked just fine - I think it's a better user experience, so I don't think my patch is necessary. Thanks for the advice!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants