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