Commit | Line | Data |
---|---|---|
eec82323 | 1 | ;;; gnus-logic.el --- advanced scoring code for Gnus |
e84b4b86 TTN |
2 | |
3 | ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, | |
114f9c96 | 4 | ;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. |
eec82323 | 5 | |
6748645f | 6 | ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org> |
eec82323 LMI |
7 | ;; Keywords: news |
8 | ||
9 | ;; This file is part of GNU Emacs. | |
10 | ||
5e809f55 | 11 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
eec82323 | 12 | ;; it under the terms of the GNU General Public License as published by |
5e809f55 GM |
13 | ;; the Free Software Foundation, either version 3 of the License, or |
14 | ;; (at your option) any later version. | |
eec82323 LMI |
15 | |
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. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
5e809f55 | 22 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
eec82323 LMI |
23 | |
24 | ;;; Commentary: | |
25 | ||
26 | ;;; Code: | |
27 | ||
5ab7173c RS |
28 | (eval-when-compile (require 'cl)) |
29 | ||
eec82323 LMI |
30 | (require 'gnus) |
31 | (require 'gnus-score) | |
32 | (require 'gnus-util) | |
33 | ||
34 | ;;; Internal variables. | |
35 | ||
36 | (defvar gnus-advanced-headers nil) | |
37 | ||
38 | ;; To avoid having 8-bit characters in the source file. | |
39 | (defvar gnus-advanced-not (intern (format "%c" 172))) | |
40 | ||
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))) | |
55 | ||
8abf1b22 | 56 | (autoload 'parse-time-string "parse-time") |
eec82323 LMI |
57 | |
58 | (defun gnus-score-advanced (rule &optional trace) | |
59 | "Apply advanced scoring RULE to all the articles in the current group." | |
23f87bed MB |
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 | |
68 | ;; article. | |
eec82323 LMI |
69 | (if (setq score (assq (mail-header-number gnus-advanced-headers) |
70 | gnus-newsgroup-scored)) | |
71 | (setcdr score | |
23f87bed | 72 | (+ (cdr score) new-score)) |
eec82323 | 73 | (push (cons (mail-header-number gnus-advanced-headers) |
23f87bed | 74 | new-score) |
eec82323 LMI |
75 | gnus-newsgroup-scored) |
76 | (when trace | |
77 | (push (cons "A file" rule) | |
23f87bed | 78 | ;; Must be synced with `gnus-score-edit-file-at-point'. |
eec82323 LMI |
79 | gnus-score-trace))))))) |
80 | ||
81 | (defun gnus-advanced-score-rule (rule) | |
82 | "Apply RULE to `gnus-advanced-headers'." | |
83 | (let ((type (car rule))) | |
84 | (cond | |
85 | ;; "And" rule. | |
86 | ((or (eq type '&) (eq type 'and)) | |
87 | (pop rule) | |
88 | (if (not rule) | |
89 | t ; Empty rule is true. | |
90 | (while (and rule | |
91 | (gnus-advanced-score-rule (car rule))) | |
92 | (pop rule)) | |
93 | ;; If all the rules were true, then `rule' should be nil. | |
94 | (not rule))) | |
95 | ;; "Or" rule. | |
96 | ((or (eq type '|) (eq type 'or)) | |
97 | (pop rule) | |
98 | (if (not rule) | |
99 | nil | |
100 | (while (and rule | |
101 | (not (gnus-advanced-score-rule (car rule)))) | |
102 | (pop rule)) | |
103 | ;; If one of the rules returned true, then `rule' should be non-nil. | |
104 | rule)) | |
105 | ;; "Not" rule. | |
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. | |
109 | ((and (symbolp type) | |
110 | (string-match "^[0-9]+-$\\|^\\^+$" (symbol-name type))) | |
111 | (let ((gnus-advanced-headers | |
112 | (gnus-parent-headers | |
113 | gnus-advanced-headers | |
114 | (if (string-match "^\\([0-9]+\\)-$" (symbol-name type)) | |
115 | ;; 1- type redirection. | |
116 | (string-to-number | |
117 | (substring (symbol-name type) | |
23f87bed | 118 | (match-beginning 1) (match-end 1))) |
eec82323 LMI |
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. | |
124 | ((stringp type) | |
125 | (gnus-advanced-score-article rule)) | |
126 | ;; Bug-out time! | |
127 | (t | |
128 | (error "Unknown advanced score type: %s" rule))))) | |
129 | ||
130 | (defun gnus-advanced-score-article (rule) | |
23f87bed MB |
131 | ;; `rule' is a semi-normal score rule, so we find out what function |
132 | ;; that's supposed to do the actual processing. | |
eec82323 LMI |
133 | (let* ((header (car rule)) |
134 | (func (assoc (downcase header) gnus-advanced-index))) | |
135 | (if (not func) | |
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))))) | |
140 | ||
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)))) | |
8b84c4d3 | 146 | (header (or (aref gnus-advanced-headers index) ""))) |
eec82323 LMI |
147 | (cond |
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)) | |
156 | header)) | |
157 | (t | |
158 | (error "No such string match type: %s" type))))) | |
159 | ||
160 | (defun gnus-advanced-integer (index match type) | |
161 | (if (not (memq type '(< > <= >= =))) | |
162 | (error "No such integer score type: %s" type) | |
23f87bed | 163 | (funcall type (or (aref gnus-advanced-headers index) 0) match))) |
eec82323 LMI |
164 | |
165 | (defun gnus-advanced-date (index match type) | |
6748645f LMI |
166 | (let ((date (apply 'encode-time (parse-time-string |
167 | (aref gnus-advanced-headers index)))) | |
168 | (match (apply 'encode-time (parse-time-string match)))) | |
eec82323 LMI |
169 | (cond |
170 | ((eq type 'at) | |
171 | (equal date match)) | |
172 | ((eq type 'before) | |
16409b0b | 173 | (time-less-p match date)) |
eec82323 | 174 | ((eq type 'after) |
16409b0b | 175 | (time-less-p date match)) |
eec82323 LMI |
176 | (t |
177 | (error "No such date score type: %s" type))))) | |
178 | ||
179 | (defun gnus-advanced-body (header match type) | |
180 | (when (string= header "all") | |
181 | (setq header "article")) | |
20a673b2 | 182 | (with-current-buffer nntp-server-buffer |
eec82323 LMI |
183 | (let* ((request-func (cond ((string= "head" header) |
184 | 'gnus-request-head) | |
185 | ((string= "body" header) | |
186 | 'gnus-request-body) | |
187 | (t 'gnus-request-article))) | |
188 | ofunc article) | |
23f87bed MB |
189 | ;; Not all backends support partial fetching. In that case, we |
190 | ;; just fetch the entire article. | |
eec82323 LMI |
191 | (unless (gnus-check-backend-function |
192 | (intern (concat "request-" header)) | |
193 | gnus-newsgroup-name) | |
194 | (setq ofunc request-func) | |
195 | (setq request-func 'gnus-request-article)) | |
196 | (setq article (mail-header-number gnus-advanced-headers)) | |
197 | (gnus-message 7 "Scoring article %s..." article) | |
198 | (when (funcall request-func article gnus-newsgroup-name) | |
199 | (goto-char (point-min)) | |
200 | ;; If just parts of the article is to be searched and the | |
23f87bed MB |
201 | ;; backend didn't support partial fetching, we just narrow to |
202 | ;; the relevant parts. | |
eec82323 LMI |
203 | (when ofunc |
204 | (if (eq ofunc 'gnus-request-head) | |
205 | (narrow-to-region | |
206 | (point) | |
207 | (or (search-forward "\n\n" nil t) (point-max))) | |
208 | (narrow-to-region | |
209 | (or (search-forward "\n\n" nil t) (point)) | |
210 | (point-max)))) | |
211 | (let* ((case-fold-search (not (eq (downcase (symbol-name type)) | |
212 | (symbol-name type)))) | |
213 | (search-func | |
214 | (cond ((memq type '(r R regexp Regexp)) | |
215 | 're-search-forward) | |
216 | ((memq type '(s S string String)) | |
217 | 'search-forward) | |
218 | (t | |
16409b0b | 219 | (error "Invalid match type: %s" type))))) |
eec82323 LMI |
220 | (goto-char (point-min)) |
221 | (prog1 | |
222 | (funcall search-func match nil t) | |
223 | (widen))))))) | |
224 | ||
225 | (provide 'gnus-logic) | |
226 | ||
715a2ca2 | 227 | ;;; gnus-logic.el ends here |