pkgs/tools/audio/botamusique/default.nix

   1 { lib
   2 , stdenv
   3 , fetchFromGitHub
   4 , python3Packages
   5 , ffmpeg-headless
   6 , makeWrapper
   7 , nixosTests
   8 , nodejs
   9 , npmHooks
  10 , fetchNpmDeps
  11
  12 # For the update script
  13 , coreutils
  14 , curl
  15 , nix-prefetch-git
  16 , prefetch-npm-deps
  17 , jq
  18 , writeShellScript
  19 }:
  20 let
  21   srcJson = lib.importJSON ./src.json;
  22   src = fetchFromGitHub {
  23     owner = "azlux";
  24     repo = "botamusique";
  25     inherit (srcJson) rev sha256;
  26   };
  27
  28   # Python needed to instantiate the html templates
  29   buildPython = python3Packages.python.withPackages (ps: [ ps.jinja2 ]);
  30 in
  31
  32 stdenv.mkDerivation rec {
  33   pname = "botamusique";
  34   version = srcJson.version;
  35
  36   inherit src;
  37
  38   npmDeps = fetchNpmDeps {
  39     src = "${src}/web";
  40     hash = srcJson.npmDepsHash;
  41   };
  42
  43   npmRoot = "web";
  44
  45   patches = [
  46     # botamusique by default resolves relative state paths by first checking
  47     # whether it exists in the working directory, then falls back to using the
  48     # installation directory. With Nix however, the installation directory is
  49     # not writable, so that won't work. So we change this so that it uses
  50     # relative paths unconditionally, whether they exist or not.
  51     ./unconditional-relative-state-paths.patch
  52
  53     # We can't update the package at runtime with NixOS, so this patch makes
  54     # the !update command mention that
  55     ./no-runtime-update.patch
  56
  57     # Fix passing of invalid "git" version into version.parse, which results
  58     # in an InvalidVersion exception. The upstream fix is insufficient, so
  59     # we carry the correct patch downstream for now.
  60     ./catch-invalid-versions.patch
  61   ];
  62
  63   postPatch = ''
  64     # However, the function that's patched above is also used for
  65     # configuration.default.ini, which is in the installation directory
  66     # after all. So we need to counter-patch it here so it can find it absolutely
  67     substituteInPlace mumbleBot.py \
  68       --replace "configuration.default.ini" "$out/share/botamusique/configuration.default.ini" \
  69       --replace "version = 'git'" "version = '${version}'"
  70   '';
  71
  72   NODE_OPTIONS = "--openssl-legacy-provider";
  73
  74   nativeBuildInputs = [
  75     makeWrapper
  76     nodejs
  77     npmHooks.npmConfigHook
  78     python3Packages.wrapPython
  79   ];
  80
  81   pythonPath = with python3Packages; [
  82     flask
  83     magic
  84     mutagen
  85     packaging
  86     pillow
  87     pymumble
  88     pyradios
  89     requests
  90     yt-dlp
  91   ];
  92
  93   buildPhase = ''
  94     runHook preBuild
  95
  96     # Generates artifacts in ./static
  97     (
  98       cd web
  99       npm run build
 100     )
 101
 102     # Fills out http templates
 103     ${buildPython}/bin/python scripts/translate_templates.py --lang-dir lang/ --template-dir templates/
 104
 105     runHook postBuild
 106   '';
 107
 108   installPhase = ''
 109     runHook preInstall
 110
 111     mkdir -p $out/share $out/bin
 112     cp -r . $out/share/botamusique
 113     chmod +x $out/share/botamusique/mumbleBot.py
 114     wrapPythonProgramsIn $out/share/botamusique "$out $pythonPath"
 115
 116     # Convenience binary and wrap with ffmpeg dependency
 117     makeWrapper $out/share/botamusique/mumbleBot.py $out/bin/botamusique \
 118       --prefix PATH : ${lib.makeBinPath [ ffmpeg-headless ]}
 119
 120     runHook postInstall
 121   '';
 122
 123   passthru.updateScript = writeShellScript "botamusique-updater" ''
 124     export PATH=${lib.makeBinPath [ coreutils curl nix-prefetch-git jq prefetch-npm-deps ]}
 125     set -ex
 126
 127     OWNER=azlux
 128     REPO=botamusique
 129     VERSION="$(curl https://api.github.com/repos/$OWNER/$REPO/releases/latest | jq -r '.tag_name')"
 130
 131     nix-prefetch-git --rev "$VERSION" --url https://github.com/$OWNER/$REPO | \
 132       jq > "${toString ./src.json}" \
 133         --arg version "$VERSION" \
 134         '.version |= $version'
 135     path="$(jq '.path' -r < "${toString ./src.json}")"
 136
 137     tmp="$(mktemp -d)"
 138     trap 'rm -rf "$tmp"' exit
 139
 140     npmHash="$(prefetch-npm-deps $path/web/package-lock.json)"
 141     jq '. + { npmDepsHash: "'"$npmHash"'" }' < "${toString ./src.json}" > "$tmp/src.json"
 142     mv "$tmp/src.json" "${toString ./src.json}"
 143   '';
 144
 145   passthru.tests = {
 146     inherit (nixosTests) botamusique;
 147   };
 148
 149   meta = with lib; {
 150     description = "Bot to play youtube / soundcloud / radio / local music on Mumble";
 151     homepage = "https://github.com/azlux/botamusique";
 152     license = licenses.mit;
 153     platforms = platforms.all;
 154     maintainers = [ ];
 155     mainProgram = "botamusique";
 156   };
 157 }