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

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