elmo/elmo-vars.el

   1 ;;; elmo-vars.el --- User variables for ELMO.
   2
   3 ;; Copyright (C) 1998,1999,2000 Yuuichi Teranishi <teranisi@gohome.org>
   4
   5 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
   6 ;; Keywords: mail, net news
   7
   8 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
   9
  10 ;; This program is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14 ;;
  15 ;; This program is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19 ;;
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24 ;;
  25
  26 ;;; Commentary:
  27 ;;
  28
  29 ;;; Code:
  30 ;;
  31 (require 'poe)
  32
  33 ;; silence byte compiler
  34 (eval-when-compile
  35   (defun-maybe dynamic-link (a))
  36   (defun-maybe dynamic-call (a b)))
  37
  38 ;; bind colon keywords for old Emacsen.
  39 (dont-compile
  40   (condition-case nil
  41       :symbol-for-testing-whether-colon-keyword-is-available-or-not
  42     (void-variable
  43      (let ((kwds '(:cc :date :extra :message-id :number :references :subject)))
  44        (while kwds
  45          (set (car kwds) (car kwds))
  46          (setq kwds (cdr kwds)))))))
  47
  48 (defgroup elmo nil
  49   "ELMO, Elisp Library for Message Orchestration."
  50   :tag "ELMO"
  51   :prefix "elmo-"
  52   :group 'news
  53   :group 'mail)
  54
  55 (defgroup elmo-setting nil
  56   "ELMO common settings."
  57   :prefix "elmo-"
  58   :group 'elmo)
  59
  60 (defcustom elmo-digest-flags '(unread)
  61   "Flags which are treated as `digest'."
  62   :type '(repeat (symbol :tag "flag"))
  63   :group 'elmo)
  64
  65 (defcustom elmo-preserved-flags '(forwarded answered cached new unread)
  66   "A list to define preserved flags.
  67 Flags in this list can be searched by `any' flag condition.
  68 If you want to treat a flag in this list as a `digest' flag,
  69 you have to add it to `elmo-digest-flags'.
  70 "
  71   :type '(repeat (symbol :tag "flag"))
  72   :group 'elmo)
  73
  74 ;; Message Database
  75
  76 (defcustom elmo-msgdb-default-type 'standard
  77   "*Default type of Message Database for ELMO."
  78   :type '(radio (const legacy)
  79                 (const standard))
  80   :group 'elmo
  81   :group 'elmo-setting)
  82
  83 (defcustom elmo-msgdb-convert-type 'auto
  84   "*MODB conversion type."
  85   :type '(radio (const sync)
  86                 (const auto)
  87                 (const :tag "No convert" nil))
  88   :group 'elmo
  89   :group 'elmo-setting)
  90
  91 (defcustom elmo-init-hook '(elmo-global-mark-migrate)
  92   "*A hook called when elmo is initialized."
  93   :type 'hook
  94   :group 'elmo)
  95
  96 (defvar elmo-msgdb-file-header-chop-length 2048
  97   "*Number of bytes to get header in one reading from file.")
  98
  99 (defcustom elmo-msgdb-directory "~/.elmo"
 100   "*ELMO Message Database path."
 101   :type 'directory
 102   :group 'elmo
 103   :group 'elmo-setting)
 104 (defvar elmo-passwd-alist-file-name "passwd"
 105   "*ELMO Password filename.")
 106 (defcustom elmo-passwd-life-time nil
 107   "*Duration of ELMO Password in seconds.  nil means infinity."
 108   :type '(choice (const :tag "Infinity" nil)
 109                  number)
 110   :group 'elmo
 111   :group 'elmo-setting)
 112
 113 (defvar elmo-warning-threshold 30000
 114   "*Display warning when the bytes of message exceeds this value.")
 115
 116 (defvar elmo-msg-appended-hook nil
 117   "A hook called when message is appended to database.")
 118 (defvar elmo-msg-deleted-hook nil
 119   "A hook called when message is deleted from database.")
 120 (defvar elmo-nntp-post-pre-hook nil
 121   "A hook called just before the nntp posting.")
 122
 123 ;;; IMAP4
 124
 125 (defcustom elmo-imap4-default-server "localhost"
 126   "*Default IMAP4 server."
 127   :type 'string
 128   :group 'elmo
 129   :group 'elmo-setting)
 130
 131 (defcustom elmo-imap4-default-authenticate-type 'login
 132   "*Default Authentication type for IMAP4."
 133   :type '(radio (const :tag "encoded password transmission (login)" login)
 134                 (const :tag "CRAM-MD5 authentication (cram-md5)" cram-md5)
 135                 (const :tag "DIGEST-MD5 authentication (digest-md5)" digest-md5)
 136                 (const :tag "plain password transmission (clear)" clear)
 137                 (const :tag "NTLM authentication (ntlm)" ntlm)
 138                 (function :tag "Other"))
 139   :group 'elmo)
 140
 141 (defcustom elmo-imap4-default-user (or (getenv "USER")
 142                                        (getenv "LOGNAME")
 143                                        (user-login-name))
 144   "*Default username for IMAP4."
 145   :type 'string
 146   :group 'elmo
 147   :group 'elmo-setting)
 148
 149 (defcustom elmo-imap4-default-port 143
 150   "*Default Port number of IMAP."
 151   :type 'integer
 152   :group 'elmo
 153   :group 'elmo-setting)
 154
 155 (defcustom elmo-imap4-default-stream-type nil
 156   "*Default stream type for IMAP4.
 157 Any symbol value of `elmo-network-stream-type-alist' or
 158 `elmo-imap4-stream-type-alist'."
 159   :type 'symbol
 160   :group 'elmo)
 161
 162 (defvar elmo-imap4-stream-type-alist nil
 163   "*Stream bindings for IMAP4.
 164 This is taken precedence over `elmo-network-stream-type-alist'.")
 165
 166 ;;; NNTP
 167
 168 ;; User options
 169 (defcustom elmo-nntp-default-server "localhost"
 170   "*Default NNTP server."
 171   :type 'string
 172   :group 'elmo
 173   :group 'elmo-setting)
 174
 175 (defcustom elmo-nntp-default-user nil
 176   "*Default User of NNTP.  nil means no user authentication."
 177   :type '(choice (const nil)
 178                  string)
 179   :group 'elmo
 180   :group 'elmo-setting)
 181
 182 (defcustom elmo-nntp-default-port 119
 183   "*Default Port number of NNTP."
 184   :type 'integer
 185   :group 'elmo
 186   :group 'elmo-setting)
 187
 188 (defcustom elmo-nntp-default-stream-type nil
 189   "*Default stream type for NNTP.
 190 Any symbol value of `elmo-network-stream-type-alist' or
 191 `elmo-nntp-stream-type-alist'."
 192   :type 'symbol
 193   :group 'elmo)
 194
 195 (defvar elmo-nntp-stream-type-alist nil
 196   "*Stream bindings for NNTP.
 197 This is taken precedence over `elmo-network-stream-type-alist'.")
 198
 199 ;;; POP3
 200
 201 ;; POP3
 202 (defcustom elmo-pop3-default-user (or (getenv "USER")
 203                                       (getenv "LOGNAME")
 204                                       (user-login-name))
 205   "*Default username for POP3."
 206   :type 'string
 207   :group 'elmo
 208   :group 'elmo-setting)
 209
 210 (defcustom elmo-pop3-default-server  "localhost"
 211   "*Default POP3 server."
 212   :type 'string
 213   :group 'elmo
 214   :group 'elmo-setting)
 215
 216 (defcustom elmo-pop3-default-authenticate-type 'user
 217   "*Default Authentication type for POP3."
 218   :type '(radio (const :tag "plain password transmission (user)" user)
 219                 (const :tag "APOP authentication (apop)" apop)
 220                 (const :tag "CRAM-MD5 authentication (cram-md5)" cram-md5)
 221                 (const :tag "DIGEST-MD5 authentication (digest-md5)" digest-md5)
 222                 (const :tag "NTLM authentication (ntlm)" ntlm)
 223                 (function :tag "Other"))
 224   :group 'elmo)
 225
 226 (defcustom elmo-pop3-default-port 110
 227   "*Default POP3 port."
 228   :type 'integer
 229   :group 'elmo
 230   :group 'elmo-setting)
 231
 232 (defcustom elmo-pop3-default-stream-type nil
 233   "*Default stream type for POP3.
 234 Any symbol value of `elmo-network-stream-type-alist' or
 235 `elmo-pop3-stream-type-alist'."
 236   :type 'symbol
 237   :group 'elmo)
 238
 239 (defvar elmo-pop3-stream-type-alist nil
 240   "*Stream bindings for POP3.
 241 This is taken precedence over `elmo-network-stream-type-alist'.")
 242
 243 (defcustom elmo-lang "ja"
 244   "Language for displayed messages."
 245   :type 'string
 246   :group 'elmo-setting)
 247
 248 (defvar elmo-mime-charset 'iso-2022-jp)
 249
 250 (defvar elmo-msgdb-mark-filename "mark"
 251   "Mark database.")
 252 (defvar elmo-msgdb-overview-filename "overview"
 253   "Overview database.")
 254 (defvar elmo-msgdb-number-filename "number"
 255   "Message number <=> Message-ID database.")
 256 (defvar elmo-msgdb-location-filename "location"
 257   "Message number <=> Actual location symbol.")
 258 (defvar elmo-msgdb-seen-filename "seen"
 259   "Seen message list for append.")
 260 (defvar elmo-msgdb-killed-filename "killed"
 261   "Deleted messages... contains elmo-killed-msgs-list.")
 262 (defvar elmo-msgdb-validity-filename "validity")
 263 (defvar elmo-msgdb-flist-filename "flist"
 264   "Folder list cache (for access folder).")
 265 (defvar elmo-msgdb-finfo-filename "finfo"
 266   "Folder information cache...list of '(filename . '(new unread all)).")
 267 (defvar elmo-msgdb-lock-list-filename "lock"
 268   "Locked messages...list of message-id.
 269 For disconnected operations.")
 270 (defvar elmo-lost+found-folder "+lost+found"
 271   "Lost and found.")
 272 (defvar elmo-crosspost-alist-filename "crosspost-alist"
 273   "Alist of crosspost messages.")
 274
 275 (defvar elmo-use-server-diff t
 276   "Non-nil forces to get unread message information on server.")
 277
 278 (defvar elmo-strict-diff-folder-list nil
 279   "List of regexps of folder name which should be checked its diff strictly.")
 280
 281 (defcustom elmo-msgdb-extra-fields nil
 282   "Extra fields for msgdb."
 283   :type '(repeat string)
 284   :group 'elmo
 285   :group 'elmo-setting)
 286
 287 (defcustom elmo-enable-disconnected-operation t
 288   "*Non-nil enables disconnected operations."
 289   :type 'boolean
 290   :group 'elmo
 291   :group 'elmo-setting)
 292
 293 (defvar elmo-auto-change-plugged 600
 294   "*Time to expire change plugged state automatically, as the number of seconds.
 295 Don't change plugged state automatically if nil.")
 296 (defvar elmo-plugged-condition 'one
 297   "*The condition for `elmo-plugged' becomes on.
 298 If `all', when all ports are on.  If `one', when even one port is on.
 299 If `independent', independent port plugged.
 300 If function, return value of function.")
 301
 302 (defvar elmo-plug-on-servers nil)
 303
 304 (defvar elmo-plug-on-exclude-servers
 305   (list "localhost"
 306         (system-name)
 307         (and (string-match "[^.]+" (system-name))
 308              (substring (system-name) 0 (match-end 0)))))
 309
 310 (defvar elmo-plugged-alist nil)
 311
 312 (defvar elmo-dop-flush-confirm t
 313   "*Flush disconnected operations queue with confirmation.")
 314
 315 (defvar elmo-path-sep "/"
 316   "*Path separator.")
 317 (defvar elmo-plugged t)
 318
 319 (defvar elmo-no-subject "(No Subject in original.)"
 320   "*A string used when no subject field exists.")
 321 (defvar elmo-no-from "nobody@nowhere?"
 322   "*A string used when no from field exists.")
 323
 324 ;; database dynamic linking
 325 (defvar elmo-database-dl-module
 326   (expand-file-name "database.so" exec-directory))
 327
 328 (defvar elmo-database-dl-handle
 329   (if (and (fboundp 'dynamic-link)
 330            (file-exists-p
 331             elmo-database-dl-module))
 332       (if (fboundp 'open-database)
 333           t ;;
 334         (dynamic-link elmo-database-dl-module))))
 335
 336 (if (and elmo-database-dl-handle
 337          (integerp elmo-database-dl-handle))
 338     (dynamic-call "emacs_database_init" elmo-database-dl-handle))
 339
 340 (defvar elmo-use-database (or (featurep 'dbm)
 341                               (featurep 'gnudbm)
 342                               (featurep 'berkdb)
 343                               (featurep 'berkeley-db)
 344                               ;; static/dl-database
 345                               (fboundp 'open-database)))
 346
 347 (defvar elmo-date-match t
 348   "Date match is available or not.")
 349
 350 (defvar elmo-network-stream-type-alist
 351   '(("!"      ssl       ssl      open-ssl-stream)
 352     ("!!"     starttls  starttls starttls-open-stream)
 353     ("!socks" socks     socks    socks-open-network-stream)
 354     ("!direct" direct   nil   open-network-stream))
 355   "An alist of (SPEC-STRING SYMBOL FEATURE OPEN-STREAM-FUNCTION).
 356 SPEC-STRING is a string for stream-type spec (it must start with '!').
 357 SYMBOL is a symbol which indicates the name of the stream type.
 358 SYMBOL should be identical in this alist.
 359 FEATURE is a symbol of the feature for OPEN-STREAM-FUNCTION.
 360 OPEN-STREAM-FUNCTION is a function to open network stream.
 361 Arguments for this function are NAME, BUFFER, HOST and SERVICE.")
 362
 363 (defvar elmo-folder-info-hashtb nil
 364   "Array of folder database information '(max length new unread).")
 365
 366 (defvar elmo-crosspost-message-alist nil
 367   "List of crosspost message.")
 368
 369 (defvar elmo-cache-expire-default-method "size"
 370   "Default expiration method.")
 371
 372 (defvar elmo-cache-expire-default-size 30000
 373   "Cache expiration disk size (Kilo bytes).  This must be float value.")
 374
 375 (defvar elmo-cache-expire-default-age 50
 376   "Cache expiration age (days).")
 377
 378 (defvar elmo-cache-directory (expand-file-name "cache" elmo-msgdb-directory)
 379   "Directory name for cache storage.")
 380
 381 (defvar elmo-pack-number-check-strict t
 382   "Pack number strictly.")
 383
 384 (defvar elmo-have-link-count
 385   (not
 386    ;; OS/2: EMX always returns the link count "1" :-(
 387    (or (memq system-type '(OS/2 emx))
 388        ;; Meadow seems to have pseudo link count.(suggestion by S.YAMAGUCHI)
 389        (and (eq system-type 'windows-nt) (not (featurep 'meadow)))))
 390   "Your file system has link count, or not.")
 391
 392 (defvar elmo-weekday-name-en '["Sun" "Mon" "Tue" "Wed" "Thu" "Fri" "Sat"])
 393 (defvar elmo-weekday-name-ja '["\e$BF|\e(B" "\e$B7n\e(B" "\e$B2P\e(B" "\e$B?e\e(B" "\e$BLZ\e(B" "\e$B6b\e(B" "\e$BEZ\e(B"])
 394 (defvar elmo-weekday-name-fr '["Dim" "Lun" "Mar" "Mer" "Jeu" "Ven" "Sam"])
 395 (defvar elmo-weekday-name-de '["Son" "Mon" "Die" "Mit" "Don" "Fre" "Sam"])
 396
 397 (defvar elmo-filename-replace-string-alist
 398   '((":"  . " c")
 399     ("*"  . " a")
 400     ("?"  . " q")
 401     ("<"  . " l")
 402     (">"  . " g")
 403     ("\"" . " d")
 404     ("|"  . " p")
 405     ("/"  . " s")
 406     ("\\" . " b")))
 407
 408 (defvar elmo-hash-minimum-size 1023
 409   "Minimum size of hash table.")
 410
 411 (defvar elmo-hash-maximum-size 4095
 412   "Maximum size of hash table.")
 413
 414 (defvar elmo-use-decoded-cache (featurep 'xemacs)
 415   "Use cache of decoded mime charset string.")
 416
 417 (defvar elmo-display-progress-threshold 20
 418   "*Displaying progress gauge if number of messages are more than this value.")
 419
 420 (defvar elmo-inhibit-number-mapping nil
 421   "Global switch to inhibit number mapping (e.g. Inhibit UIDL on POP3).")
 422
 423 (defvar elmo-display-retrieval-progress-threshold 30000
 424   "*Don't display progress if the message size is smaller than this value.")
 425
 426 (defvar elmo-inhibit-display-retrieval-progress nil
 427   "Global switch to inhibit display progress of each message's retrieval.")
 428
 429 (defvar elmo-dop-queue nil
 430   "Global variable for storing disconnected operation queues.")
 431
 432 (defcustom elmo-mime-display-as-is-coding-system (if (boundp 'MULE)
 433                                                      '*autoconv* 'undecided)
 434   "*Coding system used when message is displayed as is."
 435   :type 'symbol
 436   :group 'elmo)
 437
 438 (require 'product)
 439 (product-provide (provide 'elmo-vars) (require 'elmo-version))
 440
 441 ;;; elmo-vars.el ends here