nnimap.el 65.8 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,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
Gerd Moellmann's avatar
Gerd Moellmann committed
5 6 7 8 9 10 11

;; Author: Simon Josefsson <jas@pdc.kth.se>
;;         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
(require 'imap)
Gerd Moellmann's avatar
Gerd Moellmann committed
63 64 65 66 67 68 69 70 71
(require 'nnoo)
(require 'nnmail)
(require 'nnheader)
(require 'mm-util)
(require 'gnus)
(require 'gnus-range)
(require 'gnus-start)
(require 'gnus-int)

72 73
(eval-when-compile (require 'cl))

Gerd Moellmann's avatar
Gerd Moellmann committed
74 75
(nnoo-declare nnimap)

76 77 78 79 80
(defconst nnimap-version "nnimap 1.0")

(defgroup nnimap nil
  "Reading IMAP mail with Gnus."
  :group 'gnus)
Gerd Moellmann's avatar
Gerd Moellmann committed
81 82 83 84 85 86

(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.
87
If nil, defaults to 993 for TLS/SSL connections and 143 otherwise.")
Gerd Moellmann's avatar
Gerd Moellmann committed
88 89 90

;; Splitting variables

91
(defcustom nnimap-split-crosspost t
Gerd Moellmann's avatar
Gerd Moellmann committed
92
  "If non-nil, do crossposting if several split methods match the mail.
93 94 95
If nil, the first match found will be used."
  :group 'nnimap
  :type 'boolean)
Gerd Moellmann's avatar
Gerd Moellmann committed
96

97 98
(defcustom nnimap-split-inbox nil
  "Name of mailbox to split mail from.
Gerd Moellmann's avatar
Gerd Moellmann committed
99 100

Mail is read from this mailbox and split according to rules in
101 102 103 104 105 106 107 108 109 110 111 112 113
`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
114

115 116 117
(defun nnimap-strict-function-match (widget value)
  "Ignoring WIDGET, match if VALUE is a function."
  (functionp value))
Gerd Moellmann's avatar
Gerd Moellmann committed
118

119 120
(defcustom nnimap-split-rule nil
  "Mail will be split according to these rules.
Gerd Moellmann's avatar
Gerd Moellmann committed
121 122 123 124 125 126 127 128

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:

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

132 133 134 135
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
136 137 138 139 140 141 142 143 144 145 146 147 148 149

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:

150
\(setq nnimap-split-rule
Gerd Moellmann's avatar
Gerd Moellmann committed
151
      '((\"my1server\"    (\".*\"    ((\"ding\"    \"ding@gnus.org\")
152 153 154 155
				  (\"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
156 157 158 159 160 161

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
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
group/function elements."
  :group 'nnimap
  :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
187 188 189 190
  "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
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
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
207
analyzes the body before splitting the article.
208
If this variable is nil, bodies will not be downloaded; if this
209
variable is the symbol `default' the default behavior is
210 211 212
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."
213
  :version "22.1"
214 215 216 217 218 219 220 221
  :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'.
222
This means that errors caught by nnimap when closing the mailbox will
223 224
not prevent Gnus from updating the group status, which may be harmful.
However, it increases speed."
225
  :version "22.1"
226 227 228 229 230 231 232 233
  :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."
234
  :version "22.1"
235 236 237 238 239 240 241 242 243
  :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
244

245 246
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."
247
  :version "22.1"
248 249 250
  :type 'boolean
  :group 'nnimap)

251
(defvoo nnimap-need-unselect-to-notice-new-mail t
252 253
  "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
254

255 256 257 258 259
(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
260 261 262 263 264 265 266 267 268 269 270 271 272
;; 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

273 274 275
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
276 277 278 279 280

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.

281 282
Possible choices: gssapi, kerberos4, starttls, tls, ssl, network, shell.
See also `imap-streams' and `imap-stream-alist'.")
Gerd Moellmann's avatar
Gerd Moellmann committed
283 284 285 286 287 288 289 290 291 292 293 294 295

(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.

296 297
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
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313

(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.")

314 315 316 317 318 319
(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
320 321 322
Unlike other backends, you do not need to take special care if you
flip this variable.")

323 324 325 326 327
(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
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
(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
357 358
  "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
359 360 361 362 363 364 365 366 367 368 369 370 371 372

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.")

373 374 375 376 377 378 379 380
(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
381 382 383 384
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.")
385 386 387 388 389 390 391

(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
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
(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")
410 411
					  (string :format "Password: %v"))))))
  :group 'nnimap)
Gerd Moellmann's avatar
Gerd Moellmann committed
412 413 414

(defcustom nnimap-prune-cache t
  "If non-nil, nnimap check whether articles still exist on server before using data stored in NOV cache."
415 416
  :type 'boolean
  :group 'nnimap)
Gerd Moellmann's avatar
Gerd Moellmann committed
417 418 419 420 421 422

(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.")

423 424 425 426 427 428 429 430 431 432 433 434 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
(defcustom nnimap-id nil
  "Plist with client identity to send to server upon login.
Nil means no information is sent, symbol `no' to disable ID query
alltogheter, or plist with identifier-value pairs to send to
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)))

460
(defcustom nnimap-debug nil
461 462 463 464 465
  "If non-nil, random debug spews are placed in *nnimap-debug* buffer.
Note that username, passwords and other privacy sensitive
information (such as e-mail) may be stored in the *nnimap-debug*
buffer.  It is not written to disk, however.  Do not enable this
variable unless you are comfortable with that."
466 467 468
  :group 'nnimap
  :type 'boolean)

Gerd Moellmann's avatar
Gerd Moellmann committed
469 470
;; Internal variables:

471 472
(defvar nnimap-debug-buffer "*nnimap-debug*")
(defvar nnimap-mailbox-info (gnus-make-hashtable 997))
Gerd Moellmann's avatar
Gerd Moellmann committed
473 474 475 476 477 478 479 480
(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.
481 482
(defvar nnimap-current-server nil) ;; Current server
(defvar nnimap-server-buffer nil) ;; Current servers' buffer
Gerd Moellmann's avatar
Gerd Moellmann committed
483 484 485 486 487 488 489 490 491 492 493



(nnoo-define-basics nnimap)

;; Utility functions:

(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)))

494 495 496 497 498 499 500 501
(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
502 503 504 505 506 507 508 509 510 511 512 513
(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."
  (let* ((gnusgroup (gnus-group-prefixed-name
		     group (gnus-server-to-method
			    (format "nnimap:%s" server))))
	 (new-uidvalidity (imap-mailbox-get 'uidvalidity))
514 515
	 (old-uidvalidity (gnus-group-get-parameter gnusgroup 'uidvalidity))
	 (dir (file-name-as-directory (expand-file-name nnimap-directory)))
516 517 518 519 520 521 522
	 (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
523 524 525 526 527 528 529
		       (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
530 531
    (if old-uidvalidity
	(if (not (equal old-uidvalidity new-uidvalidity))
532 533
	    ;; uidvalidity clash
	    (gnus-delete-file file)
Gerd Moellmann's avatar
Gerd Moellmann committed
534 535 536 537 538 539 540 541
	  (gnus-group-set-parameter gnusgroup 'uidvalidity new-uidvalidity)
	  t)
      (gnus-group-add-parameter gnusgroup (cons 'uidvalidity new-uidvalidity))
      t)))

(defun nnimap-before-find-minmax-bugworkaround ()
  "Function called before iterating through mailboxes with
`nnimap-find-minmax-uid'."
542 543 544 545 546
  (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
547 548

(defun nnimap-find-minmax-uid (group &optional examine)
ShengHuo ZHU's avatar
Typos.  
ShengHuo ZHU committed
549
  "Find lowest and highest active article number in GROUP.
Gerd Moellmann's avatar
Gerd Moellmann committed
550 551
If EXAMINE is non-nil the group is selected read-only."
  (with-current-buffer nnimap-server-buffer
552 553
    (when (or (string= group (imap-current-mailbox))
	      (imap-mailbox-select group examine))
Gerd Moellmann's avatar
Gerd Moellmann committed
554 555
      (let (minuid maxuid)
	(when (> (imap-mailbox-get 'exists) 0)
Miles Bader's avatar
Miles Bader committed
556 557
	  (imap-fetch (if imap-enable-exchange-bug-workaround "1,*:*" "1,*")
		      "UID" nil 'nouidfetch)
Gerd Moellmann's avatar
Gerd Moellmann committed
558 559 560 561 562
	  (imap-message-map (lambda (uid Uid)
			      (setq minuid (if minuid (min minuid uid) uid)
				    maxuid (if maxuid (max maxuid uid) uid)))
			    'UID))
	(list (imap-mailbox-get 'exists) minuid maxuid)))))
563

Gerd Moellmann's avatar
Gerd Moellmann committed
564 565 566 567 568 569 570 571 572 573
(defun nnimap-possibly-change-group (group &optional server)
  "Make GROUP the current group, and SERVER the current server."
  (when (nnimap-possibly-change-server server)
    (with-current-buffer nnimap-server-buffer
      (if (or (null group) (imap-current-mailbox-p group))
	  imap-current-mailbox
	(if (imap-mailbox-select group)
	    (if (or (nnimap-verify-uidvalidity
		     group (or server nnimap-current-server))
		    (zerop (imap-mailbox-get 'exists group))
574 575
		    t ;; for OGnus to see if ignoring uidvalidity
		    ;; changes has any bad effects.
Gerd Moellmann's avatar
Gerd Moellmann committed
576 577 578 579 580
		    (yes-or-no-p
		     (format
		      "nnimap: Group %s is not uidvalid.  Continue? " group)))
		imap-current-mailbox
	      (imap-mailbox-unselect)
581
	      (error "nnimap: Group %s is not uid-valid" group))
Gerd Moellmann's avatar
Gerd Moellmann committed
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
	  (nnheader-report 'nnimap (imap-error-text)))))))

(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
	      mbx imap-current-mailbox
	      headers (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 uid 'BODYDETAIL)))
			 (imap-message-get uid 'RFC822.HEADER)))
	      lines (imap-body-lines (imap-message-body imap-current-message))
	      chars (imap-message-get imap-current-message 'RFC822.SIZE)))
      (nnheader-insert-nov
618 619 620
       ;; 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
621 622
	 (buffer-disable-undo)
	 (insert headers)
623
	 (let ((head (nnheader-parse-naked-head uid)))
Gerd Moellmann's avatar
Gerd Moellmann committed
624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
	   (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
648
		 (format "HEADER Message-Id \"%s\"" msgid)))
Gerd Moellmann's avatar
Gerd Moellmann committed
649 650 651
	      articles))))

(defun nnimap-group-overview-filename (group server)
652
  "Make file name for GROUP on SERVER."
653
  (let* ((dir (file-name-as-directory (expand-file-name nnimap-directory)))
654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
	 (uidvalidity (gnus-group-get-parameter
		       (gnus-group-prefixed-name
			group (gnus-server-to-method
			       (format "nnimap:%s" server)))
		       '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))))
686 687 688 689 690 691 692 693 694
    (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
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 721 722 723 724 725 726 727

(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)))))
728
      (with-current-buffer nntp-server-buffer
729
	(sort-numeric-fields 1 (point-min) (point-max)))
Gerd Moellmann's avatar
Gerd Moellmann committed
730 731 732 733
      (and (numberp nnmail-large-newsgroup)
	   (> nnimap-length nnmail-large-newsgroup)
	   (nnheader-message 6 "nnimap: Retrieving headers...done")))))

734
(defun nnimap-dont-use-nov-p (group server)
Gerd Moellmann's avatar
Gerd Moellmann committed
735 736 737 738 739 740 741 742 743 744 745 746 747
  (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)
748
      (if (nnimap-dont-use-nov-p group server)
Gerd Moellmann's avatar
Gerd Moellmann committed
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
	  (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))
771 772
		      (when (re-search-forward (format "^%d\t" uid) nil t)
			(gnus-delete-line)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
773 774 775 776 777
	      ;; nothing cached, fetch whole range from server
	      (nnimap-retrieve-headers-from-server
	       (cons low high) group server))
	    (when (buffer-modified-p)
	      (nnmail-write-region
778 779
	       (point-min) (point-max)
	       (nnimap-group-overview-filename group server) nil 'nomesg))
Gerd Moellmann's avatar
Gerd Moellmann committed
780 781 782 783
	    (nnheader-nov-delete-outside-range low high))))
      'nov)))

(defun nnimap-open-connection (server)
784 785
  ;; Note: `nnimap-open-server' that calls this function binds
  ;; `imap-logout-timeout' to `nnimap-logout-timeout'.
Gerd Moellmann's avatar
Gerd Moellmann committed
786 787 788 789 790 791 792
  (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)
    (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))
793 794
    (let* ((list (progn (gnus-message 7 "Parsing authinfo file `%s'."
				      nnimap-authinfo-file)
795 796 797 798 799 800 801 802 803 804 805
			(netrc-parse nnimap-authinfo-file)))
 	   (port (if nnimap-server-port
 		     (int-to-string nnimap-server-port)
 		   "imap"))
	   (user (netrc-machine-user-or-password
		  "login"
		  list
		  (list server
			(or nnimap-server-address
			    nnimap-address))
		  (list port)
Miles Bader's avatar
Miles Bader committed
806
		  (list "imap" "imaps" "143" "993")))
807 808 809 810 811 812 813
	   (passwd (netrc-machine-user-or-password
		    "password"
		    list
		    (list server
			  (or nnimap-server-address
			      nnimap-address))
		    (list port)
Miles Bader's avatar
Miles Bader committed
814
		    (list "imap" "imaps" "143" "993"))))
Gerd Moellmann's avatar
Gerd Moellmann committed
815
      (if (imap-authenticate user passwd nnimap-server-buffer)
816 817 818 819 820
	  (prog2
	      (setq nnimap-server-buffer-alist
		    (nnimap-remove-server-from-buffer-alist
		     server
		     nnimap-server-buffer-alist))
Gerd Moellmann's avatar
Gerd Moellmann committed
821 822
	      (push (list server nnimap-server-buffer)
		    nnimap-server-buffer-alist)
823
	    (imap-id nnimap-id nnimap-server-buffer)
Gerd Moellmann's avatar
Gerd Moellmann committed
824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
	    (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)
843 844
    (or nnimap-server-buffer
	(setq nnimap-server-buffer (cadr (assq 'nnimap-server-buffer defs))))
Gerd Moellmann's avatar
Gerd Moellmann committed
845 846
    (with-current-buffer (get-buffer-create nnimap-server-buffer)
      (nnoo-change-server 'nnimap server defs))
847 848 849 850 851 852 853 854 855
    (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
856 857 858 859 860 861 862 863 864 865 866 867 868 869

(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."
870 871
  (let ((server (or server nnimap-current-server))
	(imap-logout-timeout nnimap-logout-timeout))
Gerd Moellmann's avatar
Gerd Moellmann committed
872 873 874 875 876 877 878
    (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
879 880 881
	    (nnimap-remove-server-from-buffer-alist
	     server
	     nnimap-server-buffer-alist)))
Gerd Moellmann's avatar
Gerd Moellmann committed
882 883 884 885 886 887 888
    (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."
889 890
  (mapc (lambda (server) (nnimap-close-server (car server)))
	nnimap-server-buffer-alist)
Gerd Moellmann's avatar
Gerd Moellmann committed
891 892 893 894 895 896 897 898
  (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)))

(defun nnimap-demule (string)
899 900 901
  ;; BEWARE: we used to use string-as-multibyte here which is braindead
  ;; because it will turn accidental emacs-mule-valid byte sequences
  ;; into multibyte chars.  --Stef
902 903 904 905 906
  ;; Reverted, braindead got 7.5 out of 10 on imdb, so it can't be
  ;; that bad. --Simon
  (funcall (if (and (fboundp 'string-as-multibyte)
		    (subrp (symbol-function 'string-as-multibyte)))
	       'string-as-multibyte
Gerd Moellmann's avatar
Gerd Moellmann committed
907 908 909
	     'identity)
	   (or string "")))

910 911
(defun nnimap-make-callback (article gnus-callback buffer)
  "Return a callback function."
912
  `(lambda ()
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
     (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
930 931

(defun nnimap-request-article-part (article part prop &optional
932
					    group server to-buffer detail)
Gerd Moellmann's avatar
Gerd Moellmann committed
933 934 935
  (when (nnimap-possibly-change-group group server)
    (let ((article (if (stringp article)
		       (car-safe (imap-search
936
				  (format "HEADER Message-Id \"%s\"" article)
Gerd Moellmann's avatar
Gerd Moellmann committed
937 938 939
				  nnimap-server-buffer))
		     article)))
      (when article
940 941 942
	(gnus-message 10 "nnimap: Fetching (part of) article %d from %s..."
		      article (or group imap-current-mailbox
				  gnus-newsgroup-name))
Gerd Moellmann's avatar
Gerd Moellmann committed
943 944 945
	(if (not nnheader-callback-function)
	    (with-current-buffer (or to-buffer nntp-server-buffer)
	      (erase-buffer)
946 947 948 949 950 951 952 953 954
	      (let ((data (imap-fetch article part prop nil
				      nnimap-server-buffer)))
		(insert (nnimap-demule (if detail
					   (nth 2 (car data))
					 data))))
	      (nnheader-ms-strip-cr)
	      (gnus-message
	       10 "nnimap: Fetching (part of) article %d from %s...done"
	       article (or group imap-current-mailbox gnus-newsgroup-name))
Gerd Moellmann's avatar
Gerd Moellmann committed
955
	      (if (bobp)
956 957 958
		  (nnheader-report 'nnimap "No such article %d in %s: %s"
				   article (or group imap-current-mailbox
					       gnus-newsgroup-name)
Gerd Moellmann's avatar
Gerd Moellmann committed
959 960
				   (imap-error-text nnimap-server-buffer))
		(cons group article)))
961
	  (add-hook 'imap-fetch-data-hook
962 963
		    (nnimap-make-callback article
					  nnheader-callback-function
964
					  nntp-server-buffer))
Gerd Moellmann's avatar
Gerd Moellmann committed
965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
	  (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
   (gnus-get-info (gnus-group-prefixed-name
		   group (gnus-server-to-method (format "nnimap:%s" server))))
   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)))))

1012 1013 1014 1015
(defun nnimap-update-unseen (group &optional server)
  "Update the unseen count in `nnimap-mailbox-info'."
  (gnus-sethash
   (gnus-group-prefixed-name group server)
1016
   (let ((old (gnus-gethash-safe (gnus-group-prefixed-name group server)
1017 1018 1019 1020 1021 1022
				 nnimap-mailbox-info)))
     (list (nth 0 old) (nth 1 old)
	   (imap-mailbox-status group 'unseen nnimap-server-buffer)
	   (nth 3 old)))
   nnimap-mailbox-info))

Gerd Moellmann's avatar
Gerd Moellmann committed
1023 1024 1025 1026
(defun nnimap-close-group (group &optional server)
  (with-current-buffer nnimap-server-buffer
    (when (and (imap-opened)
	       (nnimap-possibly-change-group group server))
1027
      (nnimap-update-unseen group server)
Gerd Moellmann's avatar
Gerd Moellmann committed
1028
      (case nnimap-expunge-on-close
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
	(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'? "
					     imap-current-mailbox)))
		 (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
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
	(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)))
	  (or (member "\\NoSelect" (imap-mailbox-get 'list-flags mbx))
	      (let ((info (nnimap-find-minmax-uid mbx 'examine)))
		(when info
		  (with-current-buffer nntp-server-buffer
1067 1068 1069
		    (insert (format "\"%s\" %d %d y\n"
				    mbx (or (nth 2 info) 0)
				    (max 1 (or (nth 1 info) 1)))))))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
1070 1071 1072 1073 1074 1075 1076
    (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
1077 1078
		  (message-tokenize-header
		   (message-fetch-field "Newsgroups") ", ")) success)
Gerd Moellmann's avatar
Gerd Moellmann committed
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
      (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

1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
(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
1112 1113 1114 1115 1116 1117
(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)
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128
      (let (asyncgroups slowgroups)
	(if (null nnimap-retrieve-groups-asynchronous)
	    (setq slowgroups groups)
	  (dolist (group groups)
	    (gnus-message 9 "nnimap: Quickly checking mailbox %s" group)
	    (add-to-list (if (gnus-gethash-safe
			      (gnus-group-prefixed-name group server)
			      nnimap-mailbox-info)
			     'asyncgroups
			   'slowgroups)
			 (list group (imap-mailbox-status-asynch
1129
				      group '(uidvalidity uidnext unseen)
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139
				      nnimap-server-buffer))))
	  (dolist (asyncgroup asyncgroups)
	    (let ((group (nth 0 asyncgroup))
		  (tag   (nth 1 asyncgroup))
		  new old)
	      (when (imap-ok-p (imap-wait-for-tag tag nnimap-server-buffer))
		(if (or (not (string=
			      (nth 0 (gnus-gethash (gnus-group-prefixed-name
						    group server)
						   nnimap-mailbox-info))
1140
			      (imap-mailbox-get 'uidvalidity group
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184
						nnimap-server-buffer)))
			(not (string=
			      (nth 1 (gnus-gethash (gnus-group-prefixed-name
						    group server)
						   nnimap-mailbox-info))
			      (imap-mailbox-get 'uidnext group
						nnimap-server-buffer))))
		    (push (list group) slowgroups)
		  (insert (nth 3 (gnus-gethash (gnus-group-prefixed-name
						group server)
					       nnimap-mailbox-info))))))))
	(dolist (group slowgroups)
	  (if nnimap-retrieve-groups-asynchronous
	      (setq group (car group)))
	  (gnus-message 7 "nnimap: Mailbox %s modified" group)
	  (imap-mailbox-put 'uidnext nil group nnimap-server-buffer)
	  (or (member "\\NoSelect" (imap-mailbox-get 'list-flags group
						     nnimap-server-buffer))
	      (let* ((info (nnimap-find-minmax-uid group 'examine))
		     (str (format "\"%s\" %d %d y\n" group
				  (or (nth 2 info) 0)
				  (max 1 (or (nth 1 info) 1)))))
		(when (> (or (imap-mailbox-get 'recent group
					       nnimap-server-buffer) 0)
			 0)
		  (push (list (cons group 0)) nnmail-split-history))
		(insert str)
		(when nnimap-retrieve-groups-asynchronous
		  (gnus-sethash
		   (gnus-group-prefixed-name group server)
		   (list (or (imap-mailbox-get
			      'uidvalidity group nnimap-server-buffer)
			     (imap-mailbox-status
			      group 'uidvalidity nnimap-server-buffer))
			 (or (imap-mailbox-get
			      'uidnext group nnimap-server-buffer)
			     (imap-mailbox-status
			      group 'uidnext nnimap-server-buffer))
			 (or (imap-mailbox-get
			      'unseen group nnimap-server-buffer)
			     (imap-mailbox-status
			      group 'unseen nnimap-server-buffer))
			 str)
		   nnimap-mailbox-info)))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
1185 1186 1187 1188 1189
    (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)
1190
    (when info ;; xxx what does this mean? should we create a info?
Gerd Moellmann's avatar
Gerd Moellmann committed
1191 1192 1193
      (with-current-buffer nnimap-server-buffer
	(gnus-message 5 "nnimap: Updating info for %s..."
		      (gnus-info-group info))
1194

Gerd Moellmann's avatar
Gerd Moellmann committed
1195 1196 1197 1198
	(when (nnimap-mark-permanent-p 'read)
	  (let (seen unseen)
	    ;; read info could contain articles marked unread by other
	    ;; imap clients!  we correct this
1199 1200 1201 1202 1203 1204
	    (setq unseen (gnus-compress-sequence
			  (imap-search "UNSEEN UNDELETED"))
		  seen (gnus-range-difference (gnus-info-read info) unseen)
		  seen (gnus-range-add seen
				       (gnus-compress-sequence
					(imap-search "SEEN")))
Gerd Moellmann's avatar
Gerd Moellmann committed
1205 1206 1207 1208 1209 1210
		  seen (if (and (integerp (car seen))
				(null (cdr seen)))
			   (list (cons (car seen) (car seen)))
			 seen))
	    (gnus-info-set-read info seen)))

1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223
	(dolist (pred gnus-article-mark-lists)
	  (when (or (eq (cdr pred) 'recent)
		    (and (nnimap-mark-permanent-p (cdr pred))
			 (member (nnimap-mark-to-flag (cdr pred))
				 (imap-mailbox-get 'flags))))
	    (gnus-info-set-marks
	     info
	     (gnus-update-alist-soft
	      (cdr pred)
	      (gnus-compress-sequence
	       (imap-search (nnimap-mark-to-predicate (cdr pred))))
	      (gnus-info-marks info))
	     t)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1224

1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
	(when nnimap-importantize-dormant
	  ;; nnimap mark dormant article as ticked too (for other clients)
	  ;; so we remove that mark for gnus since we support dormant
	  (gnus-info-set-marks
	   info
	   (gnus-update-alist-soft
	    'tick
	    (gnus-remove-from-range
	     (cdr-safe (assoc 'tick (gnus-info-marks info)))
	     (cdr-safe (assoc 'dormant (gnus-info-marks info))))
	    (gnus-info-marks info))
	   t))
1237

Gerd Moellmann's avatar
Gerd Moellmann committed
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257
	(gnus-message 5 "nnimap: Updating info for %s...done"
		      (gnus-info-group info))

	info))))

(deffoo nnimap-request-type (group &optional article)
  (if (and nnimap-news-groups (string-match nnimap-news-groups group))
      'news
    'mail))

(deffoo nnimap-request-set-mark (group actions &optional server)
  (when (nnimap-possibly-change-group group server)
    (with-current-buffer nnimap-server-buffer
      (let (action)
	(gnus-message 7 "nnimap: Setting marks in %s..." group)
	(while (setq action (pop actions))
	  (let ((range (nth 0 action))
		(what  (nth 1 action))
		(cmdmarks (nth 2 action))
		marks)
1258 1259 1260 1261 1262 1263
	    ;; bookmark can't be stored (not list/range
	    (setq cmdmarks (delq 'bookmark cmdmarks))
	    ;; killed can't be stored (not list/range
	    (setq cmdmarks (delq 'killed cmdmarks))
	    ;; unsent are for nndraft groups only
	    (setq cmdmarks (delq 'unsent cmdmarks))
Gerd Moellmann's avatar
Gerd Moellmann committed
1264 1265
	    ;; cache flags are pointless on the server
	    (setq cmdmarks (delq 'cache cmdmarks))
1266 1267 1268 1269 1270 1271 1272 1273
	    ;; seen flags are local to each gnus
	    (setq cmdmarks (delq 'seen cmdmarks))
	    ;; recent marks can't be set
	    (setq cmdmarks (delq 'recent cmdmarks))
	    (when nnimap-importantize-dormant
	      ;; flag dormant articles as ticked
	      (if (memq 'dormant cmdmarks)
		  (setq cmdmarks (cons 'tick cmdmarks))))
Gerd Moellmann's avatar
Gerd Moellmann committed
1274
	    ;; remove stuff we are forbidden to store
1275 1276 1277 1278 1279
	    (mapc (lambda (mark)
		    (if (imap-message-flag-permanent-p
			 (nnimap-mark-to-flag mark))
			(setq marks (cons mark marks))))
		  cmdmarks)
Gerd Moellmann's avatar
Gerd Moellmann committed
1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296
	    (when (and range marks)
	      (cond ((eq what 'del)
		     (imap-message-flags-del
		      (imap-range-to-message-set range)
		      (nnimap-mark-to-flag marks nil t)))
		    ((eq what 'add)
		     (imap-message-flags-add
		      (imap-range-to-message-set range)
		      (nnimap-mark-to-flag marks nil t)))
		    ((eq what 'set)
		     (imap-message-flags-set
		      (imap-range-to-message-set range)
		      (nnimap-mark-to-flag marks nil t)))))))
	(gnus-message 7 "nnimap: Setting marks in %s...done" group))))
  nil)

(defun nnimap-split-fancy ()
1297
  "Like the function `nnmail-split-fancy', but uses `nnimap-split-fancy'."
Gerd Moellmann's avatar
Gerd Moellmann committed
1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
  (let ((nnmail-split-fancy nnimap-split-fancy))
    (nnmail-split-fancy)))

(defun nnimap-split-to-groups (rules)
  ;; tries to match all rules in nnimap-split-rule against content of
  ;; nntp-server-buffer, returns a list of groups that matched.
  (with-current-buffer nntp-server-buffer
    ;; Fold continuation lines.
    (goto-char (point-min))
    (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
      (replace-match " " t t))
    (if (functionp rules)
	(funcall rules)
      (let (to-groups regrepp)
	(catch 'split-done
	  (dolist (rule rules to-groups)
	    (let ((group (car rule))
		  (regexp (cadr rule)))
	      (goto-char (point-min))
	      (when (and (if (stringp regexp)
			     (progn
1319 1320 1321 1322
			       (if (not (stringp group))
				   (setq group (eval group))
				 (setq regrepp
				       (string-match "\\\\[0-9&]" group)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
			       (re-search-forward regexp nil t))
			   (funcall regexp group))
			 ;; Don't enter the article into the same group twice.
			 (not (assoc group to-groups)))
		(push (if regrepp
			  (nnmail-expand-newtext group)
			group)
		      to-groups)
		(or nnimap-split-crosspost
		    (throw 'split-done to-groups))))))))))
1333

Gerd Moellmann's avatar
Gerd Moellmann committed
1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
(defun nnimap-assoc-match (key alist)
  (let (element)
    (while (and alist (not element))
      (if (string-match (car (car alist)) key)
	  (setq element (car alist)))
      (setq alist (cdr alist)))
    element))

(defun nnimap-split-find-rule (server inbox)
  (if (and (listp nnimap-split-rule) (listp (car nnimap-split-rule))
1344
	   (list (cdar nnimap-split-rule)) (listp (cadar nnimap-split-rule)))
Gerd Moellmann's avatar
Gerd Moellmann committed
1345
      ;; extended format
1346
      (cadr (nnimap-assoc-match inbox (cdr (nnimap-assoc-match
Gerd Moellmann's avatar
Gerd Moellmann committed
1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
					    server nnimap-split-rule))))
    nnimap-split-rule))

(defun nnimap-split-find-inbox (server)
  (if (listp nnimap-split-inbox)
      nnimap-split-inbox
    (list nnimap-split-inbox)))

(defun nnimap-split-articles (&optional group server)
  (when (nnimap-possibly-change-server server)
    (with-current-buffer nnimap-server-buffer
      (let (rule inbox removeorig (inboxes (nnimap-split-find-inbox server)))
	;; iterate over inboxes
	(while (and (setq inbox (pop inboxes))
1361
		    (nnimap-possibly-change-group inbox)) ;; SELECT
Gerd Moellmann's avatar
Gerd Moellmann committed
1362 1363 1364 1365
	  ;; find split rule for this server / inbox
	  (when (setq rule (nnimap-split-find-rule server inbox))
	    ;; iterate over articles
	    (dolist (article (imap-search nnimap-split-predicate))
1366 1367 1368 1369 1370 1371
	      (when (if (if (eq nnimap-split-download-body 'default)
			    nnimap-split-download-body-default
			  nnimap-split-download-body)
			(and (nnimap-request-article article)
			     (with-current-buffer nntp-server-buffer (mail-narrow-to-head)))
		      (nnimap-request-head article))
Gerd Moellmann's avatar
Gerd Moellmann committed
1372