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