1 ;;; sieve.el --- Utilities to manage sieve scripts
3 ;; Copyright (C) 2001-2013 Free Software Foundation, Inc.
5 ;; Author: Simon Josefsson <simon@josefsson.org>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software: you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation, either version 3 of the License, or
12 ;; (at your option) any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;; This file contain utilities to facilitate upload, download and
25 ;; general management of sieve scripts. Currently only the
26 ;; Managesieve protocol is supported (using sieve-manage.el), but when
27 ;; (useful) alternatives become available, they might be supported as
30 ;; The cursor navigation was inspired by biff-mode by Franklin Lee.
34 ;; 2001-10-31 Committed to Oort Gnus.
35 ;; 2002-07-27 Fix down-mouse-2 and down-mouse-3 in manage-mode. Fix menubar
36 ;; in manage-mode. Change some messages. Added sieve-deactivate*,
37 ;; sieve-remove. Fixed help text in manage-mode. Suggested by
42 ;; * Namespace? This file contains `sieve-manage' and
43 ;; `sieve-manage-mode', but there is a sieve-manage.el file as well.
44 ;; Can't think of a good solution though, this file need a *-mode,
45 ;; and naming it `sieve-mode' would collide with sieve-mode.el. One
46 ;; solution would be to come up with some better name that this file
47 ;; can use that doesn't have the managesieve specific "manage" in
48 ;; it. sieve-dired? i dunno. we could copy all off sieve.el into
49 ;; sieve-manage.el too, but I'd like to separate the interface from
50 ;; the protocol implementation since the backends are likely to
53 ;; * Define servers? We could have a customize buffer to create a server,
54 ;; with authentication/stream/etc parameters, much like Gnus, and then
55 ;; only use names of defined servers when interacting with M-x sieve-*.
56 ;; Right now you can't use STARTTLS, which sieve-manage.el provides
60 (require 'sieve-manage)
63 ;; User customizable variables:
66 "Manage sieve scripts."
70 (defcustom sieve-new-script "<new script>"
71 "Name of name script indicator."
75 (defcustom sieve-buffer "*sieve*"
76 "Name of sieve management buffer."
80 (defcustom sieve-template "\
83 # Example script (remove comment character '#' to make it effective!):
85 # if header :contains \"from\" \"coyote\" {
87 # } elsif header :contains [\"subject\"] [\"$$$\"] {
93 "Template sieve script."
97 ;; Internal variables:
99 (defvar sieve-manage-buffer nil)
100 (defvar sieve-buffer-header-end nil)
101 (defvar sieve-buffer-script-name nil
102 "The real script name of the buffer.")
103 (make-local-variable 'sieve-buffer-script-name)
105 ;; Sieve-manage mode:
107 (defvar sieve-manage-mode-map
108 (let ((map (make-sparse-keymap)))
110 (define-key map "?" 'sieve-help)
111 (define-key map "h" 'sieve-help)
113 (define-key map "m" 'sieve-activate)
114 (define-key map "u" 'sieve-deactivate)
115 (define-key map "\M-\C-?" 'sieve-deactivate-all)
117 (define-key map "\C-p" 'sieve-prev-line)
118 (define-key map [up] 'sieve-prev-line)
119 (define-key map "\C-n" 'sieve-next-line)
120 (define-key map [down] 'sieve-next-line)
121 (define-key map " " 'sieve-next-line)
122 (define-key map "n" 'sieve-next-line)
123 (define-key map "p" 'sieve-prev-line)
124 (define-key map "\C-m" 'sieve-edit-script)
125 (define-key map "f" 'sieve-edit-script)
126 (define-key map "o" 'sieve-edit-script-other-window)
127 (define-key map "r" 'sieve-remove)
128 (define-key map "q" 'sieve-manage-quit)
129 (define-key map [(down-mouse-2)] 'sieve-edit-script)
130 (define-key map [(down-mouse-3)] 'sieve-manage-mode-menu)
132 "Keymap for `sieve-manage-mode'.")
134 (easy-menu-define sieve-manage-mode-menu sieve-manage-mode-map
137 ["Edit script" sieve-edit-script t]
138 ["Activate script" sieve-activate t]
139 ["Deactivate script" sieve-deactivate t]))
141 (define-derived-mode sieve-manage-mode fundamental-mode "Sieve-manage"
142 "Mode used for sieve script management."
143 (buffer-disable-undo (current-buffer))
144 (setq truncate-lines t)
145 (easy-menu-add sieve-manage-mode-menu sieve-manage-mode-map))
147 (put 'sieve-manage-mode 'mode-class 'special)
149 ;; Commands used in sieve-manage mode:
151 (defun sieve-manage-quit ()
154 (sieve-manage-close sieve-manage-buffer)
155 (kill-buffer sieve-manage-buffer)
156 (kill-buffer (current-buffer)))
158 (defun sieve-activate (&optional pos)
160 (let ((name (sieve-script-at-point)) err)
161 (when (or (null name) (string-equal name sieve-new-script))
162 (error "No sieve script at point"))
163 (message "Activating script %s..." name)
164 (setq err (sieve-manage-setactive name sieve-manage-buffer))
165 (sieve-refresh-scriptlist)
166 (if (sieve-manage-ok-p err)
167 (message "Activating script %s...done" name)
168 (message "Activating script %s...failed: %s" name (nth 2 err)))))
170 (defun sieve-deactivate-all (&optional pos)
172 (let ((name (sieve-script-at-point)) err)
173 (message "Deactivating scripts...")
174 (setq err (sieve-manage-setactive "" sieve-manage-buffer))
175 (sieve-refresh-scriptlist)
176 (if (sieve-manage-ok-p err)
177 (message "Deactivating scripts...done")
178 (message "Deactivating scripts...failed: %s" (nth 2 err)))))
180 (defalias 'sieve-deactivate 'sieve-deactivate-all)
182 (defun sieve-remove (&optional pos)
184 (let ((name (sieve-script-at-point)) err)
185 (when (or (null name) (string-equal name sieve-new-script))
186 (error "No sieve script at point"))
187 (message "Removing sieve script %s..." name)
188 (setq err (sieve-manage-deletescript name sieve-manage-buffer))
189 (unless (sieve-manage-ok-p err)
190 (error "Removing sieve script %s...failed: " err))
191 (sieve-refresh-scriptlist)
192 (message "Removing sieve script %s...done" name)))
194 (defun sieve-edit-script (&optional pos)
196 (let ((name (sieve-script-at-point)))
198 (error "No sieve script at point"))
199 (if (not (string-equal name sieve-new-script))
200 (let ((newbuf (generate-new-buffer name))
202 (setq err (sieve-manage-getscript name newbuf sieve-manage-buffer))
203 (switch-to-buffer newbuf)
204 (unless (sieve-manage-ok-p err)
205 (error "Sieve download failed: %s" err)))
206 (switch-to-buffer (get-buffer-create "template.siv"))
207 (insert sieve-template))
209 (setq sieve-buffer-script-name name)
210 (beginning-of-buffer)
212 (substitute-command-keys
213 "Press \\[sieve-upload] to upload script to server."))))
215 (defmacro sieve-change-region (&rest body)
216 "Turns off sieve-region before executing BODY, then re-enables it after.
217 Used to bracket operations which move point in the sieve-buffer."
219 (sieve-highlight nil)
221 (sieve-highlight t)))
222 (put 'sieve-change-region 'lisp-indent-function 0)
224 (defun sieve-next-line (&optional arg)
230 (sieve-script-at-point))
233 (message "End of list")))
235 (defun sieve-prev-line (&optional arg)
241 (sieve-script-at-point))
244 (message "Beginning of list")))
247 "Display help for various sieve commands."
249 (if (eq last-command 'sieve-help)
250 ;; would need minor-mode for log-edit-mode
251 (describe-function 'sieve-mode)
252 (message "%s" (substitute-command-keys
253 "`\\[sieve-edit-script]':edit `\\[sieve-activate]':activate `\\[sieve-deactivate]':deactivate `\\[sieve-remove]':remove"))))
257 (defun sieve-setup-buffer (server port)
258 (setq buffer-read-only nil)
260 (buffer-disable-undo)
261 (let* ((port (or port sieve-manage-default-port))
262 (header (format "Server : %s:%s\n\n" server port)))
264 (set (make-local-variable 'sieve-buffer-header-end)
267 (defun sieve-script-at-point (&optional pos)
268 "Return name of sieve script at point POS, or nil."
270 (get-char-property (or pos (point)) 'script-name))
273 (defalias 'sieve-make-overlay (if (featurep 'xemacs)
276 (defalias 'sieve-overlay-put (if (featurep 'xemacs)
279 (defalias 'sieve-overlays-at (if (featurep 'xemacs)
283 (defun sieve-highlight (on)
284 "Turn ON or off highlighting on the current language overlay."
285 (sieve-overlay-put (car (sieve-overlays-at (point)))
286 'face (if on 'highlight 'default)))
288 (defun sieve-insert-scripts (scripts)
289 "Format and insert LANGUAGE-LIST strings into current buffer at point."
293 (script (pop scripts)))
295 (insert (format " ACTIVE %s" (cdr script)))
296 (insert (format " %s" script)))
297 (setq ext (sieve-make-overlay p (point)))
298 (sieve-overlay-put ext 'mouse-face 'highlight)
299 (sieve-overlay-put ext 'script-name (if (consp script)
304 (defun sieve-open-server (server &optional port)
305 "Open SERVER (on PORT) and authenticate."
308 (set (make-local-variable 'sieve-manage-buffer)
309 (sieve-manage-open server port))
310 (error "Error opening server %s" server))
311 (sieve-manage-authenticate)))
313 (defun sieve-refresh-scriptlist ()
315 (with-current-buffer sieve-buffer
316 (setq buffer-read-only nil)
317 (delete-region (or sieve-buffer-header-end (point-max)) (point-max))
318 (goto-char (point-max))
319 ;; get list of script names and print them
320 (let ((scripts (sieve-manage-listscripts sieve-manage-buffer)))
323 (substitute-command-keys
325 "No scripts on server, press \\[sieve-edit-script] on %s to create a new script.\n"
328 (substitute-command-keys
329 (format (concat "%d script%s on server, press \\[sieve-edit-script] on a script "
330 "name edits it, or\npress \\[sieve-edit-script] on %s to create "
331 "a new script.\n") (length scripts)
332 (if (eq (length scripts) 1) "" "s")
335 (sieve-insert-scripts (list sieve-new-script))
336 (sieve-insert-scripts scripts)))
338 (setq buffer-read-only t)))
341 (defun sieve-manage (server &optional port)
342 (interactive "sServer: ")
343 (switch-to-buffer (get-buffer-create sieve-buffer))
345 (sieve-setup-buffer server port)
346 (if (sieve-open-server server port)
347 (sieve-refresh-scriptlist)
348 (message "Could not open server %s" server)))
351 (defun sieve-upload (&optional name)
353 (when (or (get-buffer sieve-buffer) (call-interactively 'sieve-manage))
354 (let ((script (buffer-string)) err)
355 (with-current-buffer (get-buffer sieve-buffer)
356 (setq err (sieve-manage-putscript
357 (or name sieve-buffer-script-name (buffer-name))
358 script sieve-manage-buffer))
359 (if (sieve-manage-ok-p err)
360 (message (substitute-command-keys
361 "Sieve upload done. Use \\[sieve-manage] to manage scripts."))
362 (message "Sieve upload failed: %s" (nth 2 err)))))))
365 (defun sieve-upload-and-bury (&optional name)
371 (defun sieve-upload-and-kill (&optional name)
378 ;; sieve.el ends here