Importing gnus-5.6.5
[elisp/gnus.git-] / lisp / gnus-kill.el
1 ;;; gnus-kill.el --- kill commands for Gnus
2 ;; Copyright (C) 1995,96,97,98 Free Software Foundation, Inc.
3
4 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
5 ;;      Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
6 ;; Keywords: news
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 2, 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., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26
27 ;;; Code:
28
29 (eval-when-compile (require 'cl))
30
31 (require 'gnus)
32 (require 'gnus-art)
33 (require 'gnus-range)
34
35 (defcustom gnus-kill-file-mode-hook nil
36   "Hook for Gnus kill file mode."
37   :group 'gnus-score-kill
38   :type 'hook)
39
40 (defcustom gnus-kill-expiry-days 7
41   "*Number of days before expiring unused kill file entries."
42   :group 'gnus-score-kill
43   :group 'gnus-score-expire
44   :type 'integer)
45
46 (defcustom gnus-kill-save-kill-file nil
47   "*If non-nil, will save kill files after processing them."
48   :group 'gnus-score-kill
49   :type 'boolean)
50
51 (defcustom gnus-winconf-kill-file nil
52   "What does this do, Lars?"
53   :group 'gnus-score-kill
54   :type 'sexp)
55
56 (defcustom gnus-kill-killed t
57   "*If non-nil, Gnus will apply kill files to already killed articles.
58 If it is nil, Gnus will never apply kill files to articles that have
59 already been through the scoring process, which might very well save lots
60 of time."
61   :group 'gnus-score-kill
62   :type 'boolean)
63
64 \f
65
66 (defmacro gnus-raise (field expression level)
67   `(gnus-kill ,field ,expression
68               (function (gnus-summary-raise-score ,level)) t))
69
70 (defmacro gnus-lower (field expression level)
71   `(gnus-kill ,field ,expression
72               (function (gnus-summary-raise-score (- ,level))) t))
73
74 ;;;
75 ;;; Gnus Kill File Mode
76 ;;;
77
78 (defvar gnus-kill-file-mode-map nil)
79
80 (unless gnus-kill-file-mode-map
81   (gnus-define-keymap (setq gnus-kill-file-mode-map
82                             (copy-keymap emacs-lisp-mode-map))
83     "\C-c\C-k\C-s" gnus-kill-file-kill-by-subject
84     "\C-c\C-k\C-a" gnus-kill-file-kill-by-author
85     "\C-c\C-k\C-t" gnus-kill-file-kill-by-thread
86     "\C-c\C-k\C-x" gnus-kill-file-kill-by-xref
87     "\C-c\C-a" gnus-kill-file-apply-buffer
88     "\C-c\C-e" gnus-kill-file-apply-last-sexp
89     "\C-c\C-c" gnus-kill-file-exit))
90
91 (defun gnus-kill-file-mode ()
92   "Major mode for editing kill files.
93
94 If you are using this mode - you probably shouldn't.  Kill files
95 perform badly and paint with a pretty broad brush.  Score files, on
96 the other hand, are vastly faster (40x speedup) and give you more
97 control over what to do.
98
99 In addition to Emacs-Lisp Mode, the following commands are available:
100
101 \\{gnus-kill-file-mode-map}
102
103   A kill file contains Lisp expressions to be applied to a selected
104 newsgroup.  The purpose is to mark articles as read on the basis of
105 some set of regexps.  A global kill file is applied to every newsgroup,
106 and a local kill file is applied to a specified newsgroup.  Since a
107 global kill file is applied to every newsgroup, for better performance
108 use a local one.
109
110   A kill file can contain any kind of Emacs Lisp expressions expected
111 to be evaluated in the Summary buffer.  Writing Lisp programs for this
112 purpose is not so easy because the internal working of Gnus must be
113 well-known.  For this reason, Gnus provides a general function which
114 does this easily for non-Lisp programmers.
115
116   The `gnus-kill' function executes commands available in Summary Mode
117 by their key sequences.  `gnus-kill' should be called with FIELD,
118 REGEXP and optional COMMAND and ALL.  FIELD is a string representing
119 the header field or an empty string.  If FIELD is an empty string, the
120 entire article body is searched for.  REGEXP is a string which is
121 compared with FIELD value.  COMMAND is a string representing a valid
122 key sequence in Summary mode or Lisp expression.  COMMAND defaults to
123 '(gnus-summary-mark-as-read nil \"X\").  Make sure that COMMAND is
124 executed in the Summary buffer.  If the second optional argument ALL
125 is non-nil, the COMMAND is applied to articles which are already
126 marked as read or unread.  Articles which are marked are skipped over
127 by default.
128
129   For example, if you want to mark articles of which subjects contain
130 the string `AI' as read, a possible kill file may look like:
131
132         (gnus-kill \"Subject\" \"AI\")
133
134   If you want to mark articles with `D' instead of `X', you can use
135 the following expression:
136
137         (gnus-kill \"Subject\" \"AI\" \"d\")
138
139 In this example it is assumed that the command
140 `gnus-summary-mark-as-read-forward' is assigned to `d' in Summary Mode.
141
142   It is possible to delete unnecessary headers which are marked with
143 `X' in a kill file as follows:
144
145         (gnus-expunge \"X\")
146
147   If the Summary buffer is empty after applying kill files, Gnus will
148 exit the selected newsgroup normally.  If headers which are marked
149 with `D' are deleted in a kill file, it is impossible to read articles
150 which are marked as read in the previous Gnus sessions.  Marks other
151 than `D' should be used for articles which should really be deleted.
152
153 Entry to this mode calls emacs-lisp-mode-hook and
154 gnus-kill-file-mode-hook with no arguments, if that value is non-nil."
155   (interactive)
156   (kill-all-local-variables)
157   (use-local-map gnus-kill-file-mode-map)
158   (set-syntax-table emacs-lisp-mode-syntax-table)
159   (setq major-mode 'gnus-kill-file-mode)
160   (setq mode-name "Kill")
161   (lisp-mode-variables nil)
162   (gnus-run-hooks 'emacs-lisp-mode-hook 'gnus-kill-file-mode-hook))
163
164 (defun gnus-kill-file-edit-file (newsgroup)
165   "Begin editing a kill file for NEWSGROUP.
166 If NEWSGROUP is nil, the global kill file is selected."
167   (interactive "sNewsgroup: ")
168   (let ((file (gnus-newsgroup-kill-file newsgroup)))
169     (gnus-make-directory (file-name-directory file))
170     ;; Save current window configuration if this is first invocation.
171     (or (and (get-file-buffer file)
172              (get-buffer-window (get-file-buffer file)))
173         (setq gnus-winconf-kill-file (current-window-configuration)))
174     ;; Hack windows.
175     (let ((buffer (find-file-noselect file)))
176       (cond ((get-buffer-window buffer)
177              (pop-to-buffer buffer))
178             ((eq major-mode 'gnus-group-mode)
179              (gnus-configure-windows 'group) ;Take all windows.
180              (pop-to-buffer buffer))
181             ((eq major-mode 'gnus-summary-mode)
182              (gnus-configure-windows 'article)
183              (pop-to-buffer gnus-article-buffer)
184              (bury-buffer gnus-article-buffer)
185              (switch-to-buffer buffer))
186             (t                          ;No good rules.
187              (find-file-other-window file))))
188     (gnus-kill-file-mode)))
189
190 ;; Fix by Sudish Joseph <joseph@cis.ohio-state.edu>.
191 (defun gnus-kill-set-kill-buffer ()
192   (let* ((file (gnus-newsgroup-kill-file gnus-newsgroup-name))
193          (buffer (find-file-noselect file)))
194     (set-buffer buffer)
195     (gnus-kill-file-mode)
196     (bury-buffer buffer)))
197
198 (defun gnus-kill-file-enter-kill (field regexp &optional dont-move)
199   ;; Enter kill file entry.
200   ;; FIELD: String containing the name of the header field to kill.
201   ;; REGEXP: The string to kill.
202   (save-excursion
203     (let (string)
204       (unless (eq major-mode 'gnus-kill-file-mode)
205         (gnus-kill-set-kill-buffer))
206       (unless dont-move
207         (goto-char (point-max)))
208       (insert (setq string (format "(gnus-kill %S %S)\n" field regexp)))
209       (gnus-kill-file-apply-string string))))
210
211 (defun gnus-kill-file-kill-by-subject ()
212   "Kill by subject."
213   (interactive)
214   (gnus-kill-file-enter-kill
215    "Subject"
216    (if (vectorp gnus-current-headers)
217        (regexp-quote
218         (gnus-simplify-subject (mail-header-subject gnus-current-headers)))
219      "")
220    t))
221
222 (defun gnus-kill-file-kill-by-author ()
223   "Kill by author."
224   (interactive)
225   (gnus-kill-file-enter-kill
226    "From"
227    (if (vectorp gnus-current-headers)
228        (regexp-quote (mail-header-from gnus-current-headers))
229      "") t))
230
231 (defun gnus-kill-file-kill-by-thread ()
232   "Kill by author."
233   (interactive)
234   (gnus-kill-file-enter-kill
235    "References"
236    (if (vectorp gnus-current-headers)
237        (regexp-quote (mail-header-id gnus-current-headers))
238      "")))
239
240 (defun gnus-kill-file-kill-by-xref ()
241   "Kill by Xref."
242   (interactive)
243   (let ((xref (and (vectorp gnus-current-headers)
244                    (mail-header-xref gnus-current-headers)))
245         (start 0)
246         group)
247     (if xref
248         (while (string-match " \\([^ \t]+\\):" xref start)
249           (setq start (match-end 0))
250           (when (not (string=
251                       (setq group
252                             (substring xref (match-beginning 1) (match-end 1)))
253                       gnus-newsgroup-name))
254             (gnus-kill-file-enter-kill
255              "Xref" (concat " " (regexp-quote group) ":") t)))
256       (gnus-kill-file-enter-kill "Xref" "" t))))
257
258 (defun gnus-kill-file-raise-followups-to-author (level)
259   "Raise score for all followups to the current author."
260   (interactive "p")
261   (let ((name (mail-header-from gnus-current-headers))
262         string)
263     (save-excursion
264       (gnus-kill-set-kill-buffer)
265       (goto-char (point-min))
266       (setq name (read-string (concat "Add " level
267                                       " to followup articles to: ")
268                               (regexp-quote name)))
269       (setq
270        string
271        (format
272         "(gnus-kill %S %S '(gnus-summary-temporarily-raise-by-thread %S))\n"
273         "From" name level))
274       (insert string)
275       (gnus-kill-file-apply-string string))
276     (gnus-message
277      6 "Added temporary score file entry for followups to %s." name)))
278
279 (defun gnus-kill-file-apply-buffer ()
280   "Apply current buffer to current newsgroup."
281   (interactive)
282   (if (and gnus-current-kill-article
283            (get-buffer gnus-summary-buffer))
284       ;; Assume newsgroup is selected.
285       (gnus-kill-file-apply-string (buffer-string))
286     (ding) (gnus-message 2 "No newsgroup is selected.")))
287
288 (defun gnus-kill-file-apply-string (string)
289   "Apply STRING to current newsgroup."
290   (interactive)
291   (let ((string (concat "(progn \n" string "\n)")))
292     (save-excursion
293       (save-window-excursion
294         (pop-to-buffer gnus-summary-buffer)
295         (eval (car (read-from-string string)))))))
296
297 (defun gnus-kill-file-apply-last-sexp ()
298   "Apply sexp before point in current buffer to current newsgroup."
299   (interactive)
300   (if (and gnus-current-kill-article
301            (get-buffer gnus-summary-buffer))
302       ;; Assume newsgroup is selected.
303       (let ((string
304              (buffer-substring
305               (save-excursion (forward-sexp -1) (point)) (point))))
306         (save-excursion
307           (save-window-excursion
308             (pop-to-buffer gnus-summary-buffer)
309             (eval (car (read-from-string string))))))
310     (ding) (gnus-message 2 "No newsgroup is selected.")))
311
312 (defun gnus-kill-file-exit ()
313   "Save a kill file, then return to the previous buffer."
314   (interactive)
315   (save-buffer)
316   (let ((killbuf (current-buffer)))
317     ;; We don't want to return to article buffer.
318     (when (get-buffer gnus-article-buffer)
319       (bury-buffer gnus-article-buffer))
320     ;; Delete the KILL file windows.
321     (delete-windows-on killbuf)
322     ;; Restore last window configuration if available.
323     (when gnus-winconf-kill-file
324       (set-window-configuration gnus-winconf-kill-file))
325     (setq gnus-winconf-kill-file nil)
326     ;; Kill the KILL file buffer.  Suggested by tale@pawl.rpi.edu.
327     (kill-buffer killbuf)))
328
329 ;; For kill files
330
331 (defun gnus-Newsgroup-kill-file (newsgroup)
332   "Return the name of a kill file for NEWSGROUP.
333 If NEWSGROUP is nil, return the global kill file instead."
334   (cond ((or (null newsgroup)
335              (string-equal newsgroup ""))
336          ;; The global kill file is placed at top of the directory.
337          (expand-file-name gnus-kill-file-name gnus-kill-files-directory))
338         (gnus-use-long-file-name
339          ;; Append ".KILL" to capitalized newsgroup name.
340          (expand-file-name (concat (gnus-capitalize-newsgroup newsgroup)
341                                    "." gnus-kill-file-name)
342                            gnus-kill-files-directory))
343         (t
344          ;; Place "KILL" under the hierarchical directory.
345          (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
346                                    "/" gnus-kill-file-name)
347                            gnus-kill-files-directory))))
348
349 (defun gnus-expunge (marks)
350   "Remove lines marked with MARKS."
351   (save-excursion
352     (set-buffer gnus-summary-buffer)
353     (gnus-summary-limit-to-marks marks 'reverse)))
354
355 (defun gnus-apply-kill-file-unless-scored ()
356   "Apply .KILL file, unless a .SCORE file for the same newsgroup exists."
357   (cond ((file-exists-p (gnus-score-file-name gnus-newsgroup-name))
358          ;; Ignores global KILL.
359          (when (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name))
360            (gnus-message 3 "Note: Ignoring %s.KILL; preferring .SCORE"
361                          gnus-newsgroup-name))
362          0)
363         ((or (file-exists-p (gnus-newsgroup-kill-file nil))
364              (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
365          (gnus-apply-kill-file-internal))
366         (t
367          0)))
368
369 (defun gnus-apply-kill-file-internal ()
370   "Apply a kill file to the current newsgroup.
371 Returns the number of articles marked as read."
372   (let* ((kill-files (list (gnus-newsgroup-kill-file nil)
373                            (gnus-newsgroup-kill-file gnus-newsgroup-name)))
374          (unreads (length gnus-newsgroup-unreads))
375          (gnus-summary-inhibit-highlight t)
376          beg)
377     (setq gnus-newsgroup-kill-headers nil)
378     ;; If there are any previously scored articles, we remove these
379     ;; from the `gnus-newsgroup-headers' list that the score functions
380     ;; will see.  This is probably pretty wasteful when it comes to
381     ;; conses, but is, I think, faster than having to assq in every
382     ;; single score function.
383     (let ((files kill-files))
384       (while files
385         (if (file-exists-p (car files))
386             (let ((headers gnus-newsgroup-headers))
387               (if gnus-kill-killed
388                   (setq gnus-newsgroup-kill-headers
389                         (mapcar (lambda (header) (mail-header-number header))
390                                 headers))
391                 (while headers
392                   (unless (gnus-member-of-range
393                            (mail-header-number (car headers))
394                            gnus-newsgroup-killed)
395                     (push (mail-header-number (car headers))
396                           gnus-newsgroup-kill-headers))
397                   (setq headers (cdr headers))))
398               (setq files nil))
399           (setq files (cdr files)))))
400     (if (not gnus-newsgroup-kill-headers)
401         ()
402       (save-window-excursion
403         (save-excursion
404           (while kill-files
405             (if (not (file-exists-p (car kill-files)))
406                 ()
407               (gnus-message 6 "Processing kill file %s..." (car kill-files))
408               (find-file (car kill-files))
409               (gnus-add-current-to-buffer-list)
410               (goto-char (point-min))
411
412               (if (consp (ignore-errors (read (current-buffer))))
413                   (gnus-kill-parse-gnus-kill-file)
414                 (gnus-kill-parse-rn-kill-file))
415
416               (gnus-message
417                6 "Processing kill file %s...done" (car kill-files)))
418             (setq kill-files (cdr kill-files)))))
419
420       (gnus-set-mode-line 'summary)
421
422       (if beg
423           (let ((nunreads (- unreads (length gnus-newsgroup-unreads))))
424             (or (eq nunreads 0)
425                 (gnus-message 6 "Marked %d articles as read" nunreads))
426             nunreads)
427         0))))
428
429 ;; Parse a Gnus killfile.
430 (defun gnus-score-insert-help (string alist idx)
431   (save-excursion
432     (pop-to-buffer "*Score Help*")
433     (buffer-disable-undo (current-buffer))
434     (erase-buffer)
435     (insert string ":\n\n")
436     (while alist
437       (insert (format " %c: %s\n" (caar alist) (nth idx (car alist))))
438       (setq alist (cdr alist)))))
439
440 (defun gnus-kill-parse-gnus-kill-file ()
441   (goto-char (point-min))
442   (gnus-kill-file-mode)
443   (let (beg form)
444     (while (progn
445              (setq beg (point))
446              (setq form (ignore-errors (read (current-buffer)))))
447       (unless (listp form)
448         (error "Illegal kill entry (possibly rn kill file?): %s" form))
449       (if (or (eq (car form) 'gnus-kill)
450               (eq (car form) 'gnus-raise)
451               (eq (car form) 'gnus-lower))
452           (progn
453             (delete-region beg (point))
454             (insert (or (eval form) "")))
455         (save-excursion
456           (set-buffer gnus-summary-buffer)
457           (ignore-errors (eval form)))))
458     (and (buffer-modified-p)
459          gnus-kill-save-kill-file
460          (save-buffer))
461     (set-buffer-modified-p nil)))
462
463 ;; Parse an rn killfile.
464 (defun gnus-kill-parse-rn-kill-file ()
465   (goto-char (point-min))
466   (gnus-kill-file-mode)
467   (let ((mod-to-header
468          '((?a . "")
469            (?h . "")
470            (?f . "from")
471            (?: . "subject")))
472         (com-to-com
473          '((?m . " ")
474            (?j . "X")))
475         pattern modifier commands)
476     (while (not (eobp))
477       (if (not (looking-at "[ \t]*/\\([^/]*\\)/\\([ahfcH]\\)?:\\([a-z=:]*\\)"))
478           ()
479         (setq pattern (buffer-substring (match-beginning 1) (match-end 1)))
480         (setq modifier (if (match-beginning 2) (char-after (match-beginning 2))
481                          ?s))
482         (setq commands (buffer-substring (match-beginning 3) (match-end 3)))
483
484         ;; The "f:+" command marks everything *but* the matches as read,
485         ;; so we simply first match everything as read, and then unmark
486         ;; PATTERN later.
487         (when (string-match "\\+" commands)
488           (gnus-kill "from" ".")
489           (setq commands "m"))
490
491         (gnus-kill
492          (or (cdr (assq modifier mod-to-header)) "subject")
493          pattern
494          (if (string-match "m" commands)
495              '(gnus-summary-mark-as-unread nil " ")
496            '(gnus-summary-mark-as-read nil "X"))
497          nil t))
498       (forward-line 1))))
499
500 ;; Kill changes and new format by suggested by JWZ and Sudish Joseph
501 ;; <joseph@cis.ohio-state.edu>.
502 (defun gnus-kill (field regexp &optional exe-command all silent)
503   "If FIELD of an article matches REGEXP, execute COMMAND.
504 Optional 1st argument COMMAND is default to
505         (gnus-summary-mark-as-read nil \"X\").
506 If optional 2nd argument ALL is non-nil, articles marked are also applied to.
507 If FIELD is an empty string (or nil), entire article body is searched for.
508 COMMAND must be a lisp expression or a string representing a key sequence."
509   ;; We don't want to change current point nor window configuration.
510   (let ((old-buffer (current-buffer)))
511     (save-excursion
512       (save-window-excursion
513         ;; Selected window must be summary buffer to execute keyboard
514         ;; macros correctly.  See command_loop_1.
515         (switch-to-buffer gnus-summary-buffer 'norecord)
516         (goto-char (point-min))         ;From the beginning.
517         (let ((kill-list regexp)
518               (date (current-time-string))
519               (command (or exe-command '(gnus-summary-mark-as-read
520                                          nil gnus-kill-file-mark)))
521               kill kdate prev)
522           (if (listp kill-list)
523               ;; It is a list.
524               (if (not (consp (cdr kill-list)))
525                   ;; It's on the form (regexp . date).
526                   (if (zerop (gnus-execute field (car kill-list)
527                                            command nil (not all)))
528                       (when (> (gnus-days-between date (cdr kill-list))
529                                gnus-kill-expiry-days)
530                         (setq regexp nil))
531                     (setcdr kill-list date))
532                 (while (setq kill (car kill-list))
533                   (if (consp kill)
534                       ;; It's a temporary kill.
535                       (progn
536                         (setq kdate (cdr kill))
537                         (if (zerop (gnus-execute
538                                     field (car kill) command nil (not all)))
539                             (when (> (gnus-days-between date kdate)
540                                      gnus-kill-expiry-days)
541                               ;; Time limit has been exceeded, so we
542                               ;; remove the match.
543                               (if prev
544                                   (setcdr prev (cdr kill-list))
545                                 (setq regexp (cdr regexp))))
546                           ;; Successful kill.  Set the date to today.
547                           (setcdr kill date)))
548                     ;; It's a permanent kill.
549                     (gnus-execute field kill command nil (not all)))
550                   (setq prev kill-list)
551                   (setq kill-list (cdr kill-list))))
552             (gnus-execute field kill-list command nil (not all))))))
553     (switch-to-buffer old-buffer)
554     (when (and (eq major-mode 'gnus-kill-file-mode) regexp (not silent))
555       (gnus-pp-gnus-kill
556        (nconc (list 'gnus-kill field
557                     (if (consp regexp) (list 'quote regexp) regexp))
558               (when (or exe-command all)
559                 (list (list 'quote exe-command)))
560               (if all (list t) nil))))))
561
562 (defun gnus-pp-gnus-kill (object)
563   (if (or (not (consp (nth 2 object)))
564           (not (consp (cdr (nth 2 object))))
565           (and (eq 'quote (car (nth 2 object)))
566                (not (consp (cdadr (nth 2 object))))))
567       (concat "\n" (gnus-prin1-to-string object))
568     (save-excursion
569       (set-buffer (get-buffer-create "*Gnus PP*"))
570       (buffer-disable-undo (current-buffer))
571       (erase-buffer)
572       (insert (format "\n(%S %S\n  '(" (nth 0 object) (nth 1 object)))
573       (let ((klist (cadr (nth 2 object)))
574             (first t))
575         (while klist
576           (insert (if first (progn (setq first nil) "")  "\n    ")
577                   (gnus-prin1-to-string (car klist)))
578           (setq klist (cdr klist))))
579       (insert ")")
580       (and (nth 3 object)
581            (insert "\n  "
582                    (if (and (consp (nth 3 object))
583                             (not (eq 'quote (car (nth 3 object)))))
584                        "'" "")
585                    (gnus-prin1-to-string (nth 3 object))))
586       (when (nth 4 object)
587         (insert "\n  t"))
588       (insert ")")
589       (prog1
590           (buffer-substring (point-min) (point-max))
591         (kill-buffer (current-buffer))))))
592
593 (defun gnus-execute-1 (function regexp form header)
594   (save-excursion
595     (let (did-kill)
596       (if (null header)
597           nil                           ;Nothing to do.
598         (if function
599             ;; Compare with header field.
600             (let (value)
601               (and header
602                    (progn
603                      (setq value (funcall function header))
604                      ;; Number (Lines:) or symbol must be converted to string.
605                      (unless (stringp value)
606                        (setq value (gnus-prin1-to-string value)))
607                      (setq did-kill (string-match regexp value)))
608                    (cond ((stringp form) ;Keyboard macro.
609                           (execute-kbd-macro form))
610                          ((gnus-functionp form)
611                           (funcall form))
612                          (t
613                           (eval form)))))
614           ;; Search article body.
615           (let ((gnus-current-article nil) ;Save article pointer.
616                 (gnus-last-article nil)
617                 (gnus-break-pages nil)  ;No need to break pages.
618                 (gnus-mark-article-hook nil)) ;Inhibit marking as read.
619             (gnus-message
620              6 "Searching for article: %d..." (mail-header-number header))
621             (gnus-article-setup-buffer)
622             (gnus-article-prepare (mail-header-number header) t)
623             (when (save-excursion
624                     (set-buffer gnus-article-buffer)
625                     (goto-char (point-min))
626                     (setq did-kill (re-search-forward regexp nil t)))
627               (cond ((stringp form)     ;Keyboard macro.
628                      (execute-kbd-macro form))
629                     ((gnus-functionp form)
630                      (funcall form))
631                     (t
632                      (eval form)))))))
633       did-kill)))
634
635 (defun gnus-execute (field regexp form &optional backward unread)
636   "If FIELD of article header matches REGEXP, execute lisp FORM (or a string).
637 If FIELD is an empty string (or nil), entire article body is searched for.
638 If optional 1st argument BACKWARD is non-nil, do backward instead.
639 If optional 2nd argument UNREAD is non-nil, articles which are
640 marked as read or ticked are ignored."
641   (save-excursion
642     (let ((killed-no 0)
643           function article header)
644       (cond
645        ;; Search body.
646        ((or (null field)
647             (string-equal field ""))
648         (setq function nil))
649        ;; Get access function of header field.
650        ((fboundp
651          (setq function
652                (intern-soft
653                 (concat "mail-header-" (downcase field)))))
654         (setq function `(lambda (h) (,function h))))
655        ;; Signal error.
656        (t
657         (error "Unknown header field: \"%s\"" field)))
658       ;; Starting from the current article.
659       (while (or
660               ;; First article.
661               (and (not article)
662                    (setq article (gnus-summary-article-number)))
663               ;; Find later articles.
664               (setq article
665                     (gnus-summary-search-forward unread nil backward)))
666         (and (or (null gnus-newsgroup-kill-headers)
667                  (memq article gnus-newsgroup-kill-headers))
668              (vectorp (setq header (gnus-summary-article-header article)))
669              (gnus-execute-1 function regexp form header)
670              (setq killed-no (1+ killed-no))))
671       ;; Return the number of killed articles.
672       killed-no)))
673
674 ;;;###autoload
675 (defalias 'gnus-batch-kill 'gnus-batch-score)
676 ;;;###autoload
677 (defun gnus-batch-score ()
678   "Run batched scoring.
679 Usage: emacs -batch -l ~/.emacs -l gnus -f gnus-batch-score"
680   (interactive)
681   (let* ((gnus-newsrc-options-n
682           (gnus-newsrc-parse-options
683            (concat "options -n "
684                    (mapconcat 'identity command-line-args-left " "))))
685          (gnus-expert-user t)
686          (nnmail-spool-file nil)
687          (gnus-use-dribble-file nil)
688          (gnus-batch-mode t)
689          info group newsrc entry
690          ;; Disable verbose message.
691          gnus-novice-user gnus-large-newsgroup
692          gnus-options-subscribe gnus-auto-subscribed-groups
693          gnus-options-not-subscribe)
694     ;; Eat all arguments.
695     (setq command-line-args-left nil)
696     (gnus-slave)
697     ;; Apply kills to specified newsgroups in command line arguments.
698     (setq newsrc (cdr gnus-newsrc-alist))
699     (while (setq info (pop newsrc))
700       (setq group (gnus-info-group info)
701             entry (gnus-gethash group gnus-newsrc-hashtb))
702       (when (and (<= (gnus-info-level info) gnus-level-subscribed)
703                  (and (car entry)
704                       (or (eq (car entry) t)
705                           (not (zerop (car entry))))))
706         (gnus-summary-read-group group nil t nil t)
707         (when (eq (current-buffer) (get-buffer gnus-summary-buffer))
708           (gnus-summary-exit))))
709     ;; Exit Emacs.
710     (switch-to-buffer gnus-group-buffer)
711     (gnus-group-save-newsrc)))
712
713 (provide 'gnus-kill)
714
715 ;;; gnus-kill.el ends here