home-manager/modules/services/mopidy.nix
Emily 9f9e277b60 treewide: remove now-redundant lib.mdDoc calls
These (and the `*MD` functions apart from `literalMD`) are now no-ops
in nixpkgs and serve no purpose other than to add additional noise and
potentially mislead people into thinking unmarked DocBook documentation
will still be accepted.

Note that if backporting changes including documentation to 23.05,
the `mdDoc` calls will need to be re-added.

To reproduce this commit, run:

    $ NIX_PATH=nixpkgs=flake:nixpkgs/e7e69199f0372364a6106a1e735f68604f4c5a25 \
      nix shell nixpkgs#coreutils \
      -c find . -name '*.nix' \
      -exec nix run -- github:emilazy/nix-doc-munge/98dadf1f77351c2ba5dcb709a2a171d655f15099 \
      --strip {} +
    $ ./format
2023-07-17 18:49:09 +01:00

152 lines
4.2 KiB
Nix

{ config, options, lib, pkgs, ... }:
with lib;
let
cfg = config.services.mopidy;
# The configuration format of Mopidy. It seems to use configparser with
# some quirky handling of its types. You can see how they're handled in
# `mopidy/config/types.py` from the source code.
toMopidyConf = generators.toINI {
mkKeyValue = generators.mkKeyValueDefault {
mkValueString = v:
if isList v then
"\n " + concatStringsSep "\n " v
else
generators.mkValueStringDefault { } v;
} " = ";
};
mopidyEnv = pkgs.buildEnv {
name = "mopidy-with-extensions-${pkgs.mopidy.version}";
paths = closePropagation cfg.extensionPackages;
pathsToLink = [ "/${pkgs.mopidyPackages.python.sitePackages}" ];
buildInputs = [ pkgs.makeWrapper ];
postBuild = ''
makeWrapper ${pkgs.mopidy}/bin/mopidy $out/bin/mopidy \
--prefix PYTHONPATH : $out/${pkgs.mopidyPackages.python.sitePackages}
'';
};
# Nix-representable format for Mopidy config.
mopidyConfFormat = { }: {
type = with types;
let
valueType = nullOr (oneOf [ bool float int str (listOf valueType) ])
// {
description = "Mopidy config value";
};
in attrsOf (attrsOf valueType);
generate = name: value: pkgs.writeText name (toMopidyConf value);
};
settingsFormat = mopidyConfFormat { };
configFilePaths = concatStringsSep ":"
([ "${config.xdg.configHome}/mopidy/mopidy.conf" ] ++ cfg.extraConfigFiles);
in {
meta.maintainers = [ hm.maintainers.foo-dogsquared ];
options.services.mopidy = {
enable = mkEnableOption "Mopidy music player daemon";
extensionPackages = mkOption {
type = with types; listOf package;
default = [ ];
example = literalExpression
"with pkgs; [ mopidy-spotify mopidy-mpd mopidy-mpris ]";
description = ''
Mopidy extensions that should be loaded by the service.
'';
};
settings = mkOption {
type = settingsFormat.type;
default = { };
example = literalExpression ''
{
file = {
media_dirs = [
"$XDG_MUSIC_DIR|Music"
"~/library|Library"
];
follow_symlinks = true;
excluded_file_extensions = [
".html"
".zip"
".jpg"
".jpeg"
".png"
];
};
# Please don't put your mopidy-spotify configuration in the public. :)
# Think of your Spotify Premium subscription!
spotify = {
client_id = "CLIENT_ID";
client_secret = "CLIENT_SECRET";
};
}
'';
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/mopidy/mopidy.conf`.
See <https://docs.mopidy.com/en/latest/config/> for
more details.
'';
};
extraConfigFiles = mkOption {
default = [ ];
type = types.listOf types.path;
description = ''
Extra configuration files read by Mopidy when the service starts.
Later files in the list override earlier configuration files and
structured settings.
'';
};
};
config = mkIf cfg.enable {
assertions =
[ (hm.assertions.assertPlatform "services.mopidy" pkgs platforms.linux) ];
xdg.configFile."mopidy/mopidy.conf".source =
settingsFormat.generate "mopidy-${config.home.username}" cfg.settings;
systemd.user.services.mopidy = {
Unit = {
Description = "mopidy music player daemon";
Documentation = [ "https://mopidy.com/" ];
After = [ "network.target" "sound.target" ];
};
Service = {
ExecStart = "${mopidyEnv}/bin/mopidy --config ${configFilePaths}";
};
Install.WantedBy = [ "default.target" ];
};
systemd.user.services.mopidy-scan = {
Unit = {
Description = "mopidy local files scanner";
Documentation = [ "https://mopidy.com/" ];
After = [ "network.target" "sound.target" ];
};
Service = {
ExecStart =
"${mopidyEnv}/bin/mopidy --config ${configFilePaths} local scan";
Type = "oneshot";
};
Install.WantedBy = [ "default.target" ];
};
};
}