cgit.sxemacs.org Git - gnus/blob - lisp/gnus-score.el

   1 ;;; gnus-score.el --- scoring code for Gnus
   2 ;; Copyright (C) 1995 Free Software Foundation, Inc.
   3
   4 ;; Author: Per Abrahamsen <amanda@iesd.auc.dk>
   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
  22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  23
  24 ;;; Commentary:
  25
  26 ;;; Code:
  27
  28 (require 'gnus)
  29
  30 (defvar gnus-score-expiry-days 7
  31   "*Number of days before unused score file entries are expired.")
  32
  33 (defvar gnus-orphan-score nil
  34   "*All orphans get this score added. Set in the score file.")
  35
  36 (defvar gnus-default-adaptive-score-alist
  37   '((gnus-kill-file-mark)
  38     (gnus-unread-mark)
  39     (gnus-read-mark (from  3) (subject  30))
  40     (gnus-catchup-mark (subject -10))
  41     (gnus-killed-mark (from -1) (subject -20))
  42     (gnus-del-mark (from -2) (subject -15)))
  43 "*Alist of marks and scores.")
  44
  45 (defvar gnus-score-mimic-keymap nil
  46   "*Have the score entry functions pretend that they are a keymap.")
  47
  48 (defvar gnus-score-exact-adapt-limit 10
  49   "*Number that says how long a match has to be before using substring matching.
  50 When doing adaptive scoring, one normally uses fuzzy or substring
  51 matching. However, if the header one matches is short, the possibility
  52 for false positives is great, so if the length of the match is less
  53 than this variable, exact matching will be used.
  54
  55 If this variable is nil, exact matching will always be used.")
  56
  57 \f
  58
  59 ;; Internal variables.
  60
  61 (defvar gnus-score-help-winconf nil)
  62 (defvar gnus-adaptive-score-alist gnus-default-adaptive-score-alist)
  63 (defvar gnus-score-trace nil)
  64 (defvar gnus-score-edit-buffer nil)
  65
  66 (defvar gnus-score-alist nil
  67   "Alist containing score information.
  68 The keys can be symbols or strings.  The following symbols are defined.
  69
  70 touched: If this alist has been modified.
  71 mark:    Automatically mark articles below this.
  72 expunge: Automatically expunge articles below this.
  73 files:   List of other score files to load when loading this one.
  74 eval:    Sexp to be evaluated when the score file is loaded.
  75
  76 String entries have the form (HEADER (MATCH TYPE SCORE DATE) ...)
  77 where HEADER is the header being scored, MATCH is the string we are
  78 looking for, TYPE is a flag indicating whether it should use regexp or
  79 substring matching, SCORE is the score to add and DATE is the date
  80 of the last successful match.")
  81
  82 (defvar gnus-score-cache nil)
  83 (defvar gnus-scores-articles nil)
  84 (defvar gnus-scores-exclude-files nil)
  85 (defvar gnus-header-index nil)
  86 (defvar gnus-score-index nil)
  87
  88 (eval-and-compile
  89   (autoload 'gnus-uu-ctl-map "gnus-uu" nil nil 'keymap)
  90   (autoload 'appt-select-lowest-window "appt.el"))
  91
  92 ;;; Summary mode score maps.
  93
  94 (defvar gnus-summary-score-map nil)
  95
  96 (define-prefix-command 'gnus-summary-score-map)
  97 (define-key gnus-summary-mode-map "V" 'gnus-summary-score-map)
  98 (define-key gnus-summary-score-map "s" 'gnus-summary-set-score)
  99 (define-key gnus-summary-score-map "a" 'gnus-summary-score-entry)
 100 (define-key gnus-summary-score-map "S" 'gnus-summary-current-score)
 101 (define-key gnus-summary-score-map "c" 'gnus-score-change-score-file)
 102 (define-key gnus-summary-score-map "m" 'gnus-score-set-mark-below)
 103 (define-key gnus-summary-score-map "x" 'gnus-score-set-expunge-below)
 104 (define-key gnus-summary-score-map "e" 'gnus-score-edit-alist)
 105 (define-key gnus-summary-score-map "f" 'gnus-score-edit-file)
 106 (define-key gnus-summary-score-map "t" 'gnus-score-find-trace)
 107 (define-key gnus-summary-score-map "C" 'gnus-score-customize)
 108
 109
 110
 111 ;; Summary score file commands
 112
 113 ;; Much modification of the kill (ahem, score) code and lots of the
 114 ;; functions are written by Per Abrahamsen <amanda@iesd.auc.dk>.
 115
 116 (defun gnus-summary-lower-score (&optional score)
 117   "Make a score entry based on the current article.
 118 The user will be prompted for header to score on, match type,
 119 permanence, and the string to be used.  The numerical prefix will be
 120 used as score."
 121   (interactive "P")
 122   (gnus-summary-increase-score (- (gnus-score-default score))))
 123
 124 (defun gnus-summary-increase-score (&optional score)
 125   "Make a score entry based on the current article.
 126 The user will be prompted for header to score on, match type,
 127 permanence, and the string to be used.  The numerical prefix will be
 128 used as score."
 129   (interactive "P")
 130   (gnus-set-global-variables)
 131   (let* ((nscore (gnus-score-default score))
 132          (prefix (if (< nscore 0) ?L ?I))
 133          (increase (> nscore 0))
 134          (char-to-header
 135           '((?a "from" nil nil string)
 136             (?s "subject" nil nil string)
 137             (?b "body" "" nil body-string)
 138             (?h "head" "" nil body-string)
 139             (?i "message-id" nil t string)
 140             (?t "references" "message-id" t string)
 141             (?x "xref" nil nil string)
 142             (?l "lines" nil nil number)
 143             (?d "date" nil nil date)
 144             (?f "followup" nil nil string)))
 145          (char-to-type
 146           '((?s s "substring" string)
 147             (?e e "exact string" string)
 148             (?f f "fuzzy string" string)
 149             (?r r "regexp string" string)
 150             (?s s "substring" body-string)
 151             (?r s "regexp string" body-string)
 152             (?b before "before date" date)
 153             (?a at "at date" date)
 154             (?n now "this date" date)
 155             (?< < "less than number" number)
 156             (?> > "greater than number" number)
 157             (?= = "equal to number" number)))
 158          (char-to-perm
 159           (list (list ?t (current-time-string) "temporary")
 160                 '(?p perm "permanent") '(?i now "immediate")))
 161          (mimic gnus-score-mimic-keymap)
 162          hchar entry temporary tchar pchar end type)
 163     ;; First we read the header to score.
 164     (while (not hchar)
 165       (if mimic
 166           (progn
 167             (sit-for 1)
 168             (message "%c-" prefix))
 169         (message "%s header (%s?): " (if increase "Increase" "Lower")
 170                  (mapconcat (lambda (s) (char-to-string (car s)))
 171                             char-to-header "")))
 172       (setq hchar (read-char))
 173       (if (not (or (= hchar ??) (= hchar ?\C-h)))
 174           ()
 175         (setq hchar nil)
 176         (gnus-score-insert-help "Match on header" char-to-header 1)))
 177
 178     (and (get-buffer "*Score Help*")
 179          (progn
 180            (kill-buffer "*Score Help*")
 181            (and gnus-score-help-winconf
 182                 (set-window-configuration gnus-score-help-winconf))))
 183
 184     (or (setq entry (assq (downcase hchar) char-to-header))
 185         (progn
 186           (ding)
 187           (setq end t)
 188           (if mimic (message "%c %c" prefix hchar) (message ""))))
 189     (if (or end (/= (downcase hchar) hchar))
 190         (progn
 191           ;; This was a majuscle, so we end reading and set the defaults.
 192           (if mimic (message "%c %c" prefix hchar) (message ""))
 193           (setq type nil
 194                 temporary (current-time-string)))
 195
 196       ;; We continue reading - the type.
 197       (while (not tchar)
 198         (if mimic
 199             (progn
 200               (sit-for 1)
 201               (message "%c %c-" prefix hchar))
 202           (message "%s header '%s' with match type (%s?): "
 203                    (if increase "Increase" "Lower")
 204                    (nth 1 entry)
 205                    (mapconcat (lambda (s)
 206                                 (if (eq (nth 4 entry)
 207                                         (nth 3 s))
 208                                     (char-to-string (car s))
 209                                   ""))
 210                               char-to-type "")))
 211         (setq tchar (read-char))
 212         (if (not (or (= tchar ??) (= tchar ?\C-h)))
 213             ()
 214           (setq tchar nil)
 215           (gnus-score-insert-help "Match type" char-to-type 2)))
 216
 217       (and (get-buffer "*Score Help*")
 218            (progn
 219              (and gnus-score-help-winconf
 220                   (set-window-configuration gnus-score-help-winconf))
 221              (kill-buffer "*Score Help*")))
 222
 223       (or (setq type (nth 1 (assq (downcase tchar) char-to-type)))
 224           (progn
 225             (ding)
 226             (if mimic (message "%c %c" prefix hchar) (message ""))
 227             (setq end t)))
 228       (if (or end (/= (downcase tchar) tchar))
 229           (progn
 230             ;; It was a majuscle, so we end reading and the the default.
 231             (if mimic (message "%c %c %c" prefix hchar tchar)
 232               (message ""))
 233             (setq temporary (current-time-string)))
 234
 235         ;; We continue reading.
 236         (while (not pchar)
 237           (if mimic
 238               (progn
 239                 (sit-for 1)
 240                 (message "%c %c %c-" prefix hchar tchar))
 241             (message "%s permanence (%s?): " (if increase "Increase" "Lower")
 242                      (mapconcat (lambda (s) (char-to-string (car s)))
 243                                 char-to-perm "")))
 244           (setq pchar (read-char))
 245           (if (not (or (= pchar ??) (= pchar ?\C-h)))
 246               ()
 247             (setq pchar nil)
 248             (gnus-score-insert-help "Match permanence" char-to-perm 2)))
 249
 250         (and (get-buffer "*Score Help*")
 251              (progn
 252                (and gnus-score-help-winconf
 253                     (set-window-configuration gnus-score-help-winconf))
 254                (kill-buffer "*Score Help*")))
 255
 256         (if mimic (message "%c %c %c" prefix hchar tchar pchar)
 257           (message ""))
 258         (if (setq temporary (nth 1 (assq pchar char-to-perm)))
 259             ()
 260           (ding)
 261           (setq end t)
 262           (if mimic
 263               (message "%c %c %c %c" prefix hchar tchar pchar)
 264             (message "")))))
 265
 266     ;; We have all the data, so we enter this score.
 267     (if end
 268         ()
 269       (gnus-summary-score-entry
 270        (nth 1 entry)                    ; Header
 271        (if (string= (nth 2 entry) "") ""
 272          (gnus-summary-header (or (nth 2 entry) (nth 1 entry)))) ; Match
 273        type                             ; Type
 274        (if (eq 's score) nil score)     ; Score
 275        (if (eq 'perm temporary)         ; Temp
 276            nil
 277          temporary)
 278        (not (nth 3 entry)))             ; Prompt
 279       )))
 280
 281 (defun gnus-score-insert-help (string alist idx)
 282   (setq gnus-score-help-winconf (current-window-configuration))
 283   (save-excursion
 284     (set-buffer (get-buffer-create "*Score Help*"))
 285     (buffer-disable-undo (current-buffer))
 286     (delete-windows-on (current-buffer))
 287     (erase-buffer)
 288     (insert string ":\n\n")
 289     (let ((max -1)
 290           (list alist)
 291           (i 0)
 292           n width pad format)
 293       ;; find the longest string to display
 294       (while list
 295         (setq n (length (nth idx (car list))))
 296         (or (> max n)
 297             (setq max n))
 298         (setq list (cdr list)))
 299       (setq max (+ max 4))              ; %c, `:', SPACE, a SPACE at end
 300       (setq n (/ (window-width) max))   ; items per line
 301       (setq width (/ (window-width) n)) ; width of each item
 302       ;; insert `n' items, each in a field of width `width'
 303       (while alist
 304         (if (< i n)
 305             ()
 306           (setq i 0)
 307           (delete-char -1)              ; the `\n' takes a char
 308           (insert "\n"))
 309         (setq pad (- width 3))
 310         (setq format (concat "%c: %-" (int-to-string pad) "s"))
 311         (insert (format format (car (car alist)) (nth idx (car alist))))
 312         (setq alist (cdr alist))
 313         (setq i (1+ i))))
 314     ;; display ourselves in a small window at the bottom
 315     (appt-select-lowest-window)
 316     (split-window)
 317     (pop-to-buffer "*Score Help*")
 318     (shrink-window-if-larger-than-buffer)
 319     (select-window (get-buffer-window gnus-summary-buffer))))
 320
 321 (defun gnus-summary-header (header &optional no-err)
 322   ;; Return HEADER for current articles, or error.
 323   (let ((article (gnus-summary-article-number))
 324         headers)
 325     (if article
 326         (if (and (setq headers (gnus-summary-article-header article))
 327                  (vectorp headers))
 328             (aref headers (nth 1 (assoc header gnus-header-index)))
 329           (if no-err
 330               nil
 331             (error "Pseudo-articles can't be scored")))
 332       (if no-err
 333           (error "No article on current line")
 334         nil))))
 335
 336 (defun gnus-summary-score-entry
 337   (header match type score date &optional prompt silent)
 338   "Enter score file entry.
 339 HEADER is the header being scored.
 340 MATCH is the string we are looking for.
 341 TYPE is the match type: substring, regexp, exact, fuzzy.
 342 SCORE is the score to add.
 343 DATE is the expire date, or nil for no expire, or 'now for immediate expire.
 344 If optional argument `PROMPT' is non-nil, allow user to edit match.
 345 If optional argument `SILENT' is nil, show effect of score entry."
 346   (interactive
 347    (list (completing-read "Header: "
 348                           gnus-header-index
 349                           (lambda (x) (fboundp (nth 2 x)))
 350                           t)
 351          (read-string "Match: ")
 352          (if (y-or-n-p "Use regexp match? ") 'r 's)
 353          (and current-prefix-arg
 354               (prefix-numeric-value current-prefix-arg))
 355          (cond ((not (y-or-n-p "Add to score file? "))
 356                 'now)
 357                ((y-or-n-p "Expire kill? ")
 358                 (current-time-string))
 359                (t nil))))
 360   ;; Regexp is the default type.
 361   (if (eq type t) (setq type 'r))
 362   ;; Simplify matches...
 363   (cond ((or (eq type 'r) (eq type 's) (eq type nil))
 364          (setq match (if match (gnus-simplify-subject-re match) "")))
 365         ((eq type 'f)
 366          (setq match (gnus-simplify-subject-fuzzy match))))
 367   (let ((score (gnus-score-default score))
 368         (header (downcase header)))
 369     (and prompt (setq match (read-string
 370                              (format "Match %s on %s, %s: "
 371                                      (cond ((eq date 'now)
 372                                             "now")
 373                                            ((stringp date)
 374                                             "temp")
 375                                            (t "permanent"))
 376                                      header
 377                                      (if (< score 0) "lower" "raise"))
 378                              (if (numberp match)
 379                                  (int-to-string match)
 380                                match))))
 381     (and (>= (nth 1 (assoc header gnus-header-index)) 0)
 382          (eq (nth 2 (assoc header gnus-header-index)) 'gnus-score-string)
 383          (not silent)
 384          (gnus-summary-score-effect header match type score))
 385
 386     ;; If this is an integer comparison, we transform from string to int.
 387     (and (eq (nth 2 (assoc header gnus-header-index)) 'gnus-score-integer)
 388          (setq match (string-to-int match)))
 389
 390     (if (eq date 'now)
 391         ()
 392       (and (= score gnus-score-interactive-default-score)
 393            (setq score nil))
 394       (let ((new (cond
 395                   (type
 396                    (list match score (and date (gnus-day-number date)) type))
 397                   (date
 398                    (list match score (gnus-day-number date)))
 399                   (score
 400                    (list match score))
 401                   (t
 402                    (list match))))
 403             (old (gnus-score-get header))
 404             elem)
 405         ;; We see whether we can collapse some score entries.
 406         ;; This isn't quite correct, because there may be more elements
 407         ;; later on with the same key that have matching elems... Hm.
 408         (if (and old
 409                  (setq elem (assoc match old))
 410                  (eq (nth 3 elem) (nth 3 new))
 411                  (or (and (numberp (nth 2 elem)) (numberp (nth 2 new)))
 412                      (and (not (nth 2 elem)) (not (nth 2 new)))))
 413             ;; Yup, we just add this new score to the old elem.
 414             (setcar (cdr elem) (+ (or (nth 1 elem)
 415                                       gnus-score-interactive-default-score)
 416                                   (or (nth 1 new)
 417                                       gnus-score-interactive-default-score)))
 418           ;; Nope, we have to add a new elem.
 419           (gnus-score-set header (if old (cons new old) (list new)))))
 420       (gnus-score-set 'touched '(t)))))
 421
 422 (defun gnus-summary-score-effect (header match type score)
 423   "Simulate the effect of a score file entry.
 424 HEADER is the header being scored.
 425 MATCH is the string we are looking for.
 426 TYPE is a flag indicating if it is a regexp or substring.
 427 SCORE is the score to add."
 428   (interactive (list (completing-read "Header: "
 429                                       gnus-header-index
 430                                       (lambda (x) (fboundp (nth 2 x)))
 431                                       t)
 432                      (read-string "Match: ")
 433                      (y-or-n-p "Use regexp match? ")
 434                      (prefix-numeric-value current-prefix-arg)))
 435   (save-excursion
 436     (or (and (stringp match) (> (length match) 0))
 437         (error "No match"))
 438     (goto-char (point-min))
 439     (let ((regexp (cond ((eq type 'f)
 440                          (gnus-simplify-subject-fuzzy match))
 441                         (type match)
 442                         (t (concat "\\`.*" (regexp-quote match) ".*\\'")))))
 443       (while (not (eobp))
 444         (let ((content (gnus-summary-header header 'noerr))
 445               (case-fold-search t))
 446           (and content
 447                (if (if (eq type 'f)
 448                        (string-equal (gnus-simplify-subject-fuzzy content)
 449                                      regexp)
 450                      (string-match regexp content))
 451                    (gnus-summary-raise-score score))))
 452         (beginning-of-line 2)))))
 453
 454 (defun gnus-summary-score-crossposting (score date)
 455   ;; Enter score file entry for current crossposting.
 456   ;; SCORE is the score to add.
 457   ;; DATE is the expire date.
 458   (let ((xref (gnus-summary-header "xref"))
 459         (start 0)
 460         group)
 461     (or xref (error "This article is not crossposted"))
 462     (while (string-match " \\([^ \t]+\\):" xref start)
 463       (setq start (match-end 0))
 464       (if (not (string=
 465                 (setq group
 466                       (substring xref (match-beginning 1) (match-end 1)))
 467                 gnus-newsgroup-name))
 468           (gnus-summary-score-entry
 469            "xref" (concat " " group ":") nil score date t)))))
 470
 471 \f
 472 ;;;
 473 ;;; Gnus Score Files
 474 ;;;
 475
 476 ;; All score code written by Per Abrahamsen <abraham@iesd.auc.dk>.
 477
 478 ;; Added by Per Abrahamsen <amanda@iesd.auc.dk>.
 479 (defun gnus-score-set-mark-below (score)
 480   "Automatically mark articles with score below SCORE as read."
 481   (interactive
 482    (list (or (and current-prefix-arg (prefix-numeric-value current-prefix-arg))
 483              (string-to-int (read-string "Mark below: ")))))
 484   (setq score (or score gnus-summary-default-score 0))
 485   (gnus-score-set 'mark (list score))
 486   (gnus-score-set 'touched '(t))
 487   (setq gnus-summary-mark-below score)
 488   (gnus-summary-update-lines))
 489
 490 (defun gnus-score-set-expunge-below (score)
 491   "Automatically expunge articles with score below SCORE."
 492   (interactive
 493    (list (or (and current-prefix-arg (prefix-numeric-value current-prefix-arg))
 494              (string-to-int (read-string "Expunge below: ")))))
 495   (setq score (or score gnus-summary-default-score 0))
 496   (gnus-score-set 'expunge (list score))
 497   (gnus-score-set 'touched '(t)))
 498
 499 (defun gnus-score-set (symbol value &optional alist)
 500   ;; Set SYMBOL to VALUE in ALIST.
 501   (let* ((alist
 502           (or alist
 503               gnus-score-alist
 504               (progn
 505                 (gnus-score-load (gnus-score-file-name gnus-newsgroup-name))
 506                 gnus-score-alist)))
 507          (entry (assoc symbol alist)))
 508     (cond ((gnus-score-get 'read-only alist)
 509            ;; This is a read-only score file, so we do nothing.
 510            )
 511           (entry
 512            (setcdr entry value))
 513           ((null alist)
 514            (error "Empty alist"))
 515           (t
 516            (setcdr alist
 517                    (cons (cons symbol value) (cdr alist)))))))
 518
 519 (defun gnus-score-get (symbol &optional alist)
 520   ;; Get SYMBOL's definition in ALIST.
 521   (cdr (assoc symbol
 522               (or alist
 523                   gnus-score-alist
 524                   (progn
 525                     (gnus-score-load
 526                      (gnus-score-file-name gnus-newsgroup-name))
 527                     gnus-score-alist)))))
 528
 529 (defun gnus-score-change-score-file (file)
 530   "Change current score alist."
 531   (interactive
 532    (list (read-file-name "Edit score file: " gnus-kill-files-directory)))
 533   (gnus-score-load-file file)
 534   (gnus-set-mode-line 'summary))
 535
 536 (defun gnus-score-edit-alist (file)
 537   "Edit the current score alist."
 538   (interactive (list gnus-current-score-file))
 539   (let ((winconf (current-window-configuration)))
 540     (and (buffer-name gnus-summary-buffer) (gnus-score-save))
 541     (setq gnus-score-edit-buffer (find-file-noselect file))
 542     (gnus-configure-windows 'edit-score)
 543     (gnus-score-mode)
 544     (make-local-variable 'gnus-prev-winconf)
 545     (setq gnus-prev-winconf winconf))
 546   (gnus-message
 547    4 (substitute-command-keys
 548       "\\<gnus-score-mode-map>\\[gnus-score-edit-done] to save edits")))
 549
 550 (defun gnus-score-edit-file (file)
 551   "Edit a score file."
 552   (interactive
 553    (list (read-file-name "Edit score file: " gnus-kill-files-directory)))
 554   (and (buffer-name gnus-summary-buffer) (gnus-score-save))
 555   (let ((winconf (current-window-configuration)))
 556     (setq gnus-score-edit-buffer (find-file-noselect file))
 557     (gnus-configure-windows 'edit-score)
 558     (gnus-score-mode)
 559     (make-local-variable 'gnus-prev-winconf)
 560     (setq gnus-prev-winconf winconf))
 561   (gnus-message
 562    4 (substitute-command-keys
 563       "\\<gnus-score-mode-map>\\[gnus-score-edit-done] to save edits")))
 564
 565 (defun gnus-score-load-file (file)
 566   ;; Load score file FILE.  Returns a list a retrieved score-alists.
 567   (setq gnus-kill-files-directory (or gnus-kill-files-directory "~/News/"))
 568   (let* ((file (expand-file-name
 569                 (or (and (string-match
 570                           (concat "^" (expand-file-name
 571                                        gnus-kill-files-directory))
 572                           (expand-file-name file))
 573                          file)
 574                     (concat gnus-kill-files-directory file))))
 575          (cached (assoc file gnus-score-cache))
 576          (global (member file gnus-internal-global-score-files))
 577          lists alist)
 578     (if cached
 579         ;; The score file was already loaded.
 580         (setq alist (cdr cached))
 581       ;; We load the score file.
 582       (setq gnus-score-alist nil)
 583       (setq alist (gnus-score-load-score-alist file))
 584       ;; We add '(touched) to the alist to signify that it hasn't been
 585       ;; touched (yet).
 586       (or (assq 'touched alist) (setq alist (cons (list 'touched nil) alist)))
 587       ;; If it is a global score file, we make it read-only.
 588       (and global
 589            (not (assq 'read-only alist))
 590            (setq alist (cons (list 'read-only t) alist)))
 591       ;; Update cache.
 592       (setq gnus-score-cache
 593             (cons (cons file alist) gnus-score-cache)))
 594     ;; If there are actual scores in the alist, we add it to the
 595     ;; return value of this function.
 596     (if (memq t (mapcar (lambda (e) (stringp (car e))) alist))
 597         (setq lists (list alist)))
 598     ;; Treat the other possible atoms in the score alist.
 599     (let ((mark (car (gnus-score-get 'mark alist)))
 600           (expunge (car (gnus-score-get 'expunge alist)))
 601           (mark-and-expunge (car (gnus-score-get 'mark-and-expunge alist)))
 602           (files (gnus-score-get 'files alist))
 603           (exclude-files (gnus-score-get 'exclude-files alist))
 604           (orphan (car (gnus-score-get 'orphan alist)))
 605           (adapt (gnus-score-get 'adapt alist))
 606           (local (gnus-score-get 'local alist))
 607           (eval (car (gnus-score-get 'eval alist))))
 608       ;; We do not respect eval and files atoms from global score
 609       ;; files.
 610       (and files (not global)
 611            (setq lists (apply 'append lists
 612                               (mapcar (lambda (file)
 613                                         (gnus-score-load-file file))
 614                                       files))))
 615       (and eval (not global) (eval eval))
 616       (setq gnus-scores-exclude-files exclude-files)
 617       (if (not local)
 618           ()
 619         (save-excursion
 620           (set-buffer gnus-summary-buffer)
 621           (while local
 622             (and (consp (car local))
 623                  (symbolp (car (car local)))
 624                  (progn
 625                    (make-local-variable (car (car local)))
 626                    (set (car (car local)) (nth 1 (car local)))))
 627             (setq local (cdr local)))))
 628       (if orphan (setq gnus-orphan-score orphan))
 629       (setq gnus-adaptive-score-alist
 630             (cond ((equal adapt '(t))
 631                    (setq gnus-newsgroup-adaptive t)
 632                    gnus-default-adaptive-score-alist)
 633                   ((equal adapt '(ignore))
 634                    (setq gnus-newsgroup-adaptive nil))
 635                   ((consp adapt)
 636                    (setq gnus-newsgroup-adaptive t)
 637                    adapt)
 638                   (t
 639                    ;;(setq gnus-newsgroup-adaptive gnus-use-adaptive-scoring)
 640                    gnus-default-adaptive-score-alist)))
 641       (setq gnus-summary-mark-below
 642             (or mark mark-and-expunge gnus-summary-mark-below))
 643       (setq gnus-summary-expunge-below
 644             (or expunge mark-and-expunge gnus-summary-expunge-below)))
 645     (setq gnus-current-score-file file)
 646     (setq gnus-score-alist alist)
 647     lists))
 648
 649 (defun gnus-score-load (file)
 650   ;; Load score FILE.
 651   (let ((cache (assoc file gnus-score-cache)))
 652     (if cache
 653         (setq gnus-score-alist (cdr cache))
 654       (setq gnus-score-alist nil)
 655       (gnus-score-load-score-alist file)
 656       (or gnus-score-alist
 657           (setq gnus-score-alist (copy-alist '((touched nil)))))
 658       (setq gnus-score-cache
 659             (cons (cons file gnus-score-alist) gnus-score-cache)))))
 660
 661 (defun gnus-score-remove-from-cache (file)
 662   (setq gnus-score-cache
 663         (delq (assoc file gnus-score-cache) gnus-score-cache)))
 664
 665 (defun gnus-score-load-score-alist (file)
 666   (let (alist)
 667     (if (file-readable-p file)
 668         (progn
 669           (save-excursion
 670             (gnus-set-work-buffer)
 671             (insert-file-contents file)
 672             (goto-char (point-min))
 673             ;; Only do the loading if the score file isn't empty.
 674             (if (save-excursion (re-search-forward "[()0-9a-zA-Z]" nil t))
 675                 (setq alist
 676                       (condition-case ()
 677                           (read (current-buffer))
 678                         (error
 679                          (progn
 680                            (gnus-message 3 "Problem with score file %s" file)
 681                            (ding)
 682                            (sit-for 2)
 683                            nil))))))
 684           (if (eq (car alist) 'setq)
 685               (setq gnus-score-alist (gnus-score-transform-old-to-new alist))
 686             (setq gnus-score-alist alist))
 687           (setq gnus-score-alist
 688                 (gnus-score-check-syntax gnus-score-alist file)))
 689       (setq gnus-score-alist nil))))
 690
 691 (defun gnus-score-check-syntax (alist file)
 692   (cond
 693    ((null alist)
 694     nil)
 695    ((not (consp alist))
 696     (gnus-message 1 "Score file is not a list: %s" file)
 697     (ding)
 698     nil)
 699    (t
 700     (let ((a alist)
 701           err)
 702       (while (and a (not err))
 703         (cond ((not (listp (car a)))
 704                (gnus-message 3 "Illegal score element %s in %s" (car a) file)
 705                (setq err t))
 706               ((and (stringp (car (car a)))
 707                     (not (listp (nth 1 (car a)))))
 708                (gnus-message 3 "Illegal header match %s in %s" (nth 1 (car a)) file)
 709                (setq err t))
 710               (t
 711                (setq a (cdr a)))))
 712       (if err
 713           (progn
 714             (ding)
 715             nil)
 716         alist)))))
 717
 718 (defun gnus-score-transform-old-to-new (alist)
 719   (let* ((alist (nth 2 alist))
 720          out entry)
 721     (if (eq (car alist) 'quote)
 722         (setq alist (nth 1 alist)))
 723     (while alist
 724       (setq entry (car alist))
 725       (if (stringp (car entry))
 726           (let ((scor (cdr entry)))
 727             (setq out (cons entry out))
 728             (while scor
 729               (setcar scor
 730                       (list (car (car scor)) (nth 2 (car scor))
 731                             (and (nth 3 (car scor))
 732                                  (gnus-day-number (nth 3 (car scor))))
 733                             (if (nth 1 (car scor)) 'r 's)))
 734               (setq scor (cdr scor))))
 735         (setq out (cons (if (not (listp (cdr entry)))
 736                             (list (car entry) (cdr entry))
 737                           entry)
 738                         out)))
 739       (setq alist (cdr alist)))
 740     (cons (list 'touched t) (nreverse out))))
 741
 742 (defun gnus-score-save ()
 743   ;; Save all score information.
 744   (let ((cache gnus-score-cache))
 745     (save-excursion
 746       (setq gnus-score-alist nil)
 747       (set-buffer (get-buffer-create "*Score*"))
 748       (buffer-disable-undo (current-buffer))
 749       (let (entry score file)
 750         (while cache
 751           (setq entry (car cache)
 752                 cache (cdr cache)
 753                 file (car entry)
 754                 score (cdr entry))
 755           (if (or (not (equal (gnus-score-get 'touched score) '(t)))
 756                   (gnus-score-get 'read-only score)
 757                   (and (file-exists-p file)
 758                        (not (file-writable-p file))))
 759               ()
 760             (setq score (setcdr entry (delq (assq 'touched score) score)))
 761             (erase-buffer)
 762             (let (emacs-lisp-mode-hook)
 763               (if (string-match (concat gnus-adaptive-file-suffix "$") file)
 764                   ;; This is an adaptive score file, so we do not run
 765                   ;; it through `pp'.  These files can get huge, and
 766                   ;; are not meant to be edited by human hands.
 767                   (insert (format "%S" score))
 768                 ;; This is a normal score file, so we print it very
 769                 ;; prettily.
 770                 (pp score (current-buffer))))
 771             (if (not (gnus-make-directory (file-name-directory file)))
 772                 ()
 773               ;; If the score file is empty, we delete it.
 774               (if (zerop (buffer-size))
 775                   (delete-file file)
 776                 ;; There are scores, so we write the file.
 777                 (and (file-writable-p file)
 778                      (write-region (point-min) (point-max)
 779                                    file nil 'silent)))))))
 780       (kill-buffer (current-buffer)))))
 781
 782 (defun gnus-score-headers (score-files &optional trace)
 783   ;; Score `gnus-newsgroup-headers'.
 784   (let (scores)
 785     ;; PLM: probably this is not the best place to clear orphan-score
 786     (setq gnus-orphan-score nil)
 787     ;; Load the score files.
 788     (while score-files
 789       (if (stringp (car score-files))
 790           ;; It is a string, which means that it's a score file name,
 791           ;; so we load the score file and add the score alist to
 792           ;; the list of alists.
 793           (setq scores (nconc (gnus-score-load-file (car score-files)) scores))
 794         ;; It is an alist, so we just add it to the list directly.
 795         (setq scores (nconc (car score-files) scores)))
 796       (setq score-files (cdr score-files)))
 797     ;; Prune the score files that are to be excluded, if any.
 798     (if (not gnus-scores-exclude-files)
 799         ()
 800       (let ((s scores)
 801             c)
 802         (while s
 803           (and (setq c (rassq (car s) gnus-score-cache))
 804                (member (car c) gnus-scores-exclude-files)
 805                (setq scores (delq (car s) scores)))
 806           (setq s (cdr s)))))
 807     (if (not (and gnus-summary-default-score
 808                   scores
 809                   (> (length gnus-newsgroup-headers)
 810                      (length gnus-newsgroup-scored))))
 811         ()
 812       (let* ((entries gnus-header-index)
 813              (now (gnus-day-number (current-time-string)))
 814              (expire (- now gnus-score-expiry-days))
 815              (headers gnus-newsgroup-headers)
 816              (current-score-file gnus-current-score-file)
 817              entry header)
 818         (gnus-message 5 "Scoring...")
 819         ;; Create articles, an alist of the form `(HEADER . SCORE)'.
 820         (while headers
 821           (setq header (car headers)
 822                 headers (cdr headers))
 823           ;; WARNING: The assq makes the function O(N*S) while it could
 824           ;; be written as O(N+S), where N is (length gnus-newsgroup-headers)
 825           ;; and S is (length gnus-newsgroup-scored).
 826           (or (assq (mail-header-number header) gnus-newsgroup-scored)
 827               (setq gnus-scores-articles ;Total of 2 * N cons-cells used.
 828                     (cons (cons header (or gnus-summary-default-score 0))
 829                           gnus-scores-articles))))
 830
 831         (save-excursion
 832           (set-buffer (get-buffer-create "*Headers*"))
 833           (buffer-disable-undo (current-buffer))
 834
 835           ;; Set the global variant of this variable.
 836           (setq gnus-current-score-file current-score-file)
 837           ;; score orphans
 838           (if gnus-orphan-score
 839               (progn
 840                 (setq gnus-score-index
 841                       (nth 1 (assoc "references" gnus-header-index)))
 842                 (gnus-score-orphans gnus-orphan-score)))
 843           ;; Run each header through the score process.
 844           (while entries
 845             (setq entry (car entries)
 846                   header (nth 0 entry)
 847                   entries (cdr entries))
 848             (setq gnus-score-index (nth 1 (assoc header gnus-header-index)))
 849             (if (< 0 (apply 'max (mapcar
 850                                   (lambda (score)
 851                                     (length (gnus-score-get header score)))
 852                                   scores)))
 853                 (funcall (nth 2 entry) scores header now expire trace)))
 854           ;; Remove the buffer.
 855           (kill-buffer (current-buffer)))
 856
 857         ;; Add articles to `gnus-newsgroup-scored'.
 858         (while gnus-scores-articles
 859           (or (= gnus-summary-default-score (cdr (car gnus-scores-articles)))
 860               (setq gnus-newsgroup-scored
 861                     (cons (cons (mail-header-number
 862                                  (car (car gnus-scores-articles)))
 863                                 (cdr (car gnus-scores-articles)))
 864                           gnus-newsgroup-scored)))
 865           (setq gnus-scores-articles (cdr gnus-scores-articles)))
 866
 867         (gnus-message 5 "Scoring...done")))))
 868
 869
 870 (defun gnus-get-new-thread-ids (articles)
 871   (let ((index (nth 1 (assoc "message-id" gnus-header-index)))
 872         (refind gnus-score-index)
 873         id-list art this tref)
 874     (while articles
 875       (setq art (car articles)
 876             this (aref (car art) index)
 877             tref (aref (car art) refind)
 878             articles (cdr articles))
 879       (if (string-equal tref "")        ;no references line
 880           (setq id-list (cons this id-list))))
 881     id-list))
 882
 883 ;; Orphan functions written by plm@atcmp.nl (Peter Mutsaers).
 884 (defun gnus-score-orphans (score)
 885   (let ((new-thread-ids (gnus-get-new-thread-ids gnus-scores-articles))
 886         alike articles art arts this last this-id)
 887
 888     (setq gnus-scores-articles (sort gnus-scores-articles 'gnus-score-string<)
 889           articles gnus-scores-articles)
 890
 891     ;;more or less the same as in gnus-score-string
 892     (erase-buffer)
 893     (while articles
 894       (setq art (car articles)
 895             this (aref (car art) gnus-score-index)
 896             articles (cdr articles))
 897       ;;completely skip if this is empty (not a child, so not an orphan)
 898       (if (not (string= this ""))
 899           (if (equal last this)
 900               ;; O(N*H) cons-cells used here, where H is the number of
 901               ;; headers.
 902               (setq alike (cons art alike))
 903             (if last
 904                 (progn
 905                   ;; Insert the line, with a text property on the
 906                   ;; terminating newline refering to the articles with
 907                   ;; this line.
 908                   (insert last ?\n)
 909                   (put-text-property (1- (point)) (point) 'articles alike)))
 910             (setq alike (list art)
 911                   last this))))
 912     (and last                           ; Bwadr, duplicate code.
 913          (progn
 914            (insert last ?\n)
 915            (put-text-property (1- (point)) (point) 'articles alike)))
 916
 917     ;; PLM: now delete those lines that contain an entry from new-thread-ids
 918     (while new-thread-ids
 919       (setq this-id (car new-thread-ids)
 920             new-thread-ids (cdr new-thread-ids))
 921       (goto-char (point-min))
 922       (while (search-forward this-id nil t)
 923         ;; found a match. remove this line
 924         (beginning-of-line)
 925         (kill-line 1)))
 926
 927     ;; now for each line: update its articles with score by moving to
 928     ;; every end-of-line in the buffer and read the articles property
 929     (goto-char (point-min))
 930     (while (eq 0 (progn
 931                    (end-of-line)
 932                    (setq arts (get-text-property (point) 'articles))
 933                    (while arts
 934                      (setq art (car arts)
 935                            arts (cdr arts))
 936                      (setcdr art (+ score (cdr art))))
 937                    (forward-line))))))
 938
 939
 940 (defun gnus-score-integer (scores header now expire &optional trace)
 941   (let ((gnus-score-index (nth 1 (assoc header gnus-header-index)))
 942         entries alist)
 943
 944     ;; Find matches.
 945     (while scores
 946       (setq alist (car scores)
 947             scores (cdr scores)
 948             entries (assoc header alist))
 949       (while (cdr entries)              ;First entry is the header index.
 950         (let* ((rest (cdr entries))
 951                (kill (car rest))
 952                (match (nth 0 kill))
 953                (type (or (nth 3 kill) '>))
 954                (score (or (nth 1 kill) gnus-score-interactive-default-score))
 955                (date (nth 2 kill))
 956                (found nil)
 957                (match-func (if (or (eq type '>) (eq type '<) (eq type '<=)
 958                                    (eq type '>=) (eq type '=))
 959                                type
 960                              (error "Illegal match type: %s" type)))
 961                (articles gnus-scores-articles))
 962           ;; Instead of doing all the clever stuff that
 963           ;; `gnus-score-string' does to minimize searches and stuff,
 964           ;; I will assume that people generally will put so few
 965           ;; matches on numbers that any cleverness will take more
 966           ;; time than one would gain.
 967           (while articles
 968             (and (funcall match-func
 969                           (or (aref (car (car articles)) gnus-score-index) 0)
 970                           match)
 971                  (progn
 972                    (and trace (setq gnus-score-trace
 973                                     (cons
 974                                      (cons
 975                                       (car-safe (rassq alist gnus-score-cache))
 976                                       kill)
 977                                      gnus-score-trace)))
 978                    (setq found t)
 979                    (setcdr (car articles) (+ score (cdr (car articles))))))
 980             (setq articles (cdr articles)))
 981           ;; Update expire date
 982           (cond ((null date))           ;Permanent entry.
 983                 (found                  ;Match, update date.
 984                  (gnus-score-set 'touched '(t) alist)
 985                  (setcar (nthcdr 2 kill) now))
 986                 ((< date expire)        ;Old entry, remove.
 987                  (gnus-score-set 'touched '(t) alist)
 988                  (setcdr entries (cdr rest))
 989                  (setq rest entries)))
 990           (setq entries rest))))))
 991
 992 (defun gnus-score-date (scores header now expire &optional trace)
 993   (let ((gnus-score-index (nth 1 (assoc header gnus-header-index)))
 994         entries alist)
 995
 996     ;; Find matches.
 997     (while scores
 998       (setq alist (car scores)
 999             scores (cdr scores)
1000             entries (assoc header alist))
1001       (while (cdr entries)              ;First entry is the header index.
1002         (let* ((rest (cdr entries))
1003                (kill (car rest))
1004                (match (timezone-make-date-sortable (nth 0 kill)))
1005                (type (or (nth 3 kill) 'before))
1006                (score (or (nth 1 kill) gnus-score-interactive-default-score))
1007                (date (nth 2 kill))
1008                (found nil)
1009                (match-func
1010                 (cond ((eq type 'after) 'string<)
1011                       ((eq type 'before) 'gnus-string>)
1012                       ((eq type 'at) 'string=)
1013                       (t (error "Illegal match type: %s" type))))
1014                (articles gnus-scores-articles)
1015                l)
1016           ;; Instead of doing all the clever stuff that
1017           ;; `gnus-score-string' does to minimize searches and stuff,
1018           ;; I will assume that people generally will put so few
1019           ;; matches on numbers that any cleverness will take more
1020           ;; time than one would gain.
1021           (while articles
1022             (and
1023              (setq l (aref (car (car articles)) gnus-score-index))
1024              (funcall match-func match (timezone-make-date-sortable l))
1025              (progn
1026                (and trace (setq gnus-score-trace
1027                                 (cons
1028                                  (cons
1029                                   (car-safe (rassq alist gnus-score-cache))
1030                                   kill)
1031                                  gnus-score-trace)))
1032                (setq found t)
1033                (setcdr (car articles) (+ score (cdr (car articles))))))
1034             (setq articles (cdr articles)))
1035           ;; Update expire date
1036           (cond ((null date))           ;Permanent entry.
1037                 (found                  ;Match, update date.
1038                  (gnus-score-set 'touched '(t) alist)
1039                  (setcar (nthcdr 2 kill) now))
1040                 ((< date expire)        ;Old entry, remove.
1041                  (gnus-score-set 'touched '(t) alist)
1042                  (setcdr entries (cdr rest))
1043                  (setq rest entries)))
1044           (setq entries rest))))))
1045
1046 (defun gnus-score-body (scores header now expire &optional trace)
1047   (save-excursion
1048     (set-buffer nntp-server-buffer)
1049     (save-restriction
1050       (let* ((buffer-read-only nil)
1051              (articles gnus-scores-articles)
1052              (last (mail-header-number (car (car gnus-scores-articles))))
1053              (all-scores scores)
1054              (request-func (cond ((string= "head" (downcase header))
1055                                   'gnus-request-head)
1056                                  ((string= "body" (downcase header))
1057                                   'gnus-request-body)
1058                                  (t 'gnus-request-article)))
1059              entries alist ofunc article)
1060         ;; Not all backends support partial fetching.  In that case,
1061         ;; we just fetch the entire article.
1062         (or (gnus-check-backend-function
1063              (and (string-match "^gnus-" (symbol-name request-func))
1064                   (intern (substring (symbol-name request-func)
1065                                      (match-end 0))))
1066              gnus-newsgroup-name)
1067             (progn
1068               (setq ofunc request-func)
1069               (setq request-func 'gnus-request-article)))
1070         (while articles
1071           (setq article (mail-header-number (car (car articles))))
1072           (gnus-message 7 "Scoring on article %s of %s..." article last)
1073           (if (not (funcall request-func article gnus-newsgroup-name))
1074               ()
1075             (widen)
1076             (goto-char (point-min))
1077             ;; If just parts of the article is to be searched, but the
1078             ;; backend didn't support partial fetching, we just narrow
1079             ;; to the relevant parts.
1080             (if ofunc
1081                 (if (eq ofunc 'gnus-request-head)
1082                     (narrow-to-region
1083                      (point)
1084                      (or (search-forward "\n\n" nil t) (point-max)))
1085                   (narrow-to-region
1086                    (or (search-forward "\n\n" nil t) (point))
1087                    (point-max))))
1088             (setq scores all-scores)
1089             ;; Find matches.
1090             (while scores
1091               (setq alist (car scores)
1092                     scores (cdr scores)
1093                     entries (assoc header alist))
1094               (while (cdr entries)      ;First entry is the header index.
1095                 (let* ((rest (cdr entries))
1096                        (kill (car rest))
1097                        (match (nth 0 kill))
1098                        (type (or (nth 3 kill) 's))
1099                        (score (or (nth 1 kill)
1100                                   gnus-score-interactive-default-score))
1101                        (date (nth 2 kill))
1102                        (found nil)
1103                        (case-fold-search
1104                         (not (or (eq type 'R) (eq type 'S)
1105                                  (eq type 'Regexp) (eq type 'String))))
1106                        (search-func
1107                         (cond ((or (eq type 'r) (eq type 'R)
1108                                    (eq type 'regexp) (eq type 'Regexp))
1109                                're-search-forward)
1110                               ((or (eq type 's) (eq type 'S)
1111                                    (eq type 'string) (eq type 'String))
1112                                'search-forward)
1113                               (t
1114                                (error "Illegal match type: %s" type)))))
1115                   (goto-char (point-min))
1116                   (if (funcall search-func match nil t)
1117                       ;; Found a match, update scores.
1118                       (progn
1119                         (setcdr (car articles) (+ score (cdr (car articles))))
1120                         (setq found t)
1121                         (and trace (setq gnus-score-trace
1122                                          (cons
1123                                           (cons
1124                                            (car-safe
1125                                             (rassq alist gnus-score-cache))
1126                                            kill)
1127                                           gnus-score-trace)))))
1128                   ;; Update expire date
1129                   (cond ((null date))   ;Permanent entry.
1130                         (found          ;Match, update date.
1131                          (gnus-score-set 'touched '(t) alist)
1132                          (setcar (nthcdr 2 kill) now))
1133                         ((< date expire) ;Old entry, remove.
1134                          (gnus-score-set 'touched '(t) alist)
1135                          (setcdr entries (cdr rest))
1136                          (setq rest entries)))
1137                   (setq entries rest)))))
1138           (setq articles (cdr articles)))))))
1139
1140
1141
1142 (defun gnus-score-followup (scores header now expire &optional trace)
1143   ;; Insert the unique article headers in the buffer.
1144   (let ((gnus-score-index (nth 1 (assoc header gnus-header-index)))
1145         (current-score-file gnus-current-score-file)
1146         (all-scores scores)
1147         ;; gnus-score-index is used as a free variable.
1148         alike last this art entries alist articles)
1149
1150     ;; Change score file to the adaptive score file.  All entries that
1151     ;; this function makes will be put into this file.
1152     (gnus-score-load-file (gnus-score-file-name
1153                            gnus-newsgroup-name gnus-adaptive-file-suffix))
1154
1155     (setq gnus-scores-articles (sort gnus-scores-articles 'gnus-score-string<)
1156           articles gnus-scores-articles)
1157
1158     (erase-buffer)
1159     (while articles
1160       (setq art (car articles)
1161             this (aref (car art) gnus-score-index)
1162             articles (cdr articles))
1163       (if (equal last this)
1164           (setq alike (cons art alike))
1165         (if last
1166             (progn
1167               (insert last ?\n)
1168               (put-text-property (1- (point)) (point) 'articles alike)))
1169         (setq alike (list art)
1170               last this)))
1171     (and last                           ; Bwadr, duplicate code.
1172          (progn
1173            (insert last ?\n)
1174            (put-text-property (1- (point)) (point) 'articles alike)))
1175
1176     ;; Find matches.
1177     (while scores
1178       (setq alist (car scores)
1179             scores (cdr scores)
1180             entries (assoc header alist))
1181       (while (cdr entries)              ;First entry is the header index.
1182         (let* ((rest (cdr entries))
1183                (kill (car rest))
1184                (match (nth 0 kill))
1185                (type (or (nth 3 kill) 's))
1186                (score (or (nth 1 kill) gnus-score-interactive-default-score))
1187                (date (nth 2 kill))
1188                (found nil)
1189                (mt (aref (symbol-name type) 0))
1190                (case-fold-search
1191                 (not (or (= mt ?R) (= mt ?S) (= mt ?E) (= mt ?F))))
1192                (dmt (downcase mt))
1193                (search-func
1194                 (cond ((= dmt ?r) 're-search-forward)
1195                       ((or (= dmt ?e) (= dmt ?s) (= dmt ?f)) 'search-forward)
1196                       (t (error "Illegal match type: %s" type))))
1197                arts art)
1198           (goto-char (point-min))
1199           (if (= dmt ?e)
1200               (while (funcall search-func match nil t)
1201                 (and (= (progn (beginning-of-line) (point))
1202                         (match-beginning 0))
1203                      (= (progn (end-of-line) (point))
1204                         (match-end 0))
1205                      (progn
1206                        (setq found (setq arts (get-text-property
1207                                                (point) 'articles)))
1208                        ;; Found a match, update scores.
1209                        (while arts
1210                          (setq art (car arts)
1211                                arts (cdr arts))
1212                          (gnus-score-add-followups
1213                           (car art) score all-scores)))))
1214             (while (funcall search-func match nil t)
1215               (end-of-line)
1216               (setq found (setq arts (get-text-property (point) 'articles)))
1217               ;; Found a match, update scores.
1218               (while arts
1219                 (setq art (car arts)
1220                       arts (cdr arts))
1221                 (gnus-score-add-followups (car art) score all-scores))))
1222           ;; Update expire date
1223           (cond ((null date))           ;Permanent entry.
1224                 (found                  ;Match, update date.
1225                  (gnus-score-set 'touched '(t) alist)
1226                  (setcar (nthcdr 2 kill) now))
1227                 ((< date expire)        ;Old entry, remove.
1228                  (gnus-score-set 'touched '(t) alist)
1229                  (setcdr entries (cdr rest))
1230                  (setq rest entries)))
1231           (setq entries rest))))
1232     ;; We change the score file back to the previous one.
1233     (gnus-score-load-file current-score-file)))
1234
1235 (defun gnus-score-add-followups (header score scores)
1236   (save-excursion
1237     (set-buffer gnus-summary-buffer)
1238     (let* ((id (mail-header-id header))
1239            (scores (car scores))
1240            entry dont)
1241       ;; Don't enter a score if there already is one.
1242       (while scores
1243         (setq entry (car scores))
1244         (and (equal "references" (car entry))
1245              (or (null (nth 3 (car (cdr entry))))
1246                  (eq 's (nth 3 (car (cdr entry)))))
1247              (progn
1248                (if (assoc id entry)
1249                    (setq dont t))))
1250         (setq scores (cdr scores)))
1251       (or dont
1252           (gnus-summary-score-entry
1253            "references" id 's score (current-time-string) nil t)))))
1254
1255
1256 (defun gnus-score-string (score-list header now expire &optional trace)
1257   ;; Score ARTICLES according to HEADER in SCORE-LIST.
1258   ;; Update matches entries to NOW and remove unmatched entried older
1259   ;; than EXPIRE.
1260
1261   ;; Insert the unique article headers in the buffer.
1262   (let ((gnus-score-index (nth 1 (assoc header gnus-header-index)))
1263         ;; gnus-score-index is used as a free variable.
1264         alike last this art entries alist articles scores fuzzy)
1265
1266     ;; Sorting the articles costs os O(N*log N) but will allow us to
1267     ;; only match with each unique header.  Thus the actual matching
1268     ;; will be O(M*U) where M is the number of strings to match with,
1269     ;; and U is the number of unique headers.  It is assumed (but
1270     ;; untested) this will be a net win because of the large constant
1271     ;; factor involved with string matching.
1272     (setq gnus-scores-articles (sort gnus-scores-articles 'gnus-score-string<)
1273           articles gnus-scores-articles)
1274
1275     (erase-buffer)
1276     (while articles
1277       (setq art (car articles)
1278             this (aref (car art) gnus-score-index)
1279             articles (cdr articles))
1280       (if (equal last this)
1281           ;; O(N*H) cons-cells used here, where H is the number of
1282           ;; headers.
1283           (setq alike (cons art alike))
1284         (if last
1285             (progn
1286               ;; Insert the line, with a text property on the
1287               ;; terminating newline refering to the articles with
1288               ;; this line.
1289               (insert last ?\n)
1290               (put-text-property (1- (point)) (point) 'articles alike)))
1291         (setq alike (list art)
1292               last this)))
1293     (and last                           ; Bwadr, duplicate code.
1294          (progn
1295            (insert last ?\n)
1296            (put-text-property (1- (point)) (point) 'articles alike)))
1297
1298     ;; Find ordinary matches.
1299     (setq scores score-list)
1300     (while scores
1301       (setq alist (car scores)
1302             scores (cdr scores)
1303             entries (assoc header alist))
1304       (while (cdr entries)              ;First entry is the header index.
1305         (let* ((rest (cdr entries))
1306                (kill (car rest))
1307                (match (nth 0 kill))
1308                (type (or (nth 3 kill) 's))
1309                (score (or (nth 1 kill) gnus-score-interactive-default-score))
1310                (date (nth 2 kill))
1311                (found nil)
1312                (mt (aref (symbol-name type) 0))
1313                (case-fold-search
1314                 (not (or (= mt ?R) (= mt ?S) (= mt ?E) (= mt ?F))))
1315                (dmt (downcase mt))
1316                (search-func
1317                 (cond ((= dmt ?r) 're-search-forward)
1318                       ((or (= dmt ?e) (= dmt ?s) (= dmt ?f)) 'search-forward)
1319                       (t (error "Illegal match type: %s" type))))
1320                arts art)
1321           (if (= dmt ?f)
1322               (setq fuzzy t)
1323             (goto-char (point-min))
1324             (if (= dmt ?e)
1325                 (while (and (not (eobp))
1326                             (funcall search-func match nil t))
1327                   (and (= (progn (beginning-of-line) (point))
1328                           (match-beginning 0))
1329                        (= (progn (end-of-line) (point))
1330                           (match-end 0))
1331                        (progn
1332                          (setq found (setq arts (get-text-property
1333                                                  (point) 'articles)))
1334                          ;; Found a match, update scores.
1335                          (if trace
1336                              (while arts
1337                                (setq art (car arts)
1338                                      arts (cdr arts))
1339                                (setcdr art (+ score (cdr art)))
1340                                (setq gnus-score-trace
1341                                      (cons
1342                                       (cons
1343                                        (car-safe
1344                                         (rassq alist gnus-score-cache))
1345                                        kill)
1346                                       gnus-score-trace)))
1347                            (while arts
1348                              (setq art (car arts)
1349                                    arts (cdr arts))
1350                              (setcdr art (+ score (cdr art)))))))
1351                   (forward-line 1))
1352               (and (string= match "") (setq match "\n"))
1353               (while (and (not (eobp))
1354                           (funcall search-func match nil t))
1355                 (goto-char (match-beginning 0))
1356                 (end-of-line)
1357                 (setq found (setq arts (get-text-property (point) 'articles)))
1358                 ;; Found a match, update scores.
1359                 (if trace
1360                     (while arts
1361                       (setq art (car arts)
1362                             arts (cdr arts))
1363                       (setcdr art (+ score (cdr art)))
1364                       (setq gnus-score-trace
1365                             (cons
1366                              (cons
1367                               (car-safe
1368                                (rassq alist gnus-score-cache))
1369                               kill)
1370                              gnus-score-trace)))
1371                   (while arts
1372                     (setq art (car arts)
1373                           arts (cdr arts))
1374                     (setcdr art (+ score (cdr art)))))
1375                 (forward-line 1)))
1376             ;; Update expire date
1377             (cond ((null date))         ;Permanent entry.
1378                   (found                ;Match, update date.
1379                    (gnus-score-set 'touched '(t) alist)
1380                    (setcar (nthcdr 2 kill) now))
1381                   ((< date expire)      ;Old entry, remove.
1382                    (gnus-score-set 'touched '(t) alist)
1383                    (setcdr entries (cdr rest))
1384                    (setq rest entries))))
1385           (setq entries rest))))
1386
1387     ;; Find fuzzy matches.
1388     (setq scores (and fuzzy score-list))
1389     (if fuzzy (gnus-simplify-buffer-fuzzy))
1390     (while scores
1391       (setq alist (car scores)
1392             scores (cdr scores)
1393             entries (assoc header alist))
1394       (while (cdr entries)              ;First entry is the header index.
1395         (let* ((rest (cdr entries))
1396                (kill (car rest))
1397                (match (nth 0 kill))
1398                (type (or (nth 3 kill) 's))
1399                (score (or (nth 1 kill) gnus-score-interactive-default-score))
1400                (date (nth 2 kill))
1401                (found nil)
1402                (mt (aref (symbol-name type) 0))
1403                (case-fold-search
1404                 (not (or (= mt ?R) (= mt ?S) (= mt ?E) (= mt ?F))))
1405                (dmt (downcase mt))
1406                (search-func
1407                 (cond ((= dmt ?r) 're-search-forward)
1408                       ((or (= dmt ?e) (= dmt ?s) (= dmt ?f)) 'search-forward)
1409                       (t (error "Illegal match type: %s" type))))
1410                arts art)
1411           (if (/= dmt ?f)
1412               ()
1413             (goto-char (point-min))
1414             (while (and (not (eobp))
1415                         (funcall search-func match nil t))
1416               (and (= (progn (beginning-of-line) (point))
1417                       (match-beginning 0))
1418                    (= (progn (end-of-line) (point))
1419                       (match-end 0))
1420                    (progn
1421                      (setq found (setq arts (get-text-property
1422                                              (point) 'articles)))
1423                      ;; Found a match, update scores.
1424                      (if trace
1425                          (while arts
1426                            (setq art (car arts)
1427                                  arts (cdr arts))
1428                            (setcdr art (+ score (cdr art)))
1429                            (setq gnus-score-trace
1430                                  (cons
1431                                   (cons
1432                                    (car-safe
1433                                     (rassq alist gnus-score-cache))
1434                                    kill)
1435                                   gnus-score-trace)))
1436                        (while arts
1437                          (setq art (car arts)
1438                                arts (cdr arts))
1439                          (setcdr art (+ score (cdr art)))))))
1440               (forward-line 1))
1441             ;; Update expire date
1442             (cond ((null date))         ;Permanent entry.
1443                   (found                ;Match, update date.
1444                    (gnus-score-set 'touched '(t) alist)
1445                    (setcar (nthcdr 2 kill) now))
1446                   ((< date expire)      ;Old entry, remove.
1447                    (gnus-score-set 'touched '(t) alist)
1448                    (setcdr entries (cdr rest))
1449                    (setq rest entries))))
1450           (setq entries rest))))))
1451
1452 (defun gnus-score-string< (a1 a2)
1453   ;; Compare headers in articles A2 and A2.
1454   ;; The header index used is the free variable `gnus-score-index'.
1455   (string-lessp (aref (car a1) gnus-score-index)
1456                 (aref (car a2) gnus-score-index)))
1457
1458 (defun gnus-score-build-cons (article)
1459   ;; Build a `gnus-newsgroup-scored' type cons from ARTICLE.
1460   (cons (mail-header-number (car article)) (cdr article)))
1461
1462 (defconst gnus-header-index
1463   ;; Name to index alist.
1464   '(("number" 0 gnus-score-integer)
1465     ("subject" 1 gnus-score-string)
1466     ("from" 2 gnus-score-string)
1467     ("date" 3 gnus-score-date)
1468     ("message-id" 4 gnus-score-string)
1469     ("references" 5 gnus-score-string)
1470     ("chars" 6 gnus-score-integer)
1471     ("lines" 7 gnus-score-integer)
1472     ("xref" 8 gnus-score-string)
1473     ("head" -1 gnus-score-body)
1474     ("body" -1 gnus-score-body)
1475     ("all" -1 gnus-score-body)
1476     ("followup" 2 gnus-score-followup)))
1477
1478 (defun gnus-current-score-file-nondirectory (&optional score-file)
1479   (let ((score-file (or score-file gnus-current-score-file)))
1480     (if score-file
1481         (gnus-short-group-name (file-name-nondirectory score-file))
1482       "none")))
1483
1484 (defun gnus-score-adaptive ()
1485   (save-excursion
1486     (let* ((malist (gnus-copy-sequence gnus-adaptive-score-alist))
1487            (alist malist)
1488            (date (current-time-string))
1489            elem headers match)
1490       ;; First we transform the adaptive rule alist into something
1491       ;; that's faster to process.
1492       (while malist
1493         (setq elem (car malist))
1494         (if (symbolp (car elem))
1495             (setcar elem (symbol-value (car elem))))
1496         (setq elem (cdr elem))
1497         (while elem
1498           (setcdr (car elem)
1499                   (cons (symbol-name (car (car elem))) (cdr (car elem))))
1500           (setcar (car elem)
1501                   (intern
1502                    (concat "gnus-header-"
1503                            (downcase (symbol-name (car (car elem)))))))
1504           (setq elem (cdr elem)))
1505         (setq malist (cdr malist)))
1506       ;; We change the score file to the adaptive score file.
1507       (gnus-score-load-file (gnus-score-file-name
1508                              gnus-newsgroup-name gnus-adaptive-file-suffix))
1509       ;; The we score away.
1510       (goto-char (point-min))
1511       (while (not (eobp))
1512         (setq elem (cdr (assq (gnus-summary-article-mark) alist)))
1513         (if (or (not elem)
1514                 (get-text-property (point) 'gnus-pseudo))
1515             ()
1516           (setq headers (gnus-summary-article-header))
1517           (while (and elem headers)
1518             (setq match (funcall (car (car elem)) headers))
1519             (gnus-summary-score-entry
1520              (nth 1 (car elem)) match
1521              (cond
1522               ((numberp match)
1523                '=)
1524               ((equal (nth 1 (car elem)) "date")
1525                'a)
1526               (t
1527                ;; Whether we use substring or exact matches are controlled
1528                ;; here.
1529                (if (or (not gnus-score-exact-adapt-limit)
1530                        (< (length match) gnus-score-exact-adapt-limit))
1531                    'e
1532                  (if (equal (nth 1 (car elem)) "subject")
1533                      'f 's))))
1534              (nth 2 (car elem)) date nil t)
1535             (setq elem (cdr elem))))
1536         (forward-line 1)))))
1537
1538 (defun gnus-score-remove-lines-adaptive (marks)
1539   (save-excursion
1540     (let* ((malist (gnus-copy-sequence gnus-adaptive-score-alist))
1541            (alist malist)
1542            (date (current-time-string))
1543            (cur-score gnus-current-score-file)
1544            elem headers match)
1545       ;; First we transform the adaptive rule alist into something
1546       ;; that's faster to process.
1547       (while malist
1548         (setq elem (car malist))
1549         (if (symbolp (car elem))
1550             (setcar elem (symbol-value (car elem))))
1551         (setq elem (cdr elem))
1552         (while elem
1553           (setcdr (car elem)
1554                   (cons (symbol-name (car (car elem))) (cdr (car elem))))
1555           (setcar (car elem)
1556                   (intern
1557                    (concat "gnus-header-"
1558                            (downcase (symbol-name (car (car elem)))))))
1559           (setq elem (cdr elem)))
1560         (setq malist (cdr malist)))
1561       ;; The we score away.
1562       (goto-char (point-min))
1563       ;; We change the score file to the adaptive score file.
1564       (gnus-score-load-file (gnus-score-file-name
1565                              gnus-newsgroup-name gnus-adaptive-file-suffix))
1566       (while (re-search-forward marks nil t)
1567         (beginning-of-line)
1568         (setq elem (cdr (assq (gnus-summary-article-mark) alist)))
1569         (if (or (not elem)
1570                 (get-text-property (gnus-point-at-bol) 'gnus-pseudo))
1571             ()
1572           (setq headers (gnus-summary-article-header))
1573           (while elem
1574             (setq match (funcall (car (car elem)) headers))
1575             (gnus-summary-score-entry
1576              (nth 1 (car elem)) match
1577              (if (or (not gnus-score-exact-adapt-limit)
1578                      (< (length match) gnus-score-exact-adapt-limit))
1579                  'e 's)
1580              (nth 2 (car elem)) date nil t)
1581             (setq elem (cdr elem)))))
1582       ;; Switch back to the old score file.
1583       (gnus-score-load-file cur-score))))
1584
1585 ;;;
1586 ;;; Score mode.
1587 ;;;
1588
1589 (defvar gnus-score-mode-map nil)
1590 (defvar gnus-score-mode-hook nil)
1591
1592 (if gnus-score-mode-map
1593     ()
1594   (setq gnus-score-mode-map (copy-keymap emacs-lisp-mode-map))
1595   (define-key gnus-score-mode-map "\C-c\C-c" 'gnus-score-edit-done)
1596   (define-key gnus-score-mode-map "\C-c\C-d" 'gnus-score-edit-insert-date))
1597
1598 (defun gnus-score-mode ()
1599   "Mode for editing score files.
1600 This mode is an extended emacs-lisp mode.
1601
1602 \\{gnus-score-mode-map}"
1603   (interactive)
1604   (kill-all-local-variables)
1605   (use-local-map gnus-score-mode-map)
1606   (set-syntax-table emacs-lisp-mode-syntax-table)
1607   (setq major-mode 'gnus-score-mode)
1608   (setq mode-name "Score")
1609   (lisp-mode-variables nil)
1610   (run-hooks 'emacs-lisp-mode-hook 'gnus-score-mode-hook))
1611
1612 (defun gnus-score-edit-insert-date ()
1613   "Insert date in numerical format."
1614   (interactive)
1615   (insert (int-to-string (gnus-day-number (current-time-string)))))
1616
1617 (defun gnus-score-edit-done ()
1618   "Save the score file and return to the summary buffer."
1619   (interactive)
1620   (let ((bufnam (buffer-file-name (current-buffer)))
1621         (winconf gnus-prev-winconf))
1622     (gnus-make-directory (file-name-directory (buffer-file-name)))
1623     (save-buffer)
1624     (kill-buffer (current-buffer))
1625     (gnus-score-remove-from-cache bufnam)
1626     (gnus-score-load-file bufnam)
1627     (and winconf (set-window-configuration winconf))))
1628
1629 (defun gnus-score-find-trace ()
1630   "Find all score rules applied to this article."
1631   (interactive)
1632   (let ((gnus-newsgroup-headers
1633          (list (gnus-summary-article-header)))
1634         (gnus-newsgroup-scored nil)
1635         (buf (current-buffer))
1636         trace)
1637     (setq gnus-score-trace nil)
1638     (gnus-possibly-score-headers 'trace)
1639     (or (setq trace gnus-score-trace)
1640         (error "No score rules apply to the current article."))
1641     (pop-to-buffer "*Gnus Scores*")
1642     (gnus-add-current-to-buffer-list)
1643     (erase-buffer)
1644     (while trace
1645       (insert (format "%S  ->  %s\n"  (cdr (car trace))
1646                       (file-name-nondirectory (car (car trace)))))
1647       (setq trace (cdr trace)))
1648     (goto-char (point-min))
1649     (pop-to-buffer buf)))
1650
1651
1652 (provide 'gnus-score)
1653
1654 ;;; gnus-score.el ends here