code.delx.au - gnu-emacs/blob - lisp/gnus/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      ,@body))
 455
 456 (put 'mail-source-bind 'lisp-indent-function 1)
 457 (put 'mail-source-bind 'edebug-form-spec '(sexp body))
 458
 459 (defun mail-source-set-1 (source)
 460   (let* ((type (pop source))
 461          (defaults (cdr (assq type mail-source-keyword-map)))
 462          default value keyword user-auth pass-auth)
 463     (while (setq default (pop defaults))
 464       ;; for each default :SYMBOL, set SYMBOL to the plist value for :SYMBOL
 465       ;; using `mail-source-value' to evaluate the plist value
 466       (set (mail-source-strip-keyword (setq keyword (car default)))
 467            ;; note the following reasons for this structure:
 468            ;; 1) the auth-sources user and password override everything
 469            ;; 2) it avoids macros, so it's cleaner
 470            ;; 3) it falls through to the mail-sources and then default values
 471            (cond
 472             ((and
 473              (eq keyword :user)
 474              (setq user-auth
 475                    (auth-source-user-or-password
 476                     "login"
 477                     ;; this is "host" in auth-sources
 478                     (if (boundp 'server) (symbol-value 'server) "")
 479                     type)))
 480              user-auth)
 481             ((and
 482              (eq keyword :password)
 483              (setq pass-auth
 484                    (auth-source-user-or-password
 485                     "password"
 486                     ;; this is "host" in auth-sources
 487                     (if (boundp 'server) (symbol-value 'server) "")
 488                     type)))
 489              pass-auth)
 490             (t (if (setq value (plist-get source keyword))
 491                  (mail-source-value value)
 492                (mail-source-value (cadr default)))))))))
 493
 494 (eval-and-compile
 495   (defun mail-source-bind-common-1 ()
 496     (let* ((defaults mail-source-common-keyword-map)
 497            default bind)
 498       (while (setq default (pop defaults))
 499         (push (list (mail-source-strip-keyword (car default))
 500                     nil)
 501               bind))
 502       bind)))
 503
 504 (defun mail-source-set-common-1 (source)
 505   (let* ((type (pop source))
 506          (defaults mail-source-common-keyword-map)
 507          (defaults-1 (cdr (assq type mail-source-keyword-map)))
 508          default value keyword)
 509     (while (setq default (pop defaults))
 510       (set (mail-source-strip-keyword (setq keyword (car default)))
 511            (if (setq value (plist-get source keyword))
 512                (mail-source-value value)
 513              (if (setq value (assq  keyword defaults-1))
 514                  (mail-source-value (cadr value))
 515                (mail-source-value (cadr default))))))))
 516
 517 (defmacro mail-source-bind-common (source &rest body)
 518   "Return a `let' form that binds all common variables.
 519 See `mail-source-bind'."
 520   `(let ,(mail-source-bind-common-1)
 521      (mail-source-set-common-1 source)
 522      ,@body))
 523
 524 (put 'mail-source-bind-common 'lisp-indent-function 1)
 525 (put 'mail-source-bind-common 'edebug-form-spec '(sexp body))
 526
 527 (defun mail-source-value (value)
 528   "Return the value of VALUE."
 529   (cond
 530    ;; String
 531    ((stringp value)
 532     value)
 533    ;; Function
 534    ((and (listp value) (symbolp (car value)) (fboundp (car value)))
 535     (eval value))
 536    ;; Just return the value.
 537    (t
 538     value)))
 539
 540 (defun mail-source-fetch (source callback)
 541   "Fetch mail from SOURCE and call CALLBACK zero or more times.
 542 CALLBACK will be called with the name of the file where (some of)
 543 the mail from SOURCE is put.
 544 Return the number of files that were found."
 545   (mail-source-bind-common source
 546     (if (or mail-source-plugged plugged)
 547         (save-excursion
 548           (let ((function (cadr (assq (car source) mail-source-fetcher-alist)))
 549                 (found 0))
 550             (unless function
 551               (error "%S is an invalid mail source specification" source))
 552             ;; If there's anything in the crash box, we do it first.
 553             (when (file-exists-p mail-source-crash-box)
 554               (message "Processing mail from %s..." mail-source-crash-box)
 555               (setq found (mail-source-callback
 556                            callback mail-source-crash-box))
 557               (mail-source-delete-crash-box))
 558             (+ found
 559                (if (or debug-on-quit debug-on-error)
 560                    (funcall function source callback)
 561                  (condition-case err
 562                      (funcall function source callback)
 563                    (error
 564                     (if (and (not mail-source-ignore-errors)
 565                              (not
 566                               (yes-or-no-p
 567                                (format "Mail source %s error (%s).  Continue? "
 568                                        (if (memq ':password source)
 569                                            (let ((s (copy-sequence source)))
 570                                              (setcar (cdr (memq ':password s))
 571                                                      "********")
 572                                              s)
 573                                          source)
 574                                        (cadr err)))))
 575                       (error "Cannot get new mail"))
 576                     0)))))))))
 577
 578 (defun mail-source-delete-old-incoming (&optional age confirm)
 579   "Remove incoming files older than AGE days.
 580 If CONFIRM is non-nil, ask for confirmation before removing a file."
 581   (interactive "P")
 582   (let* ((high2days (/ 65536.0 60 60 24));; convert high bits to days
 583          (low2days  (/ 1.0 65536.0))     ;; convert low bits to days
 584          (diff (if (natnump age) age 30));; fallback, if no valid AGE given
 585          currday files)
 586     (setq files (directory-files
 587                  mail-source-directory t
 588                  (concat "\\`"
 589                          (regexp-quote mail-source-incoming-file-prefix)))
 590           currday (* (car (current-time)) high2days)
 591           currday (+ currday (* low2days (nth 1 (current-time)))))
 592     (while files
 593       (let* ((ffile (car files))
 594              (bfile (gnus-replace-in-string
 595                      ffile "\\`.*/\\([^/]+\\)\\'" "\\1"))
 596              (filetime (nth 5 (file-attributes ffile)))
 597              (fileday (* (car filetime) high2days))
 598              (fileday (+ fileday (* low2days (nth 1 filetime)))))
 599         (setq files (cdr files))
 600         (when (and (> (- currday fileday) diff)
 601                    (if confirm
 602                        (y-or-n-p
 603                         (format "\
 604 Delete old (> %s day(s)) incoming mail file `%s'? " diff bfile))
 605                      (gnus-message 8 "\
 606 Deleting old (> %s day(s)) incoming mail file `%s'." diff bfile)
 607                      t))
 608           (delete-file ffile))))))
 609
 610 (defun mail-source-callback (callback info)
 611   "Call CALLBACK on the mail file.  Pass INFO on to CALLBACK."
 612   (if (or (not (file-exists-p mail-source-crash-box))
 613           (zerop (nth 7 (file-attributes mail-source-crash-box))))
 614       (progn
 615         (when (file-exists-p mail-source-crash-box)
 616           (delete-file mail-source-crash-box))
 617         0)
 618     (funcall callback mail-source-crash-box info)))
 619
 620 (defun mail-source-delete-crash-box ()
 621   (when (file-exists-p mail-source-crash-box)
 622     ;; Delete or move the incoming mail out of the way.
 623     (if (eq mail-source-delete-incoming t)
 624         (delete-file mail-source-crash-box)
 625       (let ((incoming
 626              (mm-make-temp-file
 627               (expand-file-name
 628                mail-source-incoming-file-prefix
 629                mail-source-directory))))
 630         (unless (file-exists-p (file-name-directory incoming))
 631           (make-directory (file-name-directory incoming) t))
 632         (rename-file mail-source-crash-box incoming t)
 633         ;; remove old incoming files?
 634         (when (natnump mail-source-delete-incoming)
 635           (mail-source-delete-old-incoming
 636            mail-source-delete-incoming
 637            mail-source-delete-old-incoming-confirm))))))
 638
 639 (defun mail-source-movemail (from to)
 640   "Move FROM to TO using movemail."
 641   (if (not (file-writable-p to))
 642       (error "Can't write to crash box %s.  Not moving mail" to)
 643     (let ((to (file-truename (expand-file-name to)))
 644           errors result)
 645       (setq to (file-truename to)
 646             from (file-truename from))
 647       ;; Set TO if have not already done so, and rename or copy
 648       ;; the file FROM to TO if and as appropriate.
 649       (cond
 650        ((file-exists-p to)
 651         ;; The crash box exists already.
 652         t)
 653        ((not (file-exists-p from))
 654         ;; There is no inbox.
 655         (setq to nil))
 656        ((zerop (nth 7 (file-attributes from)))
 657         ;; Empty file.
 658         (setq to nil))
 659        (t
 660         ;; If getting from mail spool directory, use movemail to move
 661         ;; rather than just renaming, so as to interlock with the
 662         ;; mailer.
 663         (unwind-protect
 664             (save-excursion
 665               (setq errors (generate-new-buffer " *mail source loss*"))
 666               (let ((default-directory "/"))
 667                 (setq result
 668                       (apply
 669                        'call-process
 670                        (append
 671                         (list
 672                          (or mail-source-movemail-program
 673                              (expand-file-name "movemail" exec-directory))
 674                          nil errors nil from to)))))
 675               (when (file-exists-p to)
 676                 (set-file-modes to mail-source-default-file-modes))
 677               (if (and (or (not (buffer-modified-p errors))
 678                            (zerop (buffer-size errors)))
 679                        (and (numberp result)
 680                             (zerop result)))
 681                   ;; No output => movemail won.
 682                   t
 683                 (set-buffer errors)
 684                 ;; There may be a warning about older revisions.  We
 685                 ;; ignore that.
 686                 (goto-char (point-min))
 687                 (if (search-forward "older revision" nil t)
 688                     t
 689                   ;; Probably a real error.
 690                   (subst-char-in-region (point-min) (point-max) ?\n ?\  )
 691                   (goto-char (point-max))
 692                   (skip-chars-backward " \t")
 693                   (delete-region (point) (point-max))
 694                   (goto-char (point-min))
 695                   (when (looking-at "movemail: ")
 696                     (delete-region (point-min) (match-end 0)))
 697                   ;; Result may be a signal description string.
 698                   (unless (yes-or-no-p
 699                            (format "movemail: %s (%s return).  Continue? "
 700                                    (buffer-string) result))
 701                     (error "%s" (buffer-string)))
 702                   (setq to nil)))))))
 703       (when (and errors
 704                  (buffer-name errors))
 705         (kill-buffer errors))
 706       ;; Return whether we moved successfully or not.
 707       to)))
 708
 709 (defun mail-source-movemail-and-remove (from to)
 710   "Move FROM to TO using movemail, then remove FROM if empty."
 711   (or (not (mail-source-movemail from to))
 712       (not (zerop (nth 7 (file-attributes from))))
 713       (delete-file from)))
 714
 715 (defun mail-source-fetch-with-program (program)
 716   (eq 0 (call-process shell-file-name nil nil nil
 717                       shell-command-switch program)))
 718
 719 (defun mail-source-run-script (script spec &optional delay)
 720   (when script
 721     (if (functionp script)
 722         (funcall script)
 723       (mail-source-call-script
 724        (format-spec script spec))))
 725   (when delay
 726     (sleep-for delay)))
 727
 728 (defun mail-source-call-script (script)
 729   (let ((background nil)
 730         (stderr (get-buffer-create " *mail-source-stderr*"))
 731         result)
 732     (when (string-match "& *$" script)
 733       (setq script (substring script 0 (match-beginning 0))
 734             background 0))
 735     (setq result
 736           (call-process shell-file-name nil background nil
 737                         shell-command-switch script))
 738     (when (and result
 739                (not (zerop result)))
 740       (set-buffer stderr)
 741       (message "Mail source error: %s" (buffer-string)))
 742     (kill-buffer stderr)))
 743
 744 ;;;
 745 ;;; Different fetchers
 746 ;;;
 747
 748 (defun mail-source-fetch-file (source callback)
 749   "Fetcher for single-file sources."
 750   (mail-source-bind (file source)
 751     (mail-source-run-script
 752      prescript (format-spec-make ?t mail-source-crash-box)
 753      prescript-delay)
 754     (let ((mail-source-string (format "file:%s" path)))
 755       (if (mail-source-movemail path mail-source-crash-box)
 756           (prog1
 757               (mail-source-callback callback path)
 758             (mail-source-run-script
 759              postscript (format-spec-make ?t mail-source-crash-box))
 760             (mail-source-delete-crash-box))
 761         0))))
 762
 763 (defun mail-source-fetch-directory (source callback)
 764   "Fetcher for directory sources."
 765   (mail-source-bind (directory source)
 766     (mail-source-run-script
 767      prescript (format-spec-make ?t path) prescript-delay)
 768     (let ((found 0)
 769           (mail-source-string (format "directory:%s" path)))
 770       (dolist (file (directory-files
 771                      path t (concat (regexp-quote suffix) "$")))
 772         (when (and (file-regular-p file)
 773                    (funcall predicate file)
 774                    (mail-source-movemail file mail-source-crash-box))
 775           (incf found (mail-source-callback callback file))
 776           (mail-source-run-script postscript (format-spec-make ?t path))
 777           (mail-source-delete-crash-box)))
 778       found)))
 779
 780 (defun mail-source-fetch-pop (source callback)
 781   "Fetcher for single-file sources."
 782   (mail-source-bind (pop source)
 783     ;; fixme: deal with stream type in format specs
 784     (mail-source-run-script
 785      prescript
 786      (format-spec-make ?p password ?t mail-source-crash-box
 787                        ?s server ?P port ?u user)
 788      prescript-delay)
 789     (let ((from (format "%s:%s:%s" server user port))
 790           (mail-source-string (format "pop:%s@%s" user server))
 791           result)
 792       (when (eq authentication 'password)
 793         (setq password
 794               (or password
 795                   (cdr (assoc from mail-source-password-cache))
 796                   (read-passwd
 797                    (format "Password for %s at %s: " user server)))))
 798       (when server
 799         (setenv "MAILHOST" server))
 800       (setq result
 801             (cond
 802              (program
 803               (mail-source-fetch-with-program
 804                (format-spec
 805                 program
 806                 (format-spec-make ?p password ?t mail-source-crash-box
 807                                   ?s server ?P port ?u user))))
 808              (function
 809               (funcall function mail-source-crash-box))
 810              ;; The default is to use pop3.el.
 811              (t
 812               (require 'pop3)
 813               (let ((pop3-password password)
 814                     (pop3-maildrop user)
 815                     (pop3-mailhost server)
 816                     (pop3-port port)
 817                     (pop3-authentication-scheme
 818                      (if (eq authentication 'apop) 'apop 'pass))
 819                     (pop3-stream-type stream))
 820                 (if (or debug-on-quit debug-on-error)
 821                     (save-excursion (pop3-movemail mail-source-crash-box))
 822                   (condition-case err
 823                       (save-excursion (pop3-movemail mail-source-crash-box))
 824                     (error
 825                      ;; We nix out the password in case the error
 826                      ;; was because of a wrong password being given.
 827                      (setq mail-source-password-cache
 828                            (delq (assoc from mail-source-password-cache)
 829                                  mail-source-password-cache))
 830                      (signal (car err) (cdr err)))))))))
 831       (if result
 832           (progn
 833             (when (eq authentication 'password)
 834               (unless (assoc from mail-source-password-cache)
 835                 (push (cons from password) mail-source-password-cache)))
 836             (prog1
 837                 (mail-source-callback callback server)
 838               ;; Update display-time's mail flag, if relevant.
 839               (if (equal source mail-source-primary-source)
 840                   (setq mail-source-new-mail-available nil))
 841               (mail-source-run-script
 842                postscript
 843                (format-spec-make ?p password ?t mail-source-crash-box
 844                                  ?s server ?P port ?u user))
 845               (mail-source-delete-crash-box)))
 846         ;; We nix out the password in case the error
 847         ;; was because of a wrong password being given.
 848         (setq mail-source-password-cache
 849               (delq (assoc from mail-source-password-cache)
 850                     mail-source-password-cache))
 851         0))))
 852
 853 (defun mail-source-check-pop (source)
 854   "Check whether there is new mail."
 855   (mail-source-bind (pop source)
 856     (let ((from (format "%s:%s:%s" server user port))
 857           (mail-source-string (format "pop:%s@%s" user server))
 858           result)
 859       (when (eq authentication 'password)
 860         (setq password
 861               (or password
 862                   (cdr (assoc from mail-source-password-cache))
 863                   (read-passwd
 864                    (format "Password for %s at %s: " user server))))
 865         (unless (assoc from mail-source-password-cache)
 866           (push (cons from password) mail-source-password-cache)))
 867       (when server
 868         (setenv "MAILHOST" server))
 869       (setq result
 870             (cond
 871              ;; No easy way to check whether mail is waiting for these.
 872              (program)
 873              (function)
 874              ;; The default is to use pop3.el.
 875              (t
 876               (require 'pop3)
 877               (let ((pop3-password password)
 878                     (pop3-maildrop user)
 879                     (pop3-mailhost server)
 880                     (pop3-port port)
 881                     (pop3-authentication-scheme
 882                      (if (eq authentication 'apop) 'apop 'pass)))
 883                 (if (or debug-on-quit debug-on-error)
 884                     (save-excursion (pop3-get-message-count))
 885                   (condition-case err
 886                       (save-excursion (pop3-get-message-count))
 887                     (error
 888                      ;; We nix out the password in case the error
 889                      ;; was because of a wrong password being given.
 890                      (setq mail-source-password-cache
 891                            (delq (assoc from mail-source-password-cache)
 892                                  mail-source-password-cache))
 893                      (signal (car err) (cdr err)))))))))
 894       (if result
 895           ;; Inform display-time that we have new mail.
 896           (setq mail-source-new-mail-available (> result 0))
 897         ;; We nix out the password in case the error
 898         ;; was because of a wrong password being given.
 899         (setq mail-source-password-cache
 900               (delq (assoc from mail-source-password-cache)
 901                     mail-source-password-cache)))
 902       result)))
 903
 904 (defun mail-source-touch-pop ()
 905   "Open and close a POP connection shortly.
 906 POP server should be defined in `mail-source-primary-source' (which is
 907 preferred) or `mail-sources'.  You may use it for the POP-before-SMTP
 908 authentication.  To do that, you need to set the
 909 `message-send-mail-function' variable as `message-smtpmail-send-it'
 910 and put the following line in your ~/.gnus.el file:
 911
 912 \(add-hook 'message-send-mail-hook 'mail-source-touch-pop)
 913
 914 See the Gnus manual for details."
 915   (let ((sources (if mail-source-primary-source
 916                      (list mail-source-primary-source)
 917                    mail-sources)))
 918     (while sources
 919       (if (eq 'pop (car (car sources)))
 920           (mail-source-check-pop (car sources)))
 921       (setq sources (cdr sources)))))
 922
 923 (defun mail-source-new-mail-p ()
 924   "Handler for `display-time' to indicate when new mail is available."
 925   ;; Flash (ie. ring the visible bell) if mail is available.
 926   (if (and mail-source-flash mail-source-new-mail-available)
 927       (let ((visible-bell t))
 928         (ding)))
 929   ;; Only report flag setting; flag is updated on a different schedule.
 930   mail-source-new-mail-available)
 931
 932
 933 (defvar mail-source-report-new-mail nil)
 934 (defvar mail-source-report-new-mail-timer nil)
 935 (defvar mail-source-report-new-mail-idle-timer nil)
 936
 937 (defun mail-source-start-idle-timer ()
 938   ;; Start our idle timer if necessary, so we delay the check until the
 939   ;; user isn't typing.
 940   (unless mail-source-report-new-mail-idle-timer
 941     (setq mail-source-report-new-mail-idle-timer
 942           (run-with-idle-timer
 943            mail-source-idle-time-delay
 944            nil
 945            (lambda ()
 946              (unwind-protect
 947                  (mail-source-check-pop mail-source-primary-source)
 948                (setq mail-source-report-new-mail-idle-timer nil)))))
 949     ;; Since idle timers created when Emacs is already in the idle
 950     ;; state don't get activated until Emacs _next_ becomes idle, we
 951     ;; need to force our timer to be considered active now.  We do
 952     ;; this by being naughty and poking the timer internals directly
 953     ;; (element 0 of the vector is nil if the timer is active).
 954     (aset mail-source-report-new-mail-idle-timer 0 nil)))
 955
 956 (defun mail-source-report-new-mail (arg)
 957   "Toggle whether to report when new mail is available.
 958 This only works when `display-time' is enabled."
 959   (interactive "P")
 960   (if (not mail-source-primary-source)
 961       (error "Need to set `mail-source-primary-source' to check for new mail"))
 962   (let ((on (if (null arg)
 963                 (not mail-source-report-new-mail)
 964               (> (prefix-numeric-value arg) 0))))
 965     (setq mail-source-report-new-mail on)
 966     (and mail-source-report-new-mail-timer
 967          (nnheader-cancel-timer mail-source-report-new-mail-timer))
 968     (and mail-source-report-new-mail-idle-timer
 969          (nnheader-cancel-timer mail-source-report-new-mail-idle-timer))
 970     (setq mail-source-report-new-mail-timer nil)
 971     (setq mail-source-report-new-mail-idle-timer nil)
 972     (if on
 973         (progn
 974           (require 'time)
 975           ;; display-time-mail-function is an Emacs 21 feature.
 976           (setq display-time-mail-function #'mail-source-new-mail-p)
 977           ;; Set up the main timer.
 978           (setq mail-source-report-new-mail-timer
 979                 (run-at-time
 980                  (* 60 mail-source-report-new-mail-interval)
 981                  (* 60 mail-source-report-new-mail-interval)
 982                  #'mail-source-start-idle-timer))
 983           ;; When you get new mail, clear "Mail" from the mode line.
 984           (add-hook 'nnmail-post-get-new-mail-hook
 985                     'display-time-event-handler)
 986           (message "Mail check enabled"))
 987       (setq display-time-mail-function nil)
 988       (remove-hook 'nnmail-post-get-new-mail-hook
 989                    'display-time-event-handler)
 990       (message "Mail check disabled"))))
 991
 992 (defun mail-source-fetch-maildir (source callback)
 993   "Fetcher for maildir sources."
 994   (mail-source-bind (maildir source)
 995     (let ((found 0)
 996           mail-source-string)
 997       (unless (string-match "/$" path)
 998         (setq path (concat path "/")))
 999       (dolist (subdir subdirs)
1000         (when (file-directory-p (concat path subdir))
1001           (setq mail-source-string (format "maildir:%s%s" path subdir))
1002           (dolist (file (directory-files (concat path subdir) t))
1003             (when (and (not (file-directory-p file))
1004                        (not (if function
1005                                 (funcall function file mail-source-crash-box)
1006                               (let ((coding-system-for-write
1007                                      mm-text-coding-system)
1008                                     (coding-system-for-read
1009                                      mm-text-coding-system))
1010                                 (with-temp-file mail-source-crash-box
1011                                   (insert-file-contents file)
1012                                   (goto-char (point-min))
1013 ;;;                               ;; Unix mail format
1014 ;;;                               (unless (looking-at "\n*From ")
1015 ;;;                                 (insert "From maildir "
1016 ;;;                                         (current-time-string) "\n"))
1017 ;;;                               (while (re-search-forward "^From " nil t)
1018 ;;;                                 (replace-match ">From "))
1019 ;;;                               (goto-char (point-max))
1020 ;;;                               (insert "\n\n")
1021                                   ;; MMDF mail format
1022                                   (insert "\001\001\001\001\n"))
1023                                 (delete-file file)))))
1024               (incf found (mail-source-callback callback file))
1025               (mail-source-delete-crash-box)))))
1026       found)))
1027
1028 (eval-and-compile
1029   (autoload 'imap-open "imap")
1030   (autoload 'imap-authenticate "imap")
1031   (autoload 'imap-mailbox-select "imap")
1032   (autoload 'imap-mailbox-unselect "imap")
1033   (autoload 'imap-mailbox-close "imap")
1034   (autoload 'imap-search "imap")
1035   (autoload 'imap-fetch "imap")
1036   (autoload 'imap-close "imap")
1037   (autoload 'imap-error-text "imap")
1038   (autoload 'imap-message-flags-add "imap")
1039   (autoload 'imap-list-to-message-set "imap")
1040   (autoload 'imap-range-to-message-set "imap")
1041   (autoload 'nnheader-ms-strip-cr "nnheader"))
1042
1043 (autoload 'gnus-compress-sequence "gnus-range")
1044
1045 (defvar mail-source-imap-file-coding-system 'binary
1046   "Coding system for the crashbox made by `mail-source-fetch-imap'.")
1047
1048 ;; Autoloads will bring in imap before this is called.
1049 (declare-function imap-capability "imap" (&optional identifier buffer))
1050
1051 (defun mail-source-fetch-imap (source callback)
1052   "Fetcher for imap sources."
1053   (mail-source-bind (imap source)
1054     (mail-source-run-script
1055      prescript (format-spec-make ?p password ?t mail-source-crash-box
1056                                  ?s server ?P port ?u user)
1057      prescript-delay)
1058     (let ((from (format "%s:%s:%s" server user port))
1059           (found 0)
1060           (buf (generate-new-buffer " *imap source*"))
1061           (mail-source-string (format "imap:%s:%s" server mailbox))
1062           (imap-shell-program (or (list program) imap-shell-program))
1063           remove)
1064       (if (and (imap-open server port stream authentication buf)
1065                (imap-authenticate
1066                 user (or (cdr (assoc from mail-source-password-cache))
1067                          password) buf)
1068                (imap-mailbox-select mailbox nil buf))
1069           (let ((coding-system-for-write mail-source-imap-file-coding-system)
1070                 str)
1071             (with-temp-file mail-source-crash-box
1072               ;; Avoid converting 8-bit chars from inserted strings to
1073               ;; multibyte.
1074               (mm-disable-multibyte)
1075               ;; remember password
1076               (with-current-buffer buf
1077                 (when (and imap-password
1078                            (not (assoc from mail-source-password-cache)))
1079                   (push (cons from imap-password) mail-source-password-cache)))
1080               ;; if predicate is nil, use all uids
1081               (dolist (uid (imap-search (or predicate "1:*") buf))
1082                 (when (setq str
1083                             (if (imap-capability 'IMAP4rev1 buf)
1084                                 (caddar (imap-fetch uid "BODY.PEEK[]"
1085                                                     'BODYDETAIL nil buf))
1086                               (imap-fetch uid "RFC822.PEEK" 'RFC822 nil buf)))
1087                   (push uid remove)
1088                   (insert "From imap " (current-time-string) "\n")
1089                   (save-excursion
1090                     (insert str "\n\n"))
1091                   (while (let ((case-fold-search nil))
1092                            (re-search-forward "^From " nil t))
1093                     (replace-match ">From "))
1094                   (goto-char (point-max))))
1095               (nnheader-ms-strip-cr))
1096             (incf found (mail-source-callback callback server))
1097             (mail-source-delete-crash-box)
1098             (when (and remove fetchflag)
1099               (setq remove (nreverse remove))
1100               (imap-message-flags-add
1101                (imap-range-to-message-set (gnus-compress-sequence remove))
1102                fetchflag nil buf))
1103             (if dontexpunge
1104                 (imap-mailbox-unselect buf)
1105               (imap-mailbox-close nil buf))
1106             (imap-close buf))
1107         (imap-close buf)
1108         ;; We nix out the password in case the error
1109         ;; was because of a wrong password being given.
1110         (setq mail-source-password-cache
1111               (delq (assoc from mail-source-password-cache)
1112                     mail-source-password-cache))
1113         (error "IMAP error: %s" (imap-error-text buf)))
1114       (kill-buffer buf)
1115       (mail-source-run-script
1116        postscript
1117        (format-spec-make ?p password ?t mail-source-crash-box
1118                          ?s server ?P port ?u user))
1119       found)))
1120
1121 (eval-and-compile
1122   (autoload 'webmail-fetch "webmail"))
1123
1124 (defun mail-source-fetch-webmail (source callback)
1125   "Fetch for webmail source."
1126   (mail-source-bind (webmail source)
1127     (let ((mail-source-string (format "webmail:%s:%s" subtype user))
1128           (webmail-newmail-only dontexpunge)
1129           (webmail-move-to-trash-can (not dontexpunge)))
1130       (when (eq authentication 'password)
1131         (setq password
1132               (or password
1133                   (cdr (assoc (format "webmail:%s:%s" subtype user)
1134                               mail-source-password-cache))
1135                   (read-passwd
1136                    (format "Password for %s at %s: " user subtype))))
1137         (when (and password
1138                    (not (assoc (format "webmail:%s:%s" subtype user)
1139                                mail-source-password-cache)))
1140           (push (cons (format "webmail:%s:%s" subtype user) password)
1141                 mail-source-password-cache)))
1142       (webmail-fetch mail-source-crash-box subtype user password)
1143       (mail-source-callback callback (symbol-name subtype))
1144       (mail-source-delete-crash-box))))
1145
1146 (provide 'mail-source)
1147
1148 ;; arch-tag: 72948025-1d17-4d6c-bb12-ef1aa2c490fd
1149 ;;; mail-source.el ends here