cgit.sxemacs.org Git - gnus/blob - lisp/nnimap.el

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