lisp/gnus/nnimap.el

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