git.chise.org Git - elisp/gnus.git-/blob - lisp/gnus.el

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