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

   1 ;;; gnus.el --- a newsreader for GNU Emacs
   2 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996,
   3 ;;        1997, 1998, 2000 Free Software Foundation, Inc.
   4
   5 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
   6 ;;      Lars Magne Ingebrigtsen <larsi@gnus.org>
   7 ;; Keywords: news, mail
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 2, or (at your option)
  14 ;; any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25
  26 ;;; Commentary:
  27
  28 ;;; Code:
  29
  30 (eval '(run-hooks 'gnus-load-hook))
  31
  32 (eval-when-compile (require 'cl))
  33 (require 'mm-util)
  34
  35 (require 'message)
  36
  37 (defgroup gnus nil
  38   "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
  39   :group 'news
  40   :group 'mail)
  41
  42 (defgroup gnus-charset nil
  43   "Group character set issues."
  44   :link '(custom-manual "(gnus)Charsets")
  45   :group 'gnus)
  46
  47 (defgroup gnus-cache nil
  48   "Cache interface."
  49   :group 'gnus)
  50
  51 (defgroup gnus-start nil
  52   "Starting your favorite newsreader."
  53   :group 'gnus)
  54
  55 (defgroup gnus-start-server nil
  56   "Server options at startup."
  57   :group 'gnus-start)
  58
  59 ;; These belong to gnus-group.el.
  60 (defgroup gnus-group nil
  61   "Group buffers."
  62   :link '(custom-manual "(gnus)The Group Buffer")
  63   :group 'gnus)
  64
  65 (defgroup gnus-group-foreign nil
  66   "Foreign groups."
  67   :link '(custom-manual "(gnus)Foreign Groups")
  68   :group 'gnus-group)
  69
  70 (defgroup gnus-group-new nil
  71   "Automatic subscription of new groups."
  72   :group 'gnus-group)
  73
  74 (defgroup gnus-group-levels nil
  75   "Group levels."
  76   :link '(custom-manual "(gnus)Group Levels")
  77   :group 'gnus-group)
  78
  79 (defgroup gnus-group-select nil
  80   "Selecting a Group."
  81   :link '(custom-manual "(gnus)Selecting a Group")
  82   :group 'gnus-group)
  83
  84 (defgroup gnus-group-listing nil
  85   "Showing slices of the group list."
  86   :link '(custom-manual "(gnus)Listing Groups")
  87   :group 'gnus-group)
  88
  89 (defgroup gnus-group-visual nil
  90   "Sorting the group buffer."
  91   :link '(custom-manual "(gnus)Group Buffer Format")
  92   :group 'gnus-group
  93   :group 'gnus-visual)
  94
  95 (defgroup gnus-group-various nil
  96   "Various group options."
  97   :link '(custom-manual "(gnus)Scanning New Messages")
  98   :group 'gnus-group)
  99
 100 ;; These belong to gnus-sum.el.
 101 (defgroup gnus-summary nil
 102   "Summary buffers."
 103   :link '(custom-manual "(gnus)The Summary Buffer")
 104   :group 'gnus)
 105
 106 (defgroup gnus-summary-exit nil
 107   "Leaving summary buffers."
 108   :link '(custom-manual "(gnus)Exiting the Summary Buffer")
 109   :group 'gnus-summary)
 110
 111 (defgroup gnus-summary-marks nil
 112   "Marks used in summary buffers."
 113   :link '(custom-manual "(gnus)Marking Articles")
 114   :group 'gnus-summary)
 115
 116 (defgroup gnus-thread nil
 117   "Ordering articles according to replies."
 118   :link '(custom-manual "(gnus)Threading")
 119   :group 'gnus-summary)
 120
 121 (defgroup gnus-summary-format nil
 122   "Formatting of the summary buffer."
 123   :link '(custom-manual "(gnus)Summary Buffer Format")
 124   :group 'gnus-summary)
 125
 126 (defgroup gnus-summary-choose nil
 127   "Choosing Articles."
 128   :link '(custom-manual "(gnus)Choosing Articles")
 129   :group 'gnus-summary)
 130
 131 (defgroup gnus-summary-maneuvering nil
 132   "Summary movement commands."
 133   :link '(custom-manual "(gnus)Summary Maneuvering")
 134   :group 'gnus-summary)
 135
 136 (defgroup gnus-summary-mail nil
 137   "Mail group commands."
 138   :link '(custom-manual "(gnus)Mail Group Commands")
 139   :group 'gnus-summary)
 140
 141 (defgroup gnus-summary-sort nil
 142   "Sorting the summary buffer."
 143   :link '(custom-manual "(gnus)Sorting")
 144   :group 'gnus-summary)
 145
 146 (defgroup gnus-summary-visual nil
 147   "Highlighting and menus in the summary buffer."
 148   :link '(custom-manual "(gnus)Summary Highlighting")
 149   :group 'gnus-visual
 150   :group 'gnus-summary)
 151
 152 (defgroup gnus-summary-various nil
 153   "Various summary buffer options."
 154   :link '(custom-manual "(gnus)Various Summary Stuff")
 155   :group 'gnus-summary)
 156
 157 (defgroup gnus-summary-pick nil
 158   "Pick mode in the summary buffer."
 159   :link '(custom-manual "(gnus)Pick and Read")
 160   :prefix "gnus-pick-"
 161   :group 'gnus-summary)
 162
 163 (defgroup gnus-summary-tree nil
 164   "Tree display of threads in the summary buffer."
 165   :link '(custom-manual "(gnus)Tree Display")
 166   :prefix "gnus-tree-"
 167   :group 'gnus-summary)
 168
 169 ;; Belongs to gnus-uu.el
 170 (defgroup gnus-extract-view nil
 171   "Viewing extracted files."
 172   :link '(custom-manual "(gnus)Viewing Files")
 173   :group 'gnus-extract)
 174
 175 ;; Belongs to gnus-score.el
 176 (defgroup gnus-score nil
 177   "Score and kill file handling."
 178   :group 'gnus)
 179
 180 (defgroup gnus-score-kill nil
 181   "Kill files."
 182   :group 'gnus-score)
 183
 184 (defgroup gnus-score-adapt nil
 185   "Adaptive score files."
 186   :group 'gnus-score)
 187
 188 (defgroup gnus-score-default nil
 189   "Default values for score files."
 190   :group 'gnus-score)
 191
 192 (defgroup gnus-score-expire nil
 193   "Expiring score rules."
 194   :group 'gnus-score)
 195
 196 (defgroup gnus-score-decay nil
 197   "Decaying score rules."
 198   :group 'gnus-score)
 199
 200 (defgroup gnus-score-files nil
 201   "Score and kill file names."
 202   :group 'gnus-score
 203   :group 'gnus-files)
 204
 205 (defgroup gnus-score-various nil
 206   "Various scoring and killing options."
 207   :group 'gnus-score)
 208
 209 ;; Other
 210 (defgroup gnus-visual nil
 211   "Options controling the visual fluff."
 212   :group 'gnus
 213   :group 'faces)
 214
 215 (defgroup gnus-agent nil
 216   "Offline support for Gnus."
 217   :group 'gnus)
 218
 219 (defgroup gnus-files nil
 220   "Files used by Gnus."
 221   :group 'gnus)
 222
 223 (defgroup gnus-dribble-file nil
 224   "Auto save file."
 225   :link '(custom-manual "(gnus)Auto Save")
 226   :group 'gnus-files)
 227
 228 (defgroup gnus-newsrc nil
 229   "Storing Gnus state."
 230   :group 'gnus-files)
 231
 232 (defgroup gnus-server nil
 233   "Options related to newsservers and other servers used by Gnus."
 234   :group 'gnus)
 235
 236 (defgroup gnus-message '((message custom-group))
 237   "Composing replies and followups in Gnus."
 238   :group 'gnus)
 239
 240 (defgroup gnus-meta nil
 241   "Meta variables controling major portions of Gnus.
 242 In general, modifying these variables does not take affect until Gnus
 243 is restarted, and sometimes reloaded."
 244   :group 'gnus)
 245
 246 (defgroup gnus-various nil
 247   "Other Gnus options."
 248   :link '(custom-manual "(gnus)Various Various")
 249   :group 'gnus)
 250
 251 (defgroup gnus-mime nil
 252   "Variables for controlling the Gnus MIME interface."
 253   :group 'gnus)
 254
 255 (defgroup gnus-exit nil
 256   "Exiting gnus."
 257   :link '(custom-manual "(gnus)Exiting Gnus")
 258   :group 'gnus)
 259
 260 (defconst gnus-version-number "5.8.8"
 261   "Version number for this version of Gnus.")
 262
 263 (defconst gnus-version (format "Gnus v%s" gnus-version-number)
 264   "Version string for this version of Gnus.")
 265
 266 (defcustom gnus-inhibit-startup-message nil
 267   "If non-nil, the startup message will not be displayed.
 268 This variable is used before `.gnus.el' is loaded, so it should
 269 be set in `.emacs' instead."
 270   :group 'gnus-start
 271   :type 'boolean)
 272
 273 (defcustom gnus-play-startup-jingle nil
 274   "If non-nil, play the Gnus jingle at startup."
 275   :group 'gnus-start
 276   :type 'boolean)
 277
 278 (unless (featurep 'gnus-xmas)
 279   (defalias 'gnus-make-overlay 'make-overlay)
 280   (defalias 'gnus-delete-overlay 'delete-overlay)
 281   (defalias 'gnus-overlay-put 'overlay-put)
 282   (defalias 'gnus-move-overlay 'move-overlay)
 283   (defalias 'gnus-overlay-end 'overlay-end)
 284   (defalias 'gnus-extent-detached-p 'ignore)
 285   (defalias 'gnus-extent-start-open 'ignore)
 286   (defalias 'gnus-set-text-properties 'set-text-properties)
 287   (defalias 'gnus-group-remove-excess-properties 'ignore)
 288   (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
 289   (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
 290   (defalias 'gnus-character-to-event 'identity)
 291   (defalias 'gnus-add-text-properties 'add-text-properties)
 292   (defalias 'gnus-put-text-property 'put-text-property)
 293   (defvar gnus-mode-line-image-cache t)
 294   (if (fboundp 'find-image)
 295       (defun gnus-mode-line-buffer-identification (line)
 296         (let ((str (car-safe line)))
 297           (if (and (stringp str)
 298                    (string-match "^Gnus:" str))
 299               (progn (add-text-properties
 300                       0 5
 301                       (list 'display
 302                             (if (eq t gnus-mode-line-image-cache)
 303                                 (setq gnus-mode-line-image-cache
 304                                       (find-image
 305                                        '((:type xpm :file "gnus-pointer.xpm"
 306                                                 :ascent 100)
 307                                          (:type xbm :file "gnus-pointer.xbm"
 308                                                 :ascent 100))))
 309                               gnus-mode-line-image-cache)
 310                             'help-echo "This is Gnus")
 311                       str)
 312                      (list str))
 313             line)))
 314     (defalias 'gnus-mode-line-buffer-identification 'identity))
 315   (defalias 'gnus-characterp 'numberp)
 316   (defalias 'gnus-deactivate-mark 'deactivate-mark)
 317   (defalias 'gnus-window-edges 'window-edges)
 318   (defalias 'gnus-key-press-event-p 'numberp)
 319   (defalias 'gnus-decode-rfc1522 'ignore))
 320
 321 ;; We define these group faces here to avoid the display
 322 ;; update forced when creating new faces.
 323
 324 (defface gnus-group-news-1-face
 325   '((((class color)
 326       (background dark))
 327      (:foreground "PaleTurquoise" :bold t))
 328     (((class color)
 329       (background light))
 330      (:foreground "ForestGreen" :bold t))
 331     (t
 332      ()))
 333   "Level 1 newsgroup face.")
 334
 335 (defface gnus-group-news-1-empty-face
 336   '((((class color)
 337       (background dark))
 338      (:foreground "PaleTurquoise"))
 339     (((class color)
 340       (background light))
 341      (:foreground "ForestGreen"))
 342     (t
 343      ()))
 344   "Level 1 empty newsgroup face.")
 345
 346 (defface gnus-group-news-2-face
 347   '((((class color)
 348       (background dark))
 349      (:foreground "turquoise" :bold t))
 350     (((class color)
 351       (background light))
 352      (:foreground "CadetBlue4" :bold t))
 353     (t
 354      ()))
 355   "Level 2 newsgroup face.")
 356
 357 (defface gnus-group-news-2-empty-face
 358   '((((class color)
 359       (background dark))
 360      (:foreground "turquoise"))
 361     (((class color)
 362       (background light))
 363      (:foreground "CadetBlue4"))
 364     (t
 365      ()))
 366   "Level 2 empty newsgroup face.")
 367
 368 (defface gnus-group-news-3-face
 369   '((((class color)
 370       (background dark))
 371      (:bold t))
 372     (((class color)
 373       (background light))
 374      (:bold t))
 375     (t
 376      ()))
 377   "Level 3 newsgroup face.")
 378
 379 (defface gnus-group-news-3-empty-face
 380   '((((class color)
 381       (background dark))
 382      ())
 383     (((class color)
 384       (background light))
 385      ())
 386     (t
 387      ()))
 388   "Level 3 empty newsgroup face.")
 389
 390 (defface gnus-group-news-4-face
 391   '((((class color)
 392       (background dark))
 393      (:bold t))
 394     (((class color)
 395       (background light))
 396      (:bold t))
 397     (t
 398      ()))
 399   "Level 4 newsgroup face.")
 400
 401 (defface gnus-group-news-4-empty-face
 402   '((((class color)
 403       (background dark))
 404      ())
 405     (((class color)
 406       (background light))
 407      ())
 408     (t
 409      ()))
 410   "Level 4 empty newsgroup face.")
 411
 412 (defface gnus-group-news-5-face
 413   '((((class color)
 414       (background dark))
 415      (:bold t))
 416     (((class color)
 417       (background light))
 418      (:bold t))
 419     (t
 420      ()))
 421   "Level 5 newsgroup face.")
 422
 423 (defface gnus-group-news-5-empty-face
 424   '((((class color)
 425       (background dark))
 426      ())
 427     (((class color)
 428       (background light))
 429      ())
 430     (t
 431      ()))
 432   "Level 5 empty newsgroup face.")
 433
 434 (defface gnus-group-news-6-face
 435   '((((class color)
 436       (background dark))
 437      (:bold t))
 438     (((class color)
 439       (background light))
 440      (:bold t))
 441     (t
 442      ()))
 443   "Level 6 newsgroup face.")
 444
 445 (defface gnus-group-news-6-empty-face
 446   '((((class color)
 447       (background dark))
 448      ())
 449     (((class color)
 450       (background light))
 451      ())
 452     (t
 453      ()))
 454   "Level 6 empty newsgroup face.")
 455
 456 (defface gnus-group-news-low-face
 457   '((((class color)
 458       (background dark))
 459      (:foreground "DarkTurquoise" :bold t))
 460     (((class color)
 461       (background light))
 462      (:foreground "DarkGreen" :bold t))
 463     (t
 464      ()))
 465   "Low level newsgroup face.")
 466
 467 (defface gnus-group-news-low-empty-face
 468   '((((class color)
 469       (background dark))
 470      (:foreground "DarkTurquoise"))
 471     (((class color)
 472       (background light))
 473      (:foreground "DarkGreen"))
 474     (t
 475      ()))
 476   "Low level empty newsgroup face.")
 477
 478 (defface gnus-group-mail-1-face
 479   '((((class color)
 480       (background dark))
 481      (:foreground "aquamarine1" :bold t))
 482     (((class color)
 483       (background light))
 484      (:foreground "DeepPink3" :bold t))
 485     (t
 486      (:bold t)))
 487   "Level 1 mailgroup face.")
 488
 489 (defface gnus-group-mail-1-empty-face
 490   '((((class color)
 491       (background dark))
 492      (:foreground "aquamarine1"))
 493     (((class color)
 494       (background light))
 495      (:foreground "DeepPink3"))
 496     (t
 497      (:italic t :bold t)))
 498   "Level 1 empty mailgroup face.")
 499
 500 (defface gnus-group-mail-2-face
 501   '((((class color)
 502       (background dark))
 503      (:foreground "aquamarine2" :bold t))
 504     (((class color)
 505       (background light))
 506      (:foreground "HotPink3" :bold t))
 507     (t
 508      (:bold t)))
 509   "Level 2 mailgroup face.")
 510
 511 (defface gnus-group-mail-2-empty-face
 512   '((((class color)
 513       (background dark))
 514      (:foreground "aquamarine2"))
 515     (((class color)
 516       (background light))
 517      (:foreground "HotPink3"))
 518     (t
 519      (:bold t)))
 520   "Level 2 empty mailgroup face.")
 521
 522 (defface gnus-group-mail-3-face
 523   '((((class color)
 524       (background dark))
 525      (:foreground "aquamarine3" :bold t))
 526     (((class color)
 527       (background light))
 528      (:foreground "magenta4" :bold t))
 529     (t
 530      (:bold t)))
 531   "Level 3 mailgroup face.")
 532
 533 (defface gnus-group-mail-3-empty-face
 534   '((((class color)
 535       (background dark))
 536      (:foreground "aquamarine3"))
 537     (((class color)
 538       (background light))
 539      (:foreground "magenta4"))
 540     (t
 541      ()))
 542   "Level 3 empty mailgroup face.")
 543
 544 (defface gnus-group-mail-low-face
 545   '((((class color)
 546       (background dark))
 547      (:foreground "aquamarine4" :bold t))
 548     (((class color)
 549       (background light))
 550      (:foreground "DeepPink4" :bold t))
 551     (t
 552      (:bold t)))
 553   "Low level mailgroup face.")
 554
 555 (defface gnus-group-mail-low-empty-face
 556   '((((class color)
 557       (background dark))
 558      (:foreground "aquamarine4"))
 559     (((class color)
 560       (background light))
 561      (:foreground "DeepPink4"))
 562     (t
 563      (:bold t)))
 564   "Low level empty mailgroup face.")
 565
 566 ;; Summary mode faces.
 567
 568 (defface gnus-summary-selected-face '((t
 569                                        (:underline t)))
 570   "Face used for selected articles.")
 571
 572 (defface gnus-summary-cancelled-face
 573   '((((class color))
 574      (:foreground "yellow" :background "black")))
 575   "Face used for cancelled articles.")
 576
 577 (defface gnus-summary-high-ticked-face
 578   '((((class color)
 579       (background dark))
 580      (:foreground "pink" :bold t))
 581     (((class color)
 582       (background light))
 583      (:foreground "firebrick" :bold t))
 584     (t
 585      (:bold t)))
 586   "Face used for high interest ticked articles.")
 587
 588 (defface gnus-summary-low-ticked-face
 589   '((((class color)
 590       (background dark))
 591      (:foreground "pink" :italic t))
 592     (((class color)
 593       (background light))
 594      (:foreground "firebrick" :italic t))
 595     (t
 596      (:italic t)))
 597   "Face used for low interest ticked articles.")
 598
 599 (defface gnus-summary-normal-ticked-face
 600   '((((class color)
 601       (background dark))
 602      (:foreground "pink"))
 603     (((class color)
 604       (background light))
 605      (:foreground "firebrick"))
 606     (t
 607      ()))
 608   "Face used for normal interest ticked articles.")
 609
 610 (defface gnus-summary-high-ancient-face
 611   '((((class color)
 612       (background dark))
 613      (:foreground "SkyBlue" :bold t))
 614     (((class color)
 615       (background light))
 616      (:foreground "RoyalBlue" :bold t))
 617     (t
 618      (:bold t)))
 619   "Face used for high interest ancient articles.")
 620
 621 (defface gnus-summary-low-ancient-face
 622   '((((class color)
 623       (background dark))
 624      (:foreground "SkyBlue" :italic t))
 625     (((class color)
 626       (background light))
 627      (:foreground "RoyalBlue" :italic t))
 628     (t
 629      (:italic t)))
 630   "Face used for low interest ancient articles.")
 631
 632 (defface gnus-summary-normal-ancient-face
 633   '((((class color)
 634       (background dark))
 635      (:foreground "SkyBlue"))
 636     (((class color)
 637       (background light))
 638      (:foreground "RoyalBlue"))
 639     (t
 640      ()))
 641   "Face used for normal interest ancient articles.")
 642
 643 (defface gnus-summary-high-unread-face
 644   '((t
 645      (:bold t)))
 646   "Face used for high interest unread articles.")
 647
 648 (defface gnus-summary-low-unread-face
 649   '((t
 650      (:italic t)))
 651   "Face used for low interest unread articles.")
 652
 653 (defface gnus-summary-normal-unread-face
 654   '((t
 655      ()))
 656   "Face used for normal interest unread articles.")
 657
 658 (defface gnus-summary-high-read-face
 659   '((((class color)
 660       (background dark))
 661      (:foreground "PaleGreen"
 662                   :bold t))
 663     (((class color)
 664       (background light))
 665      (:foreground "DarkGreen"
 666                   :bold t))
 667     (t
 668      (:bold t)))
 669   "Face used for high interest read articles.")
 670
 671 (defface gnus-summary-low-read-face
 672   '((((class color)
 673       (background dark))
 674      (:foreground "PaleGreen"
 675                   :italic t))
 676     (((class color)
 677       (background light))
 678      (:foreground "DarkGreen"
 679                   :italic t))
 680     (t
 681      (:italic t)))
 682   "Face used for low interest read articles.")
 683
 684 (defface gnus-summary-normal-read-face
 685   '((((class color)
 686       (background dark))
 687      (:foreground "PaleGreen"))
 688     (((class color)
 689       (background light))
 690      (:foreground "DarkGreen"))
 691     (t
 692      ()))
 693   "Face used for normal interest read articles.")
 694
 695
 696 ;;;
 697 ;;; Gnus buffers
 698 ;;;
 699
 700 (defvar gnus-buffers nil)
 701
 702 (defun gnus-get-buffer-create (name)
 703   "Do the same as `get-buffer-create', but store the created buffer."
 704   (or (get-buffer name)
 705       (car (push (get-buffer-create name) gnus-buffers))))
 706
 707 (defun gnus-add-buffer ()
 708   "Add the current buffer to the list of Gnus buffers."
 709   (push (current-buffer) gnus-buffers))
 710
 711 (defun gnus-buffers ()
 712   "Return a list of live Gnus buffers."
 713   (while (and gnus-buffers
 714               (not (buffer-name (car gnus-buffers))))
 715     (pop gnus-buffers))
 716   (let ((buffers gnus-buffers))
 717     (while (cdr buffers)
 718       (if (buffer-name (cadr buffers))
 719           (pop buffers)
 720         (setcdr buffers (cddr buffers)))))
 721   gnus-buffers)
 722
 723 ;;; Splash screen.
 724
 725 (defvar gnus-group-buffer "*Group*")
 726
 727 (eval-and-compile
 728   (autoload 'gnus-play-jingle "gnus-audio"))
 729
 730 (defface gnus-splash-face
 731   '((((class color)
 732       (background dark))
 733      (:foreground "Brown"))
 734     (((class color)
 735       (background light))
 736      (:foreground "Brown"))
 737     (t
 738      ()))
 739   "Face of the splash screen.")
 740
 741 (defun gnus-splash ()
 742   (save-excursion
 743     (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
 744     (let ((buffer-read-only nil))
 745       (erase-buffer)
 746       (unless gnus-inhibit-startup-message
 747         (gnus-group-startup-message)
 748         (sit-for 0)
 749         (when gnus-play-startup-jingle
 750           (gnus-play-jingle))))))
 751
 752 (defun gnus-indent-rigidly (start end arg)
 753   "Indent rigidly using only spaces and no tabs."
 754   (save-excursion
 755     (save-restriction
 756       (narrow-to-region start end)
 757       (let ((tab-width 8))
 758         (indent-rigidly start end arg)
 759         ;; We translate tabs into spaces -- not everybody uses
 760         ;; an 8-character tab.
 761         (goto-char (point-min))
 762         (while (search-forward "\t" nil t)
 763           (replace-match "        " t t))))))
 764
 765 (defvar gnus-simple-splash nil)
 766
 767 (defun gnus-group-startup-message (&optional x y)
 768   "Insert startup message in current buffer."
 769   ;; Insert the message.
 770   (erase-buffer)
 771   (cond
 772    ((and
 773      (fboundp 'find-image)
 774      (display-graphic-p)
 775      (let ((image (find-image
 776                    `((:type xpm :file "gnus.xpm")
 777                      (:type xbm :file "gnus.xbm"
 778                             ;; Account for the xbm's blackground.
 779                             :background ,(face-foreground 'gnus-splash-face)
 780                             :foreground ,(face-background 'default))))))
 781        (when image
 782          (let ((size (image-size image)))
 783            (insert-char ?\n (max 0 (round (- (window-height)
 784                                              (or y (cdr size)) 1) 2)))
 785            (insert-char ?\  (max 0 (round (- (window-width)
 786                                              (or x (car size))) 2)))
 787            (insert-image image))
 788          (setq gnus-simple-splash nil)
 789          t))))
 790    (t
 791     (insert
 792      (format "              %s
 793           _    ___ _             _
 794           _ ___ __ ___  __    _ ___
 795           __   _     ___    __  ___
 796               _           ___     _
 797              _  _ __             _
 798              ___   __            _
 799                    __           _
 800                     _      _   _
 801                    _      _    _
 802                       _  _    _
 803                   __  ___
 804                  _   _ _     _
 805                 _   _
 806               _    _
 807              _    _
 808             _
 809           __
 810
 811 "
 812              ""))
 813     ;; And then hack it.
 814     (gnus-indent-rigidly (point-min) (point-max)
 815                          (/ (max (- (window-width) (or x 46)) 0) 2))
 816     (goto-char (point-min))
 817     (forward-line 1)
 818     (let* ((pheight (count-lines (point-min) (point-max)))
 819            (wheight (window-height))
 820            (rest (- wheight pheight)))
 821       (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
 822     ;; Fontify some.
 823     (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
 824     (setq gnus-simple-splash t)))
 825   (goto-char (point-min))
 826   (setq mode-line-buffer-identification (concat " " gnus-version))
 827   (set-buffer-modified-p t))
 828
 829 (eval-when (load)
 830   (let ((command (format "%s" this-command)))
 831     (if (and (string-match "gnus" command)
 832              (not (string-match "gnus-other-frame" command)))
 833         (gnus-splash)
 834       (gnus-get-buffer-create gnus-group-buffer))))
 835
 836 ;;; Do the rest.
 837
 838 (require 'custom)
 839 (require 'gnus-util)
 840 (require 'nnheader)
 841
 842 (defcustom gnus-home-directory "~/"
 843   "Directory variable that specifies the \"home\" directory.
 844 All other Gnus path variables are initialized from this variable."
 845   :group 'gnus-files
 846   :type 'directory)
 847
 848 (defcustom gnus-directory (or (getenv "SAVEDIR")
 849                               (nnheader-concat gnus-home-directory "News/"))
 850   "*Directory variable from which all other Gnus file variables are derived.
 851
 852 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
 853 This means that other directory variables that are initialized from
 854 this variable won't be set properly if you set this variable in `.gnus.el'.
 855 Set this variable in `.emacs' instead."
 856   :group 'gnus-files
 857   :type 'directory)
 858
 859 (defcustom gnus-default-directory nil
 860   "*Default directory for all Gnus buffers."
 861   :group 'gnus-files
 862   :type '(choice (const :tag "current" nil)
 863                  directory))
 864
 865 ;; Site dependent variables.  These variables should be defined in
 866 ;; paths.el.
 867
 868 (defvar gnus-default-nntp-server nil
 869   "Specify a default NNTP server.
 870 This variable should be defined in paths.el, and should never be set
 871 by the user.
 872 If you want to change servers, you should use `gnus-select-method'.
 873 See the documentation to that variable.")
 874
 875 ;; Don't touch this variable.
 876 (defvar gnus-nntp-service "nntp"
 877   "NNTP service name (\"nntp\" or 119).
 878 This is an obsolete variable, which is scarcely used.  If you use an
 879 nntp server for your newsgroup and want to change the port number
 880 used to 899, you would say something along these lines:
 881
 882  (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
 883
 884 (defcustom gnus-nntpserver-file "/etc/nntpserver"
 885   "A file with only the name of the nntp server in it."
 886   :group 'gnus-files
 887   :group 'gnus-server
 888   :type 'file)
 889
 890 ;; This function is used to check both the environment variable
 891 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
 892 ;; an nntp server name default.
 893 (defun gnus-getenv-nntpserver ()
 894   (or (getenv "NNTPSERVER")
 895       (and (file-readable-p gnus-nntpserver-file)
 896            (save-excursion
 897              (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
 898              (insert-file-contents gnus-nntpserver-file)
 899              (let ((name (buffer-string)))
 900                (prog1
 901                    (if (string-match "\\'[ \t\n]*$" name)
 902                        nil
 903                      name)
 904                  (kill-buffer (current-buffer))))))))
 905
 906 (defcustom gnus-select-method
 907   (condition-case nil
 908       (nconc
 909        (list 'nntp (or (condition-case nil
 910                            (gnus-getenv-nntpserver)
 911                          (error nil))
 912                        (when (and gnus-default-nntp-server
 913                                   (not (string= gnus-default-nntp-server "")))
 914                          gnus-default-nntp-server)
 915                        "news"))
 916        (if (or (null gnus-nntp-service)
 917                (equal gnus-nntp-service "nntp"))
 918            nil
 919          (list gnus-nntp-service)))
 920     (error nil))
 921   "Default method for selecting a newsgroup.
 922 This variable should be a list, where the first element is how the
 923 news is to be fetched, the second is the address.
 924
 925 For instance, if you want to get your news via NNTP from
 926 \"flab.flab.edu\", you could say:
 927
 928 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
 929
 930 If you want to use your local spool, say:
 931
 932 \(setq gnus-select-method (list 'nnspool (system-name)))
 933
 934 If you use this variable, you must set `gnus-nntp-server' to nil.
 935
 936 There is a lot more to know about select methods and virtual servers -
 937 see the manual for details."
 938   :group 'gnus-server
 939   :type 'gnus-select-method)
 940
 941 (defcustom gnus-message-archive-method
 942   `(nnfolder
 943     "archive"
 944     (nnfolder-directory ,(nnheader-concat message-directory "archive"))
 945     (nnfolder-active-file
 946      ,(nnheader-concat message-directory "archive/active"))
 947     (nnfolder-get-new-mail nil)
 948     (nnfolder-inhibit-expiry t))
 949   "*Method used for archiving messages you've sent.
 950 This should be a mail method.
 951
 952 It's probably not very effective to change this variable once you've
 953 run Gnus once.  After doing that, you must edit this server from the
 954 server buffer."
 955   :group 'gnus-server
 956   :group 'gnus-message
 957   :type 'gnus-select-method)
 958
 959 (defcustom gnus-message-archive-group nil
 960   "*Name of the group in which to save the messages you've written.
 961 This can either be a string; a list of strings; or an alist
 962 of regexps/functions/forms to be evaluated to return a string (or a list
 963 of strings).  The functions are called with the name of the current
 964 group (or nil) as a parameter.
 965
 966 If you want to save your mail in one group and the news articles you
 967 write in another group, you could say something like:
 968
 969  \(setq gnus-message-archive-group
 970         '((if (message-news-p)
 971               \"misc-news\"
 972             \"misc-mail\")))
 973
 974 Normally the group names returned by this variable should be
 975 unprefixed -- which implicitly means \"store on the archive server\".
 976 However, you may wish to store the message on some other server.  In
 977 that case, just return a fully prefixed name of the group --
 978 \"nnml+private:mail.misc\", for instance."
 979   :group 'gnus-message
 980   :type '(choice (const :tag "none" nil)
 981                  function
 982                  sexp
 983                  string))
 984
 985 (defcustom gnus-secondary-servers nil
 986   "List of NNTP servers that the user can choose between interactively.
 987 To make Gnus query you for a server, you have to give `gnus' a
 988 non-numeric prefix - `C-u M-x gnus', in short."
 989   :group 'gnus-server
 990   :type '(repeat string))
 991
 992 (defcustom gnus-nntp-server nil
 993   "*The name of the host running the NNTP server.
 994 This variable is semi-obsolete.  Use the `gnus-select-method'
 995 variable instead."
 996   :group 'gnus-server
 997   :type '(choice (const :tag "disable" nil)
 998                  string))
 999
1000 (defcustom gnus-secondary-select-methods nil
1001   "A list of secondary methods that will be used for reading news.
1002 This is a list where each element is a complete select method (see
1003 `gnus-select-method').
1004
1005 If, for instance, you want to read your mail with the nnml backend,
1006 you could set this variable:
1007
1008 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1009   :group 'gnus-server
1010   :type '(repeat gnus-select-method))
1011
1012 (defvar gnus-backup-default-subscribed-newsgroups
1013   '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1014   "Default default new newsgroups the first time Gnus is run.
1015 Should be set in paths.el, and shouldn't be touched by the user.")
1016
1017 (defcustom gnus-local-domain nil
1018   "Local domain name without a host name.
1019 The DOMAINNAME environment variable is used instead if it is defined.
1020 If the `system-name' function returns the full Internet name, there is
1021 no need to set this variable."
1022   :group 'gnus-message
1023   :type '(choice (const :tag "default" nil)
1024                  string))
1025
1026 (defvar gnus-local-organization nil
1027   "String with a description of what organization (if any) the user belongs to.
1028 Obsolete variable; use `message-user-organization' instead.")
1029
1030 ;; Customization variables
1031
1032 (defcustom gnus-refer-article-method nil
1033   "Preferred method for fetching an article by Message-ID.
1034 If you are reading news from the local spool (with nnspool), fetching
1035 articles by Message-ID is painfully slow.  By setting this method to an
1036 nntp method, you might get acceptable results.
1037
1038 The value of this variable must be a valid select method as discussed
1039 in the documentation of `gnus-select-method'.
1040
1041 It can also be a list of select methods, as well as the special symbol
1042 `current', which means to use the current select method.  If it is a
1043 list, Gnus will try all the methods in the list until it finds a match."
1044   :group 'gnus-server
1045   :type '(choice (const :tag "default" nil)
1046                  (const :tag "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1047                  gnus-select-method
1048                  (repeat :menu-tag "Try multiple"
1049                          :tag "Multiple"
1050                          :value (current (nnweb "refer" (nnweb-type dejanews)))
1051                          (choice :tag "Method"
1052                                  (const current)
1053                                  (const :tag "DejaNews"
1054                                         (nnweb "refer" (nnweb-type dejanews)))
1055                                  gnus-select-method))))
1056
1057 (defcustom gnus-group-faq-directory
1058   '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1059     "/ftp@sunsite.auc.dk:/pub/usenet/"
1060     "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1061     "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1062     "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1063     "/ftp@rtfm.mit.edu:/pub/usenet/"
1064     "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1065     "/ftp@ftp.sunet.se:/pub/usenet/"
1066     "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1067     "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1068     "/ftp@ftp.hk.super.net:/mirror/faqs/")
1069   "*Directory where the group FAQs are stored.
1070 This will most commonly be on a remote machine, and the file will be
1071 fetched by ange-ftp.
1072
1073 This variable can also be a list of directories.  In that case, the
1074 first element in the list will be used by default.  The others can
1075 be used when being prompted for a site.
1076
1077 Note that Gnus uses an aol machine as the default directory.  If this
1078 feels fundamentally unclean, just think of it as a way to finally get
1079 something of value back from them.
1080
1081 If the default site is too slow, try one of these:
1082
1083    North America: mirrors.aol.com                /pub/rtfm/usenet
1084                   ftp.seas.gwu.edu               /pub/rtfm
1085                   rtfm.mit.edu                   /pub/usenet
1086    Europe:        ftp.uni-paderborn.de           /pub/FAQ
1087                   src.doc.ic.ac.uk               /usenet/news-FAQS
1088                   ftp.sunet.se                   /pub/usenet
1089                   sunsite.auc.dk                 /pub/usenet
1090    Asia:          nctuccca.edu.tw                /USENET/FAQ
1091                   hwarang.postech.ac.kr          /pub/usenet
1092                   ftp.hk.super.net               /mirror/faqs"
1093   :group 'gnus-group-various
1094   :type '(choice directory
1095                  (repeat directory)))
1096
1097 (defcustom gnus-use-cross-reference t
1098   "*Non-nil means that cross referenced articles will be marked as read.
1099 If nil, ignore cross references.  If t, mark articles as read in
1100 subscribed newsgroups.  If neither t nor nil, mark as read in all
1101 newsgroups."
1102   :group 'gnus-server
1103   :type '(choice (const :tag "off" nil)
1104                  (const :tag "subscribed" t)
1105                  (sexp :format "all"
1106                        :value always)))
1107
1108 (defcustom gnus-process-mark ?#
1109   "*Process mark."
1110   :group 'gnus-group-visual
1111   :group 'gnus-summary-marks
1112   :type 'character)
1113
1114 (defcustom gnus-large-newsgroup 200
1115   "*The number of articles which indicates a large newsgroup.
1116 If the number of articles in a newsgroup is greater than this value,
1117 confirmation is required for selecting the newsgroup."
1118   :group 'gnus-group-select
1119   :type 'integer)
1120
1121 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1122   "*Non-nil means that the default name of a file to save articles in is the group name.
1123 If it's nil, the directory form of the group name is used instead.
1124
1125 If this variable is a list, and the list contains the element
1126 `not-score', long file names will not be used for score files; if it
1127 contains the element `not-save', long file names will not be used for
1128 saving; and if it contains the element `not-kill', long file names
1129 will not be used for kill files.
1130
1131 Note that the default for this variable varies according to what system
1132 type you're using.  On `usg-unix-v' and `xenix' this variable defaults
1133 to nil while on all other systems it defaults to t."
1134   :group 'gnus-start
1135   :type 'boolean)
1136
1137 (defcustom gnus-kill-files-directory gnus-directory
1138   "*Name of the directory where kill files will be stored (default \"~/News\")."
1139   :group 'gnus-score-files
1140   :group 'gnus-score-kill
1141   :type 'directory)
1142
1143 (defcustom gnus-save-score nil
1144   "*If non-nil, save group scoring info."
1145   :group 'gnus-score-various
1146   :group 'gnus-start
1147   :type 'boolean)
1148
1149 (defcustom gnus-use-undo t
1150   "*If non-nil, allow undoing in Gnus group mode buffers."
1151   :group 'gnus-meta
1152   :type 'boolean)
1153
1154 (defcustom gnus-use-adaptive-scoring nil
1155   "*If non-nil, use some adaptive scoring scheme.
1156 If a list, then the values `word' and `line' are meaningful.  The
1157 former will perform adaption on individual words in the subject
1158 header while `line' will perform adaption on several headers."
1159   :group 'gnus-meta
1160   :group 'gnus-score-adapt
1161   :type '(set (const word) (const line)))
1162
1163 (defcustom gnus-use-cache 'passive
1164   "*If nil, Gnus will ignore the article cache.
1165 If `passive', it will allow entering (and reading) articles
1166 explicitly entered into the cache.  If anything else, use the
1167 cache to the full extent of the law."
1168   :group 'gnus-meta
1169   :group 'gnus-cache
1170   :type '(choice (const :tag "off" nil)
1171                  (const :tag "passive" passive)
1172                  (const :tag "active" t)))
1173
1174 (defcustom gnus-use-trees nil
1175   "*If non-nil, display a thread tree buffer."
1176   :group 'gnus-meta
1177   :type 'boolean)
1178
1179 (defcustom gnus-use-grouplens nil
1180   "*If non-nil, use GroupLens ratings."
1181   :group 'gnus-meta
1182   :type 'boolean)
1183
1184 (defcustom gnus-keep-backlog nil
1185   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1186 If it is a number N, then Gnus will only keep the last N articles
1187 read.  If it is neither nil nor a number, Gnus will keep all read
1188 articles.  This is not a good idea."
1189   :group 'gnus-meta
1190   :type '(choice (const :tag "off" nil)
1191                  integer
1192                  (sexp :format "all"
1193                        :value t)))
1194
1195 (defcustom gnus-use-nocem nil
1196   "*If non-nil, Gnus will read NoCeM cancel messages."
1197   :group 'gnus-meta
1198   :type 'boolean)
1199
1200 (defcustom gnus-suppress-duplicates nil
1201   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1202   :group 'gnus-meta
1203   :type 'boolean)
1204
1205 (defcustom gnus-use-scoring t
1206   "*If non-nil, enable scoring."
1207   :group 'gnus-meta
1208   :type 'boolean)
1209
1210 (defcustom gnus-use-picons nil
1211   "*If non-nil, display picons in a frame of their own."
1212   :group 'gnus-meta
1213   :type 'boolean)
1214
1215 (defcustom gnus-summary-prepare-exit-hook
1216   '(gnus-summary-expire-articles)
1217   "*A hook called when preparing to exit from the summary buffer.
1218 It calls `gnus-summary-expire-articles' by default."
1219   :group 'gnus-summary-exit
1220   :type 'hook)
1221
1222 (defcustom gnus-novice-user t
1223   "*Non-nil means that you are a usenet novice.
1224 If non-nil, verbose messages may be displayed and confirmations may be
1225 required."
1226   :group 'gnus-meta
1227   :type 'boolean)
1228
1229 (defcustom gnus-expert-user nil
1230   "*Non-nil means that you will never be asked for confirmation about anything.
1231 That doesn't mean *anything* anything; particularly destructive
1232 commands will still require prompting."
1233   :group 'gnus-meta
1234   :type 'boolean)
1235
1236 (defcustom gnus-interactive-catchup t
1237   "*If non-nil, require your confirmation when catching up a group."
1238   :group 'gnus-group-select
1239   :type 'boolean)
1240
1241 (defcustom gnus-interactive-exit t
1242   "*If non-nil, require your confirmation when exiting Gnus."
1243   :group 'gnus-exit
1244   :type 'boolean)
1245
1246 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1247   "*Function for extracting address components from a From header.
1248 Two pre-defined function exist: `gnus-extract-address-components',
1249 which is the default, quite fast, and too simplistic solution, and
1250 `mail-extract-address-components', which works much better, but is
1251 slower."
1252   :group 'gnus-summary-format
1253   :type '(radio (function-item gnus-extract-address-components)
1254                 (function-item mail-extract-address-components)
1255                 (function :tag "Other")))
1256
1257 (defcustom gnus-carpal nil
1258   "*If non-nil, display clickable icons."
1259   :group 'gnus-meta
1260   :type 'boolean)
1261
1262 (defcustom gnus-shell-command-separator ";"
1263   "String used to separate to shell commands."
1264   :group 'gnus-files
1265   :type 'string)
1266
1267 (defcustom gnus-valid-select-methods
1268   '(("nntp" post address prompt-address physical-address)
1269     ("nnspool" post address)
1270     ("nnvirtual" post-mail virtual prompt-address)
1271     ("nnmbox" mail respool address)
1272     ("nnml" mail respool address)
1273     ("nnmh" mail respool address)
1274     ("nndir" post-mail prompt-address physical-address)
1275     ("nneething" none address prompt-address physical-address)
1276     ("nndoc" none address prompt-address)
1277     ("nnbabyl" mail address respool)
1278     ("nnkiboze" post virtual)
1279     ("nnsoup" post-mail address)
1280     ("nndraft" post-mail)
1281     ("nnfolder" mail respool address)
1282     ("nngateway" post-mail address prompt-address physical-address)
1283     ("nnweb" none)
1284     ("nnslashdot" post)
1285     ("nnultimate" none)
1286     ("nnwarchive" none)
1287     ("nnlistserv" none)
1288     ("nnagent" post-mail)
1289     ("nnimap" post-mail address prompt-address physical-address))
1290   "*An alist of valid select methods.
1291 The first element of each list lists should be a string with the name
1292 of the select method.  The other elements may be the category of
1293 this method (i. e., `post', `mail', `none' or whatever) or other
1294 properties that this method has (like being respoolable).
1295 If you implement a new select method, all you should have to change is
1296 this variable.  I think."
1297   :group 'gnus-server
1298   :type '(repeat (group (string :tag "Name")
1299                         (radio-button-choice (const :format "%v " post)
1300                                              (const :format "%v " mail)
1301                                              (const :format "%v " none)
1302                                              (const post-mail))
1303                         (checklist :inline t
1304                                    (const :format "%v " address)
1305                                    (const :format "%v " prompt-address)
1306                                    (const :format "%v " physical-address)
1307                                    (const :format "%v " virtual)
1308                                    (const respool)))))
1309
1310 (defun gnus-redefine-select-method-widget ()
1311   "Recomputes the select-method widget based on the value of
1312 `gnus-valid-select-methods'."
1313   (define-widget 'gnus-select-method 'list
1314     "Widget for entering a select method."
1315     :value '(nntp "")
1316     :tag "Select Method"
1317     :args `((choice :tag "Method"
1318                     ,@(mapcar (lambda (entry)
1319                                 (list 'const :format "%v\n"
1320                                       (intern (car entry))))
1321                               gnus-valid-select-methods)
1322                     (symbol :tag "other"))
1323             (string :tag "Address")
1324             (repeat :tag "Options"
1325                     :inline t
1326                     (list :format "%v"
1327                           variable
1328                           (sexp :tag "Value"))))
1329     ))
1330
1331 (gnus-redefine-select-method-widget)
1332
1333 (defcustom gnus-updated-mode-lines '(group article summary tree)
1334   "List of buffers that should update their mode lines.
1335 The list may contain the symbols `group', `article', `tree' and
1336 `summary'.  If the corresponding symbol is present, Gnus will keep
1337 that mode line updated with information that may be pertinent.
1338 If this variable is nil, screen refresh may be quicker."
1339   :group 'gnus-various
1340   :type '(set (const group)
1341               (const article)
1342               (const summary)
1343               (const tree)))
1344
1345 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1346 (defcustom gnus-mode-non-string-length nil
1347   "*Max length of mode-line non-string contents.
1348 If this is nil, Gnus will take space as is needed, leaving the rest
1349 of the modeline intact.  Note that the default of nil is unlikely
1350 to be desirable; see the manual for further details."
1351   :group 'gnus-various
1352   :type '(choice (const nil)
1353                  integer))
1354
1355 (defcustom gnus-auto-expirable-newsgroups nil
1356   "*Groups in which to automatically mark read articles as expirable.
1357 If non-nil, this should be a regexp that should match all groups in
1358 which to perform auto-expiry.  This only makes sense for mail groups."
1359   :group 'nnmail-expire
1360   :type '(choice (const nil)
1361                  regexp))
1362
1363 (defcustom gnus-total-expirable-newsgroups nil
1364   "*Groups in which to perform expiry of all read articles.
1365 Use with extreme caution.  All groups that match this regexp will be
1366 expiring - which means that all read articles will be deleted after
1367 \(say) one week.         (This only goes for mail groups and the like, of
1368 course.)"
1369   :group 'nnmail-expire
1370   :type '(choice (const nil)
1371                  regexp))
1372
1373 (defcustom gnus-group-uncollapsed-levels 1
1374   "Number of group name elements to leave alone when making a short group name."
1375   :group 'gnus-group-visual
1376   :type 'integer)
1377
1378 (defcustom gnus-group-use-permanent-levels nil
1379   "*If non-nil, once you set a level, Gnus will use this level."
1380   :group 'gnus-group-levels
1381   :type 'boolean)
1382
1383 ;; Hooks.
1384
1385 (defcustom gnus-load-hook nil
1386   "A hook run while Gnus is loaded."
1387   :group 'gnus-start
1388   :type 'hook)
1389
1390 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1391   "A hook called to apply kill files to a group.
1392 This hook is intended to apply a kill file to the selected newsgroup.
1393 The function `gnus-apply-kill-file' is called by default.
1394
1395 Since a general kill file is too heavy to use only for a few
1396 newsgroups, I recommend you to use a lighter hook function.  For
1397 example, if you'd like to apply a kill file to articles which contains
1398 a string `rmgroup' in subject in newsgroup `control', you can use the
1399 following hook:
1400
1401  (setq gnus-apply-kill-hook
1402       (list
1403         (lambda ()
1404           (cond ((string-match \"control\" gnus-newsgroup-name)
1405                  (gnus-kill \"Subject\" \"rmgroup\")
1406                  (gnus-expunge \"X\"))))))"
1407   :group 'gnus-score-kill
1408   :options '(gnus-apply-kill-file)
1409   :type 'hook)
1410
1411 (defcustom gnus-group-change-level-function nil
1412   "Function run when a group level is changed.
1413 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1414   :group 'gnus-group-levels
1415   :type 'function)
1416
1417 ;;; Face thingies.
1418
1419 (defcustom gnus-visual
1420   '(summary-highlight group-highlight article-highlight
1421                       mouse-face
1422                       summary-menu group-menu article-menu
1423                       tree-highlight menu highlight
1424                       browse-menu server-menu
1425                       page-marker tree-menu binary-menu pick-menu
1426                       grouplens-menu)
1427   "*Enable visual features.
1428 If `visual' is disabled, there will be no menus and few faces.  Most of
1429 the visual customization options below will be ignored.  Gnus will use
1430 less space and be faster as a result.
1431
1432 This variable can also be a list of visual elements to switch on.  For
1433 instance, to switch off all visual things except menus, you can say:
1434
1435    (setq gnus-visual '(menu))
1436
1437 Valid elements include `summary-highlight', `group-highlight',
1438 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1439 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1440 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1441 and `grouplens-menu'."
1442   :group 'gnus-meta
1443   :group 'gnus-visual
1444   :type '(set (const summary-highlight)
1445               (const group-highlight)
1446               (const article-highlight)
1447               (const mouse-face)
1448               (const summary-menu)
1449               (const group-menu)
1450               (const article-menu)
1451               (const tree-highlight)
1452               (const menu)
1453               (const highlight)
1454               (const browse-menu)
1455               (const server-menu)
1456               (const page-marker)
1457               (const tree-menu)
1458               (const binary-menu)
1459               (const pick-menu)
1460               (const grouplens-menu)))
1461
1462 (defcustom gnus-mouse-face
1463   (condition-case ()
1464       (if (gnus-visual-p 'mouse-face 'highlight)
1465           (if (boundp 'gnus-mouse-face)
1466               (or gnus-mouse-face 'highlight)
1467             'highlight)
1468         'default)
1469     (error 'highlight))
1470   "*Face used for group or summary buffer mouse highlighting.
1471 The line beneath the mouse pointer will be highlighted with this
1472 face."
1473   :group 'gnus-visual
1474   :type 'face)
1475
1476 (defcustom gnus-article-save-directory gnus-directory
1477   "*Name of the directory articles will be saved in (default \"~/News\")."
1478   :group 'gnus-article-saving
1479   :type 'directory)
1480
1481 (defvar gnus-plugged t
1482   "Whether Gnus is plugged or not.")
1483
1484 (defcustom gnus-default-charset 'iso-8859-1
1485   "Default charset assumed to be used when viewing non-ASCII characters.
1486 This variable is overridden on a group-to-group basis by the
1487 gnus-group-charset-alist variable and is only used on groups not
1488 covered by that variable."
1489   :type 'symbol
1490   :group 'gnus-charset)
1491
1492 (defcustom gnus-default-posting-charset nil
1493   "Default charset assumed to be used when posting non-ASCII characters.
1494 This variable is overridden on a group-to-group basis by the
1495 gnus-group-posting-charset-alist variable and is only used on groups not
1496 covered by that variable.
1497 If nil, no default charset is assumed when posting."
1498   :type 'symbol
1499   :group 'gnus-charset)
1500
1501 \f
1502 ;;; Internal variables
1503
1504 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
1505 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1506 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1507 (defvar gnus-original-article-buffer " *Original Article*")
1508 (defvar gnus-newsgroup-name nil)
1509 (defvar gnus-ephemeral-servers nil)
1510
1511 (defvar gnus-agent nil
1512   "Whether we want to use the Gnus agent or not.")
1513
1514 (defvar gnus-command-method nil
1515   "Dynamically bound variable that says what the current backend is.")
1516
1517 (defvar gnus-current-select-method nil
1518   "The current method for selecting a newsgroup.")
1519
1520 (defvar gnus-tree-buffer "*Tree*"
1521   "Buffer where Gnus thread trees are displayed.")
1522
1523 ;; Dummy variable.
1524 (defvar gnus-use-generic-from nil)
1525
1526 ;; Variable holding the user answers to all method prompts.
1527 (defvar gnus-method-history nil)
1528
1529 ;; Variable holding the user answers to all mail method prompts.
1530 (defvar gnus-mail-method-history nil)
1531
1532 ;; Variable holding the user answers to all group prompts.
1533 (defvar gnus-group-history nil)
1534
1535 (defvar gnus-server-alist nil
1536   "List of available servers.")
1537
1538 (defcustom gnus-cache-directory
1539   (nnheader-concat gnus-directory "cache/")
1540   "*The directory where cached articles will be stored."
1541   :group 'gnus-cache
1542   :type 'directory)
1543
1544 (defvar gnus-predefined-server-alist
1545   `(("cache"
1546      nnspool "cache"
1547      (nnspool-spool-directory ,gnus-cache-directory)
1548      (nnspool-nov-directory ,gnus-cache-directory)
1549      (nnspool-active-file
1550       ,(nnheader-concat gnus-cache-directory "active"))))
1551   "List of predefined (convenience) servers.")
1552
1553 (defvar gnus-topic-indentation "");; Obsolete variable.
1554
1555 (defconst gnus-article-mark-lists
1556   '((marked . tick) (replied . reply)
1557     (expirable . expire) (killed . killed)
1558     (bookmarks . bookmark) (dormant . dormant)
1559     (scored . score) (saved . save)
1560     (cached . cache) (downloadable . download)
1561     (unsendable . unsend)))
1562
1563 (defvar gnus-headers-retrieved-by nil)
1564 (defvar gnus-article-reply nil)
1565 (defvar gnus-override-method nil)
1566 (defvar gnus-article-check-size nil)
1567 (defvar gnus-opened-servers nil)
1568
1569 (defvar gnus-current-kill-article nil)
1570
1571 (defvar gnus-have-read-active-file nil)
1572
1573 (defconst gnus-maintainer
1574   "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1575   "The mail address of the Gnus maintainers.")
1576
1577 (defvar gnus-info-nodes
1578   '((gnus-group-mode "(gnus)The Group Buffer")
1579     (gnus-summary-mode "(gnus)The Summary Buffer")
1580     (gnus-article-mode "(gnus)The Article Buffer")
1581     (gnus-server-mode "(gnus)The Server Buffer")
1582     (gnus-browse-mode "(gnus)Browse Foreign Server")
1583     (gnus-tree-mode "(gnus)Tree Display"))
1584   "Alist of major modes and related Info nodes.")
1585
1586 (defvar gnus-group-buffer "*Group*")
1587 (defvar gnus-summary-buffer "*Summary*")
1588 (defvar gnus-article-buffer "*Article*")
1589 (defvar gnus-server-buffer "*Server*")
1590
1591 (defvar gnus-slave nil
1592   "Whether this Gnus is a slave or not.")
1593
1594 (defvar gnus-batch-mode nil
1595   "Whether this Gnus is running in batch mode or not.")
1596
1597 (defvar gnus-variable-list
1598   '(gnus-newsrc-options gnus-newsrc-options-n
1599                         gnus-newsrc-last-checked-date
1600                         gnus-newsrc-alist gnus-server-alist
1601                         gnus-killed-list gnus-zombie-list
1602                         gnus-topic-topology gnus-topic-alist
1603                         gnus-format-specs)
1604   "Gnus variables saved in the quick startup file.")
1605
1606 (defvar gnus-newsrc-alist nil
1607   "Assoc list of read articles.
1608 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1609
1610 (defvar gnus-newsrc-hashtb nil
1611   "Hashtable of gnus-newsrc-alist.")
1612
1613 (defvar gnus-killed-list nil
1614   "List of killed newsgroups.")
1615
1616 (defvar gnus-killed-hashtb nil
1617   "Hash table equivalent of gnus-killed-list.")
1618
1619 (defvar gnus-zombie-list nil
1620   "List of almost dead newsgroups.")
1621
1622 (defvar gnus-description-hashtb nil
1623   "Descriptions of newsgroups.")
1624
1625 (defvar gnus-list-of-killed-groups nil
1626   "List of newsgroups that have recently been killed by the user.")
1627
1628 (defvar gnus-active-hashtb nil
1629   "Hashtable of active articles.")
1630
1631 (defvar gnus-moderated-hashtb nil
1632   "Hashtable of moderated newsgroups.")
1633
1634 ;; Save window configuration.
1635 (defvar gnus-prev-winconf nil)
1636
1637 (defvar gnus-reffed-article-number nil)
1638
1639 ;;; Let the byte-compiler know that we know about this variable.
1640 (defvar rmail-default-rmail-file)
1641
1642 (defvar gnus-dead-summary nil)
1643
1644 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
1645   "Regexp matching invalid groups.")
1646
1647 ;;; End of variables.
1648
1649 ;; Define some autoload functions Gnus might use.
1650 (eval-and-compile
1651
1652   ;; This little mapcar goes through the list below and marks the
1653   ;; symbols in question as autoloaded functions.
1654   (mapcar
1655    (lambda (package)
1656      (let ((interactive (nth 1 (memq ':interactive package))))
1657        (mapcar
1658         (lambda (function)
1659           (let (keymap)
1660             (when (consp function)
1661               (setq keymap (car (memq 'keymap function)))
1662               (setq function (car function)))
1663             (unless (fboundp function)
1664               (autoload function (car package) nil interactive keymap))))
1665         (if (eq (nth 1 package) ':interactive)
1666             (nthcdr 3 package)
1667           (cdr package)))))
1668    '(("info" :interactive t Info-goto-node)
1669      ("pp" pp pp-to-string pp-eval-expression)
1670      ("qp" quoted-printable-decode-region quoted-printable-decode-string)
1671      ("ps-print" ps-print-preprint)
1672      ("browse-url" :interactive t browse-url)
1673      ("message" :interactive t
1674       message-send-and-exit message-yank-original)
1675      ("babel" babel-as-string)
1676      ("nnmail" nnmail-split-fancy nnmail-article-group)
1677      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1678      ("rmailout" rmail-output rmail-output-to-rmail-file)
1679      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1680       rmail-show-message rmail-summary-exists
1681       rmail-select-summary rmail-update-summary)
1682      ("gnus-audio" :interactive t gnus-audio-play)
1683      ("gnus-xmas" gnus-xmas-splash)
1684      ("gnus-soup" :interactive t
1685       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1686       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1687      ("nnsoup" nnsoup-pack-replies)
1688      ("score-mode" :interactive t gnus-score-mode)
1689      ("gnus-mh" gnus-summary-save-article-folder
1690       gnus-Folder-save-name gnus-folder-save-name)
1691      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1692      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1693       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1694       gnus-demon-add-disconnection gnus-demon-add-handler
1695       gnus-demon-remove-handler)
1696      ("gnus-demon" :interactive t
1697       gnus-demon-init gnus-demon-cancel)
1698      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1699       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1700      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1701       gnus-nocem-unwanted-article-p)
1702      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1703       gnus-server-server-name)
1704      ("gnus-srvr" gnus-browse-foreign-server)
1705      ("gnus-cite" :interactive t
1706       gnus-article-highlight-citation gnus-article-hide-citation-maybe
1707       gnus-article-hide-citation gnus-article-fill-cited-article
1708       gnus-article-hide-citation-in-followups)
1709      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1710       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1711       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1712      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1713       gnus-cache-possibly-remove-articles gnus-cache-request-article
1714       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1715       gnus-cache-enter-remove-article gnus-cached-article-p
1716       gnus-cache-open gnus-cache-close gnus-cache-update-article
1717       gnus-cache-articles-in-group)
1718      ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1719       gnus-cache-remove-article gnus-summary-insert-cached-articles)
1720      ("gnus-score" :interactive t
1721       gnus-summary-increase-score gnus-summary-set-score
1722       gnus-summary-raise-thread gnus-summary-raise-same-subject
1723       gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1724       gnus-summary-lower-thread gnus-summary-lower-same-subject
1725       gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1726       gnus-summary-current-score gnus-score-delta-default
1727       gnus-score-flush-cache gnus-score-close
1728       gnus-possibly-score-headers gnus-score-followup-article
1729       gnus-score-followup-thread)
1730      ("gnus-score"
1731       (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1732       gnus-current-score-file-nondirectory gnus-score-adaptive
1733       gnus-score-find-trace gnus-score-file-name)
1734      ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1735      ("gnus-topic" :interactive t gnus-topic-mode)
1736      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
1737       gnus-subscribe-topics)
1738      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1739      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1740      ("gnus-uu" :interactive t
1741       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1742       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1743       gnus-uu-mark-by-regexp gnus-uu-mark-all
1744       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1745       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1746       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1747       gnus-uu-decode-binhex gnus-uu-decode-uu-view
1748       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1749       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1750       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1751       gnus-uu-mark-over gnus-uu-post-news)
1752      ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
1753      ("gnus-msg" (gnus-summary-send-map keymap)
1754       gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1755      ("gnus-msg" :interactive t
1756       gnus-group-post-news gnus-group-mail gnus-summary-post-news
1757       gnus-summary-followup gnus-summary-followup-with-original
1758       gnus-summary-cancel-article gnus-summary-supersede-article
1759       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1760       gnus-summary-mail-forward gnus-summary-mail-other-window
1761       gnus-summary-resend-message gnus-summary-resend-bounced-mail
1762       gnus-summary-wide-reply gnus-summary-followup-to-mail
1763       gnus-summary-followup-to-mail-with-original gnus-bug
1764       gnus-summary-wide-reply-with-original
1765       gnus-summary-post-forward gnus-summary-wide-reply-with-original
1766       gnus-summary-post-forward)
1767      ("gnus-picon" :interactive t gnus-article-display-picons
1768       gnus-group-display-picons gnus-picons-article-display-x-face
1769       gnus-picons-display-x-face)
1770      ("gnus-picon" gnus-picons-buffer-name)
1771      ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1772       gnus-grouplens-mode)
1773      ("smiley" :interactive t gnus-smiley-display)
1774      ("gnus-win" gnus-configure-windows gnus-add-configuration)
1775      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1776       gnus-list-of-unread-articles gnus-list-of-read-articles
1777       gnus-offer-save-summaries gnus-make-thread-indent-array
1778       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1779       gnus-summary-skip-intangible gnus-summary-article-number
1780       gnus-data-header gnus-data-find)
1781      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1782       gnus-group-list-groups gnus-group-first-unread-group
1783       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1784       gnus-group-setup-buffer gnus-group-get-new-news
1785       gnus-group-make-help-group gnus-group-update-group
1786       gnus-group-iterate gnus-group-group-name)
1787      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1788       gnus-backlog-remove-article)
1789      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1790       gnus-article-prepare gnus-article-set-window-start
1791       gnus-article-next-page gnus-article-prev-page
1792       gnus-request-article-this-buffer gnus-article-mode
1793       gnus-article-setup-buffer gnus-narrow-to-page
1794       gnus-article-delete-invisible-text gnus-treat-article)
1795      ("gnus-art" :interactive t
1796       gnus-article-hide-headers gnus-article-hide-boring-headers
1797       gnus-article-treat-overstrike
1798       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1799       gnus-article-display-x-face gnus-article-de-quoted-unreadable
1800       gnus-article-de-base64-unreadable
1801       gnus-article-decode-HZ
1802       gnus-article-wash-html
1803       gnus-article-hide-pgp
1804       gnus-article-hide-pem gnus-article-hide-signature
1805       gnus-article-strip-leading-blank-lines gnus-article-date-local
1806       gnus-article-date-original gnus-article-date-lapsed
1807       gnus-article-show-all-headers
1808       gnus-article-edit-mode gnus-article-edit-article
1809       gnus-article-edit-done gnus-article-decode-encoded-words
1810       gnus-start-date-timer gnus-stop-date-timer
1811       gnus-mime-view-all-parts)
1812      ("gnus-int" gnus-request-type)
1813      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1814       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1815      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1816       gnus-dup-enter-articles)
1817      ("gnus-range" gnus-copy-sequence)
1818      ("gnus-eform" gnus-edit-form)
1819      ("gnus-move" :interactive t
1820       gnus-group-move-group-to-server gnus-change-server)
1821      ("gnus-logic" gnus-score-advanced)
1822      ("gnus-undo" gnus-undo-mode gnus-undo-register)
1823      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1824       gnus-async-prefetch-article gnus-async-prefetch-remove-group
1825       gnus-async-halt-prefetch)
1826      ("gnus-agent" gnus-open-agent gnus-agent-get-function
1827       gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1828       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1829       gnus-summary-set-agent-mark gnus-agent-save-group-info)
1830      ("gnus-agent" :interactive t
1831       gnus-unplugged gnus-agentize gnus-agent-batch)
1832      ("gnus-vm" :interactive t gnus-summary-save-in-vm
1833       gnus-summary-save-article-vm)
1834      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts)
1835      ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
1836      ("gnus-mlspl" :interactive t gnus-group-split-setup
1837       gnus-group-split-update))))
1838
1839 ;;; gnus-sum.el thingies
1840
1841
1842 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1843   "*The format specification of the lines in the summary buffer.
1844
1845 It works along the same lines as a normal formatting string,
1846 with some simple extensions.
1847
1848 %N   Article number, left padded with spaces (string)
1849 %S   Subject (string)
1850 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
1851 %n   Name of the poster (string)
1852 %a   Extracted name of the poster (string)
1853 %A   Extracted address of the poster (string)
1854 %F   Contents of the From: header (string)
1855 %f   Contents of the From: or To: headers (string)
1856 %x   Contents of the Xref: header (string)
1857 %D   Date of the article (string)
1858 %d   Date of the article (string) in DD-MMM format
1859 %M   Message-id of the article (string)
1860 %r   References of the article (string)
1861 %c   Number of characters in the article (integer)
1862 %L   Number of lines in the article (integer)
1863 %I   Indentation based on thread level (a string of spaces)
1864 %T   A string with two possible values: 80 spaces if the article
1865      is on thread level two or larger and 0 spaces on level one
1866 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
1867 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1868 %[   Opening bracket (character, \"[\" or \"<\")
1869 %]   Closing bracket (character, \"]\" or \">\")
1870 %>   Spaces of length thread-level (string)
1871 %<   Spaces of length (- 20 thread-level) (string)
1872 %i   Article score (number)
1873 %z   Article zcore (character)
1874 %t   Number of articles under the current thread (number).
1875 %e   Whether the thread is empty or not (character).
1876 %l   GroupLens score (string).
1877 %V   Total thread score (number).
1878 %P   The line number (number).
1879 %O   Download mark (character).
1880 %u   User defined specifier.  The next character in the format string should
1881      be a letter.  Gnus will call the function gnus-user-format-function-X,
1882      where X is the letter following %u.  The function will be passed the
1883      current header as argument.  The function should return a string, which
1884      will be inserted into the summary just like information from any other
1885      summary specifier.
1886
1887 Text between %( and %) will be highlighted with `gnus-mouse-face'
1888 when the mouse point is placed inside the area.  There can only be one
1889 such area.
1890
1891 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1892 with care.  For reasons of efficiency, Gnus will compute what column
1893 these characters will end up in, and \"hard-code\" that.  This means that
1894 it is invalid to have these specs after a variable-length spec.  Well,
1895 you might not be arrested, but your summary buffer will look strange,
1896 which is bad enough.
1897
1898 The smart choice is to have these specs as for to the left as
1899 possible.
1900
1901 This restriction may disappear in later versions of Gnus."
1902   :type 'string
1903   :group 'gnus-summary-format)
1904
1905 ;;;
1906 ;;; Skeleton keymaps
1907 ;;;
1908
1909 (defun gnus-suppress-keymap (keymap)
1910   (suppress-keymap keymap)
1911   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1912     (while keys
1913       (define-key keymap (pop keys) 'undefined))))
1914
1915 (defvar gnus-article-mode-map
1916   (let ((keymap (make-sparse-keymap)))
1917     (gnus-suppress-keymap keymap)
1918     keymap))
1919 (defvar gnus-summary-mode-map
1920   (let ((keymap (make-keymap)))
1921     (gnus-suppress-keymap keymap)
1922     keymap))
1923 (defvar gnus-group-mode-map
1924   (let ((keymap (make-keymap)))
1925     (gnus-suppress-keymap keymap)
1926     keymap))
1927
1928 \f
1929
1930 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1931 ;; If you want the cursor to go somewhere else, set these two
1932 ;; functions in some startup hook to whatever you want.
1933 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1934 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1935
1936 ;;; Various macros and substs.
1937
1938 (defun gnus-header-from (header)
1939   (mail-header-from header))
1940
1941 (defmacro gnus-gethash (string hashtable)
1942   "Get hash value of STRING in HASHTABLE."
1943   `(symbol-value (intern-soft ,string ,hashtable)))
1944
1945 (defmacro gnus-sethash (string value hashtable)
1946   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
1947   `(set (intern ,string ,hashtable) ,value))
1948 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1949
1950 (defmacro gnus-group-unread (group)
1951   "Get the currently computed number of unread articles in GROUP."
1952   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1953
1954 (defmacro gnus-group-entry (group)
1955   "Get the newsrc entry for GROUP."
1956   `(gnus-gethash ,group gnus-newsrc-hashtb))
1957
1958 (defmacro gnus-active (group)
1959   "Get active info on GROUP."
1960   `(gnus-gethash ,group gnus-active-hashtb))
1961
1962 (defmacro gnus-set-active (group active)
1963   "Set GROUP's active info."
1964   `(gnus-sethash ,group ,active gnus-active-hashtb))
1965
1966 ;; Info access macros.
1967
1968 (defmacro gnus-info-group (info)
1969   `(nth 0 ,info))
1970 (defmacro gnus-info-rank (info)
1971   `(nth 1 ,info))
1972 (defmacro gnus-info-read (info)
1973   `(nth 2 ,info))
1974 (defmacro gnus-info-marks (info)
1975   `(nth 3 ,info))
1976 (defmacro gnus-info-method (info)
1977   `(nth 4 ,info))
1978 (defmacro gnus-info-params (info)
1979   `(nth 5 ,info))
1980
1981 (defmacro gnus-info-level (info)
1982   `(let ((rank (gnus-info-rank ,info)))
1983      (if (consp rank)
1984          (car rank)
1985        rank)))
1986 (defmacro gnus-info-score (info)
1987   `(let ((rank (gnus-info-rank ,info)))
1988      (or (and (consp rank) (cdr rank)) 0)))
1989
1990 (defmacro gnus-info-set-group (info group)
1991   `(setcar ,info ,group))
1992 (defmacro gnus-info-set-rank (info rank)
1993   `(setcar (nthcdr 1 ,info) ,rank))
1994 (defmacro gnus-info-set-read (info read)
1995   `(setcar (nthcdr 2 ,info) ,read))
1996 (defmacro gnus-info-set-marks (info marks &optional extend)
1997   (if extend
1998       `(gnus-info-set-entry ,info ,marks 3)
1999     `(setcar (nthcdr 3 ,info) ,marks)))
2000 (defmacro gnus-info-set-method (info method &optional extend)
2001   (if extend
2002       `(gnus-info-set-entry ,info ,method 4)
2003     `(setcar (nthcdr 4 ,info) ,method)))
2004 (defmacro gnus-info-set-params (info params &optional extend)
2005   (if extend
2006       `(gnus-info-set-entry ,info ,params 5)
2007     `(setcar (nthcdr 5 ,info) ,params)))
2008
2009 (defun gnus-info-set-entry (info entry number)
2010   ;; Extend the info until we have enough elements.
2011   (while (<= (length info) number)
2012     (nconc info (list nil)))
2013   ;; Set the entry.
2014   (setcar (nthcdr number info) entry))
2015
2016 (defmacro gnus-info-set-level (info level)
2017   `(let ((rank (cdr ,info)))
2018      (if (consp (car rank))
2019          (setcar (car rank) ,level)
2020        (setcar rank ,level))))
2021 (defmacro gnus-info-set-score (info score)
2022   `(let ((rank (cdr ,info)))
2023      (if (consp (car rank))
2024          (setcdr (car rank) ,score)
2025        (setcar rank (cons (car rank) ,score)))))
2026
2027 (defmacro gnus-get-info (group)
2028   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2029
2030 ;; Byte-compiler warning.
2031 (defvar gnus-visual)
2032 ;; Find out whether the gnus-visual TYPE is wanted.
2033 (defun gnus-visual-p (&optional type class)
2034   (and gnus-visual                      ; Has to be non-nil, at least.
2035        (if (not type)                   ; We don't care about type.
2036            gnus-visual
2037          (if (listp gnus-visual)        ; It's a list, so we check it.
2038              (or (memq type gnus-visual)
2039                  (memq class gnus-visual))
2040            t))))
2041
2042 ;;; Load the compatability functions.
2043
2044 (require 'gnus-ems)
2045
2046 \f
2047 ;;;
2048 ;;; Shutdown
2049 ;;;
2050
2051 (defvar gnus-shutdown-alist nil)
2052
2053 (defun gnus-add-shutdown (function &rest symbols)
2054   "Run FUNCTION whenever one of SYMBOLS is shut down."
2055   (push (cons function symbols) gnus-shutdown-alist))
2056
2057 (defun gnus-shutdown (symbol)
2058   "Shut down everything that waits for SYMBOL."
2059   (let ((alist gnus-shutdown-alist)
2060         entry)
2061     (while (setq entry (pop alist))
2062       (when (memq symbol (cdr entry))
2063         (funcall (car entry))))))
2064
2065 \f
2066 ;;;
2067 ;;; Gnus Utility Functions
2068 ;;;
2069
2070
2071 (defmacro gnus-string-or (&rest strings)
2072   "Return the first element of STRINGS that is a non-blank string.
2073 STRINGS will be evaluated in normal `or' order."
2074   `(gnus-string-or-1 ',strings))
2075
2076 (defun gnus-string-or-1 (strings)
2077   (let (string)
2078     (while strings
2079       (setq string (eval (pop strings)))
2080       (if (string-match "^[ \t]*$" string)
2081           (setq string nil)
2082         (setq strings nil)))
2083     string))
2084
2085 (defun gnus-version (&optional arg)
2086   "Version number of this version of Gnus.
2087 If ARG, insert string at point."
2088   (interactive "P")
2089   (if arg
2090       (insert (message gnus-version))
2091     (message gnus-version)))
2092
2093 (defun gnus-continuum-version (version)
2094   "Return VERSION as a floating point number."
2095   (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2096             (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2097     (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2098           (number (match-string 2 version))
2099           major minor least)
2100       (unless (string-match
2101                "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2102         (error "Invalid version string: %s" version))
2103       (setq major (string-to-number (match-string 1 number))
2104             minor (string-to-number (match-string 2 number))
2105             least (if (match-beginning 3)
2106                       (string-to-number (match-string 3 number))
2107                     0))
2108       (string-to-number
2109        (if (zerop major)
2110            (format "%s00%02d%02d"
2111                    (if (member alpha '("(ding)" "d"))
2112                        "4.99"
2113                      (+ 5 (* 0.02
2114                              (abs
2115                               (- (mm-char-int (aref (downcase alpha) 0))
2116                                  (mm-char-int ?t))))
2117                         -0.01))
2118                    minor least)
2119          (format "%d.%02d%02d" major minor least))))))
2120
2121 (defun gnus-info-find-node ()
2122   "Find Info documentation of Gnus."
2123   (interactive)
2124   ;; Enlarge info window if needed.
2125   (let (gnus-info-buffer)
2126     (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
2127     (setq gnus-info-buffer (current-buffer))
2128     (gnus-configure-windows 'info)))
2129
2130 ;;;
2131 ;;; gnus-interactive
2132 ;;;
2133
2134 (defvar gnus-current-prefix-symbol nil
2135   "Current prefix symbol.")
2136
2137 (defvar gnus-current-prefix-symbols nil
2138   "List of current prefix symbols.")
2139
2140 (defun gnus-interactive (string &optional params)
2141   "Return a list that can be fed to `interactive'.
2142 See `interactive' for full documentation.
2143
2144 Adds the following specs:
2145
2146 y -- The current symbolic prefix.
2147 Y -- A list of the current symbolic prefix(es).
2148 A -- Article number.
2149 H -- Article header.
2150 g -- Group name."
2151   (let ((i 0)
2152         out c prompt)
2153     (while (< i (length string))
2154       (string-match ".\\([^\n]*\\)\n?" string i)
2155       (setq c (aref string i))
2156       (when (match-end 1)
2157         (setq prompt (match-string 1 string)))
2158       (setq i (match-end 0))
2159       ;; We basically emulate just about everything that
2160       ;; `interactive' does, but add the specs listed above.
2161       (push
2162        (cond
2163         ((= c ?a)
2164          (completing-read prompt obarray 'fboundp t))
2165         ((= c ?b)
2166          (read-buffer prompt (current-buffer) t))
2167         ((= c ?B)
2168          (read-buffer prompt (other-buffer (current-buffer))))
2169         ((= c ?c)
2170          (read-char))
2171         ((= c ?C)
2172          (completing-read prompt obarray 'commandp t))
2173         ((= c ?d)
2174          (point))
2175         ((= c ?D)
2176          (read-file-name prompt nil default-directory 'lambda))
2177         ((= c ?f)
2178          (read-file-name prompt nil nil 'lambda))
2179         ((= c ?F)
2180          (read-file-name prompt))
2181         ((= c ?k)
2182          (read-key-sequence prompt))
2183         ((= c ?K)
2184          (error "Not implemented spec"))
2185         ((= c ?e)
2186          (error "Not implemented spec"))
2187         ((= c ?m)
2188          (mark))
2189         ((= c ?N)
2190          (error "Not implemented spec"))
2191         ((= c ?n)
2192          (string-to-number (read-from-minibuffer prompt)))
2193         ((= c ?p)
2194          (prefix-numeric-value current-prefix-arg))
2195         ((= c ?P)
2196          current-prefix-arg)
2197         ((= c ?r)
2198          'gnus-prefix-nil)
2199         ((= c ?s)
2200          (read-string prompt))
2201         ((= c ?S)
2202          (intern (read-string prompt)))
2203         ((= c ?v)
2204          (read-variable prompt))
2205         ((= c ?x)
2206          (read-minibuffer prompt))
2207         ((= c ?x)
2208          (eval-minibuffer prompt))
2209         ;; And here the new specs come.
2210         ((= c ?y)
2211          gnus-current-prefix-symbol)
2212         ((= c ?Y)
2213          gnus-current-prefix-symbols)
2214         ((= c ?g)
2215          (gnus-group-group-name))
2216         ((= c ?A)
2217          (gnus-summary-skip-intangible)
2218          (or (get-text-property (point) 'gnus-number)
2219              (gnus-summary-last-subject)))
2220         ((= c ?H)
2221          (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2222         (t
2223          (error "Non-implemented spec")))
2224        out)
2225       (cond
2226        ((= c ?r)
2227         (push (if (< (point) (mark) (point) (mark))) out)
2228         (push (if (> (point) (mark) (point) (mark))) out))))
2229     (setq out (delq 'gnus-prefix-nil out))
2230     (nreverse out)))
2231
2232 (defun gnus-symbolic-argument (&optional arg)
2233   "Read a symbolic argument and a command, and then execute command."
2234   (interactive "P")
2235   (let* ((in-command (this-command-keys))
2236          (command in-command)
2237          gnus-current-prefix-symbols
2238          gnus-current-prefix-symbol
2239          syms)
2240     (while (equal in-command command)
2241       (message "%s-" (key-description (this-command-keys)))
2242       (push (intern (char-to-string (read-char))) syms)
2243       (setq command (read-key-sequence nil t)))
2244     (setq gnus-current-prefix-symbols (nreverse syms)
2245           gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2246     (call-interactively (key-binding command t))))
2247
2248 ;;; More various functions.
2249
2250 (defsubst gnus-check-backend-function (func group)
2251   "Check whether GROUP supports function FUNC.
2252 GROUP can either be a string (a group name) or a select method."
2253   (ignore-errors
2254     (let ((method (if (stringp group)
2255                       (car (gnus-find-method-for-group group))
2256                     group)))
2257       (unless (featurep method)
2258         (require method))
2259       (fboundp (intern (format "%s-%s" method func))))))
2260
2261 (defun gnus-group-read-only-p (&optional group)
2262   "Check whether GROUP supports editing or not.
2263 If GROUP is nil, `gnus-newsgroup-name' will be checked instead.  Note
2264 that that variable is buffer-local to the summary buffers."
2265   (let ((group (or group gnus-newsgroup-name)))
2266     (not (gnus-check-backend-function 'request-replace-article group))))
2267
2268 (defun gnus-group-total-expirable-p (group)
2269   "Check whether GROUP is total-expirable or not."
2270   (let ((params (gnus-group-find-parameter group))
2271         val)
2272     (cond
2273      ((memq 'total-expire params)
2274       t)
2275      ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2276       (cdr val))
2277      (gnus-total-expirable-newsgroups   ; Check var.
2278       (string-match gnus-total-expirable-newsgroups group)))))
2279
2280 (defun gnus-group-auto-expirable-p (group)
2281   "Check whether GROUP is auto-expirable or not."
2282   (let ((params (gnus-group-find-parameter group))
2283         val)
2284     (cond
2285      ((memq 'auto-expire params)
2286       t)
2287      ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2288       (cdr val))
2289      (gnus-auto-expirable-newsgroups    ; Check var.
2290       (string-match gnus-auto-expirable-newsgroups group)))))
2291
2292 (defun gnus-virtual-group-p (group)
2293   "Say whether GROUP is virtual or not."
2294   (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2295                         gnus-valid-select-methods)))
2296
2297 (defun gnus-news-group-p (group &optional article)
2298   "Return non-nil if GROUP (and ARTICLE) come from a news server."
2299   (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2300       (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2301            (if (or (null article)
2302                    (not (< article 0)))
2303                (eq (gnus-request-type group article) 'news)
2304              (if (not (vectorp article))
2305                  nil
2306                ;; It's a real article.
2307                (eq (gnus-request-type group (mail-header-id article))
2308                    'news))))))
2309
2310 ;; Returns a list of writable groups.
2311 (defun gnus-writable-groups ()
2312   (let ((alist gnus-newsrc-alist)
2313         groups group)
2314     (while (setq group (car (pop alist)))
2315       (unless (gnus-group-read-only-p group)
2316         (push group groups)))
2317     (nreverse groups)))
2318
2319 ;; Check whether to use long file names.
2320 (defun gnus-use-long-file-name (symbol)
2321   ;; The variable has to be set...
2322   (and gnus-use-long-file-name
2323        ;; If it isn't a list, then we return t.
2324        (or (not (listp gnus-use-long-file-name))
2325            ;; If it is a list, and the list contains `symbol', we
2326            ;; return nil.
2327            (not (memq symbol gnus-use-long-file-name)))))
2328
2329 ;; Generate a unique new group name.
2330 (defun gnus-generate-new-group-name (leaf)
2331   (let ((name leaf)
2332         (num 0))
2333     (while (gnus-gethash name gnus-newsrc-hashtb)
2334       (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2335     name))
2336
2337 (defun gnus-ephemeral-group-p (group)
2338   "Say whether GROUP is ephemeral or not."
2339   (gnus-group-get-parameter group 'quit-config t))
2340
2341 (defun gnus-group-quit-config (group)
2342   "Return the quit-config of GROUP."
2343   (gnus-group-get-parameter group 'quit-config t))
2344
2345 (defun gnus-kill-ephemeral-group (group)
2346   "Remove ephemeral GROUP from relevant structures."
2347   (gnus-sethash group nil gnus-newsrc-hashtb))
2348
2349 (defun gnus-simplify-mode-line ()
2350   "Make mode lines a bit simpler."
2351   (setq mode-line-modified (cdr gnus-mode-line-modified))
2352   (when (listp mode-line-format)
2353     (make-local-variable 'mode-line-format)
2354     (setq mode-line-format (copy-sequence mode-line-format))
2355     (when (equal (nth 3 mode-line-format) "   ")
2356       (setcar (nthcdr 3 mode-line-format) " "))))
2357
2358 ;;; Servers and groups.
2359
2360 (defsubst gnus-server-add-address (method)
2361   (let ((method-name (symbol-name (car method))))
2362     (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2363              (not (assq (intern (concat method-name "-address")) method))
2364              (memq 'physical-address (assq (car method)
2365                                            gnus-valid-select-methods)))
2366         (append method (list (list (intern (concat method-name "-address"))
2367                                    (nth 1 method))))
2368       method)))
2369
2370 (defsubst gnus-server-get-method (group method)
2371   ;; Input either a server name, and extended server name, or a
2372   ;; select method, and return a select method.
2373   (cond ((stringp method)
2374          (gnus-server-to-method method))
2375         ((equal method gnus-select-method)
2376          gnus-select-method)
2377         ((and (stringp (car method))
2378               group)
2379          (gnus-server-extend-method group method))
2380         ((and method
2381               (not group)
2382               (equal (cadr method) ""))
2383          method)
2384         (t
2385          (gnus-server-add-address method))))
2386
2387 (defun gnus-server-to-method (server)
2388   "Map virtual server names to select methods."
2389   (or
2390    ;; Is this a method, perhaps?
2391    (and server (listp server) server)
2392    ;; Perhaps this is the native server?
2393    (and (equal server "native") gnus-select-method)
2394    ;; It should be in the server alist.
2395    (cdr (assoc server gnus-server-alist))
2396    ;; It could be in the predefined server alist.
2397    (cdr (assoc server gnus-predefined-server-alist))
2398    ;; If not, we look through all the opened server
2399    ;; to see whether we can find it there.
2400    (let ((opened gnus-opened-servers))
2401      (while (and opened
2402                  (not (equal server (format "%s:%s" (caaar opened)
2403                                             (cadaar opened)))))
2404        (pop opened))
2405      (caar opened))
2406    ;; It could be a named method, search all servers
2407    (let ((servers gnus-secondary-select-methods))
2408      (while (and servers
2409                  (not (equal server (format "%s:%s" (caar servers)
2410                                             (cadar servers)))))
2411        (pop servers))
2412      (car servers))))
2413
2414 (defmacro gnus-method-equal (ss1 ss2)
2415   "Say whether two servers are equal."
2416   `(let ((s1 ,ss1)
2417          (s2 ,ss2))
2418      (or (equal s1 s2)
2419          (and (= (length s1) (length s2))
2420               (progn
2421                 (while (and s1 (member (car s1) s2))
2422                   (setq s1 (cdr s1)))
2423                 (null s1))))))
2424
2425 (defun gnus-methods-equal-p (m1 m2)
2426   (let ((m1 (or m1 gnus-select-method))
2427         (m2 (or m2 gnus-select-method)))
2428     (or (equal m1 m2)
2429         (and (eq (car m1) (car m2))
2430              (or (not (memq 'address (assoc (symbol-name (car m1))
2431                                             gnus-valid-select-methods)))
2432                  (equal (nth 1 m1) (nth 1 m2)))))))
2433
2434 (defun gnus-server-equal (m1 m2)
2435   "Say whether two methods are equal."
2436   (let ((m1 (cond ((null m1) gnus-select-method)
2437                   ((stringp m1) (gnus-server-to-method m1))
2438                   (t m1)))
2439         (m2 (cond ((null m2) gnus-select-method)
2440                   ((stringp m2) (gnus-server-to-method m2))
2441                   (t m2))))
2442     (gnus-method-equal m1 m2)))
2443
2444 (defun gnus-servers-using-backend (backend)
2445   "Return a list of known servers using BACKEND."
2446   (let ((opened gnus-opened-servers)
2447         out)
2448     (while opened
2449       (when (eq backend (caaar opened))
2450         (push (caar opened) out))
2451       (pop opened))
2452     out))
2453
2454 (defun gnus-archive-server-wanted-p ()
2455   "Say whether the user wants to use the archive server."
2456   (cond
2457    ((or (not gnus-message-archive-method)
2458         (not gnus-message-archive-group))
2459     nil)
2460    ((and gnus-message-archive-method gnus-message-archive-group)
2461     t)
2462    (t
2463     (let ((active (cadr (assq 'nnfolder-active-file
2464                               gnus-message-archive-method))))
2465       (and active
2466            (file-exists-p active))))))
2467
2468 (defun gnus-group-prefixed-name (group method)
2469   "Return the whole name from GROUP and METHOD."
2470   (and (stringp method) (setq method (gnus-server-to-method method)))
2471   (if (or (not method)
2472           (gnus-server-equal method "native"))
2473       group
2474     (concat (format "%s" (car method))
2475             (when (and
2476                    (or (assoc (format "%s" (car method))
2477                               (gnus-methods-using 'address))
2478                        (gnus-server-equal method gnus-message-archive-method))
2479                    (nth 1 method)
2480                    (not (string= (nth 1 method) "")))
2481               (concat "+" (nth 1 method)))
2482             ":" group)))
2483
2484 (defun gnus-group-real-prefix (group)
2485   "Return the prefix of the current group name."
2486   (if (string-match "^[^:]+:" group)
2487       (substring group 0 (match-end 0))
2488     ""))
2489
2490 (defun gnus-group-method (group)
2491   "Return the server or method used for selecting GROUP.
2492 You should probably use `gnus-find-method-for-group' instead."
2493   (let ((prefix (gnus-group-real-prefix group)))
2494     (if (equal prefix "")
2495         gnus-select-method
2496       (let ((servers gnus-opened-servers)
2497             (server "")
2498             backend possible found)
2499         (if (string-match "^[^\\+]+\\+" prefix)
2500             (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2501                   server (substring prefix (match-end 0) (1- (length prefix))))
2502           (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2503         (while servers
2504           (when (eq (caaar servers) backend)
2505             (setq possible (caar servers))
2506             (when (equal (cadaar servers) server)
2507               (setq found (caar servers))))
2508           (pop servers))
2509         (or (car (rassoc found gnus-server-alist))
2510             found
2511             (car (rassoc possible gnus-server-alist))
2512             possible
2513             (list backend server))))))
2514
2515 (defsubst gnus-native-method-p (method)
2516   "Return whether METHOD is the native select method."
2517   (gnus-method-equal method gnus-select-method))
2518
2519 (defsubst gnus-secondary-method-p (method)
2520   "Return whether METHOD is a secondary select method."
2521   (let ((methods gnus-secondary-select-methods)
2522         (gmethod (gnus-server-get-method nil method)))
2523     (while (and methods
2524                 (not (gnus-method-equal
2525                       (gnus-server-get-method nil (car methods))
2526                       gmethod)))
2527       (setq methods (cdr methods)))
2528     methods))
2529
2530 (defun gnus-method-simplify (method)
2531   "Return the shortest uniquely identifying string or method for METHOD."
2532   (cond ((stringp method)
2533          method)
2534         ((gnus-native-method-p method)
2535          nil)
2536         ((gnus-secondary-method-p method)
2537          (format "%s:%s" (nth 0 method) (nth 1 method)))
2538         (t
2539          method)))
2540
2541 (defun gnus-groups-from-server (server)
2542   "Return a list of all groups that are fetched from SERVER."
2543   (let ((alist (cdr gnus-newsrc-alist))
2544         info groups)
2545     (while (setq info (pop alist))
2546       (when (gnus-server-equal (gnus-info-method info) server)
2547         (push (gnus-info-group info) groups)))
2548     (sort groups 'string<)))
2549
2550 (defun gnus-group-foreign-p (group)
2551   "Say whether a group is foreign or not."
2552   (and (not (gnus-group-native-p group))
2553        (not (gnus-group-secondary-p group))))
2554
2555 (defun gnus-group-native-p (group)
2556   "Say whether the group is native or not."
2557   (not (string-match ":" group)))
2558
2559 (defun gnus-group-secondary-p (group)
2560   "Say whether the group is secondary or not."
2561   (gnus-secondary-method-p (gnus-find-method-for-group group)))
2562
2563 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2564   "Return the group parameters for GROUP.
2565 If SYMBOL, return the value of that symbol in the group parameters."
2566   (save-excursion
2567     (set-buffer gnus-group-buffer)
2568     (let ((parameters (funcall gnus-group-get-parameter-function group)))
2569       (if symbol
2570           (gnus-group-parameter-value parameters symbol allow-list)
2571         parameters))))
2572
2573 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2574   "Return the group parameters for GROUP.
2575 If SYMBOL, return the value of that symbol in the group parameters.
2576 Most functions should use `gnus-group-find-parameter', which
2577 also examines the topic parameters."
2578   (let ((params (gnus-info-params (gnus-get-info group))))
2579     (if symbol
2580         (gnus-group-parameter-value params symbol allow-list)
2581       params)))
2582
2583 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2584   "Return the value of SYMBOL in group PARAMS."
2585   ;; We only wish to return group parameters (dotted lists) and
2586   ;; not local variables, which may have the same names.
2587   ;; But first we handle single elements...
2588   (or (car (memq symbol params))
2589       ;; Handle alist.
2590       (let (elem)
2591         (catch 'found
2592           (while (setq elem (pop params))
2593             (when (and (consp elem)
2594                        (eq (car elem) symbol)
2595                        (or allow-list
2596                            (atom (cdr elem))))
2597               (throw 'found (cdr elem))))))))
2598
2599 (defun gnus-group-add-parameter (group param)
2600   "Add parameter PARAM to GROUP."
2601   (let ((info (gnus-get-info group)))
2602     (when info
2603       (gnus-group-remove-parameter group (if (consp param) (car param) param))
2604       ;; Cons the new param to the old one and update.
2605       (gnus-group-set-info (cons param (gnus-info-params info))
2606                            group 'params))))
2607
2608 (defun gnus-group-set-parameter (group name value)
2609   "Set parameter NAME to VALUE in GROUP."
2610   (let ((info (gnus-get-info group)))
2611     (when info
2612       (gnus-group-remove-parameter group name)
2613       (let ((old-params (gnus-info-params info))
2614             (new-params (list (cons name value))))
2615         (while old-params
2616           (when (or (not (listp (car old-params)))
2617                     (not (eq (caar old-params) name)))
2618             (setq new-params (append new-params (list (car old-params)))))
2619           (setq old-params (cdr old-params)))
2620         (gnus-group-set-info new-params group 'params)))))
2621
2622 (defun gnus-group-remove-parameter (group name)
2623   "Remove parameter NAME from GROUP."
2624   (let ((info (gnus-get-info group)))
2625     (when info
2626       (let ((params (gnus-info-params info)))
2627         (when params
2628           (setq params (delq name params))
2629           (while (assq name params)
2630             (gnus-pull name params))
2631           (gnus-info-set-params info params))))))
2632
2633 (defun gnus-group-add-score (group &optional score)
2634   "Add SCORE to the GROUP score.
2635 If SCORE is nil, add 1 to the score of GROUP."
2636   (let ((info (gnus-get-info group)))
2637     (when info
2638       (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2639
2640 (defun gnus-short-group-name (group &optional levels)
2641   "Collapse GROUP name LEVELS.
2642 Select methods are stripped and any remote host name is stripped down to
2643 just the host name."
2644   (let* ((name "")
2645          (foreign "")
2646          (depth 0)
2647          (skip 1)
2648          (levels (or levels
2649                      gnus-group-uncollapsed-levels
2650                      (progn
2651                        (while (string-match "\\." group skip)
2652                          (setq skip (match-end 0)
2653                                depth (+ depth 1)))
2654                        depth))))
2655     ;; Separate foreign select method from group name and collapse.
2656     ;; If method contains a server, collapse to non-domain server name,
2657     ;; otherwise collapse to select method.
2658     (let* ((colon (string-match ":" group))
2659            (server (and colon (substring group 0 colon)))
2660            (plus (and server (string-match "+" server))))
2661       (when server
2662         (if plus
2663             (setq foreign (substring server (+ 1 plus)
2664                                      (string-match "\\." server))
2665                   group (substring group (+ 1 colon)))
2666           (setq foreign server
2667                 group (substring group (+ 1 colon))))
2668         (setq foreign (concat foreign ":")))
2669       ;; Collapse group name leaving LEVELS uncollapsed elements
2670       (let* ((slist (split-string group "/"))
2671              (slen (length slist))
2672              (dlist (split-string group "\\."))
2673              (dlen (length dlist))
2674              glist
2675              glen
2676              gsep
2677              res)
2678         (if (> slen dlen)
2679             (setq glist slist
2680                   glen slen
2681                   gsep "/")
2682           (setq glist dlist
2683                 glen dlen
2684                 gsep "."))
2685         (setq levels (- glen levels))
2686         (dolist (g glist)
2687           (push (if (>= (decf levels) 0)
2688                     (if (zerop (length g))
2689                         ""
2690                       (substring g 0 1))
2691                   g)
2692                 res))
2693         (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
2694
2695 (defun gnus-narrow-to-body ()
2696   "Narrow to the body of an article."
2697   (narrow-to-region
2698    (progn
2699      (goto-char (point-min))
2700      (or (search-forward "\n\n" nil t)
2701          (point-max)))
2702    (point-max)))
2703
2704 \f
2705 ;;;
2706 ;;; Kill file handling.
2707 ;;;
2708
2709 (defun gnus-apply-kill-file ()
2710   "Apply a kill file to the current newsgroup.
2711 Returns the number of articles marked as read."
2712   (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2713           (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2714       (gnus-apply-kill-file-internal)
2715     0))
2716
2717 (defun gnus-kill-save-kill-buffer ()
2718   (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2719     (when (get-file-buffer file)
2720       (save-excursion
2721         (set-buffer (get-file-buffer file))
2722         (when (buffer-modified-p)
2723           (save-buffer))
2724         (kill-buffer (current-buffer))))))
2725
2726 (defcustom gnus-kill-file-name "KILL"
2727   "Suffix of the kill files."
2728   :group 'gnus-score-kill
2729   :group 'gnus-score-files
2730   :type 'string)
2731
2732 (defun gnus-newsgroup-kill-file (newsgroup)
2733   "Return the name of a kill file name for NEWSGROUP.
2734 If NEWSGROUP is nil, return the global kill file name instead."
2735   (cond
2736    ;; The global KILL file is placed at top of the directory.
2737    ((or (null newsgroup)
2738         (string-equal newsgroup ""))
2739     (expand-file-name gnus-kill-file-name
2740                       gnus-kill-files-directory))
2741    ;; Append ".KILL" to newsgroup name.
2742    ((gnus-use-long-file-name 'not-kill)
2743     (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2744                               "." gnus-kill-file-name)
2745                       gnus-kill-files-directory))
2746    ;; Place "KILL" under the hierarchical directory.
2747    (t
2748     (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2749                               "/" gnus-kill-file-name)
2750                       gnus-kill-files-directory))))
2751
2752 ;;; Server things.
2753
2754 (defun gnus-member-of-valid (symbol group)
2755   "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2756   (memq symbol (assoc
2757                 (symbol-name (car (gnus-find-method-for-group group)))
2758                 gnus-valid-select-methods)))
2759
2760 (defun gnus-method-option-p (method option)
2761   "Return non-nil if select METHOD has OPTION as a parameter."
2762   (when (stringp method)
2763     (setq method (gnus-server-to-method method)))
2764   (memq option (assoc (format "%s" (car method))
2765                       gnus-valid-select-methods)))
2766
2767 (defun gnus-similar-server-opened (method)
2768   (let ((opened gnus-opened-servers))
2769     (while (and method opened)
2770       (when (and (equal (cadr method) (cadaar opened))
2771                  (equal (car method) (caaar opened))
2772                  (not (equal method (caar opened))))
2773         (setq method nil))
2774       (pop opened))
2775     (not method)))
2776
2777 (defun gnus-server-extend-method (group method)
2778   ;; This function "extends" a virtual server.  If the server is
2779   ;; "hello", and the select method is ("hello" (my-var "something"))
2780   ;; in the group "alt.alt", this will result in a new virtual server
2781   ;; called "hello+alt.alt".
2782   (if (or (not (inline (gnus-similar-server-opened method)))
2783           (not (cddr method)))
2784       method
2785     `(,(car method) ,(concat (cadr method) "+" group)
2786       (,(intern (format "%s-address" (car method))) ,(cadr method))
2787       ,@(cddr method))))
2788
2789 (defun gnus-server-status (method)
2790   "Return the status of METHOD."
2791   (nth 1 (assoc method gnus-opened-servers)))
2792
2793 (defun gnus-group-name-to-method (group)
2794   "Guess a select method based on GROUP."
2795   (if (string-match ":" group)
2796       (let ((server (substring group 0 (match-beginning 0))))
2797         (if (string-match "\\+" server)
2798             (list (intern (substring server 0 (match-beginning 0)))
2799                   (substring server (match-end 0)))
2800           (list (intern server) "")))
2801     gnus-select-method))
2802
2803 (defun gnus-find-method-for-group (group &optional info)
2804   "Find the select method that GROUP uses."
2805   (or gnus-override-method
2806       (and (not group)
2807            gnus-select-method)
2808       (and (not (gnus-group-entry group));; a new group
2809            (gnus-group-name-to-method group))
2810       (let ((info (or info (gnus-get-info group)))
2811             method)
2812         (if (or (not info)
2813                 (not (setq method (gnus-info-method info)))
2814                 (equal method "native"))
2815             gnus-select-method
2816           (setq method
2817                 (cond ((stringp method)
2818                        (inline (gnus-server-to-method method)))
2819                       ((stringp (cadr method))
2820                        (inline (gnus-server-extend-method group method)))
2821                       (t
2822                        method)))
2823           (cond ((equal (cadr method) "")
2824                  method)
2825                 ((null (cadr method))
2826                  (list (car method) ""))
2827                 (t
2828                  (gnus-server-add-address method)))))))
2829
2830 (defun gnus-methods-using (feature)
2831   "Find all methods that have FEATURE."
2832   (let ((valids gnus-valid-select-methods)
2833         outs)
2834     (while valids
2835       (when (memq feature (car valids))
2836         (push (car valids) outs))
2837       (setq valids (cdr valids)))
2838     outs))
2839
2840 (defun gnus-read-group (prompt &optional default)
2841   "Prompt the user for a group name.
2842 Disallow invalid group names."
2843   (let ((prefix "")
2844         group)
2845     (while (not group)
2846       (when (string-match
2847              gnus-invalid-group-regexp
2848              (setq group (read-string (concat prefix prompt)
2849                                       (cons (or default "") 0)
2850                                       'gnus-group-history)))
2851         (setq prefix (format "Invalid group name: \"%s\".  " group)
2852               group nil)))
2853     group))
2854
2855 (defun gnus-read-method (prompt)
2856   "Prompt the user for a method.
2857 Allow completion over sensible values."
2858   (let* ((servers
2859           (append gnus-valid-select-methods
2860                   (mapcar (lambda (i) (list (format "%s:%s" (caar i)
2861                                                     (cadar i))))
2862                           gnus-opened-servers)
2863                   gnus-predefined-server-alist
2864                   gnus-server-alist))
2865          (method
2866           (completing-read
2867            prompt servers
2868            nil t nil 'gnus-method-history)))
2869     (cond
2870      ((equal method "")
2871       (setq method gnus-select-method))
2872      ((assoc method gnus-valid-select-methods)
2873       (let ((address (if (memq 'prompt-address
2874                                (assoc method gnus-valid-select-methods))
2875                          (read-string "Address: ")
2876                        "")))
2877         (or (let ((opened gnus-opened-servers))
2878               (while (and opened
2879                           (not (equal (format "%s:%s" method address)
2880                                       (format "%s:%s" (caaar opened)
2881                                               (cadaar opened)))))
2882                 (pop opened))
2883               (caar opened))
2884             (list (intern method) address))))
2885      ((assoc method servers)
2886       method)
2887      (t
2888       (list (intern method) "")))))
2889
2890 ;;; User-level commands.
2891
2892 ;;;###autoload
2893 (defun gnus-slave-no-server (&optional arg)
2894   "Read network news as a slave, without connecting to local server."
2895   (interactive "P")
2896   (gnus-no-server arg t))
2897
2898 ;;;###autoload
2899 (defun gnus-no-server (&optional arg slave)
2900   "Read network news.
2901 If ARG is a positive number, Gnus will use that as the
2902 startup level.  If ARG is nil, Gnus will be started at level 2.
2903 If ARG is non-nil and not a positive number, Gnus will
2904 prompt the user for the name of an NNTP server to use.
2905 As opposed to `gnus', this command will not connect to the local server."
2906   (interactive "P")
2907   (gnus-no-server-1 arg slave))
2908
2909 ;;;###autoload
2910 (defun gnus-slave (&optional arg)
2911   "Read news as a slave."
2912   (interactive "P")
2913   (gnus arg nil 'slave))
2914
2915 ;;;###autoload
2916 (defun gnus-other-frame (&optional arg)
2917   "Pop up a frame to read news."
2918   (interactive "P")
2919   (let ((window (get-buffer-window gnus-group-buffer)))
2920     (cond (window
2921            (select-frame (window-frame window)))
2922           (t
2923            (select-frame (make-frame)))))
2924   (gnus arg))
2925
2926 ;;(setq thing ?                         ; this is a comment
2927 ;;      more 'yes)
2928
2929 ;;;###autoload
2930 (defun gnus (&optional arg dont-connect slave)
2931   "Read network news.
2932 If ARG is non-nil and a positive number, Gnus will use that as the
2933 startup level.  If ARG is non-nil and not a positive number, Gnus will
2934 prompt the user for the name of an NNTP server to use."
2935   (interactive "P")
2936   (gnus-1 arg dont-connect slave))
2937
2938 ;; Allow redefinition of Gnus functions.
2939
2940 (gnus-ems-redefine)
2941
2942 (provide 'gnus)
2943
2944 ;;; gnus.el ends here