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

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