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 (defgroup elmo nil
  39   "ELMO, Elisp Library for Message Orchestration."
  40   :tag "ELMO"
  41   :prefix "elmo-"
  42   :group 'news
  43   :group 'mail)
  44
  45 (defgroup elmo-setting nil
  46   "ELMO common settings."
  47   :prefix "elmo-"
  48   :group 'elmo)
  49
  50 ;; Local
  51 (defvar elmo-localnews-folder-path "~/News"
  52   "*Local news folder path.")
  53 (defvar elmo-maildir-folder-path "~/Maildir"
  54   "*Maildir folder path.")
  55 (defvar elmo-maildir-list '("\\+~/Maildir")
  56   "*All Folders that match this list will be treated as Maildir.
  57 Each elements are regexp of folder name (This is obsolete).")
  58
  59 (defvar elmo-msgdb-file-header-chop-length 2048
  60   "*Number of bytes to get header in one reading from file.")
  61
  62 (defvar elmo-msgdb-directory "~/.elmo"
  63   "*ELMO Message Database path.")
  64 (defvar elmo-passwd-alist-file-name "passwd"
  65   "*ELMO Password filename.")
  66 (defvar elmo-passwd-life-time nil
  67   "*Duration of ELMO Password in seconds.  nil means infinity.")
  68
  69 (defvar elmo-warning-threshold 30000
  70   "*Display warning when the bytes of message exceeds this value.")
  71
  72 (defvar elmo-msg-appended-hook nil
  73   "A hook called when message is appended to database.")
  74 (defvar elmo-msg-deleted-hook nil
  75   "A hook called when message is deleted from database.")
  76 (defvar elmo-nntp-post-pre-hook nil
  77   "A hook called just before the nntp posting.")
  78
  79 ;;; IMAP4
  80
  81 (defcustom elmo-imap4-default-mailbox "inbox"
  82   "*Default IMAP4 mailbox."
  83   :type 'string
  84   :group 'elmo
  85   :group 'elmo-setting)
  86
  87 (defcustom elmo-imap4-default-server "localhost"
  88   "*Default IMAP4 server."
  89   :type 'string
  90   :group 'elmo
  91   :group 'elmo-setting)
  92
  93 (defcustom elmo-imap4-default-authenticate-type 'login
  94   "*Default Authentication type for IMAP4."
  95   :type 'symbol
  96   :group 'elmo)
  97
  98 (defcustom elmo-imap4-default-user (or (getenv "USER")
  99                                        (getenv "LOGNAME")
 100                                        (user-login-name))
 101   "*Default username for IMAP4."
 102   :type 'string
 103   :group 'elmo
 104   :group 'elmo-setting)
 105
 106 (defcustom elmo-imap4-default-port 143
 107   "*Default Port number of IMAP."
 108   :type 'integer
 109   :group 'elmo
 110   :group 'elmo-setting)
 111
 112 (defcustom elmo-imap4-default-stream-type nil
 113   "*Default stream type for IMAP4.
 114 Any symbol value of `elmo-network-stream-type-alist' or
 115 `elmo-imap4-stream-type-alist'."
 116   :type 'symbol
 117   :group 'elmo)
 118
 119 (defvar elmo-imap4-stream-type-alist nil
 120   "*Stream bindings for IMAP4.
 121 This is taken precedence over `elmo-network-stream-type-alist'.")
 122
 123 ;;; NNTP
 124
 125 ;; User options
 126 (defcustom elmo-nntp-default-server "localhost"
 127   "*Default NNTP server."
 128   :type 'string
 129   :group 'elmo
 130   :group 'elmo-setting)
 131
 132 (defcustom elmo-nntp-default-user nil
 133   "*Default User of NNTP.  nil means no user authentication."
 134   :type '(choice (const nil)
 135                  string)
 136   :group 'elmo
 137   :group 'elmo-setting)
 138
 139 (defcustom elmo-nntp-default-port 119
 140   "*Default Port number of NNTP."
 141   :type 'integer
 142   :group 'elmo
 143   :group 'elmo-setting)
 144
 145 (defcustom elmo-nntp-default-stream-type nil
 146   "*Default stream type for NNTP.
 147 Any symbol value of `elmo-network-stream-type-alist' or
 148 `elmo-nntp-stream-type-alist'."
 149   :type 'symbol
 150   :group 'elmo)
 151
 152 (defvar elmo-nntp-stream-type-alist nil
 153   "*Stream bindings for NNTP.
 154 This is taken precedence over `elmo-network-stream-type-alist'.")
 155
 156 ;;; POP3
 157
 158 ;; POP3
 159 (defcustom elmo-pop3-default-user (or (getenv "USER")
 160                                       (getenv "LOGNAME")
 161                                       (user-login-name))
 162   "*Default username for POP3."
 163   :type 'string
 164   :group 'elmo
 165   :group 'elmo-setting)
 166
 167 (defcustom elmo-pop3-default-server  "localhost"
 168   "*Default POP3 server."
 169   :type 'string
 170   :group 'elmo
 171   :group 'elmo-setting)
 172
 173 (defcustom elmo-pop3-default-authenticate-type 'user
 174   "*Default Authentication type for POP3."
 175   :type 'symbol
 176   :group 'elmo)
 177
 178 (defcustom elmo-pop3-default-port 110
 179   "*Default POP3 port."
 180   :type 'integer
 181   :group 'elmo
 182   :group 'elmo-setting)
 183
 184 (defcustom elmo-pop3-default-stream-type nil
 185   "*Default stream type for POP3.
 186 Any symbol value of `elmo-network-stream-type-alist' or
 187 `elmo-pop3-stream-type-alist'."
 188   :type 'symbol
 189   :group 'elmo)
 190
 191 (defvar elmo-pop3-stream-type-alist nil
 192   "*Stream bindings for POP3.
 193 This is taken precedence over `elmo-network-stream-type-alist'.")
 194
 195 (defcustom elmo-lang "ja"
 196   "Language for displayed messages."
 197   :type 'string
 198   :group 'elmo-setting)
 199
 200 (defvar elmo-mime-charset 'iso-2022-jp)
 201
 202 (defvar elmo-msgdb-mark-filename "mark"
 203   "Mark database.")
 204 (defvar elmo-msgdb-overview-filename "overview"
 205   "Overview database.")
 206 (defvar elmo-msgdb-number-filename "number"
 207   "Message number <=> Message-ID database.")
 208 (defvar elmo-msgdb-location-filename "location"
 209   "Message number <=> Actual location symbol.")
 210 (defvar elmo-msgdb-seen-filename "seen"
 211   "Seen message list for append.")
 212 (defvar elmo-msgdb-killed-filename "killed"
 213   "Deleted messages... contains elmo-killed-msgs-list.")
 214 (defvar elmo-msgdb-validity-filename "validity")
 215 (defvar elmo-msgdb-flist-filename "flist"
 216   "Folder list cache (for access folder).")
 217 (defvar elmo-msgdb-finfo-filename "finfo"
 218   "Folder information cache...list of '(filename . '(new unread all)).")
 219 (defvar elmo-msgdb-lock-list-filename "lock"
 220   "Locked messages...list of message-id.
 221 For disconnected operations.")
 222 (defvar elmo-msgdb-global-mark-filename "global-mark"
 223   "Alist of global mark.")
 224 (defvar elmo-lost+found-folder "+lost+found"
 225   "Lost and found.")
 226 (defvar elmo-crosspost-alist-filename "crosspost-alist"
 227   "Alist of crosspost messages.")
 228
 229 (defvar elmo-use-server-diff t
 230   "Non-nil forces to get unread message information on server.")
 231
 232 (defvar elmo-strict-diff-folder-list nil
 233   "List of regexps of folder name which should be checked its diff strictly.")
 234
 235 (defvar elmo-msgdb-extra-fields nil
 236   "Extra fields for msgdb.")
 237
 238 (defvar elmo-enable-disconnected-operation t
 239   "*Enable disconnected operations.")
 240
 241 (defvar elmo-auto-change-plugged 600
 242   "*Time to expire change plugged state automatically, as the number of seconds.
 243 Don't change plugged state automatically if nil.")
 244 (defvar elmo-plugged-condition 'one
 245   "*The condition for `elmo-plugged' becomes on.
 246 If `all', when all ports are on.  If `one', when even one port is on.
 247 If `independent', independent port plugged.
 248 If function, return value of function.")
 249
 250 (defvar elmo-plug-on-servers nil)
 251
 252 (defvar elmo-plug-on-exclude-servers
 253   (list "localhost"
 254         (system-name)
 255         (and (string-match "[^.]+" (system-name))
 256              (substring (system-name) 0 (match-end 0)))))
 257
 258 (defvar elmo-plugged-alist nil)
 259
 260 (defvar elmo-dop-flush-confirm t
 261   "*Flush disconnected operations queue with confirmation.")
 262
 263 (defvar elmo-path-sep "/"
 264   "*Path separator.")
 265 (defvar elmo-plugged t)
 266
 267 (defvar elmo-no-subject "(No Subject in original.)"
 268   "*A string used when no subject field exists.")
 269 (defvar elmo-no-from "nobody@nowhere?"
 270   "*A string used when no from field exists.")
 271
 272 ;; database dynamic linking
 273 (defvar elmo-database-dl-module
 274   (expand-file-name "database.so" exec-directory))
 275
 276 (defvar elmo-database-dl-handle
 277   (if (and (fboundp 'dynamic-link)
 278            (file-exists-p
 279             elmo-database-dl-module))
 280       (if (fboundp 'open-database)
 281           t ;;
 282         (dynamic-link elmo-database-dl-module))))
 283
 284 (if (and elmo-database-dl-handle
 285          (integerp elmo-database-dl-handle))
 286     (dynamic-call "emacs_database_init" elmo-database-dl-handle))
 287
 288 (defvar elmo-use-database (or (featurep 'dbm)
 289                               (featurep 'gnudbm)
 290                               (featurep 'berkdb)
 291                               (featurep 'berkeley-db)
 292                               ;; static/dl-database
 293                               (fboundp 'open-database)))
 294
 295 (defvar elmo-date-match t
 296   "Date match is available or not.")
 297
 298 (defvar elmo-network-stream-type-alist
 299   '(("!"      ssl       ssl      open-ssl-stream)
 300     ("!!"     starttls  starttls starttls-open-stream)
 301     ("!socks" socks     socks    socks-open-network-stream))
 302   "An alist of (SPEC-STRING SYMBOL FEATURE OPEN-STREAM-FUNCTION).
 303 SPEC-STRING is a string for stream-type spec (it must start with '!').
 304 SYMBOL is a symbol which indicates the name of the stream type.
 305 SYMBOL should be identical in this alist.
 306 FEATURE is a symbol of the feature for OPEN-STREAM-FUNCTION.
 307 OPEN-STREAM-FUNCTION is a function to open network stream.
 308 Arguments for this function are NAME, BUFFER, HOST and SERVICE.")
 309
 310 (defvar elmo-folder-info-hashtb nil
 311   "Array of folder database information '(max length new unread).")
 312
 313 (defvar elmo-crosspost-message-alist nil
 314   "List of crosspost message.")
 315
 316 (defvar elmo-cache-expire-default-method "size"
 317   "Default expiration method.")
 318
 319 (defvar elmo-cache-expire-default-size 30000
 320   "Cache expiration disk size (Kilo bytes).  This must be float value.")
 321
 322 (defvar elmo-cache-expire-default-age 50
 323   "Cache expiration age (days).")
 324
 325 (defvar elmo-cache-directory (expand-file-name "cache" elmo-msgdb-directory)
 326   "Directory name for cache storage.")
 327
 328 (defvar elmo-pack-number-check-strict t
 329   "Pack number strictly.")
 330
 331 (defvar elmo-have-link-count
 332   (not
 333    ;; OS/2: EMX always returns the link count "1" :-(
 334    (or (memq system-type '(OS/2 emx))
 335        ;; Meadow seems to have pseudo link count.(suggestion by S.YAMAGUCHI)
 336        (and (eq system-type 'windows-nt) (not (featurep 'meadow)))))
 337   "Your file system has link count, or not.")
 338
 339 (defvar elmo-weekday-name-en '["Sun" "Mon" "Tue" "Wed" "Thu" "Fri" "Sat"])
 340 (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"])
 341 (defvar elmo-weekday-name-fr '["Dim" "Lun" "Mar" "Mer" "Jeu" "Ven" "Sam"])
 342 (defvar elmo-weekday-name-de '["Son" "Mon" "Die" "Mit" "Don" "Fre" "Sam"])
 343
 344 (defvar elmo-filename-replace-string-alist
 345   '((":"  . " c")
 346     ("*"  . " a")
 347     ("?"  . " q")
 348     ("<"  . " l")
 349     (">"  . " g")
 350     ("\"" . " d")
 351     ("|"  . " p")
 352     ("/"  . " s")
 353     ("\\" . " b")))
 354
 355 (defvar elmo-hash-minimum-size 1023
 356   "Minimum size of hash table.")
 357
 358 (defvar elmo-hash-maximum-size 4095
 359   "Maximum size of hash table.")
 360
 361 (defvar elmo-use-decoded-cache (featurep 'xemacs)
 362   "Use cache of decoded mime charset string.")
 363
 364 (defvar elmo-use-overview-hashtb t
 365   "Use hash table of overview.")
 366
 367 (defvar elmo-display-progress-threshold 20
 368   "*Displaying progress gauge if number of messages are more than this value.")
 369
 370 (defvar elmo-inhibit-number-mapping nil
 371   "Global switch to inhibit number mapping (e.g. Inhibit UIDL on POP3).")
 372
 373 (defvar elmo-display-retrieval-progress-threshold 30000
 374   "*Don't display progress if the message size is smaller than this value.")
 375
 376 (defvar elmo-inhibit-display-retrieval-progress nil
 377   "Global switch to inhibit display progress of each message's retrieval.")
 378
 379 (defvar elmo-dop-queue nil
 380   "Global variable for storing disconnected operation queues.")
 381
 382 (require 'product)
 383 (product-provide (provide 'elmo-vars) (require 'elmo-version))
 384
 385 ;;; elmo-vars.el ends here