Synch with `t-gnus-6_14'.
[elisp/gnus.git-] / lisp / gnus-score.el
1 ;;; gnus-score.el --- scoring code for Gnus
2 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000
3 ;;        Free Software Foundation, Inc.
4
5 ;; Author: Per Abrahamsen <amanda@iesd.auc.dk>
6 ;;      Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Keywords: news
8
9 ;; This file is part of GNU Emacs.
10
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; any later version.
15
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 ;; GNU General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
25
26 ;;; Commentary:
27
28 ;;; Code:
29
30 (eval-when-compile (require 'cl))
31
32 (require 'gnus)
33 (require 'gnus-sum)
34 (require 'gnus-range)
35 (require 'message)
36 (require 'score-mode)
37
38 (defcustom gnus-global-score-files nil
39   "List of global score files and directories.
40 Set this variable if you want to use people's score files.  One entry
41 for each score file or each score file directory.  Gnus will decide
42 by itself what score files are applicable to which group.
43
44 Say you want to use the single score file
45 \"/ftp.gnus.org@ftp:/pub/larsi/ding/score/soc.motss.SCORE\" and all
46 score files in the \"/ftp.some-where:/pub/score\" directory.
47
48  (setq gnus-global-score-files
49        '(\"/ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE\"
50          \"/ftp.some-where:/pub/score\"))"
51   :group 'gnus-score-files
52   :type '(repeat file))
53
54 (defcustom gnus-score-file-single-match-alist nil
55   "Alist mapping regexps to lists of score files.
56 Each element of this alist should be of the form
57         (\"REGEXP\" [ \"SCORE-FILE-1\" ] [ \"SCORE-FILE-2\" ] ... )
58
59 If the name of a group is matched by REGEXP, the corresponding scorefiles
60 will be used for that group.
61 The first match found is used, subsequent matching entries are ignored (to
62 use multiple matches, see gnus-score-file-multiple-match-alist).
63
64 These score files are loaded in addition to any files returned by
65 gnus-score-find-score-files-function (which see)."
66   :group 'gnus-score-files
67   :type '(repeat (cons regexp (repeat file))))
68
69 (defcustom gnus-score-file-multiple-match-alist nil
70   "Alist mapping regexps to lists of score files.
71 Each element of this alist should be of the form
72         (\"REGEXP\" [ \"SCORE-FILE-1\" ] [ \"SCORE-FILE-2\" ] ... )
73
74 If the name of a group is matched by REGEXP, the corresponding scorefiles
75 will be used for that group.
76 If multiple REGEXPs match a group, the score files corresponding to each
77 match will be used (for only one match to be used, see
78 gnus-score-file-single-match-alist).
79
80 These score files are loaded in addition to any files returned by
81 gnus-score-find-score-files-function (which see)."
82   :group 'gnus-score-files
83   :type '(repeat (cons regexp (repeat file))))
84
85 (defcustom gnus-score-file-suffix "SCORE"
86   "Suffix of the score files."
87   :group 'gnus-score-files
88   :type 'string)
89
90 (defcustom gnus-adaptive-file-suffix "ADAPT"
91   "Suffix of the adaptive score files."
92   :group 'gnus-score-files
93   :group 'gnus-score-adapt
94   :type 'string)
95
96 (defcustom gnus-score-find-score-files-function 'gnus-score-find-bnews
97   "Function used to find score files.
98 The function will be called with the group name as the argument, and
99 should return a list of score files to apply to that group.  The score
100 files do not actually have to exist.
101
102 Predefined values are:
103
104 gnus-score-find-single: Only apply the group's own score file.
105 gnus-score-find-hierarchical: Also apply score files from parent groups.
106 gnus-score-find-bnews: Apply score files whose names matches.
107
108 See the documentation to these functions for more information.
109
110 This variable can also be a list of functions to be called.  Each
111 function is given the group name as argument and should either return
112 a list of score files, or a list of score alists.
113
114 If functions other than these pre-defined functions are used,
115 the `a' symbolic prefix to the score commands will always use
116 \"all.SCORE\"."
117   :group 'gnus-score-files
118   :type '(radio (function-item gnus-score-find-single)
119                 (function-item gnus-score-find-hierarchical)
120                 (function-item gnus-score-find-bnews)
121                 (repeat :tag "List of functions"
122                         (choice (function :tag "Other" :value 'ignore)
123                                 (function-item gnus-score-find-single)
124                                 (function-item gnus-score-find-hierarchical)
125                                 (function-item gnus-score-find-bnews)))
126                 (function :tag "Other" :value 'ignore)))
127
128 (defcustom gnus-score-interactive-default-score 1000
129   "*Scoring commands will raise/lower the score with this number as the default."
130   :group 'gnus-score-default
131   :type 'integer)
132
133 (defcustom gnus-score-expiry-days 7
134   "*Number of days before unused score file entries are expired.
135 If this variable is nil, no score file entries will be expired."
136   :group 'gnus-score-expire
137   :type '(choice (const :tag "never" nil)
138                  number))
139
140 (defcustom gnus-update-score-entry-dates t
141   "*In non-nil, update matching score entry dates.
142 If this variable is nil, then score entries that provide matches
143 will be expired along with non-matching score entries."
144   :group 'gnus-score-expire
145   :type 'boolean)
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 (downcase header))
824         new)
825     (set-text-properties 0 (length header) nil header)
826     (when prompt
827       (setq match (read-string
828                    (format "Match %s on %s, %s: "
829                            (cond ((eq date 'now)
830                                   "now")
831                                  ((stringp date)
832                                   "temp")
833                                  (t "permanent"))
834                            header
835                            (if (< score 0) "lower" "raise"))
836                    (if (numberp match)
837                        (int-to-string match)
838                      match))))
839
840     (set-text-properties 0 (length match) nil 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             (when (gnus-buffer-live-p gnus-summary-buffer)
1499               (let ((scored gnus-newsgroup-scored))
1500                 (with-current-buffer gnus-summary-buffer
1501                   (setq gnus-newsgroup-scored scored))))
1502             ;; Remove the buffer.
1503             (kill-buffer (current-buffer)))
1504
1505           ;; Add articles to `gnus-newsgroup-scored'.
1506           (while gnus-scores-articles
1507             (when (or (/= gnus-summary-default-score
1508                           (cdar gnus-scores-articles))
1509                       gnus-save-score)
1510               (push (cons (mail-header-number (caar gnus-scores-articles))
1511                           (cdar gnus-scores-articles))
1512                     gnus-newsgroup-scored))
1513             (setq gnus-scores-articles (cdr gnus-scores-articles)))
1514
1515           (let (score)
1516             (while (setq score (pop scores))
1517               (while score
1518                 (when (consp (caar score))
1519                   (gnus-score-advanced (car score) trace))
1520                 (pop score))))
1521
1522           (gnus-message 5 "Scoring...done"))))))
1523
1524 (defun gnus-score-lower-thread (thread score-adjust)
1525   "Lower the socre on THREAD with SCORE-ADJUST.
1526 THREAD is expected to contain a list of the form `(PARENT [CHILD1
1527 CHILD2 ...])' where PARENT is a header array and each CHILD is a list
1528 of the same form as THREAD.  The empty list `nil' is valid.  For each
1529 article in the tree, the score of the corresponding entry in
1530 GNUS-NEWSGROUP-SCORED is adjusted by SCORE-ADJUST."
1531   (while thread
1532     (let ((head (car thread)))
1533       (if (listp head)
1534           ;; handle a child and its descendants
1535           (gnus-score-lower-thread head score-adjust)
1536         ;; handle the parent
1537         (let* ((article (mail-header-number head))
1538                (score (assq article gnus-newsgroup-scored)))
1539           (if score (setcdr score (+ (cdr score) score-adjust))
1540             (push (cons article score-adjust) gnus-newsgroup-scored)))))
1541     (setq thread (cdr thread))))
1542
1543 (defun gnus-score-orphans (score)
1544   "Score orphans.
1545 A root is an article with no references.  An orphan is an article
1546 which has references, but is not connected via its references to a
1547 root article.  This function finds all the orphans, and adjusts their
1548 score in GNUS-NEWSGROUP-SCORED by SCORE."
1549   (let ((threads (gnus-make-threads)))
1550     ;; gnus-make-threads produces a list, where each entry is a "thread"
1551     ;; as described in the gnus-score-lower-thread docs.  This function
1552     ;; will be called again (after limiting has been done) if the display
1553     ;; is threaded.  It would be nice to somehow save this info and use
1554     ;; it later.
1555     (while threads
1556       (let* ((thread (car threads))
1557              (id (aref (car thread) gnus-score-index)))
1558         ;; If the parent of the thread is not a root, lower the score of
1559         ;; it and its descendants.  Note that some roots seem to satisfy
1560         ;; (eq id nil) and some (eq id "");  not sure why.
1561         (if (and id (not (string= id "")))
1562             (gnus-score-lower-thread thread score)))
1563       (setq threads (cdr threads)))))
1564
1565 (defun gnus-score-integer (scores header now expire &optional trace)
1566   (let ((gnus-score-index (nth 1 (assoc header gnus-header-index)))
1567         entries alist)
1568     ;; Find matches.
1569     (while scores
1570       (setq alist (car scores)
1571             scores (cdr scores)
1572             entries (assoc header alist))
1573       (while (cdr entries)              ;First entry is the header index.
1574         (let* ((rest (cdr entries))
1575                (kill (car rest))
1576                (match (nth 0 kill))
1577                (type (or (nth 3 kill) '>))
1578                (score (or (nth 1 kill) gnus-score-interactive-default-score))
1579                (date (nth 2 kill))
1580                (found nil)
1581                (match-func (if (or (eq type '>) (eq type '<) (eq type '<=)
1582                                    (eq type '>=) (eq type '=))
1583                                type
1584                              (error "Invalid match type: %s" type)))
1585                (articles gnus-scores-articles))
1586           ;; Instead of doing all the clever stuff that
1587           ;; `gnus-score-string' does to minimize searches and stuff,
1588           ;; I will assume that people generally will put so few
1589           ;; matches on numbers that any cleverness will take more
1590           ;; time than one would gain.
1591           (while articles
1592             (when (funcall match-func
1593                            (or (aref (caar articles) gnus-score-index) 0)
1594                            match)
1595               (when trace
1596                 (push (cons (car-safe (rassq alist gnus-score-cache)) kill)
1597                       gnus-score-trace))
1598               (setq found t)
1599               (setcdr (car articles) (+ score (cdar articles))))
1600             (setq articles (cdr articles)))
1601           ;; Update expire date
1602           (cond ((null date))           ;Permanent entry.
1603                 ((and found gnus-update-score-entry-dates) ;Match, update date.
1604                  (gnus-score-set 'touched '(t) alist)
1605                  (setcar (nthcdr 2 kill) now))
1606                 ((and expire (< date expire)) ;Old entry, remove.
1607                  (gnus-score-set 'touched '(t) alist)
1608                  (setcdr entries (cdr rest))
1609                  (setq rest entries)))
1610           (setq entries rest)))))
1611   nil)
1612
1613 (defun gnus-score-date (scores header now expire &optional trace)
1614   (let ((gnus-score-index (nth 1 (assoc header gnus-header-index)))
1615         entries alist match match-func article)
1616     ;; Find matches.
1617     (while scores
1618       (setq alist (car scores)
1619             scores (cdr scores)
1620             entries (assoc header alist))
1621       (while (cdr entries)              ;First entry is the header index.
1622         (let* ((rest (cdr entries))
1623                (kill (car rest))
1624                (type (or (nth 3 kill) 'before))
1625                (score (or (nth 1 kill) gnus-score-interactive-default-score))
1626                (date (nth 2 kill))
1627                (found nil)
1628                (articles gnus-scores-articles)
1629                l)
1630           (cond
1631            ((eq type 'after)
1632             (setq match-func 'string<
1633                   match (gnus-date-iso8601 (nth 0 kill))))
1634            ((eq type 'before)
1635             (setq match-func 'gnus-string>
1636                   match (gnus-date-iso8601 (nth 0 kill))))
1637            ((eq type 'at)
1638             (setq match-func 'string=
1639                   match (gnus-date-iso8601 (nth 0 kill))))
1640            ((eq type 'regexp)
1641             (setq match-func 'string-match
1642                   match (nth 0 kill)))
1643            (t (error "Invalid match type: %s" type)))
1644           ;; Instead of doing all the clever stuff that
1645           ;; `gnus-score-string' does to minimize searches and stuff,
1646           ;; I will assume that people generally will put so few
1647           ;; matches on numbers that any cleverness will take more
1648           ;; time than one would gain.
1649           (while (setq article (pop articles))
1650             (when (and
1651                    (setq l (aref (car article) gnus-score-index))
1652                    (funcall match-func match (gnus-date-iso8601 l)))
1653               (when trace
1654                 (push (cons (car-safe (rassq alist gnus-score-cache)) kill)
1655                       gnus-score-trace))
1656               (setq found t)
1657               (setcdr article (+ score (cdr article)))))
1658           ;; Update expire date
1659           (cond ((null date))           ;Permanent entry.
1660                 ((and found gnus-update-score-entry-dates) ;Match, update date.
1661                  (gnus-score-set 'touched '(t) alist)
1662                  (setcar (nthcdr 2 kill) now))
1663                 ((and expire (< date expire)) ;Old entry, remove.
1664                  (gnus-score-set 'touched '(t) alist)
1665                  (setcdr entries (cdr rest))
1666                  (setq rest entries)))
1667           (setq entries rest)))))
1668   nil)
1669
1670 (defun gnus-score-body (scores header now expire &optional trace)
1671   (save-excursion
1672     (setq gnus-scores-articles
1673           (sort gnus-scores-articles
1674                 (lambda (a1 a2)
1675                   (< (mail-header-number (car a1))
1676                      (mail-header-number (car a2))))))
1677     (set-buffer nntp-server-buffer)
1678     (save-restriction
1679       (let* ((buffer-read-only nil)
1680              (articles gnus-scores-articles)
1681              (all-scores scores)
1682              (request-func (cond ((string= "head" header)
1683                                   'gnus-request-head)
1684                                  ((string= "body" header)
1685                                   'gnus-request-body)
1686                                  (t 'gnus-request-article)))
1687              entries alist ofunc article last)
1688         (when articles
1689           (setq last (mail-header-number (caar (last articles))))
1690           ;; Not all backends support partial fetching.  In that case,
1691           ;; we just fetch the entire article.
1692           (unless (gnus-check-backend-function
1693                    (and (string-match "^gnus-" (symbol-name request-func))
1694                         (intern (substring (symbol-name request-func)
1695                                            (match-end 0))))
1696                    gnus-newsgroup-name)
1697             (setq ofunc request-func)
1698             (setq request-func 'gnus-request-article))
1699           (while articles
1700             (setq article (mail-header-number (caar articles)))
1701             (gnus-message 7 "Scoring article %s of %s..." article last)
1702             (widen)
1703             (when (funcall request-func article gnus-newsgroup-name)
1704               (goto-char (point-min))
1705               ;; If just parts of the article is to be searched, but the
1706               ;; backend didn't support partial fetching, we just narrow
1707               ;; to the relevant parts.
1708               (when ofunc
1709                 (if (eq ofunc 'gnus-request-head)
1710                     (narrow-to-region
1711                      (point)
1712                      (or (search-forward "\n\n" nil t) (point-max)))
1713                   (narrow-to-region
1714                    (or (search-forward "\n\n" nil t) (point))
1715                    (point-max))))
1716               (setq scores all-scores)
1717               ;; Find matches.
1718               (while scores
1719                 (setq alist (pop scores)
1720                       entries (assoc header alist))
1721                 (while (cdr entries)    ;First entry is the header index.
1722                   (let* ((rest (cdr entries))
1723                          (kill (car rest))
1724                          (match (nth 0 kill))
1725                          (type (or (nth 3 kill) 's))
1726                          (score (or (nth 1 kill)
1727                                     gnus-score-interactive-default-score))
1728                          (date (nth 2 kill))
1729                          (found nil)
1730                          (case-fold-search
1731                           (not (or (eq type 'R) (eq type 'S)
1732                                    (eq type 'Regexp) (eq type 'String))))
1733                          (search-func
1734                           (cond ((or (eq type 'r) (eq type 'R)
1735                                      (eq type 'regexp) (eq type 'Regexp))
1736                                  're-search-forward)
1737                                 ((or (eq type 's) (eq type 'S)
1738                                      (eq type 'string) (eq type 'String))
1739                                  'search-forward)
1740                                 (t
1741                                  (error "Invalid match type: %s" type)))))
1742                     (goto-char (point-min))
1743                     (when (funcall search-func match nil t)
1744                       ;; Found a match, update scores.
1745                       (setcdr (car articles) (+ score (cdar articles)))
1746                       (setq found t)
1747                       (when trace
1748                         (push
1749                          (cons (car-safe (rassq alist gnus-score-cache)) kill)
1750                          gnus-score-trace)))
1751                     ;; Update expire date
1752                     (unless trace
1753                       (cond
1754                        ((null date))    ;Permanent entry.
1755                        ((and found gnus-update-score-entry-dates)
1756                         ;; Match, update date.
1757                         (gnus-score-set 'touched '(t) alist)
1758                         (setcar (nthcdr 2 kill) now))
1759                        ((and expire (< date expire)) ;Old entry, remove.
1760                         (gnus-score-set 'touched '(t) alist)
1761                         (setcdr entries (cdr rest))
1762                         (setq rest entries))))
1763                     (setq entries rest)))))
1764             (setq articles (cdr articles)))))))
1765   nil)
1766
1767 (defun gnus-score-thread (scores header now expire &optional trace)
1768   (gnus-score-followup scores header now expire trace t))
1769
1770 (defun gnus-score-followup (scores header now expire &optional trace thread)
1771   ;; Insert the unique article headers in the buffer.
1772   (let ((gnus-score-index (nth 1 (assoc header gnus-header-index)))
1773         (current-score-file gnus-current-score-file)
1774         (all-scores scores)
1775         ;; gnus-score-index is used as a free variable.
1776         alike last this art entries alist articles
1777         new news)
1778
1779     ;; Change score file to the adaptive score file.  All entries that
1780     ;; this function makes will be put into this file.
1781     (save-excursion
1782       (set-buffer gnus-summary-buffer)
1783       (gnus-score-load-file
1784        (or gnus-newsgroup-adaptive-score-file
1785            (gnus-score-file-name
1786             gnus-newsgroup-name gnus-adaptive-file-suffix))))
1787
1788     (setq gnus-scores-articles (sort gnus-scores-articles 'gnus-score-string<)
1789           articles gnus-scores-articles)
1790
1791     (erase-buffer)
1792     (while articles
1793       (setq art (car articles)
1794             this (aref (car art) gnus-score-index)
1795             articles (cdr articles))
1796       (if (equal last this)
1797           (push art alike)
1798         (when last
1799           (insert last ?\n)
1800           (put-text-property (1- (point)) (point) 'articles alike))
1801         (setq alike (list art)
1802               last this)))
1803     (when last                          ; Bwadr, duplicate code.
1804       (insert last ?\n)
1805       (put-text-property (1- (point)) (point) 'articles alike))
1806
1807     ;; Find matches.
1808     (while scores
1809       (setq alist (car scores)
1810             scores (cdr scores)
1811             entries (assoc header alist))
1812       (while (cdr entries)              ;First entry is the header index.
1813         (let* ((rest (cdr entries))
1814                (kill (car rest))
1815                (match (nth 0 kill))
1816                (type (or (nth 3 kill) 's))
1817                (score (or (nth 1 kill) gnus-score-interactive-default-score))
1818                (date (nth 2 kill))
1819                (found nil)
1820                (mt (aref (symbol-name type) 0))
1821                (case-fold-search
1822                 (not (or (= mt ?R) (= mt ?S) (= mt ?E) (= mt ?F))))
1823                (dmt (downcase mt))
1824                (search-func
1825                 (cond ((= dmt ?r) 're-search-forward)
1826                       ((or (= dmt ?e) (= dmt ?s) (= dmt ?f)) 'search-forward)
1827                       (t (error "Invalid match type: %s" type))))
1828                arts art)
1829           (goto-char (point-min))
1830           (if (= dmt ?e)
1831               (while (funcall search-func match nil t)
1832                 (and (= (progn (beginning-of-line) (point))
1833                         (match-beginning 0))
1834                      (= (progn (end-of-line) (point))
1835                         (match-end 0))
1836                      (progn
1837                        (setq found (setq arts (get-text-property
1838                                                (point) 'articles)))
1839                        ;; Found a match, update scores.
1840                        (while arts
1841                          (setq art (car arts)
1842                                arts (cdr arts))
1843                          (gnus-score-add-followups
1844                           (car art) score all-scores thread))))
1845                 (end-of-line))
1846             (while (funcall search-func match nil t)
1847               (end-of-line)
1848               (setq found (setq arts (get-text-property (point) 'articles)))
1849               ;; Found a match, update scores.
1850               (while (setq art (pop arts))
1851                 (when (setq new (gnus-score-add-followups
1852                                  (car art) score all-scores thread))
1853                   (push new news)))))
1854           ;; Update expire date
1855           (cond ((null date))           ;Permanent entry.
1856                 ((and found gnus-update-score-entry-dates) ;Match, update date.
1857                  (gnus-score-set 'touched '(t) alist)
1858                  (setcar (nthcdr 2 kill) now))
1859                 ((and expire (< date expire)) ;Old entry, remove.
1860                  (gnus-score-set 'touched '(t) alist)
1861                  (setcdr entries (cdr rest))
1862                  (setq rest entries)))
1863           (setq entries rest))))
1864     ;; We change the score file back to the previous one.
1865     (save-excursion
1866       (set-buffer gnus-summary-buffer)
1867       (gnus-score-load-file current-score-file))
1868     (list (cons "references" news))))
1869
1870 (defun gnus-score-add-followups (header score scores &optional thread)
1871   "Add a score entry to the adapt file."
1872   (save-excursion
1873     (set-buffer gnus-summary-buffer)
1874     (let* ((id (mail-header-id header))
1875            (scores (car scores))
1876            entry dont)
1877       ;; Don't enter a score if there already is one.
1878       (while (setq entry (pop scores))
1879         (and (equal "references" (car entry))
1880              (or (null (nth 3 (cadr entry)))
1881                  (eq 's (nth 3 (cadr entry))))
1882              (assoc id entry)
1883              (setq dont t)))
1884       (unless dont
1885         (gnus-summary-score-entry
1886          (if thread "thread" "references")
1887          id 's score (current-time-string) nil t)))))
1888
1889 (defun gnus-score-string (score-list header now expire &optional trace)
1890   ;; Score ARTICLES according to HEADER in SCORE-LIST.
1891   ;; Update matching entries to NOW and remove unmatched entries older
1892   ;; than EXPIRE.
1893
1894   ;; Insert the unique article headers in the buffer.
1895   (let ((gnus-score-index (nth 1 (assoc header gnus-header-index)))
1896         ;; gnus-score-index is used as a free variable.
1897         (simplify (and gnus-score-thread-simplify
1898                        (string= "subject" header)))
1899         alike last this art entries alist articles
1900         fuzzies arts words kill)
1901
1902     ;; Sorting the articles costs os O(N*log N) but will allow us to
1903     ;; only match with each unique header.  Thus the actual matching
1904     ;; will be O(M*U) where M is the number of strings to match with,
1905     ;; and U is the number of unique headers.  It is assumed (but
1906     ;; untested) this will be a net win because of the large constant
1907     ;; factor involved with string matching.
1908     (setq gnus-scores-articles
1909           ;; We cannot string-sort the extra headers list.  *sigh*
1910           (if (= gnus-score-index 9)
1911               gnus-scores-articles
1912             (sort gnus-scores-articles 'gnus-score-string<))
1913           articles gnus-scores-articles)
1914
1915     (erase-buffer)
1916     (while (setq art (pop articles))
1917       (setq this (aref (car art) gnus-score-index))
1918
1919       ;; If we're working with non-standard headers, we are stuck
1920       ;; with working on them as a group.  What a hassle.
1921       ;; Just wait 'til you see what horrors we commit against `match'...
1922       (if (= gnus-score-index 9)
1923           (setq this (prin1-to-string this))) ; ick.
1924
1925       (if simplify
1926           (setq this (gnus-map-function gnus-simplify-subject-functions this)))
1927       (if (equal last this)
1928           ;; O(N*H) cons-cells used here, where H is the number of
1929           ;; headers.
1930           (push art alike)
1931         (when last
1932           ;; Insert the line, with a text property on the
1933           ;; terminating newline referring to the articles with
1934           ;; this line.
1935           (insert last ?\n)
1936           (put-text-property (1- (point)) (point) 'articles alike))
1937         (setq alike (list art)
1938               last this)))
1939     (when last                          ; Bwadr, duplicate code.
1940       (insert last ?\n)
1941       (put-text-property (1- (point)) (point) 'articles alike))
1942
1943     ;; Go through all the score alists and pick out the entries
1944     ;; for this header.
1945     (while score-list
1946       (setq alist (pop score-list)
1947             ;; There's only one instance of this header for
1948             ;; each score alist.
1949             entries (assoc header alist))
1950       (while (cdr entries)              ;First entry is the header index.
1951         (let* ((kill (cadr entries))
1952                (type (or (nth 3 kill) 's))
1953                (score (or (nth 1 kill) gnus-score-interactive-default-score))
1954                (date (nth 2 kill))
1955                (extra (nth 4 kill))     ; non-standard header; string.
1956                (found nil)
1957                (mt (aref (symbol-name type) 0))
1958                (case-fold-search (not (memq mt '(?R ?S ?E ?F))))
1959                (dmt (downcase mt))
1960                ;; Assume user already simplified regexp and fuzzies
1961                (match (if (and simplify (not (memq dmt '(?f ?r))))
1962                           (gnus-map-function
1963                            gnus-simplify-subject-functions
1964                            (nth 0 kill))
1965                         (nth 0 kill)))
1966                (search-func
1967                 (cond ((= dmt ?r) 're-search-forward)
1968                       ((or (= dmt ?e) (= dmt ?s) (= dmt ?f)) 'search-forward)
1969                       ((= dmt ?w) nil)
1970                       (t (error "Invalid match type: %s" type)))))
1971
1972           ;; Evil hackery to make match usable in non-standard headers.
1973           (when extra
1974             (setq match (concat "[ (](" extra " \\. \"[^)]*"
1975                                 match "[^(]*\")[ )]")
1976                   search-func 're-search-forward)) ; XXX danger?!?
1977
1978           (cond
1979            ;; Fuzzy matches.  We save these for later.
1980            ((= dmt ?f)
1981             (push (cons entries alist) fuzzies)
1982             (setq entries (cdr entries)))
1983            ;; Word matches.  Save these for even later.
1984            ((= dmt ?w)
1985             (push (cons entries alist) words)
1986             (setq entries (cdr entries)))
1987            ;; Exact matches.
1988            ((= dmt ?e)
1989             ;; Do exact matching.
1990             (goto-char (point-min))
1991             (while (and (not (eobp))
1992                         (funcall search-func match nil t))
1993               ;; Is it really exact?
1994               (and (eolp)
1995                    (= (gnus-point-at-bol) (match-beginning 0))
1996                    ;; Yup.
1997                    (progn
1998                      (setq found (setq arts (get-text-property
1999                                              (point) 'articles)))
2000                      ;; Found a match, update scores.
2001                      (if trace
2002                          (while (setq art (pop arts))
2003                            (setcdr art (+ score (cdr art)))
2004                            (push
2005                             (cons
2006                              (car-safe (rassq alist gnus-score-cache))
2007                              kill)
2008                             gnus-score-trace))
2009                        (while (setq art (pop arts))
2010                          (setcdr art (+ score (cdr art)))))))
2011               (forward-line 1))
2012             ;; Update expiry date
2013             (if trace
2014                 (setq entries (cdr entries))
2015               (cond
2016                ;; Permanent entry.
2017                ((null date)
2018                 (setq entries (cdr entries)))
2019                ;; We have a match, so we update the date.
2020                ((and found gnus-update-score-entry-dates)
2021                 (gnus-score-set 'touched '(t) alist)
2022                 (setcar (nthcdr 2 kill) now)
2023                 (setq entries (cdr entries)))
2024                ;; This entry has expired, so we remove it.
2025                ((and expire (< date expire))
2026                 (gnus-score-set 'touched '(t) alist)
2027                 (setcdr entries (cddr entries)))
2028                ;; No match; go to next entry.
2029                (t
2030                 (setq entries (cdr entries))))))
2031            ;; Regexp and substring matching.
2032            (t
2033             (goto-char (point-min))
2034             (when (string= match "")
2035               (setq match "\n"))
2036             (while (and (not (eobp))
2037                         (funcall search-func match nil t))
2038               (goto-char (match-beginning 0))
2039               (end-of-line)
2040               (setq found (setq arts (get-text-property (point) 'articles)))
2041               ;; Found a match, update scores.
2042               (if trace
2043                   (while (setq art (pop arts))
2044                     (setcdr art (+ score (cdr art)))
2045                     (push (cons (car-safe (rassq alist gnus-score-cache)) kill)
2046                           gnus-score-trace))
2047                 (while (setq art (pop arts))
2048                   (setcdr art (+ score (cdr art)))))
2049               (forward-line 1))
2050             ;; Update expiry date
2051             (if trace
2052                 (setq entries (cdr entries))
2053               (cond
2054                ;; Permanent entry.
2055                ((null date)
2056                 (setq entries (cdr entries)))
2057                ;; We have a match, so we update the date.
2058                ((and found gnus-update-score-entry-dates)
2059                 (gnus-score-set 'touched '(t) alist)
2060                 (setcar (nthcdr 2 kill) now)
2061                 (setq entries (cdr entries)))
2062                ;; This entry has expired, so we remove it.
2063                ((and expire (< date expire))
2064                 (gnus-score-set 'touched '(t) alist)
2065                 (setcdr entries (cddr entries)))
2066                ;; No match; go to next entry.
2067                (t
2068                 (setq entries (cdr entries))))))))))
2069
2070     ;; Find fuzzy matches.
2071     (when fuzzies
2072       ;; Simplify the entire buffer for easy matching.
2073       (gnus-simplify-buffer-fuzzy)
2074       (while (setq kill (cadaar fuzzies))
2075         (let* ((match (nth 0 kill))
2076                (type (nth 3 kill))
2077                (score (or (nth 1 kill) gnus-score-interactive-default-score))
2078                (date (nth 2 kill))
2079                (mt (aref (symbol-name type) 0))
2080                (case-fold-search (not (= mt ?F)))
2081                found)
2082           (goto-char (point-min))
2083           (while (and (not (eobp))
2084                       (search-forward match nil t))
2085             (when (and (= (gnus-point-at-bol) (match-beginning 0))
2086                        (eolp))
2087               (setq found (setq arts (get-text-property (point) 'articles)))
2088               (if trace
2089                   (while (setq art (pop arts))
2090                     (setcdr art (+ score (cdr art)))
2091                     (push (cons
2092                            (car-safe (rassq (cdar fuzzies) gnus-score-cache))
2093                            kill)
2094                           gnus-score-trace))
2095                 ;; Found a match, update scores.
2096                 (while (setq art (pop arts))
2097                   (setcdr art (+ score (cdr art))))))
2098             (forward-line 1))
2099           ;; Update expiry date
2100           (if (not trace)
2101               (cond
2102                ;; Permanent.
2103                ((null date)
2104                 ;; Do nothing.
2105                 )
2106                ;; Match, update date.
2107                ((and found gnus-update-score-entry-dates)
2108                 (gnus-score-set 'touched '(t) (cdar fuzzies))
2109                 (setcar (nthcdr 2 kill) now))
2110                ;; Old entry, remove.
2111                ((and expire (< date expire))
2112                 (gnus-score-set 'touched '(t) (cdar fuzzies))
2113                 (setcdr (caar fuzzies) (cddaar fuzzies)))))
2114           (setq fuzzies (cdr fuzzies)))))
2115
2116     (when words
2117       ;; Enter all words into the hashtb.
2118       (let ((hashtb (gnus-make-hashtable
2119                      (* 10 (count-lines (point-min) (point-max))))))
2120         (gnus-enter-score-words-into-hashtb hashtb)
2121         (while (setq kill (cadaar words))
2122           (let* ((score (or (nth 1 kill) gnus-score-interactive-default-score))
2123                  (date (nth 2 kill))
2124                  found)
2125             (when (setq arts (intern-soft (nth 0 kill) hashtb))
2126               (setq arts (symbol-value arts))
2127               (setq found t)
2128               (if trace
2129                   (while (setq art (pop arts))
2130                     (setcdr art (+ score (cdr art)))
2131                     (push (cons
2132                            (car-safe (rassq (cdar words) gnus-score-cache))
2133                            kill)
2134                           gnus-score-trace))
2135                 ;; Found a match, update scores.
2136                 (while (setq art (pop arts))
2137                   (setcdr art (+ score (cdr art))))))
2138             ;; Update expiry date
2139             (if (not trace)
2140                 (cond
2141                  ;; Permanent.
2142                  ((null date)
2143                   ;; Do nothing.
2144                   )
2145                  ;; Match, update date.
2146                  ((and found gnus-update-score-entry-dates)
2147                   (gnus-score-set 'touched '(t) (cdar words))
2148                   (setcar (nthcdr 2 kill) now))
2149                  ;; Old entry, remove.
2150                  ((and expire (< date expire))
2151                   (gnus-score-set 'touched '(t) (cdar words))
2152                   (setcdr (caar words) (cddaar words)))))
2153             (setq words (cdr words))))))
2154     nil))
2155
2156 (defun gnus-enter-score-words-into-hashtb (hashtb)
2157   ;; Find all the words in the buffer and enter them into
2158   ;; the hashtable.
2159   (let ((syntab (syntax-table))
2160         word val)
2161     (goto-char (point-min))
2162     (unwind-protect
2163         (progn
2164           (set-syntax-table gnus-adaptive-word-syntax-table)
2165           (while (re-search-forward "\\b\\w+\\b" nil t)
2166             (setq val
2167                   (gnus-gethash
2168                    (setq word (downcase (buffer-substring
2169                                          (match-beginning 0) (match-end 0))))
2170                    hashtb))
2171             (gnus-sethash
2172              word
2173              (append (get-text-property (gnus-point-at-eol) 'articles) val)
2174              hashtb)))
2175       (set-syntax-table syntab))
2176     ;; Make all the ignorable words ignored.
2177     (let ((ignored (append gnus-ignored-adaptive-words
2178                            (if gnus-adaptive-word-no-group-words
2179                                (message-tokenize-header
2180                                 (gnus-group-real-name gnus-newsgroup-name)
2181                                 "."))
2182                            gnus-default-ignored-adaptive-words)))
2183       (while ignored
2184         (gnus-sethash (pop ignored) nil hashtb)))))
2185
2186 (defun gnus-score-string< (a1 a2)
2187   ;; Compare headers in articles A2 and A2.
2188   ;; The header index used is the free variable `gnus-score-index'.
2189   (string-lessp (aref (car a1) gnus-score-index)
2190                 (aref (car a2) gnus-score-index)))
2191
2192 (defun gnus-current-score-file-nondirectory (&optional score-file)
2193   (let ((score-file (or score-file gnus-current-score-file)))
2194     (if score-file
2195         (gnus-short-group-name (file-name-nondirectory score-file))
2196       "none")))
2197
2198 (defun gnus-score-adaptive ()
2199   "Create adaptive score rules for this newsgroup."
2200   (when gnus-newsgroup-adaptive
2201     ;; We change the score file to the adaptive score file.
2202     (save-excursion
2203       (set-buffer gnus-summary-buffer)
2204       (gnus-score-load-file
2205        (or gnus-newsgroup-adaptive-score-file
2206            (gnus-home-score-file gnus-newsgroup-name t)
2207            (gnus-score-file-name
2208             gnus-newsgroup-name gnus-adaptive-file-suffix))))
2209     ;; Perform ordinary line scoring.
2210     (when (or (not (listp gnus-newsgroup-adaptive))
2211               (memq 'line gnus-newsgroup-adaptive))
2212       (save-excursion
2213         (let* ((malist (gnus-copy-sequence gnus-adaptive-score-alist))
2214                (alist malist)
2215                (date (current-time-string))
2216                (data gnus-newsgroup-data)
2217                elem headers match func)
2218           ;; First we transform the adaptive rule alist into something
2219           ;; that's faster to process.
2220           (while malist
2221             (setq elem (car malist))
2222             (when (symbolp (car elem))
2223               (setcar elem (symbol-value (car elem))))
2224             (setq elem (cdr elem))
2225             (while elem
2226               (when (fboundp
2227                      (setq func
2228                            (intern
2229                             (concat "mail-header-"
2230                                     (if (eq (caar elem) 'followup)
2231                                         "message-id"
2232                                       (downcase (symbol-name (caar elem))))))))
2233                 (setcdr (car elem)
2234                         (cons (if (eq (caar elem) 'followup)
2235                                   "references"
2236                                 (symbol-name (caar elem)))
2237                               (cdar elem)))
2238                 (setcar (car elem)
2239                         `(lambda (h)
2240                            (,func h))))
2241               (setq elem (cdr elem)))
2242             (setq malist (cdr malist)))
2243           ;; Then we score away.
2244           (while data
2245             (setq elem (cdr (assq (gnus-data-mark (car data)) alist)))
2246             (if (or (not elem)
2247                     (gnus-data-pseudo-p (car data)))
2248                 ()
2249               (when (setq headers (gnus-data-header (car data)))
2250                 (while elem
2251                   (setq match (funcall (caar elem) headers))
2252                   (gnus-summary-score-entry
2253                    (nth 1 (car elem)) match
2254                    (cond
2255                     ((numberp match)
2256                      '=)
2257                     ((equal (nth 1 (car elem)) "date")
2258                      'a)
2259                     (t
2260                      ;; Whether we use substring or exact matches is
2261                      ;; controlled here.
2262                      (if (or (not gnus-score-exact-adapt-limit)
2263                              (< (length match) gnus-score-exact-adapt-limit))
2264                          'e
2265                        (if (equal (nth 1 (car elem)) "subject")
2266                            'f 's))))
2267                    (nth 2 (car elem)) date nil t)
2268                   (setq elem (cdr elem)))))
2269             (setq data (cdr data))))))
2270
2271     ;; Perform adaptive word scoring.
2272     (when (and (listp gnus-newsgroup-adaptive)
2273                (memq 'word gnus-newsgroup-adaptive))
2274       (with-temp-buffer
2275         (let* ((hashtb (gnus-make-hashtable 1000))
2276                (date (date-to-day (current-time-string)))
2277                (data gnus-newsgroup-data)
2278                (syntab (syntax-table))
2279                word d score val)
2280           (unwind-protect
2281               (progn
2282                 (set-syntax-table gnus-adaptive-word-syntax-table)
2283                 ;; Go through all articles.
2284                 (while (setq d (pop data))
2285                   (when (and
2286                          (not (gnus-data-pseudo-p d))
2287                          (setq score
2288                                (cdr (assq
2289                                      (gnus-data-mark d)
2290                                      gnus-adaptive-word-score-alist))))
2291                     ;; This article has a mark that should lead to
2292                     ;; adaptive word rules, so we insert the subject
2293                     ;; and find all words in that string.
2294                     (insert (mail-header-subject (gnus-data-header d)))
2295                     (downcase-region (point-min) (point-max))
2296                     (goto-char (point-min))
2297                     (while (re-search-forward "\\b\\w+\\b" nil t)
2298                       ;; Put the word and score into the hashtb.
2299                       (setq val (gnus-gethash (setq word (match-string 0))
2300                                               hashtb))
2301                       (setq val (+ score (or val 0)))
2302                       (if (and gnus-adaptive-word-minimum
2303                                (< val gnus-adaptive-word-minimum))
2304                           (setq val gnus-adaptive-word-minimum))
2305                       (gnus-sethash word val hashtb))
2306                     (erase-buffer))))
2307             (set-syntax-table syntab))
2308           ;; Make all the ignorable words ignored.
2309           (let ((ignored (append gnus-ignored-adaptive-words
2310                                  (if gnus-adaptive-word-no-group-words
2311                                      (message-tokenize-header
2312                                       (gnus-group-real-name
2313                                        gnus-newsgroup-name)
2314                                       "."))
2315                                  gnus-default-ignored-adaptive-words)))
2316             (while ignored
2317               (gnus-sethash (pop ignored) nil hashtb)))
2318           ;; Now we have all the words and scores, so we
2319           ;; add these rules to the ADAPT file.
2320           (set-buffer gnus-summary-buffer)
2321           (mapatoms
2322            (lambda (word)
2323              (when (symbol-value word)
2324                (gnus-summary-score-entry
2325                 "subject" (symbol-name word) 'w (symbol-value word)
2326                 date nil t)))
2327            hashtb))))))
2328
2329 (defun gnus-score-edit-done ()
2330   (let ((bufnam (buffer-file-name (current-buffer)))
2331         (winconf gnus-prev-winconf))
2332     (when winconf
2333       (set-window-configuration winconf))
2334     (gnus-score-remove-from-cache bufnam)
2335     (gnus-score-load-file bufnam)))
2336
2337 (defun gnus-score-find-trace ()
2338   "Find all score rules that applies to the current article."
2339   (interactive)
2340   (let ((old-scored gnus-newsgroup-scored))
2341     (let ((gnus-newsgroup-headers
2342            (list (gnus-summary-article-header)))
2343           (gnus-newsgroup-scored nil)
2344           trace)
2345       (save-excursion
2346         (nnheader-set-temp-buffer "*Score Trace*"))
2347       (setq gnus-score-trace nil)
2348       (gnus-possibly-score-headers 'trace)
2349       (if (not (setq trace gnus-score-trace))
2350           (gnus-error
2351            1 "No score rules apply to the current article (default score %d)."
2352            gnus-summary-default-score)
2353         (set-buffer "*Score Trace*")
2354         (setq truncate-lines t)
2355         (while trace
2356           (insert (format "%S  ->  %s\n" (cdar trace)
2357                           (or (caar trace) "(non-file rule)")))
2358           (setq trace (cdr trace)))
2359         (goto-char (point-min))
2360         (gnus-configure-windows 'score-trace)))
2361     (set-buffer gnus-summary-buffer)
2362     (setq gnus-newsgroup-scored old-scored)))
2363
2364 (defun gnus-score-find-favourite-words ()
2365   "List words used in scoring."
2366   (interactive)
2367   (let ((alists (gnus-score-load-files (gnus-all-score-files)))
2368         alist rule rules kill)
2369     ;; Go through all the score alists for this group
2370     ;; and find all `w' rules.
2371     (while (setq alist (pop alists))
2372       (while (setq rule (pop alist))
2373         (when (and (stringp (car rule))
2374                    (equal "subject" (downcase (pop rule))))
2375           (while (setq kill (pop rule))
2376             (when (memq (nth 3 kill) '(w W word Word))
2377               (push (cons (or (nth 1 kill)
2378                               gnus-score-interactive-default-score)
2379                           (car kill))
2380                     rules))))))
2381     (setq rules (sort rules (lambda (r1 r2)
2382                               (string-lessp (cdr r1) (cdr r2)))))
2383     ;; Add up words that have appeared several times.
2384     (let ((r rules))
2385       (while (cdr r)
2386         (if (equal (cdar r) (cdadr r))
2387             (progn
2388               (setcar (car r) (+ (caar r) (caadr r)))
2389               (setcdr r (cddr r)))
2390           (pop r))))
2391     ;; Insert the words.
2392     (nnheader-set-temp-buffer "*Score Words*")
2393     (if (not (setq rules (sort rules (lambda (r1 r2) (> (car r1) (car r2))))))
2394         (gnus-error 3 "No word score rules")
2395       (while rules
2396         (insert (format "%-5d: %s\n" (caar rules) (cdar rules)))
2397         (pop rules))
2398       (goto-char (point-min))
2399       (gnus-configure-windows 'score-words))))
2400
2401 (defun gnus-summary-rescore ()
2402   "Redo the entire scoring process in the current summary."
2403   (interactive)
2404   (gnus-score-save)
2405   (setq gnus-score-cache nil)
2406   (setq gnus-newsgroup-scored nil)
2407   (gnus-possibly-score-headers)
2408   (gnus-score-update-all-lines))
2409
2410 (defun gnus-score-flush-cache ()
2411   "Flush the cache of score files."
2412   (interactive)
2413   (gnus-score-save)
2414   (setq gnus-score-cache nil
2415         gnus-score-alist nil
2416         gnus-short-name-score-file-cache nil)
2417   (gnus-message 6 "The score cache is now flushed"))
2418
2419 (gnus-add-shutdown 'gnus-score-close 'gnus)
2420
2421 (defvar gnus-score-file-alist-cache nil)
2422
2423 (defun gnus-score-close ()
2424   "Clear all internal score variables."
2425   (setq gnus-score-cache nil
2426         gnus-internal-global-score-files nil
2427         gnus-score-file-list nil
2428         gnus-score-file-alist-cache nil))
2429
2430 ;; Summary score marking commands.
2431
2432 (defun gnus-summary-raise-same-subject-and-select (score)
2433   "Raise articles which has the same subject with SCORE and select the next."
2434   (interactive "p")
2435   (let ((subject (gnus-summary-article-subject)))
2436     (gnus-summary-raise-score score)
2437     (while (gnus-summary-find-subject subject)
2438       (gnus-summary-raise-score score))
2439     (gnus-summary-next-article t)))
2440
2441 (defun gnus-summary-raise-same-subject (score)
2442   "Raise articles which has the same subject with SCORE."
2443   (interactive "p")
2444   (let ((subject (gnus-summary-article-subject)))
2445     (gnus-summary-raise-score score)
2446     (while (gnus-summary-find-subject subject)
2447       (gnus-summary-raise-score score))
2448     (gnus-summary-next-subject 1 t)))
2449
2450 (defun gnus-score-delta-default (level)
2451   (if level (prefix-numeric-value level)
2452     gnus-score-interactive-default-score))
2453
2454 (defun gnus-summary-raise-thread (&optional score)
2455   "Raise the score of the articles in the current thread with SCORE."
2456   (interactive "P")
2457   (setq score (gnus-score-delta-default score))
2458   (let (e)
2459     (save-excursion
2460       (let ((articles (gnus-summary-articles-in-thread)))
2461         (while articles
2462           (gnus-summary-goto-subject (car articles))
2463           (gnus-summary-raise-score score)
2464           (setq articles (cdr articles))))
2465       (setq e (point)))
2466     (let ((gnus-summary-check-current t))
2467       (unless (zerop (gnus-summary-next-subject 1 t))
2468         (goto-char e))))
2469   (gnus-summary-recenter)
2470   (gnus-summary-position-point)
2471   (gnus-set-mode-line 'summary))
2472
2473 (defun gnus-summary-lower-same-subject-and-select (score)
2474   "Raise articles which has the same subject with SCORE and select the next."
2475   (interactive "p")
2476   (gnus-summary-raise-same-subject-and-select (- score)))
2477
2478 (defun gnus-summary-lower-same-subject (score)
2479   "Raise articles which has the same subject with SCORE."
2480   (interactive "p")
2481   (gnus-summary-raise-same-subject (- score)))
2482
2483 (defun gnus-summary-lower-thread (&optional score)
2484   "Lower score of articles in the current thread with SCORE."
2485   (interactive "P")
2486   (gnus-summary-raise-thread (- (1- (gnus-score-delta-default score)))))
2487
2488 ;;; Finding score files.
2489
2490 (defun gnus-score-score-files (group)
2491   "Return a list of all possible score files."
2492   ;; Search and set any global score files.
2493   (when gnus-global-score-files
2494     (unless gnus-internal-global-score-files
2495       (gnus-score-search-global-directories gnus-global-score-files)))
2496   ;; Fix the kill-file dir variable.
2497   (setq gnus-kill-files-directory
2498         (file-name-as-directory gnus-kill-files-directory))
2499   ;; If we can't read it, there are no score files.
2500   (if (not (file-exists-p (expand-file-name gnus-kill-files-directory)))
2501       (setq gnus-score-file-list nil)
2502     (if (not (gnus-use-long-file-name 'not-score))
2503         ;; We do not use long file names, so we have to do some
2504         ;; directory traversing.
2505         (setq gnus-score-file-list
2506               (cons nil
2507                     (or gnus-short-name-score-file-cache
2508                         (prog2
2509                             (gnus-message 6 "Finding all score files...")
2510                             (setq gnus-short-name-score-file-cache
2511                                   (gnus-score-score-files-1
2512                                    gnus-kill-files-directory))
2513                           (gnus-message 6 "Finding all score files...done")))))
2514       ;; We want long file names.
2515       (when (or (not gnus-score-file-list)
2516                 (not (car gnus-score-file-list))
2517                 (gnus-file-newer-than gnus-kill-files-directory
2518                                       (car gnus-score-file-list)))
2519         (setq gnus-score-file-list
2520               (cons (nth 5 (file-attributes gnus-kill-files-directory))
2521                     (nreverse
2522                      (directory-files
2523                       gnus-kill-files-directory t
2524                       (gnus-score-file-regexp)))))))
2525     (cdr gnus-score-file-list)))
2526
2527 (defun gnus-score-score-files-1 (dir)
2528   "Return all possible score files under DIR."
2529   (let ((files (list (expand-file-name dir)))
2530         (regexp (gnus-score-file-regexp))
2531         (case-fold-search nil)
2532         seen out file)
2533     (while (setq file (pop files))
2534       (cond
2535        ;; Ignore files that start with a dot.
2536        ((string-match "^\\." (file-name-nondirectory file))
2537         nil)
2538        ;; Add subtrees of directory to also be searched.
2539        ((and (file-directory-p file)
2540              (not (member (file-truename file) seen)))
2541         (push (file-truename file) seen)
2542         (setq files (nconc (directory-files file t nil t) files)))
2543        ;; Add files to the list of score files.
2544        ((string-match regexp file)
2545         (push file out))))
2546     (or out
2547         ;; Return a dummy value.
2548         (list "~/News/this.file.does.not.exist.SCORE"))))
2549
2550 (defun gnus-score-file-regexp ()
2551   "Return a regexp that match all score files."
2552   (concat "\\(" (regexp-quote gnus-score-file-suffix )
2553           "\\|" (regexp-quote gnus-adaptive-file-suffix) "\\)\\'"))
2554
2555 (defun gnus-score-find-bnews (group)
2556   "Return a list of score files for GROUP.
2557 The score files are those files in the ~/News/ directory which matches
2558 GROUP using BNews sys file syntax."
2559   (let* ((sfiles (append (gnus-score-score-files group)
2560                          gnus-internal-global-score-files))
2561          (kill-dir (file-name-as-directory
2562                     (expand-file-name gnus-kill-files-directory)))
2563          (klen (length kill-dir))
2564          (score-regexp (gnus-score-file-regexp))
2565          (trans (cdr (assq ?: nnheader-file-name-translation-alist)))
2566          (group-trans (nnheader-translate-file-chars group t))
2567          ofiles not-match regexp)
2568     (save-excursion
2569       (set-buffer (gnus-get-buffer-create "*gnus score files*"))
2570       (buffer-disable-undo)
2571       ;; Go through all score file names and create regexp with them
2572       ;; as the source.
2573       (while sfiles
2574         (erase-buffer)
2575         (insert (car sfiles))
2576         (goto-char (point-min))
2577         ;; First remove the suffix itself.
2578         (when (re-search-forward (concat "." score-regexp) nil t)
2579           (replace-match "" t t)
2580           (goto-char (point-min))
2581           (if (looking-at (regexp-quote kill-dir))
2582               ;; If the file name was just "SCORE", `klen' is one character
2583               ;; too much.
2584               (delete-char (min (1- (point-max)) klen))
2585             (goto-char (point-max))
2586             (search-backward "/")
2587             (delete-region (1+ (point)) (point-min)))
2588           ;; If short file names were used, we have to translate slashes.
2589           (goto-char (point-min))
2590           (let ((regexp (concat
2591                          "[/:" (if trans (char-to-string trans) "") "]")))
2592             (while (re-search-forward regexp nil t)
2593               (replace-match "." t t)))
2594           ;; Kludge to get rid of "nntp+" problems.
2595           (goto-char (point-min))
2596           (when (looking-at "nn[a-z]+\\+")
2597             (search-forward "+")
2598             (forward-char -1)
2599             (insert "\\")
2600             (forward-char 1))
2601           ;; Kludge to deal with "++".
2602           (while (search-forward "+" nil t)
2603             (replace-match "\\+" t t))
2604           ;; Translate "all" to ".*".
2605           (goto-char (point-min))
2606           (while (search-forward "all" nil t)
2607             (replace-match ".*" t t))
2608           (goto-char (point-min))
2609           ;; Deal with "not."s.
2610           (if (looking-at "not.")
2611               (progn
2612                 (setq not-match t)
2613                 (setq regexp
2614                       (concat "^" (buffer-substring 5 (point-max)) "$")))
2615             (setq regexp (concat "^" (buffer-substring 1 (point-max)) "$"))
2616             (setq not-match nil))
2617           ;; Finally - if this resulting regexp matches the group name,
2618           ;; we add this score file to the list of score files
2619           ;; applicable to this group.
2620           (when (or (and not-match
2621                          (ignore-errors
2622                            (not (string-match regexp group-trans))))
2623                     (and (not not-match)
2624                          (ignore-errors (string-match regexp group-trans))))
2625             (push (car sfiles) ofiles)))
2626         (setq sfiles (cdr sfiles)))
2627       (kill-buffer (current-buffer))
2628       ;; Slight kludge here - the last score file returned should be
2629       ;; the local score file, whether it exists or not.  This is so
2630       ;; that any score commands the user enters will go to the right
2631       ;; file, and not end up in some global score file.
2632       (let ((localscore (gnus-score-file-name group)))
2633         (setq ofiles (cons localscore (delete localscore ofiles))))
2634       (gnus-sort-score-files (nreverse ofiles)))))
2635
2636 (defun gnus-score-find-single (group)
2637   "Return list containing the score file for GROUP."
2638   (list (or gnus-newsgroup-adaptive-score-file
2639             (gnus-score-file-name group gnus-adaptive-file-suffix))
2640         (gnus-score-file-name group)))
2641
2642 (defun gnus-score-find-hierarchical (group)
2643   "Return list of score files for GROUP.
2644 This includes the score file for the group and all its parents."
2645   (let* ((prefix (gnus-group-real-prefix group))
2646          (all (list nil))
2647          (group (gnus-group-real-name group))
2648          (start 0))
2649     (while (string-match "\\." group (1+ start))
2650       (setq start (match-beginning 0))
2651       (push (substring group 0 start) all))
2652     (push group all)
2653     (setq all
2654           (nconc
2655            (mapcar (lambda (group)
2656                      (gnus-score-file-name group gnus-adaptive-file-suffix))
2657                    (setq all (nreverse all)))
2658            (mapcar 'gnus-score-file-name all)))
2659     (if (equal prefix "")
2660         all
2661       (mapcar
2662        (lambda (file)
2663          (nnheader-translate-file-chars
2664           (concat (file-name-directory file) prefix
2665                   (file-name-nondirectory file))))
2666        all))))
2667
2668 (defun gnus-score-file-rank (file)
2669   "Return a number that says how specific score FILE is.
2670 Destroys the current buffer."
2671   (if (member file gnus-internal-global-score-files)
2672       0
2673     (when (string-match
2674            (concat "^" (regexp-quote
2675                         (expand-file-name
2676                          (file-name-as-directory gnus-kill-files-directory))))
2677            file)
2678       (setq file (substring file (match-end 0))))
2679     (insert file)
2680     (goto-char (point-min))
2681     (let ((beg (point))
2682           elems)
2683       (while (re-search-forward "[./]" nil t)
2684         (push (buffer-substring beg (1- (point)))
2685               elems))
2686       (erase-buffer)
2687       (setq elems (delete "all" elems))
2688       (length elems))))
2689
2690 (defun gnus-sort-score-files (files)
2691   "Sort FILES so that the most general files come first."
2692   (with-temp-buffer
2693     (let ((alist
2694            (mapcar
2695             (lambda (file)
2696               (cons (inline (gnus-score-file-rank file)) file))
2697             files)))
2698       (mapcar
2699        (lambda (f) (cdr f))
2700        (sort alist 'car-less-than-car)))))
2701
2702 (defun gnus-score-find-alist (group)
2703   "Return list of score files for GROUP.
2704 The list is determined from the variable gnus-score-file-alist."
2705   (let ((alist gnus-score-file-multiple-match-alist)
2706         score-files)
2707     ;; if this group has been seen before, return the cached entry
2708     (if (setq score-files (assoc group gnus-score-file-alist-cache))
2709         (cdr score-files)               ;ensures caching groups with no matches
2710       ;; handle the multiple match alist
2711       (while alist
2712         (when (string-match (caar alist) group)
2713           (setq score-files
2714                 (nconc score-files (copy-sequence (cdar alist)))))
2715         (setq alist (cdr alist)))
2716       (setq alist gnus-score-file-single-match-alist)
2717       ;; handle the single match alist
2718       (while alist
2719         (when (string-match (caar alist) group)
2720           ;; progn used just in case ("regexp") has no files
2721           ;; and score-files is still nil.  -sj
2722           ;; this can be construed as a "stop searching here" feature :>
2723           ;; and used to simplify regexps in the single-alist
2724           (setq score-files
2725                 (nconc score-files (copy-sequence (cdar alist))))
2726           (setq alist nil))
2727         (setq alist (cdr alist)))
2728       ;; cache the score files
2729       (push (cons group score-files) gnus-score-file-alist-cache)
2730       score-files)))
2731
2732 (defun gnus-all-score-files (&optional group)
2733   "Return a list of all score files for the current group."
2734   (let ((funcs gnus-score-find-score-files-function)
2735         (group (or group gnus-newsgroup-name))
2736         score-files)
2737     (when group
2738       ;; Make sure funcs is a list.
2739       (and funcs
2740            (not (listp funcs))
2741            (setq funcs (list funcs)))
2742       ;; Get the initial score files for this group.
2743       (when funcs
2744         (setq score-files (nreverse (gnus-score-find-alist group))))
2745       ;; Add any home adapt files.
2746       (let ((home (gnus-home-score-file group t)))
2747         (when home
2748           (push home score-files)
2749           (setq gnus-newsgroup-adaptive-score-file home)))
2750       ;; Check whether there is a `adapt-file' group parameter.
2751       (let ((param-file (gnus-group-find-parameter group 'adapt-file)))
2752         (when param-file
2753           (push param-file score-files)
2754           (setq gnus-newsgroup-adaptive-score-file param-file)))
2755       ;; Go through all the functions for finding score files (or actual
2756       ;; scores) and add them to a list.
2757       (while funcs
2758         (when (gnus-functionp (car funcs))
2759           (setq score-files
2760                 (nconc score-files (nreverse (funcall (car funcs) group)))))
2761         (setq funcs (cdr funcs)))
2762       ;; Add any home score files.
2763       (let ((home (gnus-home-score-file group)))
2764         (when home
2765           (push home score-files)))
2766       ;; Check whether there is a `score-file' group parameter.
2767       (let ((param-file (gnus-group-find-parameter group 'score-file)))
2768         (when param-file
2769           (push param-file score-files)))
2770       ;; Expand all files names.
2771       (let ((files score-files))
2772         (while files
2773           (when (stringp (car files))
2774             (setcar files (expand-file-name
2775                            (car files) gnus-kill-files-directory)))
2776           (pop files)))
2777       (setq score-files (nreverse score-files))
2778       ;; Remove any duplicate score files.
2779       (while (and score-files
2780                   (member (car score-files) (cdr score-files)))
2781         (pop score-files))
2782       (let ((files score-files))
2783         (while (cdr files)
2784           (if (member (cadr files) (cddr files))
2785               (setcdr files (cddr files))
2786             (pop files))))
2787       ;; Do the scoring if there are any score files for this group.
2788       score-files)))
2789
2790 (defun gnus-possibly-score-headers (&optional trace)
2791   "Do scoring if scoring is required."
2792   (let ((score-files (gnus-all-score-files)))
2793     (when score-files
2794       (gnus-score-headers score-files trace))))
2795
2796 (defun gnus-score-file-name (newsgroup &optional suffix)
2797   "Return the name of a score file for NEWSGROUP."
2798   (let ((suffix (or suffix gnus-score-file-suffix)))
2799     (nnheader-translate-file-chars
2800      (cond
2801       ((or (null newsgroup)
2802            (string-equal newsgroup ""))
2803        ;; The global score file is placed at top of the directory.
2804        (expand-file-name suffix gnus-kill-files-directory))
2805       ((gnus-use-long-file-name 'not-score)
2806        ;; Append ".SCORE" to newsgroup name.
2807        (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2808                                  "." suffix)
2809                          gnus-kill-files-directory))
2810       (t
2811        ;; Place "SCORE" under the hierarchical directory.
2812        (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2813                                  "/" suffix)
2814                          gnus-kill-files-directory))))))
2815
2816 (defun gnus-score-search-global-directories (files)
2817   "Scan all global score directories for score files."
2818   ;; Set the variable `gnus-internal-global-score-files' to all
2819   ;; available global score files.
2820   (interactive (list gnus-global-score-files))
2821   (let (out)
2822     (while files
2823       ;; #### /$ Unix-specific?
2824       (if (string-match "/$" (car files))
2825           (setq out (nconc (directory-files
2826                             (car files) t
2827                             (concat (gnus-score-file-regexp) "$"))))
2828         (push (car files) out))
2829       (setq files (cdr files)))
2830     (setq gnus-internal-global-score-files out)))
2831
2832 (defun gnus-score-default-fold-toggle ()
2833   "Toggle folding for new score file entries."
2834   (interactive)
2835   (setq gnus-score-default-fold (not gnus-score-default-fold))
2836   (if gnus-score-default-fold
2837       (gnus-message 1 "New score file entries will be case insensitive.")
2838     (gnus-message 1 "New score file entries will be case sensitive.")))
2839
2840 ;;; Home score file.
2841
2842 (defun gnus-home-score-file (group &optional adapt)
2843   "Return the home score file for GROUP.
2844 If ADAPT, return the home adaptive file instead."
2845   (let ((list (if adapt gnus-home-adapt-file gnus-home-score-file))
2846         elem found)
2847     ;; Make sure we have a list.
2848     (unless (listp list)
2849       (setq list (list list)))
2850     ;; Go through the list and look for matches.
2851     (while (and (not found)
2852                 (setq elem (pop list)))
2853       (setq found
2854             (cond
2855              ;; Simple string.
2856              ((stringp elem)
2857               elem)
2858              ;; Function.
2859              ((gnus-functionp elem)
2860               (funcall elem group))
2861              ;; Regexp-file cons.
2862              ((consp elem)
2863               (when (string-match (gnus-globalify-regexp (car elem)) group)
2864                 (replace-match (cadr elem) t nil group))))))
2865     (when found
2866       (if (file-name-absolute-p found)
2867           found
2868         (nnheader-concat gnus-kill-files-directory found)))))
2869
2870 (defun gnus-hierarchial-home-score-file (group)
2871   "Return the score file of the top-level hierarchy of GROUP."
2872   (if (string-match "^[^.]+\\." group)
2873       (concat (match-string 0 group) gnus-score-file-suffix)
2874     ;; Group name without any dots.
2875     (concat group (if (gnus-use-long-file-name 'not-score) "." "/")
2876             gnus-score-file-suffix)))
2877
2878 (defun gnus-hierarchial-home-adapt-file (group)
2879   "Return the adapt file of the top-level hierarchy of GROUP."
2880   (if (string-match "^[^.]+\\." group)
2881       (concat (match-string 0 group) gnus-adaptive-file-suffix)
2882     ;; Group name without any dots.
2883     (concat group (if (gnus-use-long-file-name 'not-score) "." "/")
2884             gnus-adaptive-file-suffix)))
2885
2886 (defun gnus-current-home-score-file (group)
2887   "Return the \"current\" regular score file."
2888   (car (nreverse (gnus-score-find-alist group))))
2889
2890 ;;;
2891 ;;; Score decays
2892 ;;;
2893
2894 (defun gnus-decay-score (score)
2895   "Decay SCORE according to `gnus-score-decay-constant' and `gnus-score-decay-scale'."
2896   (floor
2897    (- score
2898       (* (if (< score 0) -1 1)
2899          (min (abs score)
2900               (max gnus-score-decay-constant
2901                    (* (abs score)
2902                       gnus-score-decay-scale)))))))
2903
2904 (defun gnus-decay-scores (alist day)
2905   "Decay non-permanent scores in ALIST."
2906   (let ((times (- (time-to-days (current-time)) day))
2907         kill entry updated score n)
2908     (unless (zerop times)               ;Done decays today already?
2909       (while (setq entry (pop alist))
2910         (when (stringp (car entry))
2911           (setq entry (cdr entry))
2912           (while (setq kill (pop entry))
2913             (when (nth 2 kill)
2914               (setq updated t)
2915               (setq score (or (nth 1 kill)
2916                               gnus-score-interactive-default-score)
2917                     n times)
2918               (while (natnump (decf n))
2919                 (setq score (funcall gnus-decay-score-function score)))
2920               (setcdr kill (cons score
2921                                  (cdr (cdr kill)))))))))
2922     ;; Return whether this score file needs to be saved.  By Je-haysuss!
2923     updated))
2924
2925 (defun gnus-score-regexp-bad-p (regexp)
2926   "Test whether REGEXP is safe for Gnus scoring.
2927 A regexp is unsafe if it matches newline or a buffer boundary.
2928
2929 If the regexp is good, return nil.  If the regexp is bad, return a
2930 cons cell (SYM . STRING), where the symbol SYM is `new' or `bad'.
2931 In the `new' case, the string is a safe replacement for REGEXP.
2932 In the `bad' case, the string is a unsafe subexpression of REGEXP,
2933 and we do not have a simple replacement to suggest.
2934
2935 See `(Gnus)Scoring Tips' for examples of good regular expressions."
2936   (let (case-fold-search)
2937     (and
2938      ;; First, try a relatively fast necessary condition.
2939      ;; Notice ranges (like [^:] or [\t-\r]), \s>, \Sw, \W, \', \`:
2940      (string-match "\n\\|\\\\[SsW`']\\|\\[\\^\\|[\0-\n]-" regexp)
2941      ;; Now break the regexp into tokens, and check each:
2942      (let ((tail regexp)                ; remaining regexp to check
2943            tok                          ; current token
2944            bad                          ; nil, or bad subexpression
2945            new                          ; nil, or replacement regexp so far
2946            end)                         ; length of current token
2947        (while (and (not bad)
2948                    (string-match
2949                     "\\`\\(\\\\[sS]?.\\|\\[\\^?]?[^]]*]\\|[^\\]\\)"
2950                     tail))
2951          (setq end (match-end 0)
2952                tok (substring tail 0 end)
2953                tail (substring tail end))
2954          (if;; Is token `bad' (matching newline or buffer ends)?
2955              (or (member tok '("\n" "\\W" "\\`" "\\'"))
2956                  ;; This next handles "[...]", "\\s.", and "\\S.":
2957                  (and (> end 2) (string-match tok "\n")))
2958              (let ((newtok
2959                     ;; Try to suggest a replacement for tok ...
2960                     (cond ((string-equal tok "\\`") "^") ; or "\\(^\\)"
2961                           ((string-equal tok "\\'") "$") ; or "\\($\\)"
2962                           ((string-match "\\[\\^" tok) ; very common
2963                            (concat (substring tok 0 -1) "\n]")))))
2964                (if newtok
2965                    (setq new
2966                          (concat
2967                           (or new
2968                               ;; good prefix so far:
2969                               (substring regexp 0 (- (+ (length tail) end))))
2970                           newtok))
2971                  ;; No replacement idea, so give up:
2972                  (setq bad tok)))
2973            ;; tok is good, may need to extend new
2974            (and new (setq new (concat new tok)))))
2975        ;; Now return a value:
2976        (cond
2977         (bad (cons 'bad bad))
2978         (new (cons 'new new))
2979         (t nil))))))
2980
2981 (provide 'gnus-score)
2982
2983 ;;; gnus-score.el ends here