894f144cc9fdda4753e5e079bb6c88d4c3cfd855
[gnus] / lisp / sieve-manage.el
1 ;;; sieve-manage.el --- Implementation of the managesive protocol in elisp
2
3 ;; Copyright (C) 2001, 2002, 2003, 2004, 2005,
4 ;;   2006, 2007 Free Software Foundation, Inc.
5
6 ;; Author: Simon Josefsson <simon@josefsson.org>
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 3, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
24
25 ;;; Commentary:
26
27 ;; This library provides an elisp API for the managesieve network
28 ;; protocol.
29 ;;
30 ;; It uses the SASL library for authentication, which means it
31 ;; supports DIGEST-MD5, CRAM-MD5, SCRAM-MD5, NTLM, PLAIN and LOGIN
32 ;; methods.  STARTTLS is not well tested, but should be easy to get to
33 ;; work if someone wants.
34 ;;
35 ;; The API should be fairly obvious for anyone familiar with the
36 ;; managesieve protocol, interface functions include:
37 ;;
38 ;; `sieve-manage-open'
39 ;; open connection to managesieve server, returning a buffer to be
40 ;; used by all other API functions.
41 ;;
42 ;; `sieve-manage-opened'
43 ;; check if a server is open or not
44 ;;
45 ;; `sieve-manage-close'
46 ;; close a server connection.
47 ;;
48 ;; `sieve-manage-authenticate'
49 ;; `sieve-manage-listscripts'
50 ;; `sieve-manage-deletescript'
51 ;; `sieve-manage-getscript'
52 ;; performs managesieve protocol actions
53 ;;
54 ;; and that's it.  Example of a managesieve session in *scratch*:
55 ;;
56 ;; (setq my-buf (sieve-manage-open "my.server.com"))
57 ;; " *sieve* my.server.com:2000*"
58 ;;
59 ;; (sieve-manage-authenticate "myusername" "mypassword" my-buf)
60 ;; 'auth
61 ;;
62 ;; (sieve-manage-listscripts my-buf)
63 ;; ("vacation" "testscript" ("splitmail") "badscript")
64 ;;
65 ;; References:
66 ;;
67 ;; draft-martin-managesieve-02.txt,
68 ;; "A Protocol for Remotely Managing Sieve Scripts",
69 ;; by Tim Martin.
70 ;;
71 ;; Release history:
72 ;;
73 ;; 2001-10-31 Committed to Oort Gnus.
74 ;; 2002-07-27 Added DELETESCRIPT.  Suggested by Ned Ludd.
75 ;; 2002-08-03 Use SASL library.
76
77 ;;; Code:
78
79 ;; For Emacs < 22.2.
80 (eval-and-compile
81   (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
82
83 (if (featurep 'xemacs)
84     (or (load "password-cache" t)
85         ;; Not all XEmacs versions support `noerror' arg of `require'.
86         (require 'password))
87   (or (require 'password-cache nil t)
88       (require 'password)))
89
90 (eval-when-compile
91   (require 'sasl)
92   (require 'starttls))
93 (eval-and-compile
94   (autoload 'sasl-find-mechanism "sasl")
95   (autoload 'starttls-open-stream "starttls"))
96
97 ;; User customizable variables:
98
99 (defgroup sieve-manage nil
100   "Low-level Managesieve protocol issues."
101   :group 'mail
102   :prefix "sieve-")
103
104 (defcustom sieve-manage-log "*sieve-manage-log*"
105   "Name of buffer for managesieve session trace."
106   :type 'string
107   :group 'sieve-manage)
108
109 (defcustom sieve-manage-default-user (user-login-name)
110   "Default username to use."
111   :type 'string
112   :group 'sieve-manage)
113
114 (defcustom sieve-manage-server-eol "\r\n"
115   "The EOL string sent from the server."
116   :type 'string
117   :group 'sieve-manage)
118
119 (defcustom sieve-manage-client-eol "\r\n"
120   "The EOL string we send to the server."
121   :type 'string
122   :group 'sieve-manage)
123
124 (defcustom sieve-manage-streams '(network starttls shell)
125   "Priority of streams to consider when opening connection to server."
126   :group 'sieve-manage)
127
128 (defcustom sieve-manage-stream-alist
129   '((network   sieve-manage-network-p          sieve-manage-network-open)
130     (shell     sieve-manage-shell-p            sieve-manage-shell-open)
131     (starttls  sieve-manage-starttls-p         sieve-manage-starttls-open))
132   "Definition of network streams.
133
134 \(NAME CHECK OPEN)
135
136 NAME names the stream, CHECK is a function returning non-nil if the
137 server support the stream and OPEN is a function for opening the
138 stream."
139   :group 'sieve-manage)
140
141 (defcustom sieve-manage-authenticators '(digest-md5
142                                          cram-md5
143                                          scram-md5
144                                          ntlm
145                                          plain
146                                          login)
147   "Priority of authenticators to consider when authenticating to server."
148   :group 'sieve-manage)
149
150 (defcustom sieve-manage-authenticator-alist
151   '((cram-md5   sieve-manage-cram-md5-p       sieve-manage-cram-md5-auth)
152     (digest-md5 sieve-manage-digest-md5-p     sieve-manage-digest-md5-auth)
153     (scram-md5  sieve-manage-scram-md5-p      sieve-manage-scram-md5-auth)
154     (ntlm       sieve-manage-ntlm-p           sieve-manage-ntlm-auth)
155     (plain      sieve-manage-plain-p          sieve-manage-plain-auth)
156     (login      sieve-manage-login-p          sieve-manage-login-auth))
157   "Definition of authenticators.
158
159 \(NAME CHECK AUTHENTICATE)
160
161 NAME names the authenticator.  CHECK is a function returning non-nil if
162 the server support the authenticator and AUTHENTICATE is a function
163 for doing the actual authentication."
164   :group 'sieve-manage)
165
166 (defcustom sieve-manage-default-port 2000
167   "Default port number for managesieve protocol."
168   :type 'integer
169   :group 'sieve-manage)
170
171 ;; Internal variables:
172
173 (defconst sieve-manage-local-variables '(sieve-manage-server
174                                          sieve-manage-port
175                                          sieve-manage-auth
176                                          sieve-manage-stream
177                                          sieve-manage-username
178                                          sieve-manage-password
179                                          sieve-manage-process
180                                          sieve-manage-client-eol
181                                          sieve-manage-server-eol
182                                          sieve-manage-capability))
183 (defconst sieve-manage-default-stream 'network)
184 (defconst sieve-manage-coding-system-for-read 'binary)
185 (defconst sieve-manage-coding-system-for-write 'binary)
186 (defvar sieve-manage-stream nil)
187 (defvar sieve-manage-auth nil)
188 (defvar sieve-manage-server nil)
189 (defvar sieve-manage-port nil)
190 (defvar sieve-manage-username nil)
191 (defvar sieve-manage-password nil)
192 (defvar sieve-manage-state 'closed
193   "Managesieve state.
194 Valid states are `closed', `initial', `nonauth', and `auth'.")
195 (defvar sieve-manage-process nil)
196 (defvar sieve-manage-capability nil)
197
198 ;; Internal utility functions
199
200 (defsubst sieve-manage-disable-multibyte ()
201   "Enable multibyte in the current buffer."
202   (when (fboundp 'set-buffer-multibyte)
203     (set-buffer-multibyte nil)))
204
205 (declare-function password-read         "password-cache" (prompt &optional key))
206 (declare-function password-cache-add    "password-cache" (key password))
207 (declare-function password-cache-remove "password-cache" (key))
208
209 ;; Uses the dynamically bound `reason' variable.
210 (defvar reason)
211 (defun sieve-manage-interactive-login (buffer loginfunc)
212   "Login to server in BUFFER.
213 LOGINFUNC is passed a username and a password, it should return t if
214 it was successful authenticating itself to the server, nil otherwise.
215 Returns t if login was successful, nil otherwise."
216   (with-current-buffer buffer
217     (make-local-variable 'sieve-manage-username)
218     (make-local-variable 'sieve-manage-password)
219     (let (user passwd ret reason passwd-key)
220       (condition-case ()
221           (while (or (not user) (not passwd))
222             (setq user (or sieve-manage-username
223                            (read-from-minibuffer
224                             (concat "Managesieve username for "
225                                     sieve-manage-server ": ")
226                             (or user sieve-manage-default-user)))
227                   passwd-key (concat "managesieve:" user "@" sieve-manage-server
228                                      ":" sieve-manage-port)
229                   passwd (or sieve-manage-password
230                              (password-read (concat "Managesieve password for "
231                                                     user "@" sieve-manage-server
232                                                     ": ")
233                                             passwd-key)))
234             (when (y-or-n-p "Store password for this session? ")
235               (password-cache-add passwd-key (copy-sequence passwd)))
236             (when (and user passwd)
237               (if (funcall loginfunc user passwd)
238                   (setq ret t
239                         sieve-manage-username user)
240                 (if reason
241                     (message "Login failed (reason given: %s)..." reason)
242                   (message "Login failed..."))
243                 (password-cache-remove passwd-key)
244                 (setq sieve-manage-password nil)
245                 (setq passwd nil)
246                 (setq reason nil)
247                 (sit-for 1))))
248         (quit (with-current-buffer buffer
249                 (password-cache-remove passwd-key)
250                 (setq user nil
251                       passwd nil
252                       sieve-manage-password nil)))
253         (error (with-current-buffer buffer
254                  (password-cache-remove passwd-key)
255                  (setq user nil
256                        passwd nil
257                        sieve-manage-password nil))))
258       ret)))
259
260 (defun sieve-manage-erase (&optional p buffer)
261   (let ((buffer (or buffer (current-buffer))))
262     (and sieve-manage-log
263          (with-current-buffer (get-buffer-create sieve-manage-log)
264            (sieve-manage-disable-multibyte)
265            (buffer-disable-undo)
266            (goto-char (point-max))
267            (insert-buffer-substring buffer (with-current-buffer buffer
268                                              (point-min))
269                                     (or p (with-current-buffer buffer
270                                             (point-max)))))))
271   (delete-region (point-min) (or p (point-max))))
272
273 (defun sieve-manage-open-1 (buffer)
274   (with-current-buffer buffer
275     (sieve-manage-erase)
276     (setq sieve-manage-state 'initial
277           sieve-manage-process
278           (condition-case ()
279               (funcall (nth 2 (assq sieve-manage-stream
280                                     sieve-manage-stream-alist))
281                        "sieve" buffer sieve-manage-server sieve-manage-port)
282             ((error quit) nil)))
283     (when sieve-manage-process
284       (while (and (eq sieve-manage-state 'initial)
285                   (memq (process-status sieve-manage-process) '(open run)))
286         (message "Waiting for response from %s..." sieve-manage-server)
287         (accept-process-output sieve-manage-process 1))
288       (message "Waiting for response from %s...done" sieve-manage-server)
289       (and (memq (process-status sieve-manage-process) '(open run))
290            sieve-manage-process))))
291
292 ;; Streams
293
294 (defun sieve-manage-network-p (buffer)
295   t)
296
297 (defun sieve-manage-network-open (name buffer server port)
298   (let* ((port (or port sieve-manage-default-port))
299          (coding-system-for-read sieve-manage-coding-system-for-read)
300          (coding-system-for-write sieve-manage-coding-system-for-write)
301          (process (open-network-stream name buffer server port)))
302     (when process
303       (while (and (memq (process-status process) '(open run))
304                   (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
305                   (goto-char (point-min))
306                   (not (sieve-manage-parse-greeting-1)))
307         (accept-process-output process 1)
308         (sit-for 1))
309       (sieve-manage-erase nil buffer)
310       (when (memq (process-status process) '(open run))
311         process))))
312
313 (defun imap-starttls-p (buffer)
314   ;;  (and (imap-capability 'STARTTLS buffer)
315   (condition-case ()
316       (progn
317         (require 'starttls)
318         (call-process "starttls"))
319     (error nil)))
320
321 (defun imap-starttls-open (name buffer server port)
322   (let* ((port (or port sieve-manage-default-port))
323          (coding-system-for-read sieve-manage-coding-system-for-read)
324          (coding-system-for-write sieve-manage-coding-system-for-write)
325          (process (starttls-open-stream name buffer server port))
326          done)
327     (when process
328       (while (and (memq (process-status process) '(open run))
329                   (set-buffer buffer) ;; XXX "blue moon" nntp.el bug
330                   (goto-char (point-min))
331                   (not (sieve-manage-parse-greeting-1)))
332         (accept-process-output process 1)
333         (sit-for 1))
334       (sieve-manage-erase nil buffer)
335       (sieve-manage-send "STARTTLS")
336       (starttls-negotiate process))
337     (when (memq (process-status process) '(open run))
338       process)))
339
340 ;; Authenticators
341
342 (defun sieve-sasl-auth (buffer mech)
343   "Login to server using the SASL MECH method."
344   (message "sieve: Authenticating using %s..." mech)
345   (if (sieve-manage-interactive-login 
346        buffer
347        (lambda (user passwd)
348          (let (client step tag data rsp)
349            (setq client (sasl-make-client (sasl-find-mechanism (list mech))
350                                           user "sieve" sieve-manage-server))
351            (setq sasl-read-passphrase (function (lambda (prompt) passwd)))
352            (setq step (sasl-next-step client nil))
353            (setq tag
354                  (sieve-manage-send
355                   (concat
356                    "AUTHENTICATE \""
357                    mech
358                    "\""
359                    (and (sasl-step-data step)
360                         (concat
361                          " \""
362                          (base64-encode-string
363                           (sasl-step-data step)
364                           'no-line-break)
365                          "\"")))))
366            (catch 'done
367              (while t
368                (setq rsp nil)
369                (goto-char (point-min))
370                (while (null (or (progn
371                                   (setq rsp (sieve-manage-is-string))
372                                   (if (not (and rsp (looking-at
373                                                      sieve-manage-server-eol)))
374                                       (setq rsp nil)
375                                     (goto-char (match-end 0))
376                                     rsp))
377                                 (setq rsp (sieve-manage-is-okno))))
378                  (accept-process-output sieve-manage-process 1)
379                  (goto-char (point-min)))
380                (sieve-manage-erase)
381                (when (sieve-manage-ok-p rsp)
382                  (when (string-match "^SASL \"\\([^\"]+\\)\"" (cadr rsp))
383                    (sasl-step-set-data
384                     step (base64-decode-string (match-string 1 (cadr rsp)))))
385                  (if (and (setq step (sasl-next-step client step))
386                           (setq data (sasl-step-data step)))
387                      ;; We got data for server but it's finished
388                      (error "Server not ready for SASL data: %s" data)
389                    ;; The authentication process is finished.
390                    (throw 'done t)))
391                (unless (stringp rsp)
392                  (apply 'error "Server aborted SASL authentication: %s %s %s"
393                         rsp))
394                (sasl-step-set-data step (base64-decode-string rsp))
395                (setq step (sasl-next-step client step))
396                (sieve-manage-send
397                 (if (sasl-step-data step)
398                     (concat "\""
399                             (base64-encode-string (sasl-step-data step)
400                                                   'no-line-break)
401                             "\"")
402                   "")))))))
403       (message "sieve: Authenticating using %s...done" mech)
404     (message "sieve: Authenticating using %s...failed" mech)))
405
406 (defun sieve-manage-cram-md5-p (buffer)
407   (sieve-manage-capability "SASL" "CRAM-MD5" buffer))
408
409 (defun sieve-manage-cram-md5-auth (buffer)
410   "Login to managesieve server using the CRAM-MD5 SASL method."
411   (sieve-sasl-auth buffer "CRAM-MD5"))
412
413 (defun sieve-manage-digest-md5-p (buffer)
414   (sieve-manage-capability "SASL" "DIGEST-MD5" buffer))
415
416 (defun sieve-manage-digest-md5-auth (buffer)
417   "Login to managesieve server using the DIGEST-MD5 SASL method."
418   (sieve-sasl-auth buffer "DIGEST-MD5"))
419
420 (defun sieve-manage-scram-md5-p (buffer)
421   (sieve-manage-capability "SASL" "SCRAM-MD5" buffer))
422
423 (defun sieve-manage-scram-md5-auth (buffer)
424   "Login to managesieve server using the SCRAM-MD5 SASL method."
425   (sieve-sasl-auth buffer "SCRAM-MD5"))
426
427 (defun sieve-manage-ntlm-p (buffer)
428   (sieve-manage-capability "SASL" "NTLM" buffer))
429
430 (defun sieve-manage-ntlm-auth (buffer)
431   "Login to managesieve server using the NTLM SASL method."
432   (sieve-sasl-auth buffer "NTLM"))
433
434 (defun sieve-manage-plain-p (buffer)
435   (sieve-manage-capability "SASL" "PLAIN" buffer))
436
437 (defun sieve-manage-plain-auth (buffer)
438   "Login to managesieve server using the PLAIN SASL method."
439   (sieve-sasl-auth buffer "PLAIN"))
440
441 (defun sieve-manage-login-p (buffer)
442   (sieve-manage-capability "SASL" "LOGIN" buffer))
443
444 (defun sieve-manage-login-auth (buffer)
445   "Login to managesieve server using the LOGIN SASL method."
446   (sieve-sasl-auth buffer "LOGIN"))
447
448 ;; Managesieve API
449
450 (defun sieve-manage-open (server &optional port stream auth buffer)
451   "Open a network connection to a managesieve SERVER (string).
452 Optional variable PORT is port number (integer) on remote server.
453 Optional variable STREAM is any of `sieve-manage-streams' (a symbol).
454 Optional variable AUTH indicates authenticator to use, see
455 `sieve-manage-authenticators' for available authenticators.  If nil, chooses
456 the best stream the server is capable of.
457 Optional variable BUFFER is buffer (buffer, or string naming buffer)
458 to work in."
459   (setq buffer (or buffer (format " *sieve* %s:%d" server (or port 2000))))
460   (with-current-buffer (get-buffer-create buffer)
461     (mapc 'make-local-variable sieve-manage-local-variables)
462     (sieve-manage-disable-multibyte)
463     (buffer-disable-undo)
464     (setq sieve-manage-server (or server sieve-manage-server))
465     (setq sieve-manage-port (or port sieve-manage-port))
466     (setq sieve-manage-stream (or stream sieve-manage-stream))
467     (message "sieve: Connecting to %s..." sieve-manage-server)
468     (if (let ((sieve-manage-stream
469                (or sieve-manage-stream sieve-manage-default-stream)))
470           (sieve-manage-open-1 buffer))
471         ;; Choose stream.
472         (let (stream-changed)
473           (message "sieve: Connecting to %s...done" sieve-manage-server)
474           (when (null sieve-manage-stream)
475             (let ((streams sieve-manage-streams))
476               (while (setq stream (pop streams))
477                 (if (funcall (nth 1 (assq stream
478                                           sieve-manage-stream-alist)) buffer)
479                     (setq stream-changed
480                           (not (eq (or sieve-manage-stream
481                                        sieve-manage-default-stream)
482                                    stream))
483                           sieve-manage-stream stream
484                           streams nil)))
485               (unless sieve-manage-stream
486                 (error "Couldn't figure out a stream for server"))))
487           (when stream-changed
488             (message "sieve: Reconnecting with stream `%s'..."
489                      sieve-manage-stream)
490             (sieve-manage-close buffer)
491             (if (sieve-manage-open-1 buffer)
492                 (message "sieve: Reconnecting with stream `%s'...done"
493                          sieve-manage-stream)
494               (message "sieve: Reconnecting with stream `%s'...failed"
495                        sieve-manage-stream))
496             (setq sieve-manage-capability nil))
497           (if (sieve-manage-opened buffer)
498               ;; Choose authenticator
499               (when (and (null sieve-manage-auth)
500                          (not (eq sieve-manage-state 'auth)))
501                 (let ((auths sieve-manage-authenticators))
502                   (while (setq auth (pop auths))
503                     (if (funcall (nth 1 (assq
504                                          auth
505                                          sieve-manage-authenticator-alist))
506                                  buffer)
507                         (setq sieve-manage-auth auth
508                               auths nil)))
509                   (unless sieve-manage-auth
510                     (error "Couldn't figure out authenticator for server"))))))
511       (message "sieve: Connecting to %s...failed" sieve-manage-server))
512     (when (sieve-manage-opened buffer)
513       (sieve-manage-erase)
514       buffer)))
515
516 (defun sieve-manage-opened (&optional buffer)
517   "Return non-nil if connection to managesieve server in BUFFER is open.
518 If BUFFER is nil then the current buffer is used."
519   (and (setq buffer (get-buffer (or buffer (current-buffer))))
520        (buffer-live-p buffer)
521        (with-current-buffer buffer
522          (and sieve-manage-process
523               (memq (process-status sieve-manage-process) '(open run))))))
524
525 (defun sieve-manage-close (&optional buffer)
526   "Close connection to managesieve server in BUFFER.
527 If BUFFER is nil, the current buffer is used."
528   (with-current-buffer (or buffer (current-buffer))
529     (when (sieve-manage-opened)
530       (sieve-manage-send "LOGOUT")
531       (sit-for 1))
532     (when (and sieve-manage-process
533                (memq (process-status sieve-manage-process) '(open run)))
534       (delete-process sieve-manage-process))
535     (setq sieve-manage-process nil)
536     (sieve-manage-erase)
537     t))
538
539 (defun sieve-manage-authenticate (&optional user passwd buffer)
540   "Authenticate to server in BUFFER, using current buffer if nil.
541 It uses the authenticator specified when opening the server.  If the
542 authenticator requires username/passwords, they are queried from the
543 user and optionally stored in the buffer.  If USER and/or PASSWD is
544 specified, the user will not be questioned and the username and/or
545 password is remembered in the buffer."
546   (with-current-buffer (or buffer (current-buffer))
547     (if (not (eq sieve-manage-state 'nonauth))
548         (eq sieve-manage-state 'auth)
549       (make-local-variable 'sieve-manage-username)
550       (make-local-variable 'sieve-manage-password)
551       (if user (setq sieve-manage-username user))
552       (if passwd (setq sieve-manage-password passwd))
553       (if (funcall (nth 2 (assq sieve-manage-auth
554                                 sieve-manage-authenticator-alist)) buffer)
555           (setq sieve-manage-state 'auth)))))
556
557 (defun sieve-manage-capability (&optional name value buffer)
558   (with-current-buffer (or buffer (current-buffer))
559     (if (null name)
560         sieve-manage-capability
561       (if (null value)
562           (nth 1 (assoc name sieve-manage-capability))
563         (when (string-match value (nth 1 (assoc name sieve-manage-capability)))
564           (nth 1 (assoc name sieve-manage-capability)))))))
565
566 (defun sieve-manage-listscripts (&optional buffer)
567   (with-current-buffer (or buffer (current-buffer))
568     (sieve-manage-send "LISTSCRIPTS")
569     (sieve-manage-parse-listscripts)))
570
571 (defun sieve-manage-havespace (name size &optional buffer)
572   (with-current-buffer (or buffer (current-buffer))
573     (sieve-manage-send (format "HAVESPACE \"%s\" %s" name size))
574     (sieve-manage-parse-okno)))
575
576 (eval-and-compile
577   (if (fboundp 'string-bytes)
578       (defalias 'sieve-string-bytes 'string-bytes)
579     (defalias 'sieve-string-bytes 'length)))
580
581 (defun sieve-manage-putscript (name content &optional buffer)
582   (with-current-buffer (or buffer (current-buffer))
583     (sieve-manage-send (format "PUTSCRIPT \"%s\" {%d+}%s%s" name
584                                (sieve-string-bytes content)
585                                sieve-manage-client-eol content))
586     (sieve-manage-parse-okno)))
587
588 (defun sieve-manage-deletescript (name &optional buffer)
589   (with-current-buffer (or buffer (current-buffer))
590     (sieve-manage-send (format "DELETESCRIPT \"%s\"" name))
591     (sieve-manage-parse-okno)))
592
593 (defun sieve-manage-getscript (name output-buffer &optional buffer)
594   (with-current-buffer (or buffer (current-buffer))
595     (sieve-manage-send (format "GETSCRIPT \"%s\"" name))
596     (let ((script (sieve-manage-parse-string)))
597       (sieve-manage-parse-crlf)
598       (with-current-buffer output-buffer
599         (insert script))
600       (sieve-manage-parse-okno))))
601
602 (defun sieve-manage-setactive (name &optional buffer)
603   (with-current-buffer (or buffer (current-buffer))
604     (sieve-manage-send (format "SETACTIVE \"%s\"" name))
605     (sieve-manage-parse-okno)))
606
607 ;; Protocol parsing routines
608
609 (defun sieve-manage-ok-p (rsp)
610   (string= (downcase (or (car-safe rsp) "")) "ok"))
611
612 (defsubst sieve-manage-forward ()
613   (or (eobp) (forward-char)))
614
615 (defun sieve-manage-is-okno ()
616   (when (looking-at (concat
617                      "^\\(OK\\|NO\\)\\( (\\([^)]+\\))\\)?\\( \\(.*\\)\\)?"
618                      sieve-manage-server-eol))
619     (let ((status (match-string 1))
620           (resp-code (match-string 3))
621           (response (match-string 5)))
622       (when response
623         (goto-char (match-beginning 5))
624         (setq response (sieve-manage-is-string)))
625       (list status resp-code response))))
626
627 (defun sieve-manage-parse-okno ()
628   (let (rsp)
629     (while (null rsp)
630       (accept-process-output (get-buffer-process (current-buffer)) 1)
631       (goto-char (point-min))
632       (setq rsp (sieve-manage-is-okno)))
633     (sieve-manage-erase)
634     rsp))
635
636 (defun sieve-manage-parse-capability-1 ()
637   "Accept a managesieve greeting."
638   (let (str)
639     (while (setq str (sieve-manage-is-string))
640       (if (eq (char-after) ? )
641           (progn
642             (sieve-manage-forward)
643             (push (list str (sieve-manage-is-string))
644                   sieve-manage-capability))
645         (push (list str) sieve-manage-capability))
646       (forward-line)))
647   (when (re-search-forward (concat "^OK" sieve-manage-server-eol) nil t)
648     (setq sieve-manage-state 'nonauth)))
649
650 (defalias 'sieve-manage-parse-greeting-1 'sieve-manage-parse-capability-1)
651
652 (defun sieve-manage-is-string ()
653   (cond ((looking-at "\"\\([^\"]+\\)\"")
654          (prog1
655              (match-string 1)
656            (goto-char (match-end 0))))
657         ((looking-at (concat "{\\([0-9]+\\)}" sieve-manage-server-eol))
658          (let ((pos (match-end 0))
659                (len (string-to-number (match-string 1))))
660            (if (< (point-max) (+ pos len))
661                nil
662              (goto-char (+ pos len))
663              (buffer-substring pos (+ pos len)))))))
664
665 (defun sieve-manage-parse-string ()
666   (let (rsp)
667     (while (null rsp)
668       (accept-process-output (get-buffer-process (current-buffer)) 1)
669       (goto-char (point-min))
670       (setq rsp (sieve-manage-is-string)))
671     (sieve-manage-erase (point))
672     rsp))
673
674 (defun sieve-manage-parse-crlf ()
675   (when (looking-at sieve-manage-server-eol)
676     (sieve-manage-erase (match-end 0))))
677
678 (defun sieve-manage-parse-listscripts ()
679   (let (tmp rsp data)
680     (while (null rsp)
681       (while (null (or (setq rsp (sieve-manage-is-okno))
682                        (setq tmp (sieve-manage-is-string))))
683         (accept-process-output (get-buffer-process (current-buffer)) 1)
684         (goto-char (point-min)))
685       (when tmp
686         (while (not (looking-at (concat "\\( ACTIVE\\)?"
687                                         sieve-manage-server-eol)))
688           (accept-process-output (get-buffer-process (current-buffer)) 1)
689           (goto-char (point-min)))
690         (if (match-string 1)
691             (push (cons 'active tmp) data)
692           (push tmp data))
693         (goto-char (match-end 0))
694         (setq tmp nil)))
695     (sieve-manage-erase)
696     (if (sieve-manage-ok-p rsp)
697         data
698       rsp)))
699
700 (defun sieve-manage-send (cmdstr)
701   (setq cmdstr (concat cmdstr sieve-manage-client-eol))
702   (and sieve-manage-log
703        (with-current-buffer (get-buffer-create sieve-manage-log)
704          (sieve-manage-disable-multibyte)
705          (buffer-disable-undo)
706          (goto-char (point-max))
707          (insert cmdstr)))
708   (process-send-string sieve-manage-process cmdstr))
709
710 (provide 'sieve-manage)
711
712 ;;; arch-tag: 321c4640-1371-4495-9baf-8ccb71dd5bd1
713 ;; sieve-manage.el ends here