nnimap.el 68.2 KB
Newer Older
Gerd Moellmann's avatar
Gerd Moellmann committed
1
;;; nnimap.el --- imap backend for Gnus
2

3
;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2007, 2008, 2009, 2010  Free Software Foundation, Inc.
Gerd Moellmann's avatar
Gerd Moellmann committed
5

Miles Bader's avatar
Miles Bader committed
6
;; Author: Simon Josefsson <simon@josefsson.org>
Gerd Moellmann's avatar
Gerd Moellmann committed
7 8 9 10 11
;;         Jim Radford <radford@robby.caltech.edu>
;; Keywords: mail

;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Gerd Moellmann's avatar
Gerd Moellmann committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Gerd Moellmann's avatar
Gerd Moellmann committed
16 17 18

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Gerd Moellmann's avatar
Gerd Moellmann committed
20 21 22
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Gerd Moellmann's avatar
Gerd Moellmann committed
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

;;; Commentary:

;; Todo, major things:
;;
;;   o Fix Gnus to view correct number of unread/total articles in group buffer
;;   o Fix Gnus to handle leading '.' in group names (fixed?)
;;   o Finish disconnected mode (moving articles between mailboxes unplugged)
;;   o Sieve
;;   o MIME (partial article fetches)
;;   o Split to other backends, different split rules for different
;;     servers/inboxes
;;
;; Todo, minor things:
;;
;;   o Don't require half of Gnus -- backends should be standalone
;;   o Verify that we don't use IMAP4rev1 specific things (RFC2060 App B)
;;   o Dont uid fetch 1,* in nnimap-retrive-groups (slow)
;;   o Split up big fetches (1,* header especially) in smaller chunks
;;   o What do I do with gnus-newsgroup-*?
;;   o Tell Gnus about new groups (how can we tell?)
ShengHuo ZHU's avatar
Typos.  
ShengHuo ZHU committed
45
;;   o Respooling (fix Gnus?) (unnecessary?)
Gerd Moellmann's avatar
Gerd Moellmann committed
46 47 48 49 50 51 52 53 54 55 56 57
;;   o Add support for the following: (if applicable)
;;       request-list-newsgroups, request-regenerate
;;       list-active-group,
;;       request-associate-buffer, request-restore-buffer,
;;   o Do The Right Thing when UIDVALIDITY changes (what's the right thing?)
;;   o Support RFC2221 (Login referrals)
;;   o IMAP2BIS compatibility? (RFC2061)
;;   o ACAP stuff (perhaps a different project, would be nice to ACAPify
;;     .newsrc.eld)
;;   o What about Gnus's article editing, can we support it?  NO!
;;   o Use \Draft to support the draft group??
;;   o Duplicate suppression
58
;;   o Rewrite UID SEARCH UID X as UID FETCH X (UID) for those with slow servers
Gerd Moellmann's avatar
Gerd Moellmann committed
59 60 61

;;; Code:

62 63 64 65
;; For Emacs < 22.2.
(eval-and-compile
  (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))

66
(require 'imap)
Gerd Moellmann's avatar
Gerd Moellmann committed
67 68 69 70 71 72 73 74 75
(require 'nnoo)
(require 'nnmail)
(require 'nnheader)
(require 'mm-util)
(require 'gnus)
(require 'gnus-range)
(require 'gnus-start)
(require 'gnus-int)

76 77
(eval-when-compile (require 'cl))

78
(autoload 'auth-source-user-or-password "auth-source")
Miles Bader's avatar
Miles Bader committed
79

Gerd Moellmann's avatar
Gerd Moellmann committed
80 81
(nnoo-declare nnimap)

82 83 84 85 86
(defconst nnimap-version "nnimap 1.0")

(defgroup nnimap nil
  "Reading IMAP mail with Gnus."
  :group 'gnus)
Gerd Moellmann's avatar
Gerd Moellmann committed
87 88 89 90 91 92

(defvoo nnimap-address nil
  "Address of physical IMAP server.  If nil, use the virtual server's name.")

(defvoo nnimap-server-port nil
  "Port number on physical IMAP server.
93
If nil, defaults to 993 for TLS/SSL connections and 143 otherwise.")
Gerd Moellmann's avatar
Gerd Moellmann committed
94 95 96

;; Splitting variables

97
(defcustom nnimap-split-crosspost t
Gerd Moellmann's avatar
Gerd Moellmann committed
98
  "If non-nil, do crossposting if several split methods match the mail.
99 100 101
If nil, the first match found will be used."
  :group 'nnimap
  :type 'boolean)
Gerd Moellmann's avatar
Gerd Moellmann committed
102

103 104
(defcustom nnimap-split-inbox nil
  "Name of mailbox to split mail from.
Gerd Moellmann's avatar
Gerd Moellmann committed
105 106

Mail is read from this mailbox and split according to rules in
107 108 109 110 111 112 113 114 115 116 117 118 119
`nnimap-split-rule'.

This can be a string or a list of strings."
  :group 'nnimap
  :type '(choice (string)
		 (repeat string)))

(define-widget 'nnimap-strict-function 'function
  "This widget only matches values that are functionp.

Warning: This means that a value that is the symbol of a not yet
loaded function will not match.  Use with care."
  :match 'nnimap-strict-function-match)
Gerd Moellmann's avatar
Gerd Moellmann committed
120

121 122 123
(defun nnimap-strict-function-match (widget value)
  "Ignoring WIDGET, match if VALUE is a function."
  (functionp value))
Gerd Moellmann's avatar
Gerd Moellmann committed
124

125 126
(defcustom nnimap-split-rule nil
  "Mail will be split according to these rules.
Gerd Moellmann's avatar
Gerd Moellmann committed
127 128 129 130 131 132 133 134

Mail is read from mailbox(es) specified in `nnimap-split-inbox'.

If you'd like, for instance, one mail group for mail from the
\"gnus-imap\" mailing list, one group for junk mail and leave
everything else in the incoming mailbox, you could do something like
this:

135
\(setq nnimap-split-rule '((\"INBOX.gnus-imap\"   \"From:.*gnus-imap\")
Gerd Moellmann's avatar
Gerd Moellmann committed
136 137
			  (\"INBOX.junk\"        \"Subject:.*buy\")))

138 139 140 141
As you can see, `nnimap-split-rule' is a list of lists, where the
first element in each \"rule\" is the name of the IMAP mailbox (or the
symbol `junk' if you want to remove the mail), and the second is a
regexp that nnimap will try to match on the header to find a fit.
Gerd Moellmann's avatar
Gerd Moellmann committed
142 143 144 145 146 147 148 149 150 151 152 153 154 155

The second element can also be a function.  In that case, it will be
called narrowed to the headers with the first element of the rule as
the argument.  It should return a non-nil value if it thinks that the
mail belongs in that group.

This variable can also have a function as its value, the function will
be called with the headers narrowed and should return a group where it
thinks the article should be splitted to.  See `nnimap-split-fancy'.

To allow for different split rules on different virtual servers, and
even different split rules in different inboxes on the same server,
the syntax of this variable have been extended along the lines of:

156
\(setq nnimap-split-rule
Gerd Moellmann's avatar
Gerd Moellmann committed
157
      '((\"my1server\"    (\".*\"    ((\"ding\"    \"ding@gnus.org\")
158 159 160 161
				  (\"junk\"    \"From:.*Simon\")))
	(\"my2server\"    (\"INBOX\" nnimap-split-fancy))
	(\"my[34]server\" (\".*\"    ((\"private\" \"To:.*Simon\")
				  (\"junk\"    my-junk-func)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
162 163 164 165 166 167

The virtual server name is in fact a regexp, so that the same rules
may apply to several servers.  In the example, the servers
\"my3server\" and \"my4server\" both use the same rules.  Similarly,
the inbox string is also a regexp.  The actual splitting rules are as
before, either a function, or a list with group/regexp or
168 169
group/function elements."
  :group 'nnimap
Miles Bader's avatar
Miles Bader committed
170 171
  ;; FIXME: Doesn't allow `("my2server" ("INBOX" nnimap-split-fancy))'
  ;; per example above.  -- fx
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
  :type '(choice :tag "Rule type"
		 (repeat :menu-tag "Single-server"
			 :tag "Single-server list"
			 (list (string :tag "Mailbox")
			       (choice :tag "Predicate"
				       (regexp :tag "A regexp")
				       (nnimap-strict-function :tag "A function"))))
		 (choice :menu-tag "A function"
			 :tag "A function"
			 (function-item nnimap-split-fancy)
			 (function-item nnmail-split-fancy)
			 (nnimap-strict-function :tag "User-defined function"))
		 (repeat :menu-tag "Multi-server (extended)"
			 :tag "Multi-server list"
			 (list (regexp :tag "Server regexp")
			       (list (regexp :tag "Incoming Mailbox regexp")
				     (repeat :tag "Rules for matching server(s) and mailbox(es)"
					     (list (string :tag "Destination mailbox")
						   (choice :tag "Predicate"
							   (regexp :tag "A Regexp")
							   (nnimap-strict-function :tag "A Function")))))))))

(defcustom nnimap-split-predicate "UNSEEN UNDELETED"
Gerd Moellmann's avatar
Gerd Moellmann committed
195 196 197 198
  "The predicate used to find articles to split.
If you use another IMAP client to peek on articles but always would
like nnimap to split them once it's started, you could change this to
\"UNDELETED\". Other available predicates are available in
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
RFC2060 section 6.4.4."
  :group 'nnimap
  :type 'string)

(defcustom nnimap-split-fancy nil
  "Like the variable `nnmail-split-fancy'."
  :group 'nnimap
  :type 'sexp)

(defvar nnimap-split-download-body-default nil
  "Internal variable with default value for `nnimap-split-download-body'.")

(defcustom nnimap-split-download-body 'default
  "Whether to download entire articles during splitting.
This is generally not required, and will slow things down considerably.
You may need it if you want to use an advanced splitting function that
215
analyzes the body before splitting the article.
216
If this variable is nil, bodies will not be downloaded; if this
217
variable is the symbol `default' the default behavior is
218 219 220
used (which currently is nil, unless you use a statistical
spam.el test); if this variable is another non-nil value bodies
will be downloaded."
221
  :version "22.1"
222 223 224 225 226 227 228 229
  :group 'nnimap
  :type '(choice (const :tag "Let system decide" deault)
		 boolean))

;; Performance / bug workaround variables

(defcustom nnimap-close-asynchronous t
  "Close mailboxes asynchronously in `nnimap-close-group'.
230
This means that errors caught by nnimap when closing the mailbox will
231 232
not prevent Gnus from updating the group status, which may be harmful.
However, it increases speed."
233
  :version "22.1"
234 235 236 237 238 239 240 241
  :type 'boolean
  :group 'nnimap)

(defcustom nnimap-dont-close t
  "Never close mailboxes.
This increases the speed of closing mailboxes (quiting group) but may
decrease the speed of selecting another mailbox later.  Re-selecting
the same mailbox will be faster though."
242
  :version "22.1"
243 244 245 246 247 248 249 250 251
  :type 'boolean
  :group 'nnimap)

(defcustom nnimap-retrieve-groups-asynchronous t
  "Send asynchronous STATUS commands for each mailbox before checking mail.
If you have mailboxes that rarely receives mail, this speeds up new
mail checking.  It works by first sending STATUS commands for each
mailbox, and then only checking groups which has a modified UIDNEXT
more carefully for new mail.
Gerd Moellmann's avatar
Gerd Moellmann committed
252

253 254
In summary, the default is O((1-p)*k+p*n) and changing it to nil makes
it O(n).  If p is small, then the default is probably faster."
255
  :version "22.1"
256 257 258
  :type 'boolean
  :group 'nnimap)

259
(defvoo nnimap-need-unselect-to-notice-new-mail t
260 261
  "Unselect mailboxes before looking for new mail in them.
Some servers seem to need this under some circumstances.")
Gerd Moellmann's avatar
Gerd Moellmann committed
262

263 264 265 266 267
(defvoo nnimap-logout-timeout nil
  "Close server immediately if it can't logout in this number of seconds.
If it is nil, never close server until logout completes.  This variable
overrides `imap-logout-timeout' on a per-server basis.")

Gerd Moellmann's avatar
Gerd Moellmann committed
268 269 270 271 272 273 274 275 276 277 278 279 280
;; Authorization / Privacy variables

(defvoo nnimap-auth-method nil
  "Obsolete.")

(defvoo nnimap-stream nil
  "How nnimap will connect to the server.

The default, nil, will try to use the \"best\" method the server can
handle.

Change this if

281 282 283
1) you want to connect with TLS/SSL.  The TLS/SSL integration
   with IMAP is suboptimal so you'll have to tell it
   specifically.
Gerd Moellmann's avatar
Gerd Moellmann committed
284 285 286 287 288

2) your server is more capable than your environment -- i.e. your
   server accept Kerberos login's but you haven't installed the
   `imtest' program or your machine isn't configured for Kerberos.

289 290
Possible choices: gssapi, kerberos4, starttls, tls, ssl, network, shell.
See also `imap-streams' and `imap-stream-alist'.")
Gerd Moellmann's avatar
Gerd Moellmann committed
291 292 293 294 295 296 297 298 299 300 301 302 303

(defvoo nnimap-authenticator nil
  "How nnimap authenticate itself to the server.

The default, nil, will try to use the \"best\" method the server can
handle.

There is only one reason for fiddling with this variable, and that is
if your server is more capable than your environment -- i.e. you
connect to a server that accept Kerberos login's but you haven't
installed the `imtest' program or your machine isn't configured for
Kerberos.

304 305
Possible choices: gssapi, kerberos4, digest-md5, cram-md5, login, anonymous.
See also `imap-authenticators' and `imap-authenticator-alist'")
Gerd Moellmann's avatar
Gerd Moellmann committed
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321

(defvoo nnimap-directory (nnheader-concat gnus-directory "overview/")
  "Directory to keep NOV cache files for nnimap groups.
See also `nnimap-nov-file-name'.")

(defvoo nnimap-nov-file-name "nnimap."
  "NOV cache base filename.
The group name and `nnimap-nov-file-name-suffix' will be appended.  A
typical complete file name would be
~/News/overview/nnimap.pdc.INBOX.ding.nov, or
~/News/overview/nnimap/pdc/INBOX/ding/nov if
`nnmail-use-long-file-names' is nil")

(defvoo nnimap-nov-file-name-suffix ".novcache"
  "Suffix for NOV cache base filename.")

322 323 324 325 326 327
(defvoo nnimap-nov-is-evil gnus-agent
  "If non-nil, never generate or use a local nov database for this backend.
Using nov databases should speed up header fetching considerably.
However, it will invoke a UID SEARCH UID command on the server, and
some servers implement this command inefficiently by opening each and
every message in the group, thus making it quite slow.
Gerd Moellmann's avatar
Gerd Moellmann committed
328 329 330
Unlike other backends, you do not need to take special care if you
flip this variable.")

331 332 333 334 335
(defvoo nnimap-search-uids-not-since-is-evil nil
  "If non-nil, avoid \"UID SEARCH UID ... NOT SINCE\" queries when expiring.
Instead, use \"UID SEARCH SINCE\" to prune the list of expirable
articles within Gnus.  This seems to be faster on Courier in some cases.")

Gerd Moellmann's avatar
Gerd Moellmann committed
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
(defvoo nnimap-expunge-on-close 'always ; 'ask, 'never
  "Whether to expunge a group when it is closed.
When a IMAP group with articles marked for deletion is closed, this
variable determine if nnimap should actually remove the articles or
not.

If always, nnimap always perform a expunge when closing the group.
If never, nnimap never expunges articles marked for deletion.
If ask, nnimap will ask you if you wish to expunge marked articles.

When setting this variable to `never', you can only expunge articles
by using `G x' (gnus-group-nnimap-expunge) from the Group buffer.")

(defvoo nnimap-list-pattern "*"
  "A string LIMIT or list of strings with mailbox wildcards used to limit available groups.
See below for available wildcards.

The LIMIT string can be a cons cell (REFERENCE . LIMIT), where
REFERENCE will be passed as the first parameter to LIST/LSUB.  The
semantics of this are server specific, on the University of Washington
server you can specify a directory.

Example:
 '(\"INBOX\" \"mail/*\" (\"~friend/mail/\" . \"list/*\"))

There are two wildcards * and %. * matches everything, % matches
everything in the current hierarchy.")

(defvoo nnimap-news-groups nil
365 366
  "IMAP support a news-like mode, also known as bulletin board mode,
where replies is sent via IMAP instead of SMTP.
Gerd Moellmann's avatar
Gerd Moellmann committed
367 368 369 370 371 372 373 374 375 376 377 378 379 380

This variable should contain a regexp matching groups where you wish
replies to be stored to the mailbox directly.

Example:
  '(\"^[^I][^N][^B][^O][^X].*$\")

This will match all groups not beginning with \"INBOX\".

Note that there is nothing technically different between mail-like and
news-like mailboxes.  If you wish to have a group with todo items or
similar which you wouldn't want to set up a mailing list for, you can
use this to make replies go directly to the group.")

381 382 383 384 385 386 387 388
(defvoo nnimap-expunge-search-string "UID %s NOT SINCE %s"
  "IMAP search command to use for articles that are to be expired.
The first %s is replaced by a UID set of articles to search on,
and the second %s is replaced by a date criterium.

One useful (and perhaps the only useful) value to change this to would
be `UID %s NOT SENTSINCE %s' to make nnimap use the Date: header
instead of the internal date of messages.  See section 6.4.4 of RFC
Miles Bader's avatar
Miles Bader committed
389 390 391 392
2060 for more information on valid strings.

However, if `nnimap-search-uids-not-since-is-evil' is true, this
variable has no effect since the search logic is reversed.")
393 394 395 396 397 398 399

(defvoo nnimap-importantize-dormant t
  "If non-nil, mark \"dormant\" articles as \"ticked\" for other IMAP clients.
Note that within Gnus, dormant articles will still (only) be
marked as ticked.  This is to make \"dormant\" articles stand out,
just like \"ticked\" articles, in other IMAP clients.")

Gerd Moellmann's avatar
Gerd Moellmann committed
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
(defvoo nnimap-server-address nil
  "Obsolete.  Use `nnimap-address'.")

(defcustom nnimap-authinfo-file "~/.authinfo"
  "Authorization information for IMAP servers.  In .netrc format."
  :type
  '(choice file
	   (repeat :tag "Entries"
		   :menu-tag "Inline"
		   (list :format "%v"
			 :value ("" ("login" . "") ("password" . ""))
			 (string :tag "Host")
			 (checklist :inline t
				    (cons :format "%v"
					  (const :format "" "login")
					  (string :format "Login: %v"))
				    (cons :format "%v"
					  (const :format "" "password")
418 419
					  (string :format "Password: %v"))))))
  :group 'nnimap)
Gerd Moellmann's avatar
Gerd Moellmann committed
420 421 422

(defcustom nnimap-prune-cache t
  "If non-nil, nnimap check whether articles still exist on server before using data stored in NOV cache."
423 424
  :type 'boolean
  :group 'nnimap)
Gerd Moellmann's avatar
Gerd Moellmann committed
425 426 427 428 429 430

(defvar nnimap-request-list-method 'imap-mailbox-list
  "Method to use to request a list of all folders from the server.
If this is 'imap-mailbox-lsub, then use a server-side subscription list to
restrict visible folders.")

431 432
(defcustom nnimap-id nil
  "Plist with client identity to send to server upon login.
Juanma Barranquero's avatar
Juanma Barranquero committed
433 434
A nil value means no information is sent, symbol `no' to disable ID query
altogether, or plist with identifier-value pairs to send to
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
server.  RFC 2971 describes the list as follows:

   Any string may be sent as a field, but the following are defined to
   describe certain values that might be sent.  Implementations are free
   to send none, any, or all of these.  Strings are not case-sensitive.
   Field strings MUST NOT be longer than 30 octets.  Value strings MUST
   NOT be longer than 1024 octets.  Implementations MUST NOT send more
   than 30 field-value pairs.

     name            Name of the program
     version         Version number of the program
     os              Name of the operating system
     os-version      Version of the operating system
     vendor          Vendor of the client/server
     support-url     URL to contact for support
     address         Postal address of contact/vendor
     date            Date program was released, specified as a date-time
                       in IMAP4rev1
     command         Command used to start the program
     arguments       Arguments supplied on the command line, if any
                       if any
     environment     Description of environment, i.e., UNIX environment
                       variables or Windows registry settings

   Implementations MUST NOT send the same field name more than once.

An example plist would be '(\"name\" \"Gnus\" \"version\" gnus-version-number
\"os\" system-configuration \"vendor\" \"GNU\")."
  :group 'nnimap
  :type '(choice (const :tag "No information" nil)
		 (const :tag "Disable ID query" no)
		 (plist :key-type string :value-type string)))

468
(defcustom nnimap-debug nil
Miles Bader's avatar
Miles Bader committed
469 470 471 472
  "If non-nil, trace nnimap- functions into `nnimap-debug-buffer'.
Uses `trace-function-background', so you can turn it off with,
say, `untrace-all'.

473
Note that username, passwords and other privacy sensitive
Miles Bader's avatar
Miles Bader committed
474 475 476 477 478 479
information (such as e-mail) may be stored in the buffer.
It is not written to disk, however.  Do not enable this
variable unless you are comfortable with that.

This variable only takes effect when loading the `nnimap' library.
See also `nnimap-log'."
480 481 482
  :group 'nnimap
  :type 'boolean)

Gerd Moellmann's avatar
Gerd Moellmann committed
483 484
;; Internal variables:

485 486
(defvar nnimap-debug-buffer "*nnimap-debug*")
(defvar nnimap-mailbox-info (gnus-make-hashtable 997))
Gerd Moellmann's avatar
Gerd Moellmann committed
487 488 489 490 491 492 493 494
(defvar nnimap-current-move-server nil)
(defvar nnimap-current-move-group nil)
(defvar nnimap-current-move-article nil)
(defvar nnimap-length)
(defvar nnimap-progress-chars '(?| ?/ ?- ?\\))
(defvar nnimap-progress-how-often 20)
(defvar nnimap-counter)
(defvar nnimap-server-buffer-alist nil)	;; Map server name to buffers.
495 496
(defvar nnimap-current-server nil) ;; Current server
(defvar nnimap-server-buffer nil) ;; Current servers' buffer
Gerd Moellmann's avatar
Gerd Moellmann committed
497 498 499 500 501 502 503



(nnoo-define-basics nnimap)

;; Utility functions:

Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
504 505 506 507 508 509 510 511 512 513 514 515 516 517
(defsubst nnimap-decode-group-name (group)
  (and group
       (gnus-group-decoded-name group)))

(defsubst nnimap-encode-group-name (group)
  (and group
       (mm-encode-coding-string group (gnus-group-name-charset nil group))))

(defun nnimap-group-prefixed-name (group &optional server)
  (gnus-group-prefixed-name group
			    (gnus-server-to-method
			     (format "nnimap:%s"
				     (or server nnimap-current-server)))))

Gerd Moellmann's avatar
Gerd Moellmann committed
518 519 520 521
(defsubst nnimap-get-server-buffer (server)
  "Return buffer for SERVER, if nil use current server."
  (cadr (assoc (or server nnimap-current-server) nnimap-server-buffer-alist)))

522 523 524 525 526 527 528 529
(defun nnimap-remove-server-from-buffer-alist (server list)
  "Remove SERVER from LIST."
  (let (l)
    (dolist (e list)
      (unless (equal server (car-safe e))
	(push e l)))
    l))

Gerd Moellmann's avatar
Gerd Moellmann committed
530 531 532 533 534 535 536 537
(defun nnimap-possibly-change-server (server)
  "Return buffer for SERVER, changing the current server as a side-effect.
If SERVER is nil, uses the current server."
  (setq nnimap-current-server (or server nnimap-current-server)
	nnimap-server-buffer (nnimap-get-server-buffer nnimap-current-server)))

(defun nnimap-verify-uidvalidity (group server)
  "Verify stored uidvalidity match current one in GROUP on SERVER."
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
538
  (let* ((gnusgroup (nnimap-group-prefixed-name group server))
Gerd Moellmann's avatar
Gerd Moellmann committed
539
	 (new-uidvalidity (imap-mailbox-get 'uidvalidity))
540 541
	 (old-uidvalidity (gnus-group-get-parameter gnusgroup 'uidvalidity))
	 (dir (file-name-as-directory (expand-file-name nnimap-directory)))
542 543 544 545 546 547 548
	 (nameuid (nnheader-translate-file-chars
		   (concat nnimap-nov-file-name
			   (if (equal server "")
			       "unnamed"
			     server) "." group "." old-uidvalidity
			   nnimap-nov-file-name-suffix) t))
	 (file (if (or nnmail-use-long-file-names
549 550 551 552 553 554 555
		       (file-exists-p (expand-file-name nameuid dir)))
		   (expand-file-name nameuid dir)
		 (expand-file-name
		  (mm-encode-coding-string
		   (nnheader-replace-chars-in-string nameuid ?. ?/)
		   nnmail-pathname-coding-system)
		  dir))))
Gerd Moellmann's avatar
Gerd Moellmann committed
556 557
    (if old-uidvalidity
	(if (not (equal old-uidvalidity new-uidvalidity))
558
	    ;; uidvalidity clash
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
559 560 561 562 563 564
	    (progn
	      (gnus-group-set-parameter gnusgroup 'uidvalidity new-uidvalidity)
	      (gnus-group-remove-parameter gnusgroup 'imap-status)
	      (gnus-sethash (gnus-group-prefixed-name group server)
			    nil nnimap-mailbox-info)
	      (gnus-delete-file file))
Gerd Moellmann's avatar
Gerd Moellmann committed
565 566
	  t)
      (gnus-group-add-parameter gnusgroup (cons 'uidvalidity new-uidvalidity))
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
567 568 569 570
      (gnus-group-remove-parameter gnusgroup 'imap-status)
      (gnus-sethash			; Maybe not necessary here.
       (gnus-group-prefixed-name group server)
       nil nnimap-mailbox-info)
Gerd Moellmann's avatar
Gerd Moellmann committed
571 572 573 574 575
      t)))

(defun nnimap-before-find-minmax-bugworkaround ()
  "Function called before iterating through mailboxes with
`nnimap-find-minmax-uid'."
576 577 578 579 580
  (when nnimap-need-unselect-to-notice-new-mail
    ;; XXX this is for UoW imapd problem, it doesn't notice new mail in
    ;; currently selected mailbox without a re-select/examine.
    (or (null (imap-current-mailbox nnimap-server-buffer))
	(imap-mailbox-unselect nnimap-server-buffer))))
Gerd Moellmann's avatar
Gerd Moellmann committed
581 582

(defun nnimap-find-minmax-uid (group &optional examine)
ShengHuo ZHU's avatar
Typos.  
ShengHuo ZHU committed
583
  "Find lowest and highest active article number in GROUP.
Gerd Moellmann's avatar
Gerd Moellmann committed
584 585
If EXAMINE is non-nil the group is selected read-only."
  (with-current-buffer nnimap-server-buffer
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
586 587 588 589 590
    (let ((decoded-group (nnimap-decode-group-name group)))
      (when (or (string= decoded-group (imap-current-mailbox))
		(imap-mailbox-select decoded-group examine))
	(let (minuid maxuid)
	  (when (> (imap-mailbox-get 'exists) 0)
591
	    (imap-fetch "1:*" "UID" nil 'nouidfetch)
592 593 594 595 596
	    (imap-message-map
	     (lambda (uid Uid)
	       (setq minuid (if minuid (min minuid uid) uid)
		     maxuid (if maxuid (max maxuid uid) uid)))
	     'UID))
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
597
	  (list (imap-mailbox-get 'exists) minuid maxuid))))))
598

Gerd Moellmann's avatar
Gerd Moellmann committed
599 600 601
(defun nnimap-possibly-change-group (group &optional server)
  "Make GROUP the current group, and SERVER the current server."
  (when (nnimap-possibly-change-server server)
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
    (let ((decoded-group (nnimap-decode-group-name group)))
      (with-current-buffer nnimap-server-buffer
	(if (or (null group) (imap-current-mailbox-p decoded-group))
	    imap-current-mailbox	; Note: utf-7 encoded.
	  (if (imap-mailbox-select decoded-group)
	      (if (or (nnimap-verify-uidvalidity
		       group (or server nnimap-current-server))
		      (zerop (imap-mailbox-get 'exists decoded-group))
		      t ;; for OGnus to see if ignoring uidvalidity
		      ;; changes has any bad effects.
		      (yes-or-no-p
		       (format
			"nnimap: Group %s is not uidvalid.  Continue? "
			decoded-group)))
		  imap-current-mailbox	; Note: utf-7 encoded.
		(imap-mailbox-unselect)
		(error "nnimap: Group %s is not uid-valid" decoded-group))
	    (nnheader-report 'nnimap (imap-error-text))))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644

(defun nnimap-replace-whitespace (string)
  "Return STRING with all whitespace replaced with space."
  (when string
    (while (string-match "[\r\n\t]+" string)
      (setq string (replace-match " " t t string)))
    string))

;; Required backend functions

(defun nnimap-retrieve-headers-progress ()
  "Hook to insert NOV line for current article into `nntp-server-buffer'."
  (and (numberp nnmail-large-newsgroup)
       (zerop (% (incf nnimap-counter) nnimap-progress-how-often))
       (> nnimap-length nnmail-large-newsgroup)
       (nnheader-message 6 "nnimap: Retrieving headers... %c"
			 (nth (/ (% nnimap-counter
				    (* (length nnimap-progress-chars)
				       nnimap-progress-how-often))
				 nnimap-progress-how-often)
			      nnimap-progress-chars)))
  (with-current-buffer nntp-server-buffer
    (let (headers lines chars uid mbx)
      (with-current-buffer nnimap-server-buffer
	(setq uid imap-current-message
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
645
	      mbx (nnimap-encode-group-name (imap-current-mailbox))
646 647 648 649 650
	      headers (if (imap-capability 'IMAP4rev1)
                          ;; xxx don't just use car? alist doesn't contain
                          ;; anything else now, but it might...
                          (nth 2 (car (imap-message-get uid 'BODYDETAIL)))
                        (imap-message-get uid 'RFC822.HEADER))
Gerd Moellmann's avatar
Gerd Moellmann committed
651 652 653
	      lines (imap-body-lines (imap-message-body imap-current-message))
	      chars (imap-message-get imap-current-message 'RFC822.SIZE)))
      (nnheader-insert-nov
654 655 656
       ;; At this stage, we only have bytes, so let's use unibyte buffers
       ;; to make it more clear.
       (mm-with-unibyte-buffer
Gerd Moellmann's avatar
Gerd Moellmann committed
657
	 (buffer-disable-undo)
658
	 ;; headers can be nil if article is write-only
659
	 (when headers (insert headers))
660
	 (let ((head (nnheader-parse-naked-head uid)))
Gerd Moellmann's avatar
Gerd Moellmann committed
661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
	   (mail-header-set-number head uid)
	   (mail-header-set-chars head chars)
	   (mail-header-set-lines head lines)
	   (mail-header-set-xref
	    head (format "%s %s:%d" (system-name) mbx uid))
	   head))))))

(defun nnimap-retrieve-which-headers (articles fetch-old)
  "Get a range of articles to fetch based on ARTICLES and FETCH-OLD."
  (with-current-buffer nnimap-server-buffer
    (if (numberp (car-safe articles))
	(imap-search
	 (concat "UID "
		 (imap-range-to-message-set
		  (gnus-compress-sequence
		   (append (gnus-uncompress-sequence
			    (and fetch-old
				 (cons (if (numberp fetch-old)
					   (max 1 (- (car articles) fetch-old))
					 1)
				       (1- (car articles)))))
			   articles)))))
      (mapcar (lambda (msgid)
		(imap-search
685
		 (format "HEADER Message-Id \"%s\"" msgid)))
Gerd Moellmann's avatar
Gerd Moellmann committed
686 687 688
	      articles))))

(defun nnimap-group-overview-filename (group server)
689
  "Make file name for GROUP on SERVER."
690
  (let* ((dir (file-name-as-directory (expand-file-name nnimap-directory)))
691
	 (uidvalidity (gnus-group-get-parameter
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
692
		       (nnimap-group-prefixed-name group server)
693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720
		       'uidvalidity))
	 (name (nnheader-translate-file-chars
		(concat nnimap-nov-file-name
			(if (equal server "")
			    "unnamed"
			  server) "." group nnimap-nov-file-name-suffix) t))
	 (nameuid (nnheader-translate-file-chars
		   (concat nnimap-nov-file-name
			   (if (equal server "")
			       "unnamed"
			     server) "." group "." uidvalidity
			   nnimap-nov-file-name-suffix) t))
	 (oldfile (if (or nnmail-use-long-file-names
			  (file-exists-p (expand-file-name name dir)))
		      (expand-file-name name dir)
		    (expand-file-name
		     (mm-encode-coding-string
		      (nnheader-replace-chars-in-string name ?. ?/)
		      nnmail-pathname-coding-system)
		     dir)))
	 (newfile (if (or nnmail-use-long-file-names
			  (file-exists-p (expand-file-name nameuid dir)))
		      (expand-file-name nameuid dir)
		    (expand-file-name
		     (mm-encode-coding-string
		      (nnheader-replace-chars-in-string nameuid ?. ?/)
		      nnmail-pathname-coding-system)
		     dir))))
721 722 723 724 725 726 727 728 729
    (when (and (file-exists-p oldfile) (not (file-exists-p newfile)))
      (message "nnimap: Upgrading novcache filename...")
      (sit-for 1)
      (gnus-make-directory (file-name-directory newfile))
      (unless (ignore-errors (rename-file oldfile newfile) t)
	(if (ignore-errors (copy-file oldfile newfile) t)
	    (delete-file oldfile)
	  (error "Can't rename `%s' to `%s'" oldfile newfile))))
    newfile))
Gerd Moellmann's avatar
Gerd Moellmann committed
730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762

(defun nnimap-retrieve-headers-from-file (group server)
  (with-current-buffer nntp-server-buffer
    (let ((nov (nnimap-group-overview-filename group server)))
      (when (file-exists-p nov)
	(mm-insert-file-contents nov)
	(set-buffer-modified-p nil)
	(let ((min (ignore-errors (goto-char (point-min))
				  (read (current-buffer))))
	      (max (ignore-errors (goto-char (point-max))
				  (forward-line -1)
				  (read (current-buffer)))))
	  (if (and (numberp min) (numberp max))
	      (cons min max)
	    ;; junk, remove it, it's saved later
	    (erase-buffer)
	    nil))))))

(defun nnimap-retrieve-headers-from-server (articles group server)
  (with-current-buffer nnimap-server-buffer
    (let ((imap-fetch-data-hook '(nnimap-retrieve-headers-progress))
	  (nnimap-length (gnus-range-length articles))
	  (nnimap-counter 0))
      (imap-fetch (imap-range-to-message-set articles)
		  (concat "(UID RFC822.SIZE BODY "
			  (let ((headers
				 (append '(Subject From Date Message-Id
						   References In-Reply-To Xref)
					 (copy-sequence
					  nnmail-extra-headers))))
			    (if (imap-capability 'IMAP4rev1)
				(format "BODY.PEEK[HEADER.FIELDS %s])" headers)
			      (format "RFC822.HEADER.LINES %s)" headers)))))
763
      (with-current-buffer nntp-server-buffer
764
	(sort-numeric-fields 1 (point-min) (point-max)))
Gerd Moellmann's avatar
Gerd Moellmann committed
765 766 767 768
      (and (numberp nnmail-large-newsgroup)
	   (> nnimap-length nnmail-large-newsgroup)
	   (nnheader-message 6 "nnimap: Retrieving headers...done")))))

769
(defun nnimap-dont-use-nov-p (group server)
Gerd Moellmann's avatar
Gerd Moellmann committed
770 771 772 773 774 775 776 777 778 779 780 781 782
  (or gnus-nov-is-evil nnimap-nov-is-evil
      (unless (and (gnus-make-directory
		    (file-name-directory
		     (nnimap-group-overview-filename group server)))
		   (file-writable-p
		    (nnimap-group-overview-filename group server)))
	(message "nnimap: Nov cache not writable, %s"
		 (nnimap-group-overview-filename group server)))))

(deffoo nnimap-retrieve-headers (articles &optional group server fetch-old)
  (when (nnimap-possibly-change-group group server)
    (with-current-buffer nntp-server-buffer
      (erase-buffer)
783
      (if (nnimap-dont-use-nov-p group server)
Gerd Moellmann's avatar
Gerd Moellmann committed
784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
	  (nnimap-retrieve-headers-from-server
	   (gnus-compress-sequence articles) group server)
	(let (uids cached low high)
	  (when (setq uids (nnimap-retrieve-which-headers articles fetch-old)
		      low (car uids)
		      high (car (last uids)))
	    (if (setq cached (nnimap-retrieve-headers-from-file group server))
		(progn
		  ;; fetch articles with uids before cache block
		  (when (< low (car cached))
		    (goto-char (point-min))
		    (nnimap-retrieve-headers-from-server
		     (cons low (1- (car cached))) group server))
		  ;; fetch articles with uids after cache block
		  (when (> high (cdr cached))
		    (goto-char (point-max))
		    (nnimap-retrieve-headers-from-server
		     (cons (1+ (cdr cached)) high) group server))
		  (when nnimap-prune-cache
		    ;; remove nov's for articles which has expired on server
		    (goto-char (point-min))
		    (dolist (uid (gnus-set-difference articles uids))
806 807
		      (when (re-search-forward (format "^%d\t" uid) nil t)
			(gnus-delete-line)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
808 809 810 811 812
	      ;; nothing cached, fetch whole range from server
	      (nnimap-retrieve-headers-from-server
	       (cons low high) group server))
	    (when (buffer-modified-p)
	      (nnmail-write-region
813 814
	       (point-min) (point-max)
	       (nnimap-group-overview-filename group server) nil 'nomesg))
Gerd Moellmann's avatar
Gerd Moellmann committed
815 816 817
	    (nnheader-nov-delete-outside-range low high))))
      'nov)))

818 819 820 821
(declare-function netrc-parse "netrc" (file))
(declare-function netrc-machine-user-or-password "netrc"
		  (mode authinfo-file-or-list machines ports defaults))

Gerd Moellmann's avatar
Gerd Moellmann committed
822
(defun nnimap-open-connection (server)
823 824
  ;; Note: `nnimap-open-server' that calls this function binds
  ;; `imap-logout-timeout' to `nnimap-logout-timeout'.
Gerd Moellmann's avatar
Gerd Moellmann committed
825 826 827
  (if (not (imap-open nnimap-address nnimap-server-port nnimap-stream
		      nnimap-authenticator nnimap-server-buffer))
      (nnheader-report 'nnimap "Can't open connection to server %s" server)
828
    (require 'netrc)
Gerd Moellmann's avatar
Gerd Moellmann committed
829 830 831 832
    (unless (or (imap-capability 'IMAP4 nnimap-server-buffer)
		(imap-capability 'IMAP4rev1 nnimap-server-buffer))
      (imap-close nnimap-server-buffer)
      (nnheader-report 'nnimap "Server %s is not IMAP4 compliant" server))
833 834
    (let* ((list (progn (gnus-message 7 "Parsing authinfo file `%s'."
				      nnimap-authinfo-file)
835
			(netrc-parse nnimap-authinfo-file)))
836 837 838
 	   (port (if nnimap-server-port
		     (int-to-string nnimap-server-port)
		   "imap"))
839
	   (auth-info
Miles Bader's avatar
Miles Bader committed
840 841 842
	    (auth-source-user-or-password '("login" "password") server port))
	   (auth-user (nth 0 auth-info))
	   (auth-passwd (nth 1 auth-info))
843
	   (user (or
Miles Bader's avatar
Miles Bader committed
844
		  auth-user ; this is preferred to netrc-*
Miles Bader's avatar
Miles Bader committed
845 846 847 848 849 850 851 852
		  (netrc-machine-user-or-password
		   "login"
		   list
		   (list server
			 (or nnimap-server-address
			     nnimap-address))
		   (list port)
		   (list "imap" "imaps" "143" "993"))))
853
	   (passwd (or
Miles Bader's avatar
Miles Bader committed
854
		    auth-passwd ; this is preferred to netrc-*
Miles Bader's avatar
Miles Bader committed
855 856 857 858 859 860 861 862
		    (netrc-machine-user-or-password
		     "password"
		     list
		     (list server
			   (or nnimap-server-address
			       nnimap-address))
		     (list port)
		     (list "imap" "imaps" "143" "993")))))
Gerd Moellmann's avatar
Gerd Moellmann committed
863
      (if (imap-authenticate user passwd nnimap-server-buffer)
864 865 866 867 868
	  (prog2
	      (setq nnimap-server-buffer-alist
		    (nnimap-remove-server-from-buffer-alist
		     server
		     nnimap-server-buffer-alist))
Gerd Moellmann's avatar
Gerd Moellmann committed
869 870
	      (push (list server nnimap-server-buffer)
		    nnimap-server-buffer-alist)
871
	    (imap-id nnimap-id nnimap-server-buffer)
Gerd Moellmann's avatar
Gerd Moellmann committed
872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890
	    (nnimap-possibly-change-server server))
	(imap-close nnimap-server-buffer)
	(kill-buffer nnimap-server-buffer)
	(nnheader-report 'nnimap "Could not authenticate to %s" server)))))

(deffoo nnimap-open-server (server &optional defs)
  (nnheader-init-server-buffer)
  (if (nnimap-server-opened server)
      t
    (unless (assq 'nnimap-server-buffer defs)
      (push (list 'nnimap-server-buffer (concat " *nnimap* " server)) defs))
    ;; translate `nnimap-server-address' to `nnimap-address' in defs
    ;; for people that configured nnimap with a very old version
    (unless (assq 'nnimap-address defs)
      (if (assq 'nnimap-server-address defs)
	  (push (list 'nnimap-address
		      (cadr (assq 'nnimap-server-address defs))) defs)
	(push (list 'nnimap-address server) defs)))
    (nnoo-change-server 'nnimap server defs)
891 892
    (or nnimap-server-buffer
	(setq nnimap-server-buffer (cadr (assq 'nnimap-server-buffer defs))))
Gerd Moellmann's avatar
Gerd Moellmann committed
893 894
    (with-current-buffer (get-buffer-create nnimap-server-buffer)
      (nnoo-change-server 'nnimap server defs))
895 896 897 898 899 900 901 902 903
    (let ((imap-logout-timeout nnimap-logout-timeout))
      (or (and nnimap-server-buffer
	       (imap-opened nnimap-server-buffer)
	       (if (with-current-buffer nnimap-server-buffer
		     (memq imap-state '(auth selected examine)))
		   t
		 (imap-close nnimap-server-buffer)
		 (nnimap-open-connection server)))
	  (nnimap-open-connection server)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
904 905 906 907 908 909 910 911 912 913 914 915 916 917

(deffoo nnimap-server-opened (&optional server)
  "Whether SERVER is opened.
If SERVER is the current virtual server, and the connection to the
physical server is alive, this function return a non-nil value.  If
SERVER is nil, it is treated as the current server."
  ;; clean up autologouts??
  (and (or server nnimap-current-server)
       (nnoo-server-opened 'nnimap (or server nnimap-current-server))
       (imap-opened (nnimap-get-server-buffer server))))

(deffoo nnimap-close-server (&optional server)
  "Close connection to server and free all resources connected to it.
Return nil if the server couldn't be closed for some reason."
918 919
  (let ((server (or server nnimap-current-server))
	(imap-logout-timeout nnimap-logout-timeout))
Gerd Moellmann's avatar
Gerd Moellmann committed
920 921 922 923 924 925 926
    (when (or (nnimap-server-opened server)
	      (imap-opened (nnimap-get-server-buffer server)))
      (imap-close (nnimap-get-server-buffer server))
      (kill-buffer (nnimap-get-server-buffer server))
      (setq nnimap-server-buffer nil
	    nnimap-current-server nil
	    nnimap-server-buffer-alist
927 928 929
	    (nnimap-remove-server-from-buffer-alist
	     server
	     nnimap-server-buffer-alist)))
Gerd Moellmann's avatar
Gerd Moellmann committed
930 931 932 933 934 935 936
    (nnoo-close-server 'nnimap server)))

(deffoo nnimap-request-close ()
  "Close connection to all servers and free all resources that the backend have reserved.
All buffers that have been created by that
backend should be killed.  (Not the nntp-server-buffer, though.) This
function is generally only called when Gnus is shutting down."
937 938
  (mapc (lambda (server) (nnimap-close-server (car server)))
	nnimap-server-buffer-alist)
Gerd Moellmann's avatar
Gerd Moellmann committed
939 940 941 942 943 944 945
  (setq nnimap-server-buffer-alist nil))

(deffoo nnimap-status-message (&optional server)
  "This function returns the last error message from server."
  (when (nnimap-possibly-change-server server)
    (nnoo-status-message 'nnimap server)))

946 947 948 949 950 951 952 953 954 955 956
;; We used to use a string-as-multibyte here, but it is really incorrect.
;; This function is used when we're about to insert a unibyte string
;; into a potentially multibyte buffer.  The string is either an article
;; header or body (or both?), undecoded.  When Emacs is asked to convert
;; a unibyte string to multibyte, it may either use the equivalent of
;; nothing (e.g. non-Mule XEmacs), string-make-unibyte (i.e. decode using
;; locale), string-as-multibyte (decode using emacs-internal coding system)
;; or string-to-multibyte (keep the data undecoded as a sequence of bytes).
;; Only the last one preserves the data such that we can reliably later on
;; decode the text using the mime info.
(defalias 'nnimap-demule 'mm-string-to-multibyte)
Gerd Moellmann's avatar
Gerd Moellmann committed
957

958 959
(defun nnimap-make-callback (article gnus-callback buffer)
  "Return a callback function."
960
  `(lambda ()
961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977
     (nnimap-callback ,article ,gnus-callback ,buffer)))

(defun nnimap-callback (article gnus-callback buffer)
  (when (eq article (imap-current-message))
    (remove-hook 'imap-fetch-data-hook
		 (nnimap-make-callback article gnus-callback buffer))
    (with-current-buffer buffer
      (insert
       (with-current-buffer nnimap-server-buffer
	 (nnimap-demule
	  (if (imap-capability 'IMAP4rev1)
	      ;; xxx don't just use car? alist doesn't contain
	      ;; anything else now, but it might...
	      (nth 2 (car (imap-message-get article 'BODYDETAIL)))
	    (imap-message-get article 'RFC822)))))
      (nnheader-ms-strip-cr)
      (funcall gnus-callback t))))
Gerd Moellmann's avatar
Gerd Moellmann committed
978 979

(defun nnimap-request-article-part (article part prop &optional
980
					    group server to-buffer detail)
Gerd Moellmann's avatar
Gerd Moellmann committed
981 982 983
  (when (nnimap-possibly-change-group group server)
    (let ((article (if (stringp article)
		       (car-safe (imap-search
984
				  (format "HEADER Message-Id \"%s\"" article)
Gerd Moellmann's avatar
Gerd Moellmann committed
985 986 987
				  nnimap-server-buffer))
		     article)))
      (when article
988
	(gnus-message 10 "nnimap: Fetching (part of) article %d from %s..."
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
989 990 991 992
		      article (or (nnimap-decode-group-name group)
				  (imap-current-mailbox)
				  (nnimap-decode-group-name
				   gnus-newsgroup-name)))
Gerd Moellmann's avatar
Gerd Moellmann committed
993 994 995
	(if (not nnheader-callback-function)
	    (with-current-buffer (or to-buffer nntp-server-buffer)
	      (erase-buffer)
996 997
	      (let ((data (imap-fetch article part prop nil
				      nnimap-server-buffer)))
998
		;; data can be nil if article is write-only
999 1000 1001 1002
		(when data
		  (insert (nnimap-demule (if detail
					     (nth 2 (car data))
					   data)))))
1003 1004 1005
	      (nnheader-ms-strip-cr)
	      (gnus-message
	       10 "nnimap: Fetching (part of) article %d from %s...done"
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
1006 1007 1008
	       article (or (nnimap-decode-group-name group)
			   (imap-current-mailbox)
			   (nnimap-decode-group-name gnus-newsgroup-name)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1009
	      (if (bobp)
1010
		  (nnheader-report 'nnimap "No such article %d in %s: %s"
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
1011 1012 1013 1014
				   article (or (nnimap-decode-group-name group)
					       (imap-current-mailbox)
					       (nnimap-decode-group-name
						gnus-newsgroup-name))
Gerd Moellmann's avatar
Gerd Moellmann committed
1015 1016
				   (imap-error-text nnimap-server-buffer))
		(cons group article)))
1017
	  (add-hook 'imap-fetch-data-hook
1018 1019
		    (nnimap-make-callback article
					  nnheader-callback-function
1020
					  nntp-server-buffer))
Gerd Moellmann's avatar
Gerd Moellmann committed
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
	  (imap-fetch-asynch article part nil nnimap-server-buffer)
	  (cons group article))))))

(deffoo nnimap-asynchronous-p ()
  t)

(deffoo nnimap-request-article (article &optional group server to-buffer)
  (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
      (nnimap-request-article-part
       article "BODY.PEEK[]" 'BODYDETAIL group server to-buffer 'detail)
    (nnimap-request-article-part
     article "RFC822.PEEK" 'RFC822 group server to-buffer)))

(deffoo nnimap-request-head (article &optional group server to-buffer)
  (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
      (nnimap-request-article-part
       article "BODY.PEEK[HEADER]" 'BODYDETAIL group server to-buffer 'detail)
    (nnimap-request-article-part
     article "RFC822.HEADER" 'RFC822.HEADER group server to-buffer)))

(deffoo nnimap-request-body (article &optional group server to-buffer)
  (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
      (nnimap-request-article-part
       article "BODY.PEEK[TEXT]" 'BODYDETAIL group server to-buffer 'detail)
    (nnimap-request-article-part
     article "RFC822.TEXT.PEEK" 'RFC822.TEXT group server to-buffer)))

(deffoo nnimap-request-group (group &optional server fast)
  (nnimap-request-update-info-internal
   group
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
1051
   (gnus-get-info (nnimap-group-prefixed-name group server))
Gerd Moellmann's avatar
Gerd Moellmann committed
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
   server)
  (when (nnimap-possibly-change-group group server)
    (nnimap-before-find-minmax-bugworkaround)
    (let (info)
      (cond (fast group)
	    ((null (setq info (nnimap-find-minmax-uid group t)))
	     (nnheader-report 'nnimap "Could not get active info for %s"
			      group))
	    (t
	     (nnheader-insert "211 %d %d %d %s\n" (or (nth 0 info) 0)
			      (max 1 (or (nth 1 info) 1))
			      (or (nth 2 info) 0) group)
	     (nnheader-report 'nnimap "Group %s selected" group)
	     t)))))

1067 1068 1069 1070
(defun nnimap-update-unseen (group &optional server)
  "Update the unseen count in `nnimap-mailbox-info'."
  (gnus-sethash
   (gnus-group-prefixed-name group server)
1071
   (let ((old (gnus-gethash-safe (gnus-group-prefixed-name group server)
1072 1073
				 nnimap-mailbox-info)))
     (list (nth 0 old) (nth 1 old)
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
1074 1075
	   (imap-mailbox-status (nnimap-decode-group-name group)
				'unseen nnimap-server-buffer)))
1076 1077
   nnimap-mailbox-info))

Gerd Moellmann's avatar
Gerd Moellmann committed
1078 1079 1080 1081
(defun nnimap-close-group (group &optional server)
  (with-current-buffer nnimap-server-buffer
    (when (and (imap-opened)
	       (nnimap-possibly-change-group group server))
1082
      (nnimap-update-unseen group server)
Gerd Moellmann's avatar
Gerd Moellmann committed
1083
      (case nnimap-expunge-on-close
1084 1085 1086 1087 1088 1089
	(always (progn
		  (imap-mailbox-expunge nnimap-close-asynchronous)
		  (unless nnimap-dont-close
		    (imap-mailbox-close nnimap-close-asynchronous))))
	(ask (if (and (imap-search "DELETED")
		      (gnus-y-or-n-p (format "Expunge articles in group `%s'? "
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
1090
					     (imap-current-mailbox))))
1091 1092 1093 1094 1095
		 (progn
		   (imap-mailbox-expunge nnimap-close-asynchronous)
		   (unless nnimap-dont-close
		     (imap-mailbox-close nnimap-close-asynchronous)))
	       (imap-mailbox-unselect)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
	(t (imap-mailbox-unselect)))
      (not imap-current-mailbox))))

(defun nnimap-pattern-to-list-arguments (pattern)
  (mapcar (lambda (p)
	    (cons (car-safe p) (or (cdr-safe p) p)))
	  (if (and (listp pattern)
		   (listp (cdr pattern)))
	      pattern
	    (list pattern))))

(deffoo nnimap-request-list (&optional server)
  (when (nnimap-possibly-change-server server)
    (with-current-buffer nntp-server-buffer
      (erase-buffer))
    (gnus-message 5 "nnimap: Generating active list%s..."
		  (if (> (length server) 0) (concat " for " server) ""))
    (nnimap-before-find-minmax-bugworkaround)
    (with-current-buffer nnimap-server-buffer
      (dolist (pattern (nnimap-pattern-to-list-arguments nnimap-list-pattern))
	(dolist (mbx (funcall nnimap-request-list-method
			      (cdr pattern) (car pattern)))
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127
	  (unless (member "\\noselect"
			  (mapcar #'downcase
				  (imap-mailbox-get 'list-flags mbx)))
	    (let* ((encoded-mbx (nnimap-encode-group-name mbx))
		   (info (nnimap-find-minmax-uid encoded-mbx 'examine)))
	      (when info
		(with-current-buffer nntp-server-buffer
		  (insert (format "\"%s\" %d %d y\n"
				  encoded-mbx (or (nth 2 info) 0)
				  (max 1 (or (nth 1 info) 1)))))))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
1128 1129 1130 1131 1132 1133 1134
    (gnus-message 5 "nnimap: Generating active list%s...done"
		  (if (> (length server) 0) (concat " for " server) ""))
    t))

(deffoo nnimap-request-post (&optional server)
  (let ((success t))
    (dolist (mbx (message-unquote-tokens
1135 1136
		  (message-tokenize-header
		   (message-fetch-field "Newsgroups") ", ")) success)
Gerd Moellmann's avatar
Gerd Moellmann committed
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152
      (let ((to-newsgroup (gnus-group-prefixed-name mbx gnus-command-method)))
	(or (gnus-active to-newsgroup)
	    (gnus-activate-group to-newsgroup)
	    (if (gnus-y-or-n-p (format "No such group: %s.  Create it? "
				       to-newsgroup))
		(or (and (gnus-request-create-group
			  to-newsgroup gnus-command-method)
			 (gnus-activate-group to-newsgroup nil nil
					      gnus-command-method))
		    (error "Couldn't create group %s" to-newsgroup)))
	    (error "No such group: %s" to-newsgroup))
	(unless (nnimap-request-accept-article mbx (nth 1 gnus-command-method))
	  (setq success nil))))))

;; Optional backend functions

1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
(defun nnimap-string-lessp-numerical (s1 s2)
  "Return t if first arg string is less than second in numerical order."
  (cond ((string= s1 s2)
	 nil)
	((> (length s1) (length s2))
	 nil)
	((< (length s1) (length s2))
	 t)
	((< (string-to-number (substring s1 0 1))
	    (string-to-number (substring s2 0 1)))
	 t)
	((> (string-to-number (substring s1 0 1))
	    (string-to-number (substring s2 0 1)))
	 nil)
	(t
	 (nnimap-string-lessp-numerical (substring s1 1) (substring s2 1)))))

Gerd Moellmann's avatar
Gerd Moellmann committed
1170 1171 1172 1173 1174 1175
(deffoo nnimap-retrieve-groups (groups &optional server)
  (when (nnimap-possibly-change-server server)
    (gnus-message 5 "nnimap: Checking mailboxes...")
    (with-current-buffer nntp-server-buffer
      (erase-buffer)
      (nnimap-before-find-minmax-bugworkaround)
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
1176
      (let (asyncgroups slowgroups decoded-group)
1177 1178 1179
	(if (null nnimap-retrieve-groups-asynchronous)
	    (setq slowgroups groups)
	  (dolist (group groups)
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
1180 1181 1182 1183 1184 1185
	    (setq decoded-group (nnimap-decode-group-name group))
	    (gnus-message 9 "nnimap: Quickly checking mailbox %s"
			  decoded-group)
	    (add-to-list (if (gnus-group-get-parameter
			      (nnimap-group-prefixed-name group)
			      'imap-status)
1186 1187 1188
			     'asyncgroups
			   'slowgroups)
			 (list group (imap-mailbox-status-asynch
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
1189 1190
				      decoded-group
				      '(uidvalidity uidnext unseen)
1191 1192
				      nnimap-server-buffer))))
	  (dolist (asyncgroup asyncgroups)
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
	    (let* ((group (nth 0 asyncgroup))
		   (tag   (nth 1 asyncgroup))
		   (gnusgroup (nnimap-group-prefixed-name group))
		   (saved-uidvalidity (gnus-group-get-parameter gnusgroup
								'uidvalidity))
		   (saved-imap-status (gnus-group-get-parameter gnusgroup
								'imap-status))
		   (saved-info (and saved-imap-status
				    (split-string saved-imap-status " "))))
	      (setq decoded-group (nnimap-decode-group-name group))
1203
	      (when (imap-ok-p (imap-wait-for-tag tag nnimap-server-buffer))
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
1204 1205 1206
		(if (or (not (equal
			      saved-uidvalidity
			      (imap-mailbox-get 'uidvalidity decoded-group
1207
						nnimap-server-buffer)))
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
1208 1209 1210
			(not (equal
			      (nth 0 saved-info)
			      (imap-mailbox-get 'uidnext decoded-group
1211 1212
						nnimap-server-buffer))))
		    (push (list group) slowgroups)
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224
		  (gnus-sethash
		   (gnus-group-prefixed-name group server)
		   (list (imap-mailbox-get 'uidvalidity
					   decoded-group nnimap-server-buffer)
			 (imap-mailbox-get 'uidnext
					   decoded-group nnimap-server-buffer)
			 (imap-mailbox-get 'unseen
					   decoded-group nnimap-server-buffer))
		   nnimap-mailbox-info)
		  (insert (format "\"%s\" %s %s y\n" group
				  (nth 2 saved-info)
				  (nth 1 saved-info))))))))
1225 1226 1227
	(dolist (group slowgroups)
	  (if nnimap-retrieve-groups-asynchronous
	      (setq group (car group)))
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
1228 1229 1230
	  (setq decoded-group (nnimap-decode-group-name group))
	  (gnus-message 7 "nnimap: Mailbox %s modified" decoded-group)
	  (or (member "\\NoSelect" (imap-mailbox-get 'list-flags decoded-group
1231
						     nnimap-server-buffer))
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
1232 1233 1234 1235 1236 1237 1238 1239
	      (let* ((gnusgroup (nnimap-group-prefixed-name group))
		     (status (imap-mailbox-status
			      decoded-group '(uidvalidity uidnext unseen)
			      nnimap-server-buffer))
		     (info (nnimap-find-minmax-uid group 'examine))
		     (min-uid (max 1 (or (nth 1 info) 1)))
		     (max-uid (or (nth 2 info) 0)))
		(when (> (or (imap-mailbox-get 'recent decoded-group
1240 1241
					       nnimap-server-buffer) 0)
			 0)
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257
		  (push (list (cons decoded-group 0)) nnmail-split-history))
		(insert (format "\"%s\" %d %d y\n" group max-uid min-uid))
		(gnus-sethash
		 (gnus-group-prefixed-name group server)
		 status
		 nnimap-mailbox-info)
		(if (not (equal (nth 0 status)
				(gnus-group-get-parameter gnusgroup
							  'uidvalidity)))
		    (nnimap-verify-uidvalidity group nnimap-current-server))
		;; The imap-status parameter is a string on the form
		;; "<uidnext> <min-uid> <max-uid>".
		(gnus-group-add-parameter
		 gnusgroup
		 (cons 'imap-status
		       (format "%s %s %s" (nth 1 status) min-uid max-uid))))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
1258 1259 1260 1261 1262
    (gnus-message 5 "nnimap: Checking mailboxes...done")
    'active))

(deffoo nnimap-request-update-info-internal (group info &optional server)
  (when (nnimap-possibly-change-group group server)
1263
    (when info ;; xxx what does this mean? should we create a info?
Gerd Moellmann's avatar
Gerd Moellmann committed
1264 1265
      (with-current-buffer nnimap-server-buffer
	(gnus-message 5 "nnimap: Updating info for %s..."
Katsumi Yamaoka's avatar
Katsumi Yamaoka committed
1266
		      (nnimap-decode-group-name (gnus-info-group info)))
1267

Gerd Moellmann's avatar
Gerd Moellmann committed
1268 1269 1270 1271
	(when (nnimap-mark-permanent-p 'read)
	  (let (seen unseen)
	    ;; read info could contain articles marked unread by other
	    ;; imap clients!  we correct this
1272