lisp/gnus/gnus-kill.el

   1 ;;; gnus-kill.el --- kill commands for Gnus
   2
   3 ;; Copyright (C) 1995-2011 Free Software Foundation, Inc.
   4
   5 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
   6 ;;      Lars Magne Ingebrigtsen <larsi@gnus.org>
   7 ;; Keywords: news
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software: you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation, either version 3 of the License, or
  14 ;; (at your option) any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 ;;; Commentary:
  25
  26 ;;; Code:
  27
  28 (eval-when-compile (require 'cl))
  29
  30 (require 'gnus)
  31 (require 'gnus-art)
  32 (require 'gnus-range)
  33
  34 (defcustom gnus-kill-file-mode-hook nil
  35   "Hook for Gnus kill file mode."
  36   :group 'gnus-score-kill
  37   :type 'hook)
  38
  39 (defcustom gnus-kill-expiry-days 7
  40   "*Number of days before expiring unused kill file entries."
  41   :group 'gnus-score-kill
  42   :group 'gnus-score-expire
  43   :type 'integer)
  44
  45 (defcustom gnus-kill-save-kill-file nil
  46   "*If non-nil, will save kill files after processing them."
  47   :group 'gnus-score-kill
  48   :type 'boolean)
  49
  50 (defcustom gnus-winconf-kill-file nil
  51   "What does this do, Lars?
  52 I don't know, Per."
  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-mode-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   (with-current-buffer gnus-summary-buffer
 352     (gnus-summary-limit-to-marks marks 'reverse)))
 353
 354 (defun gnus-apply-kill-file-unless-scored ()
 355   "Apply .KILL file, unless a .SCORE file for the same newsgroup exists."
 356   (cond ((file-exists-p (gnus-score-file-name gnus-newsgroup-name))
 357          ;; Ignores global KILL.
 358          (when (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name))
 359            (gnus-message 3 "Note: Ignoring %s.KILL; preferring .SCORE"
 360                          gnus-newsgroup-name))
 361          0)
 362         ((or (file-exists-p (gnus-newsgroup-kill-file nil))
 363              (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
 364          (gnus-apply-kill-file-internal))
 365         (t
 366          0)))
 367
 368 (defun gnus-apply-kill-file-internal ()
 369   "Apply a kill file to the current newsgroup.
 370 Returns the number of articles marked as read."
 371   (let* ((kill-files (list (gnus-newsgroup-kill-file nil)
 372                            (gnus-newsgroup-kill-file gnus-newsgroup-name)))
 373          (unreads (length gnus-newsgroup-unreads))
 374          (gnus-summary-inhibit-highlight t)
 375          beg)
 376     (setq gnus-newsgroup-kill-headers nil)
 377     ;; If there are any previously scored articles, we remove these
 378     ;; from the `gnus-newsgroup-headers' list that the score functions
 379     ;; will see.  This is probably pretty wasteful when it comes to
 380     ;; conses, but is, I think, faster than having to assq in every
 381     ;; single score function.
 382     (let ((files kill-files))
 383       (while files
 384         (if (file-exists-p (car files))
 385             (let ((headers gnus-newsgroup-headers))
 386               (if gnus-kill-killed
 387                   (setq gnus-newsgroup-kill-headers
 388                         (mapcar (lambda (header) (mail-header-number header))
 389                                 headers))
 390                 (while headers
 391                   (unless (gnus-member-of-range
 392                            (mail-header-number (car headers))
 393                            gnus-newsgroup-killed)
 394                     (push (mail-header-number (car headers))
 395                           gnus-newsgroup-kill-headers))
 396                   (setq headers (cdr headers))))
 397               (setq files nil))
 398           (setq files (cdr files)))))
 399     (if (not gnus-newsgroup-kill-headers)
 400         ()
 401       (save-window-excursion
 402         (save-excursion
 403           (while kill-files
 404             (if (not (file-exists-p (car kill-files)))
 405                 ()
 406               (gnus-message 6 "Processing kill file %s..." (car kill-files))
 407               (find-file (car kill-files))
 408               (goto-char (point-min))
 409
 410               (if (consp (ignore-errors (read (current-buffer))))
 411                   (gnus-kill-parse-gnus-kill-file)
 412                 (gnus-kill-parse-rn-kill-file))
 413
 414               (gnus-message
 415                6 "Processing kill file %s...done" (car kill-files)))
 416             (setq kill-files (cdr kill-files)))))
 417
 418       (gnus-set-mode-line 'summary)
 419
 420       (if beg
 421           (let ((nunreads (- unreads (length gnus-newsgroup-unreads))))
 422             (or (eq nunreads 0)
 423                 (gnus-message 6 "Marked %d articles as read" nunreads))
 424             nunreads)
 425         0))))
 426
 427 ;; Parse a Gnus killfile.
 428 (defun gnus-kill-parse-gnus-kill-file ()
 429   (goto-char (point-min))
 430   (gnus-kill-file-mode)
 431   (let (beg form)
 432     (while (progn
 433              (setq beg (point))
 434              (setq form (ignore-errors (read (current-buffer)))))
 435       (unless (listp form)
 436         (error "Invalid kill entry (possibly rn kill file?): %s" form))
 437       (if (or (eq (car form) 'gnus-kill)
 438               (eq (car form) 'gnus-raise)
 439               (eq (car form) 'gnus-lower))
 440           (progn
 441             (delete-region beg (point))
 442             (insert (or (eval form) "")))
 443         (with-current-buffer gnus-summary-buffer
 444           (ignore-errors (eval form)))))
 445     (and (buffer-modified-p)
 446          gnus-kill-save-kill-file
 447          (save-buffer))
 448     (set-buffer-modified-p nil)))
 449
 450 ;; Parse an rn killfile.
 451 (defun gnus-kill-parse-rn-kill-file ()
 452   (goto-char (point-min))
 453   (gnus-kill-file-mode)
 454   (let ((mod-to-header
 455          '((?a . "")
 456            (?h . "")
 457            (?f . "from")
 458            (?: . "subject")))
 459         ;;(com-to-com
 460         ;; '((?m . " ")
 461         ;;   (?j . "X")))
 462         pattern modifier commands)
 463     (while (not (eobp))
 464       (if (not (looking-at "[ \t]*/\\([^/]*\\)/\\([ahfcH]\\)?:\\([a-z=:]*\\)"))
 465           ()
 466         (setq pattern (buffer-substring (match-beginning 1) (match-end 1)))
 467         (setq modifier (if (match-beginning 2) (char-after (match-beginning 2))
 468                          ?s))
 469         (setq commands (buffer-substring (match-beginning 3) (match-end 3)))
 470
 471         ;; The "f:+" command marks everything *but* the matches as read,
 472         ;; so we simply first match everything as read, and then unmark
 473         ;; PATTERN later.
 474         (when (string-match "\\+" commands)
 475           (gnus-kill "from" ".")
 476           (setq commands "m"))
 477
 478         (gnus-kill
 479          (or (cdr (assq modifier mod-to-header)) "subject")
 480          pattern
 481          (if (string-match "m" commands)
 482              '(gnus-summary-tick-article nil " ")
 483            '(gnus-summary-mark-as-read nil "X"))
 484          nil t))
 485       (forward-line 1))))
 486
 487 ;; Kill changes and new format by suggested by JWZ and Sudish Joseph
 488 ;; <joseph@cis.ohio-state.edu>.
 489 (defun gnus-kill (field regexp &optional exe-command all silent)
 490   "If FIELD of an article matches REGEXP, execute COMMAND.
 491 Optional 1st argument COMMAND is default to
 492         (gnus-summary-mark-as-read nil \"X\").
 493 If optional 2nd argument ALL is non-nil, articles marked are also applied to.
 494 If FIELD is an empty string (or nil), entire article body is searched for.
 495 COMMAND must be a Lisp expression or a string representing a key sequence."
 496   ;; We don't want to change current point nor window configuration.
 497   (let ((old-buffer (current-buffer)))
 498     (save-excursion
 499       (save-window-excursion
 500         ;; Selected window must be summary buffer to execute keyboard
 501         ;; macros correctly.  See command_loop_1.
 502         (switch-to-buffer gnus-summary-buffer 'norecord)
 503         (goto-char (point-min))         ;From the beginning.
 504         (let ((kill-list regexp)
 505               (date (current-time-string))
 506               (command (or exe-command '(gnus-summary-mark-as-read
 507                                          nil gnus-kill-file-mark)))
 508               kill kdate prev)
 509           (if (listp kill-list)
 510               ;; It is a list.
 511               (if (not (consp (cdr kill-list)))
 512                   ;; It's of the form (regexp . date).
 513                   (if (zerop (gnus-execute field (car kill-list)
 514                                            command nil (not all)))
 515                       (when (> (days-between date (cdr kill-list))
 516                                gnus-kill-expiry-days)
 517                         (setq regexp nil))
 518                     (setcdr kill-list date))
 519                 (while (setq kill (car kill-list))
 520                   (if (consp kill)
 521                       ;; It's a temporary kill.
 522                       (progn
 523                         (setq kdate (cdr kill))
 524                         (if (zerop (gnus-execute
 525                                     field (car kill) command nil (not all)))
 526                             (when (> (days-between date kdate)
 527                                      gnus-kill-expiry-days)
 528                               ;; Time limit has been exceeded, so we
 529                               ;; remove the match.
 530                               (if prev
 531                                   (setcdr prev (cdr kill-list))
 532                                 (setq regexp (cdr regexp))))
 533                           ;; Successful kill.  Set the date to today.
 534                           (setcdr kill date)))
 535                     ;; It's a permanent kill.
 536                     (gnus-execute field kill command nil (not all)))
 537                   (setq prev kill-list)
 538                   (setq kill-list (cdr kill-list))))
 539             (gnus-execute field kill-list command nil (not all))))))
 540     (switch-to-buffer old-buffer)
 541     (when (and (eq major-mode 'gnus-kill-file-mode) regexp (not silent))
 542       (gnus-pp-gnus-kill
 543        (nconc (list 'gnus-kill field
 544                     (if (consp regexp) (list 'quote regexp) regexp))
 545               (when (or exe-command all)
 546                 (list (list 'quote exe-command)))
 547               (if all (list t) nil))))))
 548
 549 (defun gnus-pp-gnus-kill (object)
 550   (if (or (not (consp (nth 2 object)))
 551           (not (consp (cdr (nth 2 object))))
 552           (and (eq 'quote (car (nth 2 object)))
 553                (not (consp (cdadr (nth 2 object))))))
 554       (concat "\n" (gnus-prin1-to-string object))
 555     (with-current-buffer (gnus-get-buffer-create "*Gnus PP*")
 556       (buffer-disable-undo)
 557       (erase-buffer)
 558       (insert (format "\n(%S %S\n  '(" (nth 0 object) (nth 1 object)))
 559       (let ((klist (cadr (nth 2 object)))
 560             (first t))
 561         (while klist
 562           (insert (if first (progn (setq first nil) "")  "\n    ")
 563                   (gnus-prin1-to-string (car klist)))
 564           (setq klist (cdr klist))))
 565       (insert ")")
 566       (and (nth 3 object)
 567            (insert "\n  "
 568                    (if (and (consp (nth 3 object))
 569                             (not (eq 'quote (car (nth 3 object)))))
 570                        "'" "")
 571                    (gnus-prin1-to-string (nth 3 object))))
 572       (when (nth 4 object)
 573         (insert "\n  t"))
 574       (insert ")")
 575       (prog1
 576           (buffer-string)
 577         (kill-buffer (current-buffer))))))
 578
 579 (defun gnus-execute-1 (function regexp form header)
 580   (save-excursion
 581     (let (did-kill)
 582       (if (null header)
 583           nil                           ;Nothing to do.
 584         (if function
 585             ;; Compare with header field.
 586             (let (value)
 587               (and header
 588                    (progn
 589                      (setq value (funcall function header))
 590                      ;; Number (Lines:) or symbol must be converted to string.
 591                      (unless (stringp value)
 592                        (setq value (gnus-prin1-to-string value)))
 593                      (setq did-kill (string-match regexp value)))
 594                    (cond ((stringp form) ;Keyboard macro.
 595                           (execute-kbd-macro form))
 596                          ((functionp form)
 597                           (funcall form))
 598                          (t
 599                           (eval form)))))
 600           ;; Search article body.
 601           (let ((gnus-current-article nil) ;Save article pointer.
 602                 (gnus-last-article nil)
 603                 (gnus-break-pages nil)  ;No need to break pages.
 604                 (gnus-mark-article-hook nil)) ;Inhibit marking as read.
 605             (gnus-message
 606              6 "Searching for article: %d..." (mail-header-number header))
 607             (gnus-article-setup-buffer)
 608             (gnus-article-prepare (mail-header-number header) t)
 609             (when (with-current-buffer gnus-article-buffer
 610                     (goto-char (point-min))
 611                     (setq did-kill (re-search-forward regexp nil t)))
 612               (cond ((stringp form)     ;Keyboard macro.
 613                      (execute-kbd-macro form))
 614                     ((functionp form)
 615                      (funcall form))
 616                     (t
 617                      (eval form)))))))
 618       did-kill)))
 619
 620 (defun gnus-execute (field regexp form &optional backward unread)
 621   "If FIELD of article header matches REGEXP, execute Lisp FORM (or a string).
 622 If FIELD is an empty string (or nil), entire article body is searched for.
 623 If optional 1st argument BACKWARD is non-nil, do backward instead.
 624 If optional 2nd argument UNREAD is non-nil, articles which are
 625 marked as read or ticked are ignored."
 626   (save-excursion
 627     (let ((killed-no 0)
 628           function article header extras)
 629       (cond
 630        ;; Search body.
 631        ((or (null field)
 632             (string-equal field ""))
 633         (setq function nil))
 634        ;; Get access function of header field.
 635        ((cond ((fboundp
 636                 (setq function
 637                       (intern-soft
 638                        (concat "mail-header-" (downcase field)))))
 639                (setq function `(lambda (h) (,function h))))
 640               ((when (setq extras
 641                            (member (downcase field)
 642                                    (mapcar (lambda (header)
 643                                              (downcase (symbol-name header)))
 644                                            gnus-extra-headers)))
 645                  (setq function
 646                        `(lambda (h)
 647                           (gnus-extra-header
 648                            (quote ,(nth (- (length gnus-extra-headers)
 649                                            (length extras))
 650                                         gnus-extra-headers))
 651                            h)))))))
 652        ;; Signal error.
 653        (t
 654         (error "Unknown header field: \"%s\"" field)))
 655       ;; Starting from the current article.
 656       (while (or
 657               ;; First article.
 658               (and (not article)
 659                    (setq article (gnus-summary-article-number)))
 660               ;; Find later articles.
 661               (setq article
 662                     (gnus-summary-search-forward unread nil backward)))
 663         (and (or (null gnus-newsgroup-kill-headers)
 664                  (memq article gnus-newsgroup-kill-headers))
 665              (vectorp (setq header (gnus-summary-article-header article)))
 666              (gnus-execute-1 function regexp form header)
 667              (setq killed-no (1+ killed-no))))
 668       ;; Return the number of killed articles.
 669       killed-no)))
 670
 671 ;;;###autoload
 672 (defalias 'gnus-batch-kill 'gnus-batch-score)
 673 ;;;###autoload
 674 (defun gnus-batch-score ()
 675   "Run batched scoring.
 676 Usage: emacs -batch -l ~/.emacs -l gnus -f gnus-batch-score"
 677   (interactive)
 678   (let* ((gnus-newsrc-options-n
 679           (gnus-newsrc-parse-options
 680            (concat "options -n "
 681                    (mapconcat 'identity command-line-args-left " "))))
 682          (gnus-expert-user t)
 683          (mail-sources nil)
 684          (gnus-use-dribble-file nil)
 685          (gnus-batch-mode t)
 686          info group newsrc unread
 687          ;; Disable verbose message.
 688          gnus-novice-user gnus-large-newsgroup
 689          gnus-options-subscribe gnus-auto-subscribed-groups
 690          gnus-options-not-subscribe)
 691     ;; Eat all arguments.
 692     (setq command-line-args-left nil)
 693     (gnus-slave)
 694     ;; Apply kills to specified newsgroups in command line arguments.
 695     (setq newsrc (cdr gnus-newsrc-alist))
 696     (while (setq info (pop newsrc))
 697       (setq group (gnus-info-group info)
 698             unread (gnus-group-unread group))
 699       (when (and (<= (gnus-info-level info) gnus-level-subscribed)
 700                  (and unread
 701                       (or (eq unread t)
 702                           (not (zerop unread)))))
 703         (ignore-errors
 704           (gnus-summary-read-group group nil t nil t))
 705         (when (eq (current-buffer) (get-buffer gnus-summary-buffer))
 706           (gnus-summary-exit))))
 707     ;; Exit Emacs.
 708     (switch-to-buffer gnus-group-buffer)
 709     (gnus-group-save-newsrc)))
 710
 711 (provide 'gnus-kill)
 712
 713 ;;; gnus-kill.el ends here