1 ;;; gnus-logic.el --- advanced scoring code for Gnus
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
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/>.
28 (eval-when-compile (require 'cl))
34 ;;; Internal variables.
36 (defvar gnus-advanced-headers nil)
38 ;; To avoid having 8-bit characters in the source file.
39 (defvar gnus-advanced-not (intern (format "%c" 172)))
41 (defconst gnus-advanced-index
42 ;; Name to index alist.
43 '(("number" 0 gnus-advanced-integer)
44 ("subject" 1 gnus-advanced-string)
45 ("from" 2 gnus-advanced-string)
46 ("date" 3 gnus-advanced-date)
47 ("message-id" 4 gnus-advanced-string)
48 ("references" 5 gnus-advanced-string)
49 ("chars" 6 gnus-advanced-integer)
50 ("lines" 7 gnus-advanced-integer)
51 ("xref" 8 gnus-advanced-string)
52 ("head" nil gnus-advanced-body)
53 ("body" nil gnus-advanced-body)
54 ("all" nil gnus-advanced-body)))
56 (autoload 'parse-time-string "parse-time")
58 (defun gnus-score-advanced (rule &optional trace)
59 "Apply advanced scoring RULE to all the articles in the current group."
60 (let (new-score score multiple)
61 (dolist (gnus-advanced-headers gnus-newsgroup-headers)
62 (when (setq multiple (gnus-advanced-score-rule (car rule)))
63 (setq new-score (or (nth 1 rule)
64 gnus-score-interactive-default-score))
65 (when (numberp multiple)
66 (setq new-score (* multiple new-score)))
67 ;; This rule was successful, so we add the score to this
69 (if (setq score (assq (mail-header-number gnus-advanced-headers)
70 gnus-newsgroup-scored))
72 (+ (cdr score) new-score))
73 (push (cons (mail-header-number gnus-advanced-headers)
75 gnus-newsgroup-scored)
77 (push (cons "A file" rule)
78 ;; Must be synced with `gnus-score-edit-file-at-point'.
79 gnus-score-trace)))))))
81 (defun gnus-advanced-score-rule (rule)
82 "Apply RULE to `gnus-advanced-headers'."
83 (let ((type (car rule)))
86 ((or (eq type '&) (eq type 'and))
89 t ; Empty rule is true.
91 (gnus-advanced-score-rule (car rule)))
93 ;; If all the rules were true, then `rule' should be nil.
96 ((or (eq type '|) (eq type 'or))
101 (not (gnus-advanced-score-rule (car rule))))
103 ;; If one of the rules returned true, then `rule' should be non-nil.
106 ((or (eq type '!) (eq type 'not) (eq type gnus-advanced-not))
107 (not (gnus-advanced-score-rule (nth 1 rule))))
108 ;; This is a `1-'-type redirection rule.
110 (string-match "^[0-9]+-$\\|^\\^+$" (symbol-name type)))
111 (let ((gnus-advanced-headers
113 gnus-advanced-headers
114 (if (string-match "^\\([0-9]+\\)-$" (symbol-name type))
115 ;; 1- type redirection.
117 (substring (symbol-name type)
118 (match-beginning 1) (match-end 1)))
119 ;; ^^^ type redirection.
120 (length (symbol-name type))))))
121 (when gnus-advanced-headers
122 (gnus-advanced-score-rule (nth 1 rule)))))
123 ;; Plain scoring rule.
125 (gnus-advanced-score-article rule))
128 (error "Unknown advanced score type: %s" rule)))))
130 (defun gnus-advanced-score-article (rule)
131 ;; `rule' is a semi-normal score rule, so we find out what function
132 ;; that's supposed to do the actual processing.
133 (let* ((header (car rule))
134 (func (assoc (downcase header) gnus-advanced-index)))
136 (error "No such header: %s" rule)
137 ;; Call the score function.
138 (funcall (caddr func) (or (cadr func) header)
139 (cadr rule) (caddr rule)))))
141 (defun gnus-advanced-string (index match type)
142 "See whether string MATCH of TYPE matches `gnus-advanced-headers' in INDEX."
143 (let* ((type (or type 's))
144 (case-fold-search (not (eq (downcase (symbol-name type))
145 (symbol-name type))))
146 (header (or (aref gnus-advanced-headers index) "")))
148 ((memq type '(r R regexp Regexp))
149 (string-match match header))
150 ((memq type '(s S string String))
151 (string-match (regexp-quote match) header))
152 ((memq type '(e E exact Exact))
153 (string= match header))
154 ((memq type '(f F fuzzy Fuzzy))
155 (string-match (regexp-quote (gnus-simplify-subject-fuzzy match))
158 (error "No such string match type: %s" type)))))
160 (defun gnus-advanced-integer (index match type)
161 (if (not (memq type '(< > <= >= =)))
162 (error "No such integer score type: %s" type)
163 (funcall type (or (aref gnus-advanced-headers index) 0) match)))
165 (defun gnus-advanced-date (index match type)
166 (let ((date (apply 'encode-time (parse-time-string
167 (aref gnus-advanced-headers index))))
168 (match (apply 'encode-time (parse-time-string match))))
173 (time-less-p match date))
175 (time-less-p date match))
177 (error "No such date score type: %s" type)))))
179 (defun gnus-advanced-body (header match type)
180 (when (string= header "all")
181 (setq header "article"))
183 (set-buffer nntp-server-buffer)
184 (let* ((request-func (cond ((string= "head" header)
186 ((string= "body" header)
188 (t 'gnus-request-article)))
190 ;; Not all backends support partial fetching. In that case, we
191 ;; just fetch the entire article.
192 (unless (gnus-check-backend-function
193 (intern (concat "request-" header))
195 (setq ofunc request-func)
196 (setq request-func 'gnus-request-article))
197 (setq article (mail-header-number gnus-advanced-headers))
198 (gnus-message 7 "Scoring article %s..." article)
199 (when (funcall request-func article gnus-newsgroup-name)
200 (goto-char (point-min))
201 ;; If just parts of the article is to be searched and the
202 ;; backend didn't support partial fetching, we just narrow to
203 ;; the relevant parts.
205 (if (eq ofunc 'gnus-request-head)
208 (or (search-forward "\n\n" nil t) (point-max)))
210 (or (search-forward "\n\n" nil t) (point))
212 (let* ((case-fold-search (not (eq (downcase (symbol-name type))
213 (symbol-name type))))
215 (cond ((memq type '(r R regexp Regexp))
217 ((memq type '(s S string String))
220 (error "Invalid match type: %s" type)))))
221 (goto-char (point-min))
223 (funcall search-func match nil t)
226 (provide 'gnus-logic)
228 ;;; gnus-logic.el ends here