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

brltty: 6.1 -> 6.3; nixos/brltty: use upstream units #114745

Merged
merged 6 commits into from May 7, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
57 changes: 32 additions & 25 deletions nixos/modules/services/hardware/brltty.nix
Expand Up @@ -5,6 +5,19 @@ with lib;
let
cfg = config.services.brltty;

targets = [
"default.target" "multi-user.target"
"rescue.target" "emergency.target"
];

genApiKey = pkgs.writers.writeDash "generate-brlapi-key" ''
if ! test -f /etc/brlapi.key; then
echo -n generating brlapi key...
${pkgs.brltty}/bin/brltty-genkey -f /etc/brlapi.key
echo done
fi
'';

in {

options = {
Expand All @@ -18,33 +31,27 @@ in {
};

config = mkIf cfg.enable {

systemd.services.brltty = {
description = "Braille Device Support";
unitConfig = {
Documentation = "http://mielke.cc/brltty/";
DefaultDependencies = "no";
RequiresMountsFor = "${pkgs.brltty}/var/lib/brltty";
};
serviceConfig = {
ExecStart = "${pkgs.brltty}/bin/brltty --no-daemon";
Type = "notify";
TimeoutStartSec = 5;
TimeoutStopSec = 10;
Restart = "always";
RestartSec = 30;
Nice = -10;
OOMScoreAdjust = -900;
ProtectHome = "read-only";
ProtectSystem = "full";
SystemCallArchitectures = "native";
};
wants = [ "systemd-udev-settle.service" ];
after = [ "local-fs.target" "systemd-udev-settle.service" ];
before = [ "sysinit.target" ];
wantedBy = [ "sysinit.target" ];
users.users.brltty = {
description = "BRLTTY daemon user";
group = "brltty";
};
users.groups = {
brltty = { };
brlapi = { };
};

systemd.services."brltty@".serviceConfig =
{ ExecStartPre = "!${genApiKey}"; };

# Install all upstream-provided files
systemd.packages = [ pkgs.brltty ];
systemd.tmpfiles.packages = [ pkgs.brltty ];
services.udev.packages = [ pkgs.brltty ];
environment.systemPackages = [ pkgs.brltty ];

# Add missing WantedBys (see issue #81138)
systemd.paths.brltty.wantedBy = targets;
systemd.paths."brltty@".wantedBy = targets;
};

}
81 changes: 67 additions & 14 deletions pkgs/tools/misc/brltty/default.nix
@@ -1,19 +1,19 @@
{ lib, stdenv, fetchurl, pkg-config, python3, bluez
, alsaSupport ? stdenv.isLinux, alsaLib ? null
, systemdSupport ? stdenv.isLinux, systemd ? null }:

assert alsaSupport -> alsaLib != null;
assert systemdSupport -> systemd != null;
, tcl, acl, kmod, coreutils, shadow, util-linux, udev
, alsaSupport ? stdenv.isLinux, alsaLib
, systemdSupport ? stdenv.isLinux, systemd
}:

stdenv.mkDerivation rec {
name = "brltty-6.1";
pname = "brltty";
version = "6.3";

src = fetchurl {
url = "http://brltty.com/archive/${name}.tar.gz";
sha256 = "0nk54chr7z2w579vyiak9xk2avhnvrx7x2l5sk8nyw2zplchkx9q";
url = "https://brltty.app/archive/${pname}-${version}.tar.gz";
sha256 = "14psxwlvgyi2fj1zh8rfykyjcjaya8xa7yg574bxd8y8n49n8hvb";
};

nativeBuildInputs = [ pkg-config python3.pkgs.cython ];
nativeBuildInputs = [ pkg-config python3.pkgs.cython tcl ];
buildInputs = [ bluez ]
++ lib.optional alsaSupport alsaLib
++ lib.optional systemdSupport systemd;
Expand All @@ -26,17 +26,70 @@ stdenv.mkDerivation rec {
It drives the braille display, and provides complete screen review functionality.
Some speech capability has also been incorporated.
'';
homepage = "http://www.brltty.com/";
license = lib.licenses.gpl2;
homepage = "https://brltty.app";
license = lib.licenses.gpl2Plus;
maintainers = [ lib.maintainers.bramd ];
Copy link
Member

Choose a reason for hiding this comment

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

We could shorten this by using meta = with lib; {

platforms = lib.platforms.all;
};

makeFlags = [ "PYTHON_PREFIX=$(out)" ];

preConfigurePhases = [ "preConfigure" ];
makeFlags = [
"PYTHON_PREFIX=$(out)"
"SYSTEMD_UNITS_DIRECTORY=$(out)/lib/systemd/system"
"SYSTEMD_USERS_DIRECTORY=$(out)/lib/sysusers.d"
"SYSTEMD_FILES_DIRECTORY=$(out)/lib/tmpfiles.d"
"UDEV_LIBRARY_DIRECTORY=$(out)/lib/udev"
"UDEV_RULES_TYPE=all"
"POLKIT_POLICY_DIR=$(out)/share/polkit-1/actions"
"POLKIT_RULE_DIR=$(out)/share/polkit-1/rules.d"
];
configureFlags = [
"--with-writable-directory=/run/brltty"
"--with-updatable-directory=/var/lib/brltty"
"--with-api-socket-path=/var/lib/BrlAPI"
];
installFlags = [ "install-systemd" "install-udev" "install-polkit" ];

preConfigure = ''
substituteInPlace configure --replace /sbin/ldconfig ldconfig

# Some script needs a working tclsh shebang
patchShebangs .

# Skip impure operations
substituteInPlace Programs/Makefile.in \
--replace install-writable-directory "" \
--replace install-apisoc-directory "" \
--replace install-api-key ""
'';

postInstall = ''
# Rewrite absolute paths
substituteInPlace $out/bin/brltty-mkuser \
--replace '/sbin/nologin' '${shadow}/bin/nologin'
(
cd $out/lib
substituteInPlace systemd/system/brltty@.service \
--replace '/usr/lib' "$out/lib" \
--replace '/sbin/modprobe' '${kmod}/bin/modprobe'
# Ensure the systemd-wrapper script uses the correct path to the brltty binary
sed "/^Environment=\"BRLTTY_EXECUTABLE_ARGUMENTS.*/a Environment=\"BRLTTY_EXECUTABLE_PATH=$out/bin/brltty\"" -i systemd/system/brltty@.service
substituteInPlace systemd/system/brltty-device@.service \
--replace '/usr/bin/true' '${coreutils}/bin/true'
substituteInPlace udev/rules.d/90-brltty-uinput.rules \
--replace '/usr/bin/setfacl' '${acl}/bin/setfacl'
substituteInPlace tmpfiles.d/brltty.conf \
--replace "$out/etc" '/etc'

# Remove unused commands from udev rules
sed '/initctl/d' -i udev/rules.d/90-brltty-device.rules
# Remove pulse-access group from systemd unit and sysusers
substituteInPlace systemd/system/brltty@.service \
--replace 'SupplementaryGroups=pulse-access' '# SupplementaryGroups=pulse-access'
substituteInPlace sysusers.d/brltty.conf \
--replace 'm brltty pulse-access' '# m brltty pulse-access'
)
substituteInPlace $out/libexec/brltty/systemd-wrapper \
--replace 'logger' "${util-linux}/bin/logger" \
--replace 'udevadm' "${udev}/bin/udevadm"
'';
}