Commit | Line | Data |
---|---|---|
c113de23 | 1 | ;;; nnimap.el --- imap backend for Gnus |
23f87bed MB |
2 | ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004 |
3 | ;; Free Software Foundation, Inc. | |
c113de23 GM |
4 | |
5 | ;; Author: Simon Josefsson <jas@pdc.kth.se> | |
6 | ;; Jim Radford <radford@robby.caltech.edu> | |
7 | ;; Keywords: mail | |
8 | ||
9 | ;; This file is part of GNU Emacs. | |
10 | ||
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 2, or (at your option) | |
14 | ;; any later version. | |
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 | |
22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
23 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
24 | ;; Boston, MA 02111-1307, USA. | |
25 | ||
26 | ;;; Commentary: | |
27 | ||
28 | ;; Todo, major things: | |
29 | ;; | |
30 | ;; o Fix Gnus to view correct number of unread/total articles in group buffer | |
31 | ;; o Fix Gnus to handle leading '.' in group names (fixed?) | |
32 | ;; o Finish disconnected mode (moving articles between mailboxes unplugged) | |
33 | ;; o Sieve | |
34 | ;; o MIME (partial article fetches) | |
35 | ;; o Split to other backends, different split rules for different | |
36 | ;; servers/inboxes | |
37 | ;; | |
38 | ;; Todo, minor things: | |
39 | ;; | |
40 | ;; o Don't require half of Gnus -- backends should be standalone | |
41 | ;; o Verify that we don't use IMAP4rev1 specific things (RFC2060 App B) | |
42 | ;; o Dont uid fetch 1,* in nnimap-retrive-groups (slow) | |
43 | ;; o Split up big fetches (1,* header especially) in smaller chunks | |
44 | ;; o What do I do with gnus-newsgroup-*? | |
45 | ;; o Tell Gnus about new groups (how can we tell?) | |
8f688cb0 | 46 | ;; o Respooling (fix Gnus?) (unnecessary?) |
c113de23 GM |
47 | ;; o Add support for the following: (if applicable) |
48 | ;; request-list-newsgroups, request-regenerate | |
49 | ;; list-active-group, | |
50 | ;; request-associate-buffer, request-restore-buffer, | |
51 | ;; o Do The Right Thing when UIDVALIDITY changes (what's the right thing?) | |
52 | ;; o Support RFC2221 (Login referrals) | |
53 | ;; o IMAP2BIS compatibility? (RFC2061) | |
54 | ;; o ACAP stuff (perhaps a different project, would be nice to ACAPify | |
55 | ;; .newsrc.eld) | |
56 | ;; o What about Gnus's article editing, can we support it? NO! | |
57 | ;; o Use \Draft to support the draft group?? | |
58 | ;; o Duplicate suppression | |
23f87bed | 59 | ;; o Rewrite UID SEARCH UID X as UID FETCH X (UID) for those with slow servers |
c113de23 GM |
60 | |
61 | ;;; Code: | |
62 | ||
23f87bed | 63 | (require 'imap) |
c113de23 GM |
64 | (require 'nnoo) |
65 | (require 'nnmail) | |
66 | (require 'nnheader) | |
67 | (require 'mm-util) | |
68 | (require 'gnus) | |
69 | (require 'gnus-range) | |
70 | (require 'gnus-start) | |
71 | (require 'gnus-int) | |
72 | ||
23f87bed MB |
73 | (eval-when-compile (require 'cl)) |
74 | ||
c113de23 GM |
75 | (nnoo-declare nnimap) |
76 | ||
23f87bed MB |
77 | (defconst nnimap-version "nnimap 1.0") |
78 | ||
79 | (defgroup nnimap nil | |
80 | "Reading IMAP mail with Gnus." | |
81 | :group 'gnus) | |
c113de23 GM |
82 | |
83 | (defvoo nnimap-address nil | |
84 | "Address of physical IMAP server. If nil, use the virtual server's name.") | |
85 | ||
86 | (defvoo nnimap-server-port nil | |
87 | "Port number on physical IMAP server. | |
23f87bed | 88 | If nil, defaults to 993 for TLS/SSL connections and 143 otherwise.") |
c113de23 GM |
89 | |
90 | ;; Splitting variables | |
91 | ||
23f87bed | 92 | (defcustom nnimap-split-crosspost t |
c113de23 | 93 | "If non-nil, do crossposting if several split methods match the mail. |
23f87bed MB |
94 | If nil, the first match found will be used." |
95 | :group 'nnimap | |
96 | :type 'boolean) | |
c113de23 | 97 | |
23f87bed MB |
98 | (defcustom nnimap-split-inbox nil |
99 | "Name of mailbox to split mail from. | |
c113de23 GM |
100 | |
101 | Mail is read from this mailbox and split according to rules in | |
23f87bed MB |
102 | `nnimap-split-rule'. |
103 | ||
104 | This can be a string or a list of strings." | |
105 | :group 'nnimap | |
106 | :type '(choice (string) | |
107 | (repeat string))) | |
108 | ||
109 | (define-widget 'nnimap-strict-function 'function | |
110 | "This widget only matches values that are functionp. | |
111 | ||
112 | Warning: This means that a value that is the symbol of a not yet | |
113 | loaded function will not match. Use with care." | |
114 | :match 'nnimap-strict-function-match) | |
c113de23 | 115 | |
23f87bed MB |
116 | (defun nnimap-strict-function-match (widget value) |
117 | "Ignoring WIDGET, match if VALUE is a function." | |
118 | (functionp value)) | |
c113de23 | 119 | |
23f87bed MB |
120 | (defcustom nnimap-split-rule nil |
121 | "Mail will be split according to these rules. | |
c113de23 GM |
122 | |
123 | Mail is read from mailbox(es) specified in `nnimap-split-inbox'. | |
124 | ||
125 | If you'd like, for instance, one mail group for mail from the | |
126 | \"gnus-imap\" mailing list, one group for junk mail and leave | |
127 | everything else in the incoming mailbox, you could do something like | |
128 | this: | |
129 | ||
6c1b363d | 130 | \(setq nnimap-split-rule '((\"INBOX.gnus-imap\" \"From:.*gnus-imap\") |
c113de23 GM |
131 | (\"INBOX.junk\" \"Subject:.*buy\"))) |
132 | ||
23f87bed MB |
133 | As you can see, `nnimap-split-rule' is a list of lists, where the |
134 | first element in each \"rule\" is the name of the IMAP mailbox (or the | |
135 | symbol `junk' if you want to remove the mail), and the second is a | |
136 | regexp that nnimap will try to match on the header to find a fit. | |
c113de23 GM |
137 | |
138 | The second element can also be a function. In that case, it will be | |
139 | called narrowed to the headers with the first element of the rule as | |
140 | the argument. It should return a non-nil value if it thinks that the | |
141 | mail belongs in that group. | |
142 | ||
143 | This variable can also have a function as its value, the function will | |
144 | be called with the headers narrowed and should return a group where it | |
145 | thinks the article should be splitted to. See `nnimap-split-fancy'. | |
146 | ||
147 | To allow for different split rules on different virtual servers, and | |
148 | even different split rules in different inboxes on the same server, | |
149 | the syntax of this variable have been extended along the lines of: | |
150 | ||
6c1b363d | 151 | \(setq nnimap-split-rule |
c113de23 | 152 | '((\"my1server\" (\".*\" ((\"ding\" \"ding@gnus.org\") |
23f87bed MB |
153 | (\"junk\" \"From:.*Simon\"))) |
154 | (\"my2server\" (\"INBOX\" nnimap-split-fancy)) | |
155 | (\"my[34]server\" (\".*\" ((\"private\" \"To:.*Simon\") | |
156 | (\"junk\" my-junk-func))))) | |
c113de23 GM |
157 | |
158 | The virtual server name is in fact a regexp, so that the same rules | |
159 | may apply to several servers. In the example, the servers | |
160 | \"my3server\" and \"my4server\" both use the same rules. Similarly, | |
161 | the inbox string is also a regexp. The actual splitting rules are as | |
162 | before, either a function, or a list with group/regexp or | |
23f87bed MB |
163 | group/function elements." |
164 | :group 'nnimap | |
165 | :type '(choice :tag "Rule type" | |
166 | (repeat :menu-tag "Single-server" | |
167 | :tag "Single-server list" | |
168 | (list (string :tag "Mailbox") | |
169 | (choice :tag "Predicate" | |
170 | (regexp :tag "A regexp") | |
171 | (nnimap-strict-function :tag "A function")))) | |
172 | (choice :menu-tag "A function" | |
173 | :tag "A function" | |
174 | (function-item nnimap-split-fancy) | |
175 | (function-item nnmail-split-fancy) | |
176 | (nnimap-strict-function :tag "User-defined function")) | |
177 | (repeat :menu-tag "Multi-server (extended)" | |
178 | :tag "Multi-server list" | |
179 | (list (regexp :tag "Server regexp") | |
180 | (list (regexp :tag "Incoming Mailbox regexp") | |
181 | (repeat :tag "Rules for matching server(s) and mailbox(es)" | |
182 | (list (string :tag "Destination mailbox") | |
183 | (choice :tag "Predicate" | |
184 | (regexp :tag "A Regexp") | |
185 | (nnimap-strict-function :tag "A Function"))))))))) | |
186 | ||
187 | (defcustom nnimap-split-predicate "UNSEEN UNDELETED" | |
c113de23 GM |
188 | "The predicate used to find articles to split. |
189 | If you use another IMAP client to peek on articles but always would | |
190 | like nnimap to split them once it's started, you could change this to | |
191 | \"UNDELETED\". Other available predicates are available in | |
23f87bed MB |
192 | RFC2060 section 6.4.4." |
193 | :group 'nnimap | |
194 | :type 'string) | |
195 | ||
196 | (defcustom nnimap-split-fancy nil | |
197 | "Like the variable `nnmail-split-fancy'." | |
198 | :group 'nnimap | |
199 | :type 'sexp) | |
200 | ||
201 | (defvar nnimap-split-download-body-default nil | |
202 | "Internal variable with default value for `nnimap-split-download-body'.") | |
203 | ||
204 | (defcustom nnimap-split-download-body 'default | |
205 | "Whether to download entire articles during splitting. | |
206 | This is generally not required, and will slow things down considerably. | |
207 | You may need it if you want to use an advanced splitting function that | |
208 | analyses the body before splitting the article. | |
209 | If this variable is nil, bodies will not be downloaded; if this | |
210 | variable is the symbol `default' the default behaviour is | |
211 | used (which currently is nil, unless you use a statistical | |
212 | spam.el test); if this variable is another non-nil value bodies | |
213 | will be downloaded." | |
a08b59c9 | 214 | :version "21.4" |
23f87bed MB |
215 | :group 'nnimap |
216 | :type '(choice (const :tag "Let system decide" deault) | |
217 | boolean)) | |
218 | ||
219 | ;; Performance / bug workaround variables | |
220 | ||
221 | (defcustom nnimap-close-asynchronous t | |
222 | "Close mailboxes asynchronously in `nnimap-close-group'. | |
a08b59c9 | 223 | This means that errors caught by nnimap when closing the mailbox will |
23f87bed MB |
224 | not prevent Gnus from updating the group status, which may be harmful. |
225 | However, it increases speed." | |
a08b59c9 | 226 | :version "21.4" |
23f87bed MB |
227 | :type 'boolean |
228 | :group 'nnimap) | |
229 | ||
230 | (defcustom nnimap-dont-close t | |
231 | "Never close mailboxes. | |
232 | This increases the speed of closing mailboxes (quiting group) but may | |
233 | decrease the speed of selecting another mailbox later. Re-selecting | |
234 | the same mailbox will be faster though." | |
a08b59c9 | 235 | :version "21.4" |
23f87bed MB |
236 | :type 'boolean |
237 | :group 'nnimap) | |
238 | ||
239 | (defcustom nnimap-retrieve-groups-asynchronous t | |
240 | "Send asynchronous STATUS commands for each mailbox before checking mail. | |
241 | If you have mailboxes that rarely receives mail, this speeds up new | |
242 | mail checking. It works by first sending STATUS commands for each | |
243 | mailbox, and then only checking groups which has a modified UIDNEXT | |
244 | more carefully for new mail. | |
c113de23 | 245 | |
23f87bed MB |
246 | In summary, the default is O((1-p)*k+p*n) and changing it to nil makes |
247 | it O(n). If p is small, then the default is probably faster." | |
a08b59c9 | 248 | :version "21.4" |
23f87bed MB |
249 | :type 'boolean |
250 | :group 'nnimap) | |
251 | ||
252 | (defvoo nnimap-need-unselect-to-notice-new-mail nil | |
253 | "Unselect mailboxes before looking for new mail in them. | |
254 | Some servers seem to need this under some circumstances.") | |
c113de23 GM |
255 | |
256 | ;; Authorization / Privacy variables | |
257 | ||
258 | (defvoo nnimap-auth-method nil | |
259 | "Obsolete.") | |
260 | ||
261 | (defvoo nnimap-stream nil | |
262 | "How nnimap will connect to the server. | |
263 | ||
264 | The default, nil, will try to use the \"best\" method the server can | |
265 | handle. | |
266 | ||
267 | Change this if | |
268 | ||
23f87bed MB |
269 | 1) you want to connect with TLS/SSL. The TLS/SSL integration |
270 | with IMAP is suboptimal so you'll have to tell it | |
271 | specifically. | |
c113de23 GM |
272 | |
273 | 2) your server is more capable than your environment -- i.e. your | |
274 | server accept Kerberos login's but you haven't installed the | |
275 | `imtest' program or your machine isn't configured for Kerberos. | |
276 | ||
23f87bed MB |
277 | Possible choices: gssapi, kerberos4, starttls, tls, ssl, network, shell. |
278 | See also `imap-streams' and `imap-stream-alist'.") | |
c113de23 GM |
279 | |
280 | (defvoo nnimap-authenticator nil | |
281 | "How nnimap authenticate itself to the server. | |
282 | ||
283 | The default, nil, will try to use the \"best\" method the server can | |
284 | handle. | |
285 | ||
286 | There is only one reason for fiddling with this variable, and that is | |
287 | if your server is more capable than your environment -- i.e. you | |
288 | connect to a server that accept Kerberos login's but you haven't | |
289 | installed the `imtest' program or your machine isn't configured for | |
290 | Kerberos. | |
291 | ||
23f87bed MB |
292 | Possible choices: gssapi, kerberos4, digest-md5, cram-md5, login, anonymous. |
293 | See also `imap-authenticators' and `imap-authenticator-alist'") | |
c113de23 GM |
294 | |
295 | (defvoo nnimap-directory (nnheader-concat gnus-directory "overview/") | |
296 | "Directory to keep NOV cache files for nnimap groups. | |
297 | See also `nnimap-nov-file-name'.") | |
298 | ||
299 | (defvoo nnimap-nov-file-name "nnimap." | |
300 | "NOV cache base filename. | |
301 | The group name and `nnimap-nov-file-name-suffix' will be appended. A | |
302 | typical complete file name would be | |
303 | ~/News/overview/nnimap.pdc.INBOX.ding.nov, or | |
304 | ~/News/overview/nnimap/pdc/INBOX/ding/nov if | |
305 | `nnmail-use-long-file-names' is nil") | |
306 | ||
307 | (defvoo nnimap-nov-file-name-suffix ".novcache" | |
308 | "Suffix for NOV cache base filename.") | |
309 | ||
23f87bed MB |
310 | (defvoo nnimap-nov-is-evil gnus-agent |
311 | "If non-nil, never generate or use a local nov database for this backend. | |
312 | Using nov databases should speed up header fetching considerably. | |
313 | However, it will invoke a UID SEARCH UID command on the server, and | |
314 | some servers implement this command inefficiently by opening each and | |
315 | every message in the group, thus making it quite slow. | |
c113de23 GM |
316 | Unlike other backends, you do not need to take special care if you |
317 | flip this variable.") | |
318 | ||
319 | (defvoo nnimap-expunge-on-close 'always ; 'ask, 'never | |
320 | "Whether to expunge a group when it is closed. | |
321 | When a IMAP group with articles marked for deletion is closed, this | |
322 | variable determine if nnimap should actually remove the articles or | |
323 | not. | |
324 | ||
325 | If always, nnimap always perform a expunge when closing the group. | |
326 | If never, nnimap never expunges articles marked for deletion. | |
327 | If ask, nnimap will ask you if you wish to expunge marked articles. | |
328 | ||
329 | When setting this variable to `never', you can only expunge articles | |
330 | by using `G x' (gnus-group-nnimap-expunge) from the Group buffer.") | |
331 | ||
332 | (defvoo nnimap-list-pattern "*" | |
333 | "A string LIMIT or list of strings with mailbox wildcards used to limit available groups. | |
334 | See below for available wildcards. | |
335 | ||
336 | The LIMIT string can be a cons cell (REFERENCE . LIMIT), where | |
337 | REFERENCE will be passed as the first parameter to LIST/LSUB. The | |
338 | semantics of this are server specific, on the University of Washington | |
339 | server you can specify a directory. | |
340 | ||
341 | Example: | |
342 | '(\"INBOX\" \"mail/*\" (\"~friend/mail/\" . \"list/*\")) | |
343 | ||
344 | There are two wildcards * and %. * matches everything, % matches | |
345 | everything in the current hierarchy.") | |
346 | ||
347 | (defvoo nnimap-news-groups nil | |
23f87bed MB |
348 | "IMAP support a news-like mode, also known as bulletin board mode, |
349 | where replies is sent via IMAP instead of SMTP. | |
c113de23 GM |
350 | |
351 | This variable should contain a regexp matching groups where you wish | |
352 | replies to be stored to the mailbox directly. | |
353 | ||
354 | Example: | |
355 | '(\"^[^I][^N][^B][^O][^X].*$\") | |
356 | ||
357 | This will match all groups not beginning with \"INBOX\". | |
358 | ||
359 | Note that there is nothing technically different between mail-like and | |
360 | news-like mailboxes. If you wish to have a group with todo items or | |
361 | similar which you wouldn't want to set up a mailing list for, you can | |
362 | use this to make replies go directly to the group.") | |
363 | ||
23f87bed MB |
364 | (defvoo nnimap-expunge-search-string "UID %s NOT SINCE %s" |
365 | "IMAP search command to use for articles that are to be expired. | |
366 | The first %s is replaced by a UID set of articles to search on, | |
367 | and the second %s is replaced by a date criterium. | |
368 | ||
369 | One useful (and perhaps the only useful) value to change this to would | |
370 | be `UID %s NOT SENTSINCE %s' to make nnimap use the Date: header | |
371 | instead of the internal date of messages. See section 6.4.4 of RFC | |
372 | 2060 for more information on valid strings.") | |
373 | ||
374 | (defvoo nnimap-importantize-dormant t | |
375 | "If non-nil, mark \"dormant\" articles as \"ticked\" for other IMAP clients. | |
376 | Note that within Gnus, dormant articles will still (only) be | |
377 | marked as ticked. This is to make \"dormant\" articles stand out, | |
378 | just like \"ticked\" articles, in other IMAP clients.") | |
379 | ||
c113de23 GM |
380 | (defvoo nnimap-server-address nil |
381 | "Obsolete. Use `nnimap-address'.") | |
382 | ||
383 | (defcustom nnimap-authinfo-file "~/.authinfo" | |
384 | "Authorization information for IMAP servers. In .netrc format." | |
385 | :type | |
386 | '(choice file | |
387 | (repeat :tag "Entries" | |
388 | :menu-tag "Inline" | |
389 | (list :format "%v" | |
390 | :value ("" ("login" . "") ("password" . "")) | |
391 | (string :tag "Host") | |
392 | (checklist :inline t | |
393 | (cons :format "%v" | |
394 | (const :format "" "login") | |
395 | (string :format "Login: %v")) | |
396 | (cons :format "%v" | |
397 | (const :format "" "password") | |
da9b82bb KS |
398 | (string :format "Password: %v")))))) |
399 | :group 'nnimap) | |
c113de23 GM |
400 | |
401 | (defcustom nnimap-prune-cache t | |
402 | "If non-nil, nnimap check whether articles still exist on server before using data stored in NOV cache." | |
da9b82bb KS |
403 | :type 'boolean |
404 | :group 'nnimap) | |
c113de23 GM |
405 | |
406 | (defvar nnimap-request-list-method 'imap-mailbox-list | |
407 | "Method to use to request a list of all folders from the server. | |
408 | If this is 'imap-mailbox-lsub, then use a server-side subscription list to | |
409 | restrict visible folders.") | |
410 | ||
23f87bed MB |
411 | (defcustom nnimap-debug nil |
412 | "If non-nil, random debug spews are placed in *nnimap-debug* buffer." | |
413 | :group 'nnimap | |
414 | :type 'boolean) | |
415 | ||
c113de23 GM |
416 | ;; Internal variables: |
417 | ||
23f87bed MB |
418 | (defvar nnimap-debug-buffer "*nnimap-debug*") |
419 | (defvar nnimap-mailbox-info (gnus-make-hashtable 997)) | |
c113de23 GM |
420 | (defvar nnimap-current-move-server nil) |
421 | (defvar nnimap-current-move-group nil) | |
422 | (defvar nnimap-current-move-article nil) | |
423 | (defvar nnimap-length) | |
424 | (defvar nnimap-progress-chars '(?| ?/ ?- ?\\)) | |
425 | (defvar nnimap-progress-how-often 20) | |
426 | (defvar nnimap-counter) | |
c113de23 | 427 | (defvar nnimap-server-buffer-alist nil) ;; Map server name to buffers. |
23f87bed MB |
428 | (defvar nnimap-current-server nil) ;; Current server |
429 | (defvar nnimap-server-buffer nil) ;; Current servers' buffer | |
c113de23 GM |
430 | |
431 | \f | |
432 | ||
433 | (nnoo-define-basics nnimap) | |
434 | ||
435 | ;; Utility functions: | |
436 | ||
437 | (defsubst nnimap-get-server-buffer (server) | |
438 | "Return buffer for SERVER, if nil use current server." | |
439 | (cadr (assoc (or server nnimap-current-server) nnimap-server-buffer-alist))) | |
440 | ||
441 | (defun nnimap-possibly-change-server (server) | |
442 | "Return buffer for SERVER, changing the current server as a side-effect. | |
443 | If SERVER is nil, uses the current server." | |
444 | (setq nnimap-current-server (or server nnimap-current-server) | |
445 | nnimap-server-buffer (nnimap-get-server-buffer nnimap-current-server))) | |
446 | ||
447 | (defun nnimap-verify-uidvalidity (group server) | |
448 | "Verify stored uidvalidity match current one in GROUP on SERVER." | |
449 | (let* ((gnusgroup (gnus-group-prefixed-name | |
450 | group (gnus-server-to-method | |
451 | (format "nnimap:%s" server)))) | |
452 | (new-uidvalidity (imap-mailbox-get 'uidvalidity)) | |
a2617484 DL |
453 | (old-uidvalidity (gnus-group-get-parameter gnusgroup 'uidvalidity)) |
454 | (dir (file-name-as-directory (expand-file-name nnimap-directory))) | |
23f87bed MB |
455 | (nameuid (nnheader-translate-file-chars |
456 | (concat nnimap-nov-file-name | |
457 | (if (equal server "") | |
458 | "unnamed" | |
459 | server) "." group "." old-uidvalidity | |
460 | nnimap-nov-file-name-suffix) t)) | |
461 | (file (if (or nnmail-use-long-file-names | |
a2617484 DL |
462 | (file-exists-p (expand-file-name nameuid dir))) |
463 | (expand-file-name nameuid dir) | |
464 | (expand-file-name | |
465 | (mm-encode-coding-string | |
466 | (nnheader-replace-chars-in-string nameuid ?. ?/) | |
467 | nnmail-pathname-coding-system) | |
468 | dir)))) | |
c113de23 GM |
469 | (if old-uidvalidity |
470 | (if (not (equal old-uidvalidity new-uidvalidity)) | |
a2617484 DL |
471 | ;; uidvalidity clash |
472 | (gnus-delete-file file) | |
c113de23 GM |
473 | (gnus-group-set-parameter gnusgroup 'uidvalidity new-uidvalidity) |
474 | t) | |
475 | (gnus-group-add-parameter gnusgroup (cons 'uidvalidity new-uidvalidity)) | |
476 | t))) | |
477 | ||
478 | (defun nnimap-before-find-minmax-bugworkaround () | |
479 | "Function called before iterating through mailboxes with | |
480 | `nnimap-find-minmax-uid'." | |
23f87bed MB |
481 | (when nnimap-need-unselect-to-notice-new-mail |
482 | ;; XXX this is for UoW imapd problem, it doesn't notice new mail in | |
483 | ;; currently selected mailbox without a re-select/examine. | |
484 | (or (null (imap-current-mailbox nnimap-server-buffer)) | |
485 | (imap-mailbox-unselect nnimap-server-buffer)))) | |
c113de23 GM |
486 | |
487 | (defun nnimap-find-minmax-uid (group &optional examine) | |
8f688cb0 | 488 | "Find lowest and highest active article number in GROUP. |
c113de23 GM |
489 | If EXAMINE is non-nil the group is selected read-only." |
490 | (with-current-buffer nnimap-server-buffer | |
23f87bed MB |
491 | (when (or (string= group (imap-current-mailbox)) |
492 | (imap-mailbox-select group examine)) | |
c113de23 GM |
493 | (let (minuid maxuid) |
494 | (when (> (imap-mailbox-get 'exists) 0) | |
495 | (imap-fetch "1,*" "UID" nil 'nouidfetch) | |
496 | (imap-message-map (lambda (uid Uid) | |
497 | (setq minuid (if minuid (min minuid uid) uid) | |
498 | maxuid (if maxuid (max maxuid uid) uid))) | |
499 | 'UID)) | |
500 | (list (imap-mailbox-get 'exists) minuid maxuid))))) | |
a1506d29 | 501 | |
c113de23 GM |
502 | (defun nnimap-possibly-change-group (group &optional server) |
503 | "Make GROUP the current group, and SERVER the current server." | |
504 | (when (nnimap-possibly-change-server server) | |
505 | (with-current-buffer nnimap-server-buffer | |
506 | (if (or (null group) (imap-current-mailbox-p group)) | |
507 | imap-current-mailbox | |
508 | (if (imap-mailbox-select group) | |
509 | (if (or (nnimap-verify-uidvalidity | |
510 | group (or server nnimap-current-server)) | |
511 | (zerop (imap-mailbox-get 'exists group)) | |
23f87bed MB |
512 | t ;; for OGnus to see if ignoring uidvalidity |
513 | ;; changes has any bad effects. | |
c113de23 GM |
514 | (yes-or-no-p |
515 | (format | |
516 | "nnimap: Group %s is not uidvalid. Continue? " group))) | |
517 | imap-current-mailbox | |
518 | (imap-mailbox-unselect) | |
715a2ca2 | 519 | (error "nnimap: Group %s is not uid-valid" group)) |
c113de23 GM |
520 | (nnheader-report 'nnimap (imap-error-text))))))) |
521 | ||
522 | (defun nnimap-replace-whitespace (string) | |
523 | "Return STRING with all whitespace replaced with space." | |
524 | (when string | |
525 | (while (string-match "[\r\n\t]+" string) | |
526 | (setq string (replace-match " " t t string))) | |
527 | string)) | |
528 | ||
529 | ;; Required backend functions | |
530 | ||
531 | (defun nnimap-retrieve-headers-progress () | |
532 | "Hook to insert NOV line for current article into `nntp-server-buffer'." | |
533 | (and (numberp nnmail-large-newsgroup) | |
534 | (zerop (% (incf nnimap-counter) nnimap-progress-how-often)) | |
535 | (> nnimap-length nnmail-large-newsgroup) | |
536 | (nnheader-message 6 "nnimap: Retrieving headers... %c" | |
537 | (nth (/ (% nnimap-counter | |
538 | (* (length nnimap-progress-chars) | |
539 | nnimap-progress-how-often)) | |
540 | nnimap-progress-how-often) | |
541 | nnimap-progress-chars))) | |
542 | (with-current-buffer nntp-server-buffer | |
543 | (let (headers lines chars uid mbx) | |
544 | (with-current-buffer nnimap-server-buffer | |
545 | (setq uid imap-current-message | |
546 | mbx imap-current-mailbox | |
547 | headers (nnimap-demule | |
548 | (if (imap-capability 'IMAP4rev1) | |
549 | ;; xxx don't just use car? alist doesn't contain | |
550 | ;; anything else now, but it might... | |
551 | (nth 2 (car (imap-message-get uid 'BODYDETAIL))) | |
552 | (imap-message-get uid 'RFC822.HEADER))) | |
553 | lines (imap-body-lines (imap-message-body imap-current-message)) | |
554 | chars (imap-message-get imap-current-message 'RFC822.SIZE))) | |
555 | (nnheader-insert-nov | |
556 | (with-temp-buffer | |
557 | (buffer-disable-undo) | |
558 | (insert headers) | |
23f87bed | 559 | (let ((head (nnheader-parse-naked-head))) |
c113de23 GM |
560 | (mail-header-set-number head uid) |
561 | (mail-header-set-chars head chars) | |
562 | (mail-header-set-lines head lines) | |
563 | (mail-header-set-xref | |
564 | head (format "%s %s:%d" (system-name) mbx uid)) | |
565 | head)))))) | |
566 | ||
567 | (defun nnimap-retrieve-which-headers (articles fetch-old) | |
568 | "Get a range of articles to fetch based on ARTICLES and FETCH-OLD." | |
569 | (with-current-buffer nnimap-server-buffer | |
570 | (if (numberp (car-safe articles)) | |
571 | (imap-search | |
572 | (concat "UID " | |
573 | (imap-range-to-message-set | |
574 | (gnus-compress-sequence | |
575 | (append (gnus-uncompress-sequence | |
576 | (and fetch-old | |
577 | (cons (if (numberp fetch-old) | |
578 | (max 1 (- (car articles) fetch-old)) | |
579 | 1) | |
580 | (1- (car articles))))) | |
581 | articles))))) | |
582 | (mapcar (lambda (msgid) | |
583 | (imap-search | |
23f87bed | 584 | (format "HEADER Message-Id \"%s\"" msgid))) |
c113de23 GM |
585 | articles)))) |
586 | ||
587 | (defun nnimap-group-overview-filename (group server) | |
35ef97a5 | 588 | "Make file name for GROUP on SERVER." |
a2617484 | 589 | (let* ((dir (file-name-as-directory (expand-file-name nnimap-directory))) |
23f87bed MB |
590 | (uidvalidity (gnus-group-get-parameter |
591 | (gnus-group-prefixed-name | |
592 | group (gnus-server-to-method | |
593 | (format "nnimap:%s" server))) | |
594 | 'uidvalidity)) | |
595 | (name (nnheader-translate-file-chars | |
596 | (concat nnimap-nov-file-name | |
597 | (if (equal server "") | |
598 | "unnamed" | |
599 | server) "." group nnimap-nov-file-name-suffix) t)) | |
600 | (nameuid (nnheader-translate-file-chars | |
601 | (concat nnimap-nov-file-name | |
602 | (if (equal server "") | |
603 | "unnamed" | |
604 | server) "." group "." uidvalidity | |
605 | nnimap-nov-file-name-suffix) t)) | |
606 | (oldfile (if (or nnmail-use-long-file-names | |
607 | (file-exists-p (expand-file-name name dir))) | |
608 | (expand-file-name name dir) | |
609 | (expand-file-name | |
610 | (mm-encode-coding-string | |
611 | (nnheader-replace-chars-in-string name ?. ?/) | |
612 | nnmail-pathname-coding-system) | |
613 | dir))) | |
614 | (newfile (if (or nnmail-use-long-file-names | |
615 | (file-exists-p (expand-file-name nameuid dir))) | |
616 | (expand-file-name nameuid dir) | |
617 | (expand-file-name | |
618 | (mm-encode-coding-string | |
619 | (nnheader-replace-chars-in-string nameuid ?. ?/) | |
620 | nnmail-pathname-coding-system) | |
621 | dir)))) | |
a2617484 DL |
622 | (when (and (file-exists-p oldfile) (not (file-exists-p newfile))) |
623 | (message "nnimap: Upgrading novcache filename...") | |
624 | (sit-for 1) | |
625 | (gnus-make-directory (file-name-directory newfile)) | |
626 | (unless (ignore-errors (rename-file oldfile newfile) t) | |
627 | (if (ignore-errors (copy-file oldfile newfile) t) | |
628 | (delete-file oldfile) | |
629 | (error "Can't rename `%s' to `%s'" oldfile newfile)))) | |
630 | newfile)) | |
c113de23 GM |
631 | |
632 | (defun nnimap-retrieve-headers-from-file (group server) | |
633 | (with-current-buffer nntp-server-buffer | |
634 | (let ((nov (nnimap-group-overview-filename group server))) | |
635 | (when (file-exists-p nov) | |
636 | (mm-insert-file-contents nov) | |
637 | (set-buffer-modified-p nil) | |
638 | (let ((min (ignore-errors (goto-char (point-min)) | |
639 | (read (current-buffer)))) | |
640 | (max (ignore-errors (goto-char (point-max)) | |
641 | (forward-line -1) | |
642 | (read (current-buffer))))) | |
643 | (if (and (numberp min) (numberp max)) | |
644 | (cons min max) | |
645 | ;; junk, remove it, it's saved later | |
646 | (erase-buffer) | |
647 | nil)))))) | |
648 | ||
649 | (defun nnimap-retrieve-headers-from-server (articles group server) | |
650 | (with-current-buffer nnimap-server-buffer | |
651 | (let ((imap-fetch-data-hook '(nnimap-retrieve-headers-progress)) | |
652 | (nnimap-length (gnus-range-length articles)) | |
653 | (nnimap-counter 0)) | |
654 | (imap-fetch (imap-range-to-message-set articles) | |
655 | (concat "(UID RFC822.SIZE BODY " | |
656 | (let ((headers | |
657 | (append '(Subject From Date Message-Id | |
658 | References In-Reply-To Xref) | |
659 | (copy-sequence | |
660 | nnmail-extra-headers)))) | |
661 | (if (imap-capability 'IMAP4rev1) | |
662 | (format "BODY.PEEK[HEADER.FIELDS %s])" headers) | |
663 | (format "RFC822.HEADER.LINES %s)" headers))))) | |
664 | (and (numberp nnmail-large-newsgroup) | |
665 | (> nnimap-length nnmail-large-newsgroup) | |
666 | (nnheader-message 6 "nnimap: Retrieving headers...done"))))) | |
667 | ||
23f87bed | 668 | (defun nnimap-dont-use-nov-p (group server) |
c113de23 GM |
669 | (or gnus-nov-is-evil nnimap-nov-is-evil |
670 | (unless (and (gnus-make-directory | |
671 | (file-name-directory | |
672 | (nnimap-group-overview-filename group server))) | |
673 | (file-writable-p | |
674 | (nnimap-group-overview-filename group server))) | |
675 | (message "nnimap: Nov cache not writable, %s" | |
676 | (nnimap-group-overview-filename group server))))) | |
677 | ||
678 | (deffoo nnimap-retrieve-headers (articles &optional group server fetch-old) | |
679 | (when (nnimap-possibly-change-group group server) | |
680 | (with-current-buffer nntp-server-buffer | |
681 | (erase-buffer) | |
23f87bed | 682 | (if (nnimap-dont-use-nov-p group server) |
c113de23 GM |
683 | (nnimap-retrieve-headers-from-server |
684 | (gnus-compress-sequence articles) group server) | |
685 | (let (uids cached low high) | |
686 | (when (setq uids (nnimap-retrieve-which-headers articles fetch-old) | |
687 | low (car uids) | |
688 | high (car (last uids))) | |
689 | (if (setq cached (nnimap-retrieve-headers-from-file group server)) | |
690 | (progn | |
691 | ;; fetch articles with uids before cache block | |
692 | (when (< low (car cached)) | |
693 | (goto-char (point-min)) | |
694 | (nnimap-retrieve-headers-from-server | |
695 | (cons low (1- (car cached))) group server)) | |
696 | ;; fetch articles with uids after cache block | |
697 | (when (> high (cdr cached)) | |
698 | (goto-char (point-max)) | |
699 | (nnimap-retrieve-headers-from-server | |
700 | (cons (1+ (cdr cached)) high) group server)) | |
701 | (when nnimap-prune-cache | |
702 | ;; remove nov's for articles which has expired on server | |
703 | (goto-char (point-min)) | |
704 | (dolist (uid (gnus-set-difference articles uids)) | |
23f87bed MB |
705 | (when (re-search-forward (format "^%d\t" uid) nil t) |
706 | (gnus-delete-line))))) | |
c113de23 GM |
707 | ;; nothing cached, fetch whole range from server |
708 | (nnimap-retrieve-headers-from-server | |
709 | (cons low high) group server)) | |
710 | (when (buffer-modified-p) | |
711 | (nnmail-write-region | |
bcb0fd5c SM |
712 | (point-min) (point-max) |
713 | (nnimap-group-overview-filename group server) nil 'nomesg)) | |
c113de23 GM |
714 | (nnheader-nov-delete-outside-range low high)))) |
715 | 'nov))) | |
716 | ||
717 | (defun nnimap-open-connection (server) | |
718 | (if (not (imap-open nnimap-address nnimap-server-port nnimap-stream | |
719 | nnimap-authenticator nnimap-server-buffer)) | |
720 | (nnheader-report 'nnimap "Can't open connection to server %s" server) | |
721 | (unless (or (imap-capability 'IMAP4 nnimap-server-buffer) | |
722 | (imap-capability 'IMAP4rev1 nnimap-server-buffer)) | |
723 | (imap-close nnimap-server-buffer) | |
724 | (nnheader-report 'nnimap "Server %s is not IMAP4 compliant" server)) | |
725 | (let* ((list (gnus-parse-netrc nnimap-authinfo-file)) | |
726 | (port (if nnimap-server-port | |
727 | (int-to-string nnimap-server-port) | |
728 | "imap")) | |
23f87bed | 729 | (alist (or (gnus-netrc-machine list server port "imap") |
7cb0aa56 | 730 | (gnus-netrc-machine list server port "imaps") |
23f87bed MB |
731 | (gnus-netrc-machine list |
732 | (or nnimap-server-address | |
733 | nnimap-address) | |
6e7fb80c | 734 | port "imap") |
7cb0aa56 MB |
735 | (gnus-netrc-machine list |
736 | (or nnimap-server-address | |
737 | nnimap-address) | |
738 | port "imaps"))) | |
c113de23 GM |
739 | (user (gnus-netrc-get alist "login")) |
740 | (passwd (gnus-netrc-get alist "password"))) | |
741 | (if (imap-authenticate user passwd nnimap-server-buffer) | |
742 | (prog1 | |
743 | (push (list server nnimap-server-buffer) | |
744 | nnimap-server-buffer-alist) | |
745 | (nnimap-possibly-change-server server)) | |
746 | (imap-close nnimap-server-buffer) | |
747 | (kill-buffer nnimap-server-buffer) | |
748 | (nnheader-report 'nnimap "Could not authenticate to %s" server))))) | |
749 | ||
750 | (deffoo nnimap-open-server (server &optional defs) | |
751 | (nnheader-init-server-buffer) | |
752 | (if (nnimap-server-opened server) | |
753 | t | |
754 | (unless (assq 'nnimap-server-buffer defs) | |
755 | (push (list 'nnimap-server-buffer (concat " *nnimap* " server)) defs)) | |
756 | ;; translate `nnimap-server-address' to `nnimap-address' in defs | |
757 | ;; for people that configured nnimap with a very old version | |
758 | (unless (assq 'nnimap-address defs) | |
759 | (if (assq 'nnimap-server-address defs) | |
760 | (push (list 'nnimap-address | |
761 | (cadr (assq 'nnimap-server-address defs))) defs) | |
762 | (push (list 'nnimap-address server) defs))) | |
763 | (nnoo-change-server 'nnimap server defs) | |
23f87bed MB |
764 | (or nnimap-server-buffer |
765 | (setq nnimap-server-buffer (cadr (assq 'nnimap-server-buffer defs)))) | |
c113de23 GM |
766 | (with-current-buffer (get-buffer-create nnimap-server-buffer) |
767 | (nnoo-change-server 'nnimap server defs)) | |
768 | (or (and nnimap-server-buffer | |
23f87bed MB |
769 | (imap-opened nnimap-server-buffer) |
770 | (if (with-current-buffer nnimap-server-buffer | |
771 | (memq imap-state '(auth select examine))) | |
772 | t | |
773 | (imap-close nnimap-server-buffer) | |
774 | (nnimap-open-connection server))) | |
c113de23 GM |
775 | (nnimap-open-connection server)))) |
776 | ||
777 | (deffoo nnimap-server-opened (&optional server) | |
778 | "Whether SERVER is opened. | |
779 | If SERVER is the current virtual server, and the connection to the | |
780 | physical server is alive, this function return a non-nil value. If | |
781 | SERVER is nil, it is treated as the current server." | |
782 | ;; clean up autologouts?? | |
783 | (and (or server nnimap-current-server) | |
784 | (nnoo-server-opened 'nnimap (or server nnimap-current-server)) | |
785 | (imap-opened (nnimap-get-server-buffer server)))) | |
786 | ||
787 | (deffoo nnimap-close-server (&optional server) | |
788 | "Close connection to server and free all resources connected to it. | |
789 | Return nil if the server couldn't be closed for some reason." | |
790 | (let ((server (or server nnimap-current-server))) | |
791 | (when (or (nnimap-server-opened server) | |
792 | (imap-opened (nnimap-get-server-buffer server))) | |
793 | (imap-close (nnimap-get-server-buffer server)) | |
794 | (kill-buffer (nnimap-get-server-buffer server)) | |
795 | (setq nnimap-server-buffer nil | |
796 | nnimap-current-server nil | |
797 | nnimap-server-buffer-alist | |
798 | (delq server nnimap-server-buffer-alist))) | |
799 | (nnoo-close-server 'nnimap server))) | |
800 | ||
801 | (deffoo nnimap-request-close () | |
802 | "Close connection to all servers and free all resources that the backend have reserved. | |
803 | All buffers that have been created by that | |
804 | backend should be killed. (Not the nntp-server-buffer, though.) This | |
805 | function is generally only called when Gnus is shutting down." | |
806 | (mapcar (lambda (server) (nnimap-close-server (car server))) | |
807 | nnimap-server-buffer-alist) | |
808 | (setq nnimap-server-buffer-alist nil)) | |
809 | ||
810 | (deffoo nnimap-status-message (&optional server) | |
811 | "This function returns the last error message from server." | |
812 | (when (nnimap-possibly-change-server server) | |
813 | (nnoo-status-message 'nnimap server))) | |
814 | ||
815 | (defun nnimap-demule (string) | |
31a54b0e SM |
816 | ;; BEWARE: we used to use string-as-multibyte here which is braindead |
817 | ;; because it will turn accidental emacs-mule-valid byte sequences | |
818 | ;; into multibyte chars. --Stef | |
1232b9cb MB |
819 | ;; Reverted, braindead got 7.5 out of 10 on imdb, so it can't be |
820 | ;; that bad. --Simon | |
821 | (funcall (if (and (fboundp 'string-as-multibyte) | |
822 | (subrp (symbol-function 'string-as-multibyte))) | |
823 | 'string-as-multibyte | |
c113de23 GM |
824 | 'identity) |
825 | (or string ""))) | |
826 | ||
23f87bed MB |
827 | (defun nnimap-make-callback (article gnus-callback buffer) |
828 | "Return a callback function." | |
829 | `(lambda () | |
830 | (nnimap-callback ,article ,gnus-callback ,buffer))) | |
831 | ||
832 | (defun nnimap-callback (article gnus-callback buffer) | |
833 | (when (eq article (imap-current-message)) | |
834 | (remove-hook 'imap-fetch-data-hook | |
835 | (nnimap-make-callback article gnus-callback buffer)) | |
836 | (with-current-buffer buffer | |
837 | (insert | |
838 | (with-current-buffer nnimap-server-buffer | |
839 | (nnimap-demule | |
840 | (if (imap-capability 'IMAP4rev1) | |
841 | ;; xxx don't just use car? alist doesn't contain | |
842 | ;; anything else now, but it might... | |
843 | (nth 2 (car (imap-message-get article 'BODYDETAIL))) | |
844 | (imap-message-get article 'RFC822))))) | |
845 | (nnheader-ms-strip-cr) | |
846 | (funcall gnus-callback t)))) | |
c113de23 GM |
847 | |
848 | (defun nnimap-request-article-part (article part prop &optional | |
23f87bed | 849 | group server to-buffer detail) |
c113de23 GM |
850 | (when (nnimap-possibly-change-group group server) |
851 | (let ((article (if (stringp article) | |
852 | (car-safe (imap-search | |
23f87bed | 853 | (format "HEADER Message-Id \"%s\"" article) |
c113de23 GM |
854 | nnimap-server-buffer)) |
855 | article))) | |
856 | (when article | |
23f87bed MB |
857 | (gnus-message 10 "nnimap: Fetching (part of) article %d from %s..." |
858 | article (or group imap-current-mailbox | |
859 | gnus-newsgroup-name)) | |
c113de23 GM |
860 | (if (not nnheader-callback-function) |
861 | (with-current-buffer (or to-buffer nntp-server-buffer) | |
862 | (erase-buffer) | |
23f87bed MB |
863 | (let ((data (imap-fetch article part prop nil |
864 | nnimap-server-buffer))) | |
865 | (insert (nnimap-demule (if detail | |
866 | (nth 2 (car data)) | |
867 | data)))) | |
868 | (nnheader-ms-strip-cr) | |
869 | (gnus-message | |
870 | 10 "nnimap: Fetching (part of) article %d from %s...done" | |
871 | article (or group imap-current-mailbox gnus-newsgroup-name)) | |
c113de23 | 872 | (if (bobp) |
23f87bed MB |
873 | (nnheader-report 'nnimap "No such article %d in %s: %s" |
874 | article (or group imap-current-mailbox | |
875 | gnus-newsgroup-name) | |
c113de23 GM |
876 | (imap-error-text nnimap-server-buffer)) |
877 | (cons group article))) | |
23f87bed MB |
878 | (add-hook 'imap-fetch-data-hook |
879 | (nnimap-make-callback article | |
880 | nnheader-callback-function | |
881 | nntp-server-buffer)) | |
c113de23 GM |
882 | (imap-fetch-asynch article part nil nnimap-server-buffer) |
883 | (cons group article)))))) | |
884 | ||
885 | (deffoo nnimap-asynchronous-p () | |
886 | t) | |
887 | ||
888 | (deffoo nnimap-request-article (article &optional group server to-buffer) | |
889 | (if (imap-capability 'IMAP4rev1 nnimap-server-buffer) | |
890 | (nnimap-request-article-part | |
891 | article "BODY.PEEK[]" 'BODYDETAIL group server to-buffer 'detail) | |
892 | (nnimap-request-article-part | |
893 | article "RFC822.PEEK" 'RFC822 group server to-buffer))) | |
894 | ||
895 | (deffoo nnimap-request-head (article &optional group server to-buffer) | |
896 | (if (imap-capability 'IMAP4rev1 nnimap-server-buffer) | |
897 | (nnimap-request-article-part | |
898 | article "BODY.PEEK[HEADER]" 'BODYDETAIL group server to-buffer 'detail) | |
899 | (nnimap-request-article-part | |
900 | article "RFC822.HEADER" 'RFC822.HEADER group server to-buffer))) | |
901 | ||
902 | (deffoo nnimap-request-body (article &optional group server to-buffer) | |
903 | (if (imap-capability 'IMAP4rev1 nnimap-server-buffer) | |
904 | (nnimap-request-article-part | |
905 | article "BODY.PEEK[TEXT]" 'BODYDETAIL group server to-buffer 'detail) | |
906 | (nnimap-request-article-part | |
907 | article "RFC822.TEXT.PEEK" 'RFC822.TEXT group server to-buffer))) | |
908 | ||
909 | (deffoo nnimap-request-group (group &optional server fast) | |
910 | (nnimap-request-update-info-internal | |
911 | group | |
912 | (gnus-get-info (gnus-group-prefixed-name | |
913 | group (gnus-server-to-method (format "nnimap:%s" server)))) | |
914 | server) | |
915 | (when (nnimap-possibly-change-group group server) | |
916 | (nnimap-before-find-minmax-bugworkaround) | |
917 | (let (info) | |
918 | (cond (fast group) | |
919 | ((null (setq info (nnimap-find-minmax-uid group t))) | |
920 | (nnheader-report 'nnimap "Could not get active info for %s" | |
921 | group)) | |
922 | (t | |
923 | (nnheader-insert "211 %d %d %d %s\n" (or (nth 0 info) 0) | |
924 | (max 1 (or (nth 1 info) 1)) | |
925 | (or (nth 2 info) 0) group) | |
926 | (nnheader-report 'nnimap "Group %s selected" group) | |
927 | t))))) | |
928 | ||
23f87bed MB |
929 | (defun nnimap-update-unseen (group &optional server) |
930 | "Update the unseen count in `nnimap-mailbox-info'." | |
931 | (gnus-sethash | |
932 | (gnus-group-prefixed-name group server) | |
933 | (let ((old (gnus-gethash-safe (gnus-group-prefixed-name group server) | |
934 | nnimap-mailbox-info))) | |
935 | (list (nth 0 old) (nth 1 old) | |
936 | (imap-mailbox-status group 'unseen nnimap-server-buffer) | |
937 | (nth 3 old))) | |
938 | nnimap-mailbox-info)) | |
939 | ||
c113de23 GM |
940 | (defun nnimap-close-group (group &optional server) |
941 | (with-current-buffer nnimap-server-buffer | |
942 | (when (and (imap-opened) | |
943 | (nnimap-possibly-change-group group server)) | |
23f87bed | 944 | (nnimap-update-unseen group server) |
c113de23 | 945 | (case nnimap-expunge-on-close |
23f87bed MB |
946 | (always (progn |
947 | (imap-mailbox-expunge nnimap-close-asynchronous) | |
948 | (unless nnimap-dont-close | |
949 | (imap-mailbox-close nnimap-close-asynchronous)))) | |
950 | (ask (if (and (imap-search "DELETED") | |
951 | (gnus-y-or-n-p (format "Expunge articles in group `%s'? " | |
952 | imap-current-mailbox))) | |
953 | (progn | |
954 | (imap-mailbox-expunge nnimap-close-asynchronous) | |
955 | (unless nnimap-dont-close | |
956 | (imap-mailbox-close nnimap-close-asynchronous))) | |
957 | (imap-mailbox-unselect))) | |
c113de23 GM |
958 | (t (imap-mailbox-unselect))) |
959 | (not imap-current-mailbox)))) | |
960 | ||
961 | (defun nnimap-pattern-to-list-arguments (pattern) | |
962 | (mapcar (lambda (p) | |
963 | (cons (car-safe p) (or (cdr-safe p) p))) | |
964 | (if (and (listp pattern) | |
965 | (listp (cdr pattern))) | |
966 | pattern | |
967 | (list pattern)))) | |
968 | ||
969 | (deffoo nnimap-request-list (&optional server) | |
970 | (when (nnimap-possibly-change-server server) | |
971 | (with-current-buffer nntp-server-buffer | |
972 | (erase-buffer)) | |
973 | (gnus-message 5 "nnimap: Generating active list%s..." | |
974 | (if (> (length server) 0) (concat " for " server) "")) | |
975 | (nnimap-before-find-minmax-bugworkaround) | |
976 | (with-current-buffer nnimap-server-buffer | |
977 | (dolist (pattern (nnimap-pattern-to-list-arguments nnimap-list-pattern)) | |
978 | (dolist (mbx (funcall nnimap-request-list-method | |
979 | (cdr pattern) (car pattern))) | |
980 | (or (member "\\NoSelect" (imap-mailbox-get 'list-flags mbx)) | |
981 | (let ((info (nnimap-find-minmax-uid mbx 'examine))) | |
982 | (when info | |
983 | (with-current-buffer nntp-server-buffer | |
23f87bed MB |
984 | (insert (format "\"%s\" %d %d y\n" |
985 | mbx (or (nth 2 info) 0) | |
986 | (max 1 (or (nth 1 info) 1))))))))))) | |
c113de23 GM |
987 | (gnus-message 5 "nnimap: Generating active list%s...done" |
988 | (if (> (length server) 0) (concat " for " server) "")) | |
989 | t)) | |
990 | ||
991 | (deffoo nnimap-request-post (&optional server) | |
992 | (let ((success t)) | |
993 | (dolist (mbx (message-unquote-tokens | |
23f87bed MB |
994 | (message-tokenize-header |
995 | (message-fetch-field "Newsgroups") ", ")) success) | |
c113de23 GM |
996 | (let ((to-newsgroup (gnus-group-prefixed-name mbx gnus-command-method))) |
997 | (or (gnus-active to-newsgroup) | |
998 | (gnus-activate-group to-newsgroup) | |
999 | (if (gnus-y-or-n-p (format "No such group: %s. Create it? " | |
1000 | to-newsgroup)) | |
1001 | (or (and (gnus-request-create-group | |
1002 | to-newsgroup gnus-command-method) | |
1003 | (gnus-activate-group to-newsgroup nil nil | |
1004 | gnus-command-method)) | |
1005 | (error "Couldn't create group %s" to-newsgroup))) | |
1006 | (error "No such group: %s" to-newsgroup)) | |
1007 | (unless (nnimap-request-accept-article mbx (nth 1 gnus-command-method)) | |
1008 | (setq success nil)))))) | |
1009 | ||
1010 | ;; Optional backend functions | |
1011 | ||
23f87bed MB |
1012 | (defun nnimap-string-lessp-numerical (s1 s2) |
1013 | "Return t if first arg string is less than second in numerical order." | |
1014 | (cond ((string= s1 s2) | |
1015 | nil) | |
1016 | ((> (length s1) (length s2)) | |
1017 | nil) | |
1018 | ((< (length s1) (length s2)) | |
1019 | t) | |
1020 | ((< (string-to-number (substring s1 0 1)) | |
1021 | (string-to-number (substring s2 0 1))) | |
1022 | t) | |
1023 | ((> (string-to-number (substring s1 0 1)) | |
1024 | (string-to-number (substring s2 0 1))) | |
1025 | nil) | |
1026 | (t | |
1027 | (nnimap-string-lessp-numerical (substring s1 1) (substring s2 1))))) | |
1028 | ||
c113de23 GM |
1029 | (deffoo nnimap-retrieve-groups (groups &optional server) |
1030 | (when (nnimap-possibly-change-server server) | |
1031 | (gnus-message 5 "nnimap: Checking mailboxes...") | |
1032 | (with-current-buffer nntp-server-buffer | |
1033 | (erase-buffer) | |
1034 | (nnimap-before-find-minmax-bugworkaround) | |
23f87bed MB |
1035 | (let (asyncgroups slowgroups) |
1036 | (if (null nnimap-retrieve-groups-asynchronous) | |
1037 | (setq slowgroups groups) | |
1038 | (dolist (group groups) | |
1039 | (gnus-message 9 "nnimap: Quickly checking mailbox %s" group) | |
1040 | (add-to-list (if (gnus-gethash-safe | |
1041 | (gnus-group-prefixed-name group server) | |
1042 | nnimap-mailbox-info) | |
1043 | 'asyncgroups | |
1044 | 'slowgroups) | |
1045 | (list group (imap-mailbox-status-asynch | |
1046 | group '(uidvalidity uidnext unseen) | |
1047 | nnimap-server-buffer)))) | |
1048 | (dolist (asyncgroup asyncgroups) | |
1049 | (let ((group (nth 0 asyncgroup)) | |
1050 | (tag (nth 1 asyncgroup)) | |
1051 | new old) | |
1052 | (when (imap-ok-p (imap-wait-for-tag tag nnimap-server-buffer)) | |
1053 | (if (or (not (string= | |
1054 | (nth 0 (gnus-gethash (gnus-group-prefixed-name | |
1055 | group server) | |
1056 | nnimap-mailbox-info)) | |
1057 | (imap-mailbox-get 'uidvalidity group | |
1058 | nnimap-server-buffer))) | |
1059 | (not (string= | |
1060 | (nth 1 (gnus-gethash (gnus-group-prefixed-name | |
1061 | group server) | |
1062 | nnimap-mailbox-info)) | |
1063 | (imap-mailbox-get 'uidnext group | |
1064 | nnimap-server-buffer)))) | |
1065 | (push (list group) slowgroups) | |
1066 | (insert (nth 3 (gnus-gethash (gnus-group-prefixed-name | |
1067 | group server) | |
1068 | nnimap-mailbox-info)))))))) | |
1069 | (dolist (group slowgroups) | |
1070 | (if nnimap-retrieve-groups-asynchronous | |
1071 | (setq group (car group))) | |
1072 | (gnus-message 7 "nnimap: Mailbox %s modified" group) | |
1073 | (imap-mailbox-put 'uidnext nil group nnimap-server-buffer) | |
1074 | (or (member "\\NoSelect" (imap-mailbox-get 'list-flags group | |
1075 | nnimap-server-buffer)) | |
1076 | (let* ((info (nnimap-find-minmax-uid group 'examine)) | |
1077 | (str (format "\"%s\" %d %d y\n" group | |
1078 | (or (nth 2 info) 0) | |
1079 | (max 1 (or (nth 1 info) 1))))) | |
1080 | (when (> (or (imap-mailbox-get 'recent group | |
1081 | nnimap-server-buffer) 0) | |
1082 | 0) | |
1083 | (push (list (cons group 0)) nnmail-split-history)) | |
1084 | (insert str) | |
1085 | (when nnimap-retrieve-groups-asynchronous | |
1086 | (gnus-sethash | |
1087 | (gnus-group-prefixed-name group server) | |
1088 | (list (or (imap-mailbox-get | |
1089 | 'uidvalidity group nnimap-server-buffer) | |
1090 | (imap-mailbox-status | |
1091 | group 'uidvalidity nnimap-server-buffer)) | |
1092 | (or (imap-mailbox-get | |
1093 | 'uidnext group nnimap-server-buffer) | |
1094 | (imap-mailbox-status | |
1095 | group 'uidnext nnimap-server-buffer)) | |
1096 | (or (imap-mailbox-get | |
1097 | 'unseen group nnimap-server-buffer) | |
1098 | (imap-mailbox-status | |
1099 | group 'unseen nnimap-server-buffer)) | |
1100 | str) | |
1101 | nnimap-mailbox-info))))))) | |
c113de23 GM |
1102 | (gnus-message 5 "nnimap: Checking mailboxes...done") |
1103 | 'active)) | |
1104 | ||
1105 | (deffoo nnimap-request-update-info-internal (group info &optional server) | |
1106 | (when (nnimap-possibly-change-group group server) | |
23f87bed | 1107 | (when info ;; xxx what does this mean? should we create a info? |
c113de23 GM |
1108 | (with-current-buffer nnimap-server-buffer |
1109 | (gnus-message 5 "nnimap: Updating info for %s..." | |
1110 | (gnus-info-group info)) | |
a1506d29 | 1111 | |
c113de23 GM |
1112 | (when (nnimap-mark-permanent-p 'read) |
1113 | (let (seen unseen) | |
1114 | ;; read info could contain articles marked unread by other | |
1115 | ;; imap clients! we correct this | |
1116 | (setq seen (gnus-uncompress-range (gnus-info-read info)) | |
1117 | unseen (imap-search "UNSEEN UNDELETED") | |
1118 | seen (gnus-set-difference seen unseen) | |
1119 | ;; seen might lack articles marked as read by other | |
1120 | ;; imap clients! we correct this | |
1121 | seen (append seen (imap-search "SEEN")) | |
1122 | ;; remove dupes | |
1123 | seen (sort seen '<) | |
1124 | seen (gnus-compress-sequence seen t) | |
1125 | ;; we can't return '(1) since this isn't a "list of ranges", | |
1126 | ;; and we can't return '((1)) since g-list-of-unread-articles | |
1127 | ;; is buggy so we return '((1 . 1)). | |
1128 | seen (if (and (integerp (car seen)) | |
1129 | (null (cdr seen))) | |
1130 | (list (cons (car seen) (car seen))) | |
1131 | seen)) | |
1132 | (gnus-info-set-read info seen))) | |
1133 | ||
1134 | (mapcar (lambda (pred) | |
23f87bed MB |
1135 | (when (or (eq (cdr pred) 'recent) |
1136 | (and (nnimap-mark-permanent-p (cdr pred)) | |
1137 | (member (nnimap-mark-to-flag (cdr pred)) | |
1138 | (imap-mailbox-get 'flags)))) | |
c113de23 GM |
1139 | (gnus-info-set-marks |
1140 | info | |
23f87bed | 1141 | (gnus-update-alist-soft |
c113de23 GM |
1142 | (cdr pred) |
1143 | (gnus-compress-sequence | |
1144 | (imap-search (nnimap-mark-to-predicate (cdr pred)))) | |
1145 | (gnus-info-marks info)) | |
1146 | t))) | |
1147 | gnus-article-mark-lists) | |
1148 | ||
23f87bed MB |
1149 | (when nnimap-importantize-dormant |
1150 | ;; nnimap mark dormant article as ticked too (for other clients) | |
1151 | ;; so we remove that mark for gnus since we support dormant | |
1152 | (gnus-info-set-marks | |
1153 | info | |
1154 | (gnus-update-alist-soft | |
1155 | 'tick | |
1156 | (gnus-remove-from-range | |
1157 | (cdr-safe (assoc 'tick (gnus-info-marks info))) | |
1158 | (cdr-safe (assoc 'dormant (gnus-info-marks info)))) | |
1159 | (gnus-info-marks info)) | |
1160 | t)) | |
a1506d29 | 1161 | |
c113de23 GM |
1162 | (gnus-message 5 "nnimap: Updating info for %s...done" |
1163 | (gnus-info-group info)) | |
1164 | ||
1165 | info)))) | |
1166 | ||
1167 | (deffoo nnimap-request-type (group &optional article) | |
1168 | (if (and nnimap-news-groups (string-match nnimap-news-groups group)) | |
1169 | 'news | |
1170 | 'mail)) | |
1171 | ||
1172 | (deffoo nnimap-request-set-mark (group actions &optional server) | |
1173 | (when (nnimap-possibly-change-group group server) | |
1174 | (with-current-buffer nnimap-server-buffer | |
1175 | (let (action) | |
1176 | (gnus-message 7 "nnimap: Setting marks in %s..." group) | |
1177 | (while (setq action (pop actions)) | |
1178 | (let ((range (nth 0 action)) | |
1179 | (what (nth 1 action)) | |
1180 | (cmdmarks (nth 2 action)) | |
1181 | marks) | |
23f87bed MB |
1182 | ;; bookmark can't be stored (not list/range |
1183 | (setq cmdmarks (delq 'bookmark cmdmarks)) | |
1184 | ;; killed can't be stored (not list/range | |
1185 | (setq cmdmarks (delq 'killed cmdmarks)) | |
1186 | ;; unsent are for nndraft groups only | |
1187 | (setq cmdmarks (delq 'unsent cmdmarks)) | |
c113de23 GM |
1188 | ;; cache flags are pointless on the server |
1189 | (setq cmdmarks (delq 'cache cmdmarks)) | |
23f87bed MB |
1190 | ;; seen flags are local to each gnus |
1191 | (setq cmdmarks (delq 'seen cmdmarks)) | |
1192 | ;; recent marks can't be set | |
1193 | (setq cmdmarks (delq 'recent cmdmarks)) | |
1194 | (when nnimap-importantize-dormant | |
1195 | ;; flag dormant articles as ticked | |
1196 | (if (memq 'dormant cmdmarks) | |
1197 | (setq cmdmarks (cons 'tick cmdmarks)))) | |
c113de23 GM |
1198 | ;; remove stuff we are forbidden to store |
1199 | (mapcar (lambda (mark) | |
1200 | (if (imap-message-flag-permanent-p | |
1201 | (nnimap-mark-to-flag mark)) | |
1202 | (setq marks (cons mark marks)))) | |
1203 | cmdmarks) | |
1204 | (when (and range marks) | |
1205 | (cond ((eq what 'del) | |
1206 | (imap-message-flags-del | |
1207 | (imap-range-to-message-set range) | |
1208 | (nnimap-mark-to-flag marks nil t))) | |
1209 | ((eq what 'add) | |
1210 | (imap-message-flags-add | |
1211 | (imap-range-to-message-set range) | |
1212 | (nnimap-mark-to-flag marks nil t))) | |
1213 | ((eq what 'set) | |
1214 | (imap-message-flags-set | |
1215 | (imap-range-to-message-set range) | |
1216 | (nnimap-mark-to-flag marks nil t))))))) | |
1217 | (gnus-message 7 "nnimap: Setting marks in %s...done" group)))) | |
1218 | nil) | |
1219 | ||
1220 | (defun nnimap-split-fancy () | |
23f87bed | 1221 | "Like the function `nnmail-split-fancy', but uses `nnimap-split-fancy'." |
c113de23 GM |
1222 | (let ((nnmail-split-fancy nnimap-split-fancy)) |
1223 | (nnmail-split-fancy))) | |
1224 | ||
1225 | (defun nnimap-split-to-groups (rules) | |
1226 | ;; tries to match all rules in nnimap-split-rule against content of | |
1227 | ;; nntp-server-buffer, returns a list of groups that matched. | |
1228 | (with-current-buffer nntp-server-buffer | |
1229 | ;; Fold continuation lines. | |
1230 | (goto-char (point-min)) | |
1231 | (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t) | |
1232 | (replace-match " " t t)) | |
1233 | (if (functionp rules) | |
1234 | (funcall rules) | |
1235 | (let (to-groups regrepp) | |
1236 | (catch 'split-done | |
1237 | (dolist (rule rules to-groups) | |
1238 | (let ((group (car rule)) | |
1239 | (regexp (cadr rule))) | |
1240 | (goto-char (point-min)) | |
1241 | (when (and (if (stringp regexp) | |
1242 | (progn | |
23f87bed MB |
1243 | (if (not (stringp group)) |
1244 | (setq group (eval group)) | |
1245 | (setq regrepp | |
1246 | (string-match "\\\\[0-9&]" group))) | |
c113de23 GM |
1247 | (re-search-forward regexp nil t)) |
1248 | (funcall regexp group)) | |
1249 | ;; Don't enter the article into the same group twice. | |
1250 | (not (assoc group to-groups))) | |
1251 | (push (if regrepp | |
1252 | (nnmail-expand-newtext group) | |
1253 | group) | |
1254 | to-groups) | |
1255 | (or nnimap-split-crosspost | |
1256 | (throw 'split-done to-groups)))))))))) | |
a1506d29 | 1257 | |
c113de23 GM |
1258 | (defun nnimap-assoc-match (key alist) |
1259 | (let (element) | |
1260 | (while (and alist (not element)) | |
1261 | (if (string-match (car (car alist)) key) | |
1262 | (setq element (car alist))) | |
1263 | (setq alist (cdr alist))) | |
1264 | element)) | |
1265 | ||
1266 | (defun nnimap-split-find-rule (server inbox) | |
1267 | (if (and (listp nnimap-split-rule) (listp (car nnimap-split-rule)) | |
23f87bed | 1268 | (list (cdar nnimap-split-rule)) (listp (cadar nnimap-split-rule))) |
c113de23 | 1269 | ;; extended format |
a1506d29 | 1270 | (cadr (nnimap-assoc-match inbox (cdr (nnimap-assoc-match |
c113de23 GM |
1271 | server nnimap-split-rule)))) |
1272 | nnimap-split-rule)) | |
1273 | ||
1274 | (defun nnimap-split-find-inbox (server) | |
1275 | (if (listp nnimap-split-inbox) | |
1276 | nnimap-split-inbox | |
1277 | (list nnimap-split-inbox))) | |
1278 | ||
1279 | (defun nnimap-split-articles (&optional group server) | |
1280 | (when (nnimap-possibly-change-server server) | |
1281 | (with-current-buffer nnimap-server-buffer | |
1282 | (let (rule inbox removeorig (inboxes (nnimap-split-find-inbox server))) | |
1283 | ;; iterate over inboxes | |
1284 | (while (and (setq inbox (pop inboxes)) | |
23f87bed | 1285 | (nnimap-possibly-change-group inbox)) ;; SELECT |
c113de23 GM |
1286 | ;; find split rule for this server / inbox |
1287 | (when (setq rule (nnimap-split-find-rule server inbox)) | |
1288 | ;; iterate over articles | |
1289 | (dolist (article (imap-search nnimap-split-predicate)) | |
23f87bed MB |
1290 | (when (if (if (eq nnimap-split-download-body 'default) |
1291 | nnimap-split-download-body-default | |
1292 | nnimap-split-download-body) | |
1293 | (and (nnimap-request-article article) | |
1294 | (with-current-buffer nntp-server-buffer (mail-narrow-to-head))) | |
1295 | (nnimap-request-head article)) | |
c113de23 GM |
1296 | ;; copy article to right group(s) |
1297 | (setq removeorig nil) | |
1298 | (dolist (to-group (nnimap-split-to-groups rule)) | |
23f87bed MB |
1299 | (cond ((eq to-group 'junk) |
1300 | (message "IMAP split removed %s:%s:%d" server inbox | |
1301 | article) | |
1302 | (setq removeorig t)) | |
1303 | ((imap-message-copy (number-to-string article) | |
1304 | to-group nil 'nocopyuid) | |
1305 | (message "IMAP split moved %s:%s:%d to %s" server | |
1306 | inbox article to-group) | |
1307 | (setq removeorig t) | |
1308 | (when nnmail-cache-accepted-message-ids | |
1309 | (with-current-buffer nntp-server-buffer | |
1310 | (let (msgid) | |
1311 | (and (setq msgid | |
1312 | (nnmail-fetch-field "message-id")) | |
1313 | (nnmail-cache-insert msgid | |
1314 | to-group | |
1315 | (nnmail-fetch-field "subject")))))) | |
1316 | ;; Add the group-art list to the history list. | |
1317 | (push (list (cons to-group 0)) nnmail-split-history)) | |
1318 | (t | |
1319 | (message "IMAP split failed to move %s:%s:%d to %s" | |
1320 | server inbox article to-group)))) | |
1321 | (if (if (eq nnimap-split-download-body 'default) | |
1322 | nnimap-split-download-body-default | |
1323 | nnimap-split-download-body) | |
1324 | (widen)) | |
c113de23 GM |
1325 | ;; remove article if it was successfully copied somewhere |
1326 | (and removeorig | |
1327 | (imap-message-flags-add (format "%d" article) | |
1328 | "\\Seen \\Deleted"))))) | |
23f87bed | 1329 | (when (imap-mailbox-select inbox) ;; just in case |
c113de23 GM |
1330 | ;; todo: UID EXPUNGE (if available) to remove splitted articles |
1331 | (imap-mailbox-expunge) | |
1332 | (imap-mailbox-close))) | |
23f87bed MB |
1333 | (when nnmail-cache-accepted-message-ids |
1334 | (nnmail-cache-close)) | |
c113de23 GM |
1335 | t)))) |
1336 | ||
1337 | (deffoo nnimap-request-scan (&optional group server) | |
1338 | (nnimap-split-articles group server)) | |
1339 | ||
1340 | (deffoo nnimap-request-newgroups (date &optional server) | |
1341 | (when (nnimap-possibly-change-server server) | |
1342 | (with-current-buffer nntp-server-buffer | |
1343 | (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s..." | |
1344 | (if (> (length server) 0) " on " "") server) | |
1345 | (erase-buffer) | |
1346 | (nnimap-before-find-minmax-bugworkaround) | |
1347 | (dolist (pattern (nnimap-pattern-to-list-arguments | |
1348 | nnimap-list-pattern)) | |
23f87bed | 1349 | (dolist (mbx (imap-mailbox-lsub (cdr pattern) (car pattern) nil |
c113de23 GM |
1350 | nnimap-server-buffer)) |
1351 | (or (catch 'found | |
1352 | (dolist (mailbox (imap-mailbox-get 'list-flags mbx | |
1353 | nnimap-server-buffer)) | |
1354 | (if (string= (downcase mailbox) "\\noselect") | |
1355 | (throw 'found t))) | |
1356 | nil) | |
1357 | (let ((info (nnimap-find-minmax-uid mbx 'examine))) | |
1358 | (when info | |
23f87bed MB |
1359 | (insert (format "\"%s\" %d %d y\n" |
1360 | mbx (or (nth 2 info) 0) | |
1361 | (max 1 (or (nth 1 info) 1))))))))) | |
c113de23 GM |
1362 | (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s...done" |
1363 | (if (> (length server) 0) " on " "") server)) | |
1364 | t)) | |
a1506d29 | 1365 | |
c113de23 GM |
1366 | (deffoo nnimap-request-create-group (group &optional server args) |
1367 | (when (nnimap-possibly-change-server server) | |
1368 | (or (imap-mailbox-status group 'uidvalidity nnimap-server-buffer) | |
23f87bed MB |
1369 | (imap-mailbox-create group nnimap-server-buffer) |
1370 | (nnheader-report 'nnimap "%S" | |
1371 | (imap-error-text nnimap-server-buffer))))) | |
c113de23 GM |
1372 | |
1373 | (defun nnimap-time-substract (time1 time2) | |
1374 | "Return TIME for TIME1 - TIME2." | |
1375 | (let* ((ms (- (car time1) (car time2))) | |
1376 | (ls (- (nth 1 time1) (nth 1 time2)))) | |
1377 | (if (< ls 0) | |
1378 | (list (- ms 1) (+ (expt 2 16) ls)) | |
1379 | (list ms ls)))) | |
1380 | ||
1381 | (defun nnimap-date-days-ago (daysago) | |
1382 | "Return date, in format \"3-Aug-1998\", for DAYSAGO days ago." | |
6389d65c GM |
1383 | (let* ((time (nnimap-time-substract (current-time) (days-to-time daysago))) |
1384 | (date (format-time-string | |
1385 | (format "%%d-%s-%%Y" | |
1386 | (capitalize (car (rassoc (nth 4 (decode-time time)) | |
1387 | parse-time-months)))) | |
1388 | time))) | |
c113de23 GM |
1389 | (if (eq ?0 (string-to-char date)) |
1390 | (substring date 1) | |
1391 | date))) | |
1392 | ||
1393 | (defun nnimap-request-expire-articles-progress () | |
1394 | (gnus-message 5 "nnimap: Marking article %d for deletion..." | |
1395 | imap-current-message)) | |
1396 | ||
23f87bed MB |
1397 | (defun nnimap-expiry-target (arts group server) |
1398 | (unless (eq nnmail-expiry-target 'delete) | |
1399 | (with-temp-buffer | |
1400 | (dolist (art arts) | |
1401 | (nnimap-request-article art group server (current-buffer)) | |
1402 | ;; hints for optimization in `nnimap-request-accept-article' | |
1403 | (let ((nnimap-current-move-article art) | |
1404 | (nnimap-current-move-group group) | |
1405 | (nnimap-current-move-server server)) | |
1406 | (nnmail-expiry-target-group nnmail-expiry-target group)))) | |
1407 | ;; It is not clear if `nnmail-expiry-target' somehow cause the | |
1408 | ;; current group to be changed or not, so we make sure here. | |
1409 | (nnimap-possibly-change-group group server))) | |
1410 | ||
c113de23 GM |
1411 | ;; Notice that we don't actually delete anything, we just mark them deleted. |
1412 | (deffoo nnimap-request-expire-articles (articles group &optional server force) | |
1413 | (let ((artseq (gnus-compress-sequence articles))) | |
1414 | (when (and artseq (nnimap-possibly-change-group group server)) | |
1415 | (with-current-buffer nnimap-server-buffer | |
23f87bed MB |
1416 | (let ((days (or (and nnmail-expiry-wait-function |
1417 | (funcall nnmail-expiry-wait-function group)) | |
1418 | nnmail-expiry-wait))) | |
1419 | (cond ((or force (eq days 'immediate)) | |
1420 | (let ((oldarts (imap-search | |
1421 | (concat "UID " | |
1422 | (imap-range-to-message-set artseq))))) | |
1423 | (when oldarts | |
1424 | (nnimap-expiry-target oldarts group server) | |
1425 | (when (imap-message-flags-add | |
1426 | (imap-range-to-message-set | |
1427 | (gnus-compress-sequence oldarts)) "\\Deleted") | |
1428 | (setq articles (gnus-set-difference | |
1429 | articles oldarts)))))) | |
1430 | ((numberp days) | |
1431 | (let ((oldarts (imap-search | |
1432 | (format nnimap-expunge-search-string | |
1433 | (imap-range-to-message-set artseq) | |
1434 | (nnimap-date-days-ago days)))) | |
1435 | (imap-fetch-data-hook | |
1436 | '(nnimap-request-expire-articles-progress))) | |
1437 | (when oldarts | |
1438 | (nnimap-expiry-target oldarts group server) | |
1439 | (when (imap-message-flags-add | |
1440 | (imap-range-to-message-set | |
1441 | (gnus-compress-sequence oldarts)) "\\Deleted") | |
1442 | (setq articles (gnus-set-difference | |
1443 | articles oldarts))))))))))) | |
c113de23 GM |
1444 | ;; return articles not deleted |
1445 | articles) | |
1446 | ||
1447 | (deffoo nnimap-request-move-article (article group server | |
1448 | accept-form &optional last) | |
1449 | (when (nnimap-possibly-change-server server) | |
1450 | (save-excursion | |
1451 | (let ((buf (get-buffer-create " *nnimap move*")) | |
1452 | (nnimap-current-move-article article) | |
1453 | (nnimap-current-move-group group) | |
1454 | (nnimap-current-move-server nnimap-current-server) | |
1455 | result) | |
1456 | (and (nnimap-request-article article group server) | |
1457 | (save-excursion | |
1458 | (set-buffer buf) | |
1459 | (buffer-disable-undo (current-buffer)) | |
1460 | (insert-buffer-substring nntp-server-buffer) | |
1461 | (setq result (eval accept-form)) | |
1462 | (kill-buffer buf) | |
1463 | result) | |
23f87bed MB |
1464 | (imap-message-flags-add |
1465 | (imap-range-to-message-set (list article)) | |
1466 | "\\Deleted" 'silent nnimap-server-buffer)) | |
c113de23 | 1467 | result)))) |
a1506d29 | 1468 | |
c113de23 GM |
1469 | (deffoo nnimap-request-accept-article (group &optional server last) |
1470 | (when (nnimap-possibly-change-server server) | |
1471 | (let (uid) | |
1472 | (if (setq uid | |
1473 | (if (string= nnimap-current-server nnimap-current-move-server) | |
1474 | ;; moving article within same server, speed it up... | |
1475 | (and (nnimap-possibly-change-group | |
1476 | nnimap-current-move-group) | |
1477 | (imap-message-copy (number-to-string | |
1478 | nnimap-current-move-article) | |
1479 | group 'dontcreate nil | |
1480 | nnimap-server-buffer)) | |
c113de23 GM |
1481 | (with-current-buffer (current-buffer) |
1482 | (goto-char (point-min)) | |
a2617484 DL |
1483 | ;; remove any 'From blabla' lines, some IMAP servers |
1484 | ;; reject the entire message otherwise. | |
1485 | (when (looking-at "^From[^:]") | |
23f87bed | 1486 | (delete-region (point) (progn (forward-line) (point)))) |
a2617484 | 1487 | ;; turn into rfc822 format (\r\n eol's) |
c113de23 | 1488 | (while (search-forward "\n" nil t) |
23f87bed MB |
1489 | (replace-match "\r\n")) |
1490 | (when nnmail-cache-accepted-message-ids | |
1491 | (nnmail-cache-insert (nnmail-fetch-field "message-id") | |
1492 | group | |
1493 | (nnmail-fetch-field "subject")))) | |
1494 | (when (and last nnmail-cache-accepted-message-ids) | |
1495 | (nnmail-cache-close)) | |
1496 | ;; this 'or' is for Cyrus server bug | |
1497 | (or (null (imap-current-mailbox nnimap-server-buffer)) | |
1498 | (imap-mailbox-unselect nnimap-server-buffer)) | |
c113de23 GM |
1499 | (imap-message-append group (current-buffer) nil nil |
1500 | nnimap-server-buffer))) | |
1501 | (cons group (nth 1 uid)) | |
1502 | (nnheader-report 'nnimap (imap-error-text nnimap-server-buffer)))))) | |
1503 | ||
1504 | (deffoo nnimap-request-delete-group (group force &optional server) | |
1505 | (when (nnimap-possibly-change-server server) | |
1506 | (with-current-buffer nnimap-server-buffer | |
1507 | (if force | |
1508 | (or (null (imap-mailbox-status group 'uidvalidity)) | |
1509 | (imap-mailbox-delete group)) | |
1510 | ;; UNSUBSCRIBE? | |
1511 | t)))) | |
1512 | ||
1513 | (deffoo nnimap-request-rename-group (group new-name &optional server) | |
1514 | (when (nnimap-possibly-change-server server) | |
1515 | (imap-mailbox-rename group new-name nnimap-server-buffer))) | |
1516 | ||
1517 | (defun nnimap-expunge (mailbox server) | |
1518 | (when (nnimap-possibly-change-group mailbox server) | |
23f87bed | 1519 | (imap-mailbox-expunge nil nnimap-server-buffer))) |
c113de23 GM |
1520 | |
1521 | (defun nnimap-acl-get (mailbox server) | |
1522 | (when (nnimap-possibly-change-server server) | |
a2617484 DL |
1523 | (and (imap-capability 'ACL nnimap-server-buffer) |
1524 | (imap-mailbox-acl-get mailbox nnimap-server-buffer)))) | |
c113de23 GM |
1525 | |
1526 | (defun nnimap-acl-edit (mailbox method old-acls new-acls) | |
1527 | (when (nnimap-possibly-change-server (cadr method)) | |
1528 | (unless (imap-capability 'ACL nnimap-server-buffer) | |
1529 | (error "Your server does not support ACL editing")) | |
1530 | (with-current-buffer nnimap-server-buffer | |
1531 | ;; delete all removed identifiers | |
1532 | (mapcar (lambda (old-acl) | |
1533 | (unless (assoc (car old-acl) new-acls) | |
1534 | (or (imap-mailbox-acl-delete (car old-acl) mailbox) | |
1535 | (error "Can't delete ACL for %s" (car old-acl))))) | |
1536 | old-acls) | |
1537 | ;; set all changed acl's | |
1538 | (mapcar (lambda (new-acl) | |
1539 | (let ((new-rights (cdr new-acl)) | |
1540 | (old-rights (cdr (assoc (car new-acl) old-acls)))) | |
1541 | (unless (and old-rights new-rights | |
1542 | (string= old-rights new-rights)) | |
1543 | (or (imap-mailbox-acl-set (car new-acl) new-rights mailbox) | |
1544 | (error "Can't set ACL for %s to %s" (car new-acl) | |
1545 | new-rights))))) | |
1546 | new-acls) | |
1547 | t))) | |
1548 | ||
1549 | \f | |
1550 | ;;; Internal functions | |
1551 | ||
1552 | ;; | |
1553 | ;; This is confusing. | |
1554 | ;; | |
1555 | ;; mark => read, tick, draft, reply etc | |
1556 | ;; flag => "\\Seen", "\\Flagged", "\\Draft", "gnus-expire" etc | |
1557 | ;; predicate => "SEEN", "FLAGGED", "DRAFT", "KEYWORD gnus-expire" etc | |
1558 | ;; | |
1559 | ;; Mark should not really contain 'read since it's not a "mark" in the Gnus | |
1560 | ;; world, but we cheat. Mark == gnus-article-mark-lists + '(read . read). | |
1561 | ;; | |
1562 | ||
1563 | (defconst nnimap-mark-to-predicate-alist | |
1564 | (mapcar | |
1565 | (lambda (pair) ; cdr is the mark | |
1566 | (or (assoc (cdr pair) | |
23f87bed MB |
1567 | '((read . "SEEN") |
1568 | (tick . "FLAGGED") | |
1569 | (draft . "DRAFT") | |
1570 | (recent . "RECENT") | |
1571 | (reply . "ANSWERED"))) | |
1572 | (cons (cdr pair) | |
1573 | (format "KEYWORD gnus-%s" (symbol-name (cdr pair)))))) | |
c113de23 GM |
1574 | (cons '(read . read) gnus-article-mark-lists))) |
1575 | ||
1576 | (defun nnimap-mark-to-predicate (pred) | |
1577 | "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP predicate. | |
1578 | This is a string such as \"SEEN\", \"FLAGGED\", \"KEYWORD gnus-expire\", | |
1579 | to be used within a IMAP SEARCH query." | |
1580 | (cdr (assq pred nnimap-mark-to-predicate-alist))) | |
1581 | ||
1582 | (defconst nnimap-mark-to-flag-alist | |
1583 | (mapcar | |
1584 | (lambda (pair) | |
1585 | (or (assoc (cdr pair) | |
23f87bed MB |
1586 | '((read . "\\Seen") |
1587 | (tick . "\\Flagged") | |
1588 | (draft . "\\Draft") | |
1589 | (recent . "\\Recent") | |
1590 | (reply . "\\Answered"))) | |
1591 | (cons (cdr pair) | |
1592 | (format "gnus-%s" (symbol-name (cdr pair)))))) | |
c113de23 GM |
1593 | (cons '(read . read) gnus-article-mark-lists))) |
1594 | ||
1595 | (defun nnimap-mark-to-flag-1 (preds) | |
1596 | (if (and (not (null preds)) (listp preds)) | |
1597 | (cons (nnimap-mark-to-flag (car preds)) | |
1598 | (nnimap-mark-to-flag (cdr preds))) | |
1599 | (cdr (assoc preds nnimap-mark-to-flag-alist)))) | |
1600 | ||
1601 | (defun nnimap-mark-to-flag (preds &optional always-list make-string) | |
1602 | "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP flag. | |
1603 | This is a string such as \"\\Seen\", \"\\Flagged\", \"gnus-expire\", to | |
1604 | be used in a STORE FLAGS command." | |
1605 | (let ((result (nnimap-mark-to-flag-1 preds))) | |
1606 | (setq result (if (and (or make-string always-list) | |
1607 | (not (listp result))) | |
1608 | (list result) | |
1609 | result)) | |
1610 | (if make-string | |
1611 | (mapconcat (lambda (flag) | |
1612 | (if (listp flag) | |
1613 | (mapconcat 'identity flag " ") | |
1614 | flag)) | |
1615 | result " ") | |
1616 | result))) | |
1617 | ||
1618 | (defun nnimap-mark-permanent-p (mark &optional group) | |
1619 | "Return t iff MARK can be permanently (between IMAP sessions) saved on articles, in GROUP." | |
1620 | (imap-message-flag-permanent-p (nnimap-mark-to-flag mark))) | |
1621 | ||
c113de23 GM |
1622 | (when nnimap-debug |
1623 | (require 'trace) | |
23f87bed MB |
1624 | (buffer-disable-undo (get-buffer-create nnimap-debug-buffer)) |
1625 | (mapcar (lambda (f) (trace-function-background f nnimap-debug-buffer)) | |
1626 | '( | |
1627 | nnimap-possibly-change-server | |
1628 | nnimap-verify-uidvalidity | |
1629 | nnimap-find-minmax-uid | |
1630 | nnimap-before-find-minmax-bugworkaround | |
1631 | nnimap-possibly-change-group | |
1632 | ;;nnimap-replace-whitespace | |
1633 | nnimap-retrieve-headers-progress | |
1634 | nnimap-retrieve-which-headers | |
1635 | nnimap-group-overview-filename | |
1636 | nnimap-retrieve-headers-from-file | |
1637 | nnimap-retrieve-headers-from-server | |
1638 | nnimap-retrieve-headers | |
1639 | nnimap-open-connection | |
1640 | nnimap-open-server | |
1641 | nnimap-server-opened | |
1642 | nnimap-close-server | |
1643 | nnimap-request-close | |
1644 | nnimap-status-message | |
1645 | ;;nnimap-demule | |
1646 | nnimap-request-article-part | |
1647 | nnimap-request-article | |
1648 | nnimap-request-head | |
1649 | nnimap-request-body | |
1650 | nnimap-request-group | |
1651 | nnimap-close-group | |
1652 | nnimap-pattern-to-list-arguments | |
1653 | nnimap-request-list | |
1654 | nnimap-request-post | |
1655 | nnimap-retrieve-groups | |
1656 | nnimap-request-update-info-internal | |
1657 | nnimap-request-type | |
1658 | nnimap-request-set-mark | |
1659 | nnimap-split-to-groups | |
1660 | nnimap-split-find-rule | |
1661 | nnimap-split-find-inbox | |
1662 | nnimap-split-articles | |
1663 | nnimap-request-scan | |
1664 | nnimap-request-newgroups | |
1665 | nnimap-request-create-group | |
1666 | nnimap-time-substract | |
1667 | nnimap-date-days-ago | |
1668 | nnimap-request-expire-articles-progress | |
1669 | nnimap-request-expire-articles | |
1670 | nnimap-request-move-article | |
1671 | nnimap-request-accept-article | |
1672 | nnimap-request-delete-group | |
1673 | nnimap-request-rename-group | |
1674 | gnus-group-nnimap-expunge | |
1675 | gnus-group-nnimap-edit-acl | |
1676 | gnus-group-nnimap-edit-acl-done | |
1677 | nnimap-group-mode-hook | |
1678 | nnimap-mark-to-predicate | |
1679 | nnimap-mark-to-flag-1 | |
1680 | nnimap-mark-to-flag | |
1681 | nnimap-mark-permanent-p | |
1682 | ))) | |
c113de23 GM |
1683 | |
1684 | (provide 'nnimap) | |
1685 | ||
31a54b0e | 1686 | ;; arch-tag: 2b001f20-3ff9-4094-a0ad-46807c1ba70b |
c113de23 | 1687 | ;;; nnimap.el ends here |