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