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