cgit.sxemacs.org Git - gnus/blob - lisp/gnus.el

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