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