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