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        (with-temp-buffer
 621          (buffer-disable-undo)
 622          (insert headers)
 623          (let ((head (nnheader-parse-naked-head uid)))
 624            (mail-header-set-number head uid)
 625            (mail-header-set-chars head chars)
 626            (mail-header-set-lines head lines)
 627            (mail-header-set-xref
 628             head (format "%s %s:%d" (system-name) mbx uid))
 629            head))))))
 630
 631 (defun nnimap-retrieve-which-headers (articles fetch-old)
 632   "Get a range of articles to fetch based on ARTICLES and FETCH-OLD."
 633   (with-current-buffer nnimap-server-buffer
 634     (if (numberp (car-safe articles))
 635         (imap-search
 636          (concat "UID "
 637                  (imap-range-to-message-set
 638                   (gnus-compress-sequence
 639                    (append (gnus-uncompress-sequence
 640                             (and fetch-old
 641                                  (cons (if (numberp fetch-old)
 642                                            (max 1 (- (car articles) fetch-old))
 643                                          1)
 644                                        (1- (car articles)))))
 645                            articles)))))
 646       (mapcar (lambda (msgid)
 647                 (imap-search
 648                  (format "HEADER Message-Id \"%s\"" msgid)))
 649               articles))))
 650
 651 (defun nnimap-group-overview-filename (group server)
 652   "Make file name for GROUP on SERVER."
 653   (let* ((dir (file-name-as-directory (expand-file-name nnimap-directory)))
 654          (uidvalidity (gnus-group-get-parameter
 655                        (gnus-group-prefixed-name
 656                         group (gnus-server-to-method
 657                                (format "nnimap:%s" server)))
 658                        'uidvalidity))
 659          (name (nnheader-translate-file-chars
 660                 (concat nnimap-nov-file-name
 661                         (if (equal server "")
 662                             "unnamed"
 663                           server) "." group nnimap-nov-file-name-suffix) t))
 664          (nameuid (nnheader-translate-file-chars
 665                    (concat nnimap-nov-file-name
 666                            (if (equal server "")
 667                                "unnamed"
 668                              server) "." group "." uidvalidity
 669                            nnimap-nov-file-name-suffix) t))
 670          (oldfile (if (or nnmail-use-long-file-names
 671                           (file-exists-p (expand-file-name name dir)))
 672                       (expand-file-name name dir)
 673                     (expand-file-name
 674                      (mm-encode-coding-string
 675                       (nnheader-replace-chars-in-string name ?. ?/)
 676                       nnmail-pathname-coding-system)
 677                      dir)))
 678          (newfile (if (or nnmail-use-long-file-names
 679                           (file-exists-p (expand-file-name nameuid dir)))
 680                       (expand-file-name nameuid dir)
 681                     (expand-file-name
 682                      (mm-encode-coding-string
 683                       (nnheader-replace-chars-in-string nameuid ?. ?/)
 684                       nnmail-pathname-coding-system)
 685                      dir))))
 686     (when (and (file-exists-p oldfile) (not (file-exists-p newfile)))
 687       (message "nnimap: Upgrading novcache filename...")
 688       (sit-for 1)
 689       (gnus-make-directory (file-name-directory newfile))
 690       (unless (ignore-errors (rename-file oldfile newfile) t)
 691         (if (ignore-errors (copy-file oldfile newfile) t)
 692             (delete-file oldfile)
 693           (error "Can't rename `%s' to `%s'" oldfile newfile))))
 694     newfile))
 695
 696 (defun nnimap-retrieve-headers-from-file (group server)
 697   (with-current-buffer nntp-server-buffer
 698     (let ((nov (nnimap-group-overview-filename group server)))
 699       (when (file-exists-p nov)
 700         (mm-insert-file-contents nov)
 701         (set-buffer-modified-p nil)
 702         (let ((min (ignore-errors (goto-char (point-min))
 703                                   (read (current-buffer))))
 704               (max (ignore-errors (goto-char (point-max))
 705                                   (forward-line -1)
 706                                   (read (current-buffer)))))
 707           (if (and (numberp min) (numberp max))
 708               (cons min max)
 709             ;; junk, remove it, it's saved later
 710             (erase-buffer)
 711             nil))))))
 712
 713 (defun nnimap-retrieve-headers-from-server (articles group server)
 714   (with-current-buffer nnimap-server-buffer
 715     (let ((imap-fetch-data-hook '(nnimap-retrieve-headers-progress))
 716           (nnimap-length (gnus-range-length articles))
 717           (nnimap-counter 0))
 718       (imap-fetch (imap-range-to-message-set articles)
 719                   (concat "(UID RFC822.SIZE BODY "
 720                           (let ((headers
 721                                  (append '(Subject From Date Message-Id
 722                                                    References In-Reply-To Xref)
 723                                          (copy-sequence
 724                                           nnmail-extra-headers))))
 725                             (if (imap-capability 'IMAP4rev1)
 726                                 (format "BODY.PEEK[HEADER.FIELDS %s])" headers)
 727                               (format "RFC822.HEADER.LINES %s)" headers)))))
 728       (with-current-buffer nntp-server-buffer
 729         (sort-numeric-fields 1 (point-min) (point-max)))
 730       (and (numberp nnmail-large-newsgroup)
 731            (> nnimap-length nnmail-large-newsgroup)
 732            (nnheader-message 6 "nnimap: Retrieving headers...done")))))
 733
 734 (defun nnimap-dont-use-nov-p (group server)
 735   (or gnus-nov-is-evil nnimap-nov-is-evil
 736       (unless (and (gnus-make-directory
 737                     (file-name-directory
 738                      (nnimap-group-overview-filename group server)))
 739                    (file-writable-p
 740                     (nnimap-group-overview-filename group server)))
 741         (message "nnimap: Nov cache not writable, %s"
 742                  (nnimap-group-overview-filename group server)))))
 743
 744 (deffoo nnimap-retrieve-headers (articles &optional group server fetch-old)
 745   (when (nnimap-possibly-change-group group server)
 746     (with-current-buffer nntp-server-buffer
 747       (erase-buffer)
 748       (if (nnimap-dont-use-nov-p group server)
 749           (nnimap-retrieve-headers-from-server
 750            (gnus-compress-sequence articles) group server)
 751         (let (uids cached low high)
 752           (when (setq uids (nnimap-retrieve-which-headers articles fetch-old)
 753                       low (car uids)
 754                       high (car (last uids)))
 755             (if (setq cached (nnimap-retrieve-headers-from-file group server))
 756                 (progn
 757                   ;; fetch articles with uids before cache block
 758                   (when (< low (car cached))
 759                     (goto-char (point-min))
 760                     (nnimap-retrieve-headers-from-server
 761                      (cons low (1- (car cached))) group server))
 762                   ;; fetch articles with uids after cache block
 763                   (when (> high (cdr cached))
 764                     (goto-char (point-max))
 765                     (nnimap-retrieve-headers-from-server
 766                      (cons (1+ (cdr cached)) high) group server))
 767                   (when nnimap-prune-cache
 768                     ;; remove nov's for articles which has expired on server
 769                     (goto-char (point-min))
 770                     (dolist (uid (gnus-set-difference articles uids))
 771                       (when (re-search-forward (format "^%d\t" uid) nil t)
 772                         (gnus-delete-line)))))
 773               ;; nothing cached, fetch whole range from server
 774               (nnimap-retrieve-headers-from-server
 775                (cons low high) group server))
 776             (when (buffer-modified-p)
 777               (nnmail-write-region
 778                (point-min) (point-max)
 779                (nnimap-group-overview-filename group server) nil 'nomesg))
 780             (nnheader-nov-delete-outside-range low high))))
 781       'nov)))
 782
 783 (defun nnimap-open-connection (server)
 784   ;; Note: `nnimap-open-server' that calls this function binds
 785   ;; `imap-logout-timeout' to `nnimap-logout-timeout'.
 786   (if (not (imap-open nnimap-address nnimap-server-port nnimap-stream
 787                       nnimap-authenticator nnimap-server-buffer))
 788       (nnheader-report 'nnimap "Can't open connection to server %s" server)
 789     (unless (or (imap-capability 'IMAP4 nnimap-server-buffer)
 790                 (imap-capability 'IMAP4rev1 nnimap-server-buffer))
 791       (imap-close nnimap-server-buffer)
 792       (nnheader-report 'nnimap "Server %s is not IMAP4 compliant" server))
 793     (let* ((list (progn (gnus-message 7 "Parsing authinfo file `%s'."
 794                                       nnimap-authinfo-file)
 795                         (netrc-parse nnimap-authinfo-file)))
 796            (port (if nnimap-server-port
 797                      (int-to-string nnimap-server-port)
 798                    "imap"))
 799            (user (netrc-machine-user-or-password
 800                   "login"
 801                   list
 802                   (list server
 803                         (or nnimap-server-address
 804                             nnimap-address))
 805                   (list port)
 806                   (list "imap" "imaps" "143" "993")))
 807            (passwd (netrc-machine-user-or-password
 808                     "password"
 809                     list
 810                     (list server
 811                           (or nnimap-server-address
 812                               nnimap-address))
 813                     (list port)
 814                     (list "imap" "imaps" "143" "993"))))
 815       (if (imap-authenticate user passwd nnimap-server-buffer)
 816           (prog2
 817               (setq nnimap-server-buffer-alist
 818                     (nnimap-remove-server-from-buffer-alist
 819                      server
 820                      nnimap-server-buffer-alist))
 821               (push (list server nnimap-server-buffer)
 822                     nnimap-server-buffer-alist)
 823             (imap-id nnimap-id nnimap-server-buffer)
 824             (nnimap-possibly-change-server server))
 825         (imap-close nnimap-server-buffer)
 826         (kill-buffer nnimap-server-buffer)
 827         (nnheader-report 'nnimap "Could not authenticate to %s" server)))))
 828
 829 (deffoo nnimap-open-server (server &optional defs)
 830   (nnheader-init-server-buffer)
 831   (if (nnimap-server-opened server)
 832       t
 833     (unless (assq 'nnimap-server-buffer defs)
 834       (push (list 'nnimap-server-buffer (concat " *nnimap* " server)) defs))
 835     ;; translate `nnimap-server-address' to `nnimap-address' in defs
 836     ;; for people that configured nnimap with a very old version
 837     (unless (assq 'nnimap-address defs)
 838       (if (assq 'nnimap-server-address defs)
 839           (push (list 'nnimap-address
 840                       (cadr (assq 'nnimap-server-address defs))) defs)
 841         (push (list 'nnimap-address server) defs)))
 842     (nnoo-change-server 'nnimap server defs)
 843     (or nnimap-server-buffer
 844         (setq nnimap-server-buffer (cadr (assq 'nnimap-server-buffer defs))))
 845     (with-current-buffer (get-buffer-create nnimap-server-buffer)
 846       (nnoo-change-server 'nnimap server defs))
 847     (let ((imap-logout-timeout nnimap-logout-timeout))
 848       (or (and nnimap-server-buffer
 849                (imap-opened nnimap-server-buffer)
 850                (if (with-current-buffer nnimap-server-buffer
 851                      (memq imap-state '(auth selected examine)))
 852                    t
 853                  (imap-close nnimap-server-buffer)
 854                  (nnimap-open-connection server)))
 855           (nnimap-open-connection server)))))
 856
 857 (deffoo nnimap-server-opened (&optional server)
 858   "Whether SERVER is opened.
 859 If SERVER is the current virtual server, and the connection to the
 860 physical server is alive, this function return a non-nil value.  If
 861 SERVER is nil, it is treated as the current server."
 862   ;; clean up autologouts??
 863   (and (or server nnimap-current-server)
 864        (nnoo-server-opened 'nnimap (or server nnimap-current-server))
 865        (imap-opened (nnimap-get-server-buffer server))))
 866
 867 (deffoo nnimap-close-server (&optional server)
 868   "Close connection to server and free all resources connected to it.
 869 Return nil if the server couldn't be closed for some reason."
 870   (let ((server (or server nnimap-current-server))
 871         (imap-logout-timeout nnimap-logout-timeout))
 872     (when (or (nnimap-server-opened server)
 873               (imap-opened (nnimap-get-server-buffer server)))
 874       (imap-close (nnimap-get-server-buffer server))
 875       (kill-buffer (nnimap-get-server-buffer server))
 876       (setq nnimap-server-buffer nil
 877             nnimap-current-server nil
 878             nnimap-server-buffer-alist
 879             (nnimap-remove-server-from-buffer-alist
 880              server
 881              nnimap-server-buffer-alist)))
 882     (nnoo-close-server 'nnimap server)))
 883
 884 (deffoo nnimap-request-close ()
 885   "Close connection to all servers and free all resources that the backend have reserved.
 886 All buffers that have been created by that
 887 backend should be killed.  (Not the nntp-server-buffer, though.) This
 888 function is generally only called when Gnus is shutting down."
 889   (mapc (lambda (server) (nnimap-close-server (car server)))
 890         nnimap-server-buffer-alist)
 891   (setq nnimap-server-buffer-alist nil))
 892
 893 (deffoo nnimap-status-message (&optional server)
 894   "This function returns the last error message from server."
 895   (when (nnimap-possibly-change-server server)
 896     (nnoo-status-message 'nnimap server)))
 897
 898 (defun nnimap-demule (string)
 899   ;; BEWARE: we used to use string-as-multibyte here which is braindead
 900   ;; because it will turn accidental emacs-mule-valid byte sequences
 901   ;; into multibyte chars.  --Stef
 902   ;; Reverted, braindead got 7.5 out of 10 on imdb, so it can't be
 903   ;; that bad. --Simon
 904   (funcall (if (and (fboundp 'string-as-multibyte)
 905                     (subrp (symbol-function 'string-as-multibyte)))
 906                'string-as-multibyte
 907              'identity)
 908            (or string "")))
 909
 910 (defun nnimap-make-callback (article gnus-callback buffer)
 911   "Return a callback function."
 912   `(lambda ()
 913      (nnimap-callback ,article ,gnus-callback ,buffer)))
 914
 915 (defun nnimap-callback (article gnus-callback buffer)
 916   (when (eq article (imap-current-message))
 917     (remove-hook 'imap-fetch-data-hook
 918                  (nnimap-make-callback article gnus-callback buffer))
 919     (with-current-buffer buffer
 920       (insert
 921        (with-current-buffer nnimap-server-buffer
 922          (nnimap-demule
 923           (if (imap-capability 'IMAP4rev1)
 924               ;; xxx don't just use car? alist doesn't contain
 925               ;; anything else now, but it might...
 926               (nth 2 (car (imap-message-get article 'BODYDETAIL)))
 927             (imap-message-get article 'RFC822)))))
 928       (nnheader-ms-strip-cr)
 929       (funcall gnus-callback t))))
 930
 931 (defun nnimap-request-article-part (article part prop &optional
 932                                             group server to-buffer detail)
 933   (when (nnimap-possibly-change-group group server)
 934     (let ((article (if (stringp article)
 935                        (car-safe (imap-search
 936                                   (format "HEADER Message-Id \"%s\"" article)
 937                                   nnimap-server-buffer))
 938                      article)))
 939       (when article
 940         (gnus-message 10 "nnimap: Fetching (part of) article %d from %s..."
 941                       article (or group imap-current-mailbox
 942                                   gnus-newsgroup-name))
 943         (if (not nnheader-callback-function)
 944             (with-current-buffer (or to-buffer nntp-server-buffer)
 945               (erase-buffer)
 946               (let ((data (imap-fetch article part prop nil
 947                                       nnimap-server-buffer)))
 948                 (insert (nnimap-demule (if detail
 949                                            (nth 2 (car data))
 950                                          data))))
 951               (nnheader-ms-strip-cr)
 952               (gnus-message
 953                10 "nnimap: Fetching (part of) article %d from %s...done"
 954                article (or group imap-current-mailbox gnus-newsgroup-name))
 955               (if (bobp)
 956                   (nnheader-report 'nnimap "No such article %d in %s: %s"
 957                                    article (or group imap-current-mailbox
 958                                                gnus-newsgroup-name)
 959                                    (imap-error-text nnimap-server-buffer))
 960                 (cons group article)))
 961           (add-hook 'imap-fetch-data-hook
 962                     (nnimap-make-callback article
 963                                           nnheader-callback-function
 964                                           nntp-server-buffer))
 965           (imap-fetch-asynch article part nil nnimap-server-buffer)
 966           (cons group article))))))
 967
 968 (deffoo nnimap-asynchronous-p ()
 969   t)
 970
 971 (deffoo nnimap-request-article (article &optional group server to-buffer)
 972   (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
 973       (nnimap-request-article-part
 974        article "BODY.PEEK[]" 'BODYDETAIL group server to-buffer 'detail)
 975     (nnimap-request-article-part
 976      article "RFC822.PEEK" 'RFC822 group server to-buffer)))
 977
 978 (deffoo nnimap-request-head (article &optional group server to-buffer)
 979   (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
 980       (nnimap-request-article-part
 981        article "BODY.PEEK[HEADER]" 'BODYDETAIL group server to-buffer 'detail)
 982     (nnimap-request-article-part
 983      article "RFC822.HEADER" 'RFC822.HEADER group server to-buffer)))
 984
 985 (deffoo nnimap-request-body (article &optional group server to-buffer)
 986   (if (imap-capability 'IMAP4rev1 nnimap-server-buffer)
 987       (nnimap-request-article-part
 988        article "BODY.PEEK[TEXT]" 'BODYDETAIL group server to-buffer 'detail)
 989     (nnimap-request-article-part
 990      article "RFC822.TEXT.PEEK" 'RFC822.TEXT group server to-buffer)))
 991
 992 (deffoo nnimap-request-group (group &optional server fast)
 993   (nnimap-request-update-info-internal
 994    group
 995    (gnus-get-info (gnus-group-prefixed-name
 996                    group (gnus-server-to-method (format "nnimap:%s" server))))
 997    server)
 998   (when (nnimap-possibly-change-group group server)
 999     (nnimap-before-find-minmax-bugworkaround)
1000     (let (info)
1001       (cond (fast group)
1002             ((null (setq info (nnimap-find-minmax-uid group t)))
1003              (nnheader-report 'nnimap "Could not get active info for %s"
1004                               group))
1005             (t
1006              (nnheader-insert "211 %d %d %d %s\n" (or (nth 0 info) 0)
1007                               (max 1 (or (nth 1 info) 1))
1008                               (or (nth 2 info) 0) group)
1009              (nnheader-report 'nnimap "Group %s selected" group)
1010              t)))))
1011
1012 (defun nnimap-update-unseen (group &optional server)
1013   "Update the unseen count in `nnimap-mailbox-info'."
1014   (gnus-sethash
1015    (gnus-group-prefixed-name group server)
1016    (let ((old (gnus-gethash-safe (gnus-group-prefixed-name group server)
1017                                  nnimap-mailbox-info)))
1018      (list (nth 0 old) (nth 1 old)
1019            (imap-mailbox-status group 'unseen nnimap-server-buffer)
1020            (nth 3 old)))
1021    nnimap-mailbox-info))
1022
1023 (defun nnimap-close-group (group &optional server)
1024   (with-current-buffer nnimap-server-buffer
1025     (when (and (imap-opened)
1026                (nnimap-possibly-change-group group server))
1027       (nnimap-update-unseen group server)
1028       (case nnimap-expunge-on-close
1029         (always (progn
1030                   (imap-mailbox-expunge nnimap-close-asynchronous)
1031                   (unless nnimap-dont-close
1032                     (imap-mailbox-close nnimap-close-asynchronous))))
1033         (ask (if (and (imap-search "DELETED")
1034                       (gnus-y-or-n-p (format "Expunge articles in group `%s'? "
1035                                              imap-current-mailbox)))
1036                  (progn
1037                    (imap-mailbox-expunge nnimap-close-asynchronous)
1038                    (unless nnimap-dont-close
1039                      (imap-mailbox-close nnimap-close-asynchronous)))
1040                (imap-mailbox-unselect)))
1041         (t (imap-mailbox-unselect)))
1042       (not imap-current-mailbox))))
1043
1044 (defun nnimap-pattern-to-list-arguments (pattern)
1045   (mapcar (lambda (p)
1046             (cons (car-safe p) (or (cdr-safe p) p)))
1047           (if (and (listp pattern)
1048                    (listp (cdr pattern)))
1049               pattern
1050             (list pattern))))
1051
1052 (deffoo nnimap-request-list (&optional server)
1053   (when (nnimap-possibly-change-server server)
1054     (with-current-buffer nntp-server-buffer
1055       (erase-buffer))
1056     (gnus-message 5 "nnimap: Generating active list%s..."
1057                   (if (> (length server) 0) (concat " for " server) ""))
1058     (nnimap-before-find-minmax-bugworkaround)
1059     (with-current-buffer nnimap-server-buffer
1060       (dolist (pattern (nnimap-pattern-to-list-arguments nnimap-list-pattern))
1061         (dolist (mbx (funcall nnimap-request-list-method
1062                               (cdr pattern) (car pattern)))
1063           (or (member "\\NoSelect" (imap-mailbox-get 'list-flags mbx))
1064               (let ((info (nnimap-find-minmax-uid mbx 'examine)))
1065                 (when info
1066                   (with-current-buffer nntp-server-buffer
1067                     (insert (format "\"%s\" %d %d y\n"
1068                                     mbx (or (nth 2 info) 0)
1069                                     (max 1 (or (nth 1 info) 1)))))))))))
1070     (gnus-message 5 "nnimap: Generating active list%s...done"
1071                   (if (> (length server) 0) (concat " for " server) ""))
1072     t))
1073
1074 (deffoo nnimap-request-post (&optional server)
1075   (let ((success t))
1076     (dolist (mbx (message-unquote-tokens
1077                   (message-tokenize-header
1078                    (message-fetch-field "Newsgroups") ", ")) success)
1079       (let ((to-newsgroup (gnus-group-prefixed-name mbx gnus-command-method)))
1080         (or (gnus-active to-newsgroup)
1081             (gnus-activate-group to-newsgroup)
1082             (if (gnus-y-or-n-p (format "No such group: %s.  Create it? "
1083                                        to-newsgroup))
1084                 (or (and (gnus-request-create-group
1085                           to-newsgroup gnus-command-method)
1086                          (gnus-activate-group to-newsgroup nil nil
1087                                               gnus-command-method))
1088                     (error "Couldn't create group %s" to-newsgroup)))
1089             (error "No such group: %s" to-newsgroup))
1090         (unless (nnimap-request-accept-article mbx (nth 1 gnus-command-method))
1091           (setq success nil))))))
1092
1093 ;; Optional backend functions
1094
1095 (defun nnimap-string-lessp-numerical (s1 s2)
1096   "Return t if first arg string is less than second in numerical order."
1097   (cond ((string= s1 s2)
1098          nil)
1099         ((> (length s1) (length s2))
1100          nil)
1101         ((< (length s1) (length s2))
1102          t)
1103         ((< (string-to-number (substring s1 0 1))
1104             (string-to-number (substring s2 0 1)))
1105          t)
1106         ((> (string-to-number (substring s1 0 1))
1107             (string-to-number (substring s2 0 1)))
1108          nil)
1109         (t
1110          (nnimap-string-lessp-numerical (substring s1 1) (substring s2 1)))))
1111
1112 (deffoo nnimap-retrieve-groups (groups &optional server)
1113   (when (nnimap-possibly-change-server server)
1114     (gnus-message 5 "nnimap: Checking mailboxes...")
1115     (with-current-buffer nntp-server-buffer
1116       (erase-buffer)
1117       (nnimap-before-find-minmax-bugworkaround)
1118       (let (asyncgroups slowgroups)
1119         (if (null nnimap-retrieve-groups-asynchronous)
1120             (setq slowgroups groups)
1121           (dolist (group groups)
1122             (gnus-message 9 "nnimap: Quickly checking mailbox %s" group)
1123             (add-to-list (if (gnus-gethash-safe
1124                               (gnus-group-prefixed-name group server)
1125                               nnimap-mailbox-info)
1126                              'asyncgroups
1127                            'slowgroups)
1128                          (list group (imap-mailbox-status-asynch
1129                                       group '(uidvalidity uidnext unseen)
1130                                       nnimap-server-buffer))))
1131           (dolist (asyncgroup asyncgroups)
1132             (let ((group (nth 0 asyncgroup))
1133                   (tag   (nth 1 asyncgroup))
1134                   new old)
1135               (when (imap-ok-p (imap-wait-for-tag tag nnimap-server-buffer))
1136                 (if (or (not (string=
1137                               (nth 0 (gnus-gethash (gnus-group-prefixed-name
1138                                                     group server)
1139                                                    nnimap-mailbox-info))
1140                               (imap-mailbox-get 'uidvalidity group
1141                                                 nnimap-server-buffer)))
1142                         (not (string=
1143                               (nth 1 (gnus-gethash (gnus-group-prefixed-name
1144                                                     group server)
1145                                                    nnimap-mailbox-info))
1146                               (imap-mailbox-get 'uidnext group
1147                                                 nnimap-server-buffer))))
1148                     (push (list group) slowgroups)
1149                   (insert (nth 3 (gnus-gethash (gnus-group-prefixed-name
1150                                                 group server)
1151                                                nnimap-mailbox-info))))))))
1152         (dolist (group slowgroups)
1153           (if nnimap-retrieve-groups-asynchronous
1154               (setq group (car group)))
1155           (gnus-message 7 "nnimap: Mailbox %s modified" group)
1156           (imap-mailbox-put 'uidnext nil group nnimap-server-buffer)
1157           (or (member "\\NoSelect" (imap-mailbox-get 'list-flags group
1158                                                      nnimap-server-buffer))
1159               (let* ((info (nnimap-find-minmax-uid group 'examine))
1160                      (str (format "\"%s\" %d %d y\n" group
1161                                   (or (nth 2 info) 0)
1162                                   (max 1 (or (nth 1 info) 1)))))
1163                 (when (> (or (imap-mailbox-get 'recent group
1164                                                nnimap-server-buffer) 0)
1165                          0)
1166                   (push (list (cons group 0)) nnmail-split-history))
1167                 (insert str)
1168                 (when nnimap-retrieve-groups-asynchronous
1169                   (gnus-sethash
1170                    (gnus-group-prefixed-name group server)
1171                    (list (or (imap-mailbox-get
1172                               'uidvalidity group nnimap-server-buffer)
1173                              (imap-mailbox-status
1174                               group 'uidvalidity nnimap-server-buffer))
1175                          (or (imap-mailbox-get
1176                               'uidnext group nnimap-server-buffer)
1177                              (imap-mailbox-status
1178                               group 'uidnext nnimap-server-buffer))
1179                          (or (imap-mailbox-get
1180                               'unseen group nnimap-server-buffer)
1181                              (imap-mailbox-status
1182                               group 'unseen nnimap-server-buffer))
1183                          str)
1184                    nnimap-mailbox-info)))))))
1185     (gnus-message 5 "nnimap: Checking mailboxes...done")
1186     'active))
1187
1188 (deffoo nnimap-request-update-info-internal (group info &optional server)
1189   (when (nnimap-possibly-change-group group server)
1190     (when info ;; xxx what does this mean? should we create a info?
1191       (with-current-buffer nnimap-server-buffer
1192         (gnus-message 5 "nnimap: Updating info for %s..."
1193                       (gnus-info-group info))
1194
1195         (when (nnimap-mark-permanent-p 'read)
1196           (let (seen unseen)
1197             ;; read info could contain articles marked unread by other
1198             ;; imap clients!  we correct this
1199             (setq unseen (gnus-compress-sequence
1200                           (imap-search "UNSEEN UNDELETED"))
1201                   seen (gnus-range-difference (gnus-info-read info) unseen)
1202                   seen (gnus-range-add seen
1203                                        (gnus-compress-sequence
1204                                         (imap-search "SEEN")))
1205                   seen (if (and (integerp (car seen))
1206                                 (null (cdr seen)))
1207                            (list (cons (car seen) (car seen)))
1208                          seen))
1209             (gnus-info-set-read info seen)))
1210
1211         (dolist (pred gnus-article-mark-lists)
1212           (when (or (eq (cdr pred) 'recent)
1213                     (and (nnimap-mark-permanent-p (cdr pred))
1214                          (member (nnimap-mark-to-flag (cdr pred))
1215                                  (imap-mailbox-get 'flags))))
1216             (gnus-info-set-marks
1217              info
1218              (gnus-update-alist-soft
1219               (cdr pred)
1220               (gnus-compress-sequence
1221                (imap-search (nnimap-mark-to-predicate (cdr pred))))
1222               (gnus-info-marks info))
1223              t)))
1224
1225         (when nnimap-importantize-dormant
1226           ;; nnimap mark dormant article as ticked too (for other clients)
1227           ;; so we remove that mark for gnus since we support dormant
1228           (gnus-info-set-marks
1229            info
1230            (gnus-update-alist-soft
1231             'tick
1232             (gnus-remove-from-range
1233              (cdr-safe (assoc 'tick (gnus-info-marks info)))
1234              (cdr-safe (assoc 'dormant (gnus-info-marks info))))
1235             (gnus-info-marks info))
1236            t))
1237
1238         (gnus-message 5 "nnimap: Updating info for %s...done"
1239                       (gnus-info-group info))
1240
1241         info))))
1242
1243 (deffoo nnimap-request-type (group &optional article)
1244   (if (and nnimap-news-groups (string-match nnimap-news-groups group))
1245       'news
1246     'mail))
1247
1248 (deffoo nnimap-request-set-mark (group actions &optional server)
1249   (when (nnimap-possibly-change-group group server)
1250     (with-current-buffer nnimap-server-buffer
1251       (let (action)
1252         (gnus-message 7 "nnimap: Setting marks in %s..." group)
1253         (while (setq action (pop actions))
1254           (let ((range (nth 0 action))
1255                 (what  (nth 1 action))
1256                 (cmdmarks (nth 2 action))
1257                 marks)
1258             ;; bookmark can't be stored (not list/range
1259             (setq cmdmarks (delq 'bookmark cmdmarks))
1260             ;; killed can't be stored (not list/range
1261             (setq cmdmarks (delq 'killed cmdmarks))
1262             ;; unsent are for nndraft groups only
1263             (setq cmdmarks (delq 'unsent cmdmarks))
1264             ;; cache flags are pointless on the server
1265             (setq cmdmarks (delq 'cache cmdmarks))
1266             ;; seen flags are local to each gnus
1267             (setq cmdmarks (delq 'seen cmdmarks))
1268             ;; recent marks can't be set
1269             (setq cmdmarks (delq 'recent cmdmarks))
1270             (when nnimap-importantize-dormant
1271               ;; flag dormant articles as ticked
1272               (if (memq 'dormant cmdmarks)
1273                   (setq cmdmarks (cons 'tick cmdmarks))))
1274             ;; remove stuff we are forbidden to store
1275             (mapc (lambda (mark)
1276                     (if (imap-message-flag-permanent-p
1277                          (nnimap-mark-to-flag mark))
1278                         (setq marks (cons mark marks))))
1279                   cmdmarks)
1280             (when (and range marks)
1281               (cond ((eq what 'del)
1282                      (imap-message-flags-del
1283                       (imap-range-to-message-set range)
1284                       (nnimap-mark-to-flag marks nil t)))
1285                     ((eq what 'add)
1286                      (imap-message-flags-add
1287                       (imap-range-to-message-set range)
1288                       (nnimap-mark-to-flag marks nil t)))
1289                     ((eq what 'set)
1290                      (imap-message-flags-set
1291                       (imap-range-to-message-set range)
1292                       (nnimap-mark-to-flag marks nil t)))))))
1293         (gnus-message 7 "nnimap: Setting marks in %s...done" group))))
1294   nil)
1295
1296 (defun nnimap-split-fancy ()
1297   "Like the function `nnmail-split-fancy', but uses `nnimap-split-fancy'."
1298   (let ((nnmail-split-fancy nnimap-split-fancy))
1299     (nnmail-split-fancy)))
1300
1301 (defun nnimap-split-to-groups (rules)
1302   ;; tries to match all rules in nnimap-split-rule against content of
1303   ;; nntp-server-buffer, returns a list of groups that matched.
1304   (with-current-buffer nntp-server-buffer
1305     ;; Fold continuation lines.
1306     (goto-char (point-min))
1307     (while (re-search-forward "\\(\r?\n[ \t]+\\)+" nil t)
1308       (replace-match " " t t))
1309     (if (functionp rules)
1310         (funcall rules)
1311       (let (to-groups regrepp)
1312         (catch 'split-done
1313           (dolist (rule rules to-groups)
1314             (let ((group (car rule))
1315                   (regexp (cadr rule)))
1316               (goto-char (point-min))
1317               (when (and (if (stringp regexp)
1318                              (progn
1319                                (if (not (stringp group))
1320                                    (setq group (eval group))
1321                                  (setq regrepp
1322                                        (string-match "\\\\[0-9&]" group)))
1323                                (re-search-forward regexp nil t))
1324                            (funcall regexp group))
1325                          ;; Don't enter the article into the same group twice.
1326                          (not (assoc group to-groups)))
1327                 (push (if regrepp
1328                           (nnmail-expand-newtext group)
1329                         group)
1330                       to-groups)
1331                 (or nnimap-split-crosspost
1332                     (throw 'split-done to-groups))))))))))
1333
1334 (defun nnimap-assoc-match (key alist)
1335   (let (element)
1336     (while (and alist (not element))
1337       (if (string-match (car (car alist)) key)
1338           (setq element (car alist)))
1339       (setq alist (cdr alist)))
1340     element))
1341
1342 (defun nnimap-split-find-rule (server inbox)
1343   (if (and (listp nnimap-split-rule) (listp (car nnimap-split-rule))
1344            (list (cdar nnimap-split-rule)) (listp (cadar nnimap-split-rule)))
1345       ;; extended format
1346       (cadr (nnimap-assoc-match inbox (cdr (nnimap-assoc-match
1347                                             server nnimap-split-rule))))
1348     nnimap-split-rule))
1349
1350 (defun nnimap-split-find-inbox (server)
1351   (if (listp nnimap-split-inbox)
1352       nnimap-split-inbox
1353     (list nnimap-split-inbox)))
1354
1355 (defun nnimap-split-articles (&optional group server)
1356   (when (nnimap-possibly-change-server server)
1357     (with-current-buffer nnimap-server-buffer
1358       (let (rule inbox removeorig (inboxes (nnimap-split-find-inbox server)))
1359         ;; iterate over inboxes
1360         (while (and (setq inbox (pop inboxes))
1361                     (nnimap-possibly-change-group inbox)) ;; SELECT
1362           ;; find split rule for this server / inbox
1363           (when (setq rule (nnimap-split-find-rule server inbox))
1364             ;; iterate over articles
1365             (dolist (article (imap-search nnimap-split-predicate))
1366               (when (if (if (eq nnimap-split-download-body 'default)
1367                             nnimap-split-download-body-default
1368                           nnimap-split-download-body)
1369                         (and (nnimap-request-article article)
1370                              (with-current-buffer nntp-server-buffer (mail-narrow-to-head)))
1371                       (nnimap-request-head article))
1372                 ;; copy article to right group(s)
1373                 (setq removeorig nil)
1374                 (dolist (to-group (nnimap-split-to-groups rule))
1375                   (cond ((eq to-group 'junk)
1376                          (message "IMAP split removed %s:%s:%d" server inbox
1377                                   article)
1378                          (setq removeorig t))
1379                         ((imap-message-copy (number-to-string article)
1380                                             to-group nil 'nocopyuid)
1381                          (message "IMAP split moved %s:%s:%d to %s" server
1382                                   inbox article to-group)
1383                          (setq removeorig t)
1384                          (when nnmail-cache-accepted-message-ids
1385                            (with-current-buffer nntp-server-buffer
1386                              (let (msgid)
1387                                (and (setq msgid
1388                                           (nnmail-fetch-field "message-id"))
1389                                     (nnmail-cache-insert msgid
1390                                                          to-group
1391                                                          (nnmail-fetch-field "subject"))))))
1392                          ;; Add the group-art list to the history list.
1393                          (push (list (cons to-group 0)) nnmail-split-history))
1394                         (t
1395                          (message "IMAP split failed to move %s:%s:%d to %s"
1396                                   server inbox article to-group))))
1397                 (if (if (eq nnimap-split-download-body 'default)
1398                         nnimap-split-download-body-default
1399                       nnimap-split-download-body)
1400                     (widen))
1401                 ;; remove article if it was successfully copied somewhere
1402                 (and removeorig
1403                      (imap-message-flags-add (format "%d" article)
1404                                              "\\Seen \\Deleted")))))
1405           (when (imap-mailbox-select inbox) ;; just in case
1406             ;; todo: UID EXPUNGE (if available) to remove splitted articles
1407             (imap-mailbox-expunge)
1408             (imap-mailbox-close)))
1409         (when nnmail-cache-accepted-message-ids
1410           (nnmail-cache-close))
1411         t))))
1412
1413 (deffoo nnimap-request-scan (&optional group server)
1414   (nnimap-split-articles group server))
1415
1416 (deffoo nnimap-request-newgroups (date &optional server)
1417   (when (nnimap-possibly-change-server server)
1418     (with-current-buffer nntp-server-buffer
1419       (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s..."
1420                     (if (> (length server) 0) " on " "") server)
1421       (erase-buffer)
1422       (nnimap-before-find-minmax-bugworkaround)
1423       (dolist (pattern (nnimap-pattern-to-list-arguments
1424                         nnimap-list-pattern))
1425         (dolist (mbx (imap-mailbox-lsub (cdr pattern) (car pattern) nil
1426                                         nnimap-server-buffer))
1427           (or (catch 'found
1428                 (dolist (mailbox (imap-mailbox-get 'list-flags mbx
1429                                                    nnimap-server-buffer))
1430                   (if (string= (downcase mailbox) "\\noselect")
1431                       (throw 'found t)))
1432                 nil)
1433               (let ((info (nnimap-find-minmax-uid mbx 'examine)))
1434                 (when info
1435                   (insert (format "\"%s\" %d %d y\n"
1436                                   mbx (or (nth 2 info) 0)
1437                                   (max 1 (or (nth 1 info) 1)))))))))
1438       (gnus-message 5 "nnimap: Listing subscribed mailboxes%s%s...done"
1439                     (if (> (length server) 0) " on " "") server))
1440     t))
1441
1442 (deffoo nnimap-request-create-group (group &optional server args)
1443   (when (nnimap-possibly-change-server server)
1444     (or (imap-mailbox-status group 'uidvalidity nnimap-server-buffer)
1445         (imap-mailbox-create group nnimap-server-buffer)
1446         (nnheader-report 'nnimap "%S"
1447                          (imap-error-text nnimap-server-buffer)))))
1448
1449 (defun nnimap-time-substract (time1 time2)
1450   "Return TIME for TIME1 - TIME2."
1451   (let* ((ms (- (car time1) (car time2)))
1452          (ls (- (nth 1 time1) (nth 1 time2))))
1453     (if (< ls 0)
1454         (list (- ms 1) (+ (expt 2 16) ls))
1455       (list ms ls))))
1456
1457 (eval-when-compile (require 'parse-time))
1458 (defun nnimap-date-days-ago (daysago)
1459   "Return date, in format \"3-Aug-1998\", for DAYSAGO days ago."
1460   (require 'parse-time)
1461   (let* ((time (nnimap-time-substract (current-time) (days-to-time daysago)))
1462          (date (format-time-string
1463                 (format "%%d-%s-%%Y"
1464                         (capitalize (car (rassoc (nth 4 (decode-time time))
1465                                                  parse-time-months))))
1466                 time)))
1467     (if (eq ?0 (string-to-char date))
1468         (substring date 1)
1469       date)))
1470
1471 (defun nnimap-request-expire-articles-progress ()
1472   (gnus-message 5 "nnimap: Marking article %d for deletion..."
1473                 imap-current-message))
1474
1475 (defun nnimap-expiry-target (arts group server)
1476   (unless (eq nnmail-expiry-target 'delete)
1477     (with-temp-buffer
1478       (dolist (art arts)
1479         (nnimap-request-article art group server (current-buffer))
1480         ;; hints for optimization in `nnimap-request-accept-article'
1481         (let ((nnimap-current-move-article art)
1482               (nnimap-current-move-group group)
1483               (nnimap-current-move-server server))
1484           (nnmail-expiry-target-group nnmail-expiry-target group))))
1485     ;; It is not clear if `nnmail-expiry-target' somehow cause the
1486     ;; current group to be changed or not, so we make sure here.
1487     (nnimap-possibly-change-group group server)))
1488
1489 ;; Notice that we don't actually delete anything, we just mark them deleted.
1490 (deffoo nnimap-request-expire-articles (articles group &optional server force)
1491   (let ((artseq (gnus-compress-sequence articles)))
1492     (when (and artseq (nnimap-possibly-change-group group server))
1493       (with-current-buffer nnimap-server-buffer
1494         (let ((days (or (and nnmail-expiry-wait-function
1495                              (funcall nnmail-expiry-wait-function group))
1496                         nnmail-expiry-wait)))
1497           (cond ((or force (eq days 'immediate))
1498                  (let ((oldarts (imap-search
1499                                  (concat "UID "
1500                                          (imap-range-to-message-set artseq)))))
1501                    (when oldarts
1502                      (nnimap-expiry-target oldarts group server)
1503                      (when (imap-message-flags-add
1504                             (imap-range-to-message-set
1505                              (gnus-compress-sequence oldarts)) "\\Deleted")
1506                        (setq articles (gnus-set-difference
1507                                        articles oldarts))))))
1508                 ((and nnimap-search-uids-not-since-is-evil (numberp days))
1509                  (let* ((all-new-articles
1510                          (gnus-compress-sequence
1511                           (imap-search (format "SINCE %s"
1512                                                (nnimap-date-days-ago days)))))
1513                         (oldartseq
1514                          (gnus-range-difference artseq all-new-articles))
1515                         (oldarts (gnus-uncompress-range oldartseq)))
1516                    (when oldarts
1517                      (nnimap-expiry-target oldarts group server)
1518                      (when (imap-message-flags-add
1519                             (imap-range-to-message-set oldartseq)
1520                             "\\Deleted")
1521                        (setq articles (gnus-set-difference
1522                                        articles oldarts))))))
1523                 ((numberp days)
1524                  (let ((oldarts (imap-search
1525                                  (format nnimap-expunge-search-string
1526                                          (imap-range-to-message-set artseq)
1527                                          (nnimap-date-days-ago days))))
1528                        (imap-fetch-data-hook
1529                         '(nnimap-request-expire-articles-progress)))
1530                    (when oldarts
1531                      (nnimap-expiry-target oldarts group server)
1532                      (when (imap-message-flags-add
1533                             (imap-range-to-message-set
1534                              (gnus-compress-sequence oldarts)) "\\Deleted")
1535                        (setq articles (gnus-set-difference
1536                                        articles oldarts)))))))))))
1537   ;; return articles not deleted
1538   articles)
1539
1540 (deffoo nnimap-request-move-article (article group server accept-form
1541                                              &optional last move-is-internal)
1542   (when (nnimap-possibly-change-server server)
1543     (save-excursion
1544       (let ((buf (get-buffer-create " *nnimap move*"))
1545             (nnimap-current-move-article article)
1546             (nnimap-current-move-group group)
1547             (nnimap-current-move-server nnimap-current-server)
1548             result)
1549         (gnus-message 10 "nnimap-request-move-article: this is an %s move"
1550                       (if move-is-internal
1551                           "internal"
1552                         "external"))
1553         ;; request the article only when the move is NOT internal
1554         (and (or move-is-internal
1555                  (nnimap-request-article article group server))
1556              (save-excursion
1557                (set-buffer buf)
1558                (buffer-disable-undo (current-buffer))
1559                (insert-buffer-substring nntp-server-buffer)
1560                (setq result (eval accept-form))
1561                (kill-buffer buf)
1562                result)
1563              (nnimap-possibly-change-group group server)
1564              (imap-message-flags-add
1565               (imap-range-to-message-set (list article))
1566               "\\Deleted" 'silent nnimap-server-buffer))
1567         result))))
1568
1569 (deffoo nnimap-request-accept-article (group &optional server last)
1570   (when (nnimap-possibly-change-server server)
1571     (let (uid)
1572       (if (setq uid
1573                 (if (string= nnimap-current-server nnimap-current-move-server)
1574                     ;; moving article within same server, speed it up...
1575                     (and (nnimap-possibly-change-group
1576                           nnimap-current-move-group)
1577                          (imap-message-copy (number-to-string
1578                                              nnimap-current-move-article)
1579                                             group 'dontcreate nil
1580                                             nnimap-server-buffer))
1581                   (with-current-buffer (current-buffer)
1582                     (goto-char (point-min))
1583                     ;; remove any 'From blabla' lines, some IMAP servers
1584                     ;; reject the entire message otherwise.
1585                     (when (looking-at "^From[^:]")
1586                       (delete-region (point) (progn (forward-line) (point))))
1587                     ;; turn into rfc822 format (\r\n eol's)
1588                     (while (search-forward "\n" nil t)
1589                       (replace-match "\r\n"))
1590                     (when nnmail-cache-accepted-message-ids
1591                       (nnmail-cache-insert (nnmail-fetch-field "message-id")
1592                                            group
1593                                            (nnmail-fetch-field "subject"))))
1594                   (when (and last nnmail-cache-accepted-message-ids)
1595                     (nnmail-cache-close))
1596                   ;; this 'or' is for Cyrus server bug
1597                   (or (null (imap-current-mailbox nnimap-server-buffer))
1598                       (imap-mailbox-unselect nnimap-server-buffer))
1599                   (imap-message-append group (current-buffer) nil nil
1600                                        nnimap-server-buffer)))
1601           (cons group (nth 1 uid))
1602         (nnheader-report 'nnimap (imap-error-text nnimap-server-buffer))))))
1603
1604 (deffoo nnimap-request-delete-group (group force &optional server)
1605   (when (nnimap-possibly-change-server server)
1606     (with-current-buffer nnimap-server-buffer
1607       (if force
1608           (or (null (imap-mailbox-status group 'uidvalidity))
1609               (imap-mailbox-delete group))
1610         ;; UNSUBSCRIBE?
1611         t))))
1612
1613 (deffoo nnimap-request-rename-group (group new-name &optional server)
1614   (when (nnimap-possibly-change-server server)
1615     (imap-mailbox-rename group new-name nnimap-server-buffer)))
1616
1617 (defun nnimap-expunge (mailbox server)
1618   (when (nnimap-possibly-change-group mailbox server)
1619     (imap-mailbox-expunge nil nnimap-server-buffer)))
1620
1621 (defun nnimap-acl-get (mailbox server)
1622   (when (nnimap-possibly-change-server server)
1623     (and (imap-capability 'ACL nnimap-server-buffer)
1624          (imap-mailbox-acl-get mailbox nnimap-server-buffer))))
1625
1626 (defun nnimap-acl-edit (mailbox method old-acls new-acls)
1627   (when (nnimap-possibly-change-server (cadr method))
1628     (unless (imap-capability 'ACL nnimap-server-buffer)
1629       (error "Your server does not support ACL editing"))
1630     (with-current-buffer nnimap-server-buffer
1631       ;; delete all removed identifiers
1632       (mapc (lambda (old-acl)
1633               (unless (assoc (car old-acl) new-acls)
1634                 (or (imap-mailbox-acl-delete (car old-acl) mailbox)
1635                     (error "Can't delete ACL for %s" (car old-acl)))))
1636             old-acls)
1637       ;; set all changed acl's
1638       (mapc (lambda (new-acl)
1639               (let ((new-rights (cdr new-acl))
1640                     (old-rights (cdr (assoc (car new-acl) old-acls))))
1641                 (unless (and old-rights new-rights
1642                              (string= old-rights new-rights))
1643                   (or (imap-mailbox-acl-set (car new-acl) new-rights mailbox)
1644                       (error "Can't set ACL for %s to %s" (car new-acl)
1645                              new-rights)))))
1646             new-acls)
1647       t)))
1648
1649 \f
1650 ;;; Internal functions
1651
1652 ;;
1653 ;; This is confusing.
1654 ;;
1655 ;; mark      => read, tick, draft, reply etc
1656 ;; flag      => "\\Seen", "\\Flagged", "\\Draft", "gnus-expire" etc
1657 ;; predicate => "SEEN", "FLAGGED", "DRAFT", "KEYWORD gnus-expire" etc
1658 ;;
1659 ;; Mark should not really contain 'read since it's not a "mark" in the Gnus
1660 ;; world, but we cheat.  Mark == gnus-article-mark-lists + '(read . read).
1661 ;;
1662
1663 (defconst nnimap-mark-to-predicate-alist
1664   (mapcar
1665    (lambda (pair)                       ; cdr is the mark
1666      (or (assoc (cdr pair)
1667                 '((read . "SEEN")
1668                   (tick . "FLAGGED")
1669                   (draft . "DRAFT")
1670                   (recent . "RECENT")
1671                   (reply . "ANSWERED")))
1672          (cons (cdr pair)
1673                (format "KEYWORD gnus-%s" (symbol-name (cdr pair))))))
1674    (cons '(read . read) gnus-article-mark-lists)))
1675
1676 (defun nnimap-mark-to-predicate (pred)
1677   "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP predicate.
1678 This is a string such as \"SEEN\", \"FLAGGED\", \"KEYWORD gnus-expire\",
1679 to be used within a IMAP SEARCH query."
1680   (cdr (assq pred nnimap-mark-to-predicate-alist)))
1681
1682 (defconst nnimap-mark-to-flag-alist
1683   (mapcar
1684    (lambda (pair)
1685      (or (assoc (cdr pair)
1686                 '((read . "\\Seen")
1687                   (tick . "\\Flagged")
1688                   (draft . "\\Draft")
1689                   (recent . "\\Recent")
1690                   (reply . "\\Answered")))
1691          (cons (cdr pair)
1692                (format "gnus-%s" (symbol-name (cdr pair))))))
1693    (cons '(read . read) gnus-article-mark-lists)))
1694
1695 (defun nnimap-mark-to-flag-1 (preds)
1696   (if (and (not (null preds)) (listp preds))
1697       (cons (nnimap-mark-to-flag (car preds))
1698             (nnimap-mark-to-flag (cdr preds)))
1699     (cdr (assoc preds nnimap-mark-to-flag-alist))))
1700
1701 (defun nnimap-mark-to-flag (preds &optional always-list make-string)
1702   "Convert a Gnus mark (a symbol such as read, tick, expire) to a IMAP flag.
1703 This is a string such as \"\\Seen\", \"\\Flagged\", \"gnus-expire\", to
1704 be used in a STORE FLAGS command."
1705   (let ((result (nnimap-mark-to-flag-1 preds)))
1706     (setq result (if (and (or make-string always-list)
1707                           (not (listp result)))
1708                      (list result)
1709                    result))
1710     (if make-string
1711         (mapconcat (lambda (flag)
1712                      (if (listp flag)
1713                          (mapconcat 'identity flag " ")
1714                        flag))
1715                    result " ")
1716       result)))
1717
1718 (defun nnimap-mark-permanent-p (mark &optional group)
1719   "Return t if MARK can be permanently (between IMAP sessions) saved on articles, in GROUP."
1720   (imap-message-flag-permanent-p (nnimap-mark-to-flag mark)))
1721
1722 (when nnimap-debug
1723   (require 'trace)
1724   (buffer-disable-undo (get-buffer-create nnimap-debug-buffer))
1725   (mapc (lambda (f) (trace-function-background f nnimap-debug-buffer))
1726         '(
1727           nnimap-possibly-change-server
1728           nnimap-verify-uidvalidity
1729           nnimap-find-minmax-uid
1730           nnimap-before-find-minmax-bugworkaround
1731           nnimap-possibly-change-group
1732           ;;nnimap-replace-whitespace
1733           nnimap-retrieve-headers-progress
1734           nnimap-retrieve-which-headers
1735           nnimap-group-overview-filename
1736           nnimap-retrieve-headers-from-file
1737           nnimap-retrieve-headers-from-server
1738           nnimap-retrieve-headers
1739           nnimap-open-connection
1740           nnimap-open-server
1741           nnimap-server-opened
1742           nnimap-close-server
1743           nnimap-request-close
1744           nnimap-status-message
1745           ;;nnimap-demule
1746           nnimap-request-article-part
1747           nnimap-request-article
1748           nnimap-request-head
1749           nnimap-request-body
1750           nnimap-request-group
1751           nnimap-close-group
1752           nnimap-pattern-to-list-arguments
1753           nnimap-request-list
1754           nnimap-request-post
1755           nnimap-retrieve-groups
1756           nnimap-request-update-info-internal
1757           nnimap-request-type
1758           nnimap-request-set-mark
1759           nnimap-split-to-groups
1760           nnimap-split-find-rule
1761           nnimap-split-find-inbox
1762           nnimap-split-articles
1763           nnimap-request-scan
1764           nnimap-request-newgroups
1765           nnimap-request-create-group
1766           nnimap-time-substract
1767           nnimap-date-days-ago
1768           nnimap-request-expire-articles-progress
1769           nnimap-request-expire-articles
1770           nnimap-request-move-article
1771           nnimap-request-accept-article
1772           nnimap-request-delete-group
1773           nnimap-request-rename-group
1774           gnus-group-nnimap-expunge
1775           gnus-group-nnimap-edit-acl
1776           gnus-group-nnimap-edit-acl-done
1777           nnimap-group-mode-hook
1778           nnimap-mark-to-predicate
1779           nnimap-mark-to-flag-1
1780           nnimap-mark-to-flag
1781           nnimap-mark-permanent-p
1782           )))
1783
1784 (provide 'nnimap)
1785
1786 ;; arch-tag: 2b001f20-3ff9-4094-a0ad-46807c1ba70b
1787 ;;; nnimap.el ends here