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