path: root/makefu/3modules/rtorrent.nix

{ config, lib, pkgs, ... }:

with config.krebs.lib;
let
  cfg = config.makefu.rtorrent;
  webcfg = config.makefu.rtorrent.web;
  rucfg = config.makefu.rtorrent.rutorrent;

  nginx-user = config.services.nginx.user;
  nginx-group = config.services.nginx.group;
  rutorrent-deps = with pkgs; [ curl php coreutils procps ffmpeg mediainfo ] ++
    (if config.nixpkgs.config.allowUnfree then
      trace "enabling unfree packages for rutorrent" [ unrar unzip ] else
      trace "not enabling unfree packages for rutorrent because allowUnfree is unset" [])
;
  rutorrent = pkgs.stdenv.mkDerivation {
    name = "rutorrent-src-3.7";
    src = pkgs.fetchFromGitHub {
      owner = "Novik";
      repo = "rutorrent";
      rev = "b727523a153454d4976f04b0c47336ae57cc50d5";
      sha256 = "0s5wa0jnck781amln9c2p4pc0i5mq3j5693ra151lnwhz63aii4a";
    };
    phases = [ "patchPhase" "installPhase" ];
    patchPhase = ''
      cp -r $src src/
      chmod u+w -R src/
      sed -i -e 's#^\s*$scgi_port.*#$scgi_port = 0;#' \
          -e 's#^\s*$scgi_host.*#$scgi_host = "unix://${cfg.xmlrpc-socket}";#' \
             "src/conf/config.php"
    '';
    installPhase = ''
      cp -r src/ $out
      echo "replacing scgi port and host variable in conf/config.php"
    '';
  };
  fpm-socket = "/var/run/php5-fpm.sock";
  systemd-logfile = cfg.workDir + "/rtorrent-systemd.log";
  configFile = pkgs.writeText "rtorrent-config" ''
    # THIS FILE IS AUTOGENERATED
    ${optionalString (cfg.listenPort != null) ''
      port_range = ${toString cfg.listenPort}-${toString cfg.listenPort}
      port_random = no
    ''}

    ${optionalString (cfg.watchDir != null) ''
      schedule = watch_directory,5,5load_start=${cfg.watchDir}/*.torrent
    ''}

    directory = ${cfg.downloadDir}
    session = ${cfg.sessionDir}

    ${optionalString (cfg.enableXMLRPC ) ''
      # prepare socket and set permissions. rtorrent user is part of group nginx
      # TODO: configure a shared torrent group
      execute_nothrow = rm,${cfg.xmlrpc-socket}
      scgi_local = ${cfg.xmlrpc-socket}
      schedule = scgi_permission,0,0,"execute.nothrow=chmod,\"ug+w,o=\",${cfg.xmlrpc-socket}"
    ''}

    system.file_allocate.set = ${if cfg.preAllocate then "yes" else "no"}

    # Prepare systemd logging
    log.open_file = "rtorrent-systemd", ${systemd-logfile}
    log.add_output = "warn", "rtorrent-systemd"
    log.add_output = "notice", "rtorrent-systemd"
    log.add_output = "info", "rtorrent-systemd"
    # log.add_output = "debug", "rtorrent-systemd"
    log.execute = ${systemd-logfile}.execute
    log.xmlrpc  = ${systemd-logfile}.xmlrpc
    ${cfg.extraConfig}
  '';

  out = {
    options.makefu.rtorrent = api;
    config = lib.recursiveUpdate (lib.mkIf cfg.enable imp)
           ( lib.recursiveUpdate (lib.mkIf cfg.web.enable rpcweb-imp)
                                 (lib.mkIf cfg.rutorrent.enable rutorrent-imp));
  };

  api = {
    enable = mkEnableOption "rtorrent";

    web = {
      # configure NGINX to provide /RPC2 for listen address
      # authentication also applies to rtorrent.rutorrent
      enable = mkEnableOption "rtorrent nginx web RPC";

      listenAddress = mkOption {
        type = types.str;
        description =''
          nginx listen address for rtorrent web
        '';
        default = "localhost:8005";
      };

      enableAuth = mkEnableOption "rutorrent authentication";
      authfile = mkOption {
        type = types.path;
        description = ''
          basic authentication file to be used.
          Use `${pkgs.apacheHttpd}/bin/htpasswd -c <file> <username>` to create the file.
          Only in use if authentication is enabled.
        '';
      };
    };

    rutorrent = {
      enable = mkEnableOption "rutorrent";
      package = mkOption {
        type = types.package;
        description = ''
          path to rutorrent package. When using your own ruTorrent package,
          make sure you patch the scgi_port and scgi_host.
        '';
        default = rutorrent;
      };


      webdir = mkOption {
        type = types.path;
        description = ''
          rutorrent php files will be written to this folder.
          when using nginx, be aware that the the folder should be readable by nginx.
          because rutorrent does not hold mutable data in a separate folder
          these files must be writable.
        '';
        default = "/var/lib/rutorrent";
      };

    };

    package = mkOption {
      type = types.package;
      default = pkgs.rtorrent;
    };

    # TODO: enable xmlrpc with web.enable
    enableXMLRPC = mkEnableOption "rtorrent xmlrpc via socket";
    xmlrpc-socket = mkOption {
      type = types.str;
      description = ''
        enable xmlrpc at given socket. Required for web-interface.

        for documentation see:
        https://github.com/rakshasa/rtorrent/wiki/RPC-Setup-XMLRPC
      '';
      default = cfg.workDir + "/rtorrent.sock";
    };

    preAllocate = mkOption {
      type = types.bool;
      description = ''
        Pre-Allocate torrent files
      '';
      default = true;
    };

    logLevel = mkOption {
      type = types.str;
      description = ''
        Log level to be used for systemd log
      '';
      default = "warn";
    };

    downloadDir = mkOption {
      type = types.path;
      description = ''
        directory where torrents are stored
      '';
      default = cfg.workDir + "/downloads";
    };

    sessionDir = mkOption {
      type = types.path;
      description = ''
        directory where torrent progress is stored
      '';
      default = cfg.workDir + "/rtorrent-session";
    };

    watchDir = mkOption {
      type = with types; nullOr str;
      description = ''
        directory to watch for torrent files.
        If unset, no watch directory will be configured
      '';
      default = null;
    };

    listenPort = mkOption {
      type = with types; nullOr int;
      description =''
        listening port. if you want multiple ports, use extraConfig port_range
      '';
    };

    extraConfig = mkOption {
      type = types.string;
      description = ''
        config to be placed into ${cfg.workDir}/.rtorrent.rc

        see ${cfg.package}/share/doc/rtorrent/rtorrent.rc
      '';
      default = "";
    };

    user = mkOption {
      description = ''
        user which will run rtorrent. if kept default a new user will be created
      '';
      type = types.str;
      default = "rtorrent";
    };

    workDir = mkOption {
      description = ''
        working directory. rtorrent will search in HOME for `.rtorrent.rc`
      '';
      type = types.str;
      default = "/var/lib/rtorrent";
    };

  };

  imp = {
    systemd.services.rtorrent-daemon = {
      description = "rtorrent headless";
      after = [ "network.target" ];
      wantedBy = [ "multi-user.target" ];
      restartIfChanged = true;
      serviceConfig = {
        Type = "forking";
        ExecStartPre = pkgs.writeDash "prepare-folder" ''
          mkdir -p ${cfg.workDir} ${cfg.sessionDir}
          touch ${systemd-logfile}
          cp -f ${configFile} ${cfg.workDir}/.rtorrent.rc
        '';
        ExecStart = "${pkgs.tmux.bin}/bin/tmux new-session -s rt -n rtorrent -d 'PATH=/bin:/usr/bin:${makeBinPath rutorrent-deps} ${cfg.package}/bin/rtorrent'";

        # PrivateTmp = true;
        ## now you can simply sudo -u rtorrent tmux a
        ## otherwise the tmux session is stored in some private folder in /tmp
        WorkingDirectory = cfg.workDir;
        Restart = "on-failure";
        User = "${cfg.user}";
      };

    };
    systemd.services.rtorrent-log = {
      after = [ "rtorrent-daemon.service" ];
      bindsTo = [ "rtorrent-daemon.service" ];
      wantedBy = [ "rtorrent-daemon.service" ];
      serviceConfig = {
        ExecStart = "${pkgs.coreutils}/bin/tail -f ${systemd-logfile}";
        User = "${cfg.user}";
      };
    };

    users = lib.mkIf (cfg.user == "rtorrent") {
      users.rtorrent = {
        uid = genid "rtorrent";
        home = cfg.workDir;
        group = nginx-group;
        shell = "/bin/sh"; #required for tmux
        createHome = true;
      };
      groups.rtorrent.gid = genid "rtorrent";
    };
  };

  rpcweb-imp = {
    krebs.nginx.enable = mkDefault true;
    krebs.nginx.servers.rtorrent = {
      listen = [ webcfg.listenAddress ];
      server-names = [ "default" ];
      extraConfig = ''
        ${optionalString webcfg.enableAuth ''
          auth_basic "rtorrent";
          auth_basic_user_file ${webcfg.authfile};
        ''}
      '';
      locations = [
        (nameValuePair "/RPC2" ''
          include ${pkgs.nginx}/conf/scgi_params;
          scgi_param    SCRIPT_NAME  /RPC2;
          scgi_pass unix:${cfg.xmlrpc-socket};
        '')
      ];
    };
  };

  rutorrent-imp = let
    webdir = rucfg.webdir;
  in {
    systemd.services.rutorrent-prepare = {
      after = [ "rtorrent-daemon.service" ];
      bindsTo = [ "rtorrent-daemon.service" ];
      wantedBy = [ "rtorrent-daemon.service" ];
      serviceConfig = {
        Type = "oneshot";
        # we create the folder and set the permissions to allow nginx
        # TODO: update files if the version of rutorrent changed
        ExecStart = pkgs.writeDash "create-webconfig-dir" ''
          if [ ! -e ${webdir} ];then
            echo "creating webconfiguration directory for rutorrent: ${webdir}"
            cp -r ${rucfg.package} ${webdir}
            chown -R ${cfg.user}:${nginx-group} ${webdir}
            chmod -R 770 ${webdir}
          else
            echo "not overwriting ${webdir}"
          fi
        '';
      };
    };
    krebs.nginx.servers.rtorrent = {
      extraConfig = ''
        root ${webdir};
      '';
      locations = [

        (nameValuePair "~ \.php$" ''
          client_max_body_size 200M;
          root ${webdir};
          fastcgi_split_path_info ^(.+\.php)(/.+)$;
          fastcgi_pass unix:${fpm-socket};
          try_files $uri =404;
          fastcgi_index  index.php;
          include ${pkgs.nginx}/conf/fastcgi_params;
          include ${pkgs.nginx}/conf/fastcgi.conf;
        '')

      ];
    };
    services.phpfpm = {
      # phpfpm does not have an enable option
      poolConfigs  = let
        user = config.services.nginx.user;
        group = config.services.nginx.group;
        fpm-socket = "/var/run/php5-fpm.sock";
      in {
        rutorrent = ''
          user =  ${user}
          group =  ${group}
          listen = ${fpm-socket}
          listen.owner = ${user}
          listen.group = ${group}
          pm = dynamic
          pm.max_children = 5
          pm.start_servers = 2
          pm.min_spare_servers = 1
          pm.max_spare_servers = 3
          chdir = /
          # errors to journal
          php_admin_value[error_log] = 'stderr'
          php_admin_flag[log_errors] = on
          catch_workers_output = yes
          env[PATH] = ${makeBinPath rutorrent-deps}
        '';
      };
    };
  };
in
out