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

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