summaryrefslogtreecommitdiff
path: root/brisket.hy
blob: e18732a08805753e33f715e6982af8c8593f6d6b (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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
#!/usr/bin/env hy

;; Copyright (C) 2019 Jakob L. Kreuze
;;
;; This program is free software: you can redistribute it and/or modify it under
;; the terms of the GNU General Public License as published by the Free Software
;; Foundation, either version 3 of the License, or (at your option) any later
;; version.
;;
;; This program is distributed in the hope that it will be useful, but WITHOUT
;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
;; FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
;; details.
;;
;; You should have received a copy of the GNU General Public License along with
;; this program. If not, see <http://www.gnu.org/licenses/>.

"brisket.hy: Script for interacting with NNTP servers."

(setv __author__ "Jakob L. Kreuze")
(setv __copyright__ "Copyright (C) 2019 Jakob L. Kreuze")
(setv __license__ "GPL")
(setv __version__ "0.1.0: Kansas City-style")

(import [configparser [ConfigParser]])
(import [os [getenv makedirs]])
(import [os.path [dirname expanduser]])
(import [sys [argv exit stderr]])
(import [re [match]])
(import [nntplib [NNTP-SSL]])
(import [subprocess [Popen PIPE]])

(require [hy.contrib.walk [let]])

(setv *auth-source* (expanduser "~/.authinfo.gpg"))
(setv *config-path* (expanduser "~/.config/brisket/config.ini"))
(setv *recognized-commands* ["describe-group"
                             "help"
                             "list-groups"
                             "list-posts"
                             "version"])

(defn help [&rest args]
  "Display the documentation for a command to stdout.

usage: help [command]"
  (unless (= (len args) 1)
    (err (.format "usage: help [command]"))
    (return))

  (let [command (first args)]
    (unless (in command *recognized-commands*)
      (err (.format "unrecognized command: {}" command))
      (exit 1))

    (let [handler (get (globals) (.replace command "-" "_"))]
      (print (. handler __doc__)))))

(defn version [&rest args]
  "Display the version of Brisket the user is currently running.

usage: version"
  (print (.format "brisket version {}
 ________
< Uhm... >
 --------
        \   ^__^
         \  (oo)\\_______
            (__)\\       )\\/\\
                ||----w |
                ||     ||" __version__)))

(defn list-groups [session &rest args]
  "List groups on the server, matching a pattern if one is given.

usage: list-groups [pattern (optional)]"
  (let [pattern (if (>= (len args) 1) (nth args 0))
        groups (second (.list session))]
    (for [group groups]
      (if (or (is pattern None) (match pattern group.group))
          (print group.group)))))

(defn describe-group [session &rest args]
  "Describe the first group matching the pattern.

usage: describe-groups [pattern]"
  (when (< (len args) 1)
    (err "usage: describe-group [group]")
    (return))
  (let [group-name (first args)
        description (.description session group-name)]
    (if (= (len description) 0)
        (err "ERROR: Group does not have a description.")
        (print description))))

(defn list-posts [session &rest args]
  "List posts in the given group.

usage: describe-group [group]"
  (when (< (len args) 1)
    (err "usage: describe-group [group]")
    (return))
  (let [res (.group session (first args))
        first-post (nth res 2)
        last-post (nth res 3)
        overviews (second (.over session [first-post last-post]))]
    (for [[article-id overview] overviews]
      (print (.format "{}: {} by {} on {}"
                      article-id
                      (.get overview "subject")
                      (.get overview "from")
                      (.get overview "date"))))))

(defn make-config []
  "Create a default configuration file.

Creates the configuration directory if it does not exist, as well as an INI file
populated with default configuration values."
  (let [config (ConfigParser)]
    (assoc config "Server" {})
    (assoc (get config "Server") "Host" "news.eternal-september.org")
    (makedirs (dirname *config-path*))
    (with [out (open *config-path* "w+")]
      (.write config out))
    config))

(defn load-config []
  "Load the configuration file for Brisket.

Returns a default configuration, written to `*config-path*`, if a configuration
file cannot be found."
  (let [config (ConfigParser)]
    (if (= 1 (len (.read config *config-path*)))
        config
        (make-config))))

(defn find-host [config]
  "Returns the host that Brisket should connect to.

The lookup order is:
  - NNTPSERVER environment variable.
  - 'Host' in the 'Server' section of the configuration file."
  (or (getenv "NNTPSERVER")
      (if (and (in "Server" config)
               (in "Host" (get config "Server")))
          (get (get config "Server") "Host"))))

(defn get-user-info [host]
  "Decode *auth-source* and return the line containing HOST."
  (let [process (Popen ["gpg" "-q" "-d" *auth-source*] :stdout PIPE)
        output (.decode (first (.communicate process)))]
    (for [line (.split output "\n")]
      (when (.startswith line (.format "machine {}" host))
        (return line)))))

(defn get-username [host]
  "Return the username for HOST as specified by *auth-source*."
  (let [info (get-user-info host)
        start-index (.find info "login")]
    (unless (= -1 start-index)
      (let [sliced (.split (.join "" (drop start-index info)))]
        (if (> (len sliced) 1)
            (.strip (nth sliced 1) "\""))))))

(defn get-password [host]
  "Return the password for HOST as specified by *auth-source*."
  (let [info (get-user-info host)
        start-index (.find info "password")]
    (unless (= -1 start-index)
      (let [sliced (.split (.join "" (drop start-index info)))]
        (if (> (len sliced) 1)
            (.strip (nth sliced 1) "\""))))))

(defn err [&rest args]
  "Displays ARGS to stderr."
  (.write stderr (+ (first args) "\n") #* (rest args)))

(when (= __name__ "__main__")
  (unless (>= (len argv) 2)
    (err (.format "usage: {} [command] [args]" (first argv)))
    (err "recognized commands:")
    (for [command *recognized-commands*]
      (err (.format "  - {}" command)))
    (exit 1))

  (let [config (load-config)
        host (find-host config)
        command (nth argv 1)]
    (when (is host None)
      (err (.format "no host specified"))
      (exit 1))

    (unless (in command *recognized-commands*)
      (err (.format "unrecognized command: {}" command))
      (exit 1))

    ;; Special case for 'help' and 'version', as the commands doesn't require a
    ;; connection to the NNTP server.
    (cond [(= command "help") (help #* (drop 2 argv))]
          [(= command "version") (version #* (drop 2 argv))]
          [True (let [user (get-username host)
                      password (get-password host)]
                  (with [session (NNTP_SSL host :user user :password password)]
                    ;; Otherwise, pull the function out of the global namespace.
                    (let [handler (get (globals) (.replace command "-" "_"))]
                      (handler session #* (drop 2 argv)))))])))