1 ;;; nnimap.el --- imap backend for Gnus
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005 Free Software Foundation, Inc.
6 ;; Author: Simon Josefsson <jas@pdc.kth.se>
7 ;; Jim Radford <radford@robby.caltech.edu>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
29 ;; Todo, major things:
31 ;; o Fix Gnus to view correct number of unread/total articles in group buffer
32 ;; o Fix Gnus to handle leading '.' in group names (fixed?)
33 ;; o Finish disconnected mode (moving articles between mailboxes unplugged)
35 ;; o MIME (partial article fetches)
36 ;; o Split to other backends, different split rules for different
39 ;; Todo, minor things:
41 ;; o Don't require half of Gnus -- backends should be standalone
42 ;; o Verify that we don't use IMAP4rev1 specific things (RFC2060 App B)
43 ;; o Dont uid fetch 1,* in nnimap-retrive-groups (slow)
44 ;; o Split up big fetches (1,* header especially) in smaller chunks
45 ;; o What do I do with gnus-newsgroup-*?
46 ;; o Tell Gnus about new groups (how can we tell?)
47 ;; o Respooling (fix Gnus?) (unnecessary?)
48 ;; o Add support for the following: (if applicable)
49 ;; request-list-newsgroups, request-regenerate
51 ;; request-associate-buffer, request-restore-buffer,
52 ;; o Do The Right Thing when UIDVALIDITY changes (what's the right thing?)
53 ;; o Support RFC2221 (Login referrals)
54 ;; o IMAP2BIS compatibility? (RFC2061)
55 ;; o ACAP stuff (perhaps a different project, would be nice to ACAPify
57 ;; o What about Gnus's article editing, can we support it? NO!
58 ;; o Use \Draft to support the draft group??
59 ;; o Duplicate suppression
60 ;; o Rewrite UID SEARCH UID X as UID FETCH X (UID) for those with slow servers
74 (eval-when-compile (require 'cl))
78 (defconst nnimap-version "nnimap 1.0")
81 "Reading IMAP mail with Gnus."
84 (defvoo nnimap-address nil
85 "Address of physical IMAP server. If nil, use the virtual server's name.")
87 (defvoo nnimap-server-port nil
88 "Port number on physical IMAP server.
89 If nil, defaults to 993 for TLS/SSL connections and 143 otherwise.")
91 ;; Splitting variables
93 (defcustom nnimap-split-crosspost t
94 "If non-nil, do crossposting if several split methods match the mail.
95 If nil, the first match found will be used."
99 (defcustom nnimap-split-inbox nil
100 "Name of mailbox to split mail from.
102 Mail is read from this mailbox and split according to rules in
105 This can be a string or a list of strings."
107 :type '(choice (string)
110 (define-widget 'nnimap-strict-function 'function
111 "This widget only matches values that are functionp.
113 Warning: This means that a value that is the symbol of a not yet
114 loaded function will not match. Use with care."
115 :match 'nnimap-strict-function-match)
117 (defun nnimap-strict-function-match (widget value)
118 "Ignoring WIDGET, match if VALUE is a function."
121 (defcustom nnimap-split-rule nil
122 "Mail will be split according to these rules.
124 Mail is read from mailbox(es) specified in `nnimap-split-inbox'.
126 If you'd like, for instance, one mail group for mail from the
127 \"gnus-imap\" mailing list, one group for junk mail and leave
128 everything else in the incoming mailbox, you could do something like
131 \(setq nnimap-split-rule '((\"INBOX.gnus-imap\" \"From:.*gnus-imap\")
132 (\"INBOX.junk\" \"Subject:.*buy\")))
134 As you can see, `nnimap-split-rule' is a list of lists, where the
135 first element in each \"rule\" is the name of the IMAP mailbox (or the
136 symbol `junk' if you want to remove the mail), and the second is a
137 regexp that nnimap will try to match on the header to find a fit.
139 The second element can also be a function. In that case, it will be
140 called narrowed to the headers with the first element of the rule as
141 the argument. It should return a non-nil value if it thinks that the
142 mail belongs in that group.
144 This variable can also have a function as its value, the function will
145 be called with the headers narrowed and should return a group where it
146 thinks the article should be splitted to. See `nnimap-split-fancy'.
148 To allow for different split rules on different virtual servers, and
149 even different split rules in different inboxes on the same server,
150 the syntax of this variable have been extended along the lines of:
152 \(setq nnimap-split-rule
153 '((\"my1server\" (\".*\" ((\"ding\" \"ding@gnus.org\")
154 (\"junk\" \"From:.*Simon\")))
155 (\"my2server\" (\"INBOX\" nnimap-split-fancy))
156 (\"my[34]server\" (\".*\" ((\"private\" \"To:.*Simon\")
157 (\"junk\" my-junk-func)))))
159 The virtual server name is in fact a regexp, so that the same rules
160 may apply to several servers. In the example, the servers
161 \"my3server\" and \"my4server\" both use the same rules. Similarly,
162 the inbox string is also a regexp. The actual splitting rules are as
163 before, either a function, or a list with group/regexp or
164 group/function elements."
166 :type '(choice :tag "Rule type"
167 (repeat :menu-tag "Single-server"
168 :tag "Single-server list"
169 (list (string :tag "Mailbox")
170 (choice :tag "Predicate"
171 (regexp :tag "A regexp")
172 (nnimap-strict-function :tag "A function"))))
173 (choice :menu-tag "A function"
175 (function-item nnimap-split-fancy)
176 (function-item nnmail-split-fancy)
177 (nnimap-strict-function :tag "User-defined function"))
178 (repeat :menu-tag "Multi-server (extended)"
179 :tag "Multi-server list"
180 (list (regexp :tag "Server regexp")
181 (list (regexp :tag "Incoming Mailbox regexp")
182 (repeat :tag "Rules for matching server(s) and mailbox(es)"
183 (list (string :tag "Destination mailbox")
184 (choice :tag "Predicate"
185 (regexp :tag "A Regexp")
186 (nnimap-strict-function :tag "A Function")))))))))
188 (defcustom nnimap-split-predicate "UNSEEN UNDELETED"
189 "The predicate used to find articles to split.
190 If you use another IMAP client to peek on articles but always would
191 like nnimap to split them once it's started, you could change this to
192 \"UNDELETED\". Other available predicates are available in
193 RFC2060 section 6.4.4."
197 (defcustom nnimap-split-fancy nil
198 "Like the variable `nnmail-split-fancy'."
202 (defvar nnimap-split-download-body-default nil
203 "Internal variable with default value for `nnimap-split-download-body'.")
205 (defcustom nnimap-split-download-body 'default
206 "Whether to download entire articles during splitting.
207 This is generally not required, and will slow things down considerably.
208 You may need it if you want to use an advanced splitting function that
209 analyzes the body before splitting the article.
210 If this variable is nil, bodies will not be downloaded; if this
211 variable is the symbol `default' the default behaviour is
212 used (which currently is nil, unless you use a statistical
213 spam.el test); if this variable is another non-nil value bodies
217 :type '(choice (const :tag "Let system decide" deault)
220 ;; Performance / bug workaround variables
222 (defcustom nnimap-close-asynchronous t
223 "Close mailboxes asynchronously in `nnimap-close-group'.
224 This means that errors caught by nnimap when closing the mailbox will
225 not prevent Gnus from updating the group status, which may be harmful.
226 However, it increases speed."
231 (defcustom nnimap-dont-close t
232 "Never close mailboxes.
233 This increases the speed of closing mailboxes (quiting group) but may
234 decrease the speed of selecting another mailbox later. Re-selecting
235 the same mailbox will be faster though."
240 (defcustom nnimap-retrieve-groups-asynchronous t
241 "Send asynchronous STATUS commands for each mailbox before checking mail.
242 If you have mailboxes that rarely receives mail, this speeds up new
243 mail checking. It works by first sending STATUS commands for each
244 mailbox, and then only checking groups which has a modified UIDNEXT
245 more carefully for new mail.
247 In summary, the default is O((1-p)*k+p*n) and changing it to nil makes
248 it O(n). If p is small, then the default is probably faster."
253 (defvoo nnimap-need-unselect-to-notice-new-mail nil
254 "Unselect mailboxes before looking for new mail in them.
255 Some servers seem to need this under some circumstances.")
257 ;; Authorization / Privacy variables
259 (defvoo nnimap-auth-method nil
262 (defvoo nnimap-stream nil
263 "How nnimap will connect to the server.
265 The default, nil, will try to use the \"best\" method the server can
270 1) you want to connect with TLS/SSL. The TLS/SSL integration
271 with IMAP is suboptimal so you'll have to tell it
274 2) your server is more capable than your environment -- i.e. your
275 server accept Kerberos login's but you haven't installed the
276 `imtest' program or your machine isn't configured for Kerberos.
278 Possible choices: gssapi, kerberos4, starttls, tls, ssl, network, shell.
279 See also `imap-streams' and `imap-stream-alist'.")
281 (defvoo nnimap-authenticator nil
282 "How nnimap authenticate itself to the server.
284 The default, nil, will try to use the \"best\" method the server can
287 There is only one reason for fiddling with this variable, and that is
288 if your server is more capable than your environment -- i.e. you
289 connect to a server that accept Kerberos login's but you haven't
290 installed the `imtest' program or your machine isn't configured for
293 Possible choices: gssapi, kerberos4, digest-md5, cram-md5, login, anonymous.
294 See also `imap-authenticators' and `imap-authenticator-alist'")
296 (defvoo nnimap-directory (nnheader-concat gnus-directory "overview/")
297 "Directory to keep NOV cache files for nnimap groups.
298 See also `nnimap-nov-file-name'.")
300 (defvoo nnimap-nov-file-name "nnimap."
301 "NOV cache base filename.
302 The group name and `nnimap-nov-file-name-suffix' will be appended. A
303 typical complete file name would be
304 ~/News/overview/nnimap.pdc.INBOX.ding.nov, or
305 ~/News/overview/nnimap/pdc/INBOX/ding/nov if
306 `nnmail-use-long-file-names' is nil")
308 (defvoo nnimap-nov-file-name-suffix ".novcache"
309 "Suffix for NOV cache base filename.")
311 (defvoo nnimap-nov-is-evil gnus-agent
312 "If non-nil, never generate or use a local nov database for this backend.
313 Using nov databases should speed up header fetching considerably.
314 However, it will invoke a UID SEARCH UID command on the server, and
315 some servers implement this command inefficiently by opening each and
316 every message in the group, thus making it quite slow.
317 Unlike other backends, you do not need to take special care if you
318 flip this variable.")
320 (defvoo nnimap-search-uids-not-since-is-evil nil
321 "If non-nil, avoid \"UID SEARCH UID ... NOT SINCE\" queries when expiring.
322 Instead, use \"UID SEARCH SINCE\" to prune the list of expirable
323 articles within Gnus. This seems to be faster on Courier in some cases.")
325 (defvoo nnimap-expunge-on-close 'always ; 'ask, 'never
326 "Whether to expunge a group when it is closed.
327 When a IMAP group with articles marked for deletion is closed, this
328 variable determine if nnimap should actually remove the articles or
331 If always, nnimap always perform a expunge when closing the group.
332 If never, nnimap never expunges articles marked for deletion.
333 If ask, nnimap will ask you if you wish to expunge marked articles.
335 When setting this variable to `never', you can only expunge articles
336 by using `G x' (gnus-group-nnimap-expunge) from the Group buffer.")
338 (defvoo nnimap-list-pattern "*"
339 "A string LIMIT or list of strings with mailbox wildcards used to limit available groups.
340 See below for available wildcards.
342 The LIMIT string can be a cons cell (REFERENCE . LIMIT), where
343 REFERENCE will be passed as the first parameter to LIST/LSUB. The
344 semantics of this are server specific, on the University of Washington
345 server you can specify a directory.
348 '(\"INBOX\" \"mail/*\" (\"~friend/mail/\" . \"list/*\"))
350 There are two wildcards * and %. * matches everything, % matches
351 everything in the current hierarchy.")
353 (defvoo nnimap-news-groups nil
354 "IMAP support a news-like mode, also known as bulletin board mode,
355 where replies is sent via IMAP instead of SMTP.
357 This variable should contain a regexp matching groups where you wish
358 replies to be stored to the mailbox directly.
361 '(\"^[^I][^N][^B][^O][^X].*$\")
363 This will match all groups not beginning with \"INBOX\".
365 Note that there is nothing technically different between mail-like and
366 news-like mailboxes. If you wish to have a group with todo items or
367 similar which you wouldn't want to set up a mailing list for, you can
368 use this to make replies go directly to the group.")
370 (defvoo nnimap-expunge-search-string "UID %s NOT SINCE %s"
371 "IMAP search command to use for articles that are to be expired.
372 The first %s is replaced by a UID set of articles to search on,
373 and the second %s is replaced by a date criterium.
375 One useful (and perhaps the only useful) value to change this to would
376 be `UID %s NOT SENTSINCE %s' to make nnimap use the Date: header
377 instead of the internal date of messages. See section 6.4.4 of RFC
378 2060 for more information on valid strings.")
380 (defvoo nnimap-importantize-dormant t
381 "If non-nil, mark \"dormant\" articles as \"ticked\" for other IMAP clients.
382 Note that within Gnus, dormant articles will still (only) be
383 marked as ticked. This is to make \"dormant\" articles stand out,
384 just like \"ticked\" articles, in other IMAP clients.")
386 (defvoo nnimap-server-address nil
387 "Obsolete. Use `nnimap-address'.")
389 (defcustom nnimap-authinfo-file "~/.authinfo"
390 "Authorization information for IMAP servers. In .netrc format."
393 (repeat :tag "Entries"
396 :value ("" ("login" . "") ("password" . ""))
400 (const :format "" "login")
401 (string :format "Login: %v"))
403 (const :format "" "password")
404 (string :format "Password: %v"))))))
407 (defcustom nnimap-prune-cache t
408 "If non-nil, nnimap check whether articles still exist on server before using data stored in NOV cache."
412 (defvar nnimap-request-list-method 'imap-mailbox-list
413 "Method to use to request a list of all folders from the server.
414 If this is 'imap-mailbox-lsub, then use a server-side subscription list to
415 restrict visible folders.")
417 (defcustom nnimap-id nil
418 "Plist with client identity to send to server upon login.
419 Nil means no information is sent, symbol `no' to disable ID query
420 alltogheter, or plist with identifier-value pairs to send to
421 server. RFC 2971 describes the list as follows:
423 Any string may be sent as a field, but the following are defined to
424 describe certain values that might be sent. Implementations are free
425 to send none, any, or all of these. Strings are not case-sensitive.
426 Field strings MUST NOT be longer than 30 octets. Value strings MUST
427 NOT be longer than 1024 octets. Implementations MUST NOT send more
428 than 30 field-value pairs.
430 name Name of the program
431 version Version number of the program
432 os Name of the operating system
433 os-version Version of the operating system
434 vendor Vendor of the client/server
435 support-url URL to contact for support
436 address Postal address of contact/vendor
437 date Date program was released, specified as a date-time
439 command Command used to start the program
440 arguments Arguments supplied on the command line, if any
442 environment Description of environment, i.e., UNIX environment
443 variables or Windows registry settings
445 Implementations MUST NOT send the same field name more than once.
447 An example plist would be '(\"name\" \"Gnus\" \"version\" gnus-version-number
448 \"os\" system-configuration \"vendor\" \"GNU\")."
450 :type '(choice (const :tag "No information" nil)
451 (const :tag "Disable ID query" no)
452 (plist :key-type string :value-type string)))
454 (defcustom nnimap-debug nil
455 "If non-nil, random debug spews are placed in *nnimap-debug* buffer.
456 Note that username, passwords and other privacy sensitive
457 information (such as e-mail) may be stored in the *nnimap-debug*
458 buffer. It is not written to disk, however. Do not enable this
459 variable unless you are comfortable with that."
463 ;; Internal variables:
465 (defvar nnimap-debug-buffer "*nnimap-debug*")
466 (defvar nnimap-mailbox-info (gnus-make-hashtable 997))
467 (defvar nnimap-current-move-server nil)
468 (defvar nnimap-current-move-group nil)
469 (defvar nnimap-current-move-article nil)
470 (defvar nnimap-length)
471 (defvar nnimap-progress-chars '(?| ?/ ?- ?\\))
472 (defvar nnimap-progress-how-often 20)
473 (defvar nnimap-counter)
474 (defvar nnimap-server-buffer-alist nil) ;; Map server name to buffers.
475 (defvar nnimap-current-server nil) ;; Current server
476 (defvar nnimap-server-buffer nil) ;; Current servers' buffer
480 (nnoo-define-basics nnimap)
482 ;; Utility functions:
484 (defsubst nnimap-get-server-buffer (server)
485 "Return buffer for SERVER, if nil use current server."
486 (cadr (assoc (or server nnimap-current-server) nnimap-server-buffer-alist)))
488 (defun nnimap-remove-server-from-buffer-alist (server list)
489 "Remove SERVER from LIST."
492 (unless (equal server (car-safe e))
496 (defun nnimap-possibly-change-server (server)
497 "Return buffer for SERVER, changing the current server as a side-effect.
498 If SERVER is nil, uses the current server."
499 (setq nnimap-current-server (or server nnimap-current-server)
500 nnimap-server-buffer (nnimap-get-server-buffer nnimap-current-server)))
502 (defun nnimap-verify-uidvalidity (group server)
503 "Verify stored uidvalidity match current one in GROUP on SERVER."
504 (let* ((gnusgroup (gnus-group-prefixed-name
505 group (gnus-server-to-method
506 (format "nnimap:%s" server))))
507 (new-uidvalidity (imap-mailbox-get 'uidvalidity))
508 (old-uidvalidity (gnus-group-get-parameter gnusgroup 'uidvalidity))
509 (dir (file-name-as-directory (expand-file-name nnimap-directory)))
510 (nameuid (nnheader-translate-file-chars
511 (concat nnimap-nov-file-name
512 (if (equal server "")
514 server) "." group "." old-uidvalidity
515 nnimap-nov-file-name-suffix) t))
516 (file (if (or nnmail-use-long-file-names
517 (file-exists-p (expand-file-name nameuid dir)))
518 (expand-file-name nameuid dir)
520 (mm-encode-coding-string
521 (nnheader-replace-chars-in-string nameuid ?. ?/)
522 nnmail-pathname-coding-system)
525 (if (not (equal old-uidvalidity new-uidvalidity))
527 (gnus-delete-file file)
528 (gnus-group-set-parameter gnusgroup 'uidvalidity new-uidvalidity)
530 (gnus-group-add-parameter gnusgroup (cons 'uidvalidity new-uidvalidity))
533 (defun nnimap-before-find-minmax-bugworkaround ()
534 "Function called before iterating through mailboxes with
535 `nnimap-find-minmax-uid'."
536 (when nnimap-need-unselect-to-notice-new-mail
537 ;; XXX this is for UoW imapd problem, it doesn't notice new mail in
538 ;; currently selected mailbox without a re-select/examine.
539 (or (null (imap-current-mailbox nnimap-server-buffer))
540 (imap-mailbox-unselect nnimap-server-buffer))))
542 (defun nnimap-find-minmax-uid (group &optional examine)
543 "Find lowest and highest active article number in GROUP.
544 If EXAMINE is non-nil the group is selected read-only."
545 (with-current-buffer nnimap-server-buffer
546 (when (or (string= group (imap-current-mailbox))
547 (imap-mailbox-select group examine))
549 (when (> (imap-mailbox-get 'exists) 0)
550 (imap-fetch "1,*" "UID" nil 'nouidfetch)
551 (imap-message-map (lambda (uid Uid)
552 (setq minuid (if minuid (min minuid uid) uid)
553 maxuid (if maxuid (max maxuid uid) uid)))
555 (list (imap-mailbox-get 'exists) minuid maxuid)))))
557 (defun nnimap-possibly-change-group (group &optional server)
558 "Make GROUP the current group, and SERVER the current server."
559 (when (nnimap-possibly-change-server server)
560 (with-current-buffer nnimap-server-buffer
561 (if (or (null group) (imap-current-mailbox-p group))
563 (if (imap-mailbox-select group)
564 (if (or (nnimap-verify-uidvalidity
565 group (or server nnimap-current-server))
566 (zerop (imap-mailbox-get 'exists group))
567 t ;; for OGnus to see if ignoring uidvalidity
568 ;; changes has any bad effects.
571 "nnimap: Group %s is not uidvalid. Continue? " group)))
573 (imap-mailbox-unselect)
574 (error "nnimap: Group %s is not uid-valid" group))
575 (nnheader-report 'nnimap (imap-error-text)))))))
577 (defun nnimap-replace-whitespace (string)
578 "Return STRING with all whitespace replaced with space."
580 (while (string-match "[\r\n\t]+" string)
581 (setq string (replace-match " " t t string)))
584 ;; Required backend functions
586 (defun nnimap-retrieve-headers-progress ()
587 "Hook to insert NOV line for current article into `nntp-server-buffer'."
588 (and (numberp nnmail-large-newsgroup)
589 (zerop (% (incf nnimap-counter) nnimap-progress-how-often))
590 (> nnimap-length nnmail-large-newsgroup)
591 (nnheader-message 6 "nnimap: Retrieving headers... %c"
592 (nth (/ (% nnimap-counter
593 (* (length nnimap-progress-chars)
594 nnimap-progress-how-often))
595 nnimap-progress-how-often)
596 nnimap-progress-chars)))
597 (with-current-buffer nntp-server-buffer
598 (let (headers lines chars uid mbx)
599 (with-current-buffer nnimap-server-buffer
600 (setq uid imap-current-message
601 mbx imap-current-mailbox
602 headers (nnimap-demule
603 (if (imap-capability 'IMAP4rev1)
604 ;; xxx don't just use car? alist doesn't contain
605 ;; anything else now, but it might...
606 (nth 2 (car (imap-message-get uid 'BODYDETAIL)))
607 (imap-message-get uid 'RFC822.HEADER)))
608 lines (imap-body-lines (imap-message-body imap-current-message))
609 chars (imap-message-get imap-current-message 'RFC822.SIZE)))
612 (buffer-disable-undo)
614 (let ((head (nnheader-parse-naked-head uid)))
615 (mail-header-set-number head uid)
616 (mail-header-set-chars head chars)
617 (mail-header-set-lines head lines)
618 (mail-header-set-xref
619 head (format "%s %s:%d" (system-name) mbx uid))
622 (defun nnimap-retrieve-which-headers (articles fetch-old)
623 "Get a range of articles to fetch based on ARTICLES and FETCH-OLD."
624 (with-current-buffer nnimap-server-buffer
625 (if (numberp (car-safe articles))
628 (imap-range-to-message-set
629 (gnus-compress-sequence
630 (append (gnus-uncompress-sequence
632 (cons (if (numberp fetch-old)
633 (max 1 (- (car articles) fetch-old))
635 (1- (car articles)))))
637 (mapcar (lambda (msgid)
639 (format "HEADER Message-Id \"%s\"" msgid)))
642 (defun nnimap-group-overview-filename (group server)
643 "Make file name for GROUP on SERVER."
644 (let* ((dir (file-name-as-directory (expand-file-name nnimap-directory)))
645 (uidvalidity (gnus-group-get-parameter
646 (gnus-group-prefixed-name
647 group (gnus-server-to-method
648 (format "nnimap:%s" server)))
650 (name (nnheader-translate-file-chars
651 (concat nnimap-nov-file-name
652 (if (equal server "")
654 server) "." group nnimap-nov-file-name-suffix) t))
655 (nameuid (nnheader-translate-file-chars
656 (concat nnimap-nov-file-name
657 (if (equal server "")
659 server) "." group "." uidvalidity
660 nnimap-nov-file-name-suffix) t))
661 (oldfile (if (or nnmail-use-long-file-names
662 (file-exists-p (expand-file-name name dir)))
663 (expand-file-name name dir)
665 (mm-encode-coding-string
666 (nnheader-replace-chars-in-string name ?. ?/)
667 nnmail-pathname-coding-system)
669 (newfile (if (or nnmail-use-long-file-names
670 (file-exists-p (expand-file-name nameuid dir)))
671 (expand-file-name nameuid dir)
673 (mm-encode-coding-string
674 (nnheader-replace-chars-in-string nameuid ?. ?/)
675 nnmail-pathname-coding-system)
677 (when (and (file-exists-p oldfile) (not (file-exists-p newfile)))
678 (message "nnimap: Upgrading novcache filename...")
680 (gnus-make-directory (file-name-directory newfile))
681 (unless (ignore-errors (rename-file oldfile newfile) t)
682 (if (ignore-errors (copy-file oldfile newfile) t)
683 (delete-file oldfile)
684 (error "Can't rename `%s' to `%s'" oldfile newfile))))
687 (defun nnimap-retrieve-headers-from-file (group server)
688 (with-current-buffer nntp-server-buffer
689 (let ((nov (nnimap-group-overview-filename group server)))
690 (when (file-exists-p nov)
691 (mm-insert-file-contents nov)
692 (set-buffer-modified-p nil)
693 (let ((min (ignore-errors (goto-char (point-min))
694 (read (current-buffer))))
695 (max (ignore-errors (goto-char (point-max))
697 (read (current-buffer)))))
698 (if (and (numberp min) (numberp max))
700 ;; junk, remove it, it's saved later
704 (defun nnimap-retrieve-headers-from-server (articles group server)
705 (with-current-buffer nnimap-server-buffer
706 (let ((imap-fetch-data-hook '(nnimap-retrieve-headers-progress))
707 (nnimap-length (gnus-range-length articles))
709 (imap-fetch (imap-range-to-message-set articles)
710 (concat "(UID RFC822.SIZE BODY "
712 (append '(Subject From Date Message-Id
713 References In-Reply-To Xref)
715 nnmail-extra-headers))))
716 (if (imap-capability 'IMAP4rev1)
717 (format "BODY.PEEK[HEADER.FIELDS %s])" headers)
718 (format "RFC822.HEADER.LINES %s)" headers)))))
719 (with-current-buffer nntp-server-buffer
720 (sort-numeric-fields 1 (point-min) (point-max)))
721 (and (numberp nnmail-large-newsgroup)
722 (> nnimap-length nnmail-large-newsgroup)
723 (nnheader-message 6 "nnimap: Retrieving headers...done")))))
725 (defun nnimap-dont-use-nov-p (group server)
726 (or gnus-nov-is-evil nnimap-nov-is-evil
727 (unless (and (gnus-make-directory
729 (nnimap-group-overview-filename group server)))
731 (nnimap-group-overview-filename group server)))
732 (message "nnimap: Nov cache not writable, %s"
733 (nnimap-group-overview-filename group server)))))
735 (deffoo nnimap-retrieve-headers (articles &optional group server fetch-old)
736 (when (nnimap-possibly-change-group group server)
737 (with-current-buffer nntp-server-buffer
739 (if (nnimap-dont-use-nov-p group server)
740 (nnimap-retrieve-headers-from-server
741 (gnus-compress-sequence articles) group server)
742 (let (uids cached low high)
743 (when (setq uids (nnimap-retrieve-which-headers articles fetch-old)
745 high (car (last uids)))
746 (if (setq cached (nnimap-retrieve-headers-from-file group server))
748 ;; fetch articles with uids before cache block
749 (when (< low (car cached))
750 (goto-char (point-min))
751 (nnimap-retrieve-headers-from-server
752 (cons low (1- (car cached))) group server))
753 ;; fetch articles with uids after cache block
754 (when (> high (cdr cached))
755 (goto-char (point-max))
756 (nnimap-retrieve-headers-from-server
757 (cons (1+ (cdr cached)) high) group server))
758 (when nnimap-prune-cache
759 ;; remove nov's for articles which has expired on server
760 (goto-char (point-min))
761 (dolist (uid (gnus-set-difference articles uids))
762 (when (re-search-forward (format "^%d\t" uid) nil t)
763 (gnus-delete-line)))))
764 ;; nothing cached, fetch whole range from server
765 (nnimap-retrieve-headers-from-server
766 (cons low high) group server))
767 (when (buffer-modified-p)
769 (point-min) (point-max)
770 (nnimap-group-overview-filename group server) nil 'nomesg))
771 (nnheader-nov-delete-outside-range low high))))
774 (defun nnimap-open-connection (server)
775 (if (not (imap-open nnimap-address nnimap-server-port nnimap-stream
776 nnimap-authenticator nnimap-server-buffer))
777 (nnheader-report 'nnimap "Can't open connection to server %s" server)
778 (unless (or (imap-capability 'IMAP4 nnimap-server-buffer)
779 (imap-capability 'IMAP4rev1 nnimap-server-buffer))
780 (imap-close nnimap-server-buffer)
781 (nnheader-report 'nnimap "Server %s is not IMAP4 compliant" server))
782 (let* ((list (progn (gnus-message 7 "Parsing authinfo file `%s'."
783 nnimap-authinfo-file)
784 (netrc-parse nnimap-authinfo-file)))
785 (port (if nnimap-server-port
786 (int-to-string nnimap-server-port)
788 (user (netrc-machine-user-or-password
792 (or nnimap-server-address
795 (list "imap" "imaps")))
796 (passwd (netrc-machine-user-or-password
800 (or nnimap-server-address
803 (list "imap" "imaps"))))
804 (if (imap-authenticate user passwd nnimap-server-buffer)
806 (setq nnimap-server-buffer-alist
807 (nnimap-remove-server-from-buffer-alist
809 nnimap-server-buffer-alist))
810 (push (list server nnimap-server-buffer)
811 nnimap-server-buffer-alist)
812 (imap-id nnimap-id nnimap-server-buffer)
813 (nnimap-possibly-change-server server))
814 (imap-close nnimap-server-buffer)
815 (kill-buffer nnimap-server-buffer)
816 (nnheader-report 'nnimap "Could not authenticate to %s" server)))))
818 (deffoo nnimap-open-server (server &optional defs)
819 (nnheader-init-server-buffer)
820 (if (nnimap-server-opened server)
822 (unless (assq 'nnimap-server-buffer defs)
823 (push (list 'nnimap-server-buffer (concat " *nnimap* " server)) defs))
824 ;; translate `nnimap-server-address' to `nnimap-address' in defs
825 ;; for people that configured nnimap with a very old version
826 (unless (assq 'nnimap-address defs)
827 (if (assq 'nnimap-server-address defs)
828 (push (list 'nnimap-address
829 (cadr (assq 'nnimap-server-address defs))) defs)
830 (push (list 'nnimap-address server) defs)))
831 (nnoo-change-server 'nnimap server defs)
832 (or nnimap-server-buffer
833 (setq nnimap-server-buffer (cadr (assq 'nnimap-server-buffer defs))))
834 (with-current-buffer (get-buffer-create nnimap-server-buffer)
835 (nnoo-change-server 'nnimap server defs))
836 (or (and nnimap-server-buffer
837 (imap-opened nnimap-server-buffer)
838 (if (with-current-buffer nnimap-server-buffer
839 (memq imap-state '(auth selected examine)))
841 (imap-close nnimap-server-buffer)
842 (nnimap-open-connection server)))
843 (nnimap-open-connection server))))
845 (deffoo nnimap-server-opened (&optional server)
846 "Whether SERVER is opened.
847 If SERVER is the current virtual server, and the connection to the
848 physical server is alive, this function return a non-nil value. If
849 SERVER is nil, it is treated as the current server."
850 ;; clean up autologouts??
851 (and (or server nnimap-current-server)
852 (nnoo-server-opened 'nnimap (or server nnimap-current-server))
853 (imap-opened (nnimap-get-server-buffer server))))
855 (deffoo nnimap-close-server (&optional server)
856 "Close connection to server and free all resources connected to it.
857 Return nil if the server couldn't be closed for some reason."
858 (let ((server (or server nnimap-current-server)))
859 (when (or (nnimap-server-opened server)
860 (imap-opened (nnimap-get-server-buffer server)))
861 (imap-close (nnimap-get-server-buffer server))
862 (kill-buffer (nnimap-get-server-buffer server))
863 (setq nnimap-server-buffer nil
864 nnimap-current-server nil
865 nnimap-server-buffer-alist
866 (nnimap-remove-server-from-buffer-alist
868 nnimap-server-buffer-alist)))
869 (nnoo-close-server 'nnimap server)))
871 (deffoo nnimap-request-close ()
872 "Close connection to all servers and free all resources that the backend have reserved.
873 All buffers that have been created by that
874 backend should be killed. (Not the nntp-server-buffer, though.) This
875 function is generally only called when Gnus is shutting down."
876 (mapc (lambda (server) (nnimap-close-server (car server)))
877 nnimap-server-buffer-alist)
878 (setq nnimap-server-buffer-alist nil))
880 (deffoo nnimap-status-message (&optional server)
881 "This function returns the last error message from server."
882 (when (nnimap-possibly-change-server server)
883 (nnoo-status-message 'nnimap server)))
885 (defun nnimap-demule (string)
886 ;; BEWARE: we used to use string-as-multibyte here which is braindead
887 ;; because it will turn accidental emacs-mule-valid byte sequences
888 ;; into multibyte chars. --Stef
889 ;; Reverted, braindead got 7.5 out of 10 on imdb, so it can't be