Commit | Line | Data |
---|---|---|
eec82323 | 1 | ;;; gnus-logic.el --- advanced scoring code for Gnus |
23f87bed | 2 | ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002 |
16409b0b | 3 | ;; Free Software Foundation, Inc. |
eec82323 | 4 | |
6748645f | 5 | ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org> |
eec82323 LMI |
6 | ;; Keywords: news |
7 | ||
8 | ;; This file is part of GNU Emacs. | |
9 | ||
10 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 | ;; it under the terms of the GNU General Public License as published by | |
12 | ;; the Free Software Foundation; either version 2, or (at your option) | |
13 | ;; any later version. | |
14 | ||
15 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | ;; GNU General Public License for more details. | |
19 | ||
20 | ;; You should have received a copy of the GNU General Public License | |
21 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
3a35cf56 LK |
22 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
23 | ;; Boston, MA 02110-1301, USA. | |
eec82323 LMI |
24 | |
25 | ;;; Commentary: | |
26 | ||
27 | ;;; Code: | |
28 | ||
5ab7173c RS |
29 | (eval-when-compile (require 'cl)) |
30 | ||
eec82323 LMI |
31 | (require 'gnus) |
32 | (require 'gnus-score) | |
33 | (require 'gnus-util) | |
34 | ||
35 | ;;; Internal variables. | |
36 | ||
37 | (defvar gnus-advanced-headers nil) | |
38 | ||
39 | ;; To avoid having 8-bit characters in the source file. | |
40 | (defvar gnus-advanced-not (intern (format "%c" 172))) | |
41 | ||
42 | (defconst gnus-advanced-index | |
43 | ;; Name to index alist. | |
44 | '(("number" 0 gnus-advanced-integer) | |
45 | ("subject" 1 gnus-advanced-string) | |
46 | ("from" 2 gnus-advanced-string) | |
47 | ("date" 3 gnus-advanced-date) | |
48 | ("message-id" 4 gnus-advanced-string) | |
49 | ("references" 5 gnus-advanced-string) | |
50 | ("chars" 6 gnus-advanced-integer) | |
51 | ("lines" 7 gnus-advanced-integer) | |
52 | ("xref" 8 gnus-advanced-string) | |
53 | ("head" nil gnus-advanced-body) | |
54 | ("body" nil gnus-advanced-body) | |
55 | ("all" nil gnus-advanced-body))) | |
56 | ||
57 | (eval-and-compile | |
58 | (autoload 'parse-time-string "parse-time")) | |
59 | ||
60 | (defun gnus-score-advanced (rule &optional trace) | |
61 | "Apply advanced scoring RULE to all the articles in the current group." | |
23f87bed MB |
62 | (let (new-score score multiple) |
63 | (dolist (gnus-advanced-headers gnus-newsgroup-headers) | |
64 | (when (setq multiple (gnus-advanced-score-rule (car rule))) | |
65 | (setq new-score (or (nth 1 rule) | |
66 | gnus-score-interactive-default-score)) | |
67 | (when (numberp multiple) | |
68 | (setq new-score (* multiple new-score))) | |
69 | ;; This rule was successful, so we add the score to this | |
70 | ;; article. | |
eec82323 LMI |
71 | (if (setq score (assq (mail-header-number gnus-advanced-headers) |
72 | gnus-newsgroup-scored)) | |
73 | (setcdr score | |
23f87bed | 74 | (+ (cdr score) new-score)) |
eec82323 | 75 | (push (cons (mail-header-number gnus-advanced-headers) |
23f87bed | 76 | new-score) |
eec82323 LMI |
77 | gnus-newsgroup-scored) |
78 | (when trace | |
79 | (push (cons "A file" rule) | |
23f87bed | 80 | ;; Must be synced with `gnus-score-edit-file-at-point'. |
eec82323 LMI |
81 | gnus-score-trace))))))) |
82 | ||
83 | (defun gnus-advanced-score-rule (rule) | |
84 | "Apply RULE to `gnus-advanced-headers'." | |
85 | (let ((type (car rule))) | |
86 | (cond | |
87 | ;; "And" rule. | |
88 | ((or (eq type '&) (eq type 'and)) | |
89 | (pop rule) | |
90 | (if (not rule) | |
91 | t ; Empty rule is true. | |
92 | (while (and rule | |
93 | (gnus-advanced-score-rule (car rule))) | |
94 | (pop rule)) | |
95 | ;; If all the rules were true, then `rule' should be nil. | |
96 | (not rule))) | |
97 | ;; "Or" rule. | |
98 | ((or (eq type '|) (eq type 'or)) | |
99 | (pop rule) | |
100 | (if (not rule) | |
101 | nil | |
102 | (while (and rule | |
103 | (not (gnus-advanced-score-rule (car rule)))) | |
104 | (pop rule)) | |
105 | ;; If one of the rules returned true, then `rule' should be non-nil. | |
106 | rule)) | |
107 | ;; "Not" rule. | |
108 | ((or (eq type '!) (eq type 'not) (eq type gnus-advanced-not)) | |
109 | (not (gnus-advanced-score-rule (nth 1 rule)))) | |
110 | ;; This is a `1-'-type redirection rule. | |
111 | ((and (symbolp type) | |
112 | (string-match "^[0-9]+-$\\|^\\^+$" (symbol-name type))) | |
113 | (let ((gnus-advanced-headers | |
114 | (gnus-parent-headers | |
115 | gnus-advanced-headers | |
116 | (if (string-match "^\\([0-9]+\\)-$" (symbol-name type)) | |
117 | ;; 1- type redirection. | |
118 | (string-to-number | |
119 | (substring (symbol-name type) | |
23f87bed | 120 | (match-beginning 1) (match-end 1))) |
eec82323 LMI |
121 | ;; ^^^ type redirection. |
122 | (length (symbol-name type)))))) | |
123 | (when gnus-advanced-headers | |
124 | (gnus-advanced-score-rule (nth 1 rule))))) | |
125 | ;; Plain scoring rule. | |
126 | ((stringp type) | |
127 | (gnus-advanced-score-article rule)) | |
128 | ;; Bug-out time! | |
129 | (t | |
130 | (error "Unknown advanced score type: %s" rule))))) | |
131 | ||
132 | (defun gnus-advanced-score-article (rule) | |
23f87bed MB |
133 | ;; `rule' is a semi-normal score rule, so we find out what function |
134 | ;; that's supposed to do the actual processing. | |
eec82323 LMI |
135 | (let* ((header (car rule)) |
136 | (func (assoc (downcase header) gnus-advanced-index))) | |
137 | (if (not func) | |
138 | (error "No such header: %s" rule) | |
139 | ;; Call the score function. | |
140 | (funcall (caddr func) (or (cadr func) header) | |
141 | (cadr rule) (caddr rule))))) | |
142 | ||
143 | (defun gnus-advanced-string (index match type) | |
144 | "See whether string MATCH of TYPE matches `gnus-advanced-headers' in INDEX." | |
145 | (let* ((type (or type 's)) | |
146 | (case-fold-search (not (eq (downcase (symbol-name type)) | |
147 | (symbol-name type)))) | |
8b84c4d3 | 148 | (header (or (aref gnus-advanced-headers index) ""))) |
eec82323 LMI |
149 | (cond |
150 | ((memq type '(r R regexp Regexp)) | |
151 | (string-match match header)) | |
152 | ((memq type '(s S string String)) | |
153 | (string-match (regexp-quote match) header)) | |
154 | ((memq type '(e E exact Exact)) | |
155 | (string= match header)) | |
156 | ((memq type '(f F fuzzy Fuzzy)) | |
157 | (string-match (regexp-quote (gnus-simplify-subject-fuzzy match)) | |
158 | header)) | |
159 | (t | |
160 | (error "No such string match type: %s" type))))) | |
161 | ||
162 | (defun gnus-advanced-integer (index match type) | |
163 | (if (not (memq type '(< > <= >= =))) | |
164 | (error "No such integer score type: %s" type) | |
23f87bed | 165 | (funcall type (or (aref gnus-advanced-headers index) 0) match))) |
eec82323 LMI |
166 | |
167 | (defun gnus-advanced-date (index match type) | |
6748645f LMI |
168 | (let ((date (apply 'encode-time (parse-time-string |
169 | (aref gnus-advanced-headers index)))) | |
170 | (match (apply 'encode-time (parse-time-string match)))) | |
eec82323 LMI |
171 | (cond |
172 | ((eq type 'at) | |
173 | (equal date match)) | |
174 | ((eq type 'before) | |
16409b0b | 175 | (time-less-p match date)) |
eec82323 | 176 | ((eq type 'after) |
16409b0b | 177 | (time-less-p date match)) |
eec82323 LMI |
178 | (t |
179 | (error "No such date score type: %s" type))))) | |
180 | ||
181 | (defun gnus-advanced-body (header match type) | |
182 | (when (string= header "all") | |
183 | (setq header "article")) | |
184 | (save-excursion | |
185 | (set-buffer nntp-server-buffer) | |
186 | (let* ((request-func (cond ((string= "head" header) | |
187 | 'gnus-request-head) | |
188 | ((string= "body" header) | |
189 | 'gnus-request-body) | |
190 | (t 'gnus-request-article))) | |
191 | ofunc article) | |
23f87bed MB |
192 | ;; Not all backends support partial fetching. In that case, we |
193 | ;; just fetch the entire article. | |
eec82323 LMI |
194 | (unless (gnus-check-backend-function |
195 | (intern (concat "request-" header)) | |
196 | gnus-newsgroup-name) | |
197 | (setq ofunc request-func) | |
198 | (setq request-func 'gnus-request-article)) | |
199 | (setq article (mail-header-number gnus-advanced-headers)) | |
200 | (gnus-message 7 "Scoring article %s..." article) | |
201 | (when (funcall request-func article gnus-newsgroup-name) | |
202 | (goto-char (point-min)) | |
203 | ;; If just parts of the article is to be searched and the | |
23f87bed MB |
204 | ;; backend didn't support partial fetching, we just narrow to |
205 | ;; the relevant parts. | |
eec82323 LMI |
206 | (when ofunc |
207 | (if (eq ofunc 'gnus-request-head) | |
208 | (narrow-to-region | |
209 | (point) | |
210 | (or (search-forward "\n\n" nil t) (point-max))) | |
211 | (narrow-to-region | |
212 | (or (search-forward "\n\n" nil t) (point)) | |
213 | (point-max)))) | |
214 | (let* ((case-fold-search (not (eq (downcase (symbol-name type)) | |
215 | (symbol-name type)))) | |
216 | (search-func | |
217 | (cond ((memq type '(r R regexp Regexp)) | |
218 | 're-search-forward) | |
219 | ((memq type '(s S string String)) | |
220 | 'search-forward) | |
221 | (t | |
16409b0b | 222 | (error "Invalid match type: %s" type))))) |
eec82323 LMI |
223 | (goto-char (point-min)) |
224 | (prog1 | |
225 | (funcall search-func match nil t) | |
226 | (widen))))))) | |
227 | ||
228 | (provide 'gnus-logic) | |
229 | ||
ab5796a9 | 230 | ;;; arch-tag: 9651a100-4a59-4b69-a55b-e511e67c0f8d |
715a2ca2 | 231 | ;;; gnus-logic.el ends here |