summaryrefslogtreecommitdiffstats
path: root/modules/tv/urlwatch/default.nix
blob: 87ec289f7136670634375e1c1e5c0550a1103859 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
{ config, lib, pkgs, ... }:

# TODO multiple users
# TODO inform about unused caches
# cache = url: "${cfg.dataDir}/.urlwatch/cache/${hashString "sha1" url}"
# TODO hooks.py

let
  inherit (builtins) toFile;
  inherit (lib)
    concatStringsSep escapeShellArg mkIf mkOption optionals singleton types;
  inherit (pkgs) writeScript;

  cfg = config.tv.urlwatch;

  api = {
    dataDir = mkOption {
      type = types.str;
      default = "/var/lib/urlwatch";
      description = ''
        Directory where the urlwatch service should store its state.
      '';
    };
    enable = mkOption {
      type = types.bool;
      default = false;
      description = ''
        Whether to enable the urlwatch service.
        If enabled, then create a timer that calls urlwatch and sends mails
        whenever something has changed or an error occurs.
      '';
    };
    from = mkOption {
      type = types.str;
      default = "${cfg.user}@${config.networking.hostName}.retiolum";
      description = ''
        Content of the From: header of the generated mails.
      '';
    };
    mailto = mkOption {
      type = types.str;
      description = ''
        Content of the To: header of the generated mails. [AKA recipient :)]
      '';
    };
    onCalendar = mkOption {
      type = types.str;
      description = ''
        Run urlwatch at this interval.
        The format is described in systemd.time(7), CALENDAR EVENTS.
      '';
      example = "04:23";
    };
    urls = mkOption {
      type = with types; listOf str;
      description = "URL to watch.";
      example = [
        https://nixos.org/channels/nixos-unstable/git-revision
      ];
    };
    user = mkOption {
      type = types.str;
      default = "urlwatch";
      description = "User under which urlwatch runs.";
    };
  };

  urlsFile = toFile "urls" (concatStringsSep "\n" cfg.urls);

  impl = {
    systemd.timers.urlwatch = {
      wantedBy = [ "timers.target" ];
      timerConfig = {
        OnCalendar = cfg.onCalendar;
        Persistent = "true";
      };
    };
    systemd.services.urlwatch = {
      path = with pkgs; [
        coreutils
        gnused
        urlwatch
      ];
      environment = {
        HOME = cfg.dataDir;
        LC_ALL = "en_US.UTF-8";
        LOCALE_ARCHIVE = "${pkgs.glibcLocales}/lib/locale/locale-archive";
        SSL_CERT_FILE = "${pkgs.cacert}/etc/ssl/certs/ca-bundle.crt";
      };
      serviceConfig = {
        User = cfg.user;
        PermissionsStartOnly = "true";
        PrivateTmp = "true";
        Type = "oneshot";
        ExecStartPre =
          writeScript "urlwatch-prestart" ''
            #! /bin/sh
            set -euf

            dataDir=$HOME
            user=${escapeShellArg cfg.user}

            if ! test -e "$dataDir"; then
              mkdir -m 0700 -p "$dataDir"
              chown "$user": "$dataDir"
            fi
          '';
        ExecStart = writeScript "urlwatch" ''
          #! /bin/sh
          set -euf

          from=${escapeShellArg cfg.from}
          mailto=${escapeShellArg cfg.mailto}
          urlsFile=${escapeShellArg urlsFile}
          user=${escapeShellArg cfg.user}

          cd /tmp

          urlwatch -e --urls="$urlsFile" > changes 2>&1 || :

          if test -s changes; then
            date=$(date -R)
            subject=$(sed -n 's/^\(CHANGED\|ERROR\|NEW\): //p' changes \
              | tr \\n \ )
            {
              echo "Date: $date"
              echo "From: $from"
              echo "Subject: $subject"
              echo "To: $mailto"
              echo
              cat changes
            } | /var/setuid-wrappers/sendmail -t
          fi
        '';
      };
    };
    users.extraUsers = optionals (cfg.user == "urlwatch") (singleton {
      name = "urlwatch";
      uid = 3450919516; # bin/genid urlwatch
    });
  };

in

{
  # TODO
  #imports = [
  #  ./exim
  #];
  #config = mkIf cfg.enable
  #  (if config.tv.exim.enable
  #    then impl
  #    else throw "tv.exim must be enabled when enabling tv.urlwatch");

  options.tv.urlwatch = api;
  
  config = impl;
}