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