git.chise.org Git - elisp/gnus.git-/blob - lisp/gnus-score.el

   1 1;;; gnus-score.el --- scoring code for Gnus
   2 ;; Copyright (C) 1995,96,97 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 the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24
  25 ;;; Commentary:
  26
  27 ;;; Code:
  28
  29 (eval-when-compile (require 'cl))
  30
  31 (require 'gnus)
  32 (require 'gnus-sum)
  33 (require 'gnus-range)
  34 (require 'message)
  35
  36 (defcustom gnus-global-score-files nil
  37   "List of global score files and directories.
  38 Set this variable if you want to use people's score files.  One entry
  39 for each score file or each score file directory.  Gnus will decide
  40 by itself what score files are applicable to which group.
  41
  42 Say you want to use the single score file
  43 \"/ftp.gnus.org@ftp:/pub/larsi/ding/score/soc.motss.SCORE\" and all
  44 score files in the \"/ftp.some-where:/pub/score\" directory.
  45
  46  (setq gnus-global-score-files
  47        '(\"/ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE\"
  48          \"/ftp.some-where:/pub/score\"))"
  49   :group 'gnus-score-files
  50   :type '(repeat file))
  51
  52 (defcustom gnus-score-file-single-match-alist nil
  53   "Alist mapping regexps to lists of score files.
  54 Each element of this alist should be of the form
  55         (\"REGEXP\" [ \"SCORE-FILE-1\" ] [ \"SCORE-FILE-2\" ] ... )
  56
  57 If the name of a group is matched by REGEXP, the corresponding scorefiles
  58 will be used for that group.
  59 The first match found is used, subsequent matching entries are ignored (to
  60 use multiple matches, see gnus-score-file-multiple-match-alist).
  61
  62 These score files are loaded in addition to any files returned by
  63 gnus-score-find-score-files-function (which see)."
  64   :group 'gnus-score-files
  65   :type '(repeat (cons regexp (repeat file))))
  66
  67 (defcustom gnus-score-file-multiple-match-alist nil
  68   "Alist mapping regexps to lists of score files.
  69 Each element of this alist should be of the form
  70         (\"REGEXP\" [ \"SCORE-FILE-1\" ] [ \"SCORE-FILE-2\" ] ... )
  71
  72 If the name of a group is matched by REGEXP, the corresponding scorefiles
  73 will be used for that group.
  74 If multiple REGEXPs match a group, the score files corresponding to each
  75 match will be used (for only one match to be used, see
  76 gnus-score-file-single-match-alist).
  77
  78 These score files are loaded in addition to any files returned by
  79 gnus-score-find-score-files-function (which see)."
  80   :group 'gnus-score-files
  81   :type '(repeat (cons regexp (repeat file))))
  82
  83 (defcustom gnus-score-file-suffix "SCORE"
  84   "Suffix of the score files."
  85   :group 'gnus-score-files
  86   :type 'string)
  87
  88 (defcustom gnus-adaptive-file-suffix "ADAPT"
  89   "Suffix of the adaptive score files."
  90   :group 'gnus-score-files
  91   :group 'gnus-score-adapt
  92   :type 'string)
  93
  94 (defcustom gnus-score-find-score-files-function 'gnus-score-find-bnews
  95   "Function used to find score files.
  96 The function will be called with the group name as the argument, and
  97 should return a list of score files to apply to that group.  The score
  98 files do not actually have to exist.
  99
 100 Predefined values are:
 101
 102 gnus-score-find-single: Only apply the group's own score file.
 103 gnus-score-find-hierarchical: Also apply score files from parent groups.
 104 gnus-score-find-bnews: Apply score files whose names matches.
 105
 106 See the documentation to these functions for more information.
 107
 108 This variable can also be a list of functions to be called.  Each
 109 function should either return a list of score files, or a list of
 110 score alists."
 111   :group 'gnus-score-files
 112   :type '(radio (function-item gnus-score-find-single)
 113                 (function-item gnus-score-find-hierarchical)
 114                 (function-item gnus-score-find-bnews)
 115                 (function :tag "Other")))
 116
 117 (defcustom gnus-score-interactive-default-score 1000
 118   "*Scoring commands will raise/lower the score with this number as the default."
 119   :group 'gnus-score-default
 120   :type 'integer)
 121
 122 (defcustom gnus-score-expiry-days 7
 123   "*Number of days before unused score file entries are expired.
 124 If this variable is nil, no score file entries will be expired."
 125   :group 'gnus-score-expire
 126   :type '(choice (const :tag "never" nil)
 127                  number))
 128
 129 (defcustom gnus-update-score-entry-dates t
 130   "*In non-nil, update matching score entry dates.
 131 If this variable is nil, then score entries that provide matches
 132 will be expired along with non-matching score entries."
 133   :group 'gnus-score-expire
 134   :type 'boolean)
 135
 136 (defcustom gnus-orphan-score nil
 137   "*All orphans get this score added.  Set in the score file."
 138   :group 'gnus-score-default
 139   :type '(choice (const nil)
 140                  integer))
 141
 142 (defcustom gnus-decay-scores nil
 143   "*If non-nil, decay non-permanent scores."
 144   :group 'gnus-score-decay
 145   :type 'boolean)
 146
 147 (defcustom gnus-decay-score-function 'gnus-decay-score
 148   "*Function called to decay a score.
 149 It is called with one parameter -- the score to be decayed."
 150   :group 'gnus-score-decay
 151   :type '(radio (function-item gnus-decay-score)
 152                 (function :tag "Other")))
 153
 154 (defcustom gnus-score-decay-constant 3
 155   "*Decay all \"small\" scores with this amount."
 156   :group 'gnus-score-decay
 157   :type 'integer)
 158
 159 (defcustom gnus-score-decay-scale .05
 160   "*Decay all \"big\" scores with this factor."
 161   :group 'gnus-score-decay
 162   :type 'number)
 163
 164 (defcustom gnus-home-score-file nil
 165   "Variable to control where interactive score entries are to go.
 166 It can be:
 167
 168  * A string
 169    This file file will be used as the home score file.
 170
 171  * A function
 172    The result of this function will be used as the home score file.
 173    The function will be passed the name of the group as its
 174    parameter.
 175
 176  * A list
 177    The elements in this list can be:
 178
 179    * `(regexp file-name ...)'
 180      If the `regexp' matches the group name, the first `file-name' will
 181      will be used as the home score file.  (Multiple filenames are
 182      allowed so that one may use gnus-score-file-single-match-alist to
 183      set this variable.)
 184
 185    * A function.
 186      If the function returns non-nil, the result will be used
 187      as the home score file.  The function will be passed the
 188      name of the group as its parameter.
 189
 190    * A string.  Use the string as the home score file.
 191
 192    The list will be traversed from the beginning towards the end looking
 193    for matches."
 194   :group 'gnus-score-files
 195   :type '(choice string
 196                  (repeat (choice string
 197                                  (cons regexp (repeat file))
 198                                  function))
 199                  function))
 200
 201 (defcustom gnus-home-adapt-file nil
 202   "Variable to control where new adaptive score entries are to go.
 203 This variable allows the same syntax as `gnus-home-score-file'."
 204   :group 'gnus-score-adapt
 205   :group 'gnus-score-files
 206   :type '(choice string
 207                  (repeat (choice string
 208                                  (cons regexp (repeat file))
 209                                  function))
 210                  function))
 211
 212 (defcustom gnus-default-adaptive-score-alist
 213   '((gnus-kill-file-mark)
 214     (gnus-unread-mark)
 215     (gnus-read-mark (from 3) (subject 30))
 216     (gnus-catchup-mark (subject -10))
 217     (gnus-killed-mark (from -1) (subject -20))
 218     (gnus-del-mark (from -2) (subject -15)))
 219 "Alist of marks and scores."
 220 :group 'gnus-score-adapt
 221 :type '(repeat (cons (symbol :tag "Mark")
 222                      (repeat (list (choice :tag "Header"
 223                                            (const from)
 224                                            (const subject)
 225                                            (symbol :tag "other"))
 226                                    (integer :tag "Score"))))))
 227
 228 (defcustom gnus-ignored-adaptive-words nil
 229   "List of words to be ignored when doing adaptive word scoring."
 230   :group 'gnus-score-adapt
 231   :type '(repeat string))
 232
 233 (defcustom gnus-default-ignored-adaptive-words
 234   '("a" "i" "the" "to" "of" "and" "in" "is" "it" "for" "that" "if" "you"
 235     "this" "be" "on" "with" "not" "have" "are" "or" "as" "from" "can"
 236     "but" "by" "at" "an" "will" "no" "all" "was" "do" "there" "my" "one"
 237     "so" "we" "they" "what" "would" "any" "which" "about" "get" "your"
 238     "use" "some" "me" "then" "name" "like" "out" "when" "up" "time"
 239     "other" "more" "only" "just" "end" "also" "know" "how" "new" "should"
 240     "been" "than" "them" "he" "who" "make" "may" "people" "these" "now"
 241     "their" "here" "into" "first" "could" "way" "had" "see" "work" "well"
 242     "were" "two" "very" "where" "while" "us" "because" "good" "same"
 243     "even" "much" "most" "many" "such" "long" "his" "over" "last" "since"
 244     "right" "before" "our" "without" "too" "those" "why" "must" "part"
 245     "being" "current" "back" "still" "go" "point" "value" "each" "did"
 246     "both" "true" "off" "say" "another" "state" "might" "under" "start"
 247     "try" "re")
 248   "Default list of words to be ignored when doing adaptive word scoring."
 249   :group 'gnus-score-adapt
 250   :type '(repeat string))
 251
 252 (defcustom gnus-default-adaptive-word-score-alist
 253   `((,gnus-read-mark . 30)
 254     (,gnus-catchup-mark . -10)
 255     (,gnus-killed-mark . -20)
 256     (,gnus-del-mark . -15))
 257 "Alist of marks and scores."
 258 :group 'gnus-score-adapt
 259 :type '(repeat (cons (character :tag "Mark")
 260                      (integer :tag "Score"))))
 261
 262 (defcustom gnus-score-mimic-keymap nil
 263   "*Have the score entry functions pretend that they are a keymap."
 264   :group 'gnus-score-default
 265   :type 'boolean)
 266
 267 (defcustom gnus-score-exact-adapt-limit 10
 268   "*Number that says how long a match has to be before using substring matching.
 269 When doing adaptive scoring, one normally uses fuzzy or substring
 270 matching.  However, if the header one matches is short, the possibility
 271 for false positives is great, so if the length of the match is less
 272 than this variable, exact matching will be used.
 273
 274 If this variable is nil, exact matching will always be used."
 275   :group 'gnus-score-adapt
 276   :type '(choice (const nil) integer))
 277
 278 (defcustom gnus-score-uncacheable-files "ADAPT$"
 279   "All score files that match this regexp will not be cached."
 280   :group 'gnus-score-adapt
 281   :group 'gnus-score-files
 282   :type 'regexp)
 283
 284 (defcustom gnus-score-default-header nil
 285   "Default header when entering new scores.
 286
 287 Should be one of the following symbols.
 288
 289  a: from
 290  s: subject
 291  b: body
 292  h: head
 293  i: message-id
 294  t: references
 295  x: xref
 296  l: lines
 297  d: date
 298  f: followup
 299
 300 If nil, the user will be asked for a header."
 301   :group 'gnus-score-default
 302   :type '(choice (const :tag "from" a)
 303                  (const :tag "subject" s)
 304                  (const :tag "body" b)
 305                  (const :tag "head" h)
 306                  (const :tag "message-id" i)
 307                  (const :tag "references" t)
 308                  (const :tag "xref" x)
 309                  (const :tag "lines" l)
 310                  (const :tag "date" d)
 311                  (const :tag "followup" f)
 312                  (const :tag "ask" nil)))
 313
 314 (defcustom gnus-score-default-type nil
 315   "Default match type when entering new scores.
 316
 317 Should be one of the following symbols.
 318
 319  s: substring
 320  e: exact string
 321  f: fuzzy string
 322  r: regexp string
 323  b: before date
 324  a: at date
 325  n: this date
 326  <: less than number
 327  >: greater than number
 328  =: equal to number
 329
 330 If nil, the user will be asked for a match type."
 331   :group 'gnus-score-default
 332   :type '(choice (const :tag "substring" s)
 333                  (const :tag "exact string" e)
 334                  (const :tag "fuzzy string" f)
 335                  (const :tag "regexp string" r)
 336                  (const :tag "before date" b)
 337                  (const :tag "at date" a)
 338                  (const :tag "this date" n)
 339                  (const :tag "less than number" <)
 340                  (const :tag "greater than number" >)
 341                  (const :tag "equal than number" =)
 342                  (const :tag "ask" nil)))
 343
 344 (defcustom gnus-score-default-fold nil
 345   "Use case folding for new score file entries iff not nil."
 346   :group 'gnus-score-default
 347   :type 'boolean)
 348
 349 (defcustom gnus-score-default-duration nil
 350   "Default duration of effect when entering new scores.
 351
 352 Should be one of the following symbols.
 353
 354  t: temporary
 355  p: permanent
 356  i: immediate
 357
 358 If nil, the user will be asked for a duration."
 359   :group 'gnus-score-default
 360   :type '(choice (const :tag "temporary" t)
 361                  (const :tag "permanent" p)
 362                  (const :tag "immediate" i)
 363                  (const :tag "ask" nil)))
 364
 365 (defcustom gnus-score-after-write-file-function nil
 366   "Function called with the name of the score file just written to disk."
 367   :group 'gnus-score-files
 368   :type 'function)
 369
 370 \f
 371
 372 ;; Internal variables.
 373
 374 (defvar gnus-adaptive-word-syntax-table
 375   (let ((table (copy-syntax-table (standard-syntax-table)))
 376         (numbers '(?0 ?1 ?2 ?3 ?4 ?5 ?6 ?7 ?8 ?9)))
 377     (while numbers
 378       (modify-syntax-entry (pop numbers) " " table))
 379     (modify-syntax-entry ?' "w" table)
 380     table)
 381   "Syntax table used when doing adaptive word scoring.")
 382
 383 (defvar gnus-scores-exclude-files nil)
 384 (defvar gnus-internal-global-score-files nil)
 385 (defvar gnus-score-file-list nil)
 386
 387 (defvar gnus-short-name-score-file-cache nil)
 388
 389 (defvar gnus-score-help-winconf nil)
 390 (defvar gnus-adaptive-score-alist gnus-default-adaptive-score-alist)
 391 (defvar gnus-adaptive-word-score-alist gnus-default-adaptive-word-score-alist)
 392 (defvar gnus-score-trace nil)
 393 (defvar gnus-score-edit-buffer nil)
 394
 395 (defvar gnus-score-alist nil
 396   "Alist containing score information.
 397 The keys can be symbols or strings.  The following symbols are defined.
 398
 399 touched: If this alist has been modified.
 400 mark:    Automatically mark articles below this.
 401 expunge: Automatically expunge articles below this.
 402 files:   List of other score files to load when loading this one.
 403 eval:    Sexp to be evaluated when the score file is loaded.
 404
 405 String entries have the form (HEADER (MATCH TYPE SCORE DATE) ...)
 406 where HEADER is the header being scored, MATCH is the string we are
 407 looking for, TYPE is a flag indicating whether it should use regexp or
 408 substring matching, SCORE is the score to add and DATE is the date
 409 of the last successful match.")
 410
 411 (defvar gnus-score-cache nil)
 412 (defvar gnus-scores-articles nil)
 413 (defvar gnus-score-index nil)
 414
 415
 416 (defconst gnus-header-index
 417   ;; Name to index alist.
 418   '(("number" 0 gnus-score-integer)
 419     ("subject" 1 gnus-score-string)
 420     ("from" 2 gnus-score-string)
 421     ("date" 3 gnus-score-date)
 422     ("message-id" 4 gnus-score-string)
 423     ("references" 5 gnus-score-string)
 424     ("chars" 6 gnus-score-integer)
 425     ("lines" 7 gnus-score-integer)
 426     ("xref" 8 gnus-score-string)
 427     ("head" -1 gnus-score-body)
 428     ("body" -1 gnus-score-body)
 429     ("all" -1 gnus-score-body)
 430     ("followup" 2 gnus-score-followup)
 431     ("thread" 5 gnus-score-thread)))
 432
 433 ;;; Summary mode score maps.
 434
 435 (gnus-define-keys (gnus-summary-score-map "V" gnus-summary-mode-map)
 436   "s" gnus-summary-set-score
 437   "a" gnus-summary-score-entry
 438   "S" gnus-summary-current-score
 439   "c" gnus-score-change-score-file
 440   "C" gnus-score-customize
 441   "m" gnus-score-set-mark-below
 442   "x" gnus-score-set-expunge-below
 443   "R" gnus-summary-rescore
 444   "e" gnus-score-edit-current-scores
 445   "f" gnus-score-edit-file
 446   "F" gnus-score-flush-cache
 447   "t" gnus-score-find-trace
 448   "w" gnus-score-find-favourite-words)
 449
 450 ;; Summary score file commands
 451
 452 ;; Much modification of the kill (ahem, score) code and lots of the
 453 ;; functions are written by Per Abrahamsen <amanda@iesd.auc.dk>.
 454
 455 (defun gnus-summary-lower-score (&optional score symp)
 456   "Make a score entry based on the current article.
 457 The user will be prompted for header to score on, match type,
 458 permanence, and the string to be used.  The numerical prefix will be
 459 used as score."
 460   (interactive (gnus-interactive "P\ny"))
 461   (gnus-summary-increase-score (- (gnus-score-default score)) symp))
 462
 463 (defun gnus-score-kill-help-buffer ()
 464   (when (get-buffer "*Score Help*")
 465     (kill-buffer "*Score Help*")
 466     (when gnus-score-help-winconf
 467       (set-window-configuration gnus-score-help-winconf))))
 468
 469 (defun gnus-summary-increase-score (&optional score symp)
 470   "Make a score entry based on the current article.
 471 The user will be prompted for header to score on, match type,
 472 permanence, and the string to be used.  The numerical prefix will be
 473 used as score."
 474   (interactive (gnus-interactive "P\ny"))
 475   (let* ((nscore (gnus-score-default score))
 476          (prefix (if (< nscore 0) ?L ?I))
 477          (increase (> nscore 0))
 478          (char-to-header
 479           '((?a "from" nil nil string)
 480             (?s "subject" nil nil string)
 481             (?b "body" "" nil body-string)
 482             (?h "head" "" nil body-string)
 483             (?i "message-id" nil t string)
 484             (?t "references" "message-id" nil string)
 485             (?x "xref" nil nil string)
 486             (?l "lines" nil nil number)
 487             (?d "date" nil nil date)
 488             (?f "followup" nil nil string)
 489             (?T "thread" nil nil string)))
 490          (char-to-type
 491           '((?s s "substring" string)
 492             (?e e "exact string" string)
 493             (?f f "fuzzy string" string)
 494             (?r r "regexp string" string)
 495             (?z s "substring" body-string)
 496             (?p r "regexp string" body-string)
 497             (?b before "before date" date)
 498             (?a at "at date" date)
 499             (?n now "this date" date)
 500             (?< < "less than number" number)
 501             (?> > "greater than number" number)
 502             (?= = "equal to number" number)))
 503          (current-score-file gnus-current-score-file)
 504          (char-to-perm
 505           (list (list ?t (current-time-string) "temporary")
 506                 '(?p perm "permanent") '(?i now "immediate")))
 507          (mimic gnus-score-mimic-keymap)
 508          (hchar (and gnus-score-default-header
 509                      (aref (symbol-name gnus-score-default-header) 0)))
 510          (tchar (and gnus-score-default-type
 511                      (aref (symbol-name gnus-score-default-type) 0)))
 512          (pchar (and gnus-score-default-duration
 513                      (aref (symbol-name gnus-score-default-duration) 0)))
 514          entry temporary type match)
 515
 516     (unwind-protect
 517         (progn
 518
 519           ;; First we read the header to score.
 520           (while (not hchar)
 521             (if mimic
 522                 (progn
 523                   (sit-for 1)
 524                   (message "%c-" prefix))
 525               (message "%s header (%s?): " (if increase "Increase" "Lower")
 526                        (mapconcat (lambda (s) (char-to-string (car s)))
 527                                   char-to-header "")))
 528             (setq hchar (read-char))
 529             (when (or (= hchar ??) (= hchar ?\C-h))
 530               (setq hchar nil)
 531               (gnus-score-insert-help "Match on header" char-to-header 1)))
 532
 533           (gnus-score-kill-help-buffer)
 534           (unless (setq entry (assq (downcase hchar) char-to-header))
 535             (if mimic (error "%c %c" prefix hchar)
 536               (error "Illegal header type")))
 537
 538           (when (/= (downcase hchar) hchar)
 539             ;; This was a majuscule, so we end reading and set the defaults.
 540             (if mimic (message "%c %c" prefix hchar) (message ""))
 541             (setq tchar (or tchar ?s)
 542                   pchar (or pchar ?t)))
 543
 544           (let ((legal-types
 545                  (delq nil
 546                        (mapcar (lambda (s)
 547                                  (if (eq (nth 4 entry)
 548                                          (nth 3 s))
 549                                      s nil))
 550                                char-to-type))))
 551             ;; We continue reading - the type.
 552             (while (not tchar)
 553               (if mimic
 554                   (progn
 555                     (sit-for 1) (message "%c %c-" prefix hchar))
 556                 (message "%s header '%s' with match type (%s?): "
 557                          (if increase "Increase" "Lower")
 558                          (nth 1 entry)
 559                          (mapconcat (lambda (s) (char-to-string (car s)))
 560                                     legal-types "")))
 561               (setq tchar (read-char))
 562               (when (or (= tchar ??) (= tchar ?\C-h))
 563                 (setq tchar nil)
 564                 (gnus-score-insert-help "Match type" legal-types 2)))
 565
 566             (gnus-score-kill-help-buffer)
 567             (unless (setq type (nth 1 (assq (downcase tchar) legal-types)))
 568               (if mimic (error "%c %c" prefix hchar)
 569                 (error "Illegal match type"))))
 570
 571           (when (/= (downcase tchar) tchar)
 572             ;; It was a majuscule, so we end reading and use the default.
 573             (if mimic (message "%c %c %c" prefix hchar tchar)
 574               (message ""))
 575             (setq pchar (or pchar ?p)))
 576
 577           ;; We continue reading.
 578           (while (not pchar)
 579             (if mimic
 580                 (progn
 581                   (sit-for 1) (message "%c %c %c-" prefix hchar tchar))
 582               (message "%s permanence (%s?): " (if increase "Increase" "Lower")
 583                        (mapconcat (lambda (s) (char-to-string (car s)))
 584                                   char-to-perm "")))
 585             (setq pchar (read-char))
 586             (when (or (= pchar ??) (= pchar ?\C-h))
 587               (setq pchar nil)
 588               (gnus-score-insert-help "Match permanence" char-to-perm 2)))
 589
 590           (gnus-score-kill-help-buffer)
 591           (if mimic (message "%c %c %c" prefix hchar tchar pchar)
 592             (message ""))
 593           (unless (setq temporary (cadr (assq pchar char-to-perm)))
 594             ;; Deal with der(r)ided superannuated paradigms.
 595             (when (and (eq (1+ prefix) 77)
 596                        (eq (+ hchar 12) 109)
 597                        (eq tchar 114)
 598                        (eq (- pchar 4) 111))
 599               (error "You rang?"))
 600             (if mimic
 601                 (error "%c %c %c %c" prefix hchar tchar pchar)
 602               (error "Illegal match duration"))))
 603       ;; Always kill the score help buffer.
 604       (gnus-score-kill-help-buffer))
 605
 606     ;; We have all the data, so we enter this score.
 607     (setq match (if (string= (nth 2 entry) "") ""
 608                   (gnus-summary-header (or (nth 2 entry) (nth 1 entry)))))
 609
 610     ;; Modify the match, perhaps.
 611     (cond
 612      ((equal (nth 1 entry) "xref")
 613       (when (string-match "^Xref: *" match)
 614         (setq match (substring match (match-end 0))))
 615       (when (string-match "^[^:]* +" match)
 616         (setq match (substring match (match-end 0))))))
 617
 618     (when (memq type '(r R regexp Regexp))
 619       (setq match (regexp-quote match)))
 620
 621     ;; Change score file to the "all.SCORE" file.
 622     (when (eq symp 'a)
 623       (save-excursion
 624         (set-buffer gnus-summary-buffer)
 625         (gnus-score-load-file
 626          (gnus-score-file-name "all"))))
 627
 628     (gnus-summary-score-entry
 629      (nth 1 entry)                      ; Header
 630      match                              ; Match
 631      type                               ; Type
 632      (if (eq score 's) nil score)       ; Score
 633      (if (eq temporary 'perm)           ; Temp
 634          nil
 635        temporary)
 636      (not (nth 3 entry)))               ; Prompt
 637
 638     (when (eq symp 'a)
 639       ;; We change the score file back to the previous one.
 640       (save-excursion
 641         (set-buffer gnus-summary-buffer)
 642         (gnus-score-load-file current-score-file)))))
 643
 644 (defun gnus-score-insert-help (string alist idx)
 645   (setq gnus-score-help-winconf (current-window-configuration))
 646   (save-excursion
 647     (set-buffer (get-buffer-create "*Score Help*"))
 648     (buffer-disable-undo (current-buffer))
 649     (delete-windows-on (current-buffer))
 650     (erase-buffer)
 651     (insert string ":\n\n")
 652     (let ((max -1)
 653           (list alist)
 654           (i 0)
 655           n width pad format)
 656       ;; find the longest string to display
 657       (while list
 658         (setq n (length (nth idx (car list))))
 659         (unless (> max n)
 660           (setq max n))
 661         (setq list (cdr list)))
 662       (setq max (+ max 4))              ; %c, `:', SPACE, a SPACE at end
 663       (setq n (/ (1- (window-width)) max)) ; items per line
 664       (setq width (/ (1- (window-width)) n)) ; width of each item
 665       ;; insert `n' items, each in a field of width `width'
 666       (while alist
 667         (if (< i n)
 668             ()
 669           (setq i 0)
 670           (delete-char -1)              ; the `\n' takes a char
 671           (insert "\n"))
 672         (setq pad (- width 3))
 673         (setq format (concat "%c: %-" (int-to-string pad) "s"))
 674         (insert (format format (caar alist) (nth idx (car alist))))
 675         (setq alist (cdr alist))
 676         (setq i (1+ i))))
 677     ;; display ourselves in a small window at the bottom
 678     (gnus-appt-select-lowest-window)
 679     (split-window)
 680     (pop-to-buffer "*Score Help*")
 681     (let ((window-min-height 1))
 682       (shrink-window-if-larger-than-buffer))
 683     (select-window (get-buffer-window gnus-summary-buffer))))
 684
 685 (defun gnus-summary-header (header &optional no-err)
 686   ;; Return HEADER for current articles, or error.
 687   (let ((article (gnus-summary-article-number))
 688         headers)
 689     (if article
 690         (if (and (setq headers (gnus-summary-article-header article))
 691                  (vectorp headers))
 692             (aref headers (nth 1 (assoc header gnus-header-index)))
 693           (if no-err
 694               nil
 695             (error "Pseudo-articles can't be scored")))
 696       (if no-err
 697           (error "No article on current line")
 698         nil))))
 699
 700 (defun gnus-newsgroup-score-alist ()
 701   (or
 702    (let ((param-file (gnus-group-find-parameter
 703                       gnus-newsgroup-name 'score-file)))
 704      (when param-file
 705        (gnus-score-load param-file)))
 706    (gnus-score-load
 707     (gnus-score-file-name gnus-newsgroup-name)))
 708   gnus-score-alist)
 709
 710 (defsubst gnus-score-get (symbol &optional alist)
 711   ;; Get SYMBOL's definition in ALIST.
 712   (cdr (assoc symbol
 713               (or alist
 714                   gnus-score-alist
 715                   (gnus-newsgroup-score-alist)))))
 716
 717 (defun gnus-summary-score-entry (header match type score date
 718                                         &optional prompt silent)
 719   "Enter score file entry.
 720 HEADER is the header being scored.
 721 MATCH is the string we are looking for.
 722 TYPE is the match type: substring, regexp, exact, fuzzy.
 723 SCORE is the score to add.
 724 DATE is the expire date, or nil for no expire, or 'now for immediate expire.
 725 If optional argument `PROMPT' is non-nil, allow user to edit match.
 726 If optional argument `SILENT' is nil, show effect of score entry."
 727   (interactive
 728    (list (completing-read "Header: "
 729                           gnus-header-index
 730                           (lambda (x) (fboundp (nth 2 x)))
 731                           t)
 732          (read-string "Match: ")
 733          (if (y-or-n-p "Use regexp match? ") 'r 's)
 734          (and current-prefix-arg
 735               (prefix-numeric-value current-prefix-arg))
 736          (cond ((not (y-or-n-p "Add to score file? "))
 737                 'now)
 738                ((y-or-n-p "Expire kill? ")
 739                 (current-time-string))
 740                (t nil))))
 741   ;; Regexp is the default type.
 742   (when (eq type t)
 743     (setq type 'r))
 744   ;; Simplify matches...
 745   (cond ((or (eq type 'r) (eq type 's) (eq type nil))
 746          (setq match (if match (gnus-simplify-subject-re match) "")))
 747         ((eq type 'f)
 748          (setq match (gnus-simplify-subject-fuzzy match))))
 749   (let ((score (gnus-score-default score))
 750         (header (format "%s" (downcase header)))
 751         new)
 752     (when prompt
 753       (setq match (read-string
 754                    (format "Match %s on %s, %s: "
 755                            (cond ((eq date 'now)
 756                                   "now")
 757                                  ((stringp date)
 758                                   "temp")
 759                                  (t "permanent"))
 760                            header
 761                            (if (< score 0) "lower" "raise"))
 762                    (if (numberp match)
 763                        (int-to-string match)
 764                      match))))
 765
 766     ;; Get rid of string props.
 767     (setq match (format "%s" match))
 768
 769     ;; If this is an integer comparison, we transform from string to int.
 770     (when (eq (nth 2 (assoc header gnus-header-index)) 'gnus-score-integer)
 771       (setq match (string-to-int match)))
 772
 773     (unless (eq date 'now)
 774       ;; Add the score entry to the score file.
 775       (when (= score gnus-score-interactive-default-score)
 776         (setq score nil))
 777       (let ((old (gnus-score-get header))
 778             elem)
 779         (setq new
 780               (cond
 781                (type
 782                 (list match score
 783                       (and date (if (numberp date) date
 784                                   (gnus-day-number date)))
 785                       type))
 786                (date (list match score (gnus-day-number date)))
 787                (score (list match score))
 788                (t (list match))))
 789         ;; We see whether we can collapse some score entries.
 790         ;; This isn't quite correct, because there may be more elements
 791         ;; later on with the same key that have matching elems...  Hm.
 792         (if (and old
 793                  (setq elem (assoc match old))
 794                  (eq (nth 3 elem) (nth 3 new))
 795                  (or (and (numberp (nth 2 elem)) (numberp (nth 2 new)))
 796                      (and (not (nth 2 elem)) (not (nth 2 new)))))
 797             ;; Yup, we just add this new score to the old elem.
 798             (setcar (cdr elem) (+ (or (nth 1 elem)
 799                                       gnus-score-interactive-default-score)
 800                                   (or (nth 1 new)
 801                                       gnus-score-interactive-default-score)))
 802           ;; Nope, we have to add a new elem.
 803           (gnus-score-set header (if old (cons new old) (list new))))
 804         (gnus-score-set 'touched '(t))))
 805
 806     ;; Score the current buffer.
 807     (unless silent
 808       (if (and (>= (nth 1 (assoc header gnus-header-index)) 0)
 809                (eq (nth 2 (assoc header gnus-header-index))
 810                    'gnus-score-string))
 811           (gnus-summary-score-effect header match type score)
 812         (gnus-summary-rescore)))
 813
 814     ;; Return the new scoring rule.
 815     new))
 816
 817 (defun gnus-summary-score-effect (header match type score)
 818   "Simulate the effect of a score file entry.
 819 HEADER is the header being scored.
 820 MATCH is the string we are looking for.
 821 TYPE is the score type.
 822 SCORE is the score to add."
 823   (interactive (list (completing-read "Header: "
 824                                       gnus-header-index
 825                                       (lambda (x) (fboundp (nth 2 x)))
 826                                       t)
 827                      (read-string "Match: ")
 828                      (y-or-n-p "Use regexp match? ")
 829                      (prefix-numeric-value current-prefix-arg)))
 830   (save-excursion
 831     (unless (and (stringp match) (> (length match) 0))
 832       (error "No match"))
 833     (goto-char (point-min))
 834     (let ((regexp (cond ((eq type 'f)
 835                          (gnus-simplify-subject-fuzzy match))
 836                         ((eq type 'r)
 837                          match)
 838                         ((eq type 'e)
 839                          (concat "\\`" (regexp-quote match) "\\'"))
 840                         (t
 841                          (regexp-quote match)))))
 842       (while (not (eobp))
 843         (let ((content (gnus-summary-header header 'noerr))
 844               (case-fold-search t))
 845           (and content
 846                (when (if (eq type 'f)
 847                          (string-equal (gnus-simplify-subject-fuzzy content)
 848                                        regexp)
 849                        (string-match regexp content))
 850                  (gnus-summary-raise-score score))))
 851         (beginning-of-line 2))))
 852   (gnus-set-mode-line 'summary))
 853
 854 (defun gnus-summary-score-crossposting (score date)
 855   ;; Enter score file entry for current crossposting.
 856   ;; SCORE is the score to add.
 857   ;; DATE is the expire date.
 858   (let ((xref (gnus-summary-header "xref"))
 859         (start 0)
 860         group)
 861     (unless xref
 862       (error "This article is not crossposted"))
 863     (while (string-match " \\([^ \t]+\\):" xref start)
 864       (setq start (match-end 0))
 865       (when (not (string=
 866                   (setq group
 867                         (substring xref (match-beginning 1) (match-end 1)))
 868                   gnus-newsgroup-name))
 869         (gnus-summary-score-entry
 870          "xref" (concat " " group ":") nil score date t)))))
 871
 872 \f
 873 ;;;
 874 ;;; Gnus Score Files
 875 ;;;
 876
 877 ;; All score code written by Per Abrahamsen <abraham@iesd.auc.dk>.
 878
 879 ;; Added by Per Abrahamsen <amanda@iesd.auc.dk>.
 880 (defun gnus-score-set-mark-below (score)
 881   "Automatically mark articles with score below SCORE as read."
 882   (interactive
 883    (list (or (and current-prefix-arg (prefix-numeric-value current-prefix-arg))
 884              (string-to-int (read-string "Mark below: ")))))
 885   (setq score (or score gnus-summary-default-score 0))
 886   (gnus-score-set 'mark (list score))
 887   (gnus-score-set 'touched '(t))
 888   (setq gnus-summary-mark-below score)
 889   (gnus-score-update-lines))
 890
 891 (defun gnus-score-update-lines ()
 892   "Update all lines in the summary buffer."
 893   (save-excursion
 894     (goto-char (point-min))
 895     (while (not (eobp))
 896       (gnus-summary-update-line)
 897       (forward-line 1))))
 898
 899 (defun gnus-score-update-all-lines ()
 900   "Update all lines in the summary buffer, even the hidden ones."
 901   (save-excursion
 902     (goto-char (point-min))
 903     (let (hidden)
 904       (while (not (eobp))
 905         (when (gnus-summary-show-thread)
 906           (push (point) hidden))
 907         (gnus-summary-update-line)
 908         (forward-line 1))
 909       ;; Re-hide the hidden threads.
 910       (while hidden
 911         (goto-char (pop hidden))
 912         (gnus-summary-hide-thread)))))
 913
 914 (defun gnus-score-set-expunge-below (score)
 915   "Automatically expunge articles with score below SCORE."
 916   (interactive
 917    (list (or (and current-prefix-arg (prefix-numeric-value current-prefix-arg))
 918              (string-to-int (read-string "Set expunge below: ")))))
 919   (setq score (or score gnus-summary-default-score 0))
 920   (gnus-score-set 'expunge (list score))
 921   (gnus-score-set 'touched '(t)))
 922
 923 (defun gnus-score-followup-article (&optional score)
 924   "Add SCORE to all followups to the article in the current buffer."
 925   (interactive "P")
 926   (setq score (gnus-score-default score))
 927   (when (gnus-buffer-live-p gnus-summary-buffer)
 928     (save-excursion
 929       (save-restriction
 930         (message-narrow-to-headers)
 931         (let ((id (mail-fetch-field "message-id")))
 932           (when id
 933             (set-buffer gnus-summary-buffer)
 934             (gnus-summary-score-entry
 935              "references" (concat id "[ \t]*$") 'r
 936              score (current-time-string) nil t)))))))
 937
 938 (defun gnus-score-followup-thread (&optional score)
 939   "Add SCORE to all later articles in the thread the current buffer is part of."
 940   (interactive "P")
 941   (setq score (gnus-score-default score))
 942   (when (gnus-buffer-live-p gnus-summary-buffer)
 943     (save-excursion
 944       (save-restriction
 945         (goto-char (point-min))
 946         (let ((id (mail-fetch-field "message-id")))
 947           (when id
 948             (set-buffer gnus-summary-buffer)
 949             (gnus-summary-score-entry
 950              "references" id 's
 951              score (current-time-string))))))))
 952
 953 (defun gnus-score-set (symbol value &optional alist)
 954   ;; Set SYMBOL to VALUE in ALIST.
 955   (let* ((alist
 956           (or alist
 957               gnus-score-alist
 958               (gnus-newsgroup-score-alist)))
 959          (entry (assoc symbol alist)))
 960     (cond ((gnus-score-get 'read-only alist)
 961            ;; This is a read-only score file, so we do nothing.
 962            )
 963           (entry
 964            (setcdr entry value))
 965           ((null alist)
 966            (error "Empty alist"))
 967           (t
 968            (setcdr alist
 969                    (cons (cons symbol value) (cdr alist)))))))
 970
 971 (defun gnus-summary-raise-score (n)
 972   "Raise the score of the current article by N."
 973   (interactive "p")
 974   (gnus-summary-set-score (+ (gnus-summary-article-score)
 975                              (or n gnus-score-interactive-default-score ))))
 976
 977 (defun gnus-summary-set-score (n)
 978   "Set the score of the current article to N."
 979   (interactive "p")
 980   (save-excursion
 981     (gnus-summary-show-thread)
 982     (let ((buffer-read-only nil))
 983       ;; Set score.
 984       (gnus-summary-update-mark
 985        (if (= n (or gnus-summary-default-score 0)) ?
 986          (if (< n (or gnus-summary-default-score 0))
 987              gnus-score-below-mark gnus-score-over-mark))
 988        'score))
 989     (let* ((article (gnus-summary-article-number))
 990            (score (assq article gnus-newsgroup-scored)))
 991       (if score (setcdr score n)
 992         (push (cons article n) gnus-newsgroup-scored)))
 993     (gnus-summary-update-line)))
 994
 995 (defun gnus-summary-current-score ()
 996   "Return the score of the current article."
 997   (interactive)
 998   (gnus-message 1 "%s" (gnus-summary-article-score)))
 999
1000 (defun gnus-score-change-score-file (file)
1001   "Change current score alist."
1002   (interactive
1003    (list (read-file-name "Change to score file: " gnus-kill-files-directory)))
1004   (gnus-score-load-file file)
1005   (gnus-set-mode-line 'summary))
1006
1007 (defvar gnus-score-edit-exit-function)
1008 (defun gnus-score-edit-current-scores (file)
1009   "Edit the current score alist."
1010   (interactive (list gnus-current-score-file))
1011   (if (not gnus-current-score-file)
1012       (error "No current score file")
1013     (let ((winconf (current-window-configuration)))
1014       (when (buffer-name gnus-summary-buffer)
1015         (gnus-score-save))
1016       (gnus-make-directory (file-name-directory file))
1017       (setq gnus-score-edit-buffer (find-file-noselect file))
1018       (gnus-configure-windows 'edit-score)
1019       (gnus-score-mode)
1020       (setq gnus-score-edit-exit-function 'gnus-score-edit-done)
1021       (make-local-variable 'gnus-prev-winconf)
1022       (setq gnus-prev-winconf winconf))
1023     (gnus-message
1024      4 (substitute-command-keys
1025         "\\<gnus-score-mode-map>\\[gnus-score-edit-exit] to save edits"))))
1026
1027 (defun gnus-score-edit-file (file)
1028   "Edit a score file."
1029   (interactive
1030    (list (read-file-name "Edit score file: " gnus-kill-files-directory)))
1031   (gnus-make-directory (file-name-directory file))
1032   (when (buffer-name gnus-summary-buffer)
1033     (gnus-score-save))
1034   (let ((winconf (current-window-configuration)))
1035     (setq gnus-score-edit-buffer (find-file-noselect file))
1036     (gnus-configure-windows 'edit-score)
1037     (gnus-score-mode)
1038     (setq gnus-score-edit-exit-function 'gnus-score-edit-done)
1039     (make-local-variable 'gnus-prev-winconf)
1040     (setq gnus-prev-winconf winconf))
1041   (gnus-message
1042    4 (substitute-command-keys
1043       "\\<gnus-score-mode-map>\\[gnus-score-edit-exit] to save edits")))
1044
1045 (defun gnus-score-load-file (file)
1046   ;; Load score file FILE.  Returns a list a retrieved score-alists.
1047   (let* ((file (expand-file-name
1048                 (or (and (string-match
1049                           (concat "^" (expand-file-name
1050                                        gnus-kill-files-directory))
1051                           (expand-file-name file))
1052                          file)
1053                     (concat (file-name-as-directory gnus-kill-files-directory)
1054                             file))))
1055          (cached (assoc file gnus-score-cache))
1056          (global (member file gnus-internal-global-score-files))
1057          lists alist)
1058     (if cached
1059         ;; The score file was already loaded.
1060         (setq alist (cdr cached))
1061       ;; We load the score file.
1062       (setq gnus-score-alist nil)
1063       (setq alist (gnus-score-load-score-alist file))
1064       ;; We add '(touched) to the alist to signify that it hasn't been
1065       ;; touched (yet).
1066       (unless (assq 'touched alist)
1067         (push (list 'touched nil) alist))
1068       ;; If it is a global score file, we make it read-only.
1069       (and global
1070            (not (assq 'read-only alist))
1071            (push (list 'read-only t) alist))
1072       (push (cons file alist) gnus-score-cache))
1073     (let ((a alist)
1074           found)
1075       (while a
1076         ;; Downcase all header names.
1077         (when (stringp (caar a))
1078           (setcar (car a) (downcase (caar a)))
1079           (setq found t))
1080         (pop a))
1081       ;; If there are actual scores in the alist, we add it to the
1082       ;; return value of this function.
1083       (when found
1084         (setq lists (list alist))))
1085     ;; Treat the other possible atoms in the score alist.
1086     (let ((mark (car (gnus-score-get 'mark alist)))
1087           (expunge (car (gnus-score-get 'expunge alist)))
1088           (mark-and-expunge (car (gnus-score-get 'mark-and-expunge alist)))
1089           (files (gnus-score-get 'files alist))
1090           (exclude-files (gnus-score-get 'exclude-files alist))
1091           (orphan (car (gnus-score-get 'orphan alist)))
1092           (adapt (gnus-score-get 'adapt alist))
1093           (thread-mark-and-expunge
1094            (car (gnus-score-get 'thread-mark-and-expunge alist)))
1095           (adapt-file (car (gnus-score-get 'adapt-file alist)))
1096           (local (gnus-score-get 'local alist))
1097           (decay (car (gnus-score-get 'decay alist)))
1098           (eval (car (gnus-score-get 'eval alist))))
1099       ;; Perform possible decays.
1100       (when (and gnus-decay-scores
1101                  (or cached (file-exists-p file))
1102                  (or (not decay)
1103                      (gnus-decay-scores alist decay)))
1104         (gnus-score-set 'touched '(t) alist)
1105         (gnus-score-set 'decay (list (gnus-time-to-day (current-time)))))
1106       ;; We do not respect eval and files atoms from global score
1107       ;; files.
1108       (when (and files (not global))
1109         (setq lists (apply 'append lists
1110                            (mapcar (lambda (file)
1111                                      (gnus-score-load-file file))
1112                                    (if adapt-file (cons adapt-file files)
1113                                      files)))))
1114       (when (and eval (not global))
1115         (eval eval))
1116       ;; We then expand any exclude-file directives.
1117       (setq gnus-scores-exclude-files
1118             (nconc
1119              (mapcar
1120               (lambda (sfile)
1121                 (expand-file-name sfile (file-name-directory file)))
1122               exclude-files)
1123              gnus-scores-exclude-files))
1124       (unless local
1125         (save-excursion
1126           (set-buffer gnus-summary-buffer)
1127           (while local
1128             (and (consp (car local))
1129                  (symbolp (caar local))
1130                  (progn
1131                    (make-local-variable (caar local))
1132                    (set (caar local) (nth 1 (car local)))))
1133             (setq local (cdr local)))))
1134       (when orphan
1135         (setq gnus-orphan-score orphan))
1136       (setq gnus-adaptive-score-alist
1137             (cond ((equal adapt '(t))
1138                    (setq gnus-newsgroup-adaptive t)
1139                    gnus-default-adaptive-score-alist)
1140                   ((equal adapt '(ignore))
1141                    (setq gnus-newsgroup-adaptive nil))
1142                   ((consp adapt)
1143                    (setq gnus-newsgroup-adaptive t)
1144                    adapt)
1145                   (t
1146                    ;;(setq gnus-newsgroup-adaptive gnus-use-adaptive-scoring)
1147                    gnus-default-adaptive-score-alist)))
1148       (setq gnus-thread-expunge-below
1149             (or thread-mark-and-expunge gnus-thread-expunge-below))
1150       (setq gnus-summary-mark-below
1151             (or mark mark-and-expunge gnus-summary-mark-below))
1152       (setq gnus-summary-expunge-below
1153             (or expunge mark-and-expunge gnus-summary-expunge-below))
1154       (setq gnus-newsgroup-adaptive-score-file
1155             (or adapt-file gnus-newsgroup-adaptive-score-file)))
1156     (setq gnus-current-score-file file)
1157     (setq gnus-score-alist alist)
1158     lists))
1159
1160 (defun gnus-score-load (file)
1161   ;; Load score FILE.
1162   (let ((cache (assoc file gnus-score-cache)))
1163     (if cache
1164         (setq gnus-score-alist (cdr cache))
1165       (setq gnus-score-alist nil)
1166       (gnus-score-load-score-alist file)
1167       (unless gnus-score-alist
1168         (setq gnus-score-alist (copy-alist '((touched nil)))))
1169       (push (cons file gnus-score-alist) gnus-score-cache))))
1170
1171 (defun gnus-score-remove-from-cache (file)
1172   (setq gnus-score-cache
1173         (delq (assoc file gnus-score-cache) gnus-score-cache)))
1174
1175 (defun gnus-score-load-score-alist (file)
1176   "Read score FILE."
1177   (let (alist)
1178     (if (not (file-readable-p file))
1179         ;; Couldn't read file.
1180         (setq gnus-score-alist nil)
1181       ;; Read file.
1182       (save-excursion
1183         (gnus-set-work-buffer)
1184         (insert-file-contents file)
1185         (goto-char (point-min))
1186         ;; Only do the loading if the score file isn't empty.
1187         (when (save-excursion (re-search-forward "[()0-9a-zA-Z]" nil t))
1188           (setq alist
1189                 (condition-case ()
1190                     (read (current-buffer))
1191                   (error
1192                    (gnus-error 3.2 "Problem with score file %s" file))))))
1193       (if (eq (car alist) 'setq)
1194           ;; This is an old-style score file.
1195           (setq gnus-score-alist (gnus-score-transform-old-to-new alist))
1196         (setq gnus-score-alist alist))
1197       ;; Check the syntax of the score file.
1198       (setq gnus-score-alist
1199             (gnus-score-check-syntax gnus-score-alist file)))))
1200
1201 (defun gnus-score-check-syntax (alist file)
1202   "Check the syntax of the score ALIST."
1203   (cond
1204    ((null alist)
1205     nil)
1206    ((not (consp alist))
1207     (gnus-message 1 "Score file is not a list: %s" file)
1208     (ding)
1209     nil)
1210    (t
1211     (let ((a alist)
1212           sr err s type)
1213       (while (and a (not err))
1214         (setq
1215          err
1216          (cond
1217           ((not (listp (car a)))
1218            (format "Illegal score element %s in %s" (car a) file))
1219           ((stringp (caar a))
1220            (cond
1221             ((not (listp (setq sr (cdar a))))
1222              (format "Illegal header match %s in %s" (nth 1 (car a)) file))
1223             (t
1224              (setq type (caar a))
1225              (while (and sr (not err))
1226                (setq s (pop sr))
1227                (setq
1228                 err
1229                 (cond
1230                  ((if (member (downcase type) '("lines" "chars"))
1231                       (not (numberp (car s)))
1232                     (not (stringp (car s))))
1233                   (format "Illegal match %s in %s" (car s) file))
1234                  ((and (cadr s) (not (integerp (cadr s))))
1235                   (format "Non-integer score %s in %s" (cadr s) file))
1236                  ((and (caddr s) (not (integerp (caddr s))))
1237                   (format "Non-integer date %s in %s" (caddr s) file))
1238                  ((and (cadddr s) (not (symbolp (cadddr s))))
1239                   (format "Non-symbol match type %s in %s" (cadddr s) file)))))
1240              err)))))
1241         (setq a (cdr a)))
1242       (if err
1243           (progn
1244             (ding)
1245             (gnus-message 3 err)
1246             (sit-for 2)
1247             nil)
1248         alist)))))
1249
1250 (defun gnus-score-transform-old-to-new (alist)
1251   (let* ((alist (nth 2 alist))
1252          out entry)
1253     (when (eq (car alist) 'quote)
1254       (setq alist (nth 1 alist)))
1255     (while alist
1256       (setq entry (car alist))
1257       (if (stringp (car entry))
1258           (let ((scor (cdr entry)))
1259             (push entry out)
1260             (while scor
1261               (setcar scor
1262                       (list (caar scor) (nth 2 (car scor))
1263                             (and (nth 3 (car scor))
1264                                  (gnus-day-number (nth 3 (car scor))))
1265                             (if (nth 1 (car scor)) 'r 's)))
1266               (setq scor (cdr scor))))
1267         (push (if (not (listp (cdr entry)))
1268                   (list (car entry) (cdr entry))
1269                 entry)
1270               out))
1271       (setq alist (cdr alist)))
1272     (cons (list 'touched t) (nreverse out))))
1273
1274 (defun gnus-score-save ()
1275   ;; Save all score information.
1276   (let ((cache gnus-score-cache)
1277         entry score file)
1278     (save-excursion
1279       (setq gnus-score-alist nil)
1280       (nnheader-set-temp-buffer " *Gnus Scores*")
1281       (while cache
1282         (current-buffer)
1283         (setq entry (pop cache)
1284               file (car entry)
1285               score (cdr entry))
1286         (if (or (not (equal (gnus-score-get 'touched score) '(t)))
1287                 (gnus-score-get 'read-only score)
1288                 (and (file-exists-p file)
1289                      (not (file-writable-p file))))
1290             ()
1291           (setq score (setcdr entry (delq (assq 'touched score) score)))
1292           (erase-buffer)
1293           (let (emacs-lisp-mode-hook)
1294             (if (string-match
1295                  (concat (regexp-quote gnus-adaptive-file-suffix) "$")
1296                  file)
1297                 ;; This is an adaptive score file, so we do not run
1298                 ;; it through `pp'.  These files can get huge, and
1299                 ;; are not meant to be edited by human hands.
1300                 (gnus-prin1 score)
1301               ;; This is a normal score file, so we print it very
1302               ;; prettily.
1303               (pp score (current-buffer))))
1304           (gnus-make-directory (file-name-directory file))
1305           ;; If the score file is empty, we delete it.
1306           (if (zerop (buffer-size))
1307               (delete-file file)
1308             ;; There are scores, so we write the file.
1309             (when (file-writable-p file)
1310               (gnus-write-buffer file)
1311               (when gnus-score-after-write-file-function
1312                 (funcall gnus-score-after-write-file-function file)))))
1313         (and gnus-score-uncacheable-files
1314              (string-match gnus-score-uncacheable-files file)
1315              (gnus-score-remove-from-cache file)))
1316       (kill-buffer (current-buffer)))))
1317
1318 (defun gnus-score-load-files (score-files)
1319   "Load all score files in SCORE-FILES."
1320   ;; Load the score files.
1321   (let (scores)
1322     (while score-files
1323       (if (stringp (car score-files))
1324           ;; It is a string, which means that it's a score file name,
1325           ;; so we load the score file and add the score alist to
1326           ;; the list of alists.
1327           (setq scores (nconc (gnus-score-load-file (car score-files)) scores))
1328         ;; It is an alist, so we just add it to the list directly.
1329         (setq scores (nconc (car score-files) scores)))
1330       (setq score-files (cdr score-files)))
1331     ;; Prune the score files that are to be excluded, if any.
1332     (when gnus-scores-exclude-files
1333       (let ((s scores)
1334             c)
1335         (while s
1336           (and (setq c (rassq (car s) gnus-score-cache))
1337                (member (car c) gnus-scores-exclude-files)
1338                (setq scores (delq (car s) scores)))
1339           (setq s (cdr s)))))
1340     scores))
1341
1342 (defun gnus-score-headers (score-files &optional trace)
1343   ;; Score `gnus-newsgroup-headers'.
1344   (let (scores news)
1345     ;; PLM: probably this is not the best place to clear orphan-score
1346     (setq gnus-orphan-score nil
1347           gnus-scores-articles nil
1348           gnus-scores-exclude-files nil
1349           scores (gnus-score-load-files score-files))
1350     (setq news scores)
1351     ;; Do the scoring.
1352     (while news
1353       (setq scores news
1354             news nil)
1355       (when (and gnus-summary-default-score
1356                  scores)
1357         (let* ((entries gnus-header-index)
1358                (now (gnus-day-number (current-time-string)))
1359                (expire (and gnus-score-expiry-days
1360                             (- now gnus-score-expiry-days)))
1361                (headers gnus-newsgroup-headers)
1362                (current-score-file gnus-current-score-file)
1363                entry header new)
1364           (gnus-message 5 "Scoring...")
1365           ;; Create articles, an alist of the form `(HEADER . SCORE)'.
1366           (while (setq header (pop headers))
1367             ;; WARNING: The assq makes the function O(N*S) while it could
1368             ;; be written as O(N+S), where N is (length gnus-newsgroup-headers)
1369             ;; and S is (length gnus-newsgroup-scored).
1370             (unless (assq (mail-header-number header) gnus-newsgroup-scored)
1371               (setq gnus-scores-articles ;Total of 2 * N cons-cells used.
1372                     (cons (cons header (or gnus-summary-default-score 0))
1373                           gnus-scores-articles))))
1374
1375           (save-excursion
1376             (set-buffer (get-buffer-create "*Headers*"))
1377             (buffer-disable-undo (current-buffer))
1378             (when (gnus-buffer-live-p gnus-summary-buffer)
1379               (message-clone-locals gnus-summary-buffer))
1380
1381             ;; Set the global variant of this variable.
1382             (setq gnus-current-score-file current-score-file)
1383             ;; score orphans
1384             (when gnus-orphan-score
1385               (setq gnus-score-index
1386                     (nth 1 (assoc "references" gnus-header-index)))
1387               (gnus-score-orphans gnus-orphan-score))
1388             ;; Run each header through the score process.
1389             (while entries
1390               (setq entry (pop entries)
1391                     header (nth 0 entry)
1392                     gnus-score-index (nth 1 (assoc header gnus-header-index)))
1393               (when (< 0 (apply 'max (mapcar
1394                                       (lambda (score)
1395                                         (length (gnus-score-get header score)))
1396                                       scores)))
1397                 ;; Call the scoring function for this type of "header".
1398                 (when (setq new (funcall (nth 2 entry) scores header
1399                                          now expire trace))
1400                   (push new news))))
1401             ;; Remove the buffer.
1402             (kill-buffer (current-buffer)))
1403
1404           ;; Add articles to `gnus-newsgroup-scored'.
1405           (while gnus-scores-articles
1406             (when (or (/= gnus-summary-default-score
1407                           (cdar gnus-scores-articles))
1408                       gnus-save-score)
1409               (push (cons (mail-header-number (caar gnus-scores-articles))
1410                           (cdar gnus-scores-articles))
1411                     gnus-newsgroup-scored))
1412             (setq gnus-scores-articles (cdr gnus-scores-articles)))
1413
1414           (let (score)
1415             (while (setq score (pop scores))
1416               (while score
1417                 (when (listp (caar score))
1418                   (gnus-score-advanced (car score) trace))
1419                 (pop score))))
1420
1421           (gnus-message 5 "Scoring...done"))))))
1422
1423
1424 (defun gnus-get-new-thread-ids (articles)
1425   (let ((index (nth 1 (assoc "message-id" gnus-header-index)))
1426         (refind gnus-score-index)
1427         id-list art this tref)
1428     (while articles
1429       (setq art (car articles)
1430             this (aref (car art) index)
1431             tref (aref (car art) refind)
1432             articles (cdr articles))
1433       (when (string-equal tref "")      ;no references line
1434         (push this id-list)))
1435     id-list))
1436
1437 ;; Orphan functions written by plm@atcmp.nl (Peter Mutsaers).
1438 (defun gnus-score-orphans (score)
1439   (let ((new-thread-ids (gnus-get-new-thread-ids gnus-scores-articles))
1440         alike articles art arts this last this-id)
1441
1442     (setq gnus-scores-articles (sort gnus-scores-articles 'gnus-score-string<)
1443           articles gnus-scores-articles)
1444
1445     ;;more or less the same as in gnus-score-string
1446     (erase-buffer)
1447     (while articles
1448       (setq art (car articles)
1449             this (aref (car art) gnus-score-index)
1450             articles (cdr articles))
1451       ;;completely skip if this is empty (not a child, so not an orphan)
1452       (when (not (string= this ""))
1453         (if (equal last this)
1454             ;; O(N*H) cons-cells used here, where H is the number of
1455             ;; headers.
1456             (push art alike)
1457           (when last
1458             ;; Insert the line, with a text property on the
1459             ;; terminating newline referring to the articles with
1460             ;; this line.
1461             (insert last ?\n)
1462             (put-text-property (1- (point)) (point) 'articles alike))
1463           (setq alike (list art)
1464                 last this))))
1465     (when last                          ; Bwadr, duplicate code.
1466       (insert last ?\n)
1467       (put-text-property (1- (point)) (point) 'articles alike))
1468
1469     ;; PLM: now delete those lines that contain an entry from new-thread-ids
1470     (while new-thread-ids
1471       (setq this-id (car new-thread-ids)
1472             new-thread-ids (cdr new-thread-ids))
1473       (goto-char (point-min))
1474       (while (search-forward this-id nil t)
1475         ;; found a match.  remove this line
1476         (beginning-of-line)
1477         (kill-line 1)))
1478
1479     ;; now for each line: update its articles with score by moving to
1480     ;; every end-of-line in the buffer and read the articles property
1481     (goto-char (point-min))
1482     (while (eq 0 (progn
1483                    (end-of-line)
1484                    (setq arts (get-text-property (point) 'articles))
1485                    (while arts
1486                      (setq art (car arts)
1487                            arts (cdr arts))
1488                      (setcdr art (+ score (cdr art))))
1489                    (forward-line))))))
1490
1491
1492 (defun gnus-score-integer (scores header now expire &optional trace)
1493   (let ((gnus-score-index (nth 1 (assoc header gnus-header-index)))
1494         entries alist)
1495
1496     ;; Find matches.
1497     (while scores
1498       (setq alist (car scores)
1499             scores (cdr scores)
1500             entries (assoc header alist))
1501       (while (cdr entries)              ;First entry is the header index.
1502         (let* ((rest (cdr entries))
1503                (kill (car rest))
1504                (match (nth 0 kill))
1505                (type (or (nth 3 kill) '>))
1506                (score (or (nth 1 kill) gnus-score-interactive-default-score))
1507                (date (nth 2 kill))
1508                (found nil)
1509                (match-func (if (or (eq type '>) (eq type '<) (eq type '<=)
1510                                    (eq type '>=) (eq type '=))
1511                                type
1512                              (error "Illegal match type: %s" type)))
1513                (articles gnus-scores-articles))
1514           ;; Instead of doing all the clever stuff that
1515           ;; `gnus-score-string' does to minimize searches and stuff,
1516           ;; I will assume that people generally will put so few
1517           ;; matches on numbers that any cleverness will take more
1518           ;; time than one would gain.
1519           (while articles
1520             (when (funcall match-func
1521                            (or (aref (caar articles) gnus-score-index) 0)
1522                            match)
1523               (when trace
1524                 (push (cons (car-safe (rassq alist gnus-score-cache)) kill)
1525                       gnus-score-trace))
1526               (setq found t)
1527               (setcdr (car articles) (+ score (cdar articles))))
1528             (setq articles (cdr articles)))
1529           ;; Update expire date
1530           (cond ((null date))           ;Permanent entry.
1531                 ((and found gnus-update-score-entry-dates) ;Match, update date.
1532                  (gnus-score-set 'touched '(t) alist)
1533                  (setcar (nthcdr 2 kill) now))
1534                 ((and expire (< date expire)) ;Old entry, remove.
1535                  (gnus-score-set 'touched '(t) alist)
1536                  (setcdr entries (cdr rest))
1537                  (setq rest entries)))
1538           (setq entries rest)))))
1539   nil)
1540
1541 (defun gnus-score-date (scores header now expire &optional trace)
1542   (let ((gnus-score-index (nth 1 (assoc header gnus-header-index)))
1543         entries alist match match-func article)
1544
1545     ;; Find matches.
1546     (while scores
1547       (setq alist (car scores)
1548             scores (cdr scores)
1549             entries (assoc header alist))
1550       (while (cdr entries)              ;First entry is the header index.
1551         (let* ((rest (cdr entries))
1552                (kill (car rest))
1553                (type (or (nth 3 kill) 'before))
1554                (score (or (nth 1 kill) gnus-score-interactive-default-score))
1555                (date (nth 2 kill))
1556                (found nil)
1557                (articles gnus-scores-articles)
1558                l)
1559           (cond
1560            ((eq type 'after)
1561             (setq match-func 'string<
1562                   match (gnus-date-iso8601 (nth 0 kill))))
1563            ((eq type 'before)
1564             (setq match-func 'gnus-string>
1565                   match (gnus-date-iso8601 (nth 0 kill))))
1566            ((eq type 'at)
1567             (setq match-func 'string=
1568                   match (gnus-date-iso8601 (nth 0 kill))))
1569            ((eq type 'regexp)
1570             (setq match-func 'string-match
1571                   match (nth 0 kill)))
1572            (t (error "Illegal match type: %s" type)))
1573           ;; Instead of doing all the clever stuff that
1574           ;; `gnus-score-string' does to minimize searches and stuff,
1575           ;; I will assume that people generally will put so few
1576           ;; matches on numbers that any cleverness will take more
1577           ;; time than one would gain.
1578           (while (setq article (pop articles))
1579             (when (and
1580                    (setq l (aref (car article) gnus-score-index))
1581                    (funcall match-func match (gnus-date-iso8601 l)))
1582               (when trace
1583                 (push (cons (car-safe (rassq alist gnus-score-cache)) kill)
1584                       gnus-score-trace))
1585               (setq found t)
1586               (setcdr article (+ score (cdr article)))))
1587           ;; Update expire date
1588           (cond ((null date))           ;Permanent entry.
1589                 ((and found gnus-update-score-entry-dates) ;Match, update date.
1590                  (gnus-score-set 'touched '(t) alist)
1591                  (setcar (nthcdr 2 kill) now))
1592                 ((and expire (< date expire)) ;Old entry, remove.
1593                  (gnus-score-set 'touched '(t) alist)
1594                  (setcdr entries (cdr rest))
1595                  (setq rest entries)))
1596           (setq entries rest)))))
1597   nil)
1598
1599 (defun gnus-score-body (scores header now expire &optional trace)
1600   (save-excursion
1601     (setq gnus-scores-articles
1602           (sort gnus-scores-articles
1603                 (lambda (a1 a2)
1604                   (< (mail-header-number (car a1))
1605                      (mail-header-number (car a2))))))
1606     (set-buffer nntp-server-buffer)
1607     (save-restriction
1608       (let* ((buffer-read-only nil)
1609              (articles gnus-scores-articles)
1610              (all-scores scores)
1611              (request-func (cond ((string= "head" header)
1612                                   'gnus-request-head)
1613                                  ((string= "body" header)
1614                                   'gnus-request-body)
1615                                  (t 'gnus-request-article)))
1616              entries alist ofunc article last)
1617         (when articles
1618           (setq last (mail-header-number (caar (last articles))))
1619           ;; Not all backends support partial fetching.  In that case,
1620           ;; we just fetch the entire article.
1621           (unless (gnus-check-backend-function
1622                    (and (string-match "^gnus-" (symbol-name request-func))
1623                         (intern (substring (symbol-name request-func)
1624                                            (match-end 0))))
1625                    gnus-newsgroup-name)
1626             (setq ofunc request-func)
1627             (setq request-func 'gnus-request-article))
1628           (while articles
1629             (setq article (mail-header-number (caar articles)))
1630             (gnus-message 7 "Scoring on article %s of %s..." article last)
1631             (when (funcall request-func article gnus-newsgroup-name)
1632               (widen)
1633               (goto-char (point-min))
1634               ;; If just parts of the article is to be searched, but the
1635               ;; backend didn't support partial fetching, we just narrow
1636               ;; to the relevant parts.
1637               (when ofunc
1638                 (if (eq ofunc 'gnus-request-head)
1639                     (narrow-to-region
1640                      (point)
1641                      (or (search-forward "\n\n" nil t) (point-max)))
1642                   (narrow-to-region
1643                    (or (search-forward "\n\n" nil t) (point))
1644                    (point-max))))
1645               (setq scores all-scores)
1646               ;; Find matches.
1647               (while scores
1648                 (setq alist (pop scores)
1649                       entries (assoc header alist))
1650                 (while (cdr entries)    ;First entry is the header index.
1651                   (let* ((rest (cdr entries))
1652                          (kill (car rest))
1653                          (match (nth 0 kill))
1654                          (type (or (nth 3 kill) 's))
1655                          (score (or (nth 1 kill)
1656                                     gnus-score-interactive-default-score))
1657                          (date (nth 2 kill))
1658                          (found nil)
1659                          (case-fold-search
1660                           (not (or (eq type 'R) (eq type 'S)
1661                                    (eq type 'Regexp) (eq type 'String))))
1662                          (search-func
1663                           (cond ((or (eq type 'r) (eq type 'R)
1664                                      (eq type 'regexp) (eq type 'Regexp))
1665                                  're-search-forward)
1666                                 ((or (eq type 's) (eq type 'S)
1667                                      (eq type 'string) (eq type 'String))
1668                                  'search-forward)
1669                                 (t
1670                                  (error "Illegal match type: %s" type)))))
1671                     (goto-char (point-min))
1672                     (when (funcall search-func match nil t)
1673                       ;; Found a match, update scores.
1674                       (setcdr (car articles) (+ score (cdar articles)))
1675                       (setq found t)
1676                       (when trace
1677                         (push
1678                          (cons (car-safe (rassq alist gnus-score-cache)) kill)
1679                          gnus-score-trace)))
1680                     ;; Update expire date
1681                     (unless trace
1682                       (cond
1683                        ((null date))    ;Permanent entry.
1684                        ((and found gnus-update-score-entry-dates)
1685                         ;; Match, update date.
1686                         (gnus-score-set 'touched '(t) alist)
1687                         (setcar (nthcdr 2 kill) now))
1688                        ((and expire (< date expire)) ;Old entry, remove.
1689                         (gnus-score-set 'touched '(t) alist)
1690                         (setcdr entries (cdr rest))
1691                         (setq rest entries))))
1692                     (setq entries rest)))))
1693             (setq articles (cdr articles)))))))
1694   nil)
1695
1696 (defun gnus-score-thread (scores header now expire &optional trace)
1697   (gnus-score-followup scores header now expire trace t))
1698
1699 (defun gnus-score-followup (scores header now expire &optional trace thread)
1700   ;; Insert the unique article headers in the buffer.
1701   (let ((gnus-score-index (nth 1 (assoc header gnus-header-index)))
1702         (current-score-file gnus-current-score-file)
1703         (all-scores scores)
1704         ;; gnus-score-index is used as a free variable.
1705         alike last this art entries alist articles
1706         new news)
1707
1708     ;; Change score file to the adaptive score file.  All entries that
1709     ;; this function makes will be put into this file.
1710     (save-excursion
1711       (set-buffer gnus-summary-buffer)
1712       (gnus-score-load-file
1713        (or gnus-newsgroup-adaptive-score-file
1714            (gnus-score-file-name
1715             gnus-newsgroup-name gnus-adaptive-file-suffix))))
1716
1717     (setq gnus-scores-articles (sort gnus-scores-articles 'gnus-score-string<)
1718           articles gnus-scores-articles)
1719
1720     (erase-buffer)
1721     (while articles
1722       (setq art (car articles)
1723             this (aref (car art) gnus-score-index)
1724             articles (cdr articles))
1725       (if (equal last this)
1726           (push art alike)
1727         (when last
1728           (insert last ?\n)
1729           (put-text-property (1- (point)) (point) 'articles alike))
1730         (setq alike (list art)
1731               last this)))
1732     (when last                          ; Bwadr, duplicate code.
1733       (insert last ?\n)
1734       (put-text-property (1- (point)) (point) 'articles alike))
1735
1736     ;; Find matches.
1737     (while scores
1738       (setq alist (car scores)
1739             scores (cdr scores)
1740             entries (assoc header alist))
1741       (while (cdr entries)              ;First entry is the header index.
1742         (let* ((rest (cdr entries))
1743                (kill (car rest))
1744                (match (nth 0 kill))
1745                (type (or (nth 3 kill) 's))
1746                (score (or (nth 1 kill) gnus-score-interactive-default-score))
1747                (date (nth 2 kill))
1748                (found nil)
1749                (mt (aref (symbol-name type) 0))
1750                (case-fold-search
1751                 (not (or (= mt ?R) (= mt ?S) (= mt ?E) (= mt ?F))))
1752                (dmt (downcase mt))
1753                (search-func
1754                 (cond ((= dmt ?r) 're-search-forward)
1755                       ((or (= dmt ?e) (= dmt ?s) (= dmt ?f)) 'search-forward)
1756                       (t (error "Illegal match type: %s" type))))
1757                arts art)
1758           (goto-char (point-min))
1759           (if (= dmt ?e)
1760               (while (funcall search-func match nil t)
1761                 (and (= (progn (beginning-of-line) (point))
1762                         (match-beginning 0))
1763                      (= (progn (end-of-line) (point))
1764                         (match-end 0))
1765                      (progn
1766                        (setq found (setq arts (get-text-property
1767                                                (point) 'articles)))
1768                        ;; Found a match, update scores.
1769                        (while arts
1770                          (setq art (car arts)
1771                                arts (cdr arts))
1772                          (gnus-score-add-followups
1773                           (car art) score all-scores thread))))
1774                 (end-of-line))
1775             (while (funcall search-func match nil t)
1776               (end-of-line)
1777               (setq found (setq arts (get-text-property (point) 'articles)))
1778               ;; Found a match, update scores.
1779               (while (setq art (pop arts))
1780                 (when (setq new (gnus-score-add-followups
1781                                  (car art) score all-scores thread))
1782                   (push new news)))))
1783           ;; Update expire date
1784           (cond ((null date))           ;Permanent entry.
1785                 ((and found gnus-update-score-entry-dates) ;Match, update date.
1786                  (gnus-score-set 'touched '(t) alist)
1787                  (setcar (nthcdr 2 kill) now))
1788                 ((and expire (< date expire)) ;Old entry, remove.
1789                  (gnus-score-set 'touched '(t) alist)
1790                  (setcdr entries (cdr rest))
1791                  (setq rest entries)))
1792           (setq entries rest))))
1793     ;; We change the score file back to the previous one.
1794     (save-excursion
1795       (set-buffer gnus-summary-buffer)
1796       (gnus-score-load-file current-score-file))
1797     (list (cons "references" news))))
1798
1799 (defun gnus-score-add-followups (header score scores &optional thread)
1800   "Add a score entry to the adapt file."
1801   (save-excursion
1802     (set-buffer gnus-summary-buffer)
1803     (let* ((id (mail-header-id header))
1804            (scores (car scores))
1805            entry dont)
1806       ;; Don't enter a score if there already is one.
1807       (while (setq entry (pop scores))
1808         (and (equal "references" (car entry))
1809              (or (null (nth 3 (cadr entry)))
1810                  (eq 's (nth 3 (cadr entry))))
1811              (assoc id entry)
1812              (setq dont t)))
1813       (unless dont
1814         (gnus-summary-score-entry
1815          (if thread "thread" "references")
1816          id 's score (current-time-string) nil t)))))
1817
1818 (defun gnus-score-string (score-list header now expire &optional trace)
1819   ;; Score ARTICLES according to HEADER in SCORE-LIST.
1820   ;; Update matching entries to NOW and remove unmatched entries older
1821   ;; than EXPIRE.
1822
1823   ;; Insert the unique article headers in the buffer.
1824   (let ((gnus-score-index (nth 1 (assoc header gnus-header-index)))
1825         ;; gnus-score-index is used as a free variable.
1826         alike last this art entries alist articles
1827         fuzzies arts words kill)
1828
1829     ;; Sorting the articles costs os O(N*log N) but will allow us to
1830     ;; only match with each unique header.  Thus the actual matching
1831     ;; will be O(M*U) where M is the number of strings to match with,
1832     ;; and U is the number of unique headers.  It is assumed (but
1833     ;; untested) this will be a net win because of the large constant
1834     ;; factor involved with string matching.
1835     (setq gnus-scores-articles (sort gnus-scores-articles 'gnus-score-string<)
1836           articles gnus-scores-articles)
1837
1838     (erase-buffer)
1839     (while (setq art (pop articles))
1840       (setq this (aref (car art) gnus-score-index))
1841       (if (equal last this)
1842           ;; O(N*H) cons-cells used here, where H is the number of
1843           ;; headers.
1844           (push art alike)
1845         (when last
1846           ;; Insert the line, with a text property on the
1847           ;; terminating newline referring to the articles with
1848           ;; this line.
1849           (insert last ?\n)
1850           (put-text-property (1- (point)) (point) 'articles alike))
1851         (setq alike (list art)
1852               last this)))
1853     (when last                          ; Bwadr, duplicate code.
1854       (insert last ?\n)
1855       (put-text-property (1- (point)) (point) 'articles alike))
1856
1857     ;; Go through all the score alists and pick out the entries
1858     ;; for this header.
1859     (while score-list
1860       (setq alist (pop score-list)
1861             ;; There's only one instance of this header for
1862             ;; each score alist.
1863             entries (assoc header alist))
1864       (while (cdr entries)              ;First entry is the header index.
1865         (let* ((kill (cadr entries))
1866                (match (nth 0 kill))
1867                (type (or (nth 3 kill) 's))
1868                (score (or (nth 1 kill) gnus-score-interactive-default-score))
1869                (date (nth 2 kill))
1870                (found nil)
1871                (mt (aref (symbol-name type) 0))
1872                (case-fold-search (not (memq mt '(?R ?S ?E ?F))))
1873                (dmt (downcase mt))
1874                (search-func
1875                 (cond ((= dmt ?r) 're-search-forward)
1876                       ((or (= dmt ?e) (= dmt ?s) (= dmt ?f)) 'search-forward)
1877                       ((= dmt ?w) nil)
1878                       (t (error "Illegal match type: %s" type)))))
1879           (cond
1880            ;; Fuzzy matches.  We save these for later.
1881            ((= dmt ?f)
1882             (push (cons entries alist) fuzzies))
1883            ;; Word matches.  Save these for even later.
1884            ((= dmt ?w)
1885             (push (cons entries alist) words))
1886            ;; Exact matches.
1887            ((= dmt ?e)
1888             ;; Do exact matching.
1889             (goto-char (point-min))
1890             (while (and (not (eobp))
1891                         (funcall search-func match nil t))
1892               ;; Is it really exact?
1893               (and (eolp)
1894                    (= (gnus-point-at-bol) (match-beginning 0))
1895                    ;; Yup.
1896                    (progn
1897                      (setq found (setq arts (get-text-property
1898                                              (point) 'articles)))
1899                      ;; Found a match, update scores.
1900                      (if trace
1901                          (while (setq art (pop arts))
1902                            (setcdr art (+ score (cdr art)))
1903                            (push
1904                             (cons
1905                              (car-safe (rassq alist gnus-score-cache))
1906                              kill)
1907                             gnus-score-trace))
1908                        (while (setq art (pop arts))
1909                          (setcdr art (+ score (cdr art)))))))
1910               (forward-line 1)))
1911            ;; Regexp and substring matching.
1912            (t
1913             (goto-char (point-min))
1914             (when (string= match "")
1915               (setq match "\n"))
1916             (while (and (not (eobp))
1917                         (funcall search-func match nil t))
1918               (goto-char (match-beginning 0))
1919               (end-of-line)
1920               (setq found (setq arts (get-text-property (point) 'articles)))
1921               ;; Found a match, update scores.
1922               (if trace
1923                   (while (setq art (pop arts))
1924                     (setcdr art (+ score (cdr art)))
1925                     (push (cons (car-safe (rassq alist gnus-score-cache)) kill)
1926                           gnus-score-trace))
1927                 (while (setq art (pop arts))
1928                   (setcdr art (+ score (cdr art)))))
1929               (forward-line 1))))
1930           ;; Update expiry date
1931           (if trace
1932               (setq entries (cdr entries))
1933             (cond
1934              ;; Permanent entry.
1935              ((null date)
1936               (setq entries (cdr entries)))
1937              ;; We have a match, so we update the date.
1938              ((and found gnus-update-score-entry-dates)
1939               (gnus-score-set 'touched '(t) alist)
1940               (setcar (nthcdr 2 kill) now)
1941               (setq entries (cdr entries)))
1942              ;; This entry has expired, so we remove it.
1943              ((and expire (< date expire))
1944               (gnus-score-set 'touched '(t) alist)
1945               (setcdr entries (cddr entries)))
1946              ;; No match; go to next entry.
1947              (t
1948               (setq entries (cdr entries))))))))
1949
1950     ;; Find fuzzy matches.
1951     (when fuzzies
1952       ;; Simplify the entire buffer for easy matching.
1953       (gnus-simplify-buffer-fuzzy)
1954       (while (setq kill (cadaar fuzzies))
1955         (let* ((match (nth 0 kill))
1956                (type (nth 3 kill))
1957                (score (or (nth 1 kill) gnus-score-interactive-default-score))
1958                (date (nth 2 kill))
1959                (mt (aref (symbol-name type) 0))
1960                (case-fold-search (not (= mt ?F)))
1961                found)
1962           (goto-char (point-min))
1963           (while (and (not (eobp))
1964                       (search-forward match nil t))
1965             (when (and (= (gnus-point-at-bol) (match-beginning 0))
1966                        (eolp))
1967               (setq found (setq arts (get-text-property (point) 'articles)))
1968               (if trace
1969                   (while (setq art (pop arts))
1970                     (setcdr art (+ score (cdr art)))
1971                     (push (cons
1972                            (car-safe (rassq (cdar fuzzies) gnus-score-cache))
1973                            kill)
1974                           gnus-score-trace))
1975                 ;; Found a match, update scores.
1976                 (while (setq art (pop arts))
1977                   (setcdr art (+ score (cdr art))))))
1978             (forward-line 1))
1979           ;; Update expiry date
1980           (cond
1981            ;; Permanent.
1982            ((null date)
1983             )
1984            ;; Match, update date.
1985            ((and found gnus-update-score-entry-dates)
1986             (gnus-score-set 'touched '(t) (cdar fuzzies))
1987             (setcar (nthcdr 2 kill) now))
1988            ;; Old entry, remove.
1989            ((and expire (< date expire))
1990             (gnus-score-set 'touched '(t) (cdar fuzzies))
1991             (setcdr (caar fuzzies) (cddaar fuzzies))))
1992           (setq fuzzies (cdr fuzzies)))))
1993
1994     (when words
1995       ;; Enter all words into the hashtb.
1996       (let ((hashtb (gnus-make-hashtable
1997                      (* 10 (count-lines (point-min) (point-max))))))
1998         (gnus-enter-score-words-into-hashtb hashtb)
1999         (while (setq kill (cadaar words))
2000           (let* ((score (or (nth 1 kill) gnus-score-interactive-default-score))
2001                  (date (nth 2 kill))
2002                  found)
2003             (when (setq arts (intern-soft (nth 0 kill) hashtb))
2004               (setq arts (symbol-value arts))
2005               (setq found t)
2006               (if trace
2007                   (while (setq art (pop arts))
2008                     (setcdr art (+ score (cdr art)))
2009                     (push (cons
2010                            (car-safe (rassq (cdar words) gnus-score-cache))
2011                            kill)
2012                           gnus-score-trace))
2013                 ;; Found a match, update scores.
2014                 (while (setq art (pop arts))
2015                   (setcdr art (+ score (cdr art))))))
2016             ;; Update expiry date
2017             (cond
2018              ;; Permanent.
2019              ((null date)
2020               )
2021              ;; Match, update date.
2022              ((and found gnus-update-score-entry-dates)
2023               (gnus-score-set 'touched '(t) (cdar words))
2024               (setcar (nthcdr 2 kill) now))
2025              ;; Old entry, remove.
2026              ((and expire (< date expire))
2027               (gnus-score-set 'touched '(t) (cdar words))
2028               (setcdr (caar words) (cddaar words))))
2029             (setq words (cdr words))))))
2030     nil))
2031
2032 (defun gnus-enter-score-words-into-hashtb (hashtb)
2033   ;; Find all the words in the buffer and enter them into
2034   ;; the hashtable.
2035   (let ((syntab (syntax-table))
2036         word val)
2037     (goto-char (point-min))
2038     (unwind-protect
2039         (progn
2040           (set-syntax-table gnus-adaptive-word-syntax-table)
2041           (while (re-search-forward "\\b\\w+\\b" nil t)
2042             (setq val
2043                   (gnus-gethash
2044                    (setq word (downcase (buffer-substring
2045                                          (match-beginning 0) (match-end 0))))
2046                    hashtb))
2047             (gnus-sethash
2048              word
2049              (append (get-text-property (gnus-point-at-eol) 'articles) val)
2050              hashtb)))
2051       (set-syntax-table syntab))
2052     ;; Make all the ignorable words ignored.
2053     (let ((ignored (append gnus-ignored-adaptive-words
2054                            gnus-default-ignored-adaptive-words)))
2055       (while ignored
2056         (gnus-sethash (pop ignored) nil hashtb)))))
2057
2058 (defun gnus-score-string< (a1 a2)
2059   ;; Compare headers in articles A2 and A2.
2060   ;; The header index used is the free variable `gnus-score-index'.
2061   (string-lessp (aref (car a1) gnus-score-index)
2062                 (aref (car a2) gnus-score-index)))
2063
2064 (defun gnus-current-score-file-nondirectory (&optional score-file)
2065   (let ((score-file (or score-file gnus-current-score-file)))
2066     (if score-file
2067         (gnus-short-group-name (file-name-nondirectory score-file))
2068       "none")))
2069
2070 (defun gnus-score-adaptive ()
2071   "Create adaptive score rules for this newsgroup."
2072   (when gnus-newsgroup-adaptive
2073     ;; We change the score file to the adaptive score file.
2074     (save-excursion
2075       (set-buffer gnus-summary-buffer)
2076       (gnus-score-load-file
2077        (or gnus-newsgroup-adaptive-score-file
2078            (gnus-home-score-file gnus-newsgroup-name t)
2079            (gnus-score-file-name
2080             gnus-newsgroup-name gnus-adaptive-file-suffix))))
2081     ;; Perform ordinary line scoring.
2082     (when (or (not (listp gnus-newsgroup-adaptive))
2083               (memq 'line gnus-newsgroup-adaptive))
2084       (save-excursion
2085         (let* ((malist (gnus-copy-sequence gnus-adaptive-score-alist))
2086                (alist malist)
2087                (date (current-time-string))
2088                (data gnus-newsgroup-data)
2089                elem headers match func)
2090           ;; First we transform the adaptive rule alist into something
2091           ;; that's faster to process.
2092           (while malist
2093             (setq elem (car malist))
2094             (when (symbolp (car elem))
2095               (setcar elem (symbol-value (car elem))))
2096             (setq elem (cdr elem))
2097             (while elem
2098               (when (fboundp
2099                      (setq func
2100                            (intern
2101                             (concat "mail-header-"
2102                                     (if (eq (caar elem) 'followup)
2103                                         "message-id"
2104                                       (downcase (symbol-name (caar elem))))))))
2105                 (setcdr (car elem)
2106                         (cons (if (eq (caar elem) 'followup)
2107                                   "references"
2108                                 (symbol-name (caar elem)))
2109                               (cdar elem)))
2110                 (setcar (car elem)
2111                         `(lambda (h)
2112                            (,func h))))
2113               (setq elem (cdr elem)))
2114             (setq malist (cdr malist)))
2115           ;; Then we score away.
2116           (while data
2117             (setq elem (cdr (assq (gnus-data-mark (car data)) alist)))
2118             (if (or (not elem)
2119                     (gnus-data-pseudo-p (car data)))
2120                 ()
2121               (when (setq headers (gnus-data-header (car data)))
2122                 (while elem
2123                   (setq match (funcall (caar elem) headers))
2124                   (gnus-summary-score-entry
2125                    (nth 1 (car elem)) match
2126                    (cond
2127                     ((numberp match)
2128                      '=)
2129                     ((equal (nth 1 (car elem)) "date")
2130                      'a)
2131                     (t
2132                      ;; Whether we use substring or exact matches is
2133                      ;; controlled here.
2134                      (if (or (not gnus-score-exact-adapt-limit)
2135                              (< (length match) gnus-score-exact-adapt-limit))
2136                          'e
2137                        (if (equal (nth 1 (car elem)) "subject")
2138                            'f 's))))
2139                    (nth 2 (car elem)) date nil t)
2140                   (setq elem (cdr elem)))))
2141             (setq data (cdr data))))))
2142
2143     ;; Perform adaptive word scoring.
2144     (when (and (listp gnus-newsgroup-adaptive)
2145                (memq 'word gnus-newsgroup-adaptive))
2146       (nnheader-temp-write nil
2147         (let* ((hashtb (gnus-make-hashtable 1000))
2148                (date (gnus-day-number (current-time-string)))
2149                (data gnus-newsgroup-data)
2150                (syntab (syntax-table))
2151                word d score val)
2152           (unwind-protect
2153               (progn
2154                 (set-syntax-table gnus-adaptive-word-syntax-table)
2155                 ;; Go through all articles.
2156                 (while (setq d (pop data))
2157                   (when (and
2158                          (not (gnus-data-pseudo-p d))
2159                          (setq score
2160                                (cdr (assq
2161                                      (gnus-data-mark d)
2162                                      gnus-adaptive-word-score-alist))))
2163                     ;; This article has a mark that should lead to
2164                     ;; adaptive word rules, so we insert the subject
2165                     ;; and find all words in that string.
2166                     (insert (mail-header-subject (gnus-data-header d)))
2167                     (downcase-region (point-min) (point-max))
2168                     (goto-char (point-min))
2169                     (while (re-search-forward "\\b\\w+\\b" nil t)
2170                       ;; Put the word and score into the hashtb.
2171                       (setq val (gnus-gethash (setq word (match-string 0))
2172                                               hashtb))
2173                       (gnus-sethash word (+ (or val 0) score) hashtb))
2174                     (erase-buffer))))
2175             (set-syntax-table syntab))
2176           ;; Make all the ignorable words ignored.
2177           (let ((ignored (append gnus-ignored-adaptive-words
2178                                  gnus-default-ignored-adaptive-words)))
2179             (while ignored
2180               (gnus-sethash (pop ignored) nil hashtb)))
2181           ;; Now we have all the words and scores, so we
2182           ;; add these rules to the ADAPT file.
2183           (set-buffer gnus-summary-buffer)
2184           (mapatoms
2185            (lambda (word)
2186              (when (symbol-value word)
2187                (gnus-summary-score-entry
2188                 "subject" (symbol-name word) 'w (symbol-value word)
2189                 date nil t)))
2190            hashtb))))))
2191
2192 (defun gnus-score-edit-done ()
2193   (let ((bufnam (buffer-file-name (current-buffer)))
2194         (winconf gnus-prev-winconf))
2195     (when winconf
2196       (set-window-configuration winconf))
2197     (gnus-score-remove-from-cache bufnam)
2198     (gnus-score-load-file bufnam)))
2199
2200 (defun gnus-score-find-trace ()
2201   "Find all score rules that applies to the current article."
2202   (interactive)
2203   (let ((old-scored gnus-newsgroup-scored))
2204     (let ((gnus-newsgroup-headers
2205            (list (gnus-summary-article-header)))
2206           (gnus-newsgroup-scored nil)
2207           trace)
2208       (save-excursion
2209         (nnheader-set-temp-buffer "*Score Trace*"))
2210       (setq gnus-score-trace nil)
2211       (gnus-possibly-score-headers 'trace)
2212       (if (not (setq trace gnus-score-trace))
2213           (gnus-error
2214            1 "No score rules apply to the current article (default score %d)."
2215            gnus-summary-default-score)
2216         (set-buffer "*Score Trace*")
2217         (gnus-add-current-to-buffer-list)
2218         (while trace
2219           (insert (format "%S  ->  %s\n" (cdar trace)
2220                           (if (caar trace)
2221                               (file-name-nondirectory (caar trace))
2222                             "(non-file rule)")))
2223           (setq trace (cdr trace)))
2224         (goto-char (point-min))
2225         (gnus-configure-windows 'score-trace)))
2226     (set-buffer gnus-summary-buffer)
2227     (setq gnus-newsgroup-scored old-scored)))
2228
2229 (defun gnus-score-find-favourite-words ()
2230   "List words used in scoring."
2231   (interactive)
2232   (let ((alists (gnus-score-load-files (gnus-all-score-files)))
2233         alist rule rules kill)
2234     ;; Go through all the score alists for this group
2235     ;; and find all `w' rules.
2236     (while (setq alist (pop alists))
2237       (while (setq rule (pop alist))
2238         (when (and (stringp (car rule))
2239                    (equal "subject" (downcase (pop rule))))
2240           (while (setq kill (pop rule))
2241             (when (memq (nth 3 kill) '(w W word Word))
2242               (push (cons (or (nth 1 kill)
2243                               gnus-score-interactive-default-score)
2244                           (car kill))
2245                     rules))))))
2246     (setq rules (sort rules (lambda (r1 r2)
2247                               (string-lessp (cdr r1) (cdr r2)))))
2248     ;; Add up words that have appeared several times.
2249     (let ((r rules))
2250       (while (cdr r)
2251         (if (equal (cdar r) (cdadr r))
2252             (progn
2253               (setcar (car r) (+ (caar r) (caadr r)))
2254               (setcdr r (cddr r)))
2255           (pop r))))
2256     ;; Insert the words.
2257     (nnheader-set-temp-buffer "*Score Words*")
2258     (if (not (setq rules (sort rules (lambda (r1 r2) (> (car r1) (car r2))))))
2259         (gnus-error 3 "No word score rules")
2260       (while rules
2261         (insert (format "%-5d: %s\n" (caar rules) (cdar rules)))
2262         (pop rules))
2263       (gnus-add-current-to-buffer-list)
2264       (goto-char (point-min))
2265       (gnus-configure-windows 'score-words))))
2266
2267 (defun gnus-summary-rescore ()
2268   "Redo the entire scoring process in the current summary."
2269   (interactive)
2270   (gnus-score-save)
2271   (setq gnus-score-cache nil)
2272   (setq gnus-newsgroup-scored nil)
2273   (gnus-possibly-score-headers)
2274   (gnus-score-update-all-lines))
2275
2276 (defun gnus-score-flush-cache ()
2277   "Flush the cache of score files."
2278   (interactive)
2279   (gnus-score-save)
2280   (setq gnus-score-cache nil
2281         gnus-score-alist nil
2282         gnus-short-name-score-file-cache nil)
2283   (gnus-message 6 "The score cache is now flushed"))
2284
2285 (gnus-add-shutdown 'gnus-score-close 'gnus)
2286
2287 (defvar gnus-score-file-alist-cache nil)
2288
2289 (defun gnus-score-close ()
2290   "Clear all internal score variables."
2291   (setq gnus-score-cache nil
2292         gnus-internal-global-score-files nil
2293         gnus-score-file-list nil
2294         gnus-score-file-alist-cache nil))
2295
2296 ;; Summary score marking commands.
2297
2298 (defun gnus-summary-raise-same-subject-and-select (score)
2299   "Raise articles which has the same subject with SCORE and select the next."
2300   (interactive "p")
2301   (let ((subject (gnus-summary-article-subject)))
2302     (gnus-summary-raise-score score)
2303     (while (gnus-summary-find-subject subject)
2304       (gnus-summary-raise-score score))
2305     (gnus-summary-next-article t)))
2306
2307 (defun gnus-summary-raise-same-subject (score)
2308   "Raise articles which has the same subject with SCORE."
2309   (interactive "p")
2310   (let ((subject (gnus-summary-article-subject)))
2311     (gnus-summary-raise-score score)
2312     (while (gnus-summary-find-subject subject)
2313       (gnus-summary-raise-score score))
2314     (gnus-summary-next-subject 1 t)))
2315
2316 (defun gnus-score-default (level)
2317   (if level (prefix-numeric-value level)
2318     gnus-score-interactive-default-score))
2319
2320 (defun gnus-summary-raise-thread (&optional score)
2321   "Raise the score of the articles in the current thread with SCORE."
2322   (interactive "P")
2323   (setq score (gnus-score-default score))
2324   (let (e)
2325     (save-excursion
2326       (let ((articles (gnus-summary-articles-in-thread)))
2327         (while articles
2328           (gnus-summary-goto-subject (car articles))
2329           (gnus-summary-raise-score score)
2330           (setq articles (cdr articles))))
2331       (setq e (point)))
2332     (let ((gnus-summary-check-current t))
2333       (unless (zerop (gnus-summary-next-subject 1 t))
2334         (goto-char e))))
2335   (gnus-summary-recenter)
2336   (gnus-summary-position-point)
2337   (gnus-set-mode-line 'summary))
2338
2339 (defun gnus-summary-lower-same-subject-and-select (score)
2340   "Raise articles which has the same subject with SCORE and select the next."
2341   (interactive "p")
2342   (gnus-summary-raise-same-subject-and-select (- score)))
2343
2344 (defun gnus-summary-lower-same-subject (score)
2345   "Raise articles which has the same subject with SCORE."
2346   (interactive "p")
2347   (gnus-summary-raise-same-subject (- score)))
2348
2349 (defun gnus-summary-lower-thread (&optional score)
2350   "Lower score of articles in the current thread with SCORE."
2351   (interactive "P")
2352   (gnus-summary-raise-thread (- (1- (gnus-score-default score)))))
2353
2354 ;;; Finding score files.
2355
2356 (defun gnus-score-score-files (group)
2357   "Return a list of all possible score files."
2358   ;; Search and set any global score files.
2359   (when gnus-global-score-files
2360     (unless gnus-internal-global-score-files
2361       (gnus-score-search-global-directories gnus-global-score-files)))
2362   ;; Fix the kill-file dir variable.
2363   (setq gnus-kill-files-directory
2364         (file-name-as-directory gnus-kill-files-directory))
2365   ;; If we can't read it, there are no score files.
2366   (if (not (file-exists-p (expand-file-name gnus-kill-files-directory)))
2367       (setq gnus-score-file-list nil)
2368     (if (not (gnus-use-long-file-name 'not-score))
2369         ;; We do not use long file names, so we have to do some
2370         ;; directory traversing.
2371         (setq gnus-score-file-list
2372               (cons nil
2373                     (or gnus-short-name-score-file-cache
2374                         (prog2
2375                             (gnus-message 6 "Finding all score files...")
2376                             (setq gnus-short-name-score-file-cache
2377                                   (gnus-score-score-files-1
2378                                    gnus-kill-files-directory))
2379                           (gnus-message 6 "Finding all score files...done")))))
2380       ;; We want long file names.
2381       (when (or (not gnus-score-file-list)
2382                 (not (car gnus-score-file-list))
2383                 (gnus-file-newer-than gnus-kill-files-directory
2384                                       (car gnus-score-file-list)))
2385         (setq gnus-score-file-list
2386               (cons (nth 5 (file-attributes gnus-kill-files-directory))
2387                     (nreverse
2388                      (directory-files
2389                       gnus-kill-files-directory t
2390                       (gnus-score-file-regexp)))))))
2391     (cdr gnus-score-file-list)))
2392
2393 (defun gnus-score-score-files-1 (dir)
2394   "Return all possible score files under DIR."
2395   (let ((files (list (expand-file-name dir)))
2396         (regexp (gnus-score-file-regexp))
2397         (case-fold-search nil)
2398         seen out file)
2399     (while (setq file (pop files))
2400       (cond
2401        ;; Ignore "." and "..".
2402        ((member (file-name-nondirectory file) '("." ".."))
2403         nil)
2404        ;; Add subtrees of directory to also be searched.
2405        ((and (file-directory-p file)
2406              (not (member (file-truename file) seen)))
2407         (push (file-truename file) seen)
2408         (setq files (nconc (directory-files file t nil t) files)))
2409        ;; Add files to the list of score files.
2410        ((string-match regexp file)
2411         (push file out))))
2412     (or out
2413         ;; Return a dummy value.
2414         (list "~/News/this.file.does.not.exist.SCORE"))))
2415
2416 (defun gnus-score-file-regexp ()
2417   "Return a regexp that match all score files."
2418   (concat "\\(" (regexp-quote gnus-score-file-suffix )
2419           "\\|" (regexp-quote gnus-adaptive-file-suffix) "\\)\\'"))
2420
2421 (defun gnus-score-find-bnews (group)
2422   "Return a list of score files for GROUP.
2423 The score files are those files in the ~/News/ directory which matches
2424 GROUP using BNews sys file syntax."
2425   (let* ((sfiles (append (gnus-score-score-files group)
2426                          gnus-internal-global-score-files))
2427          (kill-dir (file-name-as-directory
2428                     (expand-file-name gnus-kill-files-directory)))
2429          (klen (length kill-dir))
2430          (score-regexp (gnus-score-file-regexp))
2431          (trans (cdr (assq ?: nnheader-file-name-translation-alist)))
2432          ofiles not-match regexp)
2433     (save-excursion
2434       (set-buffer (get-buffer-create "*gnus score files*"))
2435       (buffer-disable-undo (current-buffer))
2436       ;; Go through all score file names and create regexp with them
2437       ;; as the source.
2438       (while sfiles
2439         (erase-buffer)
2440         (insert (car sfiles))
2441         (goto-char (point-min))
2442         ;; First remove the suffix itself.
2443         (when (re-search-forward (concat "." score-regexp) nil t)
2444           (replace-match "" t t)
2445           (goto-char (point-min))
2446           (if (looking-at (regexp-quote kill-dir))
2447               ;; If the file name was just "SCORE", `klen' is one character
2448               ;; too much.
2449               (delete-char (min (1- (point-max)) klen))
2450             (goto-char (point-max))
2451             (search-backward "/")
2452             (delete-region (1+ (point)) (point-min)))
2453           ;; If short file names were used, we have to translate slashes.
2454           (goto-char (point-min))
2455           (let ((regexp (concat
2456                          "[/:" (if trans (char-to-string trans) "") "]")))
2457             (while (re-search-forward regexp nil t)
2458               (replace-match "." t t)))
2459           ;; Kludge to get rid of "nntp+" problems.
2460           (goto-char (point-min))
2461           (when (looking-at "nn[a-z]+\\+")
2462             (search-forward "+")
2463             (forward-char -1)
2464             (insert "\\")
2465             (forward-char 1))
2466           ;; Kludge to deal with "++".
2467           (while (search-forward "+" nil t)
2468             (replace-match "\\+" t t))
2469           ;; Translate "all" to ".*".
2470           (goto-char (point-min))
2471           (while (search-forward "all" nil t)
2472             (replace-match ".*" t t))
2473           (goto-char (point-min))
2474           ;; Deal with "not."s.
2475           (if (looking-at "not.")
2476               (progn
2477                 (setq not-match t)
2478                 (setq regexp (concat "^" (buffer-substring 5 (point-max)) "$")))
2479             (setq regexp (concat "^" (buffer-substring 1 (point-max)) "$"))
2480             (setq not-match nil))
2481           ;; Finally - if this resulting regexp matches the group name,
2482           ;; we add this score file to the list of score files
2483           ;; applicable to this group.
2484           (when (or (and not-match
2485                          (not (string-match regexp group)))
2486                     (and (not not-match)
2487                          (string-match regexp group)))
2488             (push (car sfiles) ofiles)))
2489         (setq sfiles (cdr sfiles)))
2490       (kill-buffer (current-buffer))
2491       ;; Slight kludge here - the last score file returned should be
2492       ;; the local score file, whether it exists or not.  This is so
2493       ;; that any score commands the user enters will go to the right
2494       ;; file, and not end up in some global score file.
2495       (let ((localscore (gnus-score-file-name group)))
2496         (setq ofiles (cons localscore (delete localscore ofiles))))
2497       (gnus-sort-score-files (nreverse ofiles)))))
2498
2499 (defun gnus-score-find-single (group)
2500   "Return list containing the score file for GROUP."
2501   (list (or gnus-newsgroup-adaptive-score-file
2502             (gnus-score-file-name group gnus-adaptive-file-suffix))
2503         (gnus-score-file-name group)))
2504
2505 (defun gnus-score-find-hierarchical (group)
2506   "Return list of score files for GROUP.
2507 This includes the score file for the group and all its parents."
2508   (let* ((prefix (gnus-group-real-prefix group))
2509          (all (list nil))
2510          (group (gnus-group-real-name group))
2511          (start 0))
2512     (while (string-match "\\." group (1+ start))
2513       (setq start (match-beginning 0))
2514       (push (substring group 0 start) all))
2515     (push group all)
2516     (setq all
2517           (nconc
2518            (mapcar (lambda (group)
2519                      (gnus-score-file-name group gnus-adaptive-file-suffix))
2520                    (setq all (nreverse all)))
2521            (mapcar 'gnus-score-file-name all)))
2522     (if (equal prefix "")
2523         all
2524       (mapcar
2525        (lambda (file)
2526          (nnheader-translate-file-chars
2527           (concat (file-name-directory file) prefix
2528                   (file-name-nondirectory file))))
2529        all))))
2530
2531 (defun gnus-score-file-rank (file)
2532   "Return a number that says how specific score FILE is.
2533 Destroys the current buffer."
2534   (if (member file gnus-internal-global-score-files)
2535       0
2536     (when (string-match
2537            (concat "^" (regexp-quote
2538                         (expand-file-name
2539                          (file-name-as-directory gnus-kill-files-directory))))
2540            file)
2541       (setq file (substring file (match-end 0))))
2542     (insert file)
2543     (goto-char (point-min))
2544     (let ((beg (point))
2545           elems)
2546       (while (re-search-forward "[./]" nil t)
2547         (push (buffer-substring beg (1- (point)))
2548               elems))
2549       (erase-buffer)
2550       (setq elems (delete "all" elems))
2551       (length elems))))
2552
2553 (defun gnus-sort-score-files (files)
2554   "Sort FILES so that the most general files come first."
2555   (nnheader-temp-write nil
2556     (let ((alist
2557            (mapcar
2558             (lambda (file)
2559               (cons (inline (gnus-score-file-rank file)) file))
2560             files)))
2561       (mapcar
2562        (lambda (f) (cdr f))
2563        (sort alist 'car-less-than-car)))))
2564
2565 (defun gnus-score-find-alist (group)
2566   "Return list of score files for GROUP.
2567 The list is determined from the variable gnus-score-file-alist."
2568   (let ((alist gnus-score-file-multiple-match-alist)
2569         score-files)
2570     ;; if this group has been seen before, return the cached entry
2571     (if (setq score-files (assoc group gnus-score-file-alist-cache))
2572         (cdr score-files)               ;ensures caching groups with no matches
2573       ;; handle the multiple match alist
2574       (while alist
2575         (when (string-match (caar alist) group)
2576           (setq score-files
2577                 (nconc score-files (copy-sequence (cdar alist)))))
2578         (setq alist (cdr alist)))
2579       (setq alist gnus-score-file-single-match-alist)
2580       ;; handle the single match alist
2581       (while alist
2582         (when (string-match (caar alist) group)
2583           ;; progn used just in case ("regexp") has no files
2584           ;; and score-files is still nil.  -sj
2585           ;; this can be construed as a "stop searching here" feature :>
2586           ;; and used to simplify regexps in the single-alist
2587           (setq score-files
2588                 (nconc score-files (copy-sequence (cdar alist))))
2589           (setq alist nil))
2590         (setq alist (cdr alist)))
2591       ;; cache the score files
2592       (push (cons group score-files) gnus-score-file-alist-cache)
2593       score-files)))
2594
2595 (defun gnus-all-score-files (&optional group)
2596   "Return a list of all score files for the current group."
2597   (let ((funcs gnus-score-find-score-files-function)
2598         (group (or group gnus-newsgroup-name))
2599         score-files)
2600     (when group
2601       ;; Make sure funcs is a list.
2602       (and funcs
2603            (not (listp funcs))
2604            (setq funcs (list funcs)))
2605       ;; Get the initial score files for this group.
2606       (when funcs
2607         (setq score-files (nreverse (gnus-score-find-alist group))))
2608       ;; Add any home adapt files.
2609       (let ((home (gnus-home-score-file group t)))
2610         (when home
2611           (push home score-files)
2612           (setq gnus-newsgroup-adaptive-score-file home)))
2613       ;; Check whether there is a `adapt-file' group parameter.
2614       (let ((param-file (gnus-group-find-parameter group 'adapt-file)))
2615         (when param-file
2616           (push param-file score-files)
2617           (setq gnus-newsgroup-adaptive-score-file param-file)))
2618       ;; Go through all the functions for finding score files (or actual
2619       ;; scores) and add them to a list.
2620       (while funcs
2621         (when (gnus-functionp (car funcs))
2622           (setq score-files
2623                 (nconc score-files (nreverse (funcall (car funcs) group)))))
2624         (setq funcs (cdr funcs)))
2625       ;; Add any home score files.
2626       (let ((home (gnus-home-score-file group)))
2627         (when home
2628           (push home score-files)))
2629       ;; Check whether there is a `score-file' group parameter.
2630       (let ((param-file (gnus-group-find-parameter group 'score-file)))
2631         (when param-file
2632           (push param-file score-files)))
2633       ;; Expand all files names.
2634       (let ((files score-files))
2635         (while files
2636           (when (stringp (car files))
2637             (setcar files (expand-file-name
2638                            (car files) gnus-kill-files-directory)))
2639           (pop files)))
2640       (setq score-files (nreverse score-files))
2641       ;; Remove any duplicate score files.
2642       (while (and score-files
2643                   (member (car score-files) (cdr score-files)))
2644         (pop score-files))
2645       (let ((files score-files))
2646         (while (cdr files)
2647           (if (member (cadr files) (cddr files))
2648               (setcdr files (cddr files))
2649             (pop files))))
2650       ;; Do the scoring if there are any score files for this group.
2651       score-files)))
2652
2653 (defun gnus-possibly-score-headers (&optional trace)
2654   "Do scoring if scoring is required."
2655   (let ((score-files (gnus-all-score-files)))
2656     (when score-files
2657       (gnus-score-headers score-files trace))))
2658
2659 (defun gnus-score-file-name (newsgroup &optional suffix)
2660   "Return the name of a score file for NEWSGROUP."
2661   (let ((suffix (or suffix gnus-score-file-suffix)))
2662     (nnheader-translate-file-chars
2663      (cond
2664       ((or (null newsgroup)
2665            (string-equal newsgroup ""))
2666        ;; The global score file is placed at top of the directory.
2667        (expand-file-name
2668         suffix gnus-kill-files-directory))
2669       ((gnus-use-long-file-name 'not-score)
2670        ;; Append ".SCORE" to newsgroup name.
2671        (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2672                                  "." suffix)
2673                          gnus-kill-files-directory))
2674       (t
2675        ;; Place "SCORE" under the hierarchical directory.
2676        (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2677                                  "/" suffix)
2678                          gnus-kill-files-directory))))))
2679
2680 (defun gnus-score-search-global-directories (files)
2681   "Scan all global score directories for score files."
2682   ;; Set the variable `gnus-internal-global-score-files' to all
2683   ;; available global score files.
2684   (interactive (list gnus-global-score-files))
2685   (let (out)
2686     (while files
2687       (if (string-match "/$" (car files))
2688           (setq out (nconc (directory-files
2689                             (car files) t
2690                             (concat (gnus-score-file-regexp) "$"))))
2691         (push (car files) out))
2692       (setq files (cdr files)))
2693     (setq gnus-internal-global-score-files out)))
2694
2695 (defun gnus-score-default-fold-toggle ()
2696   "Toggle folding for new score file entries."
2697   (interactive)
2698   (setq gnus-score-default-fold (not gnus-score-default-fold))
2699   (if gnus-score-default-fold
2700       (gnus-message 1 "New score file entries will be case insensitive.")
2701     (gnus-message 1 "New score file entries will be case sensitive.")))
2702
2703 ;;; Home score file.
2704
2705 (defun gnus-home-score-file (group &optional adapt)
2706   "Return the home score file for GROUP.
2707 If ADAPT, return the home adaptive file instead."
2708   (let ((list (if adapt gnus-home-adapt-file gnus-home-score-file))
2709         elem found)
2710     ;; Make sure we have a list.
2711     (unless (listp list)
2712       (setq list (list list)))
2713     ;; Go through the list and look for matches.
2714     (while (and (not found)
2715                 (setq elem (pop list)))
2716       (setq found
2717             (cond
2718              ;; Simple string.
2719              ((stringp elem)
2720               elem)
2721              ;; Function.
2722              ((gnus-functionp elem)
2723               (funcall elem group))
2724              ;; Regexp-file cons
2725              ((consp elem)
2726               (when (string-match (car elem) group)
2727                 (cadr elem))))))
2728     (when found
2729       (nnheader-concat gnus-kill-files-directory found))))
2730
2731 (defun gnus-hierarchial-home-score-file (group)
2732   "Return the score file of the top-level hierarchy of GROUP."
2733   (if (string-match "^[^.]+\\." group)
2734       (concat (match-string 0 group) gnus-score-file-suffix)
2735     ;; Group name without any dots.
2736     (concat group (if (gnus-use-long-file-name 'not-score) "." "/")
2737             gnus-score-file-suffix)))
2738
2739 (defun gnus-hierarchial-home-adapt-file (group)
2740   "Return the adapt file of the top-level hierarchy of GROUP."
2741   (if (string-match "^[^.]+\\." group)
2742       (concat (match-string 0 group) gnus-adaptive-file-suffix)
2743     ;; Group name without any dots.
2744     (concat group (if (gnus-use-long-file-name 'not-score) "." "/")
2745             gnus-adaptive-file-suffix)))
2746
2747 ;;;
2748 ;;; Score decays
2749 ;;;
2750
2751 (defun gnus-decay-score (score)
2752   "Decay SCORE according to `gnus-score-decay-constant' and `gnus-score-decay-scale'."
2753   (floor
2754    (- score
2755       (* (if (< score 0) -1 1)
2756          (min (abs score)
2757               (max gnus-score-decay-constant
2758                    (* (abs score)
2759                       gnus-score-decay-scale)))))))
2760
2761 (defun gnus-decay-scores (alist day)
2762   "Decay non-permanent scores in ALIST."
2763   (let ((times (- (gnus-time-to-day (current-time)) day))
2764         kill entry updated score n)
2765     (unless (zerop times)               ;Done decays today already?
2766       (while (setq entry (pop alist))
2767         (when (stringp (car entry))
2768           (setq entry (cdr entry))
2769           (while (setq kill (pop entry))
2770             (when (nth 2 kill)
2771               (setq updated t)
2772               (setq score (or (nth 1 kill)
2773                               gnus-score-interactive-default-score)
2774                     n times)
2775               (while (natnump (decf n))
2776                 (setq score (funcall gnus-decay-score-function score)))
2777               (setcdr kill (cons score
2778                                  (cdr (cdr kill)))))))))
2779     ;; Return whether this score file needs to be saved.  By Je-haysuss!
2780     updated))
2781
2782 (defun gnus-score-regexp-bad-p (regexp)
2783   "Test whether REGEXP is safe for Gnus scoring.
2784 A regexp is unsafe if it matches newline or a buffer boundary.
2785
2786 If the regexp is good, return nil.  If the regexp is bad, return a
2787 cons cell (SYM . STRING), where the symbol SYM is `new' or `bad'.
2788 In the `new' case, the string is a safe replacement for REGEXP.
2789 In the `bad' case, the string is a unsafe subexpression of REGEXP,
2790 and we do not have a simple replacement to suggest.
2791
2792 See `(Gnus)Scoring Tips' for examples of good regular expressions."
2793   (let (case-fold-search)
2794     (and
2795      ;; First, try a relatively fast necessary condition.
2796      ;; Notice ranges (like [^:] or [\t-\r]), \s>, \Sw, \W, \', \`:
2797      (string-match "\n\\|\\\\[SsW`']\\|\\[\\^\\|[\0-\n]-" regexp)
2798      ;; Now break the regexp into tokens, and check each:
2799      (let ((tail regexp)                ; remaining regexp to check
2800            tok                          ; current token
2801            bad                          ; nil, or bad subexpression
2802            new                          ; nil, or replacement regexp so far
2803            end)                         ; length of current token
2804        (while (and (not bad)
2805                    (string-match
2806                     "\\`\\(\\\\[sS]?.\\|\\[\\^?]?[^]]*]\\|[^\\]\\)"
2807                     tail))
2808          (setq end (match-end 0)
2809                tok (substring tail 0 end)
2810                tail (substring tail end))
2811          (if;; Is token `bad' (matching newline or buffer ends)?
2812              (or (member tok '("\n" "\\W" "\\`" "\\'"))
2813                  ;; This next handles "[...]", "\\s.", and "\\S.":
2814                  (and (> end 2) (string-match tok "\n")))
2815              (let ((newtok
2816                     ;; Try to suggest a replacement for tok ...
2817                     (cond ((string-equal tok "\\`") "^") ; or "\\(^\\)"
2818                           ((string-equal tok "\\'") "$") ; or "\\($\\)"
2819                           ((string-match "\\[\\^" tok) ; very common
2820                            (concat (substring tok 0 -1) "\n]")))))
2821                (if newtok
2822                    (setq new
2823                          (concat
2824                           (or new
2825                               ;; good prefix so far:
2826                               (substring regexp 0 (- (+ (length tail) end))))
2827                           newtok))
2828                  ;; No replacement idea, so give up:
2829                  (setq bad tok)))
2830            ;; tok is good, may need to extend new
2831            (and new (setq new (concat new tok)))))
2832        ;; Now return a value:
2833        (cond
2834         (bad (cons 'bad bad))
2835         (new (cons 'new new))
2836         ;; or nil
2837         )))))
2838
2839 (provide 'gnus-score)
2840
2841 ;;; gnus-score.el ends here