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