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

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