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