cgit.sxemacs.org Git - gnus/blob - lisp/mail-source.el

   1 ;;; mail-source.el --- functions for fetching mail
   2
   3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004,
   4 ;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
   5
   6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   7 ;; Keywords: news, 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 3, 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., 51 Franklin Street, Fifth Floor,
  24 ;; Boston, MA 02110-1301, USA.
  25
  26 ;;; Commentary:
  27
  28 ;;; Code:
  29
  30 ;; For Emacs < 22.2.
  31 (eval-and-compile
  32   (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
  33
  34 (require 'format-spec)
  35 (eval-when-compile
  36   (require 'cl)
  37   (require 'imap))
  38 (eval-and-compile
  39   (autoload 'auth-source-user-or-password "auth-source")
  40   (autoload 'pop3-movemail "pop3")
  41   (autoload 'pop3-get-message-count "pop3")
  42   (autoload 'nnheader-cancel-timer "nnheader"))
  43 (require 'mm-util)
  44 (require 'message) ;; for `message-directory'
  45
  46 (defvar display-time-mail-function)
  47
  48 (defgroup mail-source nil
  49   "The mail-fetching library."
  50   :version "21.1"
  51   :group 'gnus)
  52
  53 ;; Define these at compile time to avoid dragging in imap always.
  54 (defconst mail-source-imap-authenticators
  55   (eval-when-compile
  56     (mapcar (lambda (a)
  57               (list 'const (car a)))
  58      imap-authenticator-alist)))
  59 (defconst mail-source-imap-streams
  60   (eval-when-compile
  61     (mapcar (lambda (a)
  62               (list 'const (car a)))
  63      imap-stream-alist)))
  64
  65 (defcustom mail-sources '((file))
  66   "Where the mail backends will look for incoming mail.
  67 This variable is a list of mail source specifiers.
  68 See Info node `(gnus)Mail Source Specifiers'."
  69   :group 'mail-source
  70   :version "23.1" ;; No Gnus
  71   :link '(custom-manual "(gnus)Mail Source Specifiers")
  72   :type `(choice
  73           (const :tag "None" nil)
  74           (repeat :tag "List"
  75            (choice :format "%[Value Menu%] %v"
  76                    :value (file)
  77                    (cons :tag "Group parameter `mail-source'"
  78                          (const :format "" group))
  79                    (cons :tag "Spool file"
  80                          (const :format "" file)
  81                          (checklist :tag "Options" :greedy t
  82                                     (group :inline t
  83                                            (const :format "" :value :path)
  84                                            file)))
  85                    (cons :tag "Several files in a directory"
  86                          (const :format "" directory)
  87                          (checklist :tag "Options" :greedy t
  88                                     (group :inline t
  89                                            (const :format "" :value :path)
  90                                            (directory :tag "Path"))
  91                                     (group :inline t
  92                                            (const :format "" :value :suffix)
  93                                            (string :tag "Suffix"))
  94                                     (group :inline t
  95                                            (const :format "" :value :predicate)
  96                                            (function :tag "Predicate"))
  97                                     (group :inline t
  98                                            (const :format "" :value :prescript)
  99                                            (choice :tag "Prescript"
 100                                                    :value nil
 101                                                    (string :format "%v")
 102                                                    (function :format "%v")))
 103                                     (group :inline t
 104                                            (const :format "" :value :postscript)
 105                                            (choice :tag "Postscript"
 106                                                    :value nil
 107                                                    (string :format "%v")
 108                                                    (function :format "%v")))
 109                                     (group :inline t
 110                                            (const :format "" :value :plugged)
 111                                            (boolean :tag "Plugged"))))
 112                    (cons :tag "POP3 server"
 113                          (const :format "" pop)
 114                          (checklist :tag "Options" :greedy t
 115                                     (group :inline t
 116                                            (const :format "" :value :server)
 117                                            (string :tag "Server"))
 118                                     (group :inline t
 119                                            (const :format "" :value :port)
 120                                            (choice :tag "Port"
 121                                                    :value "pop3"
 122                                                    (integer :format "%v")
 123                                                    (string :format "%v")))
 124                                     (group :inline t
 125                                            (const :format "" :value :user)
 126                                            (string :tag "User"))
 127                                     (group :inline t
 128                                            (const :format "" :value :password)
 129                                            (string :tag "Password"))
 130                                     (group :inline t
 131                                            (const :format "" :value :program)
 132                                            (string :tag "Program"))
 133                                     (group :inline t
 134                                            (const :format "" :value :prescript)
 135                                            (choice :tag "Prescript"
 136                                                    :value nil
 137                                                    (string :format "%v")
 138                                                    (function :format "%v")
 139                                                    (const :tag "None" nil)))
 140                                     (group :inline t
 141                                            (const :format "" :value :postscript)
 142                                            (choice :tag "Postscript"
 143                                                    :value nil
 144                                                    (string :format "%v")
 145                                                    (function :format "%v")
 146                                                    (const :tag "None" nil)))
 147                                     (group :inline t
 148                                            (const :format "" :value :function)
 149                                            (function :tag "Function"))
 150                                     (group :inline t
 151                                            (const :format ""
 152                                                   :value :authentication)
 153                                            (choice :tag "Authentication"
 154                                                    :value apop
 155                                                    (const password)
 156                                                    (const apop)))
 157                                     (group :inline t
 158                                            (const :format "" :value :plugged)
 159                                            (boolean :tag "Plugged"))
 160                                     (group :inline t
 161                                            (const :format "" :value :stream)
 162                                            (choice :tag "Stream"
 163                                                    :value nil
 164                                                    (const :tag "Clear" nil)
 165                                                    (const starttls)
 166                                                    (const :tag "SSL/TLS" ssl)))))
 167                    (cons :tag "Maildir (qmail, postfix...)"
 168                          (const :format "" maildir)
 169                          (checklist :tag "Options" :greedy t
 170                                     (group :inline t
 171                                            (const :format "" :value :path)
 172                                            (directory :tag "Path"))
 173                                     (group :inline t
 174                                            (const :format "" :value :plugged)
 175                                            (boolean :tag "Plugged"))))
 176                    (cons :tag "IMAP server"
 177                          (const :format "" imap)
 178                          (checklist :tag "Options" :greedy t
 179                                     (group :inline t
 180                                            (const :format "" :value :server)
 181                                            (string :tag "Server"))
 182                                     (group :inline t
 183                                            (const :format "" :value :port)
 184                                            (choice :tag "Port"
 185                                                    :value 143
 186                                                    integer string))
 187                                     (group :inline t
 188                                            (const :format "" :value :user)
 189                                            (string :tag "User"))
 190                                     (group :inline t
 191                                            (const :format "" :value :password)
 192                                            (string :tag "Password"))
 193                                     (group :inline t
 194                                            (const :format "" :value :stream)
 195                                            (choice :tag "Stream"
 196                                                    :value network
 197                                                    ,@mail-source-imap-streams))
 198                                     (group :inline t
 199                                            (const :format "" :value :program)
 200                                            (string :tag "Program"))
 201                                     (group :inline t
 202                                            (const :format ""
 203                                                   :value :authenticator)
 204                                            (choice :tag "Authenticator"
 205                                                    :value login
 206                                                    ,@mail-source-imap-authenticators))
 207                                     (group :inline t
 208                                            (const :format "" :value :mailbox)
 209                                            (string :tag "Mailbox"
 210                                                    :value "INBOX"))
 211                                     (group :inline t
 212                                            (const :format "" :value :predicate)
 213                                            (string :tag "Predicate"
 214                                                    :value "UNSEEN UNDELETED"))
 215                                     (group :inline t
 216                                            (const :format "" :value :fetchflag)
 217                                            (string :tag "Fetchflag"
 218                                                    :value  "\\Deleted"))
 219                                     (group :inline t
 220                                            (const :format ""
 221                                                   :value :dontexpunge)
 222                                            (boolean :tag "Dontexpunge"))
 223                                     (group :inline t
 224                                            (const :format "" :value :plugged)
 225                                            (boolean :tag "Plugged"))))
 226                    (cons :tag "Webmail server"
 227                          (const :format "" webmail)
 228                          (checklist :tag "Options" :greedy t
 229                                     (group :inline t
 230                                           (const :format "" :value :subtype)
 231                                           ;; Should be generated from
 232                                           ;; `webmail-type-definition', but we
 233                                           ;; can't require webmail without W3.
 234                                           (choice :tag "Subtype"
 235                                                   :value hotmail
 236                                                   (const hotmail)
 237                                                   (const yahoo)
 238                                                   (const netaddress)
 239                                                   (const netscape)
 240                                                   (const my-deja)))
 241                                     (group :inline t
 242                                            (const :format "" :value :user)
 243                                            (string :tag "User"))
 244                                     (group :inline t
 245                                            (const :format "" :value :password)
 246                                            (string :tag "Password"))
 247                                     (group :inline t
 248                                            (const :format ""
 249                                                   :value :dontexpunge)
 250                                            (boolean :tag "Dontexpunge"))
 251                                     (group :inline t
 252                                            (const :format "" :value :plugged)
 253                                            (boolean :tag "Plugged"))))))))
 254
 255 (defcustom mail-source-ignore-errors nil
 256   "*Ignore errors when querying mail sources.
 257 If nil, the user will be prompted when an error occurs.  If non-nil,
 258 the error will be ignored."
 259   :version "22.1"
 260   :group 'mail-source
 261   :type 'boolean)
 262
 263 (defcustom mail-source-primary-source nil
 264   "*Primary source for incoming mail.
 265 If non-nil, this maildrop will be checked periodically for new mail."
 266   :group 'mail-source
 267   :type 'sexp)
 268
 269 (defcustom mail-source-flash t
 270   "*If non-nil, flash periodically when mail is available."
 271   :group 'mail-source
 272   :type 'boolean)
 273
 274 (defcustom mail-source-crash-box "~/.emacs-mail-crash-box"
 275   "File where mail will be stored while processing it."
 276   :group 'mail-source
 277   :type 'file)
 278
 279 (defcustom mail-source-directory message-directory
 280   "Directory where incoming mail source files (if any) will be stored."
 281   :group 'mail-source
 282   :type 'directory)
 283
 284 (defcustom mail-source-default-file-modes 384
 285   "Set the mode bits of all new mail files to this integer."
 286   :group 'mail-source
 287   :type 'integer)
 288
 289 (defcustom mail-source-delete-incoming
 290   10 ;; development versions
 291   ;; 2 ;; released versions
 292   "If non-nil, delete incoming files after handling.
 293 If t, delete immediately, if nil, never delete.  If a positive number, delete
 294 files older than number of days.
 295
 296 Removing of old files happens in `mail-source-callback', i.e. no
 297 old incoming files will be deleted unless you receive new mail.
 298 You may also set this variable to nil and call
 299 `mail-source-delete-old-incoming' interactively."
 300   :group 'mail-source
 301   :version "22.2" ;; No Gnus / Gnus 5.10.10 (default changed)
 302   :type '(choice (const :tag "immediately" t)
 303                  (const :tag "never" nil)
 304                  (integer :tag "days")))
 305
 306 (defcustom mail-source-delete-old-incoming-confirm nil
 307   "If non-nil, ask for confirmation before deleting old incoming files.
 308 This variable only applies when `mail-source-delete-incoming' is a positive
 309 number."
 310   :version "22.2" ;; No Gnus / Gnus 5.10.10 (default changed)
 311   :group 'mail-source
 312   :type 'boolean)
 313
 314 (defcustom mail-source-incoming-file-prefix "Incoming"
 315   "Prefix for file name for storing incoming mail"
 316   :group 'mail-source
 317   :type 'string)
 318
 319 (defcustom mail-source-report-new-mail-interval 5
 320   "Interval in minutes between checks for new mail."
 321   :group 'mail-source
 322   :type 'number)
 323
 324 (defcustom mail-source-idle-time-delay 5
 325   "Number of idle seconds to wait before checking for new mail."
 326   :group 'mail-source
 327   :type 'number)
 328
 329 (defcustom mail-source-movemail-program nil
 330   "If non-nil, name of program for fetching new mail."
 331   :version "22.1"
 332   :group 'mail-source
 333   :type '(choice (const nil) string))
 334
 335 ;;; Internal variables.
 336
 337 (defvar mail-source-string ""
 338   "A dynamically bound string that says what the current mail source is.")
 339
 340 (defvar mail-source-new-mail-available nil
 341   "Flag indicating when new mail is available.")
 342
 343 (eval-and-compile
 344   (defvar mail-source-common-keyword-map
 345     '((:plugged))
 346     "Mapping from keywords to default values.
 347 Common keywords should be listed here.")
 348
 349   (defvar mail-source-keyword-map
 350     '((file
 351        (:prescript)
 352        (:prescript-delay)
 353        (:postscript)
 354        (:path (or (getenv "MAIL")
 355                   (expand-file-name (user-login-name) rmail-spool-directory))))
 356       (directory
 357        (:prescript)
 358        (:prescript-delay)
 359        (:postscript)
 360        (:path)
 361        (:suffix ".spool")
 362        (:predicate identity))
 363       (pop
 364        (:prescript)
 365        (:prescript-delay)
 366        (:postscript)
 367        (:server (getenv "MAILHOST"))
 368        (:port 110)
 369        (:user (or (user-login-name) (getenv "LOGNAME") (getenv "USER")))
 370        (:program)
 371        (:function)
 372        (:password)
 373        (:authentication password)
 374        (:stream nil))
 375       (maildir
 376        (:path (or (getenv "MAILDIR") "~/Maildir/"))
 377        (:subdirs ("cur" "new"))
 378        (:function))
 379       (imap
 380        (:server (getenv "MAILHOST"))
 381        (:port)
 382        (:stream)
 383        (:program)
 384        (:authentication)
 385        (:user (or (user-login-name) (getenv "LOGNAME") (getenv "USER")))
 386        (:password)
 387        (:mailbox "INBOX")
 388        (:predicate "UNSEEN UNDELETED")
 389        (:fetchflag "\\Deleted")
 390        (:prescript)
 391        (:prescript-delay)
 392        (:postscript)
 393        (:dontexpunge))
 394       (webmail
 395        (:subtype hotmail)
 396        (:user (or (user-login-name) (getenv "LOGNAME") (getenv "USER")))
 397        (:password)
 398        (:dontexpunge)
 399        (:authentication password)))
 400     "Mapping from keywords to default values.
 401 All keywords that can be used must be listed here."))
 402
 403 (defvar mail-source-fetcher-alist
 404   '((file mail-source-fetch-file)
 405     (directory mail-source-fetch-directory)
 406     (pop mail-source-fetch-pop)
 407     (maildir mail-source-fetch-maildir)
 408     (imap mail-source-fetch-imap)
 409     (webmail mail-source-fetch-webmail))
 410   "A mapping from source type to fetcher function.")
 411
 412 (defvar mail-source-password-cache nil)
 413
 414 (defvar mail-source-plugged t)
 415
 416 ;;; Functions
 417
 418 (eval-and-compile
 419   (defun mail-source-strip-keyword (keyword)
 420     "Strip the leading colon off the KEYWORD."
 421     (intern (substring (symbol-name keyword) 1))))
 422
 423 ;; generate a list of variable names paired with nil values
 424 ;; suitable for usage in a `let' form
 425 (eval-and-compile
 426   (defun mail-source-bind-1 (type)
 427     (let* ((defaults (cdr (assq type mail-source-keyword-map)))
 428            default bind)
 429       (while (setq default (pop defaults))
 430         (push (list (mail-source-strip-keyword (car default))
 431                     nil)
 432               bind))
 433       bind)))
 434
 435 (defmacro mail-source-bind (type-source &rest body)
 436   "Return a `let' form that binds all variables in source TYPE.
 437 TYPE-SOURCE is a list where the first element is the TYPE, and
 438 the second variable is the SOURCE.
 439 At run time, the mail source specifier SOURCE will be inspected,
 440 and the variables will be set according to it.  Variables not
 441 specified will be given default values.
 442
 443 The user and password will be loaded from the auth-source values
 444 if those are available.  They override the original user and
 445 password in a second `let' form.
 446
 447 After this is done, BODY will be executed in the scope
 448 of the second `let' form.
 449
 450 The variables bound and their default values are described by
 451 the `mail-source-keyword-map' variable."
 452   `(let* ,(mail-source-bind-1 (car type-source))
 453      (mail-source-set-1 ,(cadr type-source))
 454      (let ((user
 455             (or
 456              (auth-source-user-or-password
 457               "login"
 458               server          ; this is "host" in auth-sources
 459               ',(car type-source))
 460              (when (boundp 'user) (symbol-value 'user))))
 461            (password
 462             (or
 463              (auth-source-user-or-password
 464               "password"
 465               server          ; this is "host" in auth-sources
 466               ',(car type-source))
 467              (when (boundp 'user) (symbol-value 'user)))))
 468        (unless user
 469          (unintern 'user))
 470        (unless password
 471          (unintern 'password))
 472        ,@body)))
 473
 474 (put 'mail-source-bind 'lisp-indent-function 1)
 475 (put 'mail-source-bind 'edebug-form-spec '(sexp body))
 476
 477 (defun mail-source-set-1 (source)
 478   (let* ((type (pop source))
 479          (defaults (cdr (assq type mail-source-keyword-map)))
 480          default value keyword)
 481     (while (setq default (pop defaults))
 482       ;; for each default :SYMBOL, set SYMBOL to the plist value for :SYMBOL
 483       ;; using `mail-source-value' to evaluate the plist value
 484       (set (mail-source-strip-keyword (setq keyword (car default)))
 485            (if (setq value (plist-get source keyword))
 486                (mail-source-value value)
 487              (mail-source-value (cadr default)))))))
 488
 489 (eval-and-compile
 490   (defun mail-source-bind-common-1 ()
 491     (let* ((defaults mail-source-common-keyword-map)
 492            default bind)
 493       (while (setq default (pop defaults))
 494         (push (list (mail-source-strip-keyword (car default))
 495                     nil)
 496               bind))
 497       bind)))
 498
 499 (defun mail-source-set-common-1 (source)
 500   (let* ((type (pop source))
 501          (defaults mail-source-common-keyword-map)
 502          (defaults-1 (cdr (assq type mail-source-keyword-map)))
 503          default value keyword)
 504     (while (setq default (pop defaults))
 505       (set (mail-source-strip-keyword (setq keyword (car default)))
 506            (if (setq value (plist-get source keyword))
 507                (mail-source-value value)
 508              (if (setq value (assq  keyword defaults-1))
 509                  (mail-source-value (cadr value))
 510                (mail-source-value (cadr default))))))))
 511
 512 (defmacro mail-source-bind-common (source &rest body)
 513   "Return a `let' form that binds all common variables.
 514 See `mail-source-bind'."
 515   `(let ,(mail-source-bind-common-1)
 516      (mail-source-set-common-1 source)
 517      ,@body))
 518
 519 (put 'mail-source-bind-common 'lisp-indent-function 1)
 520 (put 'mail-source-bind-common 'edebug-form-spec '(sexp body))
 521
 522 (defun mail-source-value (value)
 523   "Return the value of VALUE."
 524   (cond
 525    ;; String
 526    ((stringp value)
 527     value)
 528    ;; Function
 529    ((and (listp value) (symbolp (car value)) (fboundp (car value)))
 530     (eval value))
 531    ;; Just return the value.
 532    (t
 533     value)))
 534
 535 (defun mail-source-fetch (source callback)
 536   "Fetch mail from SOURCE and call CALLBACK zero or more times.
 537 CALLBACK will be called with the name of the file where (some of)
 538 the mail from SOURCE is put.
 539 Return the number of files that were found."
 540   (mail-source-bind-common source
 541     (if (or mail-source-plugged plugged)
 542         (save-excursion
 543           (let ((function (cadr (assq (car source) mail-source-fetcher-alist)))
 544                 (found 0))
 545             (unless function
 546               (error "%S is an invalid mail source specification" source))
 547             ;; If there's anything in the crash box, we do it first.
 548             (when (file-exists-p mail-source-crash-box)
 549               (message "Processing mail from %s..." mail-source-crash-box)
 550               (setq found (mail-source-callback
 551                            callback mail-source-crash-box))
 552               (mail-source-delete-crash-box))
 553             (+ found
 554                (if (or debug-on-quit debug-on-error)
 555                    (funcall function source callback)
 556                  (condition-case err
 557                      (funcall function source callback)
 558                    (error
 559                     (if (and (not mail-source-ignore-errors)
 560                              (not
 561                               (yes-or-no-p
 562                                (format "Mail source %s error (%s).  Continue? "
 563                                        (if (memq ':password source)
 564                                            (let ((s (copy-sequence source)))
 565                                              (setcar (cdr (memq ':password s))
 566                                                      "********")
 567                                              s)
 568                                          source)
 569                                        (cadr err)))))
 570                       (error "Cannot get new mail"))
 571                     0)))))))))
 572
 573 (defun mail-source-delete-old-incoming (&optional age confirm)
 574   "Remove incoming files older than AGE days.
 575 If CONFIRM is non-nil, ask for confirmation before removing a file."
 576   (interactive "P")
 577   (let* ((high2days (/ 65536.0 60 60 24));; convert high bits to days
 578          (low2days  (/ 1.0 65536.0))     ;; convert low bits to days
 579          (diff (if (natnump age) age 30));; fallback, if no valid AGE given
 580          currday files)
 581     (setq files (directory-files
 582                  mail-source-directory t
 583                  (concat "\\`"
 584                          (regexp-quote mail-source-incoming-file-prefix)))
 585           currday (* (car (current-time)) high2days)
 586           currday (+ currday (* low2days (nth 1 (current-time)))))
 587     (while files
 588       (let* ((ffile (car files))
 589              (bfile (gnus-replace-in-string
 590                      ffile "\\`.*/\\([^/]+\\)\\'" "\\1"))
 591              (filetime (nth 5 (file-attributes ffile)))
 592              (fileday (* (car filetime) high2days))
 593              (fileday (+ fileday (* low2days (nth 1 filetime)))))
 594         (setq files (cdr files))
 595         (when (and (> (- currday fileday) diff)
 596                    (if confirm
 597                        (y-or-n-p
 598                         (format "\
 599 Delete old (> %s day(s)) incoming mail file `%s'? " diff bfile))
 600                      (gnus-message 8 "\
 601 Deleting old (> %s day(s)) incoming mail file `%s'." diff bfile)
 602                      t))
 603           (delete-file ffile))))))
 604
 605 (defun mail-source-callback (callback info)
 606   "Call CALLBACK on the mail file.  Pass INFO on to CALLBACK."
 607   (if (or (not (file-exists-p mail-source-crash-box))
 608           (zerop (nth 7 (file-attributes mail-source-crash-box))))
 609       (progn
 610         (when (file-exists-p mail-source-crash-box)
 611           (delete-file mail-source-crash-box))
 612         0)
 613     (funcall callback mail-source-crash-box info)))
 614
 615 (defun mail-source-delete-crash-box ()
 616   (when (file-exists-p mail-source-crash-box)
 617     ;; Delete or move the incoming mail out of the way.
 618     (if (eq mail-source-delete-incoming t)
 619         (delete-file mail-source-crash-box)
 620       (let ((incoming
 621              (mm-make-temp-file
 622               (expand-file-name
 623                mail-source-incoming-file-prefix
 624                mail-source-directory))))
 625         (unless (file-exists-p (file-name-directory incoming))
 626           (make-directory (file-name-directory incoming) t))
 627         (rename-file mail-source-crash-box incoming t)
 628         ;; remove old incoming files?
 629         (when (natnump mail-source-delete-incoming)
 630           (mail-source-delete-old-incoming
 631            mail-source-delete-incoming
 632            mail-source-delete-old-incoming-confirm))))))
 633
 634 (defun mail-source-movemail (from to)
 635   "Move FROM to TO using movemail."
 636   (if (not (file-writable-p to))
 637       (error "Can't write to crash box %s.  Not moving mail" to)
 638     (let ((to (file-truename (expand-file-name to)))
 639           errors result)
 640       (setq to (file-truename to)
 641             from (file-truename from))
 642       ;; Set TO if have not already done so, and rename or copy
 643       ;; the file FROM to TO if and as appropriate.
 644       (cond
 645        ((file-exists-p to)
 646         ;; The crash box exists already.
 647         t)
 648        ((not (file-exists-p from))
 649         ;; There is no inbox.
 650         (setq to nil))
 651        ((zerop (nth 7 (file-attributes from)))
 652         ;; Empty file.
 653         (setq to nil))
 654        (t
 655         ;; If getting from mail spool directory, use movemail to move
 656         ;; rather than just renaming, so as to interlock with the
 657         ;; mailer.
 658         (unwind-protect
 659             (save-excursion
 660               (setq errors (generate-new-buffer " *mail source loss*"))
 661               (let ((default-directory "/"))
 662                 (setq result
 663                       (apply
 664                        'call-process
 665                        (append
 666                         (list
 667                          (or mail-source-movemail-program
 668                              (expand-file-name "movemail" exec-directory))
 669                          nil errors nil from to)))))
 670               (when (file-exists-p to)
 671                 (set-file-modes to mail-source-default-file-modes))
 672               (if (and (or (not (buffer-modified-p errors))
 673                            (zerop (buffer-size errors)))
 674                        (and (numberp result)
 675                             (zerop result)))
 676                   ;; No output => movemail won.
 677                   t
 678                 (set-buffer errors)
 679                 ;; There may be a warning about older revisions.  We
 680                 ;; ignore that.
 681                 (goto-char (point-min))
 682                 (if (search-forward "older revision" nil t)
 683                     t
 684                   ;; Probably a real error.
 685                   (subst-char-in-region (point-min) (point-max) ?\n ?\  )
 686                   (goto-char (point-max))
 687                   (skip-chars-backward " \t")
 688                   (delete-region (point) (point-max))
 689                   (goto-char (point-min))
 690                   (when (looking-at "movemail: ")
 691                     (delete-region (point-min) (match-end 0)))
 692                   ;; Result may be a signal description string.
 693                   (unless (yes-or-no-p
 694                            (format "movemail: %s (%s return).  Continue? "
 695                                    (buffer-string) result))
 696                     (error "%s" (buffer-string)))
 697                   (setq to nil)))))))
 698       (when (and errors
 699                  (buffer-name errors))
 700         (kill-buffer errors))
 701       ;; Return whether we moved successfully or not.
 702       to)))
 703
 704 (defun mail-source-movemail-and-remove (from to)
 705   "Move FROM to TO using movemail, then remove FROM if empty."
 706   (or (not (mail-source-movemail from to))
 707       (not (zerop (nth 7 (file-attributes from))))
 708       (delete-file from)))
 709
 710 (defun mail-source-fetch-with-program (program)
 711   (eq 0 (call-process shell-file-name nil nil nil
 712                       shell-command-switch program)))
 713
 714 (defun mail-source-run-script (script spec &optional delay)
 715   (when script
 716     (if (functionp script)
 717         (funcall script)
 718       (mail-source-call-script
 719        (format-spec script spec))))
 720   (when delay
 721     (sleep-for delay)))
 722
 723 (defun mail-source-call-script (script)
 724   (let ((background nil)
 725         (stderr (get-buffer-create " *mail-source-stderr*"))
 726         result)
 727     (when (string-match "& *$" script)
 728       (setq script (substring script 0 (match-beginning 0))
 729             background 0))
 730     (setq result
 731           (call-process shell-file-name nil background nil
 732                         shell-command-switch script))
 733     (when (and result
 734                (not (zerop result)))
 735       (set-buffer stderr)
 736       (message "Mail source error: %s" (buffer-string)))
 737     (kill-buffer stderr)))
 738
 739 ;;;
 740 ;;; Different fetchers
 741 ;;;
 742
 743 (defun mail-source-fetch-file (source callback)
 744   "Fetcher for single-file sources."
 745   (mail-source-bind (file source)
 746     (mail-source-run-script
 747      prescript (format-spec-make ?t mail-source-crash-box)
 748      prescript-delay)
 749     (let ((mail-source-string (format "file:%s" path)))
 750       (if (mail-source-movemail path mail-source-crash-box)
 751           (prog1
 752               (mail-source-callback callback path)
 753             (mail-source-run-script
 754              postscript (format-spec-make ?t mail-source-crash-box))
 755             (mail-source-delete-crash-box))
 756         0))))
 757
 758 (defun mail-source-fetch-directory (source callback)
 759   "Fetcher for directory sources."
 760   (mail-source-bind (directory source)
 761     (mail-source-run-script
 762      prescript (format-spec-make ?t path) prescript-delay)
 763     (let ((found 0)
 764           (mail-source-string (format "directory:%s" path)))
 765       (dolist (file (directory-files
 766                      path t (concat (regexp-quote suffix) "$")))
 767         (when (and (file-regular-p file)
 768                    (funcall predicate file)
 769                    (mail-source-movemail file mail-source-crash-box))
 770           (incf found (mail-source-callback callback file))
 771           (mail-source-run-script postscript (format-spec-make ?t path))
 772           (mail-source-delete-crash-box)))
 773       found)))
 774
 775 (defun mail-source-fetch-pop (source callback)
 776   "Fetcher for single-file sources."
 777   (mail-source-bind (pop source)
 778     ;; fixme: deal with stream type in format specs
 779     (mail-source-run-script
 780      prescript
 781      (format-spec-make ?p password ?t mail-source-crash-box
 782                        ?s server ?P port ?u user)
 783      prescript-delay)
 784     (let ((from (format "%s:%s:%s" server user port))
 785           (mail-source-string (format "pop:%s@%s" user server))
 786           result)
 787       (when (eq authentication 'password)
 788         (setq password
 789               (or password
 790                   (cdr (assoc from mail-source-password-cache))
 791                   (read-passwd
 792                    (format "Password for %s at %s: " user server)))))
 793       (when server
 794         (setenv "MAILHOST" server))
 795       (setq result
 796             (cond
 797              (program
 798               (mail-source-fetch-with-program
 799                (format-spec
 800                 program
 801                 (format-spec-make ?p password ?t mail-source-crash-box
 802                                   ?s server ?P port ?u user))))
 803              (function
 804               (funcall function mail-source-crash-box))
 805              ;; The default is to use pop3.el.
 806              (t
 807               (require 'pop3)
 808               (let ((pop3-password password)
 809                     (pop3-maildrop user)
 810                     (pop3-mailhost server)
 811                     (pop3-port port)
 812                     (pop3-authentication-scheme
 813                      (if (eq authentication 'apop) 'apop 'pass))
 814                     (pop3-stream-type stream))
 815                 (if (or debug-on-quit debug-on-error)
 816                     (save-excursion (pop3-movemail mail-source-crash-box))
 817                   (condition-case err
 818                       (save-excursion (pop3-movemail mail-source-crash-box))
 819                     (error
 820                      ;; We nix out the password in case the error
 821                      ;; was because of a wrong password being given.
 822                      (setq mail-source-password-cache
 823                            (delq (assoc from mail-source-password-cache)
 824                                  mail-source-password-cache))
 825                      (signal (car err) (cdr err)))))))))
 826       (if result
 827           (progn
 828             (when (eq authentication 'password)
 829               (unless (assoc from mail-source-password-cache)
 830                 (push (cons from password) mail-source-password-cache)))
 831             (prog1
 832                 (mail-source-callback callback server)
 833               ;; Update display-time's mail flag, if relevant.
 834               (if (equal source mail-source-primary-source)
 835                   (setq mail-source-new-mail-available nil))
 836               (mail-source-run-script
 837                postscript
 838                (format-spec-make ?p password ?t mail-source-crash-box
 839                                  ?s server ?P port ?u user))
 840               (mail-source-delete-crash-box)))
 841         ;; We nix out the password in case the error
 842         ;; was because of a wrong password being given.
 843         (setq mail-source-password-cache
 844               (delq (assoc from mail-source-password-cache)
 845                     mail-source-password-cache))
 846         0))))
 847
 848 (defun mail-source-check-pop (source)
 849   "Check whether there is new mail."
 850   (mail-source-bind (pop source)
 851     (let ((from (format "%s:%s:%s" server user port))
 852           (mail-source-string (format "pop:%s@%s" user server))
 853           result)
 854       (when (eq authentication 'password)
 855         (setq password
 856               (or password
 857                   (cdr (assoc from mail-source-password-cache))
 858                   (read-passwd
 859                    (format "Password for %s at %s: " user server))))
 860         (unless (assoc from mail-source-password-cache)
 861           (push (cons from password) mail-source-password-cache)))
 862       (when server
 863         (setenv "MAILHOST" server))
 864       (setq result
 865             (cond
 866              ;; No easy way to check whether mail is waiting for these.
 867              (program)
 868              (function)
 869              ;; The default is to use pop3.el.
 870              (t
 871               (require 'pop3)
 872               (let ((pop3-password password)
 873                     (pop3-maildrop user)
 874                     (pop3-mailhost server)
 875                     (pop3-port port)
 876                     (pop3-authentication-scheme
 877                      (if (eq authentication 'apop) 'apop 'pass)))
 878                 (if (or debug-on-quit debug-on-error)
 879                     (save-excursion (pop3-get-message-count))
 880                   (condition-case err
 881                       (save-excursion (pop3-get-message-count))
 882                     (error
 883                      ;; We nix out the password in case the error
 884                      ;; was because of a wrong password being given.
 885                      (setq mail-source-password-cache
 886                            (delq (assoc from mail-source-password-cache)
 887                                  mail-source-password-cache))
 888                      (signal (car err) (cdr err)))))))))
 889       (if result
 890           ;; Inform display-time that we have new mail.
 891           (setq mail-source-new-mail-available (> result 0))
 892         ;; We nix out the password in case the error
 893         ;; was because of a wrong password being given.
 894         (setq mail-source-password-cache
 895               (delq (assoc from mail-source-password-cache)
 896                     mail-source-password-cache)))
 897       result)))
 898
 899 (defun mail-source-touch-pop ()
 900   "Open and close a POP connection shortly.
 901 POP server should be defined in `mail-source-primary-source' (which is
 902 preferred) or `mail-sources'.  You may use it for the POP-before-SMTP
 903 authentication.  To do that, you need to set the
 904 `message-send-mail-function' variable as `message-smtpmail-send-it'
 905 and put the following line in your ~/.gnus.el file:
 906
 907 \(add-hook 'message-send-mail-hook 'mail-source-touch-pop)
 908
 909 See the Gnus manual for details."
 910   (let ((sources (if mail-source-primary-source
 911                      (list mail-source-primary-source)
 912                    mail-sources)))
 913     (while sources
 914       (if (eq 'pop (car (car sources)))
 915           (mail-source-check-pop (car sources)))
 916       (setq sources (cdr sources)))))
 917
 918 (defun mail-source-new-mail-p ()
 919   "Handler for `display-time' to indicate when new mail is available."
 920   ;; Flash (ie. ring the visible bell) if mail is available.
 921   (if (and mail-source-flash mail-source-new-mail-available)
 922       (let ((visible-bell t))
 923         (ding)))
 924   ;; Only report flag setting; flag is updated on a different schedule.
 925   mail-source-new-mail-available)
 926
 927
 928 (defvar mail-source-report-new-mail nil)
 929 (defvar mail-source-report-new-mail-timer nil)
 930 (defvar mail-source-report-new-mail-idle-timer nil)
 931
 932 (defun mail-source-start-idle-timer ()
 933   ;; Start our idle timer if necessary, so we delay the check until the
 934   ;; user isn't typing.
 935   (unless mail-source-report-new-mail-idle-timer
 936     (setq mail-source-report-new-mail-idle-timer
 937           (run-with-idle-timer
 938            mail-source-idle-time-delay
 939            nil
 940            (lambda ()
 941              (unwind-protect
 942                  (mail-source-check-pop mail-source-primary-source)
 943                (setq mail-source-report-new-mail-idle-timer nil)))))
 944     ;; Since idle timers created when Emacs is already in the idle
 945     ;; state don't get activated until Emacs _next_ becomes idle, we
 946     ;; need to force our timer to be considered active now.  We do
 947     ;; this by being naughty and poking the timer internals directly
 948     ;; (element 0 of the vector is nil if the timer is active).
 949     (aset mail-source-report-new-mail-idle-timer 0 nil)))
 950
 951 (defun mail-source-report-new-mail (arg)
 952   "Toggle whether to report when new mail is available.
 953 This only works when `display-time' is enabled."
 954   (interactive "P")
 955   (if (not mail-source-primary-source)
 956       (error "Need to set `mail-source-primary-source' to check for new mail"))
 957   (let ((on (if (null arg)
 958                 (not mail-source-report-new-mail)
 959               (> (prefix-numeric-value arg) 0))))
 960     (setq mail-source-report-new-mail on)
 961     (and mail-source-report-new-mail-timer
 962          (nnheader-cancel-timer mail-source-report-new-mail-timer))
 963     (and mail-source-report-new-mail-idle-timer
 964          (nnheader-cancel-timer mail-source-report-new-mail-idle-timer))
 965     (setq mail-source-report-new-mail-timer nil)
 966     (setq mail-source-report-new-mail-idle-timer nil)
 967     (if on
 968         (progn
 969           (require 'time)
 970           ;; display-time-mail-function is an Emacs 21 feature.
 971           (setq display-time-mail-function #'mail-source-new-mail-p)
 972           ;; Set up the main timer.
 973           (setq mail-source-report-new-mail-timer
 974                 (run-at-time
 975                  (* 60 mail-source-report-new-mail-interval)
 976                  (* 60 mail-source-report-new-mail-interval)
 977                  #'mail-source-start-idle-timer))
 978           ;; When you get new mail, clear "Mail" from the mode line.
 979           (add-hook 'nnmail-post-get-new-mail-hook
 980                     'display-time-event-handler)
 981           (message "Mail check enabled"))
 982       (setq display-time-mail-function nil)
 983       (remove-hook 'nnmail-post-get-new-mail-hook
 984                    'display-time-event-handler)
 985       (message "Mail check disabled"))))
 986
 987 (defun mail-source-fetch-maildir (source callback)
 988   "Fetcher for maildir sources."
 989   (mail-source-bind (maildir source)
 990     (let ((found 0)
 991           mail-source-string)
 992       (unless (string-match "/$" path)
 993         (setq path (concat path "/")))
 994       (dolist (subdir subdirs)
 995         (when (file-directory-p (concat path subdir))
 996           (setq mail-source-string (format "maildir:%s%s" path subdir))
 997           (dolist (file (directory-files (concat path subdir) t))
 998             (when (and (not (file-directory-p file))
 999                        (not (if function
1000                                 (funcall function file mail-source-crash-box)
1001                               (let ((coding-system-for-write
1002                                      mm-text-coding-system)
1003                                     (coding-system-for-read
1004                                      mm-text-coding-system))
1005                                 (with-temp-file mail-source-crash-box
1006                                   (insert-file-contents file)
1007                                   (goto-char (point-min))
1008 ;;;                               ;; Unix mail format
1009 ;;;                               (unless (looking-at "\n*From ")
1010 ;;;                                 (insert "From maildir "
1011 ;;;                                         (current-time-string) "\n"))
1012 ;;;                               (while (re-search-forward "^From " nil t)
1013 ;;;                                 (replace-match ">From "))
1014 ;;;                               (goto-char (point-max))
1015 ;;;                               (insert "\n\n")
1016                                   ;; MMDF mail format
1017                                   (insert "\001\001\001\001\n"))
1018                                 (delete-file file)))))
1019               (incf found (mail-source-callback callback file))
1020               (mail-source-delete-crash-box)))))
1021       found)))
1022
1023 (eval-and-compile
1024   (autoload 'imap-open "imap")
1025   (autoload 'imap-authenticate "imap")
1026   (autoload 'imap-mailbox-select "imap")
1027   (autoload 'imap-mailbox-unselect "imap")
1028   (autoload 'imap-mailbox-close "imap")
1029   (autoload 'imap-search "imap")
1030   (autoload 'imap-fetch "imap")
1031   (autoload 'imap-close "imap")
1032   (autoload 'imap-error-text "imap")
1033   (autoload 'imap-message-flags-add "imap")
1034   (autoload 'imap-list-to-message-set "imap")
1035   (autoload 'imap-range-to-message-set "imap")
1036   (autoload 'nnheader-ms-strip-cr "nnheader"))
1037
1038 (autoload 'gnus-compress-sequence "gnus-range")
1039
1040 (defvar mail-source-imap-file-coding-system 'binary
1041   "Coding system for the crashbox made by `mail-source-fetch-imap'.")
1042
1043 ;; Autoloads will bring in imap before this is called.
1044 (declare-function imap-capability "imap" (&optional identifier buffer))
1045
1046 (defun mail-source-fetch-imap (source callback)
1047   "Fetcher for imap sources."
1048   (mail-source-bind (imap source)
1049     (mail-source-run-script
1050      prescript (format-spec-make ?p password ?t mail-source-crash-box
1051                                  ?s server ?P port ?u user)
1052      prescript-delay)
1053     (let ((from (format "%s:%s:%s" server user port))
1054           (found 0)
1055           (buf (generate-new-buffer " *imap source*"))
1056           (mail-source-string (format "imap:%s:%s" server mailbox))
1057           (imap-shell-program (or (list program) imap-shell-program))
1058           remove)
1059       (if (and (imap-open server port stream authentication buf)
1060                (imap-authenticate
1061                 user (or (cdr (assoc from mail-source-password-cache))
1062                          password) buf)
1063                (imap-mailbox-select mailbox nil buf))
1064           (let ((coding-system-for-write mail-source-imap-file-coding-system)
1065                 str)
1066             (with-temp-file mail-source-crash-box
1067               ;; Avoid converting 8-bit chars from inserted strings to
1068               ;; multibyte.
1069               (mm-disable-multibyte)
1070               ;; remember password
1071               (with-current-buffer buf
1072                 (when (and imap-password
1073                            (not (assoc from mail-source-password-cache)))
1074                   (push (cons from imap-password) mail-source-password-cache)))
1075               ;; if predicate is nil, use all uids
1076               (dolist (uid (imap-search (or predicate "1:*") buf))
1077                 (when (setq str
1078                             (if (imap-capability 'IMAP4rev1 buf)
1079                                 (caddar (imap-fetch uid "BODY.PEEK[]"
1080                                                     'BODYDETAIL nil buf))
1081                               (imap-fetch uid "RFC822.PEEK" 'RFC822 nil buf)))
1082                   (push uid remove)
1083                   (insert "From imap " (current-time-string) "\n")
1084                   (save-excursion
1085                     (insert str "\n\n"))
1086                   (while (let ((case-fold-search nil))
1087                            (re-search-forward "^From " nil t))
1088                     (replace-match ">From "))
1089                   (goto-char (point-max))))
1090               (nnheader-ms-strip-cr))
1091             (incf found (mail-source-callback callback server))
1092             (mail-source-delete-crash-box)
1093             (when (and remove fetchflag)
1094               (setq remove (nreverse remove))
1095               (imap-message-flags-add
1096                (imap-range-to-message-set (gnus-compress-sequence remove))
1097                fetchflag nil buf))
1098             (if dontexpunge
1099                 (imap-mailbox-unselect buf)
1100               (imap-mailbox-close nil buf))
1101             (imap-close buf))
1102         (imap-close buf)
1103         ;; We nix out the password in case the error
1104         ;; was because of a wrong password being given.
1105         (setq mail-source-password-cache
1106               (delq (assoc from mail-source-password-cache)
1107                     mail-source-password-cache))
1108         (error "IMAP error: %s" (imap-error-text buf)))
1109       (kill-buffer buf)
1110       (mail-source-run-script
1111        postscript
1112        (format-spec-make ?p password ?t mail-source-crash-box
1113                          ?s server ?P port ?u user))
1114       found)))
1115
1116 (eval-and-compile
1117   (autoload 'webmail-fetch "webmail"))
1118
1119 (defun mail-source-fetch-webmail (source callback)
1120   "Fetch for webmail source."
1121   (mail-source-bind (webmail source)
1122     (let ((mail-source-string (format "webmail:%s:%s" subtype user))
1123           (webmail-newmail-only dontexpunge)
1124           (webmail-move-to-trash-can (not dontexpunge)))
1125       (when (eq authentication 'password)
1126         (setq password
1127               (or password
1128                   (cdr (assoc (format "webmail:%s:%s" subtype user)
1129                               mail-source-password-cache))
1130                   (read-passwd
1131                    (format "Password for %s at %s: " user subtype))))
1132         (when (and password
1133                    (not (assoc (format "webmail:%s:%s" subtype user)
1134                                mail-source-password-cache)))
1135           (push (cons (format "webmail:%s:%s" subtype user) password)
1136                 mail-source-password-cache)))
1137       (webmail-fetch mail-source-crash-box subtype user password)
1138       (mail-source-callback callback (symbol-name subtype))
1139       (mail-source-delete-crash-box))))
1140
1141 (provide 'mail-source)
1142
1143 ;; arch-tag: 72948025-1d17-4d6c-bb12-ef1aa2c490fd
1144 ;;; mail-source.el ends here