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