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

   1 ;;; gnus.el --- a newsreader for GNU Emacs
   2
   3 ;; Copyright (C) 1987-1990, 1993-1998, 2000-2011  Free Software Foundation, Inc.
   4
   5 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
   6 ;;      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 of the License, or
  14 ;; (at your option) 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.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 ;;; Commentary:
  25
  26 ;;; Code:
  27
  28 (eval '(run-hooks 'gnus-load-hook))
  29
  30 ;; For Emacs <22.2 and XEmacs.
  31 (eval-and-compile
  32   (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
  33
  34 (eval-when-compile (require 'cl))
  35 (require 'wid-edit)
  36 (require 'mm-util)
  37 (require 'nnheader)
  38
  39 ;; These are defined afterwards with gnus-define-group-parameter
  40 (defvar gnus-ham-process-destinations)
  41 (defvar gnus-parameter-ham-marks-alist)
  42 (defvar gnus-parameter-spam-marks-alist)
  43 (defvar gnus-spam-autodetect)
  44 (defvar gnus-spam-autodetect-methods)
  45 (defvar gnus-spam-newsgroup-contents)
  46 (defvar gnus-spam-process-destinations)
  47 (defvar gnus-spam-resend-to)
  48 (defvar gnus-ham-resend-to)
  49 (defvar gnus-spam-process-newsgroups)
  50
  51
  52 (defgroup gnus nil
  53   "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
  54   :group 'news
  55   :group 'mail)
  56
  57 (defgroup gnus-start nil
  58   "Starting your favorite newsreader."
  59   :group 'gnus)
  60
  61 (defgroup gnus-format nil
  62   "Dealing with formatting issues."
  63   :group 'gnus)
  64
  65 (defgroup gnus-charset nil
  66   "Group character set issues."
  67   :link '(custom-manual "(gnus)Charsets")
  68   :version "21.1"
  69   :group 'gnus)
  70
  71 (defgroup gnus-cache nil
  72   "Cache interface."
  73   :link '(custom-manual "(gnus)Article Caching")
  74   :group 'gnus)
  75
  76 (defgroup gnus-registry nil
  77   "Article Registry."
  78   :group 'gnus)
  79
  80 (defgroup gnus-start-server nil
  81   "Server options at startup."
  82   :group 'gnus-start)
  83
  84 ;; These belong to gnus-group.el.
  85 (defgroup gnus-group nil
  86   "Group buffers."
  87   :link '(custom-manual "(gnus)Group Buffer")
  88   :group 'gnus)
  89
  90 (defgroup gnus-group-foreign nil
  91   "Foreign groups."
  92   :link '(custom-manual "(gnus)Foreign Groups")
  93   :group 'gnus-group)
  94
  95 (defgroup gnus-group-new nil
  96   "Automatic subscription of new groups."
  97   :group 'gnus-group)
  98
  99 (defgroup gnus-group-levels nil
 100   "Group levels."
 101   :link '(custom-manual "(gnus)Group Levels")
 102   :group 'gnus-group)
 103
 104 (defgroup gnus-group-select nil
 105   "Selecting a Group."
 106   :link '(custom-manual "(gnus)Selecting a Group")
 107   :group 'gnus-group)
 108
 109 (defgroup gnus-group-listing nil
 110   "Showing slices of the group list."
 111   :link '(custom-manual "(gnus)Listing Groups")
 112   :group 'gnus-group)
 113
 114 (defgroup gnus-group-visual nil
 115   "Sorting the group buffer."
 116   :link '(custom-manual "(gnus)Group Buffer Format")
 117   :group 'gnus-group
 118   :group 'gnus-visual)
 119
 120 (defgroup gnus-group-various nil
 121   "Various group options."
 122   :link '(custom-manual "(gnus)Scanning New Messages")
 123   :group 'gnus-group)
 124
 125 ;; These belong to gnus-sum.el.
 126 (defgroup gnus-summary nil
 127   "Summary buffers."
 128   :link '(custom-manual "(gnus)Summary Buffer")
 129   :group 'gnus)
 130
 131 (defgroup gnus-summary-exit nil
 132   "Leaving summary buffers."
 133   :link '(custom-manual "(gnus)Exiting the Summary Buffer")
 134   :group 'gnus-summary)
 135
 136 (defgroup gnus-summary-marks nil
 137   "Marks used in summary buffers."
 138   :link '(custom-manual "(gnus)Marking Articles")
 139   :group 'gnus-summary)
 140
 141 (defgroup gnus-thread nil
 142   "Ordering articles according to replies."
 143   :link '(custom-manual "(gnus)Threading")
 144   :group 'gnus-summary)
 145
 146 (defgroup gnus-summary-format nil
 147   "Formatting of the summary buffer."
 148   :link '(custom-manual "(gnus)Summary Buffer Format")
 149   :group 'gnus-summary)
 150
 151 (defgroup gnus-summary-choose nil
 152   "Choosing Articles."
 153   :link '(custom-manual "(gnus)Choosing Articles")
 154   :group 'gnus-summary)
 155
 156 (defgroup gnus-summary-maneuvering nil
 157   "Summary movement commands."
 158   :link '(custom-manual "(gnus)Summary Maneuvering")
 159   :group 'gnus-summary)
 160
 161 (defgroup gnus-picon nil
 162   "Show pictures of people, domains, and newsgroups."
 163   :group 'gnus-visual)
 164
 165 (defgroup gnus-summary-mail nil
 166   "Mail group commands."
 167   :link '(custom-manual "(gnus)Mail Group Commands")
 168   :group 'gnus-summary)
 169
 170 (defgroup gnus-summary-sort nil
 171   "Sorting the summary buffer."
 172   :link '(custom-manual "(gnus)Sorting the Summary Buffer")
 173   :group 'gnus-summary)
 174
 175 (defgroup gnus-summary-visual nil
 176   "Highlighting and menus in the summary buffer."
 177   :link '(custom-manual "(gnus)Summary Highlighting")
 178   :group 'gnus-visual
 179   :group 'gnus-summary)
 180
 181 (defgroup gnus-summary-various nil
 182   "Various summary buffer options."
 183   :link '(custom-manual "(gnus)Various Summary Stuff")
 184   :group 'gnus-summary)
 185
 186 (defgroup gnus-summary-pick nil
 187   "Pick mode in the summary buffer."
 188   :link '(custom-manual "(gnus)Pick and Read")
 189   :prefix "gnus-pick-"
 190   :group 'gnus-summary)
 191
 192 (defgroup gnus-summary-tree nil
 193   "Tree display of threads in the summary buffer."
 194   :link '(custom-manual "(gnus)Tree Display")
 195   :prefix "gnus-tree-"
 196   :group 'gnus-summary)
 197
 198 ;; Belongs to gnus-uu.el
 199 (defgroup gnus-extract-view nil
 200   "Viewing extracted files."
 201   :link '(custom-manual "(gnus)Viewing Files")
 202   :group 'gnus-extract)
 203
 204 ;; Belongs to gnus-score.el
 205 (defgroup gnus-score nil
 206   "Score and kill file handling."
 207   :group 'gnus)
 208
 209 (defgroup gnus-score-kill nil
 210   "Kill files."
 211   :group 'gnus-score)
 212
 213 (defgroup gnus-score-adapt nil
 214   "Adaptive score files."
 215   :group 'gnus-score)
 216
 217 (defgroup gnus-score-default nil
 218   "Default values for score files."
 219   :group 'gnus-score)
 220
 221 (defgroup gnus-score-expire nil
 222   "Expiring score rules."
 223   :group 'gnus-score)
 224
 225 (defgroup gnus-score-decay nil
 226   "Decaying score rules."
 227   :group 'gnus-score)
 228
 229 (defgroup gnus-score-files nil
 230   "Score and kill file names."
 231   :group 'gnus-score
 232   :group 'gnus-files)
 233
 234 (defgroup gnus-score-various nil
 235   "Various scoring and killing options."
 236   :group 'gnus-score)
 237
 238 ;; Other
 239 (defgroup gnus-visual nil
 240   "Options controlling the visual fluff."
 241   :group 'gnus
 242   :group 'faces)
 243
 244 (defgroup gnus-agent nil
 245   "Offline support for Gnus."
 246   :group 'gnus)
 247
 248 (defgroup gnus-files nil
 249   "Files used by Gnus."
 250   :group 'gnus)
 251
 252 (defgroup gnus-dribble-file nil
 253   "Auto save file."
 254   :link '(custom-manual "(gnus)Auto Save")
 255   :group 'gnus-files)
 256
 257 (defgroup gnus-newsrc nil
 258   "Storing Gnus state."
 259   :group 'gnus-files)
 260
 261 (defgroup gnus-server nil
 262   "Options related to newsservers and other servers used by Gnus."
 263   :group 'gnus)
 264
 265 (defgroup gnus-server-visual nil
 266   "Highlighting and menus in the server buffer."
 267   :group 'gnus-visual
 268   :group 'gnus-server)
 269
 270 (defgroup gnus-message '((message custom-group))
 271   "Composing replies and followups in Gnus."
 272   :group 'gnus)
 273
 274 (defgroup gnus-meta nil
 275   "Meta variables controlling major portions of Gnus.
 276 In general, modifying these variables does not take affect until Gnus
 277 is restarted, and sometimes reloaded."
 278   :group 'gnus)
 279
 280 (defgroup gnus-various nil
 281   "Other Gnus options."
 282   :link '(custom-manual "(gnus)Various Various")
 283   :group 'gnus)
 284
 285 (defgroup gnus-exit nil
 286   "Exiting Gnus."
 287   :link '(custom-manual "(gnus)Exiting Gnus")
 288   :group 'gnus)
 289
 290 (defgroup gnus-fun nil
 291   "Frivolous Gnus extensions."
 292   :link '(custom-manual "(gnus)Exiting Gnus")
 293   :group 'gnus)
 294
 295 (defconst gnus-version-number "0.11"
 296   "Version number for this version of Gnus.")
 297
 298 (defconst gnus-version (format "No Gnus v%s" gnus-version-number)
 299   "Version string for this version of Gnus.")
 300
 301 (defcustom gnus-inhibit-startup-message nil
 302   "If non-nil, the startup message will not be displayed.
 303 This variable is used before `.gnus.el' is loaded, so it should
 304 be set in `.emacs' instead."
 305   :group 'gnus-start
 306   :type 'boolean)
 307
 308 (unless (featurep 'gnus-xmas)
 309   (defalias 'gnus-make-overlay 'make-overlay)
 310   (defalias 'gnus-delete-overlay 'delete-overlay)
 311   (defalias 'gnus-overlay-get 'overlay-get)
 312   (defalias 'gnus-overlay-put 'overlay-put)
 313   (defalias 'gnus-move-overlay 'move-overlay)
 314   (defalias 'gnus-overlay-buffer 'overlay-buffer)
 315   (defalias 'gnus-overlay-start 'overlay-start)
 316   (defalias 'gnus-overlay-end 'overlay-end)
 317   (defalias 'gnus-overlays-in 'overlays-in)
 318   (defalias 'gnus-extent-detached-p 'ignore)
 319   (defalias 'gnus-extent-start-open 'ignore)
 320   (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
 321   (defalias 'gnus-character-to-event 'identity)
 322   (defalias 'gnus-assq-delete-all 'assq-delete-all)
 323   (defalias 'gnus-add-text-properties 'add-text-properties)
 324   (defalias 'gnus-put-text-property 'put-text-property)
 325   (defvar gnus-mode-line-image-cache t)
 326   (if (fboundp 'find-image)
 327       (defun gnus-mode-line-buffer-identification (line)
 328         (let ((str (car-safe line))
 329               (load-path (mm-image-load-path)))
 330           (if (and (stringp str)
 331                    (string-match "^Gnus:" str))
 332               (progn (add-text-properties
 333                       0 5
 334                       (list 'display
 335                             (if (eq t gnus-mode-line-image-cache)
 336                                 (setq gnus-mode-line-image-cache
 337                                       (find-image
 338                                        '((:type xpm :file "gnus-pointer.xpm"
 339                                                 :ascent center)
 340                                          (:type xbm :file "gnus-pointer.xbm"
 341                                                 :ascent center))))
 342                               gnus-mode-line-image-cache)
 343                             'help-echo (format
 344                                         "This is %s, %s."
 345                                         gnus-version (gnus-emacs-version)))
 346                       str)
 347                      (list str))
 348             line)))
 349     (defalias 'gnus-mode-line-buffer-identification 'identity))
 350   (defalias 'gnus-deactivate-mark 'deactivate-mark)
 351   (defalias 'gnus-window-edges 'window-edges)
 352   (defalias 'gnus-key-press-event-p 'numberp)
 353   ;;(defalias 'gnus-decode-rfc1522 'ignore)
 354   )
 355
 356 ;; We define these group faces here to avoid the display
 357 ;; update forced when creating new faces.
 358
 359 (defface gnus-group-news-1
 360   '((((class color)
 361       (background dark))
 362      (:foreground "PaleTurquoise" :bold t))
 363     (((class color)
 364       (background light))
 365      (:foreground "ForestGreen" :bold t))
 366     (t
 367      ()))
 368   "Level 1 newsgroup face."
 369   :group 'gnus-group)
 370 ;; backward-compatibility alias
 371 (put 'gnus-group-news-1-face 'face-alias 'gnus-group-news-1)
 372 (put 'gnus-group-news-1-face 'obsolete-face "22.1")
 373
 374 (defface gnus-group-news-1-empty
 375   '((((class color)
 376       (background dark))
 377      (:foreground "PaleTurquoise"))
 378     (((class color)
 379       (background light))
 380      (:foreground "ForestGreen"))
 381     (t
 382      ()))
 383   "Level 1 empty newsgroup face."
 384   :group 'gnus-group)
 385 ;; backward-compatibility alias
 386 (put 'gnus-group-news-1-empty-face 'face-alias 'gnus-group-news-1-empty)
 387 (put 'gnus-group-news-1-empty-face 'obsolete-face "22.1")
 388
 389 (defface gnus-group-news-2
 390   '((((class color)
 391       (background dark))
 392      (:foreground "turquoise" :bold t))
 393     (((class color)
 394       (background light))
 395      (:foreground "CadetBlue4" :bold t))
 396     (t
 397      ()))
 398   "Level 2 newsgroup face."
 399   :group 'gnus-group)
 400 ;; backward-compatibility alias
 401 (put 'gnus-group-news-2-face 'face-alias 'gnus-group-news-2)
 402 (put 'gnus-group-news-2-face 'obsolete-face "22.1")
 403
 404 (defface gnus-group-news-2-empty
 405   '((((class color)
 406       (background dark))
 407      (:foreground "turquoise"))
 408     (((class color)
 409       (background light))
 410      (:foreground "CadetBlue4"))
 411     (t
 412      ()))
 413   "Level 2 empty newsgroup face."
 414   :group 'gnus-group)
 415 ;; backward-compatibility alias
 416 (put 'gnus-group-news-2-empty-face 'face-alias 'gnus-group-news-2-empty)
 417 (put 'gnus-group-news-2-empty-face 'obsolete-face "22.1")
 418
 419 (defface gnus-group-news-3
 420   '((((class color)
 421       (background dark))
 422      (:bold t))
 423     (((class color)
 424       (background light))
 425      (:bold t))
 426     (t
 427      ()))
 428   "Level 3 newsgroup face."
 429   :group 'gnus-group)
 430 ;; backward-compatibility alias
 431 (put 'gnus-group-news-3-face 'face-alias 'gnus-group-news-3)
 432 (put 'gnus-group-news-3-face 'obsolete-face "22.1")
 433
 434 (defface gnus-group-news-3-empty
 435   '((((class color)
 436       (background dark))
 437      ())
 438     (((class color)
 439       (background light))
 440      ())
 441     (t
 442      ()))
 443   "Level 3 empty newsgroup face."
 444   :group 'gnus-group)
 445 ;; backward-compatibility alias
 446 (put 'gnus-group-news-3-empty-face 'face-alias 'gnus-group-news-3-empty)
 447 (put 'gnus-group-news-3-empty-face 'obsolete-face "22.1")
 448
 449 (defface gnus-group-news-4
 450   '((((class color)
 451       (background dark))
 452      (:bold t))
 453     (((class color)
 454       (background light))
 455      (:bold t))
 456     (t
 457      ()))
 458   "Level 4 newsgroup face."
 459   :group 'gnus-group)
 460 ;; backward-compatibility alias
 461 (put 'gnus-group-news-4-face 'face-alias 'gnus-group-news-4)
 462 (put 'gnus-group-news-4-face 'obsolete-face "22.1")
 463
 464 (defface gnus-group-news-4-empty
 465   '((((class color)
 466       (background dark))
 467      ())
 468     (((class color)
 469       (background light))
 470      ())
 471     (t
 472      ()))
 473   "Level 4 empty newsgroup face."
 474   :group 'gnus-group)
 475 ;; backward-compatibility alias
 476 (put 'gnus-group-news-4-empty-face 'face-alias 'gnus-group-news-4-empty)
 477 (put 'gnus-group-news-4-empty-face 'obsolete-face "22.1")
 478
 479 (defface gnus-group-news-5
 480   '((((class color)
 481       (background dark))
 482      (:bold t))
 483     (((class color)
 484       (background light))
 485      (:bold t))
 486     (t
 487      ()))
 488   "Level 5 newsgroup face."
 489   :group 'gnus-group)
 490 ;; backward-compatibility alias
 491 (put 'gnus-group-news-5-face 'face-alias 'gnus-group-news-5)
 492 (put 'gnus-group-news-5-face 'obsolete-face "22.1")
 493
 494 (defface gnus-group-news-5-empty
 495   '((((class color)
 496       (background dark))
 497      ())
 498     (((class color)
 499       (background light))
 500      ())
 501     (t
 502      ()))
 503   "Level 5 empty newsgroup face."
 504   :group 'gnus-group)
 505 ;; backward-compatibility alias
 506 (put 'gnus-group-news-5-empty-face 'face-alias 'gnus-group-news-5-empty)
 507 (put 'gnus-group-news-5-empty-face 'obsolete-face "22.1")
 508
 509 (defface gnus-group-news-6
 510   '((((class color)
 511       (background dark))
 512      (:bold t))
 513     (((class color)
 514       (background light))
 515      (:bold t))
 516     (t
 517      ()))
 518   "Level 6 newsgroup face."
 519   :group 'gnus-group)
 520 ;; backward-compatibility alias
 521 (put 'gnus-group-news-6-face 'face-alias 'gnus-group-news-6)
 522 (put 'gnus-group-news-6-face 'obsolete-face "22.1")
 523
 524 (defface gnus-group-news-6-empty
 525   '((((class color)
 526       (background dark))
 527      ())
 528     (((class color)
 529       (background light))
 530      ())
 531     (t
 532      ()))
 533   "Level 6 empty newsgroup face."
 534   :group 'gnus-group)
 535 ;; backward-compatibility alias
 536 (put 'gnus-group-news-6-empty-face 'face-alias 'gnus-group-news-6-empty)
 537 (put 'gnus-group-news-6-empty-face 'obsolete-face "22.1")
 538
 539 (defface gnus-group-news-low
 540   '((((class color)
 541       (background dark))
 542      (:foreground "DarkTurquoise" :bold t))
 543     (((class color)
 544       (background light))
 545      (:foreground "DarkGreen" :bold t))
 546     (t
 547      ()))
 548   "Low level newsgroup face."
 549   :group 'gnus-group)
 550 ;; backward-compatibility alias
 551 (put 'gnus-group-news-low-face 'face-alias 'gnus-group-news-low)
 552 (put 'gnus-group-news-low-face 'obsolete-face "22.1")
 553
 554 (defface gnus-group-news-low-empty
 555   '((((class color)
 556       (background dark))
 557      (:foreground "DarkTurquoise"))
 558     (((class color)
 559       (background light))
 560      (:foreground "DarkGreen"))
 561     (t
 562      ()))
 563   "Low level empty newsgroup face."
 564   :group 'gnus-group)
 565 ;; backward-compatibility alias
 566 (put 'gnus-group-news-low-empty-face 'face-alias 'gnus-group-news-low-empty)
 567 (put 'gnus-group-news-low-empty-face 'obsolete-face "22.1")
 568
 569 (defface gnus-group-mail-1
 570   '((((class color)
 571       (background dark))
 572      (:foreground "#e1ffe1" :bold t))
 573     (((class color)
 574       (background light))
 575      (:foreground "DeepPink3" :bold t))
 576     (t
 577      (:bold t)))
 578   "Level 1 mailgroup face."
 579   :group 'gnus-group)
 580 ;; backward-compatibility alias
 581 (put 'gnus-group-mail-1-face 'face-alias 'gnus-group-mail-1)
 582 (put 'gnus-group-mail-1-face 'obsolete-face "22.1")
 583
 584 (defface gnus-group-mail-1-empty
 585   '((((class color)
 586       (background dark))
 587      (:foreground "#e1ffe1"))
 588     (((class color)
 589       (background light))
 590      (:foreground "DeepPink3"))
 591     (t
 592      (:italic t :bold t)))
 593   "Level 1 empty mailgroup face."
 594   :group 'gnus-group)
 595 ;; backward-compatibility alias
 596 (put 'gnus-group-mail-1-empty-face 'face-alias 'gnus-group-mail-1-empty)
 597 (put 'gnus-group-mail-1-empty-face 'obsolete-face "22.1")
 598
 599 (defface gnus-group-mail-2
 600   '((((class color)
 601       (background dark))
 602      (:foreground "DarkSeaGreen1" :bold t))
 603     (((class color)
 604       (background light))
 605      (:foreground "HotPink3" :bold t))
 606     (t
 607      (:bold t)))
 608   "Level 2 mailgroup face."
 609   :group 'gnus-group)
 610 ;; backward-compatibility alias
 611 (put 'gnus-group-mail-2-face 'face-alias 'gnus-group-mail-2)
 612 (put 'gnus-group-mail-2-face 'obsolete-face "22.1")
 613
 614 (defface gnus-group-mail-2-empty
 615   '((((class color)
 616       (background dark))
 617      (:foreground "DarkSeaGreen1"))
 618     (((class color)
 619       (background light))
 620      (:foreground "HotPink3"))
 621     (t
 622      (:bold t)))
 623   "Level 2 empty mailgroup face."
 624   :group 'gnus-group)
 625 ;; backward-compatibility alias
 626 (put 'gnus-group-mail-2-empty-face 'face-alias 'gnus-group-mail-2-empty)
 627 (put 'gnus-group-mail-2-empty-face 'obsolete-face "22.1")
 628
 629 (defface gnus-group-mail-3
 630   '((((class color)
 631       (background dark))
 632      (:foreground "aquamarine1" :bold t))
 633     (((class color)
 634       (background light))
 635      (:foreground "magenta4" :bold t))
 636     (t
 637      (:bold t)))
 638   "Level 3 mailgroup face."
 639   :group 'gnus-group)
 640 ;; backward-compatibility alias
 641 (put 'gnus-group-mail-3-face 'face-alias 'gnus-group-mail-3)
 642 (put 'gnus-group-mail-3-face 'obsolete-face "22.1")
 643
 644 (defface gnus-group-mail-3-empty
 645   '((((class color)
 646       (background dark))
 647      (:foreground "aquamarine1"))
 648     (((class color)
 649       (background light))
 650      (:foreground "magenta4"))
 651     (t
 652      ()))
 653   "Level 3 empty mailgroup face."
 654   :group 'gnus-group)
 655 ;; backward-compatibility alias
 656 (put 'gnus-group-mail-3-empty-face 'face-alias 'gnus-group-mail-3-empty)
 657 (put 'gnus-group-mail-3-empty-face 'obsolete-face "22.1")
 658
 659 (defface gnus-group-mail-low
 660   '((((class color)
 661       (background dark))
 662      (:foreground "aquamarine2" :bold t))
 663     (((class color)
 664       (background light))
 665      (:foreground "DeepPink4" :bold t))
 666     (t
 667      (:bold t)))
 668   "Low level mailgroup face."
 669   :group 'gnus-group)
 670 ;; backward-compatibility alias
 671 (put 'gnus-group-mail-low-face 'face-alias 'gnus-group-mail-low)
 672 (put 'gnus-group-mail-low-face 'obsolete-face "22.1")
 673
 674 (defface gnus-group-mail-low-empty
 675   '((((class color)
 676       (background dark))
 677      (:foreground "aquamarine2"))
 678     (((class color)
 679       (background light))
 680      (:foreground "DeepPink4"))
 681     (t
 682      (:bold t)))
 683   "Low level empty mailgroup face."
 684   :group 'gnus-group)
 685 ;; backward-compatibility alias
 686 (put 'gnus-group-mail-low-empty-face 'face-alias 'gnus-group-mail-low-empty)
 687 (put 'gnus-group-mail-low-empty-face 'obsolete-face "22.1")
 688
 689 ;; Summary mode faces.
 690
 691 (defface gnus-summary-selected '((t (:underline t)))
 692   "Face used for selected articles."
 693   :group 'gnus-summary)
 694 ;; backward-compatibility alias
 695 (put 'gnus-summary-selected-face 'face-alias 'gnus-summary-selected)
 696 (put 'gnus-summary-selected-face 'obsolete-face "22.1")
 697
 698 (defface gnus-summary-cancelled
 699   '((((class color))
 700      (:foreground "yellow" :background "black")))
 701   "Face used for cancelled articles."
 702   :group 'gnus-summary)
 703 ;; backward-compatibility alias
 704 (put 'gnus-summary-cancelled-face 'face-alias 'gnus-summary-cancelled)
 705 (put 'gnus-summary-cancelled-face 'obsolete-face "22.1")
 706
 707 (defface gnus-summary-high-ticked
 708   '((((class color)
 709       (background dark))
 710      (:foreground "pink" :bold t))
 711     (((class color)
 712       (background light))
 713      (:foreground "firebrick" :bold t))
 714     (t
 715      (:bold t)))
 716   "Face used for high interest ticked articles."
 717   :group 'gnus-summary)
 718 ;; backward-compatibility alias
 719 (put 'gnus-summary-high-ticked-face 'face-alias 'gnus-summary-high-ticked)
 720 (put 'gnus-summary-high-ticked-face 'obsolete-face "22.1")
 721
 722 (defface gnus-summary-low-ticked
 723   '((((class color)
 724       (background dark))
 725      (:foreground "pink" :italic t))
 726     (((class color)
 727       (background light))
 728      (:foreground "firebrick" :italic t))
 729     (t
 730      (:italic t)))
 731   "Face used for low interest ticked articles."
 732   :group 'gnus-summary)
 733 ;; backward-compatibility alias
 734 (put 'gnus-summary-low-ticked-face 'face-alias 'gnus-summary-low-ticked)
 735 (put 'gnus-summary-low-ticked-face 'obsolete-face "22.1")
 736
 737 (defface gnus-summary-normal-ticked
 738   '((((class color)
 739       (background dark))
 740      (:foreground "pink"))
 741     (((class color)
 742       (background light))
 743      (:foreground "firebrick"))
 744     (t
 745      ()))
 746   "Face used for normal interest ticked articles."
 747   :group 'gnus-summary)
 748 ;; backward-compatibility alias
 749 (put 'gnus-summary-normal-ticked-face 'face-alias 'gnus-summary-normal-ticked)
 750 (put 'gnus-summary-normal-ticked-face 'obsolete-face "22.1")
 751
 752 (defface gnus-summary-high-ancient
 753   '((((class color)
 754       (background dark))
 755      (:foreground "SkyBlue" :bold t))
 756     (((class color)
 757       (background light))
 758      (:foreground "RoyalBlue" :bold t))
 759     (t
 760      (:bold t)))
 761   "Face used for high interest ancient articles."
 762   :group 'gnus-summary)
 763 ;; backward-compatibility alias
 764 (put 'gnus-summary-high-ancient-face 'face-alias 'gnus-summary-high-ancient)
 765 (put 'gnus-summary-high-ancient-face 'obsolete-face "22.1")
 766
 767 (defface gnus-summary-low-ancient
 768   '((((class color)
 769       (background dark))
 770      (:foreground "SkyBlue" :italic t))
 771     (((class color)
 772       (background light))
 773      (:foreground "RoyalBlue" :italic t))
 774     (t
 775      (:italic t)))
 776   "Face used for low interest ancient articles."
 777   :group 'gnus-summary)
 778 ;; backward-compatibility alias
 779 (put 'gnus-summary-low-ancient-face 'face-alias 'gnus-summary-low-ancient)
 780 (put 'gnus-summary-low-ancient-face 'obsolete-face "22.1")
 781
 782 (defface gnus-summary-normal-ancient
 783   '((((class color)
 784       (background dark))
 785      (:foreground "SkyBlue"))
 786     (((class color)
 787       (background light))
 788      (:foreground "RoyalBlue"))
 789     (t
 790      ()))
 791   "Face used for normal interest ancient articles."
 792   :group 'gnus-summary)
 793 ;; backward-compatibility alias
 794 (put 'gnus-summary-normal-ancient-face 'face-alias 'gnus-summary-normal-ancient)
 795 (put 'gnus-summary-normal-ancient-face 'obsolete-face "22.1")
 796
 797 (defface gnus-summary-high-undownloaded
 798    '((((class color)
 799        (background light))
 800       (:bold t :foreground "cyan4"))
 801      (((class color) (background dark))
 802       (:bold t :foreground "LightGray"))
 803      (t (:inverse-video t :bold t)))
 804   "Face used for high interest uncached articles."
 805   :group 'gnus-summary)
 806 ;; backward-compatibility alias
 807 (put 'gnus-summary-high-undownloaded-face 'face-alias 'gnus-summary-high-undownloaded)
 808 (put 'gnus-summary-high-undownloaded-face 'obsolete-face "22.1")
 809
 810 (defface gnus-summary-low-undownloaded
 811    '((((class color)
 812        (background light))
 813       (:italic t :foreground "cyan4" :bold nil))
 814      (((class color) (background dark))
 815       (:italic t :foreground "LightGray" :bold nil))
 816      (t (:inverse-video t :italic t)))
 817   "Face used for low interest uncached articles."
 818   :group 'gnus-summary)
 819 ;; backward-compatibility alias
 820 (put 'gnus-summary-low-undownloaded-face 'face-alias 'gnus-summary-low-undownloaded)
 821 (put 'gnus-summary-low-undownloaded-face 'obsolete-face "22.1")
 822
 823 (defface gnus-summary-normal-undownloaded
 824    '((((class color)
 825        (background light))
 826       (:foreground "cyan4" :bold nil))
 827      (((class color) (background dark))
 828       (:foreground "LightGray" :bold nil))
 829      (t (:inverse-video t)))
 830   "Face used for normal interest uncached articles."
 831   :group 'gnus-summary)
 832 ;; backward-compatibility alias
 833 (put 'gnus-summary-normal-undownloaded-face 'face-alias 'gnus-summary-normal-undownloaded)
 834 (put 'gnus-summary-normal-undownloaded-face 'obsolete-face "22.1")
 835
 836 (defface gnus-summary-high-unread
 837   '((t
 838      (:bold t)))
 839   "Face used for high interest unread articles."
 840   :group 'gnus-summary)
 841 ;; backward-compatibility alias
 842 (put 'gnus-summary-high-unread-face 'face-alias 'gnus-summary-high-unread)
 843 (put 'gnus-summary-high-unread-face 'obsolete-face "22.1")
 844
 845 (defface gnus-summary-low-unread
 846   '((t
 847      (:italic t)))
 848   "Face used for low interest unread articles."
 849   :group 'gnus-summary)
 850 ;; backward-compatibility alias
 851 (put 'gnus-summary-low-unread-face 'face-alias 'gnus-summary-low-unread)
 852 (put 'gnus-summary-low-unread-face 'obsolete-face "22.1")
 853
 854 (defface gnus-summary-normal-unread
 855   '((t
 856      ()))
 857   "Face used for normal interest unread articles."
 858   :group 'gnus-summary)
 859 ;; backward-compatibility alias
 860 (put 'gnus-summary-normal-unread-face 'face-alias 'gnus-summary-normal-unread)
 861 (put 'gnus-summary-normal-unread-face 'obsolete-face "22.1")
 862
 863 (defface gnus-summary-high-read
 864   '((((class color)
 865       (background dark))
 866      (:foreground "PaleGreen"
 867                   :bold t))
 868     (((class color)
 869       (background light))
 870      (:foreground "DarkGreen"
 871                   :bold t))
 872     (t
 873      (:bold t)))
 874   "Face used for high interest read articles."
 875   :group 'gnus-summary)
 876 ;; backward-compatibility alias
 877 (put 'gnus-summary-high-read-face 'face-alias 'gnus-summary-high-read)
 878 (put 'gnus-summary-high-read-face 'obsolete-face "22.1")
 879
 880 (defface gnus-summary-low-read
 881   '((((class color)
 882       (background dark))
 883      (:foreground "PaleGreen"
 884                   :italic t))
 885     (((class color)
 886       (background light))
 887      (:foreground "DarkGreen"
 888                   :italic t))
 889     (t
 890      (:italic t)))
 891   "Face used for low interest read articles."
 892   :group 'gnus-summary)
 893 ;; backward-compatibility alias
 894 (put 'gnus-summary-low-read-face 'face-alias 'gnus-summary-low-read)
 895 (put 'gnus-summary-low-read-face 'obsolete-face "22.1")
 896
 897 (defface gnus-summary-normal-read
 898   '((((class color)
 899       (background dark))
 900      (:foreground "PaleGreen"))
 901     (((class color)
 902       (background light))
 903      (:foreground "DarkGreen"))
 904     (t
 905      ()))
 906   "Face used for normal interest read articles."
 907   :group 'gnus-summary)
 908 ;; backward-compatibility alias
 909 (put 'gnus-summary-normal-read-face 'face-alias 'gnus-summary-normal-read)
 910 (put 'gnus-summary-normal-read-face 'obsolete-face "22.1")
 911
 912
 913 ;;;
 914 ;;; Gnus buffers
 915 ;;;
 916
 917 (defvar gnus-buffers nil
 918   "List of buffers handled by Gnus.")
 919
 920 (defun gnus-get-buffer-create (name)
 921   "Do the same as `get-buffer-create', but store the created buffer."
 922   (or (get-buffer name)
 923       (car (push (get-buffer-create name) gnus-buffers))))
 924
 925 (defun gnus-add-buffer ()
 926   "Add the current buffer to the list of Gnus buffers."
 927   (push (current-buffer) gnus-buffers))
 928
 929 (defmacro gnus-kill-buffer (buffer)
 930   "Kill BUFFER and remove from the list of Gnus buffers."
 931   `(let ((buf ,buffer))
 932      (when (gnus-buffer-exists-p buf)
 933        (setq gnus-buffers (delete (get-buffer buf) gnus-buffers))
 934        (kill-buffer buf))))
 935
 936 (defun gnus-buffers ()
 937   "Return a list of live Gnus buffers."
 938   (while (and gnus-buffers
 939               (not (buffer-name (car gnus-buffers))))
 940     (pop gnus-buffers))
 941   (let ((buffers gnus-buffers))
 942     (while (cdr buffers)
 943       (if (buffer-name (cadr buffers))
 944           (pop buffers)
 945         (setcdr buffers (cddr buffers)))))
 946   gnus-buffers)
 947
 948 ;;; Splash screen.
 949
 950 (defvar gnus-group-buffer "*Group*"
 951   "Name of the Gnus group buffer.")
 952
 953 (defface gnus-splash
 954   '((((class color)
 955       (background dark))
 956      (:foreground "#cccccc"))
 957     (((class color)
 958       (background light))
 959      (:foreground "#888888"))
 960     (t
 961      ()))
 962   "Face for the splash screen."
 963   :group 'gnus-start)
 964 ;; backward-compatibility alias
 965 (put 'gnus-splash-face 'face-alias 'gnus-splash)
 966 (put 'gnus-splash-face 'obsolete-face "22.1")
 967
 968 (defun gnus-splash ()
 969   (save-excursion
 970     (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
 971     (let ((buffer-read-only nil))
 972       (erase-buffer)
 973       (unless gnus-inhibit-startup-message
 974         (gnus-group-startup-message)
 975         (sit-for 0)))))
 976
 977 (defun gnus-indent-rigidly (start end arg)
 978   "Indent rigidly using only spaces and no tabs."
 979   (save-excursion
 980     (save-restriction
 981       (narrow-to-region start end)
 982       (let ((tab-width 8))
 983         (indent-rigidly start end arg)
 984         ;; We translate tabs into spaces -- not everybody uses
 985         ;; an 8-character tab.
 986         (goto-char (point-min))
 987         (while (search-forward "\t" nil t)
 988           (replace-match "        " t t))))))
 989
 990 ;;(format "%02x%02x%02x" 114 66 20) "724214"
 991
 992 (defvar gnus-logo-color-alist
 993   '((flame "#cc3300" "#ff2200")
 994     (pine "#c0cc93" "#f8ffb8")
 995     (moss "#a1cc93" "#d2ffb8")
 996     (irish "#04cc90" "#05ff97")
 997     (sky "#049acc" "#05deff")
 998     (tin "#6886cc" "#82b6ff")
 999     (velvet "#7c68cc" "#8c82ff")
1000     (grape "#b264cc" "#cf7df")
1001     (labia "#cc64c2" "#fd7dff")
1002     (berry "#cc6485" "#ff7db5")
1003     (dino "#724214" "#1e3f03")
1004     (oort "#cccccc" "#888888")
1005     (storm "#666699" "#99ccff")
1006     (pdino "#9999cc" "#99ccff")
1007     (purp "#9999cc" "#666699")
1008     (no "#ff0000" "#ffff00")
1009     (neutral "#b4b4b4" "#878787")
1010     (september "#bf9900" "#ffcc00"))
1011   "Color alist used for the Gnus logo.")
1012
1013 (defcustom gnus-logo-color-style 'no
1014   "*Color styles used for the Gnus logo."
1015   :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
1016                            gnus-logo-color-alist))
1017   :group 'gnus-xmas)
1018
1019 (defvar gnus-logo-colors
1020   (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
1021   "Colors used for the Gnus logo.")
1022
1023 (declare-function image-size "image.c" (spec &optional pixels frame))
1024
1025 (defun gnus-group-startup-message (&optional x y)
1026   "Insert startup message in current buffer."
1027   ;; Insert the message.
1028   (erase-buffer)
1029   (unless (and
1030            (fboundp 'find-image)
1031            (display-graphic-p)
1032            ;; Make sure the library defining `image-load-path' is
1033            ;; loaded (`find-image' is autoloaded) (and discard the
1034            ;; result).  Else, we may get "defvar ignored because
1035            ;; image-load-path is let-bound" when calling `find-image'
1036            ;; below.
1037            (or (find-image '(nil (:type xpm :file "gnus.xpm"))) t)
1038            (let* ((data-directory (nnheader-find-etc-directory "images/gnus"))
1039                   (image-load-path (cond (data-directory
1040                                           (list data-directory))
1041                                          ((boundp 'image-load-path)
1042                                           (symbol-value 'image-load-path))
1043                                          (t load-path)))
1044                   (image (find-image
1045                           `((:type xpm :file "gnus.xpm"
1046                                    :color-symbols
1047                                    (("thing" . ,(car gnus-logo-colors))
1048                                     ("shadow" . ,(cadr gnus-logo-colors))))
1049                             (:type svg :file "gnus.svg")
1050                             (:type png :file "gnus.png")
1051                             (:type pbm :file "gnus.pbm"
1052                                    ;; Account for the pbm's background.
1053                                    :background ,(face-foreground 'gnus-splash)
1054                                    :foreground ,(face-background 'default))
1055                             (:type xbm :file "gnus.xbm"
1056                                    ;; Account for the xbm's background.
1057                                    :background ,(face-foreground 'gnus-splash)
1058                                    :foreground ,(face-background 'default))))))
1059              (when image
1060                (let ((size (image-size image)))
1061                  (insert-char ?\n (max 0 (round (- (window-height)
1062                                                    (or y (cdr size)) 1) 2)))
1063                  (insert-char ?\  (max 0 (round (- (window-width)
1064                                                    (or x (car size))) 2)))
1065                  (insert-image image))
1066                (goto-char (point-min))
1067                t)))
1068     (insert
1069      (format "
1070           _    ___ _             _
1071           _ ___ __ ___  __    _ ___
1072           __   _     ___    __  ___
1073               _           ___     _
1074              _  _ __             _
1075              ___   __            _
1076                    __           _
1077                     _      _   _
1078                    _      _    _
1079                       _  _    _
1080                   __  ___
1081                  _   _ _     _
1082                 _   _
1083               _    _
1084              _    _
1085             _
1086           __
1087
1088 "))
1089     ;; And then hack it.
1090     (gnus-indent-rigidly (point-min) (point-max)
1091                          (/ (max (- (window-width) (or x 46)) 0) 2))
1092     (goto-char (point-min))
1093     (forward-line 1)
1094     (let* ((pheight (count-lines (point-min) (point-max)))
1095            (wheight (window-height))
1096            (rest (- wheight pheight)))
1097       (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
1098     ;; Fontify some.
1099     (put-text-property (point-min) (point-max) 'face 'gnus-splash)
1100     (goto-char (point-min))
1101     (setq mode-line-buffer-identification (concat " " gnus-version))
1102     (set-buffer-modified-p t)))
1103
1104 (eval-when (load)
1105   (let ((command (format "%s" this-command)))
1106     (when (string-match "gnus" command)
1107       (if (string-match "gnus-other-frame" command)
1108           (gnus-get-buffer-create gnus-group-buffer)
1109         (gnus-splash)))))
1110
1111 ;;; Do the rest.
1112
1113 (require 'gnus-util)
1114 (require 'nnheader)
1115
1116 (defcustom gnus-parameters nil
1117   "Alist of group parameters.
1118
1119 For example:
1120    ((\"mail\\\\..*\"  (gnus-show-threads nil)
1121                   (gnus-use-scoring nil)
1122                   (gnus-summary-line-format
1123                         \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
1124                   (gcc-self . t)
1125                   (display . all))
1126      (\"mail\\\\.me\" (gnus-use-scoring  t))
1127      (\"list\\\\..*\" (total-expire . t)
1128                   (broken-reply-to . t)))"
1129   :version "22.1"
1130   :group 'gnus-group-various
1131   :type '(repeat (cons regexp
1132                        (repeat sexp))))
1133
1134 (defcustom gnus-parameters-case-fold-search 'default
1135   "If it is t, ignore case of group names specified in `gnus-parameters'.
1136 If it is nil, don't ignore case.  If it is `default', which is for the
1137 backward compatibility, use the value of `case-fold-search'."
1138   :version "22.1"
1139   :group 'gnus-group-various
1140   :type '(choice :format "%{%t%}:\n %[Value Menu%] %v"
1141                  (const :tag "Use `case-fold-search'" default)
1142                  (const nil)
1143                  (const t)))
1144
1145 (defvar gnus-group-parameters-more nil)
1146
1147 (defmacro gnus-define-group-parameter (param &rest rest)
1148   "Define a group parameter PARAM.
1149 REST is a plist of following:
1150 :type               One of `bool', `list' or nil.
1151 :function           The name of the function.
1152 :function-document  The documentation of the function.
1153 :parameter-type     The type for customizing the parameter.
1154 :parameter-document The documentation for the parameter.
1155 :variable           The name of the variable.
1156 :variable-document  The documentation for the variable.
1157 :variable-group     The group for customizing the variable.
1158 :variable-type      The type for customizing the variable.
1159 :variable-default   The default value of the variable."
1160   (let* ((type (plist-get rest :type))
1161          (parameter-type (plist-get rest :parameter-type))
1162          (parameter-document (plist-get rest :parameter-document))
1163          (function (or (plist-get rest :function)
1164                        (intern (format "gnus-parameter-%s" param))))
1165          (function-document (or (plist-get rest :function-document) ""))
1166          (variable (or (plist-get rest :variable)
1167                        (intern (format "gnus-parameter-%s-alist" param))))
1168          (variable-document (or (plist-get rest :variable-document) ""))
1169          (variable-group (plist-get rest :variable-group))
1170          (variable-type (or (plist-get rest :variable-type)
1171                             `(quote (repeat
1172                                      (list (regexp :tag "Group")
1173                                            ,(car (cdr parameter-type)))))))
1174          (variable-default (plist-get rest :variable-default)))
1175     (list
1176      'progn
1177      `(defcustom ,variable ,variable-default
1178         ,variable-document
1179         :group 'gnus-group-parameter
1180         :group ',variable-group
1181         :type ,variable-type)
1182      `(setq gnus-group-parameters-more
1183             (delq (assq ',param gnus-group-parameters-more)
1184                   gnus-group-parameters-more))
1185      `(add-to-list 'gnus-group-parameters-more
1186                    (list ',param
1187                          ,parameter-type
1188                          ,parameter-document))
1189      (if (eq type 'bool)
1190          `(defun ,function (name)
1191             ,function-document
1192             (let ((params (gnus-group-find-parameter name))
1193                   val)
1194               (cond
1195                ((memq ',param params)
1196                 t)
1197                ((setq val (assq ',param params))
1198                 (cdr val))
1199                ((stringp ,variable)
1200                 (string-match ,variable name))
1201                (,variable
1202                 (let ((alist ,variable)
1203                       elem value)
1204                   (while (setq elem (pop alist))
1205                     (when (and name
1206                                (string-match (car elem) name))
1207                       (setq alist nil
1208                             value (cdr elem))))
1209                   (if (consp value) (car value) value))))))
1210        `(defun ,function (name)
1211           ,function-document
1212           (and name
1213                (or (gnus-group-find-parameter name ',param ,(and type t))
1214                    (let ((alist ,variable)
1215                          elem value)
1216                      (while (setq elem (pop alist))
1217                        (when (and name
1218                                   (string-match (car elem) name))
1219                          (setq alist nil
1220                                value (cdr elem))))
1221                      ,(if type
1222                           'value
1223                         '(if (consp value) (car value) value))))))))))
1224
1225 (defcustom gnus-home-directory "~/"
1226   "Directory variable that specifies the \"home\" directory.
1227 All other Gnus file and directory variables are initialized from this variable."
1228   :group 'gnus-files
1229   :type 'directory)
1230
1231 (defcustom gnus-directory (or (getenv "SAVEDIR")
1232                               (nnheader-concat gnus-home-directory "News/"))
1233   "*Directory variable from which all other Gnus file variables are derived.
1234
1235 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1236 This means that other directory variables that are initialized from
1237 this variable won't be set properly if you set this variable in `.gnus.el'.
1238 Set this variable in `.emacs' instead."
1239   :group 'gnus-files
1240   :type 'directory)
1241
1242 (defcustom gnus-default-directory nil
1243   "*Default directory for all Gnus buffers."
1244   :group 'gnus-files
1245   :type '(choice (const :tag "current" nil)
1246                  directory))
1247
1248 ;; Site dependent variables.  These variables should be defined in
1249 ;; paths.el.
1250
1251 (defvar gnus-default-nntp-server nil
1252   "Specify a default NNTP server.
1253 This variable should be defined in paths.el, and should never be set
1254 by the user.
1255 If you want to change servers, you should use `gnus-select-method'.
1256 See the documentation to that variable.")
1257
1258 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1259   "A file with only the name of the nntp server in it."
1260   :group 'gnus-files
1261   :group 'gnus-server
1262   :type 'file)
1263
1264 (defun gnus-getenv-nntpserver ()
1265   "Find default nntp server.
1266 Check the NNTPSERVER environment variable and the
1267 `gnus-nntpserver-file' file."
1268   (or (getenv "NNTPSERVER")
1269       (and (file-readable-p gnus-nntpserver-file)
1270            (with-temp-buffer
1271              (insert-file-contents gnus-nntpserver-file)
1272              (when (re-search-forward "[^ \t\n\r]+" nil t)
1273                (match-string 0))))))
1274
1275 ;; `M-x customize-variable RET gnus-select-method RET' should work without
1276 ;; starting or even loading Gnus.
1277 ;;;###autoload(when (fboundp 'custom-autoload)
1278 ;;;###autoload  (custom-autoload 'gnus-select-method "gnus"))
1279
1280 (defcustom gnus-select-method
1281   (list 'nntp (or (gnus-getenv-nntpserver)
1282                   (when (and gnus-default-nntp-server
1283                              (not (string= gnus-default-nntp-server "")))
1284                     gnus-default-nntp-server)
1285                   "news"))
1286   "Default method for selecting a newsgroup.
1287 This variable should be a list, where the first element is how the
1288 news is to be fetched, the second is the address.
1289
1290 For instance, if you want to get your news via \"flab.flab.edu\" using
1291 NNTP, you could say:
1292
1293 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1294
1295 If you want to use your local spool, say:
1296
1297 \(setq gnus-select-method (list 'nnspool (system-name)))
1298
1299 If you use this variable, you must set `gnus-nntp-server' to nil.
1300
1301 There is a lot more to know about select methods and virtual servers -
1302 see the manual for details."
1303   :group 'gnus-server
1304   :group 'gnus-start
1305   :initialize 'custom-initialize-default
1306   :type 'gnus-select-method)
1307
1308 (defcustom gnus-message-archive-method "archive"
1309   "*Method used for archiving messages you've sent.
1310 This should be a mail method.
1311
1312 See also `gnus-update-message-archive-method'."
1313   :group 'gnus-server
1314   :group 'gnus-message
1315   :type '(choice (const :tag "Default archive method" "archive")
1316                  gnus-select-method))
1317
1318 (defcustom gnus-update-message-archive-method nil
1319   "Non-nil means always update the saved \"archive\" method.
1320
1321 The archive method is initially set according to the value of
1322 `gnus-message-archive-method' and is saved in the \"~/.newsrc.eld\" file
1323 so that it may be used as a real method of the server which is named
1324 \"archive\" ever since.  If it once has been saved, it will never be
1325 updated if the value of this variable is nil, even if you change the
1326 value of `gnus-message-archive-method' afterward.  If you want the
1327 saved \"archive\" method to be updated whenever you change the value of
1328 `gnus-message-archive-method', set this variable to a non-nil value."
1329   :version "23.1"
1330   :group 'gnus-server
1331   :group 'gnus-message
1332   :type 'boolean)
1333
1334 (defcustom gnus-message-archive-group '((format-time-string "sent.%Y-%m"))
1335   "*Name of the group in which to save the messages you've written.
1336 This can either be a string; a list of strings; or an alist
1337 of regexps/functions/forms to be evaluated to return a string (or a list
1338 of strings).  The functions are called with the name of the current
1339 group (or nil) as a parameter.
1340
1341 If you want to save your mail in one group and the news articles you
1342 write in another group, you could say something like:
1343
1344  \(setq gnus-message-archive-group
1345         '((if (message-news-p)
1346               \"misc-news\"
1347             \"misc-mail\")))
1348
1349 Normally the group names returned by this variable should be
1350 unprefixed -- which implicitly means \"store on the archive server\".
1351 However, you may wish to store the message on some other server.  In
1352 that case, just return a fully prefixed name of the group --
1353 \"nnml+private:mail.misc\", for instance."
1354   :version "24.1"
1355   :group 'gnus-message
1356   :type '(choice (const :tag "none" nil)
1357                  (const :tag "Weekly" ((format-time-string "sent.%Yw%U")))
1358                  (const :tag "Monthly" ((format-time-string "sent.%Y-%m")))
1359                  (const :tag "Yearly" ((format-time-string "sent.%Y")))
1360                  function
1361                  sexp
1362                  string))
1363
1364 (defcustom gnus-secondary-servers nil
1365   "List of NNTP servers that the user can choose between interactively.
1366 To make Gnus query you for a server, you have to give `gnus' a
1367 non-numeric prefix - `C-u M-x gnus', in short."
1368   :group 'gnus-server
1369   :type '(repeat string))
1370 (make-obsolete-variable 'gnus-secondary-servers 'gnus-select-method "24.1")
1371
1372 (defcustom gnus-nntp-server nil
1373   "The name of the host running the NNTP server."
1374   :group 'gnus-server
1375   :type '(choice (const :tag "disable" nil)
1376                  string))
1377 (make-obsolete-variable 'gnus-nntp-server 'gnus-select-method "24.1")
1378
1379 (defcustom gnus-secondary-select-methods nil
1380   "A list of secondary methods that will be used for reading news.
1381 This is a list where each element is a complete select method (see
1382 `gnus-select-method').
1383
1384 If, for instance, you want to read your mail with the nnml back end,
1385 you could set this variable:
1386
1387 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1388   :group 'gnus-server
1389   :type '(repeat gnus-select-method))
1390
1391 (defcustom gnus-local-domain nil
1392   "Local domain name without a host name.
1393 The DOMAINNAME environment variable is used instead if it is defined.
1394 If the function `system-name' returns the full Internet name, there is
1395 no need to set this variable."
1396   :group 'gnus-message
1397   :type '(choice (const :tag "default" nil)
1398                  string))
1399 (make-obsolete-variable 'gnus-local-domain nil "Emacs 24.1")
1400
1401 ;; Customization variables
1402
1403 (defcustom gnus-refer-article-method 'current
1404   "Preferred method for fetching an article by Message-ID.
1405 If you are reading news from the local spool (with nnspool), fetching
1406 articles by Message-ID is painfully slow.  By setting this method to an
1407 nntp method, you might get acceptable results.
1408
1409 The value of this variable must be a valid select method as discussed
1410 in the documentation of `gnus-select-method'.
1411
1412 It can also be a list of select methods, as well as the special symbol
1413 `current', which means to use the current select method.  If it is a
1414 list, Gnus will try all the methods in the list until it finds a match."
1415   :version "24.1"
1416   :group 'gnus-server
1417   :type '(choice (const :tag "default" nil)
1418                  (const current)
1419                  (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1420                  gnus-select-method
1421                  (repeat :menu-tag "Try multiple"
1422                          :tag "Multiple"
1423                          :value (current (nnweb "refer" (nnweb-type google)))
1424                          (choice :tag "Method"
1425                                  (const current)
1426                                  (const :tag "Google"
1427                                         (nnweb "refer" (nnweb-type google)))
1428                                  gnus-select-method))))
1429
1430 (defcustom gnus-use-cross-reference t
1431   "*Non-nil means that cross referenced articles will be marked as read.
1432 If nil, ignore cross references.  If t, mark articles as read in
1433 subscribed newsgroups.  If neither t nor nil, mark as read in all
1434 newsgroups."
1435   :group 'gnus-server
1436   :type '(choice (const :tag "off" nil)
1437                  (const :tag "subscribed" t)
1438                  (sexp :format "all"
1439                        :value always)))
1440
1441 (defcustom gnus-process-mark ?#
1442   "*Process mark."
1443   :group 'gnus-group-visual
1444   :group 'gnus-summary-marks
1445   :type 'character)
1446
1447 (defcustom gnus-large-newsgroup 200
1448   "*The number of articles which indicates a large newsgroup.
1449 If the number of articles in a newsgroup is greater than this value,
1450 confirmation is required for selecting the newsgroup.
1451 If it is nil, no confirmation is required.
1452
1453 Also see `gnus-large-ephemeral-newsgroup'."
1454   :group 'gnus-group-select
1455   :type '(choice (const :tag "No limit" nil)
1456                  integer))
1457
1458 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v)))
1459   "Non-nil means that the default name of a file to save articles in is the group name.
1460 If it's nil, the directory form of the group name is used instead.
1461
1462 If this variable is a list, and the list contains the element
1463 `not-score', long file names will not be used for score files; if it
1464 contains the element `not-save', long file names will not be used for
1465 saving; and if it contains the element `not-kill', long file names
1466 will not be used for kill files.
1467
1468 Note that the default for this variable varies according to what system
1469 type you're using.  On `usg-unix-v' this variable defaults to nil while
1470 on all other systems it defaults to t."
1471   :group 'gnus-start
1472   :type '(radio (sexp :format "Non-nil\n"
1473                       :match (lambda (widget value)
1474                                (and value (not (listp value))))
1475                       :value t)
1476                 (const nil)
1477                 (checklist (const :format "%v " not-score)
1478                            (const :format "%v " not-save)
1479                            (const not-kill))))
1480
1481 (defcustom gnus-kill-files-directory gnus-directory
1482   "*Name of the directory where kill files will be stored (default \"~/News\")."
1483   :group 'gnus-score-files
1484   :group 'gnus-score-kill
1485   :type 'directory)
1486
1487 (defcustom gnus-save-score nil
1488   "*If non-nil, save group scoring info."
1489   :group 'gnus-score-various
1490   :group 'gnus-start
1491   :type 'boolean)
1492
1493 (defcustom gnus-use-undo t
1494   "*If non-nil, allow undoing in Gnus group mode buffers."
1495   :group 'gnus-meta
1496   :type 'boolean)
1497
1498 (defcustom gnus-use-adaptive-scoring nil
1499   "*If non-nil, use some adaptive scoring scheme.
1500 If a list, then the values `word' and `line' are meaningful.  The
1501 former will perform adaption on individual words in the subject
1502 header while `line' will perform adaption on several headers."
1503   :group 'gnus-meta
1504   :group 'gnus-score-adapt
1505   :type '(set (const word) (const line)))
1506
1507 (defcustom gnus-use-cache 'passive
1508   "*If nil, Gnus will ignore the article cache.
1509 If `passive', it will allow entering (and reading) articles
1510 explicitly entered into the cache.  If anything else, use the
1511 cache to the full extent of the law."
1512   :group 'gnus-meta
1513   :group 'gnus-cache
1514   :type '(choice (const :tag "off" nil)
1515                  (const :tag "passive" passive)
1516                  (const :tag "active" t)))
1517
1518 (defcustom gnus-use-trees nil
1519   "*If non-nil, display a thread tree buffer."
1520   :group 'gnus-meta
1521   :type 'boolean)
1522
1523 (defcustom gnus-keep-backlog 20
1524   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1525 If it is a number N, then Gnus will only keep the last N articles
1526 read.  If it is neither nil nor a number, Gnus will keep all read
1527 articles.  This is not a good idea."
1528   :group 'gnus-meta
1529   :type '(choice (const :tag "off" nil)
1530                  integer
1531                  (sexp :format "all"
1532                        :value t)))
1533
1534 (defcustom gnus-suppress-duplicates nil
1535   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1536   :group 'gnus-meta
1537   :type 'boolean)
1538
1539 (defcustom gnus-use-scoring t
1540   "*If non-nil, enable scoring."
1541   :group 'gnus-meta
1542   :type 'boolean)
1543
1544 (defcustom gnus-summary-prepare-exit-hook
1545   '(gnus-summary-expire-articles)
1546   "*A hook called when preparing to exit from the summary buffer.
1547 It calls `gnus-summary-expire-articles' by default."
1548   :group 'gnus-summary-exit
1549   :type 'hook)
1550
1551 (defcustom gnus-novice-user t
1552   "*Non-nil means that you are a Usenet novice.
1553 If non-nil, verbose messages may be displayed and confirmations may be
1554 required."
1555   :group 'gnus-meta
1556   :type 'boolean)
1557
1558 (defcustom gnus-expert-user nil
1559   "*Non-nil means that you will never be asked for confirmation about anything.
1560 That doesn't mean *anything* anything; particularly destructive
1561 commands will still require prompting."
1562   :group 'gnus-meta
1563   :type 'boolean)
1564
1565 (defcustom gnus-interactive-catchup t
1566   "*If non-nil, require your confirmation when catching up a group."
1567   :group 'gnus-group-select
1568   :type 'boolean)
1569
1570 (defcustom gnus-interactive-exit t
1571   "*If non-nil, require your confirmation when exiting Gnus."
1572   :group 'gnus-exit
1573   :type 'boolean)
1574
1575 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1576   "*Function for extracting address components from a From header.
1577 Two pre-defined function exist: `gnus-extract-address-components',
1578 which is the default, quite fast, and too simplistic solution, and
1579 `mail-extract-address-components', which works much better, but is
1580 slower."
1581   :group 'gnus-summary-format
1582   :type '(radio (function-item gnus-extract-address-components)
1583                 (function-item mail-extract-address-components)
1584                 (function :tag "Other")))
1585
1586 (defcustom gnus-shell-command-separator ";"
1587   "String used to separate shell commands."
1588   :group 'gnus-files
1589   :type 'string)
1590
1591 (defcustom gnus-valid-select-methods
1592   '(("nntp" post address prompt-address physical-address)
1593     ("nnspool" post address)
1594     ("nnvirtual" post-mail virtual prompt-address)
1595     ("nnmbox" mail respool address)
1596     ("nnml" post-mail respool address)
1597     ("nnmh" mail respool address)
1598     ("nndir" post-mail prompt-address physical-address)
1599     ("nneething" none address prompt-address physical-address)
1600     ("nndoc" none address prompt-address)
1601     ("nnbabyl" mail address respool)
1602     ("nndraft" post-mail)
1603     ("nnfolder" mail respool address)
1604     ("nngateway" post-mail address prompt-address physical-address)
1605     ("nnweb" none)
1606     ("nnrss" none)
1607     ("nnagent" post-mail)
1608     ("nnimap" post-mail address prompt-address physical-address respool)
1609     ("nnmaildir" mail respool address)
1610     ("nnnil" none))
1611   "*An alist of valid select methods.
1612 The first element of each list lists should be a string with the name
1613 of the select method.  The other elements may be the category of
1614 this method (i. e., `post', `mail', `none' or whatever) or other
1615 properties that this method has (like being respoolable).
1616 If you implement a new select method, all you should have to change is
1617 this variable.  I think."
1618   :group 'gnus-server
1619   :type '(repeat (group (string :tag "Name")
1620                         (radio-button-choice (const :format "%v " post)
1621                                              (const :format "%v " mail)
1622                                              (const :format "%v " none)
1623                                              (const post-mail))
1624                         (checklist :inline t
1625                                    (const :format "%v " address)
1626                                    (const :format "%v " prompt-address)
1627                                    (const :format "%v " physical-address)
1628                                    (const :format "%v " virtual)
1629                                    (const respool))))
1630   :version "24.1")
1631
1632 (defun gnus-redefine-select-method-widget ()
1633   "Recomputes the select-method widget based on the value of
1634 `gnus-valid-select-methods'."
1635   (define-widget 'gnus-select-method 'list
1636     "Widget for entering a select method."
1637     :value '(nntp "")
1638     :tag "Select Method"
1639     :args `((choice :tag "Method"
1640                     ,@(mapcar (lambda (entry)
1641                                 (list 'const :format "%v\n"
1642                                       (intern (car entry))))
1643                               gnus-valid-select-methods)
1644                     (symbol :tag "other"))
1645             (string :tag "Address")
1646             (repeat :tag "Options"
1647                     :inline t
1648                     (list :format "%v"
1649                           variable
1650                           (sexp :tag "Value"))))))
1651
1652 (gnus-redefine-select-method-widget)
1653
1654 (defcustom gnus-updated-mode-lines '(group article summary tree)
1655   "List of buffers that should update their mode lines.
1656 The list may contain the symbols `group', `article', `tree' and
1657 `summary'.  If the corresponding symbol is present, Gnus will keep
1658 that mode line updated with information that may be pertinent.
1659 If this variable is nil, screen refresh may be quicker."
1660   :group 'gnus-various
1661   :type '(set (const group)
1662               (const article)
1663               (const summary)
1664               (const tree)))
1665
1666 (defcustom gnus-mode-non-string-length 30
1667   "*Max length of mode-line non-string contents.
1668 If this is nil, Gnus will take space as is needed, leaving the rest
1669 of the mode line intact."
1670   :version "24.1"
1671   :group 'gnus-various
1672   :type '(choice (const nil)
1673                  integer))
1674
1675 ;; There should be special validation for this.
1676 (define-widget 'gnus-email-address 'string
1677   "An email address.")
1678
1679 (gnus-define-group-parameter
1680  to-address
1681  :function-document
1682  "Return GROUP's to-address."
1683  :variable-document
1684  "*Alist of group regexps and correspondent to-addresses."
1685  :variable-group gnus-group-parameter
1686  :parameter-type '(gnus-email-address :tag "To Address")
1687  :parameter-document "\
1688 This will be used when doing followups and posts.
1689
1690 This is primarily useful in mail groups that represent closed
1691 mailing lists--mailing lists where it's expected that everybody that
1692 writes to the mailing list is subscribed to it.  Since using this
1693 parameter ensures that the mail only goes to the mailing list itself,
1694 it means that members won't receive two copies of your followups.
1695
1696 Using `to-address' will actually work whether the group is foreign or
1697 not.  Let's say there's a group on the server that is called
1698 `fa.4ad-l'.  This is a real newsgroup, but the server has gotten the
1699 articles from a mail-to-news gateway.  Posting directly to this group
1700 is therefore impossible--you have to send mail to the mailing list
1701 address instead.
1702
1703 The gnus-group-split mail splitting mechanism will behave as if this
1704 address was listed in gnus-group-split Addresses (see below).")
1705
1706 (gnus-define-group-parameter
1707  to-list
1708  :function-document
1709  "Return GROUP's to-list."
1710  :variable-document
1711  "*Alist of group regexps and correspondent to-lists."
1712  :variable-group gnus-group-parameter
1713  :parameter-type '(gnus-email-address :tag "To List")
1714  :parameter-document "\
1715 This address will be used when doing a `a' in the group.
1716
1717 It is totally ignored when doing a followup--except that if it is
1718 present in a news group, you'll get mail group semantics when doing
1719 `f'.
1720
1721 The gnus-group-split mail splitting mechanism will behave as if this
1722 address was listed in gnus-group-split Addresses (see below).")
1723
1724 (gnus-define-group-parameter
1725  subscribed
1726  :type bool
1727  :function-document
1728  "Return GROUP's subscription status."
1729  :variable-document
1730  "*Groups which are automatically considered subscribed."
1731  :variable-group gnus-group-parameter
1732  :parameter-type '(const :tag "Subscribed" t)
1733  :parameter-document "\
1734 Gnus assumed that you are subscribed to the To/List address.
1735
1736 When constructing a list of subscribed groups using
1737 `gnus-find-subscribed-addresses', Gnus includes the To address given
1738 above, or the list address (if the To address has not been set).")
1739
1740 (gnus-define-group-parameter
1741  auto-expire
1742  :type bool
1743  :function gnus-group-auto-expirable-p
1744  :function-document
1745  "Check whether GROUP is auto-expirable or not."
1746  :variable gnus-auto-expirable-newsgroups
1747  :variable-default nil
1748  :variable-document
1749  "*Groups in which to automatically mark read articles as expirable.
1750 If non-nil, this should be a regexp that should match all groups in
1751 which to perform auto-expiry.  This only makes sense for mail groups."
1752  :variable-group nnmail-expire
1753  :variable-type '(choice (const nil)
1754                          regexp)
1755  :parameter-type '(const :tag "Automatic Expire" t)
1756  :parameter-document
1757  "All articles that are read will be marked as expirable.")
1758
1759 (gnus-define-group-parameter
1760  total-expire
1761  :type bool
1762  :function gnus-group-total-expirable-p
1763  :function-document
1764  "Check whether GROUP is total-expirable or not."
1765  :variable gnus-total-expirable-newsgroups
1766  :variable-default nil
1767  :variable-document
1768  "*Groups in which to perform expiry of all read articles.
1769 Use with extreme caution.  All groups that match this regexp will be
1770 expiring - which means that all read articles will be deleted after
1771 \(say) one week.  (This only goes for mail groups and the like, of
1772 course.)"
1773  :variable-group nnmail-expire
1774  :variable-type '(choice (const nil)
1775                          regexp)
1776  :parameter-type '(const :tag "Total Expire" t)
1777  :parameter-document
1778  "All read articles will be put through the expiry process
1779
1780 This happens even if they are not marked as expirable.
1781 Use with caution.")
1782
1783 (gnus-define-group-parameter
1784  charset
1785  :function-document
1786  "Return the default charset of GROUP."
1787  :variable gnus-group-charset-alist
1788  :variable-default
1789  '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1790    ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1791    ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1792    ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1793    ("\\(^\\|:\\)relcom\\>" koi8-r)
1794    ("\\(^\\|:\\)fido7\\>" koi8-r)
1795    ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1796    ("\\(^\\|:\\)israel\\>" iso-8859-1)
1797    ("\\(^\\|:\\)han\\>" euc-kr)
1798    ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1799    ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1800    ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1801  :variable-document
1802  "Alist of regexps (to match group names) and default charsets to be used when reading."
1803  :variable-group gnus-charset
1804  :variable-type '(repeat (list (regexp :tag "Group")
1805                                (symbol :tag "Charset")))
1806  :parameter-type '(symbol :tag "Charset")
1807  :parameter-document "\
1808 The default charset to use in the group.")
1809
1810 (gnus-define-group-parameter
1811  post-method
1812  :type list
1813  :function-document
1814  "Return a posting method for GROUP."
1815  :variable gnus-post-method-alist
1816  :variable-document
1817  "Alist of regexps (to match group names) and method to be used when
1818 posting an article."
1819  :variable-group gnus-group-foreign
1820  :parameter-type
1821  '(choice :tag "Posting Method"
1822           (const :tag "Use native server" native)
1823           (const :tag "Use current server" current)
1824           (list :convert-widget
1825                 (lambda (widget)
1826                   (list 'sexp :tag "Methods"
1827                         :value gnus-select-method))))
1828  :parameter-document
1829  "Posting method for this group.")
1830
1831 (gnus-define-group-parameter
1832  large-newsgroup-initial
1833  :type integer
1834  :function-document
1835  "Return GROUP's initial input of the number of articles."
1836  :variable-document
1837  "*Alist of group regexps and its initial input of the number of articles."
1838  :variable-group gnus-group-parameter
1839  :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1840                           (const :tag "All" nil)
1841                           (integer))
1842  :parameter-document "\
1843
1844 This number will be prompted as the initial value of the number of
1845 articles to list when the group is a large newsgroup (see
1846 `gnus-large-newsgroup').  If it is nil, the default value is the
1847 total number of articles in the group.")
1848
1849 ;; The Gnus registry's ignored groups
1850 (gnus-define-group-parameter
1851  registry-ignore
1852  :type list
1853  :function-document
1854  "Whether this group should be ignored by the registry."
1855  :variable gnus-registry-ignored-groups
1856  :variable-default nil
1857  :variable-document
1858  "*Groups in which the registry should be turned off."
1859  :variable-group gnus-registry
1860  :variable-type '(repeat
1861                   (list
1862                    (regexp :tag "Group Name Regular Expression")
1863                    (boolean :tag "Ignored")))
1864
1865  :parameter-type '(boolean :tag "Group Ignored by the Registry")
1866  :parameter-document
1867  "Whether the Gnus Registry should ignore this group.")
1868
1869 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1870 (defcustom gnus-install-group-spam-parameters t
1871   "*Disable the group parameters for spam detection.
1872 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1873   :version "22.1"
1874   :type 'boolean
1875   :group 'gnus-start)
1876
1877 (when gnus-install-group-spam-parameters
1878   (defvar gnus-group-spam-classification-spam t
1879     "Spam group classification (requires spam.el).
1880 This group contains spam messages.  On summary entry, unread messages
1881 will be marked as spam.  On summary exit, the specified spam
1882 processors will be invoked on spam-marked messages, then those
1883 messages will be expired, so the spam processor will only see a
1884 spam-marked message once.")
1885
1886   (defvar gnus-group-spam-classification-ham 'ask
1887     "The ham value for the spam group parameter (requires spam.el).
1888 On summary exit, the specified ham processors will be invoked on
1889 ham-marked messages.  Exercise caution, since the ham processor will
1890 see the same message more than once because there is no ham message
1891 registry.")
1892
1893   (gnus-define-group-parameter
1894    spam-contents
1895    :type list
1896    :function-document
1897    "The spam type (spam, ham, or neither) of the group."
1898    :variable gnus-spam-newsgroup-contents
1899    :variable-default nil
1900    :variable-document
1901    "*Group classification (spam, ham, or neither).  Only
1902 meaningful when spam.el is loaded.  If non-nil, this should be a
1903 list of group name regexps associated with a classification for
1904 each one.  In spam groups, new articles are marked as spam on
1905 summary entry.  There is other behavior associated with ham and
1906 no classification when spam.el is loaded - see the manual."
1907    :variable-group spam
1908    :variable-type '(repeat
1909                     (list :tag "Group contents spam/ham classification"
1910                           (regexp :tag "Group")
1911                           (choice
1912                            (variable-item gnus-group-spam-classification-spam)
1913                            (variable-item gnus-group-spam-classification-ham)
1914                            (const :tag "Unclassified" nil))))
1915
1916    :parameter-type '(list :tag "Group contents spam/ham classification"
1917                           (choice :tag "Group contents classification for spam sorting"
1918                                   (variable-item gnus-group-spam-classification-spam)
1919                                   (variable-item gnus-group-spam-classification-ham)
1920                                   (const :tag "Unclassified" nil)))
1921    :parameter-document
1922    "The spam classification (spam, ham, or neither) of this group.
1923 When a spam group is entered, all unread articles are marked as
1924 spam.  There is other behavior associated with ham and no
1925 classification when spam.el is loaded - see the manual.")
1926
1927   (gnus-define-group-parameter
1928    spam-resend-to
1929    :type list
1930    :function-document
1931    "The address to get spam resent (through spam-report-resend)."
1932    :variable gnus-spam-resend-to
1933    :variable-default nil
1934    :variable-document
1935    "The address to get spam resent (through spam-report-resend)."
1936    :variable-group spam
1937    :variable-type '(repeat
1938                     (list :tag "Group address for resending spam"
1939                           (regexp :tag "Group")
1940                           (string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)")))
1941    :parameter-type 'string :tag "E-mail address for resending spam (requires the spam-use-resend exit processor)"
1942    :parameter-document
1943    "The address to get spam resent (through spam-report-resend).")
1944
1945   (gnus-define-group-parameter
1946    ham-resend-to
1947    :type list
1948    :function-document
1949    "The address to get ham resent (through spam-report-resend)."
1950    :variable gnus-ham-resend-to
1951    :variable-default nil
1952    :variable-document
1953    "The address to get ham resent (through spam-report-resend)."
1954    :variable-group spam
1955    :variable-type '(repeat
1956                     (list :tag "Group address for resending ham"
1957                           (regexp :tag "Group")
1958                           (string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)")))
1959    :parameter-type 'string :tag "E-mail address for resending ham (requires the spam-use-resend exit processor)"
1960    :parameter-document
1961    "The address to get ham resent (through spam-report-resend).")
1962
1963   (defvar gnus-group-spam-exit-processor-ifile "ifile"
1964     "OBSOLETE: The ifile summary exit spam processor.")
1965
1966   (defvar gnus-group-spam-exit-processor-stat "stat"
1967     "OBSOLETE: The spam-stat summary exit spam processor.")
1968
1969   (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1970     "OBSOLETE: The Bogofilter summary exit spam processor.")
1971
1972   (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1973     "OBSOLETE: The Blacklist summary exit spam processor.")
1974
1975   (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1976     "OBSOLETE: The Gmane reporting summary exit spam processor.
1977 Only applicable to NNTP groups with articles from Gmane.  See spam-report.el")
1978
1979   (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1980     "OBSOLETE: The spamoracle summary exit spam processor.")
1981
1982   (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1983     "OBSOLETE: The ifile summary exit ham processor.
1984 Only applicable to non-spam (unclassified and ham) groups.")
1985
1986   (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1987     "OBSOLETE: The Bogofilter summary exit ham processor.
1988 Only applicable to non-spam (unclassified and ham) groups.")
1989
1990   (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1991     "OBSOLETE: The spam-stat summary exit ham processor.
1992 Only applicable to non-spam (unclassified and ham) groups.")
1993
1994   (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1995     "OBSOLETE: The whitelist summary exit ham processor.
1996 Only applicable to non-spam (unclassified and ham) groups.")
1997
1998   (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
1999     "OBSOLETE: The BBDB summary exit ham processor.
2000 Only applicable to non-spam (unclassified and ham) groups.")
2001
2002   (defvar gnus-group-ham-exit-processor-copy "copy"
2003     "OBSOLETE: The ham copy exit ham processor.
2004 Only applicable to non-spam (unclassified and ham) groups.")
2005
2006   (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
2007     "OBSOLETE: The spamoracle summary exit ham processor.
2008 Only applicable to non-spam (unclassified and ham) groups.")
2009
2010   (gnus-define-group-parameter
2011    spam-process
2012    :type list
2013    :parameter-type
2014    '(choice
2015      :tag "Spam Summary Exit Processor"
2016      :value nil
2017      (list :tag "Spam Summary Exit Processor Choices"
2018            (set
2019             (const :tag "Spam: Bogofilter"    (spam spam-use-bogofilter))
2020             (const :tag "Spam: Blacklist"     (spam spam-use-blacklist))
2021             (const :tag "Spam: Bsfilter"      (spam spam-use-bsfilter))
2022             (const :tag "Spam: Gmane Report"  (spam spam-use-gmane))
2023             (const :tag "Spam: Resend Message"(spam spam-use-resend))
2024             (const :tag "Spam: ifile"         (spam spam-use-ifile))
2025             (const :tag "Spam: Spam Oracle"   (spam spam-use-spamoracle))
2026             (const :tag "Spam: Spam-stat"     (spam spam-use-stat))
2027             (const :tag "Spam: SpamAssassin"  (spam spam-use-spamassassin))
2028             (const :tag "Spam: CRM114"        (spam spam-use-crm114))
2029             (const :tag "Ham: BBDB"           (ham spam-use-BBDB))
2030             (const :tag "Ham: Bogofilter"     (ham spam-use-bogofilter))
2031             (const :tag "Ham: Bsfilter"       (ham spam-use-bsfilter))
2032             (const :tag "Ham: Copy"           (ham spam-use-ham-copy))
2033             (const :tag "Ham: Resend Message" (ham spam-use-resend))
2034             (const :tag "Ham: ifile"          (ham spam-use-ifile))
2035             (const :tag "Ham: Spam Oracle"    (ham spam-use-spamoracle))
2036             (const :tag "Ham: Spam-stat"      (ham spam-use-stat))
2037             (const :tag "Ham: SpamAssassin"   (ham spam-use-spamassassin))
2038             (const :tag "Ham: CRM114"         (ham spam-use-crm114))
2039             (const :tag "Ham: Whitelist"      (ham spam-use-whitelist))
2040             (variable-item gnus-group-spam-exit-processor-ifile)
2041             (variable-item gnus-group-spam-exit-processor-stat)
2042             (variable-item gnus-group-spam-exit-processor-bogofilter)
2043             (variable-item gnus-group-spam-exit-processor-blacklist)
2044             (variable-item gnus-group-spam-exit-processor-spamoracle)
2045             (variable-item gnus-group-spam-exit-processor-report-gmane)
2046             (variable-item gnus-group-ham-exit-processor-bogofilter)
2047             (variable-item gnus-group-ham-exit-processor-ifile)
2048             (variable-item gnus-group-ham-exit-processor-stat)
2049             (variable-item gnus-group-ham-exit-processor-whitelist)
2050             (variable-item gnus-group-ham-exit-processor-BBDB)
2051             (variable-item gnus-group-ham-exit-processor-spamoracle)
2052             (variable-item gnus-group-ham-exit-processor-copy))))
2053    :function-document
2054    "Which spam or ham processors will be applied when the summary is exited."
2055    :variable gnus-spam-process-newsgroups
2056    :variable-default nil
2057    :variable-document
2058    "*Groups in which to automatically process spam or ham articles with
2059 a backend on summary exit.  If non-nil, this should be a list of group
2060 name regexps that should match all groups in which to do automatic
2061 spam processing, associated with the appropriate processor."
2062    :variable-group spam
2063    :variable-type
2064    '(repeat :tag "Spam/Ham Processors"
2065             (list :tag "Spam Summary Exit Processor Choices"
2066                   (regexp :tag "Group Regexp")
2067                   (set
2068                    :tag "Spam/Ham Summary Exit Processor"
2069                    (const :tag "Spam: Bogofilter"    (spam spam-use-bogofilter))
2070                    (const :tag "Spam: Blacklist"     (spam spam-use-blacklist))
2071                    (const :tag "Spam: Bsfilter"      (spam spam-use-bsfilter))
2072                    (const :tag "Spam: Gmane Report"  (spam spam-use-gmane))
2073                    (const :tag "Spam: Resend Message"(spam spam-use-resend))
2074                    (const :tag "Spam: ifile"         (spam spam-use-ifile))
2075                    (const :tag "Spam: Spam-stat"     (spam spam-use-stat))
2076                    (const :tag "Spam: Spam Oracle"   (spam spam-use-spamoracle))
2077                    (const :tag "Spam: SpamAssassin"  (spam spam-use-spamassassin))
2078                    (const :tag "Spam: CRM114"        (spam spam-use-crm114))
2079                    (const :tag "Ham: BBDB"           (ham spam-use-BBDB))
2080                    (const :tag "Ham: Bogofilter"     (ham spam-use-bogofilter))
2081                    (const :tag "Ham: Bsfilter"       (ham spam-use-bsfilter))
2082                    (const :tag "Ham: Copy"           (ham spam-use-ham-copy))
2083                    (const :tag "Ham: Resend Message" (ham spam-use-resend))
2084                    (const :tag "Ham: ifile"          (ham spam-use-ifile))
2085                    (const :tag "Ham: Spam-stat"      (ham spam-use-stat))
2086                    (const :tag "Ham: Spam Oracle"    (ham spam-use-spamoracle))
2087                    (const :tag "Ham: SpamAssassin"   (ham spam-use-spamassassin))
2088                    (const :tag "Ham: CRM114"         (ham spam-use-crm114))
2089                    (const :tag "Ham: Whitelist"      (ham spam-use-whitelist))
2090                    (variable-item gnus-group-spam-exit-processor-ifile)
2091                    (variable-item gnus-group-spam-exit-processor-stat)
2092                    (variable-item gnus-group-spam-exit-processor-bogofilter)
2093                    (variable-item gnus-group-spam-exit-processor-blacklist)
2094                    (variable-item gnus-group-spam-exit-processor-spamoracle)
2095                    (variable-item gnus-group-spam-exit-processor-report-gmane)
2096                    (variable-item gnus-group-ham-exit-processor-bogofilter)
2097                    (variable-item gnus-group-ham-exit-processor-ifile)
2098                    (variable-item gnus-group-ham-exit-processor-stat)
2099                    (variable-item gnus-group-ham-exit-processor-whitelist)
2100                    (variable-item gnus-group-ham-exit-processor-BBDB)
2101                    (variable-item gnus-group-ham-exit-processor-spamoracle)
2102                    (variable-item gnus-group-ham-exit-processor-copy))))
2103
2104    :parameter-document
2105    "Which spam or ham processors will be applied when the summary is exited.")
2106
2107   (gnus-define-group-parameter
2108    spam-autodetect
2109    :type list
2110    :parameter-type
2111    '(boolean :tag "Spam autodetection")
2112    :function-document
2113    "Should spam be autodetected (with spam-split) in this group?"
2114    :variable gnus-spam-autodetect
2115    :variable-default nil
2116    :variable-document
2117    "*Groups in which spam should be autodetected when they are entered.
2118    Only unseen articles will be examined, unless
2119    spam-autodetect-recheck-messages is set."
2120    :variable-group spam
2121    :variable-type
2122    '(repeat
2123      :tag "Autodetection setting"
2124      (list
2125       (regexp :tag "Group Regexp")
2126       boolean))
2127    :parameter-document
2128    "Spam autodetection.
2129 Only unseen articles will be examined, unless
2130 spam-autodetect-recheck-messages is set.")
2131
2132   (gnus-define-group-parameter
2133    spam-autodetect-methods
2134    :type list
2135    :parameter-type
2136    '(choice :tag "Spam autodetection-specific methods"
2137      (const none)
2138      (const default)
2139      (set :tag "Use specific methods"
2140           (variable-item spam-use-blacklist)
2141           (variable-item spam-use-gmane-xref)
2142           (variable-item spam-use-regex-headers)
2143           (variable-item spam-use-regex-body)
2144           (variable-item spam-use-whitelist)
2145           (variable-item spam-use-BBDB)
2146           (variable-item spam-use-ifile)
2147           (variable-item spam-use-spamoracle)
2148           (variable-item spam-use-crm114)
2149           (variable-item spam-use-spamassassin)
2150           (variable-item spam-use-spamassassin-headers)
2151           (variable-item spam-use-bsfilter)
2152           (variable-item spam-use-bsfilter-headers)
2153           (variable-item spam-use-stat)
2154           (variable-item spam-use-blackholes)
2155           (variable-item spam-use-hashcash)
2156           (variable-item spam-use-bogofilter-headers)
2157           (variable-item spam-use-bogofilter)))
2158    :function-document
2159    "Methods to be used for autodetection in each group"
2160    :variable gnus-spam-autodetect-methods
2161    :variable-default nil
2162    :variable-document
2163    "*Methods for autodetecting spam per group.
2164 Requires the spam-autodetect parameter.  Only unseen articles
2165 will be examined, unless spam-autodetect-recheck-messages is
2166 set."
2167    :variable-group spam
2168    :variable-type
2169    '(repeat
2170      :tag "Autodetection methods"
2171      (list
2172       (regexp :tag "Group Regexp")
2173       (choice
2174        (const none)
2175        (const default)
2176        (set :tag "Use specific methods"
2177         (variable-item spam-use-blacklist)
2178         (variable-item spam-use-gmane-xref)
2179         (variable-item spam-use-regex-headers)
2180         (variable-item spam-use-regex-body)
2181         (variable-item spam-use-whitelist)
2182         (variable-item spam-use-BBDB)
2183         (variable-item spam-use-ifile)
2184         (variable-item spam-use-spamoracle)
2185         (variable-item spam-use-crm114)
2186         (variable-item spam-use-stat)
2187         (variable-item spam-use-blackholes)
2188         (variable-item spam-use-hashcash)
2189         (variable-item spam-use-spamassassin)
2190         (variable-item spam-use-spamassassin-headers)
2191         (variable-item spam-use-bsfilter)
2192         (variable-item spam-use-bsfilter-headers)
2193         (variable-item spam-use-bogofilter-headers)
2194         (variable-item spam-use-bogofilter)))))
2195      :parameter-document
2196    "Spam autodetection methods.
2197 Requires the spam-autodetect parameter.  Only unseen articles
2198 will be examined, unless spam-autodetect-recheck-messages is
2199 set.")
2200
2201   (gnus-define-group-parameter
2202    spam-process-destination
2203    :type list
2204    :parameter-type
2205    '(choice :tag "Destination for spam-processed articles at summary exit"
2206             (string :tag "Move to a group")
2207             (repeat :tag "Move to multiple groups"
2208                     (string :tag "Destination group"))
2209             (const :tag "Expire" nil))
2210    :function-document
2211    "Where spam-processed articles will go at summary exit."
2212    :variable gnus-spam-process-destinations
2213    :variable-default nil
2214    :variable-document
2215    "*Groups in which to explicitly send spam-processed articles to
2216 another group, or expire them (the default).  If non-nil, this should
2217 be a list of group name regexps that should match all groups in which
2218 to do spam-processed article moving, associated with the destination
2219 group or nil for explicit expiration.  This only makes sense for
2220 mail groups."
2221    :variable-group spam
2222    :variable-type
2223    '(repeat
2224      :tag "Spam-processed articles destination"
2225      (list
2226       (regexp :tag "Group Regexp")
2227       (choice
2228        :tag "Destination for spam-processed articles at summary exit"
2229        (string :tag "Move to a group")
2230        (repeat :tag "Move to multiple groups"
2231                (string :tag "Destination group"))
2232        (const :tag "Expire" nil))))
2233    :parameter-document
2234    "Where spam-processed articles will go at summary exit.")
2235
2236   (gnus-define-group-parameter
2237    ham-process-destination
2238    :type list
2239    :parameter-type
2240    '(choice
2241      :tag "Destination for ham articles at summary exit from a spam group"
2242      (string :tag "Move to a group")
2243      (repeat :tag "Move to multiple groups"
2244              (string :tag "Destination group"))
2245      (const :tag "Respool" respool)
2246      (const :tag "Do nothing" nil))
2247    :function-document
2248    "Where ham articles will go at summary exit from a spam group."
2249    :variable gnus-ham-process-destinations
2250    :variable-default nil
2251    :variable-document
2252    "*Groups in which to explicitly send ham articles to
2253 another group, or do nothing (the default).  If non-nil, this should
2254 be a list of group name regexps that should match all groups in which
2255 to do ham article moving, associated with the destination
2256 group or nil for explicit ignoring.  This only makes sense for
2257 mail groups, and only works in spam groups."
2258    :variable-group spam
2259    :variable-type
2260    '(repeat
2261      :tag "Ham articles destination"
2262      (list
2263       (regexp :tag "Group Regexp")
2264       (choice
2265        :tag "Destination for ham articles at summary exit from spam group"
2266        (string :tag "Move to a group")
2267        (repeat :tag "Move to multiple groups"
2268                 (string :tag "Destination group"))
2269        (const :tag "Respool" respool)
2270        (const :tag "Expire" nil))))
2271    :parameter-document
2272    "Where ham articles will go at summary exit from a spam group.")
2273
2274   (gnus-define-group-parameter
2275    ham-marks
2276    :type 'list
2277    :parameter-type '(list :tag "Ham mark choices"
2278                           (set
2279                            (variable-item gnus-del-mark)
2280                            (variable-item gnus-read-mark)
2281                            (variable-item gnus-ticked-mark)
2282                            (variable-item gnus-killed-mark)
2283                            (variable-item gnus-kill-file-mark)
2284                            (variable-item gnus-low-score-mark)))
2285
2286    :parameter-document
2287    "Marks considered ham (positively not spam).  Such articles will be
2288 processed as ham (non-spam) on group exit.  When nil, the global
2289 spam-ham-marks variable takes precedence."
2290    :variable-default '((".*" ((gnus-del-mark
2291                                gnus-read-mark
2292                                gnus-killed-mark
2293                                gnus-kill-file-mark
2294                                gnus-low-score-mark))))
2295    :variable-group spam
2296    :variable-document
2297    "*Groups in which to explicitly set the ham marks to some value.")
2298
2299   (gnus-define-group-parameter
2300    spam-marks
2301    :type 'list
2302    :parameter-type '(list :tag "Spam mark choices"
2303                           (set
2304                            (variable-item gnus-spam-mark)
2305                            (variable-item gnus-killed-mark)
2306                            (variable-item gnus-kill-file-mark)
2307                            (variable-item gnus-low-score-mark)))
2308
2309    :parameter-document
2310    "Marks considered spam.
2311 Such articles will be processed as spam on group exit.  When nil, the global
2312 spam-spam-marks variable takes precedence."
2313    :variable-default '((".*" ((gnus-spam-mark))))
2314    :variable-group spam
2315    :variable-document
2316    "*Groups in which to explicitly set the spam marks to some value."))
2317
2318 (defcustom gnus-group-uncollapsed-levels 1
2319   "Number of group name elements to leave alone when making a short group name."
2320   :group 'gnus-group-visual
2321   :type 'integer)
2322
2323 (defcustom gnus-group-use-permanent-levels nil
2324   "*If non-nil, once you set a level, Gnus will use this level."
2325   :group 'gnus-group-levels
2326   :type 'boolean)
2327
2328 ;; Hooks.
2329
2330 (defcustom gnus-load-hook nil
2331   "A hook run while Gnus is loaded."
2332   :group 'gnus-start
2333   :type 'hook)
2334
2335 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2336   "A hook called to apply kill files to a group.
2337 This hook is intended to apply a kill file to the selected newsgroup.
2338 The function `gnus-apply-kill-file' is called by default.
2339
2340 Since a general kill file is too heavy to use only for a few
2341 newsgroups, I recommend you to use a lighter hook function.  For
2342 example, if you'd like to apply a kill file to articles which contains
2343 a string `rmgroup' in subject in newsgroup `control', you can use the
2344 following hook:
2345
2346  (setq gnus-apply-kill-hook
2347       (list
2348         (lambda ()
2349           (cond ((string-match \"control\" gnus-newsgroup-name)
2350                  (gnus-kill \"Subject\" \"rmgroup\")
2351                  (gnus-expunge \"X\"))))))"
2352   :group 'gnus-score-kill
2353   :options '(gnus-apply-kill-file)
2354   :type 'hook)
2355
2356 (defcustom gnus-group-change-level-function nil
2357   "Function run when a group level is changed.
2358 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2359   :group 'gnus-group-levels
2360   :type '(choice (const nil)
2361                  function))
2362
2363 ;;; Face thingies.
2364
2365 (defcustom gnus-visual
2366   '(summary-highlight group-highlight article-highlight
2367                       mouse-face
2368                       summary-menu group-menu article-menu
2369                       tree-highlight menu highlight
2370                       browse-menu server-menu
2371                       page-marker tree-menu binary-menu pick-menu)
2372   "*Enable visual features.
2373 If `visual' is disabled, there will be no menus and few faces.  Most of
2374 the visual customization options below will be ignored.  Gnus will use
2375 less space and be faster as a result.
2376
2377 This variable can also be a list of visual elements to switch on.  For
2378 instance, to switch off all visual things except menus, you can say:
2379
2380    (setq gnus-visual '(menu))
2381
2382 Valid elements include `summary-highlight', `group-highlight',
2383 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2384 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2385 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2386   :group 'gnus-meta
2387   :group 'gnus-visual
2388   :type '(set (const summary-highlight)
2389               (const group-highlight)
2390               (const article-highlight)
2391               (const mouse-face)
2392               (const summary-menu)
2393               (const group-menu)
2394               (const article-menu)
2395               (const tree-highlight)
2396               (const menu)
2397               (const highlight)
2398               (const browse-menu)
2399               (const server-menu)
2400               (const page-marker)
2401               (const tree-menu)
2402               (const binary-menu)
2403               (const pick-menu)))
2404
2405 ;; Byte-compiler warning.
2406 (defvar gnus-visual)
2407 ;; Find out whether the gnus-visual TYPE is wanted.
2408 (defun gnus-visual-p (&optional type class)
2409   (and gnus-visual                      ; Has to be non-nil, at least.
2410        (if (not type)                   ; We don't care about type.
2411            gnus-visual
2412          (if (listp gnus-visual)        ; It's a list, so we check it.
2413              (or (memq type gnus-visual)
2414                  (memq class gnus-visual))
2415            t))))
2416
2417 (defcustom gnus-mouse-face
2418   (condition-case ()
2419       (if (gnus-visual-p 'mouse-face 'highlight)
2420           (if (boundp 'gnus-mouse-face)
2421               (or gnus-mouse-face 'highlight)
2422             'highlight)
2423         'default)
2424     (error 'highlight))
2425   "*Face used for group or summary buffer mouse highlighting.
2426 The line beneath the mouse pointer will be highlighted with this
2427 face."
2428   :group 'gnus-visual
2429   :type 'face)
2430
2431 (defcustom gnus-article-save-directory gnus-directory
2432   "*Name of the directory articles will be saved in (default \"~/News\")."
2433   :group 'gnus-article-saving
2434   :type 'directory)
2435
2436 (defvar gnus-plugged t
2437   "Whether Gnus is plugged or not.")
2438
2439 (defcustom gnus-agent-cache t
2440   "Controls use of the agent cache while plugged.
2441 When set, Gnus will prefer using the locally stored content rather
2442 than re-fetching it from the server.  You also need to enable
2443 `gnus-agent' for this to have any affect."
2444   :version "22.1"
2445   :group 'gnus-agent
2446   :type 'boolean)
2447
2448 (defcustom gnus-default-charset 'undecided
2449   "Default charset assumed to be used when viewing non-ASCII characters.
2450 This variable is overridden on a group-to-group basis by the
2451 `gnus-group-charset-alist' variable and is only used on groups not
2452 covered by that variable."
2453   :type 'symbol
2454   :group 'gnus-charset)
2455
2456 ;; Fixme: Doc reference to agent.
2457 (defcustom gnus-agent t
2458   "Whether we want to use the Gnus agent or not.
2459
2460 You may customize gnus-agent to disable its use.  However, some
2461 back ends have started to use the agent as a client-side cache.
2462 Disabling the agent may result in noticeable loss of performance."
2463   :version "22.1"
2464   :group 'gnus-agent
2465   :type 'boolean)
2466
2467 (defcustom gnus-other-frame-function 'gnus
2468   "Function called by the command `gnus-other-frame'."
2469   :group 'gnus-start
2470   :type '(choice (function-item gnus)
2471                  (function-item gnus-no-server)
2472                  (function-item gnus-slave)
2473                  (function-item gnus-slave-no-server)))
2474
2475 (defcustom gnus-other-frame-parameters nil
2476   "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2477 This should be an alist for Emacs, or a plist for XEmacs."
2478   :group 'gnus-start
2479   :type (if (featurep 'xemacs)
2480             '(repeat (list :inline t :format "%v"
2481                            (symbol :tag "Property")
2482                            (sexp :tag "Value")))
2483           '(repeat (cons :format "%v"
2484                          (symbol :tag "Parameter")
2485                          (sexp :tag "Value")))))
2486
2487 (defcustom gnus-user-agent '(emacs gnus type)
2488   "Which information should be exposed in the User-Agent header.
2489
2490 Can be a list of symbols or a string.  Valid symbols are `gnus'
2491 \(show Gnus version\) and `emacs' \(show Emacs version\).  In
2492 addition to the Emacs version, you can add `codename' \(show
2493 \(S\)XEmacs codename\) or either `config' \(show system
2494 configuration\) or `type' \(show system type\).  If you set it to
2495 a string, be sure to use a valid format, see RFC 2616."
2496
2497   :version "22.1"
2498   :group 'gnus-message
2499   :type '(choice (list (set :inline t
2500                             (const gnus  :tag "Gnus version")
2501                             (const emacs :tag "Emacs version")
2502                             (choice :tag "system"
2503                                     (const type   :tag "system type")
2504                                     (const config :tag "system configuration"))
2505                             (const codename :tag "Emacs codename")))
2506                  (string)))
2507
2508 ;; Convert old (< 2005-01-10) symbol type values:
2509 (when (symbolp gnus-user-agent)
2510   (setq gnus-user-agent
2511         (cond ((eq gnus-user-agent 'emacs-gnus-config)
2512                '(emacs gnus config))
2513               ((eq gnus-user-agent 'emacs-gnus-type)
2514                '(emacs gnus type))
2515               ((eq gnus-user-agent 'emacs-gnus)
2516                '(emacs gnus))
2517               ((eq gnus-user-agent 'gnus)
2518                '(gnus))
2519               (t gnus-user-agent)))
2520   (gnus-message 1 "Converted `gnus-user-agent' to `%s'." gnus-user-agent)
2521   (sit-for 1)
2522   (if (get 'gnus-user-agent 'saved-value)
2523       (customize-save-variable 'gnus-user-agent gnus-user-agent)
2524     (gnus-message 1 "Edit your init file to make this change permanent.")
2525     (sit-for 2)))
2526
2527 \f
2528 ;;; Internal variables
2529
2530 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2531 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2532 (defvar gnus-agent-method-p-cache nil
2533   ; Reset each time gnus-agent-covered-methods is changed else
2534   ; gnus-agent-method-p may mis-report a methods status.
2535   )
2536 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2537 (defvar gnus-draft-meta-information-header "X-Draft-From")
2538 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2539 (defvar gnus-original-article-buffer " *Original Article*")
2540 (defvar gnus-newsgroup-name nil)
2541 (defvar gnus-ephemeral-servers nil)
2542 (defvar gnus-server-method-cache nil)
2543 (defvar gnus-extended-servers nil)
2544
2545 ;; The carpal mode has been removed, but define the variable for
2546 ;; backwards compatability.
2547 (defvar gnus-carpal nil)
2548 (make-obsolete-variable 'gnus-carpal nil "Emacs 24.1")
2549
2550 (defvar gnus-agent-fetching nil
2551   "Whether Gnus agent is in fetching mode.")
2552
2553 (defvar gnus-agent-covered-methods nil
2554   "A list of servers, NOT methods, showing which servers are covered by the agent.")
2555
2556 (defvar gnus-command-method nil
2557   "Dynamically bound variable that says what the current back end is.")
2558
2559 (defvar gnus-current-select-method nil
2560   "The current method for selecting a newsgroup.")
2561
2562 (defvar gnus-tree-buffer "*Tree*"
2563   "Buffer where Gnus thread trees are displayed.")
2564
2565 ;; Variable holding the user answers to all method prompts.
2566 (defvar gnus-method-history nil)
2567
2568 ;; Variable holding the user answers to all mail method prompts.
2569 (defvar gnus-mail-method-history nil)
2570
2571 ;; Variable holding the user answers to all group prompts.
2572 (defvar gnus-group-history nil)
2573
2574 (defvar gnus-server-alist nil
2575   "List of available servers.")
2576
2577 (defcustom gnus-cache-directory
2578   (nnheader-concat gnus-directory "cache/")
2579   "*The directory where cached articles will be stored."
2580   :group 'gnus-cache
2581   :type 'directory)
2582
2583 (defvar gnus-predefined-server-alist
2584   `(("cache"
2585      nnspool "cache"
2586      (nnspool-spool-directory ,gnus-cache-directory)
2587      (nnspool-nov-directory ,gnus-cache-directory)
2588      (nnspool-active-file
2589       ,(nnheader-concat gnus-cache-directory "active"))))
2590   "List of predefined (convenience) servers.")
2591
2592 (defconst gnus-article-mark-lists
2593   '((marked . tick) (replied . reply)
2594     (expirable . expire) (killed . killed)
2595     (bookmarks . bookmark) (dormant . dormant)
2596     (scored . score) (saved . save)
2597     (cached . cache) (downloadable . download)
2598     (unsendable . unsend) (forwarded . forward)
2599     (recent . recent) (seen . seen)))
2600
2601 (defconst gnus-article-special-mark-lists
2602   '((seen range)
2603     (killed range)
2604     (bookmark tuple)
2605     (uid tuple)
2606     (active tuple)
2607     (score tuple)))
2608
2609 ;; Propagate flags to server, with the following exceptions:
2610 ;; `seen' is private to each gnus installation
2611 ;; `cache' is a internal gnus flag for each gnus installation
2612 ;; `download' is a agent flag private to each gnus installation
2613 ;; `unsend' are for nndraft groups only
2614 ;; `score' is not a proper mark
2615 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2616 (defconst gnus-article-unpropagated-mark-lists
2617   '(seen cache download unsend score bookmark)
2618   "Marks that shouldn't be propagated to back ends.
2619 Typical marks are those that make no sense in a standalone back end,
2620 such as a mark that says whether an article is stored in the cache
2621 \(which doesn't make sense in a standalone back end).")
2622
2623 (defvar gnus-headers-retrieved-by nil)
2624 (defvar gnus-article-reply nil)
2625 (defvar gnus-override-method nil)
2626 (defvar gnus-opened-servers nil)
2627
2628 (defvar gnus-current-kill-article nil)
2629
2630 (defvar gnus-have-read-active-file nil)
2631
2632 (defconst gnus-maintainer
2633   "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2634   "The mail address of the Gnus maintainers.")
2635
2636 (defvar gnus-info-nodes
2637   '((gnus-group-mode "(gnus)Group Buffer")
2638     (gnus-summary-mode "(gnus)Summary Buffer")
2639     (gnus-article-mode "(gnus)Article Buffer")
2640     (gnus-server-mode "(gnus)Server Buffer")
2641     (gnus-browse-mode "(gnus)Browse Foreign Server")
2642     (gnus-tree-mode "(gnus)Tree Display"))
2643   "Alist of major modes and related Info nodes.")
2644
2645 (defvar gnus-group-buffer "*Group*")
2646 (defvar gnus-summary-buffer "*Summary*")
2647 (defvar gnus-article-buffer "*Article*")
2648 (defvar gnus-server-buffer "*Server*")
2649
2650 (defvar gnus-slave nil
2651   "Whether this Gnus is a slave or not.")
2652
2653 (defvar gnus-batch-mode nil
2654   "Whether this Gnus is running in batch mode or not.")
2655
2656 (defvar gnus-variable-list
2657   '(gnus-newsrc-options gnus-newsrc-options-n
2658                         gnus-newsrc-last-checked-date
2659                         gnus-newsrc-alist gnus-server-alist
2660                         gnus-killed-list gnus-zombie-list
2661                         gnus-topic-topology gnus-topic-alist
2662                         gnus-format-specs)
2663   "Gnus variables saved in the quick startup file.")
2664
2665 (defvar gnus-newsrc-alist nil
2666   "Assoc list of read articles.
2667 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2668
2669 (defvar gnus-registry-alist nil
2670   "Assoc list of registry data.
2671 gnus-registry.el will populate this if it's loaded.")
2672
2673 (defvar gnus-newsrc-hashtb nil
2674   "Hashtable of `gnus-newsrc-alist'.")
2675
2676 (defvar gnus-killed-list nil
2677   "List of killed newsgroups.")
2678
2679 (defvar gnus-killed-hashtb nil
2680   "Hash table equivalent of `gnus-killed-list'.")
2681
2682 (defvar gnus-zombie-list nil
2683   "List of almost dead newsgroups.")
2684
2685 (defvar gnus-description-hashtb nil
2686   "Descriptions of newsgroups.")
2687
2688 (defvar gnus-list-of-killed-groups nil
2689   "List of newsgroups that have recently been killed by the user.")
2690
2691 (defvar gnus-active-hashtb nil
2692   "Hashtable of active articles.")
2693
2694 (defvar gnus-moderated-hashtb nil
2695   "Hashtable of moderated newsgroups.")
2696
2697 ;; Save window configuration.
2698 (defvar gnus-prev-winconf nil)
2699
2700 (defvar gnus-reffed-article-number nil)
2701
2702 (defvar gnus-dead-summary nil)
2703
2704 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2705   "Regexp matching invalid groups.")
2706
2707 (defvar gnus-other-frame-object nil
2708   "A frame object which will be created by `gnus-other-frame'.")
2709
2710 ;;; End of variables.
2711
2712 ;; Define some autoload functions Gnus might use.
2713 (eval-and-compile
2714
2715   ;; This little mapcar goes through the list below and marks the
2716   ;; symbols in question as autoloaded functions.
2717   (mapc
2718    (lambda (package)
2719      (let ((interactive (nth 1 (memq ':interactive package))))
2720        (mapcar
2721         (lambda (function)
2722           (let (keymap)
2723             (when (consp function)
2724               (setq keymap (car (memq 'keymap function)))
2725               (setq function (car function)))
2726             (unless (fboundp function)
2727               (autoload function (car package) nil interactive keymap))))
2728         (if (eq (nth 1 package) ':interactive)
2729             (nthcdr 3 package)
2730           (cdr package)))))
2731    '(("info" :interactive t Info-goto-node)
2732      ("pp" pp-to-string)
2733      ("qp" quoted-printable-decode-region quoted-printable-decode-string)
2734      ("ps-print" ps-print-preprint)
2735      ("message" :interactive t
2736       message-send-and-exit message-yank-original)
2737      ("babel" babel-as-string)
2738      ("nnmail" nnmail-split-fancy nnmail-article-group)
2739      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2740      ;; This is only used in message.el, which has an autoload.
2741      ("rmailout" rmail-output)
2742      ;; Next two used in gnus-util, which has autoloads, and contrib/sendmail.
2743      ("rmail" rmail-count-new-messages rmail-show-message
2744       ;; Next two only used in gnus-util.
2745       rmail-summary-exists rmail-select-summary)
2746      ;; Only used in gnus-util, which has an autoload.
2747      ("rmailsum" rmail-update-summary)
2748      ("gnus-xmas" gnus-xmas-splash)
2749      ("score-mode" :interactive t gnus-score-mode)
2750      ("gnus-mh" gnus-summary-save-article-folder
2751       gnus-Folder-save-name gnus-folder-save-name)
2752      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2753      ("gnus-demon" gnus-demon-add-scanmail
2754       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2755       gnus-demon-add-disconnection gnus-demon-add-handler
2756       gnus-demon-remove-handler)
2757      ("gnus-demon" :interactive t
2758       gnus-demon-init gnus-demon-cancel)
2759      ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2760       gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2761       gnus-face-from-file)
2762      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2763       gnus-tree-open gnus-tree-close)
2764      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2765       gnus-server-server-name)
2766      ("gnus-srvr" gnus-browse-foreign-server)
2767      ("gnus-cite" :interactive t
2768       gnus-article-highlight-citation gnus-article-hide-citation-maybe
2769       gnus-article-hide-citation gnus-article-fill-cited-article
2770       gnus-article-hide-citation-in-followups
2771       gnus-article-fill-cited-long-lines)
2772      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2773       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2774       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2775      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2776       gnus-cache-possibly-remove-articles gnus-cache-request-article
2777       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2778       gnus-cache-enter-remove-article gnus-cached-article-p
2779       gnus-cache-open gnus-cache-close gnus-cache-update-article
2780       gnus-cache-articles-in-group)
2781      ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2782       gnus-cache-remove-article gnus-summary-insert-cached-articles)
2783      ("gnus-score" :interactive t
2784       gnus-summary-increase-score gnus-summary-set-score
2785       gnus-summary-raise-thread gnus-summary-raise-same-subject
2786       gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2787       gnus-summary-lower-thread gnus-summary-lower-same-subject
2788       gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2789       gnus-summary-current-score gnus-score-delta-default
2790       gnus-score-flush-cache gnus-score-close
2791       gnus-possibly-score-headers gnus-score-followup-article
2792       gnus-score-followup-thread)
2793      ("gnus-score"
2794       (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2795       gnus-current-score-file-nondirectory gnus-score-adaptive
2796       gnus-score-find-trace gnus-score-file-name)
2797      ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2798      ("gnus-topic" :interactive t gnus-topic-mode)
2799      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2800       gnus-subscribe-topics)
2801      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2802      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2803      ("gnus-uu" :interactive t
2804       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2805       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2806       gnus-uu-mark-by-regexp gnus-uu-mark-all
2807       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2808       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2809       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2810       gnus-uu-decode-binhex gnus-uu-decode-uu-view
2811       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2812       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2813       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2814       gnus-uu-mark-over gnus-uu-post-news gnus-uu-invert-processable)
2815      ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
2816      ("gnus-msg" (gnus-summary-send-map keymap)
2817       gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2818      ("gnus-msg" :interactive t
2819       gnus-group-post-news gnus-group-mail gnus-group-news
2820       gnus-summary-post-news gnus-summary-news-other-window
2821       gnus-summary-followup gnus-summary-followup-with-original
2822       gnus-summary-cancel-article gnus-summary-supersede-article
2823       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2824       gnus-summary-mail-forward gnus-summary-mail-other-window
2825       gnus-summary-resend-message gnus-summary-resend-bounced-mail
2826       gnus-summary-wide-reply gnus-summary-followup-to-mail
2827       gnus-summary-followup-to-mail-with-original gnus-bug
2828       gnus-summary-wide-reply-with-original
2829       gnus-summary-post-forward gnus-summary-wide-reply-with-original
2830       gnus-summary-post-forward)
2831      ("gnus-picon" :interactive t gnus-treat-from-picon)
2832      ("smiley" :interactive t smiley-region)
2833      ("gnus-win" gnus-configure-windows gnus-add-configuration)
2834      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2835       gnus-list-of-unread-articles gnus-list-of-read-articles
2836       gnus-offer-save-summaries gnus-make-thread-indent-array
2837       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2838       gnus-summary-skip-intangible gnus-summary-article-number
2839       gnus-data-header gnus-data-find)
2840      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2841       gnus-group-list-groups gnus-group-first-unread-group
2842       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2843       gnus-group-setup-buffer gnus-group-get-new-news
2844       gnus-group-make-help-group gnus-group-update-group
2845       gnus-group-iterate gnus-group-group-name)
2846      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2847       gnus-backlog-remove-article)
2848      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2849       gnus-article-prepare gnus-article-set-window-start
2850       gnus-article-next-page gnus-article-prev-page
2851       gnus-request-article-this-buffer gnus-article-mode
2852       gnus-article-setup-buffer gnus-narrow-to-page
2853       gnus-article-delete-invisible-text gnus-treat-article)
2854      ("gnus-art" :interactive t
2855       gnus-article-hide-headers gnus-article-hide-boring-headers
2856       gnus-article-treat-overstrike
2857       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2858       gnus-article-display-x-face gnus-article-de-quoted-unreadable
2859       gnus-article-de-base64-unreadable
2860       gnus-article-decode-HZ
2861       gnus-article-wash-html
2862       gnus-article-unsplit-urls
2863       gnus-article-hide-pem gnus-article-hide-signature
2864       gnus-article-strip-leading-blank-lines gnus-article-date-local
2865       gnus-article-date-original gnus-article-date-lapsed
2866       ;;gnus-article-show-all-headers
2867       gnus-article-edit-mode gnus-article-edit-article
2868       gnus-article-edit-done gnus-article-decode-encoded-words
2869       gnus-start-date-timer gnus-stop-date-timer
2870       gnus-mime-view-all-parts)
2871      ("gnus-int" gnus-request-type)
2872      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2873       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch
2874       gnus-check-reasonable-setup)
2875      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2876       gnus-dup-enter-articles)
2877      ("gnus-range" gnus-copy-sequence)
2878      ("gnus-eform" gnus-edit-form)
2879      ("gnus-logic" gnus-score-advanced)
2880      ("gnus-undo" gnus-undo-mode gnus-undo-register)
2881      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2882       gnus-async-prefetch-article gnus-async-prefetch-remove-group
2883       gnus-async-halt-prefetch)
2884      ("gnus-agent" gnus-open-agent gnus-agent-get-function
2885       gnus-agent-save-active gnus-agent-method-p
2886       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2887       gnus-summary-set-agent-mark gnus-agent-save-group-info
2888       gnus-agent-request-article gnus-agent-retrieve-headers)
2889      ("gnus-agent" :interactive t
2890       gnus-unplugged gnus-agentize gnus-agent-batch)
2891      ("gnus-vm" :interactive t gnus-summary-save-in-vm
2892       gnus-summary-save-article-vm)
2893      ("compface" uncompface)
2894      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2895      ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2896      ("gnus-mlspl" :interactive t gnus-group-split-setup
2897       gnus-group-split-update)
2898      ("gnus-delay" gnus-delay-initialize))))
2899
2900 ;;; gnus-sum.el thingies
2901
2902
2903 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2904   "*The format specification of the lines in the summary buffer.
2905
2906 It works along the same lines as a normal formatting string,
2907 with some simple extensions.
2908
2909 %N   Article number, left padded with spaces (string)
2910 %S   Subject (string)
2911 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
2912 %n   Name of the poster (string)
2913 %a   Extracted name of the poster (string)
2914 %A   Extracted address of the poster (string)
2915 %F   Contents of the From: header (string)
2916 %f   Contents of the From: or To: headers (string)
2917 %x   Contents of the Xref: header (string)
2918 %D   Date of the article (string)
2919 %d   Date of the article (string) in DD-MMM format
2920 %o   Date of the article (string) in YYYYMMDD`T'HHMMSS format
2921 %M   Message-id of the article (string)
2922 %r   References of the article (string)
2923 %c   Number of characters in the article (integer)
2924 %k   Pretty-printed version of the above (string)
2925      For example, \"1.2k\" or \"0.4M\".
2926 %L   Number of lines in the article (integer)
2927 %I   Indentation based on thread level (a string of spaces)
2928 %B   A complex trn-style thread tree (string)
2929      The variables `gnus-sum-thread-*' can be used for customization.
2930 %T   A string with two possible values: 80 spaces if the article
2931      is on thread level two or larger and 0 spaces on level one
2932 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
2933 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2934 %[   Opening bracket (character, \"[\" or \"<\")
2935 %]   Closing bracket (character, \"]\" or \">\")
2936 %>   Spaces of length thread-level (string)
2937 %<   Spaces of length (- 20 thread-level) (string)
2938 %i   Article score (number)
2939 %z   Article zcore (character)
2940 %t   Number of articles under the current thread (number).
2941 %e   Whether the thread is empty or not (character).
2942 %V   Total thread score (number).
2943 %P   The line number (number).
2944 %O   Download mark (character).
2945 %*   If present, indicates desired cursor position
2946      (instead of after first colon).
2947 %u   User defined specifier.  The next character in the format string should
2948      be a letter.  Gnus will call the function gnus-user-format-function-X,
2949      where X is the letter following %u.  The function will be passed the
2950      current header as argument.  The function should return a string, which
2951      will be inserted into the summary just like information from any other
2952      summary specifier.
2953
2954 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2955 with care.  For reasons of efficiency, Gnus will compute what column
2956 these characters will end up in, and \"hard-code\" that.  This means that
2957 it is invalid to have these specs after a variable-length spec.  Well,
2958 you might not be arrested, but your summary buffer will look strange,
2959 which is bad enough.
2960
2961 The smart choice is to have these specs as far to the left as
2962 possible.
2963
2964 This restriction may disappear in later versions of Gnus.
2965
2966 General format specifiers can also be used.
2967 See Info node `(gnus)Formatting Variables'."
2968   :link '(custom-manual "(gnus)Formatting Variables")
2969   :type 'string
2970   :group 'gnus-summary-format)
2971
2972 ;;;
2973 ;;; Skeleton keymaps
2974 ;;;
2975
2976 (defun gnus-suppress-keymap (keymap)
2977   (suppress-keymap keymap)
2978   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2979     (while keys
2980       (define-key keymap (pop keys) 'undefined))))
2981
2982 (defvar gnus-article-mode-map
2983   (let ((keymap (make-sparse-keymap)))
2984     (gnus-suppress-keymap keymap)
2985     keymap))
2986 (defvar gnus-summary-mode-map
2987   (let ((keymap (make-keymap)))
2988     (gnus-suppress-keymap keymap)
2989     keymap))
2990 (defvar gnus-group-mode-map
2991   (let ((keymap (make-keymap)))
2992     (gnus-suppress-keymap keymap)
2993     keymap))
2994
2995 \f
2996
2997 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2998 ;; If you want the cursor to go somewhere else, set these two
2999 ;; functions in some startup hook to whatever you want.
3000 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
3001 (defalias 'gnus-group-position-point 'gnus-goto-colon)
3002
3003 ;;; Various macros and substs.
3004
3005 (defun gnus-header-from (header)
3006   (mail-header-from header))
3007
3008 (defmacro gnus-gethash (string hashtable)
3009   "Get hash value of STRING in HASHTABLE."
3010   `(symbol-value (intern-soft ,string ,hashtable)))
3011
3012 (defmacro gnus-gethash-safe (string hashtable)
3013   "Get hash value of STRING in HASHTABLE.
3014 Return nil if not defined."
3015   `(let ((sym (intern-soft ,string ,hashtable)))
3016      (and (boundp sym) (symbol-value sym))))
3017
3018 (defmacro gnus-sethash (string value hashtable)
3019   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
3020   `(set (intern ,string ,hashtable) ,value))
3021 (put 'gnus-sethash 'edebug-form-spec '(form form form))
3022
3023 (defmacro gnus-group-unread (group)
3024   "Get the currently computed number of unread articles in GROUP."
3025   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
3026
3027 (defmacro gnus-group-entry (group)
3028   "Get the newsrc entry for GROUP."
3029   `(gnus-gethash ,group gnus-newsrc-hashtb))
3030
3031 (defmacro gnus-active (group)
3032   "Get active info on GROUP."
3033   `(gnus-gethash ,group gnus-active-hashtb))
3034
3035 (defmacro gnus-set-active (group active)
3036   "Set GROUP's active info."
3037   `(gnus-sethash ,group ,active gnus-active-hashtb))
3038
3039 ;; Info access macros.
3040
3041 (defmacro gnus-info-group (info)
3042   `(nth 0 ,info))
3043 (defmacro gnus-info-rank (info)
3044   `(nth 1 ,info))
3045 (defmacro gnus-info-read (info)
3046   `(nth 2 ,info))
3047 (defmacro gnus-info-marks (info)
3048   `(nth 3 ,info))
3049 (defmacro gnus-info-method (info)
3050   `(nth 4 ,info))
3051 (defmacro gnus-info-params (info)
3052   `(nth 5 ,info))
3053
3054 (defmacro gnus-info-level (info)
3055   `(let ((rank (gnus-info-rank ,info)))
3056      (if (consp rank)
3057          (car rank)
3058        rank)))
3059 (defmacro gnus-info-score (info)
3060   `(let ((rank (gnus-info-rank ,info)))
3061      (or (and (consp rank) (cdr rank)) 0)))
3062
3063 (defmacro gnus-info-set-group (info group)
3064   `(setcar ,info ,group))
3065 (defmacro gnus-info-set-rank (info rank)
3066   `(setcar (nthcdr 1 ,info) ,rank))
3067 (defmacro gnus-info-set-read (info read)
3068   `(setcar (nthcdr 2 ,info) ,read))
3069 (defmacro gnus-info-set-marks (info marks &optional extend)
3070   (if extend
3071       `(gnus-info-set-entry ,info ,marks 3)
3072     `(setcar (nthcdr 3 ,info) ,marks)))
3073 (defmacro gnus-info-set-method (info method &optional extend)
3074   (if extend
3075       `(gnus-info-set-entry ,info ,method 4)
3076     `(setcar (nthcdr 4 ,info) ,method)))
3077 (defmacro gnus-info-set-params (info params &optional extend)
3078   (if extend
3079       `(gnus-info-set-entry ,info ,params 5)
3080     `(setcar (nthcdr 5 ,info) ,params)))
3081
3082 (defun gnus-info-set-entry (info entry number)
3083   ;; Extend the info until we have enough elements.
3084   (while (<= (length info) number)
3085     (nconc info (list nil)))
3086   ;; Set the entry.
3087   (setcar (nthcdr number info) entry))
3088
3089 (defmacro gnus-info-set-level (info level)
3090   `(let ((rank (cdr ,info)))
3091      (if (consp (car rank))
3092          (setcar (car rank) ,level)
3093        (setcar rank ,level))))
3094 (defmacro gnus-info-set-score (info score)
3095   `(let ((rank (cdr ,info)))
3096      (if (consp (car rank))
3097          (setcdr (car rank) ,score)
3098        (setcar rank (cons (car rank) ,score)))))
3099
3100 (defmacro gnus-get-info (group)
3101   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3102
3103 ;;; Load the compatibility functions.
3104
3105 (require 'gnus-ems)
3106
3107 \f
3108 ;;;
3109 ;;; Shutdown
3110 ;;;
3111
3112 (defvar gnus-shutdown-alist nil)
3113
3114 (defun gnus-add-shutdown (function &rest symbols)
3115   "Run FUNCTION whenever one of SYMBOLS is shut down."
3116   (push (cons function symbols) gnus-shutdown-alist))
3117
3118 (defun gnus-shutdown (symbol)
3119   "Shut down everything that waits for SYMBOL."
3120   (dolist (entry gnus-shutdown-alist)
3121     (when (memq symbol (cdr entry))
3122       (funcall (car entry)))))
3123
3124 \f
3125 ;;;
3126 ;;; Gnus Utility Functions
3127 ;;;
3128
3129 (defun gnus-find-subscribed-addresses ()
3130   "Return a regexp matching the addresses of all subscribed mail groups.
3131 It consists of the `to-address' or `to-list' parameter of all groups
3132 with a `subscribed' parameter."
3133   (let (group address addresses)
3134     (dolist (entry (cdr gnus-newsrc-alist))
3135       (setq group (car entry))
3136       (when (gnus-parameter-subscribed group)
3137         (setq address (mail-strip-quoted-names
3138                        (or (gnus-group-fast-parameter group 'to-address)
3139                            (gnus-group-fast-parameter group 'to-list))))
3140         (when address
3141           (add-to-list 'addresses address))))
3142     (when addresses
3143       (list (mapconcat 'regexp-quote addresses "\\|")))))
3144
3145 (defmacro gnus-string-or (&rest strings)
3146   "Return the first element of STRINGS that is a non-blank string.
3147 STRINGS will be evaluated in normal `or' order."
3148   `(gnus-string-or-1 (list ,@strings)))
3149
3150 (defun gnus-string-or-1 (strings)
3151   (let (string)
3152     (while strings
3153       (setq string (pop strings))
3154       (if (string-match "^[ \t]*$" string)
3155           (setq string nil)
3156         (setq strings nil)))
3157     string))
3158
3159 (defun gnus-version (&optional arg)
3160   "Version number of this version of Gnus.
3161 If ARG, insert string at point."
3162   (interactive "P")
3163   (if arg
3164       (insert (message gnus-version))
3165     (message gnus-version)))
3166
3167 (defun gnus-continuum-version (&optional version)
3168   "Return VERSION as a floating point number."
3169   (unless version
3170     (setq version gnus-version))
3171   (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
3172             (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
3173     (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3174           (number (match-string 2 version))
3175           major minor least)
3176       (unless (string-match
3177                "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
3178         (error "Invalid version string: %s" version))
3179       (setq major (string-to-number (match-string 1 number))
3180             minor (string-to-number (match-string 2 number))
3181             least (if (match-beginning 3)
3182                       (string-to-number (match-string 3 number))
3183                     0))
3184       (string-to-number
3185        (if (zerop major)
3186              (format "%s00%02d%02d"
3187                      (if (member alpha '("(ding)" "d"))
3188                          "4.99"
3189                        (+ 5 (* 0.02
3190                                (abs
3191                                 (- (mm-char-int (aref (downcase alpha) 0))
3192                                    (mm-char-int ?t))))
3193                           -0.01))
3194                      minor least)
3195          (format "%d.%02d%02d" major minor least))))))
3196
3197 (defun gnus-info-find-node (&optional nodename)
3198   "Find Info documentation of Gnus."
3199   (interactive)
3200   ;; Enlarge info window if needed.
3201   (let (gnus-info-buffer)
3202     (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3203     (setq gnus-info-buffer (current-buffer))
3204     (gnus-configure-windows 'info)))
3205
3206 ;;;
3207 ;;; gnus-interactive
3208 ;;;
3209
3210 (defvar gnus-current-prefix-symbol nil
3211   "Current prefix symbol.")
3212
3213 (defvar gnus-current-prefix-symbols nil
3214   "List of current prefix symbols.")
3215
3216 (defun gnus-interactive (string &optional params)
3217   "Return a list that can be fed to `interactive'.
3218 See `interactive' for full documentation.
3219
3220 Adds the following specs:
3221
3222 y -- The current symbolic prefix.
3223 Y -- A list of the current symbolic prefix(es).
3224 A -- Article number.
3225 H -- Article header.
3226 g -- Group name."
3227   (let ((i 0)
3228         out c prompt)
3229     (while (< i (length string))
3230       (string-match ".\\([^\n]*\\)\n?" string i)
3231       (setq c (aref string i))
3232       (when (match-end 1)
3233         (setq prompt (match-string 1 string)))
3234       (setq i (match-end 0))
3235       ;; We basically emulate just about everything that
3236       ;; `interactive' does, but add the specs listed above.
3237       (push
3238        (cond
3239         ((= c ?a)
3240          (completing-read prompt obarray 'fboundp t))
3241         ((= c ?b)
3242          (read-buffer prompt (current-buffer) t))
3243         ((= c ?B)
3244          (read-buffer prompt (other-buffer (current-buffer))))
3245         ((= c ?c)
3246          (read-char))
3247         ((= c ?C)
3248          (completing-read prompt obarray 'commandp t))
3249         ((= c ?d)
3250          (point))
3251         ((= c ?D)
3252          (read-file-name prompt nil default-directory 'lambda))
3253         ((= c ?f)
3254          (read-file-name prompt nil nil 'lambda))
3255         ((= c ?F)
3256          (read-file-name prompt))
3257         ((= c ?k)
3258          (read-key-sequence prompt))
3259         ((= c ?K)
3260          (error "Not implemented spec"))
3261         ((= c ?e)
3262          (error "Not implemented spec"))
3263         ((= c ?m)
3264          (mark))
3265         ((= c ?N)
3266          (error "Not implemented spec"))
3267         ((= c ?n)
3268          (string-to-number (read-from-minibuffer prompt)))
3269         ((= c ?p)
3270          (prefix-numeric-value current-prefix-arg))
3271         ((= c ?P)
3272          current-prefix-arg)
3273         ((= c ?r)
3274          'gnus-prefix-nil)
3275         ((= c ?s)
3276          (read-string prompt))
3277         ((= c ?S)
3278          (intern (read-string prompt)))
3279         ((= c ?v)
3280          (read-variable prompt))
3281         ((= c ?x)
3282          (read-minibuffer prompt))
3283         ((= c ?x)
3284          (eval-minibuffer prompt))
3285         ;; And here the new specs come.
3286         ((= c ?y)
3287          gnus-current-prefix-symbol)
3288         ((= c ?Y)
3289          gnus-current-prefix-symbols)
3290         ((= c ?g)
3291          (gnus-group-group-name))
3292         ((= c ?A)
3293          (gnus-summary-skip-intangible)
3294          (or (get-text-property (point) 'gnus-number)
3295              (gnus-summary-last-subject)))
3296         ((= c ?H)
3297          (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3298         (t
3299          (error "Non-implemented spec")))
3300        out)
3301       (cond
3302        ((= c ?r)
3303         (push (if (< (point) (mark)) (point) (mark)) out)
3304         (push (if (> (point) (mark)) (point) (mark)) out))))
3305     (setq out (delq 'gnus-prefix-nil out))
3306     (nreverse out)))
3307
3308 (defun gnus-symbolic-argument (&optional arg)
3309   "Read a symbolic argument and a command, and then execute command."
3310   (interactive "P")
3311   (let* ((in-command (this-command-keys))
3312          (command in-command)
3313          gnus-current-prefix-symbols
3314          gnus-current-prefix-symbol
3315          syms)
3316     (while (equal in-command command)
3317       (message "%s-" (key-description (this-command-keys)))
3318       (push (intern (char-to-string (read-char))) syms)
3319       (setq command (read-key-sequence nil t)))
3320     (setq gnus-current-prefix-symbols (nreverse syms)
3321           gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3322     (call-interactively (key-binding command t))))
3323
3324 ;;; More various functions.
3325
3326 (defsubst gnus-check-backend-function (func group)
3327   "Check whether GROUP supports function FUNC.
3328 GROUP can either be a string (a group name) or a select method."
3329   (ignore-errors
3330     (let ((method (if (stringp group)
3331                       (car (gnus-find-method-for-group group))
3332                     group)))
3333       (unless (featurep method)
3334         (require method))
3335       (fboundp (intern (format "%s-%s" method func))))))
3336
3337 (defun gnus-group-read-only-p (&optional group)
3338   "Check whether GROUP supports editing or not.
3339 If GROUP is nil, `gnus-newsgroup-name' will be checked instead.  Note
3340 that that variable is buffer-local to the summary buffers."
3341   (let ((group (or group gnus-newsgroup-name)))
3342     (not (gnus-check-backend-function 'request-replace-article group))))
3343
3344 (defun gnus-virtual-group-p (group)
3345   "Say whether GROUP is virtual or not."
3346   (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3347                         gnus-valid-select-methods)))
3348
3349 (defun gnus-news-group-p (group &optional article)
3350   "Return non-nil if GROUP (and ARTICLE) come from a news server."
3351   (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3352          t)                                 ;is news of course.
3353         ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3354          nil)                           ;must be mail then.
3355         ((vectorp article)              ;Has header info.
3356          (eq (gnus-request-type group (mail-header-id article)) 'news))
3357         ((null article)                        ;Hasn't header info
3358          (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3359         ((< article 0)                         ;Virtual message
3360          nil)                           ;we don't know, guess mail.
3361         (t                              ;Has positive number
3362          (eq (gnus-request-type group article) 'news)))) ;use it.
3363
3364 ;; Returns a list of writable groups.
3365 (defun gnus-writable-groups ()
3366   (let ((alist gnus-newsrc-alist)
3367         groups group)
3368     (while (setq group (car (pop alist)))
3369       (unless (gnus-group-read-only-p group)
3370         (push group groups)))
3371     (nreverse groups)))
3372
3373 ;; Check whether to use long file names.
3374 (defun gnus-use-long-file-name (symbol)
3375   ;; The variable has to be set...
3376   (and gnus-use-long-file-name
3377        ;; If it isn't a list, then we return t.
3378        (or (not (listp gnus-use-long-file-name))
3379            ;; If it is a list, and the list contains `symbol', we
3380            ;; return nil.
3381            (not (memq symbol gnus-use-long-file-name)))))
3382
3383 ;; Generate a unique new group name.
3384 (defun gnus-generate-new-group-name (leaf)
3385   (let ((name leaf)
3386         (num 0))
3387     (while (gnus-group-entry name)
3388       (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3389     name))
3390
3391 (defun gnus-ephemeral-group-p (group)
3392   "Say whether GROUP is ephemeral or not."
3393   (gnus-group-get-parameter group 'quit-config t))
3394
3395 (defun gnus-group-quit-config (group)
3396   "Return the quit-config of GROUP."
3397   (gnus-group-get-parameter group 'quit-config t))
3398
3399 (defun gnus-kill-ephemeral-group (group)
3400   "Remove ephemeral GROUP from relevant structures."
3401   (gnus-sethash group nil gnus-newsrc-hashtb))
3402
3403 (defun gnus-simplify-mode-line ()
3404   "Make mode lines a bit simpler."
3405   (setq mode-line-modified (cdr gnus-mode-line-modified))
3406   (when (listp mode-line-format)
3407     (make-local-variable 'mode-line-format)
3408     (setq mode-line-format (copy-sequence mode-line-format))
3409     (when (equal (nth 3 mode-line-format) "   ")
3410       (setcar (nthcdr 3 mode-line-format) " "))))
3411
3412 ;;; Servers and groups.
3413
3414 (defsubst gnus-server-add-address (method)
3415   (let ((method-name (symbol-name (car method))))
3416     (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3417              (not (assq (intern (concat method-name "-address")) method))
3418              (memq 'physical-address (assq (car method)
3419                                            gnus-valid-select-methods)))
3420         (append method (list (list (intern (concat method-name "-address"))
3421                                    (nth 1 method))))
3422       method)))
3423
3424 (defsubst gnus-method-to-server (method &optional nocache no-enter-cache)
3425   (catch 'server-name
3426     (setq method (or method gnus-select-method))
3427
3428     ;; Perhaps it is already in the cache.
3429     (unless nocache
3430       (mapc (lambda (name-method)
3431               (if (equal (cdr name-method) method)
3432                   (throw 'server-name (car name-method))))
3433             gnus-server-method-cache))
3434
3435     (mapc
3436      (lambda (server-alist)
3437        (mapc (lambda (name-method)
3438                (when (gnus-methods-equal-p (cdr name-method) method)
3439                  (unless (member name-method gnus-server-method-cache)
3440                    (push name-method gnus-server-method-cache))
3441                  (throw 'server-name (car name-method))))
3442              server-alist))
3443      (list gnus-server-alist
3444            gnus-predefined-server-alist))
3445
3446     (let* ((name (if (member (cadr method) '(nil ""))
3447                      (format "%s" (car method))
3448                    (format "%s:%s" (car method) (cadr method))))
3449            (name-method (cons name method)))
3450       (when (and (not (member name-method gnus-server-method-cache))
3451                  (not no-enter-cache)
3452                  (not (assoc (car name-method) gnus-server-method-cache)))
3453         (push name-method gnus-server-method-cache))
3454       name)))
3455
3456 (defsubst gnus-server-to-method (server)
3457   "Map virtual server names to select methods."
3458   (or (and server (listp server) server)
3459       (cdr (assoc server gnus-server-method-cache))
3460       (let ((result
3461              (or
3462               ;; Perhaps this is the native server?
3463               (and (equal server "native") gnus-select-method)
3464               ;; It should be in the server alist.
3465               (cdr (assoc server gnus-server-alist))
3466               ;; It could be in the predefined server alist.
3467               (cdr (assoc server gnus-predefined-server-alist))
3468               ;; If not, we look through all the opened server
3469               ;; to see whether we can find it there.
3470               (let ((opened gnus-opened-servers))
3471                 (while (and opened
3472                             (not (equal server (format "%s:%s" (caaar opened)
3473                                                        (cadaar opened)))))
3474                   (pop opened))
3475                 (caar opened))
3476               ;; It could be a named method, search all servers
3477               (let ((servers gnus-secondary-select-methods))
3478                 (while (and servers
3479                             (not (equal server (format "%s:%s" (caar servers)
3480                                                        (cadar servers)))))
3481                   (pop servers))
3482                 (car servers))
3483               ;; This could be some sort of foreign server that I
3484               ;; simply haven't opened (yet).  Do a brute-force scan
3485               ;; of the entire gnus-newsrc-alist for the server name
3486               ;; of every method.  As a side-effect, loads the
3487               ;; gnus-server-method-cache so this only happens once,
3488               ;; if at all.
3489               (let ((alist (cdr gnus-newsrc-alist))
3490                     method match)
3491                 (while alist
3492                   (setq method (gnus-info-method (pop alist)))
3493                   (when (and (not (stringp method))
3494                              (equal server
3495                                     (gnus-method-to-server method nil t)))
3496                     (setq match method
3497                           alist nil)))
3498                 match))))
3499         (when (and result
3500                    (not (assoc server gnus-server-method-cache)))
3501           (push (cons server result) gnus-server-method-cache))
3502         result)))
3503
3504 (defsubst gnus-server-get-method (group method)
3505   ;; Input either a server name, and extended server name, or a
3506   ;; select method, and return a select method.
3507   (cond ((stringp method)
3508          (gnus-server-to-method method))
3509         ((equal method gnus-select-method)
3510          gnus-select-method)
3511         ((and (stringp (car method))
3512               group)
3513          (gnus-server-extend-method group method))
3514         ((and method
3515               (not group)
3516               (equal (cadr method) ""))
3517          method)
3518         (t
3519          (gnus-server-add-address method))))
3520
3521 (defmacro gnus-method-equal (ss1 ss2)
3522   "Say whether two servers are equal."
3523   `(let ((s1 ,ss1)
3524          (s2 ,ss2))
3525      (or (equal s1 s2)
3526          (and (= (length s1) (length s2))
3527               (progn
3528                 (while (and s1 (member (car s1) s2))
3529                   (setq s1 (cdr s1)))
3530                 (null s1))))))
3531
3532 (defun gnus-methods-equal-p (m1 m2)
3533   (let ((m1 (or m1 gnus-select-method))
3534         (m2 (or m2 gnus-select-method)))
3535     (or (equal m1 m2)
3536         (and (eq (car m1) (car m2))
3537              (or (not (memq 'address (assoc (symbol-name (car m1))
3538                                             gnus-valid-select-methods)))
3539                  (equal (nth 1 m1) (nth 1 m2)))))))
3540
3541 (defsubst gnus-sloppily-equal-method-parameters (m1 m2)
3542   ;; Check parameters for sloppy equalness.
3543   (let ((p1 (copy-sequence (cddr m1)))
3544         (p2 (copy-sequence (cddr m2)))
3545         e1 e2)
3546     (block nil
3547       (while (setq e1 (pop p1))
3548         (unless (setq e2 (assq (car e1) p2))
3549           ;; The parameter doesn't exist in p2.
3550           (return nil))
3551         (setq p2 (delq e2 p2))
3552         (unless (equal e1 e2)
3553           (if (not (and (stringp (cadr e1))
3554                         (stringp (cadr e2))))
3555               (return nil)
3556             ;; Special-case string parameter comparison so that we
3557             ;; can uniquify them.
3558             (let ((s1 (cadr e1))
3559                   (s2 (cadr e2)))
3560               (when (string-match "/$" s1)
3561                 (setq s1 (directory-file-name s1)))
3562               (when (string-match "/$" s2)
3563                 (setq s2 (directory-file-name s2)))
3564               (unless (equal s1 s2)
3565                 (return nil))))))
3566       ;; If p2 now is empty, they were equal.
3567       (null p2))))
3568
3569 (defun gnus-methods-sloppily-equal (m1 m2)
3570   ;; Same method.
3571   (or
3572    (eq m1 m2)
3573    ;; Type and name are equal.
3574    (and
3575     (eq (car m1) (car m2))
3576     (equal (cadr m1) (cadr m2))
3577     (gnus-sloppily-equal-method-parameters m1 m2))))
3578
3579 (defun gnus-server-equal (m1 m2)
3580   "Say whether two methods are equal."
3581   (let ((m1 (cond ((null m1) gnus-select-method)
3582                   ((stringp m1) (gnus-server-to-method m1))
3583                   (t m1)))
3584         (m2 (cond ((null m2) gnus-select-method)
3585                   ((stringp m2) (gnus-server-to-method m2))
3586                   (t m2))))
3587     (gnus-method-equal m1 m2)))
3588
3589 (defun gnus-servers-using-backend (backend)
3590   "Return a list of known servers using BACKEND."
3591   (let ((opened gnus-opened-servers)
3592         out)
3593     (while opened
3594       (when (eq backend (caaar opened))
3595         (push (caar opened) out))
3596       (pop opened))
3597     out))
3598
3599 (defun gnus-archive-server-wanted-p ()
3600   "Say whether the user wants to use the archive server."
3601   (cond
3602    ((or (not gnus-message-archive-method)
3603         (not gnus-message-archive-group))
3604     nil)
3605    ((and gnus-message-archive-method gnus-message-archive-group)
3606     t)
3607    (t
3608     (let ((active (cadr (assq 'nnfolder-active-file
3609                               gnus-message-archive-method))))
3610       (and active
3611            (file-exists-p active))))))
3612
3613 (defsubst gnus-method-to-server-name (method)
3614   (concat
3615    (format "%s" (car method))
3616    (when (and
3617           (or (assoc (format "%s" (car method))
3618                      (gnus-methods-using 'address))
3619               (gnus-server-equal method gnus-message-archive-method))
3620           (nth 1 method)
3621           (not (string= (nth 1 method) "")))
3622      (concat "+" (nth 1 method)))))
3623
3624 (defsubst gnus-method-to-full-server-name (method)
3625   (format "%s+%s" (car method) (nth 1 method)))
3626
3627 (defun gnus-group-prefixed-name (group method &optional full)
3628   "Return the whole name from GROUP and METHOD.
3629 Call with full set to get the fully qualified group name (even if the
3630 server is native)."
3631   (when (stringp method)
3632     (setq method (gnus-server-to-method method)))
3633   (if (or (not method)
3634           (and (not full) (gnus-server-equal method "native"))
3635           ;;;!!! This might not be right.  We'll see...
3636           ;(string-match ":" group)
3637           )
3638       group
3639     (concat (gnus-method-to-server-name method) ":" group)))
3640
3641 (defun gnus-group-guess-prefixed-name (group)
3642   "Guess the whole name from GROUP and METHOD."
3643   (gnus-group-prefixed-name group (gnus-find-method-for-group
3644                                group)))
3645
3646 (defun gnus-group-full-name (group method)
3647   "Return the full name from GROUP and METHOD, even if the method is native."
3648   (gnus-group-prefixed-name group method t))
3649
3650 (defun gnus-group-guess-full-name (group)
3651   "Guess the full name from GROUP, even if the method is native."
3652   (if (gnus-group-prefixed-p group)
3653       group
3654     (gnus-group-full-name group (gnus-find-method-for-group group))))
3655
3656 (defun gnus-group-guess-full-name-from-command-method (group)
3657   "Guess the full name from GROUP, even if the method is native."
3658   (if (gnus-group-prefixed-p group)
3659       group
3660     (gnus-group-full-name group gnus-command-method)))
3661
3662 (defun gnus-group-real-prefix (group)
3663   "Return the prefix of the current group name."
3664   (if (stringp group)
3665       (if (string-match "^[^:]+:" group)
3666           (substring group 0 (match-end 0))
3667         "")
3668     nil))
3669
3670 (defun gnus-group-short-name (group)
3671   "Return the short group name."
3672   (let ((prefix (gnus-group-real-prefix group)))
3673     (if (< 0 (length prefix))
3674         (substring group (length prefix) nil)
3675       group)))
3676
3677 (defun gnus-group-prefixed-p (group)
3678   "Return the prefix of the current group name."
3679   (< 0 (length (gnus-group-real-prefix group))))
3680
3681 (declare-function gnus-group-decoded-name "gnus-group" (string))
3682
3683 (defun gnus-summary-buffer-name (group)
3684   "Return the summary buffer name of GROUP."
3685   (concat "*Summary " (gnus-group-decoded-name group) "*"))
3686
3687 (defun gnus-group-method (group)
3688   "Return the server or method used for selecting GROUP.
3689 You should probably use `gnus-find-method-for-group' instead."
3690   (let ((prefix (gnus-group-real-prefix group)))
3691     (if (equal prefix "")
3692         gnus-select-method
3693       (let ((servers gnus-opened-servers)
3694             (server "")
3695             backend possible found)
3696         (if (string-match "^[^\\+]+\\+" prefix)
3697             (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3698                   server (substring prefix (match-end 0) (1- (length prefix))))
3699           (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3700         (while servers
3701           (when (eq (caaar servers) backend)
3702             (setq possible (caar servers))
3703             (when (equal (cadaar servers) server)
3704               (setq found (caar servers))))
3705           (pop servers))
3706         (or (car (rassoc found gnus-server-alist))
3707             found
3708             (car (rassoc possible gnus-server-alist))
3709             possible
3710             (list backend server))))))
3711
3712 (defsubst gnus-native-method-p (method)
3713   "Return whether METHOD is the native select method."
3714   (gnus-method-equal method gnus-select-method))
3715
3716 (defsubst gnus-secondary-method-p (method)
3717   "Return whether METHOD is a secondary select method."
3718   (let ((methods gnus-secondary-select-methods)
3719         (gmethod (inline (gnus-server-get-method nil method))))
3720     (while (and methods
3721                 (not (gnus-method-equal
3722                       (inline (gnus-server-get-method nil (car methods)))
3723                       gmethod)))
3724       (setq methods (cdr methods)))
3725     methods))
3726
3727 (defun gnus-method-simplify (method)
3728   "Return the shortest uniquely identifying string or method for METHOD."
3729   (cond ((stringp method)
3730          method)
3731         ((gnus-native-method-p method)
3732          nil)
3733         ((gnus-secondary-method-p method)
3734          (format "%s:%s" (nth 0 method) (nth 1 method)))
3735         (t
3736          method)))
3737
3738 (defun gnus-groups-from-server (server)
3739   "Return a list of all groups that are fetched from SERVER."
3740   (let ((alist (cdr gnus-newsrc-alist))
3741         info groups)
3742     (while (setq info (pop alist))
3743       (when (gnus-server-equal (gnus-info-method info) server)
3744         (push (gnus-info-group info) groups)))
3745     (sort groups 'string<)))
3746
3747 (defun gnus-group-foreign-p (group)
3748   "Say whether a group is foreign or not."
3749   (and (not (gnus-group-native-p group))
3750        (not (gnus-group-secondary-p group))))
3751
3752 (defun gnus-group-native-p (group)
3753   "Say whether the group is native or not."
3754   (not (string-match ":" group)))
3755
3756 (defun gnus-group-secondary-p (group)
3757   "Say whether the group is secondary or not."
3758   (gnus-secondary-method-p (gnus-find-method-for-group group)))
3759
3760 (defun gnus-parameters-get-parameter (group)
3761   "Return the group parameters for GROUP from `gnus-parameters'."
3762   (let ((case-fold-search (if (eq gnus-parameters-case-fold-search 'default)
3763                               case-fold-search
3764                             gnus-parameters-case-fold-search))
3765         params-list)
3766     (dolist (elem gnus-parameters)
3767       (when (string-match (car elem) group)
3768         (setq params-list
3769               (nconc (gnus-expand-group-parameters
3770                       (car elem) (cdr elem) group)
3771                      params-list))))
3772     params-list))
3773
3774 (defun gnus-expand-group-parameter (match value group)
3775   "Use MATCH to expand VALUE in GROUP."
3776   (let ((start (string-match match group)))
3777     (if start
3778         (let ((matched-string (substring group start (match-end 0))))
3779           ;; Build match groups
3780           (string-match match matched-string)
3781           (replace-match value nil nil matched-string))
3782       group)))
3783
3784 (defun gnus-expand-group-parameters (match parameters group)
3785   "Go through PARAMETERS and expand them according to the match data."
3786   (let (new)
3787     (dolist (elem parameters)
3788       (if (and (stringp (cdr elem))
3789                (string-match "\\\\[0-9&]" (cdr elem)))
3790           (push (cons (car elem)
3791                       (gnus-expand-group-parameter match (cdr elem) group))
3792                 new)
3793         (push elem new)))
3794     new))
3795
3796 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3797   "For GROUP, return the value of SYMBOL.
3798
3799 You should call this in the `gnus-group-buffer' buffer.
3800 The function `gnus-group-find-parameter' will do that for you."
3801   ;; The speed trick:  No cons'ing and quit early.
3802   (let* ((params (funcall gnus-group-get-parameter-function group))
3803          ;; Start easy, check the "real" group parameters.
3804          (simple-results
3805           (gnus-group-parameter-value params symbol allow-list t)))
3806     (if simple-results
3807         ;; Found results; return them.
3808         (car simple-results)
3809       ;; We didn't find it there, try `gnus-parameters'.
3810       (let ((result nil)
3811             (head nil)
3812             (tail gnus-parameters))
3813         ;; A good old-fashioned non-cl loop.
3814         (while tail
3815           (setq head (car tail)
3816                 tail (cdr tail))
3817           ;; The car is regexp matching for matching the group name.
3818           (when (string-match (car head) group)
3819             ;; The cdr is the parameters.
3820             (setq result (gnus-group-parameter-value (cdr head)
3821                                                      symbol allow-list))
3822             (when result
3823               ;; Expand if necessary.
3824               (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3825                   (setq result (gnus-expand-group-parameter (car head)
3826                                                             result group))))))
3827         ;; Done.
3828         result))))
3829
3830 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3831   "Return the group parameters for GROUP.
3832 If SYMBOL, return the value of that symbol in the group parameters.
3833
3834 If you call this function inside a loop, consider using the faster
3835 `gnus-group-fast-parameter' instead."
3836   (with-current-buffer gnus-group-buffer
3837     (if symbol
3838         (gnus-group-fast-parameter group symbol allow-list)
3839       (nconc
3840        (copy-sequence
3841         (funcall gnus-group-get-parameter-function group))
3842        (gnus-parameters-get-parameter group)))))
3843
3844 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3845   "Return the group parameters for GROUP.
3846 If SYMBOL, return the value of that symbol in the group parameters.
3847 If ALLOW-LIST, also allow list as a result.
3848 Most functions should use `gnus-group-find-parameter', which
3849 also examines the topic parameters."
3850   (let ((params (gnus-info-params (gnus-get-info group))))
3851     (if symbol
3852         (gnus-group-parameter-value params symbol allow-list)
3853       params)))
3854
3855 (defun gnus-group-parameter-value (params symbol &optional
3856                                           allow-list present-p)
3857   "Return the value of SYMBOL in group PARAMS.
3858 If ALLOW-LIST, also allow list as a result."
3859   ;; We only wish to return group parameters (dotted lists) and
3860   ;; not local variables, which may have the same names.
3861   ;; But first we handle single elements...
3862   (or (car (memq symbol params))
3863       ;; Handle alist.
3864       (let (elem)
3865         (catch 'found
3866           (while (setq elem (pop params))
3867             (when (and (consp elem)
3868                        (eq (car elem) symbol)
3869                        (or allow-list
3870                            (atom (cdr elem))))
3871               (throw 'found (if present-p (list (cdr elem))
3872                               (cdr elem)))))))))
3873
3874 (defun gnus-group-add-parameter (group param)
3875   "Add parameter PARAM to GROUP."
3876   (let ((info (gnus-get-info group)))
3877     (when info
3878       (gnus-group-remove-parameter group (if (consp param) (car param) param))
3879       ;; Cons the new param to the old one and update.
3880       (gnus-group-set-info (cons param (gnus-info-params info))
3881                            group 'params))))
3882
3883 (defun gnus-group-set-parameter (group name value)
3884   "Set parameter NAME to VALUE in GROUP.
3885 GROUP can also be an INFO structure."
3886   (let ((info (if (listp group)
3887                   group
3888                 (gnus-get-info group))))
3889     (when info
3890       (gnus-group-remove-parameter group name)
3891       (let ((old-params (gnus-info-params info))
3892             (new-params (list (cons name value))))
3893         (while old-params
3894           (when (or (not (listp (car old-params)))
3895                     (not (eq (caar old-params) name)))
3896             (setq new-params (append new-params (list (car old-params)))))
3897           (setq old-params (cdr old-params)))
3898         (if (listp group)
3899             (gnus-info-set-params info new-params t)
3900           (gnus-group-set-info new-params (gnus-info-group info) 'params))))))
3901
3902 (defun gnus-group-remove-parameter (group name)
3903   "Remove parameter NAME from GROUP.
3904 GROUP can also be an INFO structure."
3905   (let ((info (if (listp group)
3906                   group
3907                 (gnus-get-info group))))
3908     (when info
3909       (let ((params (gnus-info-params info)))
3910         (when params
3911           (setq params (delq name params))
3912           (while (assq name params)
3913             (gnus-alist-pull name params))
3914           (gnus-info-set-params info params))))))
3915
3916 (defun gnus-group-add-score (group &optional score)
3917   "Add SCORE to the GROUP score.
3918 If SCORE is nil, add 1 to the score of GROUP."
3919   (let ((info (gnus-get-info group)))
3920     (when info
3921       (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3922
3923 (defun gnus-short-group-name (group &optional levels)
3924   "Collapse GROUP name LEVELS.
3925 Select methods are stripped and any remote host name is stripped down to
3926 just the host name."
3927   (let* ((name "")
3928          (foreign "")
3929          (depth 0)
3930          (skip 1)
3931          (levels (or levels
3932                      gnus-group-uncollapsed-levels
3933                      (progn
3934                        (while (string-match "\\." group skip)
3935                          (setq skip (match-end 0)
3936                                depth (+ depth 1)))
3937                        depth))))
3938     ;; Separate foreign select method from group name and collapse.
3939    ;; If method contains a server, collapse to non-domain server name,
3940     ;; otherwise collapse to select method.
3941     (let* ((colon (string-match ":" group))
3942            (server (and colon (substring group 0 colon)))
3943            (plus (and server (string-match "+" server))))
3944       (when server
3945         (if plus
3946             (setq foreign (substring server (+ 1 plus)
3947                                      (string-match "\\." server))
3948                   group (substring group (+ 1 colon)))
3949           (setq foreign server
3950                 group (substring group (+ 1 colon))))
3951         (setq foreign (concat foreign ":")))
3952       ;; Collapse group name leaving LEVELS uncollapsed elements
3953       (let* ((slist (split-string group "/"))
3954              (slen (length slist))
3955              (dlist (split-string group "\\."))
3956              (dlen (length dlist))
3957              glist
3958              glen
3959              gsep
3960              res)
3961         (if (> slen dlen)
3962             (setq glist slist
3963                   glen slen
3964                   gsep "/")
3965           (setq glist dlist
3966                 glen dlen
3967                 gsep "."))
3968         (setq levels (- glen levels))
3969         (dolist (g glist)
3970           (push (if (>= (decf levels) 0)
3971                     (if (zerop (length g))
3972                         ""
3973                       (substring g 0 1))
3974                   g)
3975                 res))
3976         (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3977
3978 (defun gnus-narrow-to-body ()
3979   "Narrow to the body of an article."
3980   (narrow-to-region
3981    (progn
3982      (goto-char (point-min))
3983      (or (search-forward "\n\n" nil t)
3984          (point-max)))
3985    (point-max)))
3986
3987 \f
3988 ;;;
3989 ;;; Kill file handling.
3990 ;;;
3991
3992 (defun gnus-apply-kill-file ()
3993   "Apply a kill file to the current newsgroup.
3994 Returns the number of articles marked as read."
3995   (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3996           (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3997       (gnus-apply-kill-file-internal)
3998     0))
3999
4000 (defun gnus-kill-save-kill-buffer ()
4001   (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
4002     (when (get-file-buffer file)
4003       (with-current-buffer (get-file-buffer file)
4004         (when (buffer-modified-p)
4005           (save-buffer))
4006         (kill-buffer (current-buffer))))))
4007
4008 (defcustom gnus-kill-file-name "KILL"
4009   "Suffix of the kill files."
4010   :group 'gnus-score-kill
4011   :group 'gnus-score-files
4012   :type 'string)
4013
4014 (defun gnus-newsgroup-kill-file (newsgroup)
4015   "Return the name of a kill file name for NEWSGROUP.
4016 If NEWSGROUP is nil, return the global kill file name instead."
4017   (cond
4018    ;; The global KILL file is placed at top of the directory.
4019    ((or (null newsgroup)
4020         (string-equal newsgroup ""))
4021     (expand-file-name gnus-kill-file-name
4022                       gnus-kill-files-directory))
4023    ;; Append ".KILL" to newsgroup name.
4024    ((gnus-use-long-file-name 'not-kill)
4025     (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
4026                               "." gnus-kill-file-name)
4027                       gnus-kill-files-directory))
4028    ;; Place "KILL" under the hierarchical directory.
4029    (t
4030     (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
4031                               "/" gnus-kill-file-name)
4032                       gnus-kill-files-directory))))
4033
4034 ;;; Server things.
4035
4036 (defun gnus-member-of-valid (symbol group)
4037   "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
4038   (memq symbol (assoc
4039                 (symbol-name (car (gnus-find-method-for-group group)))
4040                 gnus-valid-select-methods)))
4041
4042 (defun gnus-method-option-p (method option)
4043   "Return non-nil if select METHOD has OPTION as a parameter."
4044   (when (stringp method)
4045     (setq method (gnus-server-to-method method)))
4046   (memq option (assoc (format "%s" (car method))
4047                       gnus-valid-select-methods)))
4048
4049 (defun gnus-similar-server-opened (method)
4050   "Return non-nil if we have a similar server opened.
4051 This is defined as a server with the same name, but different
4052 parameters."
4053   (let ((opened gnus-opened-servers)
4054         open)
4055     (while (and method opened)
4056       (setq open (car (pop opened)))
4057       ;; Type and name are the same...
4058       (when (and (equal (car method) (car open))
4059                  (equal (cadr method) (cadr open))
4060                  ;; ... but the rest of the parameters differ.
4061                  (not (gnus-methods-sloppily-equal method open)))
4062         (setq method nil)))
4063     (not method)))
4064
4065 (defun gnus-server-extend-method (group method)
4066   ;; This function "extends" a virtual server.  If the server is
4067   ;; "hello", and the select method is ("hello" (my-var "something"))
4068   ;; in the group "alt.alt", this will result in a new virtual server
4069   ;; called "hello+alt.alt".
4070   (if (or (not (inline (gnus-similar-server-opened method)))
4071           (not (cddr method)))
4072       method
4073     (setq method
4074           `(,(car method) ,(concat (cadr method) "+" group)
4075             (,(intern (format "%s-address" (car method))) ,(cadr method))
4076             ,@(cddr method)))
4077     (push method gnus-extended-servers)
4078     method))
4079
4080 (defun gnus-server-status (method)
4081   "Return the status of METHOD."
4082   (nth 1 (assoc method gnus-opened-servers)))
4083
4084 (defun gnus-group-name-to-method (group)
4085   "Guess a select method based on GROUP."
4086   (if (string-match ":" group)
4087       (let ((server (substring group 0 (match-beginning 0))))
4088         (if (string-match "\\+" server)
4089             (list (intern (substring server 0 (match-beginning 0)))
4090                   (substring server (match-end 0)))
4091           (list (intern server) "")))
4092     gnus-select-method))
4093
4094 (defun gnus-server-string (server)
4095   "Return a readable string that describes SERVER."
4096   (let* ((server (gnus-server-to-method server))
4097          (address (nth 1 server)))
4098     (if (and address
4099              (not (zerop (length address))))
4100         (format "%s using %s" address (car server))
4101       (format "%s" (car server)))))
4102
4103 (defun gnus-same-method-different-name (method)
4104   (let ((slot (intern (concat (symbol-name (car method)) "-address"))))
4105     (unless (assq slot (cddr method))
4106       (setq method
4107             (append method (list (list slot (nth 1 method)))))))
4108   (let ((methods gnus-extended-servers)
4109         open found)
4110     (while (and (not found)
4111                 (setq open (pop methods)))
4112       (when (and (eq (car method) (car open))
4113                  (gnus-sloppily-equal-method-parameters method open))
4114         (setq found open)))
4115     found))
4116
4117 (defun gnus-find-method-for-group (group &optional info)
4118   "Find the select method that GROUP uses."
4119   (or gnus-override-method
4120       (and (not group)
4121            gnus-select-method)
4122       (and (not (gnus-group-entry group))
4123            ;; Killed or otherwise unknown group.
4124            (or
4125             ;; If we know a virtual server by that name, return its method.
4126             (gnus-server-to-method (gnus-group-server group))
4127             ;; Guess a new method as last resort.
4128             (gnus-group-name-to-method group)))
4129       (let ((info (or info (gnus-get-info group)))
4130             method)
4131         (if (or (not info)
4132                 (not (setq method (gnus-info-method info)))
4133                 (equal method "native"))
4134             gnus-select-method
4135           (setq method
4136                 (cond ((stringp method)
4137                        (inline (gnus-server-to-method method)))
4138                       ((stringp (cadr method))
4139                        (or
4140                         (inline
4141                          (gnus-same-method-different-name method))
4142                         (inline (gnus-server-extend-method group method))))
4143                       (t
4144                        method)))
4145           (cond ((equal (cadr method) "")
4146                  method)
4147                 ((null (cadr method))
4148                  (list (car method) ""))
4149                 (t
4150                  (gnus-server-add-address method)))))))
4151
4152 (defun gnus-methods-using (feature)
4153   "Find all methods that have FEATURE."
4154   (let ((valids gnus-valid-select-methods)
4155         outs)
4156     (while valids
4157       (when (memq feature (car valids))
4158         (push (car valids) outs))
4159       (setq valids (cdr valids)))
4160     outs))
4161
4162 (eval-and-compile
4163   (autoload 'message-y-or-n-p "message" nil nil 'macro))
4164
4165 (defun gnus-read-group (prompt &optional default)
4166   "Prompt the user for a group name.
4167 Disallow invalid group names."
4168   (let ((prefix "")
4169         group)
4170     (while (not group)
4171       (when (string-match
4172              gnus-invalid-group-regexp
4173              (setq group (read-string (concat prefix prompt)
4174                                       (cons (or default "") 0)
4175                                       'gnus-group-history)))
4176         (let ((match (match-string 0 group)))
4177           ;; Might be okay (e.g. for nnimap), so ask the user:
4178           (unless (and (not (string-match "^$\\|:" match))
4179                        (message-y-or-n-p
4180                         "Proceed and create group anyway? " t
4181 "The group name \"" group "\" contains a forbidden character: \"" match "\".
4182
4183 Usually, it's dangerous to create a group with this name, because it's not
4184 supported by all back ends and servers.  On IMAP servers it should work,
4185 though.  If you are really sure, you can proceed anyway and create the group.
4186
4187 You may customize the variable `gnus-invalid-group-regexp', which currently is
4188 set to \"" gnus-invalid-group-regexp
4189 "\", if you want to get rid of this query permanently."))
4190             (setq prefix (format "Invalid group name: \"%s\".  " group)
4191                   group nil)))))
4192     group))
4193
4194 (defun gnus-read-method (prompt)
4195   "Prompt the user for a method.
4196 Allow completion over sensible values."
4197   (let* ((open-servers
4198           (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4199                   gnus-opened-servers))
4200          (valid-methods
4201           (let (methods)
4202             (dolist (method gnus-valid-select-methods)
4203               (if (or (memq 'prompt-address method)
4204                       (not (assoc (format "%s:" (car method)) open-servers)))
4205                   (push method methods)))
4206             methods))
4207          (servers
4208           (append valid-methods
4209                   open-servers
4210                   gnus-predefined-server-alist
4211                   gnus-server-alist))
4212          (method
4213           (gnus-completing-read
4214            prompt (mapcar 'car servers)
4215            t nil 'gnus-method-history)))
4216     (cond
4217      ((equal method "")
4218       (setq method gnus-select-method))
4219      ((assoc method gnus-valid-select-methods)
4220       (let ((address (if (memq 'prompt-address
4221                                (assoc method gnus-valid-select-methods))
4222                          (read-string "Address: ")
4223                        "")))
4224         (or (cadr (assoc (format "%s:%s" method address) open-servers))
4225             (list (intern method) address))))
4226      ((assoc method servers)
4227       method)
4228      (t
4229       (list (intern method) "")))))
4230
4231 ;;; Agent functions
4232
4233 (defun gnus-agent-method-p (method-or-server)
4234   "Say whether METHOD is covered by the agent."
4235   (or (eq (car gnus-agent-method-p-cache) method-or-server)
4236       (let* ((method (if (stringp method-or-server)
4237                          (gnus-server-to-method method-or-server)
4238                        method-or-server))
4239              (server (gnus-method-to-server method t)))
4240         (setq gnus-agent-method-p-cache
4241               (cons method-or-server
4242                     (member server gnus-agent-covered-methods)))))
4243   (cdr gnus-agent-method-p-cache))
4244
4245 (defun gnus-online (method)
4246   (not
4247    (if gnus-plugged
4248        (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4249      (gnus-agent-method-p method))))
4250
4251 ;;; User-level commands.
4252
4253 ;;;###autoload
4254 (defun gnus-slave-no-server (&optional arg)
4255   "Read network news as a slave, without connecting to the local server."
4256   (interactive "P")
4257   (gnus-no-server arg t))
4258
4259 ;;;###autoload
4260 (defun gnus-no-server (&optional arg slave)
4261   "Read network news.
4262 If ARG is a positive number, Gnus will use that as the startup
4263 level. If ARG is nil, Gnus will be started at level 2.  If ARG is
4264 non-nil and not a positive number, Gnus will prompt the user for the
4265 name of an NNTP server to use.
4266 As opposed to `gnus', this command will not connect to the local
4267 server."
4268   (interactive "P")
4269   (gnus-no-server-1 arg slave))
4270
4271 ;;;###autoload
4272 (defun gnus-slave (&optional arg)
4273   "Read news as a slave."
4274   (interactive "P")
4275   (gnus arg nil 'slave))
4276
4277 ;;;###autoload
4278 (defun gnus-other-frame (&optional arg display)
4279   "Pop up a frame to read news.
4280 This will call one of the Gnus commands which is specified by the user
4281 option `gnus-other-frame-function' (default `gnus') with the argument
4282 ARG if Gnus is not running, otherwise just pop up a Gnus frame.  The
4283 optional second argument DISPLAY should be a standard display string
4284 such as \"unix:0\" to specify where to pop up a frame.  If DISPLAY is
4285 omitted or the function `make-frame-on-display' is not available, the
4286 current display is used."
4287   (interactive "P")
4288   (if (fboundp 'make-frame-on-display)
4289       (unless display
4290         (setq display (gnus-frame-or-window-display-name (selected-frame))))
4291     (setq display nil))
4292   (let ((alive (gnus-alive-p)))
4293     (unless (and alive
4294                  (catch 'found
4295                    (walk-windows
4296                     (lambda (window)
4297                       (when (and (or (not display)
4298                                      (equal display
4299                                             (gnus-frame-or-window-display-name
4300                                              window)))
4301                                  (with-current-buffer (window-buffer window)
4302                                    (string-match "\\`gnus-"
4303                                                  (symbol-name major-mode))))
4304                         (gnus-select-frame-set-input-focus
4305                          (setq gnus-other-frame-object (window-frame window)))
4306                         (select-window window)
4307                         (throw 'found t)))
4308                     'ignore t)))
4309       (gnus-select-frame-set-input-focus
4310        (setq gnus-other-frame-object
4311              (if display
4312                  (make-frame-on-display display gnus-other-frame-parameters)
4313                (make-frame gnus-other-frame-parameters))))
4314       (if alive
4315           (switch-to-buffer gnus-group-buffer)
4316         (funcall gnus-other-frame-function arg)
4317         (add-hook 'gnus-exit-gnus-hook
4318                   '(lambda nil
4319                      (when (and (frame-live-p gnus-other-frame-object)
4320                                 (cdr (frame-list)))
4321                        (delete-frame gnus-other-frame-object))
4322                      (setq gnus-other-frame-object nil)))))))
4323
4324 ;;;###autoload
4325 (defun gnus (&optional arg dont-connect slave)
4326   "Read network news.
4327 If ARG is non-nil and a positive number, Gnus will use that as the
4328 startup level.  If ARG is non-nil and not a positive number, Gnus will
4329 prompt the user for the name of an NNTP server to use."
4330   (interactive "P")
4331   ;; When using the development version of Gnus, load the gnus-load
4332   ;; file.
4333   (unless (string-match "^Gnus" gnus-version)
4334     (load "gnus-load" nil t))
4335   (unless (byte-code-function-p (symbol-function 'gnus))
4336     (message "You should byte-compile Gnus")
4337     (sit-for 2))
4338   (let ((gnus-action-message-log (list nil)))
4339     (gnus-1 arg dont-connect slave)
4340     (gnus-final-warning)))
4341
4342 ;; Allow redefinition of Gnus functions.
4343
4344 (gnus-ems-redefine)
4345
4346 (provide 'gnus)
4347
4348 ;;; gnus.el ends here