nixpkgs/pkgs/tools/inputmethods/input-remapper/default.nix

165 lines
5.4 KiB
Nix
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{ lib
, python3
, pkgconfig
, wrapGAppsHook
, gettext
, gtk3
, glib
, dbus
, gobject-introspection
, xmodmap
, pygobject3
, setuptools
, evdev
, pydantic
, pydbus
, psutil
, fetchFromGitHub
, buildPythonApplication
, procps
, gtksourceview4
, nixosTests
# Change the default log level to debug for easier debugging of package issues
, withDebugLogLevel ? false
# Xmodmap is an optional dependency
# If you use Xmodmap to set keyboard mappings (or your DE does)
# it is required to correctly map keys
, withXmodmap ? true
# Some tests are flakey under high CPU load and could cause intermittent
# failures when building. Override this to true to run tests anyway
# See upstream issue: https://github.com/sezanzeb/input-remapper/issues/306
, withDoCheck ? false
# Version and rev and hash are package arguments to allow overriding
# while ensuring the values in prePatch and src match
# https://discourse.nixos.org/t/avoid-rec-expresions-in-nixpkgs/8293/7
# The names are prefixed with input_remapper to avoid potential
# collisions with package names
, input_remapper_version ? "unstable-2022-02-09"
, input_remapper_src_rev ? "55227e0b5a28d21d7333c6c8ea1c691e56fd35c4"
, input_remapper_src_hash ? "sha256-kzGlEaYN/JfAgbI0aMLr5mwObYOL43X7QU/ihDEBQFg="
}:
let
maybeXmodmap = lib.optional withXmodmap xmodmap;
in
buildPythonApplication {
pname = "input-remapper";
version = input_remapper_version;
src = fetchFromGitHub {
rev = input_remapper_src_rev;
owner = "sezanzeb";
repo = "input-remapper";
hash = input_remapper_src_hash;
};
# Fixes error
# Couldnt recognize the image file format for file "*.svg"
# at startup, see https://github.com/NixOS/nixpkgs/issues/56943
strictDeps = false;
prePatch = ''
# set revision for --version output
echo "COMMIT_HASH = '${input_remapper_src_rev}'" > inputremapper/commit_hash.py
# fix FHS paths
substituteInPlace inputremapper/configs/data.py \
--replace "/usr/share/input-remapper" "$out/usr/share/input-remapper"
'' + (lib.optionalString (withDebugLogLevel) ''
# if debugging
substituteInPlace inputremapper/logger.py --replace "logger.setLevel(logging.INFO)" "logger.setLevel(logging.DEBUG)"
'');
doCheck = withDoCheck;
checkInputs = [
psutil
];
pythonImportsCheck = [
"evdev"
"inputremapper"
];
# Custom test script, can't use plain pytest / pytestCheckHook
# We only run tests in the unit folder, integration tests require UI
# To allow tests which access the system and session DBUS to run, we start a dbus session
# and bind it to both the system and session buses
installCheckPhase = ''
echo "<busconfig>
<type>session</type>
<listen>unix:tmpdir=$TMPDIR</listen>
<listen>unix:path=/build/system_bus_socket</listen>
<standard_session_servicedirs/>
<policy context=\"default\">
<!-- Allow everything to be sent -->
<allow send_destination=\"*\" eavesdrop=\"true\"/>
<!-- Allow everything to be received -->
<allow eavesdrop=\"true\"/>
<!-- Allow anyone to own anything -->
<allow own=\"*\"/>
</policy>
</busconfig>" > dbus.cfg
PATH=${lib.makeBinPath ([ dbus procps ] ++ maybeXmodmap)}:$PATH \
USER="$(id -u -n)" \
DBUS_SYSTEM_BUS_ADDRESS=unix:path=/build/system_bus_socket \
${dbus}/bin/dbus-run-session --config-file dbus.cfg \
python tests/test.py --start-dir unit
'';
# Nixpkgs 15.9.4.3. When using wrapGAppsHook with special derivers you can end up with double wrapped binaries.
dontWrapGApps = true;
preFixup = ''
makeWrapperArgs+=(
"''${gappsWrapperArgs[@]}"
--prefix PATH : "${lib.makeBinPath maybeXmodmap}"
)
'';
nativeBuildInputs = [
wrapGAppsHook
gettext # needed to build translations
gtk3
glib
gobject-introspection
pygobject3
] ++ maybeXmodmap;
propagatedBuildInputs = [
setuptools # needs pkg_resources
pygobject3
evdev
pkgconfig
pydantic
pydbus
gtksourceview4
];
postInstall = ''
sed -r "s#RUN\+\=\"/bin/input-remapper-control#RUN\+\=\"$out/bin/input-remapper-control#g" -i data/99-input-remapper.rules
sed -r "s#ExecStart\=/usr/bin/input-remapper-service#ExecStart\=$out/bin/input-remapper-service#g" -i data/input-remapper.service
chmod +x data/*.desktop
install -D -t $out/share/applications/ data/*.desktop
install -D -t $out/share/polkit-1/actions/ data/input-remapper.policy
install -D data/99-input-remapper.rules $out/etc/udev/rules.d/99-input-remapper.rules
install -D data/input-remapper.service $out/lib/systemd/system/input-remapper.service
install -D data/input-remapper.policy $out/share/polkit-1/actions/input-remapper.policy
install -D data/inputremapper.Control.conf $out/etc/dbus-1/system.d/inputremapper.Control.conf
install -D -t $out/usr/share/input-remapper/ data/*
# Only install input-remapper prefixed binaries, we don't care about deprecated key-mapper ones
install -m755 -D -t $out/bin/ bin/input-remapper*
'';
passthru.tests = nixosTests.input-remapper;
meta = with lib; {
description = "An easy to use tool to change the mapping of your input device buttons";
homepage = "https://github.com/sezanzeb/input-remapper";
license = licenses.gpl3Plus;
platforms = platforms.linux;
maintainers = with maintainers; [ LunNova ];
mainProgram = "input-remapper-gtk";
};
}