gnus-score.el 106 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1
;;; gnus-score.el --- scoring code for Gnus
2

3
;; Copyright (C) 1995-2012 Free Software Foundation, Inc.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
4 5

;; Author: Per Abrahamsen <amanda@iesd.auc.dk>
6
;;	Lars Magne Ingebrigtsen <larsi@gnus.org>
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
7 8 9 10
;; Keywords: news

;; This file is part of GNU Emacs.

11
;; GNU Emacs is free software: you can redistribute it and/or modify
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
12
;; it under the terms of the GNU General Public License as published by
13 14
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
15 16 17 18 19 20 21

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; 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/>.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
23 24 25 26 27

;;; Commentary:

;;; Code:

28 29
(eval-when-compile (require 'cl))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
30 31 32
(require 'gnus)
(require 'gnus-sum)
(require 'gnus-range)
33
(require 'gnus-win)
34
(require 'message)
35
(require 'score-mode)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
36 37 38 39 40 41 42 43 44 45 46 47 48

(defcustom gnus-global-score-files nil
  "List of global score files and directories.
Set this variable if you want to use people's score files.  One entry
for each score file or each score file directory.  Gnus will decide
by itself what score files are applicable to which group.

Say you want to use the single score file
\"/ftp.gnus.org@ftp:/pub/larsi/ding/score/soc.motss.SCORE\" and all
score files in the \"/ftp.some-where:/pub/score\" directory.

 (setq gnus-global-score-files
       '(\"/ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE\"
49
	 \"/ftp.some-where:/pub/score\"))"
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
50 51 52 53 54 55 56 57 58 59 60
  :group 'gnus-score-files
  :type '(repeat file))

(defcustom gnus-score-file-single-match-alist nil
  "Alist mapping regexps to lists of score files.
Each element of this alist should be of the form
	(\"REGEXP\" [ \"SCORE-FILE-1\" ] [ \"SCORE-FILE-2\" ] ... )

If the name of a group is matched by REGEXP, the corresponding scorefiles
will be used for that group.
The first match found is used, subsequent matching entries are ignored (to
61
use multiple matches, see `gnus-score-file-multiple-match-alist').
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
62 63

These score files are loaded in addition to any files returned by
64
`gnus-score-find-score-files-function'."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
65 66 67 68 69 70 71 72 73 74 75 76
  :group 'gnus-score-files
  :type '(repeat (cons regexp (repeat file))))

(defcustom gnus-score-file-multiple-match-alist nil
  "Alist mapping regexps to lists of score files.
Each element of this alist should be of the form
	(\"REGEXP\" [ \"SCORE-FILE-1\" ] [ \"SCORE-FILE-2\" ] ... )

If the name of a group is matched by REGEXP, the corresponding scorefiles
will be used for that group.
If multiple REGEXPs match a group, the score files corresponding to each
match will be used (for only one match to be used, see
77
`gnus-score-file-single-match-alist').
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
78 79

These score files are loaded in addition to any files returned by
80
`gnus-score-find-score-files-function'."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
  :group 'gnus-score-files
  :type '(repeat (cons regexp (repeat file))))

(defcustom gnus-score-file-suffix "SCORE"
  "Suffix of the score files."
  :group 'gnus-score-files
  :type 'string)

(defcustom gnus-adaptive-file-suffix "ADAPT"
  "Suffix of the adaptive score files."
  :group 'gnus-score-files
  :group 'gnus-score-adapt
  :type 'string)

(defcustom gnus-score-find-score-files-function 'gnus-score-find-bnews
  "Function used to find score files.
The function will be called with the group name as the argument, and
should return a list of score files to apply to that group.  The score
files do not actually have to exist.

Predefined values are:

103 104 105
`gnus-score-find-single': Only apply the group's own score file.
`gnus-score-find-hierarchical': Also apply score files from parent groups.
`gnus-score-find-bnews': Apply score files whose names matches.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
106 107 108 109

See the documentation to these functions for more information.

This variable can also be a list of functions to be called.  Each
110 111
function is given the group name as argument and should either return
a list of score files, or a list of score alists.
112 113 114 115

If functions other than these pre-defined functions are used,
the `a' symbolic prefix to the score commands will always use
\"all.SCORE\"."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
116 117 118 119
  :group 'gnus-score-files
  :type '(radio (function-item gnus-score-find-single)
		(function-item gnus-score-find-hierarchical)
		(function-item gnus-score-find-bnews)
120 121 122 123 124 125
		(repeat :tag "List of functions"
			(choice (function :tag "Other" :value 'ignore)
				(function-item gnus-score-find-single)
				(function-item gnus-score-find-hierarchical)
				(function-item gnus-score-find-bnews)))
		(function :tag "Other" :value 'ignore)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
126 127 128 129

(defcustom gnus-score-interactive-default-score 1000
  "*Scoring commands will raise/lower the score with this number as the default."
  :group 'gnus-score-default
130
  :type 'integer)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
131 132 133 134 135 136 137 138 139

(defcustom gnus-score-expiry-days 7
  "*Number of days before unused score file entries are expired.
If this variable is nil, no score file entries will be expired."
  :group 'gnus-score-expire
  :type '(choice (const :tag "never" nil)
		 number))

(defcustom gnus-update-score-entry-dates t
140
  "*If non-nil, update matching score entry dates.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
141 142 143 144 145 146
If this variable is nil, then score entries that provide matches
will be expired along with non-matching score entries."
  :group 'gnus-score-expire
  :type 'boolean)

(defcustom gnus-decay-scores nil
147 148 149
  "*If non-nil, decay non-permanent scores.

If it is a regexp, only decay score files matching regexp."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
150
  :group 'gnus-score-decay
151 152 153 154 155
  :type `(choice (const :tag "never" nil)
		 (const :tag "always" t)
		 (const :tag "adaptive score files"
			,(concat "\\." gnus-adaptive-file-suffix "\\'"))
		 (regexp)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178

(defcustom gnus-decay-score-function 'gnus-decay-score
  "*Function called to decay a score.
It is called with one parameter -- the score to be decayed."
  :group 'gnus-score-decay
  :type '(radio (function-item gnus-decay-score)
		(function :tag "Other")))

(defcustom gnus-score-decay-constant 3
  "*Decay all \"small\" scores with this amount."
  :group 'gnus-score-decay
  :type 'integer)

(defcustom gnus-score-decay-scale .05
  "*Decay all \"big\" scores with this factor."
  :group 'gnus-score-decay
  :type 'number)

(defcustom gnus-home-score-file nil
  "Variable to control where interactive score entries are to go.
It can be:

 * A string
179
   This file will be used as the home score file.
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
180 181 182 183 184 185 186 187 188 189

 * A function
   The result of this function will be used as the home score file.
   The function will be passed the name of the group as its
   parameter.

 * A list
   The elements in this list can be:

   * `(regexp file-name ...)'
190
     If the `regexp' matches the group name, the first `file-name'
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
     will be used as the home score file.  (Multiple filenames are
     allowed so that one may use gnus-score-file-single-match-alist to
     set this variable.)

   * A function.
     If the function returns non-nil, the result will be used
     as the home score file.  The function will be passed the
     name of the group as its parameter.

   * A string.  Use the string as the home score file.

   The list will be traversed from the beginning towards the end looking
   for matches."
  :group 'gnus-score-files
  :type '(choice string
		 (repeat (choice string
				 (cons regexp (repeat file))
Miles Bader's avatar
Miles Bader committed
208
				 function))
209 210
		 (function-item gnus-hierarchial-home-score-file)
		 (function-item gnus-current-home-score-file)
Miles Bader's avatar
Miles Bader committed
211
		 function))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
212 213 214 215 216 217 218 219 220

(defcustom gnus-home-adapt-file nil
  "Variable to control where new adaptive score entries are to go.
This variable allows the same syntax as `gnus-home-score-file'."
  :group 'gnus-score-adapt
  :group 'gnus-score-files
  :type '(choice string
		 (repeat (choice string
				 (cons regexp (repeat file))
Miles Bader's avatar
Miles Bader committed
221 222
				 function))
		 function))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
223 224

(defcustom gnus-default-adaptive-score-alist
225
  `((gnus-kill-file-mark)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
226
    (gnus-unread-mark)
227 228 229 230 231 232 233 234 235 236 237 238 239 240
    (gnus-read-mark
     (from , (+ 2 gnus-score-decay-constant))
     (subject , (+ 27 gnus-score-decay-constant)))
    (gnus-catchup-mark
     (subject , (+ -7 (* -1 gnus-score-decay-constant))))
    (gnus-killed-mark
     (from , (- -1 gnus-score-decay-constant))
     (subject , (+ -17 (* -1 gnus-score-decay-constant))))
    (gnus-del-mark
     (from , (- -1 gnus-score-decay-constant))
     (subject , (+ -12 (* -1 gnus-score-decay-constant)))))
  "Alist of marks and scores.
If you use score decays, you might want to set values higher than
`gnus-score-decay-constant'."
241 242 243 244 245 246 247
  :group 'gnus-score-adapt
  :type '(repeat (cons (symbol :tag "Mark")
		       (repeat (list (choice :tag "Header"
					     (const from)
					     (const subject)
					     (symbol :tag "other"))
				     (integer :tag "Score"))))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
248

249 250
(defcustom gnus-adaptive-word-length-limit nil
  "*Words of a length lesser than this limit will be ignored when doing adaptive scoring."
251
  :version "22.1"
252 253
  :group 'gnus-score-adapt
  :type '(radio (const :format "Unlimited " nil)
254
		(integer :format "Maximum length: %v")))
255

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
(defcustom gnus-ignored-adaptive-words nil
  "List of words to be ignored when doing adaptive word scoring."
  :group 'gnus-score-adapt
  :type '(repeat string))

(defcustom gnus-default-ignored-adaptive-words
  '("a" "i" "the" "to" "of" "and" "in" "is" "it" "for" "that" "if" "you"
    "this" "be" "on" "with" "not" "have" "are" "or" "as" "from" "can"
    "but" "by" "at" "an" "will" "no" "all" "was" "do" "there" "my" "one"
    "so" "we" "they" "what" "would" "any" "which" "about" "get" "your"
    "use" "some" "me" "then" "name" "like" "out" "when" "up" "time"
    "other" "more" "only" "just" "end" "also" "know" "how" "new" "should"
    "been" "than" "them" "he" "who" "make" "may" "people" "these" "now"
    "their" "here" "into" "first" "could" "way" "had" "see" "work" "well"
    "were" "two" "very" "where" "while" "us" "because" "good" "same"
    "even" "much" "most" "many" "such" "long" "his" "over" "last" "since"
    "right" "before" "our" "without" "too" "those" "why" "must" "part"
    "being" "current" "back" "still" "go" "point" "value" "each" "did"
    "both" "true" "off" "say" "another" "state" "might" "under" "start"
    "try" "re")
276
  "*Default list of words to be ignored when doing adaptive word scoring."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
277 278 279 280 281 282 283 284
  :group 'gnus-score-adapt
  :type '(repeat string))

(defcustom gnus-default-adaptive-word-score-alist
  `((,gnus-read-mark . 30)
    (,gnus-catchup-mark . -10)
    (,gnus-killed-mark . -20)
    (,gnus-del-mark . -15))
285 286 287 288
  "*Alist of marks and scores."
  :group 'gnus-score-adapt
  :type '(repeat (cons (character :tag "Mark")
		       (integer :tag "Score"))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
289

290 291 292 293 294 295 296 297 298 299
(defcustom gnus-adaptive-word-minimum nil
  "If a number, this is the minimum score value that can be assigned to a word."
  :group 'gnus-score-adapt
  :type '(choice (const nil) integer))

(defcustom gnus-adaptive-word-no-group-words nil
  "If t, don't adaptively score words included in the group name."
  :group 'gnus-score-adapt
  :type 'boolean)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
(defcustom gnus-score-mimic-keymap nil
  "*Have the score entry functions pretend that they are a keymap."
  :group 'gnus-score-default
  :type 'boolean)

(defcustom gnus-score-exact-adapt-limit 10
  "*Number that says how long a match has to be before using substring matching.
When doing adaptive scoring, one normally uses fuzzy or substring
matching.  However, if the header one matches is short, the possibility
for false positives is great, so if the length of the match is less
than this variable, exact matching will be used.

If this variable is nil, exact matching will always be used."
  :group 'gnus-score-adapt
  :type '(choice (const nil) integer))

(defcustom gnus-score-uncacheable-files "ADAPT$"
  "All score files that match this regexp will not be cached."
  :group 'gnus-score-adapt
  :group 'gnus-score-files
  :type 'regexp)

322 323 324 325
(defcustom gnus-adaptive-pretty-print nil
  "If non-nil, adaptive score files fill are pretty printed."
  :group 'gnus-score-files
  :group 'gnus-score-adapt
326
  :version "23.1" ;; No Gnus
327 328
  :type 'boolean)

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
329 330 331 332 333 334 335 336 337 338 339 340
(defcustom gnus-score-default-header nil
  "Default header when entering new scores.

Should be one of the following symbols.

 a: from
 s: subject
 b: body
 h: head
 i: message-id
 t: references
 x: xref
341
 e: `extra' (non-standard overview)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
342 343 344 345 346 347 348 349 350 351 352 353 354
 l: lines
 d: date
 f: followup

If nil, the user will be asked for a header."
  :group 'gnus-score-default
  :type '(choice (const :tag "from" a)
		 (const :tag "subject" s)
		 (const :tag "body" b)
		 (const :tag "head" h)
		 (const :tag "message-id" i)
		 (const :tag "references" t)
		 (const :tag "xref" x)
355
		 (const :tag "extra" e)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
356 357
		 (const :tag "lines" l)
		 (const :tag "date" d)
358 359
		 (const :tag "followup" f)
		 (const :tag "ask" nil)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
360 361 362 363 364 365 366 367 368 369 370

(defcustom gnus-score-default-type nil
  "Default match type when entering new scores.

Should be one of the following symbols.

 s: substring
 e: exact string
 f: fuzzy string
 r: regexp string
 b: before date
371
 a: after date
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
372 373 374 375 376 377 378 379 380 381 382 383
 n: this date
 <: less than number
 >: greater than number
 =: equal to number

If nil, the user will be asked for a match type."
  :group 'gnus-score-default
  :type '(choice (const :tag "substring" s)
		 (const :tag "exact string" e)
		 (const :tag "fuzzy string" f)
		 (const :tag "regexp string" r)
		 (const :tag "before date" b)
384
		 (const :tag "after date" a)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
385 386 387
		 (const :tag "this date" n)
		 (const :tag "less than number" <)
		 (const :tag "greater than number" >)
388 389
		 (const :tag "equal than number" =)
		 (const :tag "ask" nil)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
390 391

(defcustom gnus-score-default-fold nil
392
  "Non-nil means use case folding for new score file entries."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
  :group 'gnus-score-default
  :type 'boolean)

(defcustom gnus-score-default-duration nil
  "Default duration of effect when entering new scores.

Should be one of the following symbols.

 t: temporary
 p: permanent
 i: immediate

If nil, the user will be asked for a duration."
  :group 'gnus-score-default
  :type '(choice (const :tag "temporary" t)
		 (const :tag "permanent" p)
		 (const :tag "immediate" i)
		 (const :tag "ask" nil)))

(defcustom gnus-score-after-write-file-function nil
  "Function called with the name of the score file just written to disk."
  :group 'gnus-score-files
415
  :type '(choice (const nil) function))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
416

417 418 419
(defcustom gnus-score-thread-simplify nil
  "If non-nil, subjects will simplified as in threading."
  :group 'gnus-score-various
420
  :type 'boolean)
421

422 423 424 425 426 427 428
(defcustom gnus-inhibit-slow-scoring nil
  "Inhibit slow scoring, e.g. scoring on headers or body.

If a regexp, scoring on headers or body is inhibited if the group
matches the regexp.  If it is t, scoring on headers or body is
inhibited for all groups."
  :group 'gnus-score-various
429
  :version "23.1" ;; No Gnus
430 431 432 433
  :type '(choice (const :tag "All" nil)
		 (const :tag "None" t)
		 regexp))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
434 435 436 437


;; Internal variables.

438 439 440
(defvar gnus-score-use-all-scores t
  "If nil, only `gnus-score-find-score-files-function' is used.")

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
(defvar gnus-adaptive-word-syntax-table
  (let ((table (copy-syntax-table (standard-syntax-table)))
	(numbers '(?0 ?1 ?2 ?3 ?4 ?5 ?6 ?7 ?8 ?9)))
    (while numbers
      (modify-syntax-entry (pop numbers) " " table))
    (modify-syntax-entry ?' "w" table)
    table)
  "Syntax table used when doing adaptive word scoring.")

(defvar gnus-scores-exclude-files nil)
(defvar gnus-internal-global-score-files nil)
(defvar gnus-score-file-list nil)

(defvar gnus-short-name-score-file-cache nil)

(defvar gnus-score-help-winconf nil)
(defvar gnus-adaptive-score-alist gnus-default-adaptive-score-alist)
(defvar gnus-adaptive-word-score-alist gnus-default-adaptive-word-score-alist)
(defvar gnus-score-trace nil)
(defvar gnus-score-edit-buffer nil)

(defvar gnus-score-alist nil
  "Alist containing score information.
The keys can be symbols or strings.  The following symbols are defined.

touched: If this alist has been modified.
mark:    Automatically mark articles below this.
expunge: Automatically expunge articles below this.
files:   List of other score files to load when loading this one.
eval:    Sexp to be evaluated when the score file is loaded.

String entries have the form (HEADER (MATCH TYPE SCORE DATE) ...)
where HEADER is the header being scored, MATCH is the string we are
looking for, TYPE is a flag indicating whether it should use regexp or
substring matching, SCORE is the score to add and DATE is the date
of the last successful match.")

(defvar gnus-score-cache nil)
(defvar gnus-scores-articles nil)
(defvar gnus-score-index nil)


(defconst gnus-header-index
  ;; Name to index alist.
  '(("number" 0 gnus-score-integer)
    ("subject" 1 gnus-score-string)
    ("from" 2 gnus-score-string)
    ("date" 3 gnus-score-date)
    ("message-id" 4 gnus-score-string)
    ("references" 5 gnus-score-string)
    ("chars" 6 gnus-score-integer)
    ("lines" 7 gnus-score-integer)
    ("xref" 8 gnus-score-string)
494
    ("extra" 9 gnus-score-string)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
    ("head" -1 gnus-score-body)
    ("body" -1 gnus-score-body)
    ("all" -1 gnus-score-body)
    ("followup" 2 gnus-score-followup)
    ("thread" 5 gnus-score-thread)))

;;; Summary mode score maps.

(gnus-define-keys (gnus-summary-score-map "V" gnus-summary-mode-map)
  "s" gnus-summary-set-score
  "S" gnus-summary-current-score
  "c" gnus-score-change-score-file
  "C" gnus-score-customize
  "m" gnus-score-set-mark-below
  "x" gnus-score-set-expunge-below
  "R" gnus-summary-rescore
  "e" gnus-score-edit-current-scores
  "f" gnus-score-edit-file
  "F" gnus-score-flush-cache
  "t" gnus-score-find-trace
  "w" gnus-score-find-favourite-words)

;; Summary score file commands

;; Much modification of the kill (ahem, score) code and lots of the
;; functions are written by Per Abrahamsen <amanda@iesd.auc.dk>.

522
(defun gnus-summary-lower-score (&optional score symp)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
523 524
  "Make a score entry based on the current article.
The user will be prompted for header to score on, match type,
525 526 527 528
permanence, and the string to be used.  The numerical prefix will
be used as SCORE.  A symbolic prefix of `a' (the SYMP parameter)
says to use the `all.SCORE' file for the command instead of the
current score file."
529
  (interactive (gnus-interactive "P\ny"))
530
  (gnus-summary-increase-score (- (gnus-score-delta-default score)) symp))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
531 532 533 534 535 536 537

(defun gnus-score-kill-help-buffer ()
  (when (get-buffer "*Score Help*")
    (kill-buffer "*Score Help*")
    (when gnus-score-help-winconf
      (set-window-configuration gnus-score-help-winconf))))

538
(defun gnus-summary-increase-score (&optional score symp)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
539 540
  "Make a score entry based on the current article.
The user will be prompted for header to score on, match type,
541 542 543 544
permanence, and the string to be used.  The numerical prefix will
be used as SCORE.  A symbolic prefix of `a' (the SYMP parameter)
says to use the `all.SCORE' file for the command instead of the
current score file."
545
  (interactive (gnus-interactive "P\ny"))
546
  (let* ((nscore (gnus-score-delta-default score))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
547 548 549 550 551 552 553
	 (prefix (if (< nscore 0) ?L ?I))
	 (increase (> nscore 0))
	 (char-to-header
	  '((?a "from" nil nil string)
	    (?s "subject" nil nil string)
	    (?b "body" "" nil body-string)
	    (?h "head" "" nil body-string)
554
	    (?i "message-id" nil nil string)
555
	    (?r "references" "message-id" nil string)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
556
	    (?x "xref" nil nil string)
557
	    (?e "extra" nil nil string)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
558 559 560
	    (?l "lines" nil nil number)
	    (?d "date" nil nil date)
	    (?f "followup" nil nil string)
561
	    (?t "thread" "message-id" nil string)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
562 563 564 565 566 567 568 569
	 (char-to-type
	  '((?s s "substring" string)
	    (?e e "exact string" string)
	    (?f f "fuzzy string" string)
	    (?r r "regexp string" string)
	    (?z s "substring" body-string)
	    (?p r "regexp string" body-string)
	    (?b before "before date" date)
570 571
	    (?a after "after date" date)
	    (?n at "this date" date)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
572 573 574
	    (?< < "less than number" number)
	    (?> > "greater than number" number)
	    (?= = "equal to number" number)))
575
	 (current-score-file gnus-current-score-file)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
576 577 578 579 580 581 582 583 584 585
	 (char-to-perm
	  (list (list ?t (current-time-string) "temporary")
		'(?p perm "permanent") '(?i now "immediate")))
	 (mimic gnus-score-mimic-keymap)
	 (hchar (and gnus-score-default-header
		     (aref (symbol-name gnus-score-default-header) 0)))
	 (tchar (and gnus-score-default-type
		     (aref (symbol-name gnus-score-default-type) 0)))
	 (pchar (and gnus-score-default-duration
		     (aref (symbol-name gnus-score-default-duration) 0)))
586
	 entry temporary type match extra)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606

    (unwind-protect
	(progn

	  ;; First we read the header to score.
	  (while (not hchar)
	    (if mimic
		(progn
		  (sit-for 1)
		  (message "%c-" prefix))
	      (message "%s header (%s?): " (if increase "Increase" "Lower")
		       (mapconcat (lambda (s) (char-to-string (car s)))
				  char-to-header "")))
	    (setq hchar (read-char))
	    (when (or (= hchar ??) (= hchar ?\C-h))
	      (setq hchar nil)
	      (gnus-score-insert-help "Match on header" char-to-header 1)))

	  (gnus-score-kill-help-buffer)
	  (unless (setq entry (assq (downcase hchar) char-to-header))
607
	    (if mimic (error "%c %c" prefix hchar)
608
	      (error "Invalid header type")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
609 610 611 612 613 614 615

	  (when (/= (downcase hchar) hchar)
	    ;; This was a majuscule, so we end reading and set the defaults.
	    (if mimic (message "%c %c" prefix hchar) (message ""))
	    (setq tchar (or tchar ?s)
		  pchar (or pchar ?t)))

616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
	  (let ((legal-types
		 (delq nil
		       (mapcar (lambda (s)
				 (if (eq (nth 4 entry)
					 (nth 3 s))
				     s nil))
			       char-to-type))))
	    ;; We continue reading - the type.
	    (while (not tchar)
	      (if mimic
		  (progn
		    (sit-for 1) (message "%c %c-" prefix hchar))
		(message "%s header '%s' with match type (%s?): "
			 (if increase "Increase" "Lower")
			 (nth 1 entry)
			 (mapconcat (lambda (s) (char-to-string (car s)))
				    legal-types "")))
	      (setq tchar (read-char))
	      (when (or (= tchar ??) (= tchar ?\C-h))
		(setq tchar nil)
		(gnus-score-insert-help "Match type" legal-types 2)))

	    (gnus-score-kill-help-buffer)
	    (unless (setq type (nth 1 (assq (downcase tchar) legal-types)))
	      (if mimic (error "%c %c" prefix hchar)
641
		(error "Invalid match type"))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
642 643 644 645 646

	  (when (/= (downcase tchar) tchar)
	    ;; It was a majuscule, so we end reading and use the default.
	    (if mimic (message "%c %c %c" prefix hchar tchar)
	      (message ""))
647
	    (setq pchar (or pchar ?t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662

	  ;; We continue reading.
	  (while (not pchar)
	    (if mimic
		(progn
		  (sit-for 1) (message "%c %c %c-" prefix hchar tchar))
	      (message "%s permanence (%s?): " (if increase "Increase" "Lower")
		       (mapconcat (lambda (s) (char-to-string (car s)))
				  char-to-perm "")))
	    (setq pchar (read-char))
	    (when (or (= pchar ??) (= pchar ?\C-h))
	      (setq pchar nil)
	      (gnus-score-insert-help "Match permanence" char-to-perm 2)))

	  (gnus-score-kill-help-buffer)
663
	  (if mimic (message "%c %c %c %c" prefix hchar tchar pchar)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
664 665 666 667 668
	    (message ""))
	  (unless (setq temporary (cadr (assq pchar char-to-perm)))
	    ;; Deal with der(r)ided superannuated paradigms.
	    (when (and (eq (1+ prefix) 77)
		       (eq (+ hchar 12) 109)
669
		       (eq (1- tchar) 113)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
670 671 672 673
		       (eq (- pchar 4) 111))
	      (error "You rang?"))
	    (if mimic
		(error "%c %c %c %c" prefix hchar tchar pchar)
674
	      (error "Invalid match duration"))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
675 676 677
      ;; Always kill the score help buffer.
      (gnus-score-kill-help-buffer))

678 679 680 681 682 683
    ;; If scoring an extra (non-standard overview) header,
    ;; we must find out which header is in question.
    (setq extra
	  (and gnus-extra-headers
	       (equal (nth 1 entry) "extra")
	       (intern			; need symbol
684 685 686 687 688 689 690 691
                (let ((collection (mapcar 'symbol-name gnus-extra-headers)))
                  (gnus-completing-read
                   "Score extra header"  ; prompt
                   collection            ; completion list
                   t                     ; require match
                   nil                   ; no history
                   nil                   ; no initial-input
                   (car collection)))))) ; default value
692 693
    ;; extra is now nil or a symbol.

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
694 695
    ;; We have all the data, so we enter this score.
    (setq match (if (string= (nth 2 entry) "") ""
696 697
		  (gnus-summary-header (or (nth 2 entry) (nth 1 entry))
				       nil extra)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
698 699 700 701 702 703 704 705 706 707 708 709

    ;; Modify the match, perhaps.
    (cond
     ((equal (nth 1 entry) "xref")
      (when (string-match "^Xref: *" match)
	(setq match (substring match (match-end 0))))
      (when (string-match "^[^:]* +" match)
	(setq match (substring match (match-end 0))))))

    (when (memq type '(r R regexp Regexp))
      (setq match (regexp-quote match)))

710 711
    ;; Change score file to the "all.SCORE" file.
    (when (eq symp 'a)
712
      (with-current-buffer gnus-summary-buffer
713 714 715 716 717 718 719 720 721 722
	(gnus-score-load-file
	 ;; This is a kludge; yes...
	 (cond
	  ((eq gnus-score-find-score-files-function
	       'gnus-score-find-hierarchical)
	   (gnus-score-file-name ""))
	  ((eq gnus-score-find-score-files-function 'gnus-score-find-single)
	   current-score-file)
	  (t
	   (gnus-score-file-name "all"))))))
723

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
724 725 726 727 728 729 730 731
    (gnus-summary-score-entry
     (nth 1 entry)			; Header
     match				; Match
     type				; Type
     (if (eq score 's) nil score)	; Score
     (if (eq temporary 'perm)		; Temp
	 nil
       temporary)
732 733 734
     (not (nth 3 entry))		; Prompt
     nil				; not silent
     extra)				; non-standard overview.
735 736 737

    (when (eq symp 'a)
      ;; 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)))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
740 741 742

(defun gnus-score-insert-help (string alist idx)
  (setq gnus-score-help-winconf (current-window-configuration))
743
  (with-current-buffer (gnus-get-buffer-create "*Score Help*")
744
    (buffer-disable-undo)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
    (delete-windows-on (current-buffer))
    (erase-buffer)
    (insert string ":\n\n")
    (let ((max -1)
	  (list alist)
	  (i 0)
	  n width pad format)
      ;; find the longest string to display
      (while list
	(setq n (length (nth idx (car list))))
	(unless (> max n)
	  (setq max n))
	(setq list (cdr list)))
      (setq max (+ max 4))		; %c, `:', SPACE, a SPACE at end
      (setq n (/ (1- (window-width)) max)) ; items per line
      (setq width (/ (1- (window-width)) n)) ; width of each item
      ;; insert `n' items, each in a field of width `width'
      (while alist
	(if (< i n)
	    ()
	  (setq i 0)
	  (delete-char -1)		; the `\n' takes a char
	  (insert "\n"))
	(setq pad (- width 3))
	(setq format (concat "%c: %-" (int-to-string pad) "s"))
	(insert (format format (caar alist) (nth idx (car alist))))
	(setq alist (cdr alist))
	(setq i (1+ i))))
773
    (goto-char (point-min))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
774
    ;; display ourselves in a small window at the bottom
775
    (gnus-select-lowest-window)
776 777 778 779
    (if (< (/ (window-height) 2) window-min-height)
	(switch-to-buffer "*Score Help*")
      (split-window)
      (pop-to-buffer "*Score Help*"))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
780 781
    (let ((window-min-height 1))
      (shrink-window-if-larger-than-buffer))
782
    (select-window (gnus-get-buffer-window gnus-summary-buffer t))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
783

784
(defun gnus-summary-header (header &optional no-err extra)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
785 786 787 788 789 790
  ;; Return HEADER for current articles, or error.
  (let ((article (gnus-summary-article-number))
	headers)
    (if article
	(if (and (setq headers (gnus-summary-article-header article))
		 (vectorp headers))
791 792 793
	    (if extra			; `header' must be "extra"
		(or (cdr (assq extra (mail-header-extra headers))) "")
	      (aref headers (nth 1 (assoc header gnus-header-index))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
	  (if no-err
	      nil
	    (error "Pseudo-articles can't be scored")))
      (if no-err
	  (error "No article on current line")
	nil))))

(defun gnus-newsgroup-score-alist ()
  (or
   (let ((param-file (gnus-group-find-parameter
		      gnus-newsgroup-name 'score-file)))
     (when param-file
       (gnus-score-load param-file)))
   (gnus-score-load
    (gnus-score-file-name gnus-newsgroup-name)))
  gnus-score-alist)

(defsubst gnus-score-get (symbol &optional alist)
  ;; Get SYMBOL's definition in ALIST.
  (cdr (assoc symbol
	      (or alist
		  gnus-score-alist
		  (gnus-newsgroup-score-alist)))))

(defun gnus-summary-score-entry (header match type score date
819
					&optional prompt silent extra)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
820 821 822 823 824 825 826
  "Enter score file entry.
HEADER is the header being scored.
MATCH is the string we are looking for.
TYPE is the match type: substring, regexp, exact, fuzzy.
SCORE is the score to add.
DATE is the expire date, or nil for no expire, or 'now for immediate expire.
If optional argument `PROMPT' is non-nil, allow user to edit match.
827 828
If optional argument `SILENT' is nil, show effect of score entry.
If optional argument `EXTRA' is non-nil, it's a non-standard overview header."
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
829 830 831 832 833 834 835 836
  ;; Regexp is the default type.
  (when (eq type t)
    (setq type 'r))
  ;; Simplify matches...
  (cond ((or (eq type 'r) (eq type 's) (eq type nil))
	 (setq match (if match (gnus-simplify-subject-re match) "")))
	((eq type 'f)
	 (setq match (gnus-simplify-subject-fuzzy match))))
837 838
  (let ((score (gnus-score-delta-default score))
	(header (downcase header))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
839
	new)
840
    (set-text-properties 0 (length header) nil header)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
    (when prompt
      (setq match (read-string
		   (format "Match %s on %s, %s: "
			   (cond ((eq date 'now)
				  "now")
				 ((stringp date)
				  "temp")
				 (t "permanent"))
			   header
			   (if (< score 0) "lower" "raise"))
		   (if (numberp match)
		       (int-to-string match)
		     match))))

    ;; If this is an integer comparison, we transform from string to int.
856 857
    (if (eq (nth 2 (assoc header gnus-header-index)) 'gnus-score-integer)
	(if (stringp match)
858
	    (setq match (string-to-number match)))
859
      (set-text-properties 0 (length match) nil match))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
860 861 862 863 864 865 866 867 868

    (unless (eq date 'now)
      ;; Add the score entry to the score file.
      (when (= score gnus-score-interactive-default-score)
	(setq score nil))
      (let ((old (gnus-score-get header))
	    elem)
	(setq new
	      (cond
869 870 871 872 873
	       (extra
		(list match score
		      (and date (if (numberp date) date
				  (date-to-day date)))
		      type (symbol-name extra)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
874 875 876
	       (type
		(list match score
		      (and date (if (numberp date) date
877
				  (date-to-day date)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
878
		      type))
879
	       (date (list match score (date-to-day date)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
	       (score (list match score))
	       (t (list match))))
	;; We see whether we can collapse some score entries.
	;; This isn't quite correct, because there may be more elements
	;; later on with the same key that have matching elems...  Hm.
	(if (and old
		 (setq elem (assoc match old))
		 (eq (nth 3 elem) (nth 3 new))
		 (or (and (numberp (nth 2 elem)) (numberp (nth 2 new)))
		     (and (not (nth 2 elem)) (not (nth 2 new)))))
	    ;; Yup, we just add this new score to the old elem.
	    (setcar (cdr elem) (+ (or (nth 1 elem)
				      gnus-score-interactive-default-score)
				  (or (nth 1 new)
				      gnus-score-interactive-default-score)))
	  ;; Nope, we have to add a new elem.
896
	  (gnus-score-set header (if old (cons new old) (list new)) nil t))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
897 898 899 900 901 902 903
	(gnus-score-set 'touched '(t))))

    ;; Score the current buffer.
    (unless silent
      (if (and (>= (nth 1 (assoc header gnus-header-index)) 0)
	       (eq (nth 2 (assoc header gnus-header-index))
		   'gnus-score-string))
904
	  (gnus-summary-score-effect header match type score extra)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
905 906 907 908 909
	(gnus-summary-rescore)))

    ;; Return the new scoring rule.
    new))

910
(defun gnus-summary-score-effect (header match type score &optional extra)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
911 912 913 914
  "Simulate the effect of a score file entry.
HEADER is the header being scored.
MATCH is the string we are looking for.
TYPE is the score type.
915 916
SCORE is the score to add.
EXTRA is the possible non-standard header."
917 918 919
  (interactive (list (gnus-completing-read "Header"
                                           (mapcar
                                            'car
920
                                            (gnus-remove-if-not
921 922 923
                                             (lambda (x) (fboundp (nth 2 x)))
                                             gnus-header-index))
                                           t)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
924
		     (read-string "Match: ")
925
		     (if (y-or-n-p "Use regexp match? ") 'r 's)
926
		     (string-to-number (read-string "Score: "))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
927 928 929 930 931 932 933 934 935 936 937 938 939
  (save-excursion
    (unless (and (stringp match) (> (length match) 0))
      (error "No match"))
    (goto-char (point-min))
    (let ((regexp (cond ((eq type 'f)
			 (gnus-simplify-subject-fuzzy match))
			((eq type 'r)
			 match)
			((eq type 'e)
			 (concat "\\`" (regexp-quote match) "\\'"))
			(t
			 (regexp-quote match)))))
      (while (not (eobp))
940
	(let ((content (gnus-summary-header header 'noerr extra))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
	      (case-fold-search t))
	  (and content
	       (when (if (eq type 'f)
			 (string-equal (gnus-simplify-subject-fuzzy content)
				       regexp)
		       (string-match regexp content))
		 (gnus-summary-raise-score score))))
	(beginning-of-line 2))))
  (gnus-set-mode-line 'summary))

;;;
;;; Gnus Score Files
;;;

;; All score code written by Per Abrahamsen <abraham@iesd.auc.dk>.

(defun gnus-score-set-mark-below (score)
  "Automatically mark articles with score below SCORE as read."
  (interactive
   (list (or (and current-prefix-arg (prefix-numeric-value current-prefix-arg))
961
	     (string-to-number (read-string "Mark below: ")))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994
  (setq score (or score gnus-summary-default-score 0))
  (gnus-score-set 'mark (list score))
  (gnus-score-set 'touched '(t))
  (setq gnus-summary-mark-below score)
  (gnus-score-update-lines))

(defun gnus-score-update-lines ()
  "Update all lines in the summary buffer."
  (save-excursion
    (goto-char (point-min))
    (while (not (eobp))
      (gnus-summary-update-line)
      (forward-line 1))))

(defun gnus-score-update-all-lines ()
  "Update all lines in the summary buffer, even the hidden ones."
  (save-excursion
    (goto-char (point-min))
    (let (hidden)
      (while (not (eobp))
	(when (gnus-summary-show-thread)
	  (push (point) hidden))
	(gnus-summary-update-line)
	(forward-line 1))
      ;; Re-hide the hidden threads.
      (while hidden
	(goto-char (pop hidden))
	(gnus-summary-hide-thread)))))

(defun gnus-score-set-expunge-below (score)
  "Automatically expunge articles with score below SCORE."
  (interactive
   (list (or (and current-prefix-arg (prefix-numeric-value current-prefix-arg))
995
	     (string-to-number (read-string "Set expunge below: ")))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
996 997 998 999 1000 1001 1002
  (setq score (or score gnus-summary-default-score 0))
  (gnus-score-set 'expunge (list score))
  (gnus-score-set 'touched '(t)))

(defun gnus-score-followup-article (&optional score)
  "Add SCORE to all followups to the article in the current buffer."
  (interactive "P")
1003
  (setq score (gnus-score-delta-default score))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
  (when (gnus-buffer-live-p gnus-summary-buffer)
    (save-excursion
      (save-restriction
	(message-narrow-to-headers)
	(let ((id (mail-fetch-field "message-id")))
	  (when id
	    (set-buffer gnus-summary-buffer)
	    (gnus-summary-score-entry
	     "references" (concat id "[ \t]*$") 'r
	     score (current-time-string) nil t)))))))

(defun gnus-score-followup-thread (&optional score)
  "Add SCORE to all later articles in the thread the current buffer is part of."
  (interactive "P")
1018
  (setq score (gnus-score-delta-default score))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
  (when (gnus-buffer-live-p gnus-summary-buffer)
    (save-excursion
      (save-restriction
	(goto-char (point-min))
	(let ((id (mail-fetch-field "message-id")))
	  (when id
	    (set-buffer gnus-summary-buffer)
	    (gnus-summary-score-entry
	     "references" id 's
	     score (current-time-string))))))))

1030
(defun gnus-score-set (symbol value &optional alist warn)
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1031 1032 1033 1034 1035 1036 1037 1038
  ;; Set SYMBOL to VALUE in ALIST.
  (let* ((alist
	  (or alist
	      gnus-score-alist
	      (gnus-newsgroup-score-alist)))
	 (entry (assoc symbol alist)))
    (cond ((gnus-score-get 'read-only alist)
	   ;; This is a read-only score file, so we do nothing.
1039 1040
	   (when warn
	     (gnus-message 4 "Note: read-only score file; entry discarded")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
	  (entry
	   (setcdr entry value))
	  ((null alist)
	   (error "Empty alist"))
	  (t
	   (setcdr alist
		   (cons (cons symbol value) (cdr alist)))))))

(defun gnus-summary-raise-score (n)
  "Raise the score of the current article by N."
  (interactive "p")
  (gnus-summary-set-score (+ (gnus-summary-article-score)
			     (or n gnus-score-interactive-default-score ))))

(defun gnus-summary-set-score (n)
  "Set the score of the current article to N."
  (interactive "p")
  (save-excursion
    (gnus-summary-show-thread)
    (let ((buffer-read-only nil))
      ;; Set score.
      (gnus-summary-update-mark
1063
       (if (= n (or gnus-summary-default-score 0)) ?  ;Whitespace
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
	 (if (< n (or gnus-summary-default-score 0))
	     gnus-score-below-mark gnus-score-over-mark))
       'score))
    (let* ((article (gnus-summary-article-number))
	   (score (assq article gnus-newsgroup-scored)))
      (if score (setcdr score n)
	(push (cons article n) gnus-newsgroup-scored)))
    (gnus-summary-update-line)))

(defun gnus-summary-current-score ()
  "Return the score of the current article."
  (interactive)
  (gnus-message 1 "%s" (gnus-summary-article-score)))

(defun gnus-score-change-score-file (file)
  "Change current score alist."
  (interactive
   (list (read-file-name "Change to score file: " gnus-kill-files-directory)))
  (gnus-score-load-file file)
  (gnus-set-mode-line 'summary))

(defvar gnus-score-edit-exit-function)
(defun gnus-score-edit-current-scores (file)
  "Edit the current score alist."
  (interactive (list gnus-current-score-file))
1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
  (if (not gnus-current-score-file)
      (error "No current score file")
    (let ((winconf (current-window-configuration)))
      (when (buffer-name gnus-summary-buffer)
	(gnus-score-save))
      (gnus-make-directory (file-name-directory file))
      (setq gnus-score-edit-buffer (find-file-noselect file))
      (gnus-configure-windows 'edit-score)
      (gnus-score-mode)
      (setq gnus-score-edit-exit-function 'gnus-score-edit-done)
      (make-local-variable 'gnus-prev-winconf)
      (setq gnus-prev-winconf winconf))
    (gnus-message
1102 1103
     4 "%s" (substitute-command-keys
	     "\\<gnus-score-mode-map>\\[gnus-score-edit-exit] to save edits"))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1104

1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
(defun gnus-score-edit-all-score ()
  "Edit the all.SCORE file."
  (interactive)
  (find-file (gnus-score-file-name "all"))
  (gnus-score-mode)
  (setq gnus-score-edit-exit-function 'gnus-score-edit-done)
  (gnus-message
   4 (substitute-command-keys
      "\\<gnus-score-mode-map>\\[gnus-score-edit-exit] to save edits")))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
(defun gnus-score-edit-file (file)
  "Edit a score file."
  (interactive
   (list (read-file-name "Edit score file: " gnus-kill-files-directory)))
  (gnus-make-directory (file-name-directory file))
  (when (buffer-name gnus-summary-buffer)
    (gnus-score-save))
  (let ((winconf (current-window-configuration)))
    (setq gnus-score-edit-buffer (find-file-noselect file))
    (gnus-configure-windows 'edit-score)
    (gnus-score-mode)
    (setq gnus-score-edit-exit-function 'gnus-score-edit-done)
    (make-local-variable 'gnus-prev-winconf)
    (setq gnus-prev-winconf winconf))
  (gnus-message
1130 1131
   4 "%s" (substitute-command-keys
	   "\\<gnus-score-mode-map>\\[gnus-score-edit-exit] to save edits")))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1132

1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
(defun gnus-score-edit-file-at-point (&optional format)
  "Edit score file at point in Score Trace buffers.
If FORMAT, also format the current score file."
  (let* ((rule (save-excursion
		 (beginning-of-line)
		 (read (current-buffer))))
	 (sep "[ \n\r\t]*")
	 ;; Must be synced with `gnus-score-find-trace':
	 (reg " -> +")
	 (file (save-excursion
		 (end-of-line)
1144 1145 1146
		 (if (and (re-search-backward reg (point-at-bol) t)
			  (re-search-forward  reg (point-at-eol) t))
		     (buffer-substring (point) (point-at-eol))
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
		   nil))))
    (if (or (not file)
	    (string-match "\\<\\(non-file rule\\|A file\\)\\>" file)
	    ;; (see `gnus-score-find-trace' and `gnus-score-advanced')
	    (string= "" file))
	(gnus-error 3 "Can't find a score file in current line.")
      (gnus-score-edit-file file)
      (when format
	(gnus-score-pretty-print))
      (when (consp rule) ;; the rule exists
	(setq rule (mapconcat #'(lambda (obj)
				  (regexp-quote (format "%S" obj)))
			      rule
			      sep))
	(goto-char (point-min))
	(re-search-forward rule nil t)
	;; make it easy to use `kill-sexp':
	(goto-char (1- (match-beginning 0)))))))

Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1166 1167 1168 1169
(defun gnus-score-load-file (file)
  ;; Load score file FILE.  Returns a list a retrieved score-alists.
  (let* ((file (expand-file-name
		(or (and (string-match
1170 1171 1172
			  (concat "^" (regexp-quote
				       (expand-file-name
					gnus-kill-files-directory)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1173 1174
			  (expand-file-name file))
			 file)
1175
		    (expand-file-name file gnus-kill-files-directory))))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197
	 (cached (assoc file gnus-score-cache))
	 (global (member file gnus-internal-global-score-files))
	 lists alist)
    (if cached
	;; The score file was already loaded.
	(setq alist (cdr cached))
      ;; We load the score file.
      (setq gnus-score-alist nil)
      (setq alist (gnus-score-load-score-alist file))
      ;; We add '(touched) to the alist to signify that it hasn't been
      ;; touched (yet).
      (unless (assq 'touched alist)
	(push (list 'touched nil) alist))
      ;; If it is a global score file, we make it read-only.
      (and global
	   (not (assq 'read-only alist))
	   (push (list 'read-only t) alist))
      (push (cons file alist) gnus-score-cache))
    (let ((a alist)
	  found)
      (while a
	;; Downcase all header names.
1198 1199
	(cond
	 ((stringp (caar a))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1200 1201
	  (setcar (car a) (downcase (caar a)))
	  (setq found t))
1202 1203 1204
	 ;; Advanced scoring.
	 ((consp (caar a))
	  (setq found t)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215
	(pop a))
      ;; If there are actual scores in the alist, we add it to the
      ;; return value of this function.
      (when found
	(setq lists (list alist))))
    ;; Treat the other possible atoms in the score alist.
    (let ((mark (car (gnus-score-get 'mark alist)))
	  (expunge (car (gnus-score-get 'expunge alist)))
	  (mark-and-expunge (car (gnus-score-get 'mark-and-expunge alist)))
	  (files (gnus-score-get 'files alist))
	  (exclude-files (gnus-score-get 'exclude-files alist))
1216
	  (orphan (car (gnus-score-get 'orphan alist)))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1217 1218 1219 1220 1221 1222 1223 1224
	  (adapt (gnus-score-get 'adapt alist))
	  (thread-mark-and-expunge
	   (car (gnus-score-get 'thread-mark-and-expunge alist)))
	  (adapt-file (car (gnus-score-get 'adapt-file alist)))
	  (local (gnus-score-get 'local alist))
	  (decay (car (gnus-score-get 'decay alist)))
	  (eval (car (gnus-score-get 'eval alist))))
      ;; Perform possible decays.
1225 1226 1227
      (when (and (if (stringp gnus-decay-scores)
		     (string-match gnus-decay-scores file)
		   gnus-decay-scores)
1228 1229 1230 1231
		 (or cached (file-exists-p file))
		 (or (not decay)
		     (gnus-decay-scores alist decay)))
	(gnus-score-set 'touched '(t) alist)
1232
	(gnus-score-set 'decay (list (time-to-days (current-time))) alist))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1233 1234
      ;; We do not respect eval and files atoms from global score
      ;; files.
1235 1236
      (when (and files (not global))
	(setq lists (apply 'append lists
1237
			   (mapcar 'gnus-score-load-file
1238 1239 1240 1241
				   (if adapt-file (cons adapt-file files)
				     files)))))
      (when (and eval (not global))
	(eval eval))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1242 1243 1244
      ;; We then expand any exclude-file directives.
      (setq gnus-scores-exclude-files
	    (nconc
1245 1246 1247 1248 1249 1250 1251 1252
	     (apply
	      'nconc
	      (mapcar
	       (lambda (sfile)
		 (list
		  (expand-file-name sfile (file-name-directory file))
		  (expand-file-name sfile gnus-kill-files-directory)))
	       exclude-files))
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1253
	     gnus-scores-exclude-files))
1254
      (when local
1255
	(with-current-buffer gnus-summary-buffer
Lars Magne Ingebrigtsen's avatar
Lars Magne Ingebrigtsen committed
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309
	  (while local
	    (and (consp (car local))
		 (symbolp (caar local))
		 (progn
		   (make-local-variable (caar local))
		   (set (caar local) (nth 1 (car local)))))
	    (setq local (cdr local)))))
      (when orphan
	(setq gnus-orphan-score orphan))
      (setq gnus-adaptive-score-alist
	    (cond ((equal adapt '(t))
		   (setq gnus-newsgroup-adaptive t)
		   gnus-default-adaptive-score-alist)
		  ((equal adapt '(ignore))
		   (setq gnus-newsgroup-adaptive nil))
		  ((consp adapt)
		   (setq gnus-newsgroup-adaptive t)
		   adapt)
		  (t
		   gnus-default-adaptive-score-alist)))
      (setq gnus-thread-expunge-below
	    (or thread-mark-and-expunge gnus-thread-expunge-below))
      (setq gnus-summary-mark-below
	    (or mark mark-and-expunge gnus-summary-mark-below))
      (setq gnus-summary-expunge-below
	    (or expunge mark-and-expunge gnus-summary-expunge-below))
      (setq gnus-newsgroup-adaptive-score-file
	    (or adapt-file gnus-newsgroup-adaptive-score-file)))
    (setq gnus-current-score-file file)
    (setq gnus-score-alist alist)
    lists))

(defun gnus-score-load (file)
  ;; Load score FILE.
  (let ((cache (assoc file gnus-score-cache)))
    (if cache
	(setq gnus-score-alist (cdr cache))
      (setq gnus-score-alist nil)
      (gnus-score-load-score-alist file)
      (unless gnus-score-alist
	(setq gnus-score-alist (copy-alist '((touched nil)))))
      (push (cons file gnus-score-alist) gnus-score-cache))))

(defun gnus-score-remove-from-cache