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